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/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"
  25
  26 // FIXME: Gross.
  27 #include "../Target/X86/X86FixupKinds.h"
  28
  29 #include <vector>
  30 using namespace llvm;
  31 using namespace llvm::object;
  32
  33 // FIXME: this has been copied from (or to) X86AsmBackend.cpp
  34 static unsigned getFixupKindLog2Size(unsigned Kind) {
  35   switch (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
  40   // re-enabled.
  41   default: return 0;// llvm_unreachable("invalid fixup kind!");
  42   case FK_PCRel_1:
  43   case FK_Data_1: return 0;
  44   case FK_PCRel_2:
  45   case FK_Data_2: return 1;
  46   case FK_PCRel_4:
  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;
  52   }
  53 }
  54
  55 static bool doesSymbolRequireExternRelocation(MCSymbolData *SD) {
  56   // Undefined symbols are always extern.
  57   if (SD->Symbol->isUndefined())
  58     return true;
  59
  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)
  63     return true;
  64
  65   // Otherwise, we can use an internal relocation.
  66   return false;
  67 }
  68
  69 static bool isScatteredFixupFullyResolved(const MCAssembler &Asm,
  70                                           const MCValue Target,
  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.
  78   //
  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.
  82
  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)
  87       return false;
  88
  89     A_Base = Asm.getAtom(&Asm.getSymbolData(A->getSymbol()));
  90     if (!A_Base)
  91       return false;
  92   }
  93
  94   if (const MCSymbolRefExpr *B = Target.getSymB()) {
  95     // Modified symbol references cannot be resolved.
  96     if (B->getKind() != MCSymbolRefExpr::VK_None)
  97       return false;
  98
  99     B_Base = Asm.getAtom(&Asm.getSymbolData(B->getSymbol()));
 100     if (!B_Base)
 101       return false;
 102   }
 103
 104   // If there is no base, A and B have to be the same atom for this fixup to be
 105   // fully resolved.
 106   if (!BaseSymbol)
 107     return A_Base == B_Base;
 108
 109   // Otherwise, B must be missing and A must be the base.
 110   return !B_Base && BaseSymbol == A_Base;
 111 }
 112
 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.
 122   //
 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.
 131
 132   // Non-relative fixups are only resolved if constant.
 133   if (!BaseSection)
 134     return Target.isAbsolute();
 135
 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())
 139     return false;
 140
 141   const MCSymbol *A = &Target.getSymA()->getSymbol();
 142   if (!A->isTemporary() || !A->isInSection() ||
 143       &A->getSection() != BaseSection)
 144     return false;
 145
 146   return true;
 147 }
 148
 149 namespace {
 150
 151 class MachObjectWriter : public MCObjectWriter {
 152   /// MachSymbolData - Helper struct for containing some precomputed information
 153   /// on symbols.
 154   struct MachSymbolData {
 155     MCSymbolData *SymbolData;
 156     uint64_t StringIndex;
 157     uint8_t SectionIndex;
 158
 159     // Support lexicographic sorting.
 160     bool operator<(const MachSymbolData &RHS) const {
 161       return SymbolData->getSymbol().getName() <
 162              RHS.SymbolData->getSymbol().getName();
 163     }
 164   };
 165
 166   /// The target specific Mach-O writer instance.
 167   llvm::OwningPtr<MCMachObjectTargetWriter> TargetObjectWriter;
 168
 169   /// @name Relocation Data
 170   /// @{
 171
 172   llvm::DenseMap<const MCSectionData*,
 173                  std::vector<macho::RelocationEntry> > Relocations;
 174   llvm::DenseMap<const MCSectionData*, unsigned> IndirectSymBase;
 175
 176   /// @}
 177   /// @name Symbol Table Data
 178   /// @{
 179
 180   SmallString<256> StringTable;
 181   std::vector<MachSymbolData> LocalSymbolData;
 182   std::vector<MachSymbolData> ExternalSymbolData;
 183   std::vector<MachSymbolData> UndefinedSymbolData;
 184
 185   /// @}
 186
 187 private:
 188   /// @name Utility Methods
 189   /// @{
 190
 191   bool isFixupKindPCRel(const MCAssembler &Asm, unsigned Kind) {
 192     const MCFixupKindInfo &FKI = Asm.getBackend().getFixupKindInfo(
 193       (MCFixupKind) Kind);
 194
 195     return FKI.Flags & MCFixupKindInfo::FKF_IsPCRel;
 196   }
 197
 198   /// @}
 199
 200   SectionAddrMap SectionAddress;
 201   uint64_t getSectionAddress(const MCSectionData* SD) const {
 202     return SectionAddress.lookup(SD);
 203   }
 204   uint64_t getSymbolAddress(const MCSymbolData* SD,
 205                             const MCAsmLayout &Layout) const {
 206     return getSectionAddress(SD->getFragment()->getParent()) +
 207       Layout.getSymbolOffset(SD);
 208   }
 209   uint64_t getFragmentAddress(const MCFragment *Fragment,
 210                             const MCAsmLayout &Layout) const {
 211     return getSectionAddress(Fragment->getParent()) +
 212       Layout.getFragmentOffset(Fragment);
 213   }
 214
 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())
 220       return 0;
 221
 222     const MCSectionData &NextSD = *Layout.getSectionOrder()[Next];
 223     if (NextSD.getSection().isVirtualSection())
 224       return 0;
 225     return OffsetToAlignment(EndAddr, NextSD.getAlignment());
 226   }
 227
 228 public:
 229   MachObjectWriter(MCMachObjectTargetWriter *MOTW, raw_ostream &_OS,
 230                    bool _IsLittleEndian)
 231     : MCObjectWriter(_OS, _IsLittleEndian), TargetObjectWriter(MOTW) {
 232   }
 233
 234   /// @name Target Writer Proxy Accessors
 235   /// @{
 236
 237   bool is64Bit() const { return TargetObjectWriter->is64Bit(); }
 238   bool isARM() const {
 239     uint32_t CPUType = TargetObjectWriter->getCPUType() & mach::CTFM_ArchMask;
 240     return CPUType == mach::CTM_ARM;
 241   }
 242
 243   /// @}
 244
 245   void WriteHeader(unsigned NumLoadCommands, unsigned LoadCommandsSize,
 246                    bool SubsectionsViaSymbols) {
 247     uint32_t Flags = 0;
 248
 249     if (SubsectionsViaSymbols)
 250       Flags |= macho::HF_SubsectionsViaSymbols;
 251
 252     // struct mach_header (28 bytes) or
 253     // struct mach_header_64 (32 bytes)
 254
 255     uint64_t Start = OS.tell();
 256     (void) Start;
 257
 258     Write32(is64Bit() ? macho::HM_Object64 : macho::HM_Object32);
 259
 260     Write32(TargetObjectWriter->getCPUType());
 261     Write32(TargetObjectWriter->getCPUSubtype());
 262
 263     Write32(macho::HFT_Object);
 264     Write32(NumLoadCommands);
 265     Write32(LoadCommandsSize);
 266     Write32(Flags);
 267     if (is64Bit())
 268       Write32(0); // reserved
 269
 270     assert(OS.tell() - Start == is64Bit() ?
 271            macho::Header64Size : macho::Header32Size);
 272   }
 273
 274   /// WriteSegmentLoadCommand - Write a segment load command.
 275   ///
 276   /// \arg NumSections - The number of sections in this segment.
 277   /// \arg SectionDataSize - The total size of the sections.
 278   void WriteSegmentLoadCommand(unsigned NumSections,
 279                                uint64_t VMSize,
 280                                uint64_t SectionDataStartOffset,
 281                                uint64_t SectionDataSize) {
 282     // struct segment_command (56 bytes) or
 283     // struct segment_command_64 (72 bytes)
 284
 285     uint64_t Start = OS.tell();
 286     (void) Start;
 287
 288     unsigned SegmentLoadCommandSize =
 289       is64Bit() ? macho::SegmentLoadCommand64Size:
 290       macho::SegmentLoadCommand32Size;
 291     Write32(is64Bit() ? macho::LCT_Segment64 : macho::LCT_Segment);
 292     Write32(SegmentLoadCommandSize +
 293             NumSections * (is64Bit() ? macho::Section64Size :
 294                            macho::Section32Size));
 295
 296     WriteBytes("", 16);
 297     if (is64Bit()) {
 298       Write64(0); // vmaddr
 299       Write64(VMSize); // vmsize
 300       Write64(SectionDataStartOffset); // file offset
 301       Write64(SectionDataSize); // file size
 302     } else {
 303       Write32(0); // vmaddr
 304       Write32(VMSize); // vmsize
 305       Write32(SectionDataStartOffset); // file offset
 306       Write32(SectionDataSize); // file size
 307     }
 308     Write32(0x7); // maxprot
 309     Write32(0x7); // initprot
 310     Write32(NumSections);
 311     Write32(0); // flags
 312
 313     assert(OS.tell() - Start == SegmentLoadCommandSize);
 314   }
 315
 316   void WriteSection(const MCAssembler &Asm, const MCAsmLayout &Layout,
 317                     const MCSectionData &SD, uint64_t FileOffset,
 318                     uint64_t RelocationsStart, unsigned NumRelocations) {
 319     uint64_t SectionSize = Layout.getSectionAddressSize(&SD);
 320
 321     // The offset is unused for virtual sections.
 322     if (SD.getSection().isVirtualSection()) {
 323       assert(Layout.getSectionFileSize(&SD) == 0 && "Invalid file size!");
 324       FileOffset = 0;
 325     }
 326
 327     // struct section (68 bytes) or
 328     // struct section_64 (80 bytes)
 329
 330     uint64_t Start = OS.tell();
 331     (void) Start;
 332
 333     const MCSectionMachO &Section = cast<MCSectionMachO>(SD.getSection());
 334     WriteBytes(Section.getSectionName(), 16);
 335     WriteBytes(Section.getSegmentName(), 16);
 336     if (is64Bit()) {
 337       Write64(getSectionAddress(&SD)); // address
 338       Write64(SectionSize); // size
 339     } else {
 340       Write32(getSectionAddress(&SD)); // address
 341       Write32(SectionSize); // size
 342     }
 343     Write32(FileOffset);
 344
 345     unsigned Flags = Section.getTypeAndAttributes();
 346     if (SD.hasInstructions())
 347       Flags |= MCSectionMachO::S_ATTR_SOME_INSTRUCTIONS;
 348
 349     assert(isPowerOf2_32(SD.getAlignment()) && "Invalid alignment!");
 350     Write32(Log2_32(SD.getAlignment()));
 351     Write32(NumRelocations ? RelocationsStart : 0);
 352     Write32(NumRelocations);
 353     Write32(Flags);
 354     Write32(IndirectSymBase.lookup(&SD)); // reserved1
 355     Write32(Section.getStubSize()); // reserved2
 356     if (is64Bit())
 357       Write32(0); // reserved3
 358
 359     assert(OS.tell() - Start == is64Bit() ? macho::Section64Size :
 360            macho::Section32Size);
 361   }
 362
 363   void WriteSymtabLoadCommand(uint32_t SymbolOffset, uint32_t NumSymbols,
 364                               uint32_t StringTableOffset,
 365                               uint32_t StringTableSize) {
 366     // struct symtab_command (24 bytes)
 367
 368     uint64_t Start = OS.tell();
 369     (void) Start;
 370
 371     Write32(macho::LCT_Symtab);
 372     Write32(macho::SymtabLoadCommandSize);
 373     Write32(SymbolOffset);
 374     Write32(NumSymbols);
 375     Write32(StringTableOffset);
 376     Write32(StringTableSize);
 377
 378     assert(OS.tell() - Start == macho::SymtabLoadCommandSize);
 379   }
 380
 381   void WriteDysymtabLoadCommand(uint32_t FirstLocalSymbol,
 382                                 uint32_t NumLocalSymbols,
 383                                 uint32_t FirstExternalSymbol,
 384                                 uint32_t NumExternalSymbols,
 385                                 uint32_t FirstUndefinedSymbol,
 386                                 uint32_t NumUndefinedSymbols,
 387                                 uint32_t IndirectSymbolOffset,
 388                                 uint32_t NumIndirectSymbols) {
 389     // struct dysymtab_command (80 bytes)
 390
 391     uint64_t Start = OS.tell();
 392     (void) Start;
 393
 394     Write32(macho::LCT_Dysymtab);
 395     Write32(macho::DysymtabLoadCommandSize);
 396     Write32(FirstLocalSymbol);
 397     Write32(NumLocalSymbols);
 398     Write32(FirstExternalSymbol);
 399     Write32(NumExternalSymbols);
 400     Write32(FirstUndefinedSymbol);
 401     Write32(NumUndefinedSymbols);
 402     Write32(0); // tocoff
 403     Write32(0); // ntoc
 404     Write32(0); // modtaboff
 405     Write32(0); // nmodtab
 406     Write32(0); // extrefsymoff
 407     Write32(0); // nextrefsyms
 408     Write32(IndirectSymbolOffset);
 409     Write32(NumIndirectSymbols);
 410     Write32(0); // extreloff
 411     Write32(0); // nextrel
 412     Write32(0); // locreloff
 413     Write32(0); // nlocrel
 414
 415     assert(OS.tell() - Start == macho::DysymtabLoadCommandSize);
 416   }
 417
 418   void WriteNlist(MachSymbolData &MSD, const MCAsmLayout &Layout) {
 419     MCSymbolData &Data = *MSD.SymbolData;
 420     const MCSymbol &Symbol = Data.getSymbol();
 421     uint8_t Type = 0;
 422     uint16_t Flags = Data.getFlags();
 423     uint32_t Address = 0;
 424
 425     // Set the N_TYPE bits. See <mach-o/nlist.h>.
 426     //
 427     // FIXME: Are the prebound or indirect fields possible here?
 428     if (Symbol.isUndefined())
 429       Type = macho::STT_Undefined;
 430     else if (Symbol.isAbsolute())
 431       Type = macho::STT_Absolute;
 432     else
 433       Type = macho::STT_Section;
 434
 435     // FIXME: Set STAB bits.
 436
 437     if (Data.isPrivateExtern())
 438       Type |= macho::STF_PrivateExtern;
 439
 440     // Set external bit.
 441     if (Data.isExternal() || Symbol.isUndefined())
 442       Type |= macho::STF_External;
 443
 444     // Compute the symbol address.
 445     if (Symbol.isDefined()) {
 446       if (Symbol.isAbsolute()) {
 447         Address = cast<MCConstantExpr>(Symbol.getVariableValue())->getValue();
 448       } else {
 449         Address = getSymbolAddress(&Data, Layout);
 450       }
 451     } else if (Data.isCommon()) {
 452       // Common symbols are encoded with the size in the address
 453       // field, and their alignment in the flags.
 454       Address = Data.getCommonSize();
 455
 456       // Common alignment is packed into the 'desc' bits.
 457       if (unsigned Align = Data.getCommonAlignment()) {
 458         unsigned Log2Size = Log2_32(Align);
 459         assert((1U << Log2Size) == Align && "Invalid 'common' alignment!");
 460         if (Log2Size > 15)
 461           report_fatal_error("invalid 'common' alignment '" +
 462                             Twine(Align) + "'");
 463         // FIXME: Keep this mask with the SymbolFlags enumeration.
 464         Flags = (Flags & 0xF0FF) | (Log2Size << 8);
 465       }
 466     }
 467
 468     // struct nlist (12 bytes)
 469
 470     Write32(MSD.StringIndex);
 471     Write8(Type);
 472     Write8(MSD.SectionIndex);
 473
 474     // The Mach-O streamer uses the lowest 16-bits of the flags for the 'desc'
 475     // value.
 476     Write16(Flags);
 477     if (is64Bit())
 478       Write64(Address);
 479     else
 480       Write32(Address);
 481   }
 482
 483   // FIXME: We really need to improve the relocation validation. Basically, we
 484   // want to implement a separate computation which evaluates the relocation
 485   // entry as the linker would, and verifies that the resultant fixup value is
 486   // exactly what the encoder wanted. This will catch several classes of
 487   // problems:
 488   //
 489   //  - Relocation entry bugs, the two algorithms are unlikely to have the same
 490   //    exact bug.
 491   //
 492   //  - Relaxation issues, where we forget to relax something.
 493   //
 494   //  - Input errors, where something cannot be correctly encoded. 'as' allows
 495   //    these through in many cases.
 496
 497   static bool isFixupKindRIPRel(unsigned Kind) {
 498     return Kind == X86::reloc_riprel_4byte ||
 499       Kind == X86::reloc_riprel_4byte_movq_load;
 500   }
 501   void RecordX86_64Relocation(const MCAssembler &Asm, const MCAsmLayout &Layout,
 502                               const MCFragment *Fragment,
 503                               const MCFixup &Fixup, MCValue Target,
 504                               uint64_t &FixedValue) {
 505     unsigned IsPCRel = isFixupKindPCRel(Asm, Fixup.getKind());
 506     unsigned IsRIPRel = isFixupKindRIPRel(Fixup.getKind());
 507     unsigned Log2Size = getFixupKindLog2Size(Fixup.getKind());
 508
 509     // See <reloc.h>.
 510     uint32_t FixupOffset =
 511       Layout.getFragmentOffset(Fragment) + Fixup.getOffset();
 512     uint32_t FixupAddress =
 513       getFragmentAddress(Fragment, Layout) + Fixup.getOffset();
 514     int64_t Value = 0;
 515     unsigned Index = 0;
 516     unsigned IsExtern = 0;
 517     unsigned Type = 0;
 518
 519     Value = Target.getConstant();
 520
 521     if (IsPCRel) {
 522       // Compensate for the relocation offset, Darwin x86_64 relocations only
 523       // have the addend and appear to have attempted to define it to be the
 524       // actual expression addend without the PCrel bias. However, instructions
 525       // with data following the relocation are not accomodated for (see comment
 526       // below regarding SIGNED{1,2,4}), so it isn't exactly that either.
 527       Value += 1LL << Log2Size;
 528     }
 529
 530     if (Target.isAbsolute()) { // constant
 531       // SymbolNum of 0 indicates the absolute section.
 532       Type = macho::RIT_X86_64_Unsigned;
 533       Index = 0;
 534
 535       // FIXME: I believe this is broken, I don't think the linker can
 536       // understand it. I think it would require a local relocation, but I'm not
 537       // sure if that would work either. The official way to get an absolute
 538       // PCrel relocation is to use an absolute symbol (which we don't support
 539       // yet).
 540       if (IsPCRel) {
 541         IsExtern = 1;
 542         Type = macho::RIT_X86_64_Branch;
 543       }
 544     } else if (Target.getSymB()) { // A - B + constant
 545       const MCSymbol *A = &Target.getSymA()->getSymbol();
 546       MCSymbolData &A_SD = Asm.getSymbolData(*A);
 547       const MCSymbolData *A_Base = Asm.getAtom(&A_SD);
 548
 549       const MCSymbol *B = &Target.getSymB()->getSymbol();
 550       MCSymbolData &B_SD = Asm.getSymbolData(*B);
 551       const MCSymbolData *B_Base = Asm.getAtom(&B_SD);
 552
 553       // Neither symbol can be modified.
 554       if (Target.getSymA()->getKind() != MCSymbolRefExpr::VK_None ||
 555           Target.getSymB()->getKind() != MCSymbolRefExpr::VK_None)
 556         report_fatal_error("unsupported relocation of modified symbol");
 557
 558       // We don't support PCrel relocations of differences. Darwin 'as' doesn't
 559       // implement most of these correctly.
 560       if (IsPCRel)
 561         report_fatal_error("unsupported pc-relative relocation of difference");
 562
 563       // The support for the situation where one or both of the symbols would
 564       // require a local relocation is handled just like if the symbols were
 565       // external.  This is certainly used in the case of debug sections where
 566       // the section has only temporary symbols and thus the symbols don't have
 567       // base symbols.  This is encoded using the section ordinal and
 568       // non-extern relocation entries.
 569
 570       // Darwin 'as' doesn't emit correct relocations for this (it ends up with
 571       // a single SIGNED relocation); reject it for now.  Except the case where
 572       // both symbols don't have a base, equal but both NULL.
 573       if (A_Base == B_Base && A_Base)
 574         report_fatal_error("unsupported relocation with identical base");
 575
 576       Value += getSymbolAddress(&A_SD, Layout) -
 577         (A_Base == NULL ? 0 : getSymbolAddress(A_Base, Layout));
 578       Value -= getSymbolAddress(&B_SD, Layout) -
 579         (B_Base == NULL ? 0 : getSymbolAddress(B_Base, Layout));
 580
 581       if (A_Base) {
 582         Index = A_Base->getIndex();
 583         IsExtern = 1;
 584       }
 585       else {
 586         Index = A_SD.getFragment()->getParent()->getOrdinal() + 1;
 587         IsExtern = 0;
 588       }
 589       Type = macho::RIT_X86_64_Unsigned;
 590
 591       macho::RelocationEntry MRE;
 592       MRE.Word0 = FixupOffset;
 593       MRE.Word1 = ((Index     <<  0) |
 594                    (IsPCRel   << 24) |
 595                    (Log2Size  << 25) |
 596                    (IsExtern  << 27) |
 597                    (Type      << 28));
 598       Relocations[Fragment->getParent()].push_back(MRE);
 599
 600       if (B_Base) {
 601         Index = B_Base->getIndex();
 602         IsExtern = 1;
 603       }
 604       else {
 605         Index = B_SD.getFragment()->getParent()->getOrdinal() + 1;
 606         IsExtern = 0;
 607       }
 608       Type = macho::RIT_X86_64_Subtractor;
 609     } else {
 610       const MCSymbol *Symbol = &Target.getSymA()->getSymbol();
 611       MCSymbolData &SD = Asm.getSymbolData(*Symbol);
 612       const MCSymbolData *Base = Asm.getAtom(&SD);
 613
 614       // Relocations inside debug sections always use local relocations when
 615       // possible. This seems to be done because the debugger doesn't fully
 616       // understand x86_64 relocation entries, and expects to find values that
 617       // have already been fixed up.
 618       if (Symbol->isInSection()) {
 619         const MCSectionMachO &Section = static_cast<const MCSectionMachO&>(
 620           Fragment->getParent()->getSection());
 621         if (Section.hasAttribute(MCSectionMachO::S_ATTR_DEBUG))
 622           Base = 0;
 623       }
 624
 625       // x86_64 almost always uses external relocations, except when there is no
 626       // symbol to use as a base address (a local symbol with no preceeding
 627       // non-local symbol).
 628       if (Base) {
 629         Index = Base->getIndex();
 630         IsExtern = 1;
 631
 632         // Add the local offset, if needed.
 633         if (Base != &SD)
 634           Value += Layout.getSymbolOffset(&SD) - Layout.getSymbolOffset(Base);
 635       } else if (Symbol->isInSection()) {
 636         // The index is the section ordinal (1-based).
 637         Index = SD.getFragment()->getParent()->getOrdinal() + 1;
 638         IsExtern = 0;
 639         Value += getSymbolAddress(&SD, Layout);
 640
 641         if (IsPCRel)
 642           Value -= FixupAddress + (1 << Log2Size);
 643       } else if (Symbol->isVariable()) {
 644         const MCExpr *Value = Symbol->getVariableValue();
 645         int64_t Res;
 646         bool isAbs = Value->EvaluateAsAbsolute(Res, Layout, SectionAddress);
 647         if (isAbs) {
 648           FixedValue = Res;
 649           return;
 650         } else {
 651           report_fatal_error("unsupported relocation of variable '" +
 652                              Symbol->getName() + "'");
 653         }
 654       } else {
 655         report_fatal_error("unsupported relocation of undefined symbol '" +
 656                            Symbol->getName() + "'");
 657       }
 658
 659       MCSymbolRefExpr::VariantKind Modifier = Target.getSymA()->getKind();
 660       if (IsPCRel) {
 661         if (IsRIPRel) {
 662           if (Modifier == MCSymbolRefExpr::VK_GOTPCREL) {
 663             // x86_64 distinguishes movq foo@GOTPCREL so that the linker can
 664             // rewrite the movq to an leaq at link time if the symbol ends up in
 665             // the same linkage unit.
 666             if (unsigned(Fixup.getKind()) == X86::reloc_riprel_4byte_movq_load)
 667               Type = macho::RIT_X86_64_GOTLoad;
 668             else
 669               Type = macho::RIT_X86_64_GOT;
 670           }  else if (Modifier == MCSymbolRefExpr::VK_TLVP) {
 671             Type = macho::RIT_X86_64_TLV;
 672           }  else if (Modifier != MCSymbolRefExpr::VK_None) {
 673             report_fatal_error("unsupported symbol modifier in relocation");
 674           } else {
 675             Type = macho::RIT_X86_64_Signed;
 676
 677             // The Darwin x86_64 relocation format has a problem where it cannot
 678             // encode an address (L<foo> + <constant>) which is outside the atom
 679             // containing L<foo>. Generally, this shouldn't occur but it does
 680             // happen when we have a RIPrel instruction with data following the
 681             // relocation entry (e.g., movb $012, L0(%rip)). Even with the PCrel
 682             // adjustment Darwin x86_64 uses, the offset is still negative and
 683             // the linker has no way to recognize this.
 684             //
 685             // To work around this, Darwin uses several special relocation types
 686             // to indicate the offsets. However, the specification or
 687             // implementation of these seems to also be incomplete; they should
 688             // adjust the addend as well based on the actual encoded instruction
 689             // (the additional bias), but instead appear to just look at the
 690             // final offset.
 691             switch (-(Target.getConstant() + (1LL << Log2Size))) {
 692             case 1: Type = macho::RIT_X86_64_Signed1; break;
 693             case 2: Type = macho::RIT_X86_64_Signed2; break;
 694             case 4: Type = macho::RIT_X86_64_Signed4; break;
 695             }
 696           }
 697         } else {
 698           if (Modifier != MCSymbolRefExpr::VK_None)
 699             report_fatal_error("unsupported symbol modifier in branch "
 700                               "relocation");
 701
 702           Type = macho::RIT_X86_64_Branch;
 703         }
 704       } else {
 705         if (Modifier == MCSymbolRefExpr::VK_GOT) {
 706           Type = macho::RIT_X86_64_GOT;
 707         } else if (Modifier == MCSymbolRefExpr::VK_GOTPCREL) {
 708           // GOTPCREL is allowed as a modifier on non-PCrel instructions, in
 709           // which case all we do is set the PCrel bit in the relocation entry;
 710           // this is used with exception handling, for example. The source is
 711           // required to include any necessary offset directly.
 712           Type = macho::RIT_X86_64_GOT;
 713           IsPCRel = 1;
 714         } else if (Modifier == MCSymbolRefExpr::VK_TLVP) {
 715           report_fatal_error("TLVP symbol modifier should have been rip-rel");
 716         } else if (Modifier != MCSymbolRefExpr::VK_None)
 717           report_fatal_error("unsupported symbol modifier in relocation");
 718         else
 719           Type = macho::RIT_X86_64_Unsigned;
 720       }
 721     }
 722
 723     // x86_64 always writes custom values into the fixups.
 724     FixedValue = Value;
 725
 726     // struct relocation_info (8 bytes)
 727     macho::RelocationEntry MRE;
 728     MRE.Word0 = FixupOffset;
 729     MRE.Word1 = ((Index     <<  0) |
 730                  (IsPCRel   << 24) |
 731                  (Log2Size  << 25) |
 732                  (IsExtern  << 27) |
 733                  (Type      << 28));
 734     Relocations[Fragment->getParent()].push_back(MRE);
 735   }
 736
 737   void RecordScatteredRelocation(const MCAssembler &Asm,
 738                                  const MCAsmLayout &Layout,
 739                                  const MCFragment *Fragment,
 740                                  const MCFixup &Fixup, MCValue Target,
 741                                  uint64_t &FixedValue) {
 742     uint32_t FixupOffset = Layout.getFragmentOffset(Fragment)+Fixup.getOffset();
 743     unsigned IsPCRel = isFixupKindPCRel(Asm, Fixup.getKind());
 744     unsigned Log2Size = getFixupKindLog2Size(Fixup.getKind());
 745     unsigned Type = macho::RIT_Vanilla;
 746
 747     // See <reloc.h>.
 748     const MCSymbol *A = &Target.getSymA()->getSymbol();
 749     MCSymbolData *A_SD = &Asm.getSymbolData(*A);
 750
 751     if (!A_SD->getFragment())
 752       report_fatal_error("symbol '" + A->getName() +
 753                         "' can not be undefined in a subtraction expression");
 754
 755     uint32_t Value = getSymbolAddress(A_SD, Layout);
 756     uint64_t SecAddr = getSectionAddress(A_SD->getFragment()->getParent());
 757     FixedValue += SecAddr;
 758     uint32_t Value2 = 0;
 759
 760     if (const MCSymbolRefExpr *B = Target.getSymB()) {
 761       MCSymbolData *B_SD = &Asm.getSymbolData(B->getSymbol());
 762
 763       if (!B_SD->getFragment())
 764         report_fatal_error("symbol '" + B->getSymbol().getName() +
 765                           "' can not be undefined in a subtraction expression");
 766
 767       // Select the appropriate difference relocation type.
 768       //
 769       // Note that there is no longer any semantic difference between these two
 770       // relocation types from the linkers point of view, this is done solely
 771       // for pedantic compatibility with 'as'.
 772       Type = A_SD->isExternal() ? (unsigned)macho::RIT_Difference :
 773         (unsigned)macho::RIT_Generic_LocalDifference;
 774       Value2 = getSymbolAddress(B_SD, Layout);
 775       FixedValue -= getSectionAddress(B_SD->getFragment()->getParent());
 776     }
 777
 778     // Relocations are written out in reverse order, so the PAIR comes first.
 779     if (Type == macho::RIT_Difference ||
 780         Type == macho::RIT_Generic_LocalDifference) {
 781       macho::RelocationEntry MRE;
 782       MRE.Word0 = ((0         <<  0) |
 783                    (macho::RIT_Pair  << 24) |
 784                    (Log2Size  << 28) |
 785                    (IsPCRel   << 30) |
 786                    macho::RF_Scattered);
 787       MRE.Word1 = Value2;
 788       Relocations[Fragment->getParent()].push_back(MRE);
 789     }
 790
 791     macho::RelocationEntry MRE;
 792     MRE.Word0 = ((FixupOffset <<  0) |
 793                  (Type        << 24) |
 794                  (Log2Size    << 28) |
 795                  (IsPCRel     << 30) |
 796                  macho::RF_Scattered);
 797     MRE.Word1 = Value;
 798     Relocations[Fragment->getParent()].push_back(MRE);
 799   }
 800
 801   void RecordTLVPRelocation(const MCAssembler &Asm,
 802                             const MCAsmLayout &Layout,
 803                             const MCFragment *Fragment,
 804                             const MCFixup &Fixup, MCValue Target,
 805                             uint64_t &FixedValue) {
 806     assert(Target.getSymA()->getKind() == MCSymbolRefExpr::VK_TLVP &&
 807            !is64Bit() &&
 808            "Should only be called with a 32-bit TLVP relocation!");
 809
 810     unsigned Log2Size = getFixupKindLog2Size(Fixup.getKind());
 811     uint32_t Value = Layout.getFragmentOffset(Fragment)+Fixup.getOffset();
 812     unsigned IsPCRel = 0;
 813
 814     // Get the symbol data.
 815     MCSymbolData *SD_A = &Asm.getSymbolData(Target.getSymA()->getSymbol());
 816     unsigned Index = SD_A->getIndex();
 817
 818     // We're only going to have a second symbol in pic mode and it'll be a
 819     // subtraction from the picbase. For 32-bit pic the addend is the difference
 820     // between the picbase and the next address.  For 32-bit static the addend
 821     // is zero.
 822     if (Target.getSymB()) {
 823       // If this is a subtraction then we're pcrel.
 824       uint32_t FixupAddress =
 825         getFragmentAddress(Fragment, Layout) + Fixup.getOffset();
 826       MCSymbolData *SD_B = &Asm.getSymbolData(Target.getSymB()->getSymbol());
 827       IsPCRel = 1;
 828       FixedValue = (FixupAddress - getSymbolAddress(SD_B, Layout) +
 829                     Target.getConstant());
 830       FixedValue += 1ULL << Log2Size;
 831     } else {
 832       FixedValue = 0;
 833     }
 834
 835     // struct relocation_info (8 bytes)
 836     macho::RelocationEntry MRE;
 837     MRE.Word0 = Value;
 838     MRE.Word1 = ((Index                  <<  0) |
 839                  (IsPCRel                << 24) |
 840                  (Log2Size               << 25) |
 841                  (1                      << 27) | // Extern
 842                  (macho::RIT_Generic_TLV << 28)); // Type
 843     Relocations[Fragment->getParent()].push_back(MRE);
 844   }
 845
 846   void RecordARMRelocation(const MCAssembler &Asm, const MCAsmLayout &Layout,
 847                            const MCFragment *Fragment, const MCFixup &Fixup,
 848                            MCValue Target, uint64_t &FixedValue) {
 849     // FIXME!
 850   }
 851
 852   void RecordRelocation(const MCAssembler &Asm, const MCAsmLayout &Layout,
 853                         const MCFragment *Fragment, const MCFixup &Fixup,
 854                         MCValue Target, uint64_t &FixedValue) {
 855     // FIXME: These needs to be factored into the target Mach-O writer.
 856     if (isARM()) {
 857       RecordARMRelocation(Asm, Layout, Fragment, Fixup, Target, FixedValue);
 858       return;
 859     }
 860     if (is64Bit()) {
 861       RecordX86_64Relocation(Asm, Layout, Fragment, Fixup, Target, FixedValue);
 862       return;
 863     }
 864
 865     unsigned IsPCRel = isFixupKindPCRel(Asm, Fixup.getKind());
 866     unsigned Log2Size = getFixupKindLog2Size(Fixup.getKind());
 867
 868     // If this is a 32-bit TLVP reloc it's handled a bit differently.
 869     if (Target.getSymA() &&
 870         Target.getSymA()->getKind() == MCSymbolRefExpr::VK_TLVP) {
 871       RecordTLVPRelocation(Asm, Layout, Fragment, Fixup, Target, FixedValue);
 872       return;
 873     }
 874
 875     // If this is a difference or a defined symbol plus an offset, then we need
 876     // a scattered relocation entry.
 877     // Differences always require scattered relocations.
 878     if (Target.getSymB())
 879         return RecordScatteredRelocation(Asm, Layout, Fragment, Fixup,
 880                                          Target, FixedValue);
 881
 882     // Get the symbol data, if any.
 883     MCSymbolData *SD = 0;
 884     if (Target.getSymA())
 885       SD = &Asm.getSymbolData(Target.getSymA()->getSymbol());
 886
 887     // If this is an internal relocation with an offset, it also needs a
 888     // scattered relocation entry.
 889     uint32_t Offset = Target.getConstant();
 890     if (IsPCRel)
 891       Offset += 1 << Log2Size;
 892     if (Offset && SD && !doesSymbolRequireExternRelocation(SD))
 893       return RecordScatteredRelocation(Asm, Layout, Fragment, Fixup,
 894                                        Target, FixedValue);
 895
 896     // See <reloc.h>.
 897     uint32_t FixupOffset = Layout.getFragmentOffset(Fragment)+Fixup.getOffset();
 898     unsigned Index = 0;
 899     unsigned IsExtern = 0;
 900     unsigned Type = 0;
 901
 902     if (Target.isAbsolute()) { // constant
 903       // SymbolNum of 0 indicates the absolute section.
 904       //
 905       // FIXME: Currently, these are never generated (see code below). I cannot
 906       // find a case where they are actually emitted.
 907       Type = macho::RIT_Vanilla;
 908     } else if (SD->getSymbol().isVariable()) {
 909       const MCExpr *Value = SD->getSymbol().getVariableValue();
 910       int64_t Res;
 911       bool isAbs = Value->EvaluateAsAbsolute(Res, Layout, SectionAddress);
 912       if (isAbs) {
 913         FixedValue = Res;
 914         return;
 915       } else {
 916         report_fatal_error("unsupported relocation of variable '" +
 917                            SD->getSymbol().getName() + "'");
 918       }
 919     } else {
 920       // Check whether we need an external or internal relocation.
 921       if (doesSymbolRequireExternRelocation(SD)) {
 922         IsExtern = 1;
 923         Index = SD->getIndex();
 924         // For external relocations, make sure to offset the fixup value to
 925         // compensate for the addend of the symbol address, if it was
 926         // undefined. This occurs with weak definitions, for example.
 927         if (!SD->Symbol->isUndefined())
 928           FixedValue -= Layout.getSymbolOffset(SD);
 929       } else {
 930         // The index is the section ordinal (1-based).
 931         Index = SD->getFragment()->getParent()->getOrdinal() + 1;
 932         FixedValue += getSectionAddress(SD->getFragment()->getParent());
 933       }
 934       if (IsPCRel)
 935         FixedValue -= getSectionAddress(Fragment->getParent());
 936
 937       Type = macho::RIT_Vanilla;
 938     }
 939
 940     // struct relocation_info (8 bytes)
 941     macho::RelocationEntry MRE;
 942     MRE.Word0 = FixupOffset;
 943     MRE.Word1 = ((Index     <<  0) |
 944                  (IsPCRel   << 24) |
 945                  (Log2Size  << 25) |
 946                  (IsExtern  << 27) |
 947                  (Type      << 28));
 948     Relocations[Fragment->getParent()].push_back(MRE);
 949   }
 950
 951   void BindIndirectSymbols(MCAssembler &Asm) {
 952     // This is the point where 'as' creates actual symbols for indirect symbols
 953     // (in the following two passes). It would be easier for us to do this
 954     // sooner when we see the attribute, but that makes getting the order in the
 955     // symbol table much more complicated than it is worth.
 956     //
 957     // FIXME: Revisit this when the dust settles.
 958
 959     // Bind non lazy symbol pointers first.
 960     unsigned IndirectIndex = 0;
 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());
 965
 966       if (Section.getType() != MCSectionMachO::S_NON_LAZY_SYMBOL_POINTERS)
 967         continue;
 968
 969       // Initialize the section indirect symbol base, if necessary.
 970       if (!IndirectSymBase.count(it->SectionData))
 971         IndirectSymBase[it->SectionData] = IndirectIndex;
 972
 973       Asm.getOrCreateSymbolData(*it->Symbol);
 974     }
 975
 976     // Then lazy symbol pointers and symbol stubs.
 977     IndirectIndex = 0;
 978     for (MCAssembler::indirect_symbol_iterator it = Asm.indirect_symbol_begin(),
 979            ie = Asm.indirect_symbol_end(); it != ie; ++it, ++IndirectIndex) {
 980       const MCSectionMachO &Section =
 981         cast<MCSectionMachO>(it->SectionData->getSection());
 982
 983       if (Section.getType() != MCSectionMachO::S_LAZY_SYMBOL_POINTERS &&
 984           Section.getType() != MCSectionMachO::S_SYMBOL_STUBS)
 985         continue;
 986
 987       // Initialize the section indirect symbol base, if necessary.
 988       if (!IndirectSymBase.count(it->SectionData))
 989         IndirectSymBase[it->SectionData] = IndirectIndex;
 990
 991       // Set the symbol type to undefined lazy, but only on construction.
 992       //
 993       // FIXME: Do not hardcode.
 994       bool Created;
 995       MCSymbolData &Entry = Asm.getOrCreateSymbolData(*it->Symbol, &Created);
 996       if (Created)
 997         Entry.setFlags(Entry.getFlags() | 0x0001);
 998     }
 999   }
