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