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