1000
1001   /// ComputeSymbolTable - Compute the symbol table data
1002   ///
1003   /// \param StringTable [out] - The string table data.
1004   /// \param StringIndexMap [out] - Map from symbol names to offsets in the
1005   /// string table.
1006   void ComputeSymbolTable(MCAssembler &Asm, SmallString<256> &StringTable,
1007                           std::vector<MachSymbolData> &LocalSymbolData,
1008                           std::vector<MachSymbolData> &ExternalSymbolData,
1009                           std::vector<MachSymbolData> &UndefinedSymbolData) {
1010     // Build section lookup table.
1011     DenseMap<const MCSection*, uint8_t> SectionIndexMap;
1012     unsigned Index = 1;
1013     for (MCAssembler::iterator it = Asm.begin(),
1014            ie = Asm.end(); it != ie; ++it, ++Index)
1015       SectionIndexMap[&it->getSection()] = Index;
1016     assert(Index <= 256 && "Too many sections!");
1017
1018     // Index 0 is always the empty string.
1019     StringMap<uint64_t> StringIndexMap;
1020     StringTable += '\x00';
1021
1022     // Build the symbol arrays and the string table, but only for non-local
1023     // symbols.
1024     //
1025     // The particular order that we collect the symbols and create the string
1026     // table, then sort the symbols is chosen to match 'as'. Even though it
1027     // doesn't matter for correctness, this is important for letting us diff .o
1028     // files.
1029     for (MCAssembler::symbol_iterator it = Asm.symbol_begin(),
1030            ie = Asm.symbol_end(); it != ie; ++it) {
1031       const MCSymbol &Symbol = it->getSymbol();
1032
1033       // Ignore non-linker visible symbols.
1034       if (!Asm.isSymbolLinkerVisible(it->getSymbol()))
1035         continue;
1036
1037       if (!it->isExternal() && !Symbol.isUndefined())
1038         continue;
1039
1040       uint64_t &Entry = StringIndexMap[Symbol.getName()];
1041       if (!Entry) {
1042         Entry = StringTable.size();
1043         StringTable += Symbol.getName();
1044         StringTable += '\x00';
1045       }
1046
1047       MachSymbolData MSD;
1048       MSD.SymbolData = it;
1049       MSD.StringIndex = Entry;
1050
1051       if (Symbol.isUndefined()) {
1052         MSD.SectionIndex = 0;
1053         UndefinedSymbolData.push_back(MSD);
1054       } else if (Symbol.isAbsolute()) {
1055         MSD.SectionIndex = 0;
1056         ExternalSymbolData.push_back(MSD);
1057       } else {
1058         MSD.SectionIndex = SectionIndexMap.lookup(&Symbol.getSection());
1059         assert(MSD.SectionIndex && "Invalid section index!");
1060         ExternalSymbolData.push_back(MSD);
1061       }
1062     }
1063
1064     // Now add the data for local symbols.
1065     for (MCAssembler::symbol_iterator it = Asm.symbol_begin(),
1066            ie = Asm.symbol_end(); it != ie; ++it) {
1067       const MCSymbol &Symbol = it->getSymbol();
1068
1069       // Ignore non-linker visible symbols.
1070       if (!Asm.isSymbolLinkerVisible(it->getSymbol()))
1071         continue;
1072
1073       if (it->isExternal() || Symbol.isUndefined())
1074         continue;
1075
1076       uint64_t &Entry = StringIndexMap[Symbol.getName()];
1077       if (!Entry) {
1078         Entry = StringTable.size();
1079         StringTable += Symbol.getName();
1080         StringTable += '\x00';
1081       }
1082
1083       MachSymbolData MSD;
1084       MSD.SymbolData = it;
1085       MSD.StringIndex = Entry;
1086
1087       if (Symbol.isAbsolute()) {
1088         MSD.SectionIndex = 0;
1089         LocalSymbolData.push_back(MSD);
1090       } else {
1091         MSD.SectionIndex = SectionIndexMap.lookup(&Symbol.getSection());
1092         assert(MSD.SectionIndex && "Invalid section index!");
1093         LocalSymbolData.push_back(MSD);
1094       }
1095     }
1096
1097     // External and undefined symbols are required to be in lexicographic order.
1098     std::sort(ExternalSymbolData.begin(), ExternalSymbolData.end());
1099     std::sort(UndefinedSymbolData.begin(), UndefinedSymbolData.end());
1100
1101     // Set the symbol indices.
1102     Index = 0;
1103     for (unsigned i = 0, e = LocalSymbolData.size(); i != e; ++i)
1104       LocalSymbolData[i].SymbolData->setIndex(Index++);
1105     for (unsigned i = 0, e = ExternalSymbolData.size(); i != e; ++i)
1106       ExternalSymbolData[i].SymbolData->setIndex(Index++);
1107     for (unsigned i = 0, e = UndefinedSymbolData.size(); i != e; ++i)
1108       UndefinedSymbolData[i].SymbolData->setIndex(Index++);
1109
1110     // The string table is padded to a multiple of 4.
1111     while (StringTable.size() % 4)
1112       StringTable += '\x00';
1113   }
1114
1115   void computeSectionAddresses(const MCAssembler &Asm,
1116                                const MCAsmLayout &Layout) {
1117     uint64_t StartAddress = 0;
1118     const SmallVectorImpl<MCSectionData*> &Order = Layout.getSectionOrder();
1119     for (int i = 0, n = Order.size(); i != n ; ++i) {
1120       const MCSectionData *SD = Order[i];
1121       StartAddress = RoundUpToAlignment(StartAddress, SD->getAlignment());
1122       SectionAddress[SD] = StartAddress;
1123       StartAddress += Layout.getSectionAddressSize(SD);
1124       // Explicitly pad the section to match the alignment requirements of the
1125       // following one. This is for 'gas' compatibility, it shouldn't
1126       /// strictly be necessary.
1127       StartAddress += getPaddingSize(SD, Layout);
1128     }
1129   }
1130
1131   void ExecutePostLayoutBinding(MCAssembler &Asm, const MCAsmLayout &Layout) {
1132     computeSectionAddresses(Asm, Layout);
1133
1134     // Create symbol data for any indirect symbols.
1135     BindIndirectSymbols(Asm);
1136
1137     // Compute symbol table information and bind symbol indices.
1138     ComputeSymbolTable(Asm, StringTable, LocalSymbolData, ExternalSymbolData,
1139                        UndefinedSymbolData);
1140   }
1141
1142   bool IsSymbolRefDifferenceFullyResolved(const MCAssembler &Asm,
1143                                           const MCSymbolRefExpr *A,
1144                                           const MCSymbolRefExpr *B,
1145                                           bool InSet) const {
1146     if (InSet)
1147       return true;
1148
1149     if (!TargetObjectWriter->useAggressiveSymbolFolding())
1150       return false;
1151
1152     // The effective address is
1153     //     addr(atom(A)) + offset(A)
1154     //   - addr(atom(B)) - offset(B)
1155     // and the offsets are not relocatable, so the fixup is fully resolved when
1156     //  addr(atom(A)) - addr(atom(B)) == 0.
1157     const MCSymbolData *A_Base = 0, *B_Base = 0;
1158
1159     // Modified symbol references cannot be resolved.
1160     if (A->getKind() != MCSymbolRefExpr::VK_None ||
1161         B->getKind() != MCSymbolRefExpr::VK_None)
1162       return false;
1163
1164     A_Base = Asm.getAtom(&Asm.getSymbolData(A->getSymbol()));
1165     if (!A_Base)
1166       return false;
1167
1168     B_Base = Asm.getAtom(&Asm.getSymbolData(B->getSymbol()));
1169     if (!B_Base)
1170       return false;
1171
1172     // If the atoms are the same, they are guaranteed to have the same address.
1173     if (A_Base == B_Base)
1174       return true;
1175
1176     // Otherwise, we can't prove this is fully resolved.
1177     return false;
1178   }
1179
1180   bool IsFixupFullyResolved(const MCAssembler &Asm,
1181                             const MCValue Target,
1182                             bool IsPCRel,
1183                             const MCFragment *DF) const {
1184     // Otherwise, determine whether this value is actually resolved; scattering
1185     // may cause atoms to move.
1186
1187     // Check if we are using the "simple" resolution algorithm (e.g.,
1188     // i386).
1189     if (!Asm.getBackend().hasReliableSymbolDifference()) {
1190       const MCSection *BaseSection = 0;
1191       if (IsPCRel)
1192         BaseSection = &DF->getParent()->getSection();
1193
1194       return isScatteredFixupFullyResolvedSimple(Asm, Target, BaseSection);
1195     }
1196
1197     // Otherwise, compute the proper answer as reliably as possible.
1198
1199     // If this is a PCrel relocation, find the base atom (identified by its
1200     // symbol) that the fixup value is relative to.
1201     const MCSymbolData *BaseSymbol = 0;
1202     if (IsPCRel) {
1203       BaseSymbol = DF->getAtom();
1204       if (!BaseSymbol)
1205         return false;
1206     }
1207
1208     return isScatteredFixupFullyResolved(Asm, Target, BaseSymbol);
1209   }
1210
1211   void WriteObject(MCAssembler &Asm, const MCAsmLayout &Layout) {
1212     unsigned NumSections = Asm.size();
1213
1214     // The section data starts after the header, the segment load command (and
1215     // section headers) and the symbol table.
1216     unsigned NumLoadCommands = 1;
1217     uint64_t LoadCommandsSize = is64Bit() ?
1218       macho::SegmentLoadCommand64Size + NumSections * macho::Section64Size :
1219       macho::SegmentLoadCommand32Size + NumSections * macho::Section32Size;
1220
1221     // Add the symbol table load command sizes, if used.
1222     unsigned NumSymbols = LocalSymbolData.size() + ExternalSymbolData.size() +
1223       UndefinedSymbolData.size();
1224     if (NumSymbols) {
1225       NumLoadCommands += 2;
1226       LoadCommandsSize += (macho::SymtabLoadCommandSize +
1227                            macho::DysymtabLoadCommandSize);
1228     }
1229
1230     // Compute the total size of the section data, as well as its file size and
1231     // vm size.
1232     uint64_t SectionDataStart = (is64Bit() ? macho::Header64Size :
1233                                  macho::Header32Size) + LoadCommandsSize;
1234     uint64_t SectionDataSize = 0;
1235     uint64_t SectionDataFileSize = 0;
1236     uint64_t VMSize = 0;
1237     for (MCAssembler::const_iterator it = Asm.begin(),
1238            ie = Asm.end(); it != ie; ++it) {
1239       const MCSectionData &SD = *it;
1240       uint64_t Address = getSectionAddress(&SD);
1241       uint64_t Size = Layout.getSectionAddressSize(&SD);
1242       uint64_t FileSize = Layout.getSectionFileSize(&SD);
1243       FileSize += getPaddingSize(&SD, Layout);
1244
1245       VMSize = std::max(VMSize, Address + Size);
1246
1247       if (SD.getSection().isVirtualSection())
1248         continue;
1249
1250       SectionDataSize = std::max(SectionDataSize, Address + Size);
1251       SectionDataFileSize = std::max(SectionDataFileSize, Address + FileSize);
1252     }
1253
1254     // The section data is padded to 4 bytes.
1255     //
1256     // FIXME: Is this machine dependent?
1257     unsigned SectionDataPadding = OffsetToAlignment(SectionDataFileSize, 4);
1258     SectionDataFileSize += SectionDataPadding;
1259
1260     // Write the prolog, starting with the header and load command...
1261     WriteHeader(NumLoadCommands, LoadCommandsSize,
1262                 Asm.getSubsectionsViaSymbols());
1263     WriteSegmentLoadCommand(NumSections, VMSize,
1264                             SectionDataStart, SectionDataSize);
1265
1266     // ... and then the section headers.
1267     uint64_t RelocTableEnd = SectionDataStart + SectionDataFileSize;
1268     for (MCAssembler::const_iterator it = Asm.begin(),
1269            ie = Asm.end(); it != ie; ++it) {
1270       std::vector<macho::RelocationEntry> &Relocs = Relocations[it];
1271       unsigned NumRelocs = Relocs.size();
1272       uint64_t SectionStart = SectionDataStart + getSectionAddress(it);
1273       WriteSection(Asm, Layout, *it, SectionStart, RelocTableEnd, NumRelocs);
1274       RelocTableEnd += NumRelocs * macho::RelocationInfoSize;
1275     }
1276
1277     // Write the symbol table load command, if used.
1278     if (NumSymbols) {
1279       unsigned FirstLocalSymbol = 0;
1280       unsigned NumLocalSymbols = LocalSymbolData.size();
1281       unsigned FirstExternalSymbol = FirstLocalSymbol + NumLocalSymbols;
1282       unsigned NumExternalSymbols = ExternalSymbolData.size();
1283       unsigned FirstUndefinedSymbol = FirstExternalSymbol + NumExternalSymbols;
1284       unsigned NumUndefinedSymbols = UndefinedSymbolData.size();
1285       unsigned NumIndirectSymbols = Asm.indirect_symbol_size();
1286       unsigned NumSymTabSymbols =
1287         NumLocalSymbols + NumExternalSymbols + NumUndefinedSymbols;
1288       uint64_t IndirectSymbolSize = NumIndirectSymbols * 4;
1289       uint64_t IndirectSymbolOffset = 0;
1290
1291       // If used, the indirect symbols are written after the section data.
1292       if (NumIndirectSymbols)
1293         IndirectSymbolOffset = RelocTableEnd;
1294
1295       // The symbol table is written after the indirect symbol data.
1296       uint64_t SymbolTableOffset = RelocTableEnd + IndirectSymbolSize;
1297
1298       // The string table is written after symbol table.
1299       uint64_t StringTableOffset =
1300         SymbolTableOffset + NumSymTabSymbols * (is64Bit() ? macho::Nlist64Size :
1301                                                 macho::Nlist32Size);
1302       WriteSymtabLoadCommand(SymbolTableOffset, NumSymTabSymbols,
1303                              StringTableOffset, StringTable.size());
1304
1305       WriteDysymtabLoadCommand(FirstLocalSymbol, NumLocalSymbols,
1306                                FirstExternalSymbol, NumExternalSymbols,
1307                                FirstUndefinedSymbol, NumUndefinedSymbols,
1308                                IndirectSymbolOffset, NumIndirectSymbols);
1309     }
1310
1311     // Write the actual section data.
1312     for (MCAssembler::const_iterator it = Asm.begin(),
1313            ie = Asm.end(); it != ie; ++it) {
1314       Asm.WriteSectionData(it, Layout);
1315
1316       uint64_t Pad = getPaddingSize(it, Layout);
1317       for (unsigned int i = 0; i < Pad; ++i)
1318         Write8(0);
1319     }
1320
1321     // Write the extra padding.
1322     WriteZeros(SectionDataPadding);
1323
1324     // Write the relocation entries.
1325     for (MCAssembler::const_iterator it = Asm.begin(),
1326            ie = Asm.end(); it != ie; ++it) {
1327       // Write the section relocation entries, in reverse order to match 'as'
1328       // (approximately, the exact algorithm is more complicated than this).
1329       std::vector<macho::RelocationEntry> &Relocs = Relocations[it];
1330       for (unsigned i = 0, e = Relocs.size(); i != e; ++i) {
1331         Write32(Relocs[e - i - 1].Word0);
1332         Write32(Relocs[e - i - 1].Word1);
1333       }
1334     }
1335
1336     // Write the symbol table data, if used.
1337     if (NumSymbols) {
1338       // Write the indirect symbol entries.
1339       for (MCAssembler::const_indirect_symbol_iterator
1340              it = Asm.indirect_symbol_begin(),
1341              ie = Asm.indirect_symbol_end(); it != ie; ++it) {
1342         // Indirect symbols in the non lazy symbol pointer section have some
1343         // special handling.
1344         const MCSectionMachO &Section =
1345           static_cast<const MCSectionMachO&>(it->SectionData->getSection());
1346         if (Section.getType() == MCSectionMachO::S_NON_LAZY_SYMBOL_POINTERS) {
1347           // If this symbol is defined and internal, mark it as such.
1348           if (it->Symbol->isDefined() &&
1349               !Asm.getSymbolData(*it->Symbol).isExternal()) {
1350             uint32_t Flags = macho::ISF_Local;
1351             if (it->Symbol->isAbsolute())
1352               Flags |= macho::ISF_Absolute;
1353             Write32(Flags);
1354             continue;
1355           }
1356         }
1357
1358         Write32(Asm.getSymbolData(*it->Symbol).getIndex());
1359       }
1360
1361       // FIXME: Check that offsets match computed ones.
1362
1363       // Write the symbol table entries.
1364       for (unsigned i = 0, e = LocalSymbolData.size(); i != e; ++i)
1365         WriteNlist(LocalSymbolData[i], Layout);
1366       for (unsigned i = 0, e = ExternalSymbolData.size(); i != e; ++i)
1367         WriteNlist(ExternalSymbolData[i], Layout);
1368       for (unsigned i = 0, e = UndefinedSymbolData.size(); i != e; ++i)
1369         WriteNlist(UndefinedSymbolData[i], Layout);
1370
1371       // Write the string table.
1372       OS << StringTable.str();
1373     }
1374   }
1375 };
1376
1377 }
1378
1379 MCObjectWriter *llvm::createMachObjectWriter(MCMachObjectTargetWriter *MOTW,
1380                                              raw_ostream &OS,
1381                                              bool IsLittleEndian) {
1382   return new MachObjectWriter(MOTW, OS, IsLittleEndian);
1383 }