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/StringMap.h"
  12 #include "llvm/ADT/Twine.h"
  13 #include "llvm/MC/MCAsmBackend.h"
  14 #include "llvm/MC/MCAsmLayout.h"
  15 #include "llvm/MC/MCAssembler.h"
  16 #include "llvm/MC/MCExpr.h"
  17 #include "llvm/MC/MCFixupKindInfo.h"
  18 #include "llvm/MC/MCMachOSymbolFlags.h"
  19 #include "llvm/MC/MCObjectWriter.h"
  20 #include "llvm/MC/MCSectionMachO.h"
  21 #include "llvm/MC/MCSymbolMachO.h"
  22 #include "llvm/MC/MCValue.h"
  23 #include "llvm/Support/Debug.h"
  24 #include "llvm/Support/ErrorHandling.h"
  25 #include "llvm/Support/MachO.h"
  26 #include "llvm/Support/raw_ostream.h"
  27 #include <vector>
  28 using namespace llvm;
  29
  30 #define DEBUG_TYPE "mc"
  31
  32 void MachObjectWriter::reset() {
  33   Relocations.clear();
  34   IndirectSymBase.clear();
  35   StringTable.clear();
  36   LocalSymbolData.clear();
  37   ExternalSymbolData.clear();
  38   UndefinedSymbolData.clear();
  39   MCObjectWriter::reset();
  40 }
  41
  42 bool MachObjectWriter::doesSymbolRequireExternRelocation(const MCSymbol &S) {
  43   // Undefined symbols are always extern.
  44   if (S.isUndefined())
  45     return true;
  46
  47   // References to weak definitions require external relocation entries; the
  48   // definition may not always be the one in the same object file.
  49   if (cast<MCSymbolMachO>(S).isWeakDefinition())
  50     return true;
  51
  52   // Otherwise, we can use an internal relocation.
  53   return false;
  54 }
  55
  56 bool MachObjectWriter::
  57 MachSymbolData::operator<(const MachSymbolData &RHS) const {
  58   return Symbol->getName() < RHS.Symbol->getName();
  59 }
  60
  61 bool MachObjectWriter::isFixupKindPCRel(const MCAssembler &Asm, unsigned Kind) {
  62   const MCFixupKindInfo &FKI = Asm.getBackend().getFixupKindInfo(
  63     (MCFixupKind) Kind);
  64
  65   return FKI.Flags & MCFixupKindInfo::FKF_IsPCRel;
  66 }
  67
  68 uint64_t MachObjectWriter::getFragmentAddress(const MCFragment *Fragment,
  69                                               const MCAsmLayout &Layout) const {
  70   return getSectionAddress(Fragment->getParent()) +
  71          Layout.getFragmentOffset(Fragment);
  72 }
  73
  74 uint64_t MachObjectWriter::getSymbolAddress(const MCSymbol &S,
  75                                             const MCAsmLayout &Layout) const {
  76   // If this is a variable, then recursively evaluate now.
  77   if (S.isVariable()) {
  78     if (const MCConstantExpr *C =
  79           dyn_cast<const MCConstantExpr>(S.getVariableValue()))
  80       return C->getValue();
  81
  82
  83     MCValue Target;
  84     if (!S.getVariableValue()->evaluateAsRelocatable(Target, &Layout, nullptr))
  85       report_fatal_error("unable to evaluate offset for variable '" +
  86                          S.getName() + "'");
  87
  88     // Verify that any used symbols are defined.
  89     if (Target.getSymA() && Target.getSymA()->getSymbol().isUndefined())
  90       report_fatal_error("unable to evaluate offset to undefined symbol '" +
  91                          Target.getSymA()->getSymbol().getName() + "'");
  92     if (Target.getSymB() && Target.getSymB()->getSymbol().isUndefined())
  93       report_fatal_error("unable to evaluate offset to undefined symbol '" +
  94                          Target.getSymB()->getSymbol().getName() + "'");
  95
  96     uint64_t Address = Target.getConstant();
  97     if (Target.getSymA())
  98       Address += getSymbolAddress(Target.getSymA()->getSymbol(), Layout);
  99     if (Target.getSymB())
 100       Address += getSymbolAddress(Target.getSymB()->getSymbol(), Layout);
 101     return Address;
 102   }
 103
 104   return getSectionAddress(S.getFragment()->getParent()) +
 105          Layout.getSymbolOffset(S);
 106 }
 107
 108 uint64_t MachObjectWriter::getPaddingSize(const MCSection *Sec,
 109                                           const MCAsmLayout &Layout) const {
 110   uint64_t EndAddr = getSectionAddress(Sec) + Layout.getSectionAddressSize(Sec);
 111   unsigned Next = Sec->getLayoutOrder() + 1;
 112   if (Next >= Layout.getSectionOrder().size())
 113     return 0;
 114
 115   const MCSection &NextSec = *Layout.getSectionOrder()[Next];
 116   if (NextSec.isVirtualSection())
 117     return 0;
 118   return OffsetToAlignment(EndAddr, NextSec.getAlignment());
 119 }
 120
 121 void MachObjectWriter::writeHeader(unsigned NumLoadCommands,
 122                                    unsigned LoadCommandsSize,
 123                                    bool SubsectionsViaSymbols) {
 124   uint32_t Flags = 0;
 125
 126   if (SubsectionsViaSymbols)
 127     Flags |= MachO::MH_SUBSECTIONS_VIA_SYMBOLS;
 128
 129   // struct mach_header (28 bytes) or
 130   // struct mach_header_64 (32 bytes)
 131
 132   uint64_t Start = OS.tell();
 133   (void) Start;
 134
 135   write32(is64Bit() ? MachO::MH_MAGIC_64 : MachO::MH_MAGIC);
 136
 137   write32(TargetObjectWriter->getCPUType());
 138   write32(TargetObjectWriter->getCPUSubtype());
 139
 140   write32(MachO::MH_OBJECT);
 141   write32(NumLoadCommands);
 142   write32(LoadCommandsSize);
 143   write32(Flags);
 144   if (is64Bit())
 145     write32(0); // reserved
 146
 147   assert(OS.tell() - Start ==
 148          (is64Bit()?sizeof(MachO::mach_header_64): sizeof(MachO::mach_header)));
 149 }
 150
 151 /// writeSegmentLoadCommand - Write a segment load command.
 152 ///
 153 /// \param NumSections The number of sections in this segment.
 154 /// \param SectionDataSize The total size of the sections.
 155 void MachObjectWriter::writeSegmentLoadCommand(unsigned NumSections,
 156                                                uint64_t VMSize,
 157                                                uint64_t SectionDataStartOffset,
 158                                                uint64_t SectionDataSize) {
 159   // struct segment_command (56 bytes) or
 160   // struct segment_command_64 (72 bytes)
 161
 162   uint64_t Start = OS.tell();
 163   (void) Start;
 164
 165   unsigned SegmentLoadCommandSize =
 166     is64Bit() ? sizeof(MachO::segment_command_64):
 167     sizeof(MachO::segment_command);
 168   write32(is64Bit() ? MachO::LC_SEGMENT_64 : MachO::LC_SEGMENT);
 169   write32(SegmentLoadCommandSize +
 170           NumSections * (is64Bit() ? sizeof(MachO::section_64) :
 171                          sizeof(MachO::section)));
 172
 173   writeBytes("", 16);
 174   if (is64Bit()) {
 175     write64(0); // vmaddr
 176     write64(VMSize); // vmsize
 177     write64(SectionDataStartOffset); // file offset
 178     write64(SectionDataSize); // file size
 179   } else {
 180     write32(0); // vmaddr
 181     write32(VMSize); // vmsize
 182     write32(SectionDataStartOffset); // file offset
 183     write32(SectionDataSize); // file size
 184   }
 185   // maxprot
 186   write32(MachO::VM_PROT_READ | MachO::VM_PROT_WRITE | MachO::VM_PROT_EXECUTE);
 187   // initprot
 188   write32(MachO::VM_PROT_READ | MachO::VM_PROT_WRITE | MachO::VM_PROT_EXECUTE);
 189   write32(NumSections);
 190   write32(0); // flags
 191
 192   assert(OS.tell() - Start == SegmentLoadCommandSize);
 193 }
 194
 195 void MachObjectWriter::writeSection(const MCAssembler &Asm,
 196                                     const MCAsmLayout &Layout,
 197                                     const MCSection &Sec, uint64_t FileOffset,
 198                                     uint64_t RelocationsStart,
 199                                     unsigned NumRelocations) {
 200   uint64_t SectionSize = Layout.getSectionAddressSize(&Sec);
 201   const MCSectionMachO &Section = cast<MCSectionMachO>(Sec);
 202
 203   // The offset is unused for virtual sections.
 204   if (Section.isVirtualSection()) {
 205     assert(Layout.getSectionFileSize(&Sec) == 0 && "Invalid file size!");
 206     FileOffset = 0;
 207   }
 208
 209   // struct section (68 bytes) or
 210   // struct section_64 (80 bytes)
 211
 212   uint64_t Start = OS.tell();
 213   (void) Start;
 214
 215   writeBytes(Section.getSectionName(), 16);
 216   writeBytes(Section.getSegmentName(), 16);
 217   if (is64Bit()) {
 218     write64(getSectionAddress(&Sec)); // address
 219     write64(SectionSize); // size
 220   } else {
 221     write32(getSectionAddress(&Sec)); // address
 222     write32(SectionSize); // size
 223   }
 224   write32(FileOffset);
 225
 226   unsigned Flags = Section.getTypeAndAttributes();
 227   if (Section.hasInstructions())
 228     Flags |= MachO::S_ATTR_SOME_INSTRUCTIONS;
 229
 230   assert(isPowerOf2_32(Section.getAlignment()) && "Invalid alignment!");
 231   write32(Log2_32(Section.getAlignment()));
 232   write32(NumRelocations ? RelocationsStart : 0);
 233   write32(NumRelocations);
 234   write32(Flags);
 235   write32(IndirectSymBase.lookup(&Sec)); // reserved1
 236   write32(Section.getStubSize()); // reserved2
 237   if (is64Bit())
 238     write32(0); // reserved3
 239
 240   assert(OS.tell() - Start == (is64Bit() ? sizeof(MachO::section_64) :
 241                                sizeof(MachO::section)));
 242 }
 243
 244 void MachObjectWriter::writeSymtabLoadCommand(uint32_t SymbolOffset,
 245                                               uint32_t NumSymbols,
 246                                               uint32_t StringTableOffset,
 247                                               uint32_t StringTableSize) {
 248   // struct symtab_command (24 bytes)
 249
 250   uint64_t Start = OS.tell();
 251   (void) Start;
 252
 253   write32(MachO::LC_SYMTAB);
 254   write32(sizeof(MachO::symtab_command));
 255   write32(SymbolOffset);
 256   write32(NumSymbols);
 257   write32(StringTableOffset);
 258   write32(StringTableSize);
 259
 260   assert(OS.tell() - Start == sizeof(MachO::symtab_command));
 261 }
 262
 263 void MachObjectWriter::writeDysymtabLoadCommand(uint32_t FirstLocalSymbol,
 264                                                 uint32_t NumLocalSymbols,
 265                                                 uint32_t FirstExternalSymbol,
 266                                                 uint32_t NumExternalSymbols,
 267                                                 uint32_t FirstUndefinedSymbol,
 268                                                 uint32_t NumUndefinedSymbols,
 269                                                 uint32_t IndirectSymbolOffset,
 270                                                 uint32_t NumIndirectSymbols) {
 271   // struct dysymtab_command (80 bytes)
 272
 273   uint64_t Start = OS.tell();
 274   (void) Start;
 275
 276   write32(MachO::LC_DYSYMTAB);
 277   write32(sizeof(MachO::dysymtab_command));
 278   write32(FirstLocalSymbol);
 279   write32(NumLocalSymbols);
 280   write32(FirstExternalSymbol);
 281   write32(NumExternalSymbols);
 282   write32(FirstUndefinedSymbol);
 283   write32(NumUndefinedSymbols);
 284   write32(0); // tocoff
 285   write32(0); // ntoc
 286   write32(0); // modtaboff
 287   write32(0); // nmodtab
 288   write32(0); // extrefsymoff
 289   write32(0); // nextrefsyms
 290   write32(IndirectSymbolOffset);
 291   write32(NumIndirectSymbols);
 292   write32(0); // extreloff
 293   write32(0); // nextrel
 294   write32(0); // locreloff
 295   write32(0); // nlocrel
 296
 297   assert(OS.tell() - Start == sizeof(MachO::dysymtab_command));
 298 }
 299
 300 MachObjectWriter::MachSymbolData *
 301 MachObjectWriter::findSymbolData(const MCSymbol &Sym) {
 302   for (auto *SymbolData :
 303        {&LocalSymbolData, &ExternalSymbolData, &UndefinedSymbolData})
 304     for (MachSymbolData &Entry : *SymbolData)
 305       if (Entry.Symbol == &Sym)
 306         return &Entry;
 307
 308   return nullptr;
 309 }
 310
 311 const MCSymbol &MachObjectWriter::findAliasedSymbol(const MCSymbol &Sym) const {
 312   const MCSymbol *S = &Sym;
 313   while (S->isVariable()) {
 314     const MCExpr *Value = S->getVariableValue();
 315     const auto *Ref = dyn_cast<MCSymbolRefExpr>(Value);
 316     if (!Ref)
 317       return *S;
 318     S = &Ref->getSymbol();
 319   }
 320   return *S;
 321 }
 322
 323 void MachObjectWriter::writeNlist(MachSymbolData &MSD,
 324                                   const MCAsmLayout &Layout) {
 325   const MCSymbol *Symbol = MSD.Symbol;
 326   const MCSymbol &Data = *Symbol;
 327   const MCSymbol *AliasedSymbol = &findAliasedSymbol(*Symbol);
 328   uint8_t SectionIndex = MSD.SectionIndex;
 329   uint8_t Type = 0;
 330   uint64_t Address = 0;
 331   bool IsAlias = Symbol != AliasedSymbol;
 332
 333   const MCSymbol &OrigSymbol = *Symbol;
 334   MachSymbolData *AliaseeInfo;
 335   if (IsAlias) {
 336     AliaseeInfo = findSymbolData(*AliasedSymbol);
 337     if (AliaseeInfo)
 338       SectionIndex = AliaseeInfo->SectionIndex;
 339     Symbol = AliasedSymbol;
 340     // FIXME: Should this update Data as well?  Do we need OrigSymbol at all?
 341   }
 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 (IsAlias && Symbol->isUndefined())
 347     Type = MachO::N_INDR;
 348   else if (Symbol->isUndefined())
 349     Type = MachO::N_UNDF;
 350   else if (Symbol->isAbsolute())
 351     Type = MachO::N_ABS;
 352   else
 353     Type = MachO::N_SECT;
 354
 355   // FIXME: Set STAB bits.
 356
 357   if (Data.isPrivateExtern())
 358     Type |= MachO::N_PEXT;
 359
 360   // Set external bit.
 361   if (Data.isExternal() || (!IsAlias && Symbol->isUndefined()))
 362     Type |= MachO::N_EXT;
 363
 364   // Compute the symbol address.
 365   if (IsAlias && Symbol->isUndefined())
 366     Address = AliaseeInfo->StringIndex;
 367   else if (Symbol->isDefined())
 368     Address = getSymbolAddress(OrigSymbol, Layout);
 369   else if (Symbol->isCommon()) {
 370     // Common symbols are encoded with the size in the address
 371     // field, and their alignment in the flags.
 372     Address = Symbol->getCommonSize();
 373   }
 374
 375   // struct nlist (12 bytes)
 376
 377   write32(MSD.StringIndex);
 378   write8(Type);
 379   write8(SectionIndex);
 380
 381   // The Mach-O streamer uses the lowest 16-bits of the flags for the 'desc'
 382   // value.
 383   write16(cast<MCSymbolMachO>(Symbol)->getEncodedFlags());
 384   if (is64Bit())
 385     write64(Address);
 386   else
 387     write32(Address);
 388 }
 389
 390 void MachObjectWriter::writeLinkeditLoadCommand(uint32_t Type,
 391                                                 uint32_t DataOffset,
 392                                                 uint32_t DataSize) {
 393   uint64_t Start = OS.tell();
 394   (void) Start;
 395
 396   write32(Type);
 397   write32(sizeof(MachO::linkedit_data_command));
 398   write32(DataOffset);
 399   write32(DataSize);
 400
 401   assert(OS.tell() - Start == sizeof(MachO::linkedit_data_command));
 402 }
 403
 404 static unsigned ComputeLinkerOptionsLoadCommandSize(
 405   const std::vector<std::string> &Options, bool is64Bit)
 406 {
 407   unsigned Size = sizeof(MachO::linker_option_command);
 408   for (const std::string &Option : Options)
 409     Size += Option.size() + 1;
 410   return RoundUpToAlignment(Size, is64Bit ? 8 : 4);
 411 }
 412
 413 void MachObjectWriter::writeLinkerOptionsLoadCommand(
 414   const std::vector<std::string> &Options)
 415 {
 416   unsigned Size = ComputeLinkerOptionsLoadCommandSize(Options, is64Bit());
 417   uint64_t Start = OS.tell();
 418   (void) Start;
 419
 420   write32(MachO::LC_LINKER_OPTION);
 421   write32(Size);
 422   write32(Options.size());
 423   uint64_t BytesWritten = sizeof(MachO::linker_option_command);
 424   for (const std::string &Option : Options) {
 425     // Write each string, including the null byte.
 426     writeBytes(Option.c_str(), Option.size() + 1);
 427     BytesWritten += Option.size() + 1;
 428   }
 429
 430   // Pad to a multiple of the pointer size.
 431   writeBytes("", OffsetToAlignment(BytesWritten, is64Bit() ? 8 : 4));
 432
 433   assert(OS.tell() - Start == Size);
 434 }
 435
 436 void MachObjectWriter::recordRelocation(MCAssembler &Asm,
 437                                         const MCAsmLayout &Layout,
 438                                         const MCFragment *Fragment,
 439                                         const MCFixup &Fixup, MCValue Target,
 440                                         bool &IsPCRel, uint64_t &FixedValue) {
 441   TargetObjectWriter->recordRelocation(this, Asm, Layout, Fragment, Fixup,
 442                                        Target, FixedValue);
 443 }
 444
 445 void MachObjectWriter::bindIndirectSymbols(MCAssembler &Asm) {
 446   // This is the point where 'as' creates actual symbols for indirect symbols
 447   // (in the following two passes). It would be easier for us to do this sooner
 448   // when we see the attribute, but that makes getting the order in the symbol
 449   // table much more complicated than it is worth.
 450   //
 451   // FIXME: Revisit this when the dust settles.
 452
 453   // Report errors for use of .indirect_symbol not in a symbol pointer section
 454   // or stub section.
 455   for (MCAssembler::indirect_symbol_iterator it = Asm.indirect_symbol_begin(),
 456          ie = Asm.indirect_symbol_end(); it != ie; ++it) {
 457     const MCSectionMachO &Section = cast<MCSectionMachO>(*it->Section);
 458
 459     if (Section.getType() != MachO::S_NON_LAZY_SYMBOL_POINTERS &&
 460         Section.getType() != MachO::S_LAZY_SYMBOL_POINTERS &&
 461         Section.getType() != MachO::S_SYMBOL_STUBS) {
 462         MCSymbol &Symbol = *it->Symbol;
 463         report_fatal_error("indirect symbol '" + Symbol.getName() +
 464                            "' not in a symbol pointer or stub section");
 465     }
 466   }
 467
 468   // Bind non-lazy symbol pointers first.
 469   unsigned IndirectIndex = 0;
 470   for (MCAssembler::indirect_symbol_iterator it = Asm.indirect_symbol_begin(),
 471          ie = Asm.indirect_symbol_end(); it != ie; ++it, ++IndirectIndex) {
 472     const MCSectionMachO &Section = cast<MCSectionMachO>(*it->Section);
 473
 474     if (Section.getType() != MachO::S_NON_LAZY_SYMBOL_POINTERS)
 475       continue;
 476
 477     // Initialize the section indirect symbol base, if necessary.
 478     IndirectSymBase.insert(std::make_pair(it->Section, IndirectIndex));
 479
 480     Asm.registerSymbol(*it->Symbol);
 481   }
 482
 483   // Then lazy symbol pointers and symbol stubs.
 484   IndirectIndex = 0;
 485   for (MCAssembler::indirect_symbol_iterator it = Asm.indirect_symbol_begin(),
 486          ie = Asm.indirect_symbol_end(); it != ie; ++it, ++IndirectIndex) {
 487     const MCSectionMachO &Section = cast<MCSectionMachO>(*it->Section);
 488
 489     if (Section.getType() != MachO::S_LAZY_SYMBOL_POINTERS &&
 490         Section.getType() != MachO::S_SYMBOL_STUBS)
 491       continue;
 492
 493     // Initialize the section indirect symbol base, if necessary.
 494     IndirectSymBase.insert(std::make_pair(it->Section, IndirectIndex));
 495
 496     // Set the symbol type to undefined lazy, but only on construction.
 497     //
 498     // FIXME: Do not hardcode.
 499     bool Created;
 500     Asm.registerSymbol(*it->Symbol, &Created);
 501     if (Created)
 502       cast<MCSymbolMachO>(it->Symbol)->setReferenceTypeUndefinedLazy(true);
 503   }
 504 }
 505
 506 /// computeSymbolTable - Compute the symbol table data
 507 void MachObjectWriter::computeSymbolTable(
 508     MCAssembler &Asm, std::vector<MachSymbolData> &LocalSymbolData,
 509     std::vector<MachSymbolData> &ExternalSymbolData,
 510     std::vector<MachSymbolData> &UndefinedSymbolData) {
 511   // Build section lookup table.
 512   DenseMap<const MCSection*, uint8_t> SectionIndexMap;
 513   unsigned Index = 1;
 514   for (MCAssembler::iterator it = Asm.begin(),
 515          ie = Asm.end(); it != ie; ++it, ++Index)
 516     SectionIndexMap[&*it] = Index;
 517   assert(Index <= 256 && "Too many sections!");
 518
 519   // Build the string table.
 520   for (const MCSymbol &Symbol : Asm.symbols()) {
 521     if (!Asm.isSymbolLinkerVisible(Symbol))
 522       continue;
 523
 524     StringTable.add(Symbol.getName());
 525   }
 526   StringTable.finalize(StringTableBuilder::MachO);
 527
 528   // Build the symbol arrays but only for non-local symbols.
 529   //
 530   // The particular order that we collect and then sort the symbols is chosen to
 531   // match 'as'. Even though it doesn't matter for correctness, this is
 532   // important for letting us diff .o files.
 533   for (const MCSymbol &Symbol : Asm.symbols()) {
 534     // Ignore non-linker visible symbols.
 535     if (!Asm.isSymbolLinkerVisible(Symbol))
 536       continue;
 537
 538     if (!Symbol.isExternal() && !Symbol.isUndefined())
 539       continue;
 540
 541     MachSymbolData MSD;
 542     MSD.Symbol = &Symbol;
 543     MSD.StringIndex = StringTable.getOffset(Symbol.getName());
 544
 545     if (Symbol.isUndefined()) {
 546       MSD.SectionIndex = 0;
 547       UndefinedSymbolData.push_back(MSD);
 548     } else if (Symbol.isAbsolute()) {
 549       MSD.SectionIndex = 0;
 550       ExternalSymbolData.push_back(MSD);
 551     } else {
 552       MSD.SectionIndex = SectionIndexMap.lookup(&Symbol.getSection());
 553       assert(MSD.SectionIndex && "Invalid section index!");
 554       ExternalSymbolData.push_back(MSD);
 555     }
 556   }
 557
 558   // Now add the data for local symbols.
 559   for (const MCSymbol &Symbol : Asm.symbols()) {
 560     // Ignore non-linker visible symbols.
 561     if (!Asm.isSymbolLinkerVisible(Symbol))
 562       continue;
 563
 564     if (Symbol.isExternal() || Symbol.isUndefined())
 565       continue;
 566
 567     MachSymbolData MSD;
 568     MSD.Symbol = &Symbol;
 569     MSD.StringIndex = StringTable.getOffset(Symbol.getName());
 570
 571     if (Symbol.isAbsolute()) {
 572       MSD.SectionIndex = 0;
 573       LocalSymbolData.push_back(MSD);
 574     } else {
 575       MSD.SectionIndex = SectionIndexMap.lookup(&Symbol.getSection());
 576       assert(MSD.SectionIndex && "Invalid section index!");
 577       LocalSymbolData.push_back(MSD);
 578     }
 579   }
 580
 581   // External and undefined symbols are required to be in lexicographic order.
 582   std::sort(ExternalSymbolData.begin(), ExternalSymbolData.end());
 583   std::sort(UndefinedSymbolData.begin(), UndefinedSymbolData.end());
 584
 585   // Set the symbol indices.
 586   Index = 0;
 587   for (auto *SymbolData :
 588        {&LocalSymbolData, &ExternalSymbolData, &UndefinedSymbolData})
 589     for (MachSymbolData &Entry : *SymbolData)
 590       Entry.Symbol->setIndex(Index++);
 591
 592   for (const MCSection &Section : Asm) {
 593     for (RelAndSymbol &Rel : Relocations[&Section]) {
 594       if (!Rel.Sym)
 595         continue;
 596
 597       // Set the Index and the IsExtern bit.
 598       unsigned Index = Rel.Sym->getIndex();
 599       assert(isInt<24>(Index));
 600       if (IsLittleEndian)
 601         Rel.MRE.r_word1 = (Rel.MRE.r_word1 & (~0U << 24)) | Index | (1 << 27);
 602       else
 603         Rel.MRE.r_word1 = (Rel.MRE.r_word1 & 0xff) | Index << 8 | (1 << 4);
 604     }
 605   }
 606 }
 607
 608 void MachObjectWriter::computeSectionAddresses(const MCAssembler &Asm,
 609                                                const MCAsmLayout &Layout) {
 610   uint64_t StartAddress = 0;
 611   for (const MCSection *Sec : Layout.getSectionOrder()) {
 612     StartAddress = RoundUpToAlignment(StartAddress, Sec->getAlignment());
 613     SectionAddress[Sec] = StartAddress;
 614     StartAddress += Layout.getSectionAddressSize(Sec);
 615
 616     // Explicitly pad the section to match the alignment requirements of the
 617     // following one. This is for 'gas' compatibility, it shouldn't
 618     /// strictly be necessary.
 619     StartAddress += getPaddingSize(Sec, Layout);
 620   }
 621 }
 622
 623 void MachObjectWriter::executePostLayoutBinding(MCAssembler &Asm,
 624                                                 const MCAsmLayout &Layout) {
 625   computeSectionAddresses(Asm, Layout);
 626
 627   // Create symbol data for any indirect symbols.
 628   bindIndirectSymbols(Asm);
 629 }
 630
 631 bool MachObjectWriter::isSymbolRefDifferenceFullyResolvedImpl(
 632     const MCAssembler &Asm, const MCSymbol &SymA, const MCFragment &FB,
 633     bool InSet, bool IsPCRel) const {
 634   if (InSet)
 635     return true;
 636
 637   // The effective address is
 638   //     addr(atom(A)) + offset(A)
 639   //   - addr(atom(B)) - offset(B)
 640   // and the offsets are not relocatable, so the fixup is fully resolved when
 641   //  addr(atom(A)) - addr(atom(B)) == 0.
 642   const MCSymbol &SA = findAliasedSymbol(SymA);
 643   const MCSection &SecA = SA.getSection();
 644   const MCSection &SecB = *FB.getParent();
 645
 646   if (IsPCRel) {
 647     // The simple (Darwin, except on x86_64) way of dealing with this was to
 648     // assume that any reference to a temporary symbol *must* be a temporary
 649     // symbol in the same atom, unless the sections differ. Therefore, any PCrel
 650     // relocation to a temporary symbol (in the same section) is fully
 651     // resolved. This also works in conjunction with absolutized .set, which
 652     // requires the compiler to use .set to absolutize the differences between
 653     // symbols which the compiler knows to be assembly time constants, so we
 654     // don't need to worry about considering symbol differences fully resolved.
 655     //
 656     // If the file isn't using sub-sections-via-symbols, we can make the
 657     // same assumptions about any symbol that we normally make about
 658     // assembler locals.
 659
 660     bool hasReliableSymbolDifference = isX86_64();
 661     if (!hasReliableSymbolDifference) {
 662       if (!SA.isInSection() || &SecA != &SecB ||
 663           (!SA.isTemporary() && FB.getAtom() != SA.getFragment()->getAtom() &&
 664            Asm.getSubsectionsViaSymbols()))
 665         return false;
 666       return true;
 667     }
 668     // For Darwin x86_64, there is one special case when the reference IsPCRel.
 669     // If the fragment with the reference does not have a base symbol but meets
 670     // the simple way of dealing with this, in that it is a temporary symbol in
 671     // the same atom then it is assumed to be fully resolved.  This is needed so
 672     // a relocation entry is not created and so the static linker does not
 673     // mess up the reference later.
 674     else if(!FB.getAtom() &&
 675             SA.isTemporary() && SA.isInSection() && &SecA == &SecB){
 676       return true;
 677     }
 678   }
 679
 680   // If they are not in the same section, we can't compute the diff.
 681   if (&SecA != &SecB)
 682     return false;
 683
 684   const MCFragment *FA = SA.getFragment();
 685
 686   // Bail if the symbol has no fragment.
 687   if (!FA)
 688     return false;
 689
 690   // If the atoms are the same, they are guaranteed to have the same address.
 691   if (FA->getAtom() == FB.getAtom())
 692     return true;
 693
 694   // Otherwise, we can't prove this is fully resolved.
 695   return false;
 696 }
 697
 698 void MachObjectWriter::writeObject(MCAssembler &Asm,
 699                                    const MCAsmLayout &Layout) {
 700   // Compute symbol table information and bind symbol indices.
 701   computeSymbolTable(Asm, LocalSymbolData, ExternalSymbolData,
 702                      UndefinedSymbolData);
 703
 704   unsigned NumSections = Asm.size();
 705   const MCAssembler::VersionMinInfoType &VersionInfo =
 706     Layout.getAssembler().getVersionMinInfo();
 707
 708   // The section data starts after the header, the segment load command (and
 709   // section headers) and the symbol table.
 710   unsigned NumLoadCommands = 1;
 711   uint64_t LoadCommandsSize = is64Bit() ?
 712     sizeof(MachO::segment_command_64) + NumSections * sizeof(MachO::section_64):
 713     sizeof(MachO::segment_command) + NumSections * sizeof(MachO::section);
 714
 715   // Add the deployment target version info load command size, if used.
 716   if (VersionInfo.Major != 0) {
 717     ++NumLoadCommands;
 718     LoadCommandsSize += sizeof(MachO::version_min_command);
 719   }
 720
 721   // Add the data-in-code load command size, if used.
 722   unsigned NumDataRegions = Asm.getDataRegions().size();
 723   if (NumDataRegions) {
 724     ++NumLoadCommands;
 725     LoadCommandsSize += sizeof(MachO::linkedit_data_command);
 726   }
 727
 728   // Add the loh load command size, if used.
 729   uint64_t LOHRawSize = Asm.getLOHContainer().getEmitSize(*this, Layout);
 730   uint64_t LOHSize = RoundUpToAlignment(LOHRawSize, is64Bit() ? 8 : 4);
 731   if (LOHSize) {
 732     ++NumLoadCommands;
 733     LoadCommandsSize += sizeof(MachO::linkedit_data_command);
 734   }
 735
 736   // Add the symbol table load command sizes, if used.
 737   unsigned NumSymbols = LocalSymbolData.size() + ExternalSymbolData.size() +
 738     UndefinedSymbolData.size();
 739   if (NumSymbols) {
 740     NumLoadCommands += 2;
 741     LoadCommandsSize += (sizeof(MachO::symtab_command) +
 742                          sizeof(MachO::dysymtab_command));
 743   }
 744
 745   // Add the linker option load commands sizes.
 746   for (const auto &Option : Asm.getLinkerOptions()) {
 747     ++NumLoadCommands;
 748     LoadCommandsSize += ComputeLinkerOptionsLoadCommandSize(Option, is64Bit());
 749   }
 750
 751   // Compute the total size of the section data, as well as its file size and vm
 752   // size.
 753   uint64_t SectionDataStart = (is64Bit() ? sizeof(MachO::mach_header_64) :
 754                                sizeof(MachO::mach_header)) + LoadCommandsSize;
 755   uint64_t SectionDataSize = 0;
 756   uint64_t SectionDataFileSize = 0;
 757   uint64_t VMSize = 0;
 758   for (const MCSection &Sec : Asm) {
 759     uint64_t Address = getSectionAddress(&Sec);
 760     uint64_t Size = Layout.getSectionAddressSize(&Sec);
 761     uint64_t FileSize = Layout.getSectionFileSize(&Sec);
 762     FileSize += getPaddingSize(&Sec, Layout);
 763
 764     VMSize = std::max(VMSize, Address + Size);
 765
 766     if (Sec.isVirtualSection())
 767       continue;
 768
 769     SectionDataSize = std::max(SectionDataSize, Address + Size);
 770     SectionDataFileSize = std::max(SectionDataFileSize, Address + FileSize);
 771   }
 772
 773   // The section data is padded to 4 bytes.
 774   //
 775   // FIXME: Is this machine dependent?
 776   unsigned SectionDataPadding = OffsetToAlignment(SectionDataFileSize, 4);
 777   SectionDataFileSize += SectionDataPadding;
 778
 779   // Write the prolog, starting with the header and load command...
 780   writeHeader(NumLoadCommands, LoadCommandsSize,
 781               Asm.getSubsectionsViaSymbols());
 782   writeSegmentLoadCommand(NumSections, VMSize,
 783                           SectionDataStart, SectionDataSize);
 784
 785   // ... and then the section headers.
 786   uint64_t RelocTableEnd = SectionDataStart + SectionDataFileSize;
 787   for (const MCSection &Sec : Asm) {
 788     std::vector<RelAndSymbol> &Relocs = Relocations[&Sec];
 789     unsigned NumRelocs = Relocs.size();
 790     uint64_t SectionStart = SectionDataStart + getSectionAddress(&Sec);
 791     writeSection(Asm, Layout, Sec, SectionStart, RelocTableEnd, NumRelocs);
 792     RelocTableEnd += NumRelocs * sizeof(MachO::any_relocation_info);
 793   }
 794
 795   // Write out the deployment target information, if it's available.
 796   if (VersionInfo.Major != 0) {
 797     assert(VersionInfo.Update < 256 && "unencodable update target version");
 798     assert(VersionInfo.Minor < 256 && "unencodable minor target version");
 799     assert(VersionInfo.Major < 65536 && "unencodable major target version");
 800     uint32_t EncodedVersion = VersionInfo.Update | (VersionInfo.Minor << 8) |
 801       (VersionInfo.Major << 16);
 802     write32(VersionInfo.Kind == MCVM_OSXVersionMin ? MachO::LC_VERSION_MIN_MACOSX :
 803             MachO::LC_VERSION_MIN_IPHONEOS);
 804     write32(sizeof(MachO::version_min_command));
 805     write32(EncodedVersion);
 806     write32(0);         // reserved.
 807   }
 808
 809   // Write the data-in-code load command, if used.
 810   uint64_t DataInCodeTableEnd = RelocTableEnd + NumDataRegions * 8;
 811   if (NumDataRegions) {
 812     uint64_t DataRegionsOffset = RelocTableEnd;
 813     uint64_t DataRegionsSize = NumDataRegions * 8;
 814     writeLinkeditLoadCommand(MachO::LC_DATA_IN_CODE, DataRegionsOffset,
 815                              DataRegionsSize);
 816   }
 817
 818   // Write the loh load command, if used.
 819   uint64_t LOHTableEnd = DataInCodeTableEnd + LOHSize;
 820   if (LOHSize)
 821     writeLinkeditLoadCommand(MachO::LC_LINKER_OPTIMIZATION_HINT,
 822                              DataInCodeTableEnd, LOHSize);
 823
 824   // Write the symbol table load command, if used.
 825   if (NumSymbols) {
 826     unsigned FirstLocalSymbol = 0;
 827     unsigned NumLocalSymbols = LocalSymbolData.size();
 828     unsigned FirstExternalSymbol = FirstLocalSymbol + NumLocalSymbols;
 829     unsigned NumExternalSymbols = ExternalSymbolData.size();
 830     unsigned FirstUndefinedSymbol = FirstExternalSymbol + NumExternalSymbols;
 831     unsigned NumUndefinedSymbols = UndefinedSymbolData.size();
 832     unsigned NumIndirectSymbols = Asm.indirect_symbol_size();
 833     unsigned NumSymTabSymbols =
 834       NumLocalSymbols + NumExternalSymbols + NumUndefinedSymbols;
 835     uint64_t IndirectSymbolSize = NumIndirectSymbols * 4;
 836     uint64_t IndirectSymbolOffset = 0;
 837
 838     // If used, the indirect symbols are written after the section data.
 839     if (NumIndirectSymbols)
 840       IndirectSymbolOffset = LOHTableEnd;
 841
 842     // The symbol table is written after the indirect symbol data.
 843     uint64_t SymbolTableOffset = LOHTableEnd + IndirectSymbolSize;
 844
 845     // The string table is written after symbol table.
 846     uint64_t StringTableOffset =
 847       SymbolTableOffset + NumSymTabSymbols * (is64Bit() ?
 848                                               sizeof(MachO::nlist_64) :
 849                                               sizeof(MachO::nlist));
 850     writeSymtabLoadCommand(SymbolTableOffset, NumSymTabSymbols,
 851                            StringTableOffset, StringTable.data().size());
 852
 853     writeDysymtabLoadCommand(FirstLocalSymbol, NumLocalSymbols,
 854                              FirstExternalSymbol, NumExternalSymbols,
 855                              FirstUndefinedSymbol, NumUndefinedSymbols,
 856                              IndirectSymbolOffset, NumIndirectSymbols);
 857   }
 858
 859   // Write the linker options load commands.
 860   for (const auto &Option : Asm.getLinkerOptions())
 861     writeLinkerOptionsLoadCommand(Option);
 862
 863   // Write the actual section data.
 864   for (const MCSection &Sec : Asm) {
 865     Asm.writeSectionData(&Sec, Layout);
 866
 867     uint64_t Pad = getPaddingSize(&Sec, Layout);
 868     WriteZeros(Pad);
 869   }
 870
 871   // Write the extra padding.
 872   WriteZeros(SectionDataPadding);
 873
 874   // Write the relocation entries.
 875   for (const MCSection &Sec : Asm) {
 876     // Write the section relocation entries, in reverse order to match 'as'
 877     // (approximately, the exact algorithm is more complicated than this).
 878     std::vector<RelAndSymbol> &Relocs = Relocations[&Sec];
 879     for (const RelAndSymbol &Rel : make_range(Relocs.rbegin(), Relocs.rend())) {
 880       write32(Rel.MRE.r_word0);
 881       write32(Rel.MRE.r_word1);
 882     }
 883   }
 884
 885   // Write out the data-in-code region payload, if there is one.
 886   for (MCAssembler::const_data_region_iterator
 887          it = Asm.data_region_begin(), ie = Asm.data_region_end();
 888          it != ie; ++it) {
 889     const DataRegionData *Data = &(*it);
 890     uint64_t Start = getSymbolAddress(*Data->Start, Layout);
 891     uint64_t End = getSymbolAddress(*Data->End, Layout);
 892     DEBUG(dbgs() << "data in code region-- kind: " << Data->Kind
 893                  << "  start: " << Start << "(" << Data->Start->getName() << ")"
 894                  << "  end: " << End << "(" << Data->End->getName() << ")"
 895                  << "  size: " << End - Start
 896                  << "\n");
 897     write32(Start);
 898     write16(End - Start);
 899     write16(Data->Kind);
 900   }
 901
 902   // Write out the loh commands, if there is one.
 903   if (LOHSize) {
 904 #ifndef NDEBUG
 905     unsigned Start = OS.tell();
 906 #endif
 907     Asm.getLOHContainer().emit(*this, Layout);
 908     // Pad to a multiple of the pointer size.
 909     writeBytes("", OffsetToAlignment(LOHRawSize, is64Bit() ? 8 : 4));
 910     assert(OS.tell() - Start == LOHSize);
 911   }
 912
 913   // Write the symbol table data, if used.
 914   if (NumSymbols) {
 915     // Write the indirect symbol entries.
 916     for (MCAssembler::const_indirect_symbol_iterator
 917            it = Asm.indirect_symbol_begin(),
 918            ie = Asm.indirect_symbol_end(); it != ie; ++it) {
 919       // Indirect symbols in the non-lazy symbol pointer section have some
 920       // special handling.
 921       const MCSectionMachO &Section =
 922           static_cast<const MCSectionMachO &>(*it->Section);
 923       if (Section.getType() == MachO::S_NON_LAZY_SYMBOL_POINTERS) {
 924         // If this symbol is defined and internal, mark it as such.
 925         if (it->Symbol->isDefined() && !it->Symbol->isExternal()) {
 926           uint32_t Flags = MachO::INDIRECT_SYMBOL_LOCAL;
 927           if (it->Symbol->isAbsolute())
 928             Flags |= MachO::INDIRECT_SYMBOL_ABS;
 929           write32(Flags);
 930           continue;
 931         }
 932       }
 933
 934       write32(it->Symbol->getIndex());
 935     }
 936
 937     // FIXME: Check that offsets match computed ones.
 938
 939     // Write the symbol table entries.
 940     for (auto *SymbolData :
 941          {&LocalSymbolData, &ExternalSymbolData, &UndefinedSymbolData})
 942       for (MachSymbolData &Entry : *SymbolData)
 943         writeNlist(Entry, Layout);
 944
 945     // Write the string table.
 946     OS << StringTable.data();
 947   }
 948 }
 949
 950 MCObjectWriter *llvm::createMachObjectWriter(MCMachObjectTargetWriter *MOTW,
 951                                              raw_pwrite_stream &OS,
 952                                              bool IsLittleEndian) {
 953   return new MachObjectWriter(MOTW, OS, IsLittleEndian);
 954 }