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