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