1 //===- InputFiles.cpp -----------------------------------------------------===//
2 //
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6 //
7 //===----------------------------------------------------------------------===//
8 //
9 // This file contains functions to parse Mach-O object files. In this comment,
10 // we describe the Mach-O file structure and how we parse it.
11 //
12 // Mach-O is not very different from ELF or COFF. The notion of symbols,
13 // sections and relocations exists in Mach-O as it does in ELF and COFF.
14 //
15 // Perhaps the notion that is new to those who know ELF/COFF is "subsections".
16 // In ELF/COFF, sections are an atomic unit of data copied from input files to
17 // output files. When we merge or garbage-collect sections, we treat each
18 // section as an atomic unit. In Mach-O, that's not the case. Sections can
19 // consist of multiple subsections, and subsections are a unit of merging and
20 // garbage-collecting. Therefore, Mach-O's subsections are more similar to
21 // ELF/COFF's sections than Mach-O's sections are.
22 //
23 // A section can have multiple symbols. A symbol that does not have the
24 // N_ALT_ENTRY attribute indicates a beginning of a subsection. Therefore, by
25 // definition, a symbol is always present at the beginning of each subsection. A
26 // symbol with N_ALT_ENTRY attribute does not start a new subsection and can
27 // point to a middle of a subsection.
28 //
29 // The notion of subsections also affects how relocations are represented in
30 // Mach-O. All references within a section need to be explicitly represented as
31 // relocations if they refer to different subsections, because we obviously need
32 // to fix up addresses if subsections are laid out in an output file differently
33 // than they were in object files. To represent that, Mach-O relocations can
34 // refer to an unnamed location via its address. Scattered relocations (those
35 // with the R_SCATTERED bit set) always refer to unnamed locations.
36 // Non-scattered relocations refer to an unnamed location if r_extern is not set
37 // and r_symbolnum is zero.
38 //
39 // Without the above differences, I think you can use your knowledge about ELF
40 // and COFF for Mach-O.
41 //
42 //===----------------------------------------------------------------------===//
43 
44 #include "InputFiles.h"
45 #include "Config.h"
46 #include "Driver.h"
47 #include "Dwarf.h"
48 #include "ExportTrie.h"
49 #include "InputSection.h"
50 #include "MachOStructs.h"
51 #include "ObjC.h"
52 #include "OutputSection.h"
53 #include "OutputSegment.h"
54 #include "SymbolTable.h"
55 #include "Symbols.h"
56 #include "SyntheticSections.h"
57 #include "Target.h"
58 
59 #include "lld/Common/DWARF.h"
60 #include "lld/Common/ErrorHandler.h"
61 #include "lld/Common/Memory.h"
62 #include "lld/Common/Reproduce.h"
63 #include "llvm/ADT/iterator.h"
64 #include "llvm/BinaryFormat/MachO.h"
65 #include "llvm/LTO/LTO.h"
66 #include "llvm/Support/Endian.h"
67 #include "llvm/Support/MemoryBuffer.h"
68 #include "llvm/Support/Path.h"
69 #include "llvm/Support/TarWriter.h"
70 #include "llvm/TextAPI/Architecture.h"
71 #include "llvm/TextAPI/InterfaceFile.h"
72 
73 using namespace llvm;
74 using namespace llvm::MachO;
75 using namespace llvm::support::endian;
76 using namespace llvm::sys;
77 using namespace lld;
78 using namespace lld::macho;
79 
80 // Returns "<internal>", "foo.a(bar.o)", or "baz.o".
81 std::string lld::toString(const InputFile *f) {
82   if (!f)
83     return "<internal>";
84 
85   // Multiple dylibs can be defined in one .tbd file.
86   if (auto dylibFile = dyn_cast<DylibFile>(f))
87     if (f->getName().endswith(".tbd"))
88       return (f->getName() + "(" + dylibFile->installName + ")").str();
89 
90   if (f->archiveName.empty())
91     return std::string(f->getName());
92   return (f->archiveName + "(" + path::filename(f->getName()) + ")").str();
93 }
94 
95 SetVector<InputFile *> macho::inputFiles;
96 std::unique_ptr<TarWriter> macho::tar;
97 int InputFile::idCount = 0;
98 
99 static VersionTuple decodeVersion(uint32_t version) {
100   unsigned major = version >> 16;
101   unsigned minor = (version >> 8) & 0xffu;
102   unsigned subMinor = version & 0xffu;
103   return VersionTuple(major, minor, subMinor);
104 }
105 
106 static std::vector<PlatformInfo> getPlatformInfos(const InputFile *input) {
107   if (!isa<ObjFile>(input) && !isa<DylibFile>(input))
108     return {};
109 
110   const char *hdr = input->mb.getBufferStart();
111 
112   std::vector<PlatformInfo> platformInfos;
113   for (auto *cmd : findCommands<build_version_command>(hdr, LC_BUILD_VERSION)) {
114     PlatformInfo info;
115     info.target.Platform = static_cast<PlatformKind>(cmd->platform);
116     info.minimum = decodeVersion(cmd->minos);
117     platformInfos.emplace_back(std::move(info));
118   }
119   for (auto *cmd : findCommands<version_min_command>(
120            hdr, LC_VERSION_MIN_MACOSX, LC_VERSION_MIN_IPHONEOS,
121            LC_VERSION_MIN_TVOS, LC_VERSION_MIN_WATCHOS)) {
122     PlatformInfo info;
123     switch (cmd->cmd) {
124     case LC_VERSION_MIN_MACOSX:
125       info.target.Platform = PlatformKind::macOS;
126       break;
127     case LC_VERSION_MIN_IPHONEOS:
128       info.target.Platform = PlatformKind::iOS;
129       break;
130     case LC_VERSION_MIN_TVOS:
131       info.target.Platform = PlatformKind::tvOS;
132       break;
133     case LC_VERSION_MIN_WATCHOS:
134       info.target.Platform = PlatformKind::watchOS;
135       break;
136     }
137     info.minimum = decodeVersion(cmd->version);
138     platformInfos.emplace_back(std::move(info));
139   }
140 
141   return platformInfos;
142 }
143 
144 static PlatformKind removeSimulator(PlatformKind platform) {
145   // Mapping of platform to simulator and vice-versa.
146   static const std::map<PlatformKind, PlatformKind> platformMap = {
147       {PlatformKind::iOSSimulator, PlatformKind::iOS},
148       {PlatformKind::tvOSSimulator, PlatformKind::tvOS},
149       {PlatformKind::watchOSSimulator, PlatformKind::watchOS}};
150 
151   auto iter = platformMap.find(platform);
152   if (iter == platformMap.end())
153     return platform;
154   return iter->second;
155 }
156 
157 static bool checkCompatibility(const InputFile *input) {
158   std::vector<PlatformInfo> platformInfos = getPlatformInfos(input);
159   if (platformInfos.empty())
160     return true;
161 
162   auto it = find_if(platformInfos, [&](const PlatformInfo &info) {
163     return removeSimulator(info.target.Platform) ==
164            removeSimulator(config->platform());
165   });
166   if (it == platformInfos.end()) {
167     std::string platformNames;
168     raw_string_ostream os(platformNames);
169     interleave(
170         platformInfos, os,
171         [&](const PlatformInfo &info) {
172           os << getPlatformName(info.target.Platform);
173         },
174         "/");
175     error(toString(input) + " has platform " + platformNames +
176           Twine(", which is different from target platform ") +
177           getPlatformName(config->platform()));
178     return false;
179   }
180 
181   if (it->minimum > config->platformInfo.minimum)
182     warn(toString(input) + " has version " + it->minimum.getAsString() +
183          ", which is newer than target minimum of " +
184          config->platformInfo.minimum.getAsString());
185 
186   return true;
187 }
188 
189 // Open a given file path and return it as a memory-mapped file.
190 Optional<MemoryBufferRef> macho::readFile(StringRef path) {
191   ErrorOr<std::unique_ptr<MemoryBuffer>> mbOrErr = MemoryBuffer::getFile(path);
192   if (std::error_code ec = mbOrErr.getError()) {
193     error("cannot open " + path + ": " + ec.message());
194     return None;
195   }
196 
197   std::unique_ptr<MemoryBuffer> &mb = *mbOrErr;
198   MemoryBufferRef mbref = mb->getMemBufferRef();
199   make<std::unique_ptr<MemoryBuffer>>(std::move(mb)); // take mb ownership
200 
201   // If this is a regular non-fat file, return it.
202   const char *buf = mbref.getBufferStart();
203   const auto *hdr = reinterpret_cast<const fat_header *>(buf);
204   if (mbref.getBufferSize() < sizeof(uint32_t) ||
205       read32be(&hdr->magic) != FAT_MAGIC) {
206     if (tar)
207       tar->append(relativeToRoot(path), mbref.getBuffer());
208     return mbref;
209   }
210 
211   // Object files and archive files may be fat files, which contain multiple
212   // real files for different CPU ISAs. Here, we search for a file that matches
213   // with the current link target and returns it as a MemoryBufferRef.
214   const auto *arch = reinterpret_cast<const fat_arch *>(buf + sizeof(*hdr));
215 
216   for (uint32_t i = 0, n = read32be(&hdr->nfat_arch); i < n; ++i) {
217     if (reinterpret_cast<const char *>(arch + i + 1) >
218         buf + mbref.getBufferSize()) {
219       error(path + ": fat_arch struct extends beyond end of file");
220       return None;
221     }
222 
223     if (read32be(&arch[i].cputype) != static_cast<uint32_t>(target->cpuType) ||
224         read32be(&arch[i].cpusubtype) != target->cpuSubtype)
225       continue;
226 
227     uint32_t offset = read32be(&arch[i].offset);
228     uint32_t size = read32be(&arch[i].size);
229     if (offset + size > mbref.getBufferSize())
230       error(path + ": slice extends beyond end of file");
231     if (tar)
232       tar->append(relativeToRoot(path), mbref.getBuffer());
233     return MemoryBufferRef(StringRef(buf + offset, size), path.copy(bAlloc));
234   }
235 
236   error("unable to find matching architecture in " + path);
237   return None;
238 }
239 
240 InputFile::InputFile(Kind kind, const InterfaceFile &interface)
241     : id(idCount++), fileKind(kind), name(saver.save(interface.getPath())) {}
242 
243 template <class Section>
244 void ObjFile::parseSections(ArrayRef<Section> sections) {
245   subsections.reserve(sections.size());
246   auto *buf = reinterpret_cast<const uint8_t *>(mb.getBufferStart());
247 
248   for (const Section &sec : sections) {
249     StringRef name =
250         StringRef(sec.sectname, strnlen(sec.sectname, sizeof(sec.sectname)));
251     StringRef segname =
252         StringRef(sec.segname, strnlen(sec.segname, sizeof(sec.segname)));
253     ArrayRef<uint8_t> data = {isZeroFill(sec.flags) ? nullptr
254                                                     : buf + sec.offset,
255                               static_cast<size_t>(sec.size)};
256     if (sec.align >= 32) {
257       error("alignment " + std::to_string(sec.align) + " of section " + name +
258             " is too large");
259       subsections.push_back({});
260       continue;
261     }
262     uint32_t align = 1 << sec.align;
263     uint32_t flags = sec.flags;
264 
265     if (config->dedupLiterals &&
266         (sectionType(sec.flags) == S_CSTRING_LITERALS ||
267          isWordLiteralSection(sec.flags))) {
268       if (sec.nreloc)
269         fatal(toString(this) + " contains relocations in " + sec.segname + "," +
270               sec.sectname +
271               ", so LLD cannot deduplicate literals. Try re-running without "
272               "--deduplicate-literals.");
273 
274       InputSection *isec;
275       if (sectionType(sec.flags) == S_CSTRING_LITERALS) {
276         isec =
277             make<CStringInputSection>(segname, name, this, data, align, flags);
278         // FIXME: parallelize this?
279         cast<CStringInputSection>(isec)->splitIntoPieces();
280       } else {
281         isec = make<WordLiteralInputSection>(segname, name, this, data, align,
282                                              flags);
283       }
284       subsections.push_back({{0, isec}});
285     } else {
286       auto *isec =
287           make<ConcatInputSection>(segname, name, this, data, align, flags);
288       if (!(isDebugSection(isec->flags) &&
289             isec->segname == segment_names::dwarf)) {
290         subsections.push_back({{0, isec}});
291       } else {
292         // Instead of emitting DWARF sections, we emit STABS symbols to the
293         // object files that contain them. We filter them out early to avoid
294         // parsing their relocations unnecessarily. But we must still push an
295         // empty map to ensure the indices line up for the remaining sections.
296         subsections.push_back({});
297         debugSections.push_back(isec);
298       }
299     }
300   }
301 }
302 
303 // Find the subsection corresponding to the greatest section offset that is <=
304 // that of the given offset.
305 //
306 // offset: an offset relative to the start of the original InputSection (before
307 // any subsection splitting has occurred). It will be updated to represent the
308 // same location as an offset relative to the start of the containing
309 // subsection.
310 static InputSection *findContainingSubsection(SubsectionMap &map,
311                                               uint64_t *offset) {
312   auto it = std::prev(llvm::upper_bound(
313       map, *offset, [](uint64_t value, SubsectionEntry subsecEntry) {
314         return value < subsecEntry.offset;
315       }));
316   *offset -= it->offset;
317   return it->isec;
318 }
319 
320 template <class Section>
321 static bool validateRelocationInfo(InputFile *file, const Section &sec,
322                                    relocation_info rel) {
323   const RelocAttrs &relocAttrs = target->getRelocAttrs(rel.r_type);
324   bool valid = true;
325   auto message = [relocAttrs, file, sec, rel, &valid](const Twine &diagnostic) {
326     valid = false;
327     return (relocAttrs.name + " relocation " + diagnostic + " at offset " +
328             std::to_string(rel.r_address) + " of " + sec.segname + "," +
329             sec.sectname + " in " + toString(file))
330         .str();
331   };
332 
333   if (!relocAttrs.hasAttr(RelocAttrBits::LOCAL) && !rel.r_extern)
334     error(message("must be extern"));
335   if (relocAttrs.hasAttr(RelocAttrBits::PCREL) != rel.r_pcrel)
336     error(message(Twine("must ") + (rel.r_pcrel ? "not " : "") +
337                   "be PC-relative"));
338   if (isThreadLocalVariables(sec.flags) &&
339       !relocAttrs.hasAttr(RelocAttrBits::UNSIGNED))
340     error(message("not allowed in thread-local section, must be UNSIGNED"));
341   if (rel.r_length < 2 || rel.r_length > 3 ||
342       !relocAttrs.hasAttr(static_cast<RelocAttrBits>(1 << rel.r_length))) {
343     static SmallVector<StringRef, 4> widths{"0", "4", "8", "4 or 8"};
344     error(message("has width " + std::to_string(1 << rel.r_length) +
345                   " bytes, but must be " +
346                   widths[(static_cast<int>(relocAttrs.bits) >> 2) & 3] +
347                   " bytes"));
348   }
349   return valid;
350 }
351 
352 template <class Section>
353 void ObjFile::parseRelocations(ArrayRef<Section> sectionHeaders,
354                                const Section &sec, SubsectionMap &subsecMap) {
355   auto *buf = reinterpret_cast<const uint8_t *>(mb.getBufferStart());
356   ArrayRef<relocation_info> relInfos(
357       reinterpret_cast<const relocation_info *>(buf + sec.reloff), sec.nreloc);
358 
359   for (size_t i = 0; i < relInfos.size(); i++) {
360     // Paired relocations serve as Mach-O's method for attaching a
361     // supplemental datum to a primary relocation record. ELF does not
362     // need them because the *_RELOC_RELA records contain the extra
363     // addend field, vs. *_RELOC_REL which omit the addend.
364     //
365     // The {X86_64,ARM64}_RELOC_SUBTRACTOR record holds the subtrahend,
366     // and the paired *_RELOC_UNSIGNED record holds the minuend. The
367     // datum for each is a symbolic address. The result is the offset
368     // between two addresses.
369     //
370     // The ARM64_RELOC_ADDEND record holds the addend, and the paired
371     // ARM64_RELOC_BRANCH26 or ARM64_RELOC_PAGE21/PAGEOFF12 holds the
372     // base symbolic address.
373     //
374     // Note: X86 does not use *_RELOC_ADDEND because it can embed an
375     // addend into the instruction stream. On X86, a relocatable address
376     // field always occupies an entire contiguous sequence of byte(s),
377     // so there is no need to merge opcode bits with address
378     // bits. Therefore, it's easy and convenient to store addends in the
379     // instruction-stream bytes that would otherwise contain zeroes. By
380     // contrast, RISC ISAs such as ARM64 mix opcode bits with with
381     // address bits so that bitwise arithmetic is necessary to extract
382     // and insert them. Storing addends in the instruction stream is
383     // possible, but inconvenient and more costly at link time.
384 
385     int64_t pairedAddend = 0;
386     relocation_info relInfo = relInfos[i];
387     if (target->hasAttr(relInfo.r_type, RelocAttrBits::ADDEND)) {
388       pairedAddend = SignExtend64<24>(relInfo.r_symbolnum);
389       relInfo = relInfos[++i];
390     }
391     assert(i < relInfos.size());
392     if (!validateRelocationInfo(this, sec, relInfo))
393       continue;
394     if (relInfo.r_address & R_SCATTERED)
395       fatal("TODO: Scattered relocations not supported");
396 
397     bool isSubtrahend =
398         target->hasAttr(relInfo.r_type, RelocAttrBits::SUBTRAHEND);
399     int64_t embeddedAddend = target->getEmbeddedAddend(mb, sec.offset, relInfo);
400     assert(!(embeddedAddend && pairedAddend));
401     int64_t totalAddend = pairedAddend + embeddedAddend;
402     Reloc r;
403     r.type = relInfo.r_type;
404     r.pcrel = relInfo.r_pcrel;
405     r.length = relInfo.r_length;
406     r.offset = relInfo.r_address;
407     if (relInfo.r_extern) {
408       r.referent = symbols[relInfo.r_symbolnum];
409       r.addend = isSubtrahend ? 0 : totalAddend;
410     } else {
411       assert(!isSubtrahend);
412       const Section &referentSec = sectionHeaders[relInfo.r_symbolnum - 1];
413       uint64_t referentOffset;
414       if (relInfo.r_pcrel) {
415         // The implicit addend for pcrel section relocations is the pcrel offset
416         // in terms of the addresses in the input file. Here we adjust it so
417         // that it describes the offset from the start of the referent section.
418         // FIXME This logic was written around x86_64 behavior -- ARM64 doesn't
419         // have pcrel section relocations. We may want to factor this out into
420         // the arch-specific .cpp file.
421         assert(target->hasAttr(r.type, RelocAttrBits::BYTE4));
422         referentOffset =
423             sec.addr + relInfo.r_address + 4 + totalAddend - referentSec.addr;
424       } else {
425         // The addend for a non-pcrel relocation is its absolute address.
426         referentOffset = totalAddend - referentSec.addr;
427       }
428       SubsectionMap &referentSubsecMap = subsections[relInfo.r_symbolnum - 1];
429       r.referent = findContainingSubsection(referentSubsecMap, &referentOffset);
430       r.addend = referentOffset;
431     }
432 
433     InputSection *subsec = findContainingSubsection(subsecMap, &r.offset);
434     subsec->relocs.push_back(r);
435 
436     if (isSubtrahend) {
437       relocation_info minuendInfo = relInfos[++i];
438       // SUBTRACTOR relocations should always be followed by an UNSIGNED one
439       // attached to the same address.
440       assert(target->hasAttr(minuendInfo.r_type, RelocAttrBits::UNSIGNED) &&
441              relInfo.r_address == minuendInfo.r_address);
442       Reloc p;
443       p.type = minuendInfo.r_type;
444       if (minuendInfo.r_extern) {
445         p.referent = symbols[minuendInfo.r_symbolnum];
446         p.addend = totalAddend;
447       } else {
448         uint64_t referentOffset =
449             totalAddend - sectionHeaders[minuendInfo.r_symbolnum - 1].addr;
450         SubsectionMap &referentSubsecMap =
451             subsections[minuendInfo.r_symbolnum - 1];
452         p.referent =
453             findContainingSubsection(referentSubsecMap, &referentOffset);
454         p.addend = referentOffset;
455       }
456       subsec->relocs.push_back(p);
457     }
458   }
459 }
460 
461 template <class NList>
462 static macho::Symbol *createDefined(const NList &sym, StringRef name,
463                                     InputSection *isec, uint64_t value,
464                                     uint64_t size) {
465   // Symbol scope is determined by sym.n_type & (N_EXT | N_PEXT):
466   // N_EXT: Global symbols. These go in the symbol table during the link,
467   //        and also in the export table of the output so that the dynamic
468   //        linker sees them.
469   // N_EXT | N_PEXT: Linkage unit (think: dylib) scoped. These go in the
470   //                 symbol table during the link so that duplicates are
471   //                 either reported (for non-weak symbols) or merged
472   //                 (for weak symbols), but they do not go in the export
473   //                 table of the output.
474   // N_PEXT: Does not occur in input files in practice,
475   //         a private extern must be external.
476   // 0: Translation-unit scoped. These are not in the symbol table during
477   //    link, and not in the export table of the output either.
478 
479   bool isWeakDefCanBeHidden =
480       (sym.n_desc & (N_WEAK_DEF | N_WEAK_REF)) == (N_WEAK_DEF | N_WEAK_REF);
481 
482   if (sym.n_type & (N_EXT | N_PEXT)) {
483     assert((sym.n_type & N_EXT) && "invalid input");
484     bool isPrivateExtern = sym.n_type & N_PEXT;
485 
486     // lld's behavior for merging symbols is slightly different from ld64:
487     // ld64 picks the winning symbol based on several criteria (see
488     // pickBetweenRegularAtoms() in ld64's SymbolTable.cpp), while lld
489     // just merges metadata and keeps the contents of the first symbol
490     // with that name (see SymbolTable::addDefined). For:
491     // * inline function F in a TU built with -fvisibility-inlines-hidden
492     // * and inline function F in another TU built without that flag
493     // ld64 will pick the one from the file built without
494     // -fvisibility-inlines-hidden.
495     // lld will instead pick the one listed first on the link command line and
496     // give it visibility as if the function was built without
497     // -fvisibility-inlines-hidden.
498     // If both functions have the same contents, this will have the same
499     // behavior. If not, it won't, but the input had an ODR violation in
500     // that case.
501     //
502     // Similarly, merging a symbol
503     // that's isPrivateExtern and not isWeakDefCanBeHidden with one
504     // that's not isPrivateExtern but isWeakDefCanBeHidden technically
505     // should produce one
506     // that's not isPrivateExtern but isWeakDefCanBeHidden. That matters
507     // with ld64's semantics, because it means the non-private-extern
508     // definition will continue to take priority if more private extern
509     // definitions are encountered. With lld's semantics there's no observable
510     // difference between a symbol that's isWeakDefCanBeHidden or one that's
511     // privateExtern -- neither makes it into the dynamic symbol table. So just
512     // promote isWeakDefCanBeHidden to isPrivateExtern here.
513     if (isWeakDefCanBeHidden)
514       isPrivateExtern = true;
515 
516     return symtab->addDefined(
517         name, isec->file, isec, value, size, sym.n_desc & N_WEAK_DEF,
518         isPrivateExtern, sym.n_desc & N_ARM_THUMB_DEF,
519         sym.n_desc & REFERENCED_DYNAMICALLY, sym.n_desc & N_NO_DEAD_STRIP);
520   }
521 
522   assert(!isWeakDefCanBeHidden &&
523          "weak_def_can_be_hidden on already-hidden symbol?");
524   return make<Defined>(
525       name, isec->file, isec, value, size, sym.n_desc & N_WEAK_DEF,
526       /*isExternal=*/false, /*isPrivateExtern=*/false,
527       sym.n_desc & N_ARM_THUMB_DEF, sym.n_desc & REFERENCED_DYNAMICALLY,
528       sym.n_desc & N_NO_DEAD_STRIP);
529 }
530 
531 // Absolute symbols are defined symbols that do not have an associated
532 // InputSection. They cannot be weak.
533 template <class NList>
534 static macho::Symbol *createAbsolute(const NList &sym, InputFile *file,
535                                      StringRef name) {
536   if (sym.n_type & (N_EXT | N_PEXT)) {
537     assert((sym.n_type & N_EXT) && "invalid input");
538     return symtab->addDefined(name, file, nullptr, sym.n_value, /*size=*/0,
539                               /*isWeakDef=*/false, sym.n_type & N_PEXT,
540                               sym.n_desc & N_ARM_THUMB_DEF,
541                               /*isReferencedDynamically=*/false,
542                               sym.n_desc & N_NO_DEAD_STRIP);
543   }
544   return make<Defined>(name, file, nullptr, sym.n_value, /*size=*/0,
545                        /*isWeakDef=*/false,
546                        /*isExternal=*/false, /*isPrivateExtern=*/false,
547                        sym.n_desc & N_ARM_THUMB_DEF,
548                        /*isReferencedDynamically=*/false,
549                        sym.n_desc & N_NO_DEAD_STRIP);
550 }
551 
552 template <class NList>
553 macho::Symbol *ObjFile::parseNonSectionSymbol(const NList &sym,
554                                               StringRef name) {
555   uint8_t type = sym.n_type & N_TYPE;
556   switch (type) {
557   case N_UNDF:
558     return sym.n_value == 0
559                ? symtab->addUndefined(name, this, sym.n_desc & N_WEAK_REF)
560                : symtab->addCommon(name, this, sym.n_value,
561                                    1 << GET_COMM_ALIGN(sym.n_desc),
562                                    sym.n_type & N_PEXT);
563   case N_ABS:
564     return createAbsolute(sym, this, name);
565   case N_PBUD:
566   case N_INDR:
567     error("TODO: support symbols of type " + std::to_string(type));
568     return nullptr;
569   case N_SECT:
570     llvm_unreachable(
571         "N_SECT symbols should not be passed to parseNonSectionSymbol");
572   default:
573     llvm_unreachable("invalid symbol type");
574   }
575 }
576 
577 template <class LP>
578 void ObjFile::parseSymbols(ArrayRef<typename LP::section> sectionHeaders,
579                            ArrayRef<typename LP::nlist> nList,
580                            const char *strtab, bool subsectionsViaSymbols) {
581   using NList = typename LP::nlist;
582 
583   // Groups indices of the symbols by the sections that contain them.
584   std::vector<std::vector<uint32_t>> symbolsBySection(subsections.size());
585   symbols.resize(nList.size());
586   for (uint32_t i = 0; i < nList.size(); ++i) {
587     const NList &sym = nList[i];
588     StringRef name = strtab + sym.n_strx;
589     if ((sym.n_type & N_TYPE) == N_SECT) {
590       SubsectionMap &subsecMap = subsections[sym.n_sect - 1];
591       // parseSections() may have chosen not to parse this section.
592       if (subsecMap.empty())
593         continue;
594       symbolsBySection[sym.n_sect - 1].push_back(i);
595     } else {
596       symbols[i] = parseNonSectionSymbol(sym, name);
597     }
598   }
599 
600   // Calculate symbol sizes and create subsections by splitting the sections
601   // along symbol boundaries.
602   for (size_t i = 0; i < subsections.size(); ++i) {
603     SubsectionMap &subsecMap = subsections[i];
604     if (subsecMap.empty())
605       continue;
606 
607     std::vector<uint32_t> &symbolIndices = symbolsBySection[i];
608     llvm::sort(symbolIndices, [&](uint32_t lhs, uint32_t rhs) {
609       return nList[lhs].n_value < nList[rhs].n_value;
610     });
611     uint64_t sectionAddr = sectionHeaders[i].addr;
612     uint32_t sectionAlign = 1u << sectionHeaders[i].align;
613 
614     // We populate subsecMap by repeatedly splitting the last (highest address)
615     // subsection.
616     SubsectionEntry subsecEntry = subsecMap.back();
617     for (size_t j = 0; j < symbolIndices.size(); ++j) {
618       uint32_t symIndex = symbolIndices[j];
619       const NList &sym = nList[symIndex];
620       StringRef name = strtab + sym.n_strx;
621       InputSection *isec = subsecEntry.isec;
622 
623       uint64_t subsecAddr = sectionAddr + subsecEntry.offset;
624       uint64_t symbolOffset = sym.n_value - subsecAddr;
625       uint64_t symbolSize =
626           j + 1 < symbolIndices.size()
627               ? nList[symbolIndices[j + 1]].n_value - sym.n_value
628               : isec->data.size() - symbolOffset;
629       // There are 4 cases where we do not need to create a new subsection:
630       //   1. If the input file does not use subsections-via-symbols.
631       //   2. Multiple symbols at the same address only induce one subsection.
632       //      (The symbolOffset == 0 check covers both this case as well as
633       //      the first loop iteration.)
634       //   3. Alternative entry points do not induce new subsections.
635       //   4. If we have a literal section (e.g. __cstring and __literal4).
636       if (!subsectionsViaSymbols || symbolOffset == 0 ||
637           sym.n_desc & N_ALT_ENTRY || !isa<ConcatInputSection>(isec)) {
638         symbols[symIndex] =
639             createDefined(sym, name, isec, symbolOffset, symbolSize);
640         continue;
641       }
642       auto *concatIsec = cast<ConcatInputSection>(isec);
643 
644       auto *nextIsec = make<ConcatInputSection>(*concatIsec);
645       nextIsec->numRefs = 0;
646       nextIsec->wasCoalesced = false;
647       if (isZeroFill(isec->flags)) {
648         // Zero-fill sections have NULL data.data() non-zero data.size()
649         nextIsec->data = {nullptr, isec->data.size() - symbolOffset};
650         isec->data = {nullptr, symbolOffset};
651       } else {
652         nextIsec->data = isec->data.slice(symbolOffset);
653         isec->data = isec->data.slice(0, symbolOffset);
654       }
655 
656       // By construction, the symbol will be at offset zero in the new
657       // subsection.
658       symbols[symIndex] =
659           createDefined(sym, name, nextIsec, /*value=*/0, symbolSize);
660       // TODO: ld64 appears to preserve the original alignment as well as each
661       // subsection's offset from the last aligned address. We should consider
662       // emulating that behavior.
663       nextIsec->align = MinAlign(sectionAlign, sym.n_value);
664       subsecMap.push_back({sym.n_value - sectionAddr, nextIsec});
665       subsecEntry = subsecMap.back();
666     }
667   }
668 }
669 
670 OpaqueFile::OpaqueFile(MemoryBufferRef mb, StringRef segName,
671                        StringRef sectName)
672     : InputFile(OpaqueKind, mb) {
673   ConcatInputSection *isec =
674       make<ConcatInputSection>(segName.take_front(16), sectName.take_front(16));
675   isec->file = this;
676   const auto *buf = reinterpret_cast<const uint8_t *>(mb.getBufferStart());
677   isec->data = {buf, mb.getBufferSize()};
678   isec->live = true;
679   subsections.push_back({{0, isec}});
680 }
681 
682 ObjFile::ObjFile(MemoryBufferRef mb, uint32_t modTime, StringRef archiveName)
683     : InputFile(ObjKind, mb), modTime(modTime) {
684   this->archiveName = std::string(archiveName);
685   if (target->wordSize == 8)
686     parse<LP64>();
687   else
688     parse<ILP32>();
689 }
690 
691 template <class LP> void ObjFile::parse() {
692   using Header = typename LP::mach_header;
693   using SegmentCommand = typename LP::segment_command;
694   using Section = typename LP::section;
695   using NList = typename LP::nlist;
696 
697   auto *buf = reinterpret_cast<const uint8_t *>(mb.getBufferStart());
698   auto *hdr = reinterpret_cast<const Header *>(mb.getBufferStart());
699 
700   Architecture arch = getArchitectureFromCpuType(hdr->cputype, hdr->cpusubtype);
701   if (arch != config->arch()) {
702     error(toString(this) + " has architecture " + getArchitectureName(arch) +
703           " which is incompatible with target architecture " +
704           getArchitectureName(config->arch()));
705     return;
706   }
707 
708   if (!checkCompatibility(this))
709     return;
710 
711   for (auto *cmd : findCommands<linker_option_command>(hdr, LC_LINKER_OPTION)) {
712     StringRef data{reinterpret_cast<const char *>(cmd + 1),
713                    cmd->cmdsize - sizeof(linker_option_command)};
714     parseLCLinkerOption(this, cmd->count, data);
715   }
716 
717   ArrayRef<Section> sectionHeaders;
718   if (const load_command *cmd = findCommand(hdr, LP::segmentLCType)) {
719     auto *c = reinterpret_cast<const SegmentCommand *>(cmd);
720     sectionHeaders =
721         ArrayRef<Section>{reinterpret_cast<const Section *>(c + 1), c->nsects};
722     parseSections(sectionHeaders);
723   }
724 
725   // TODO: Error on missing LC_SYMTAB?
726   if (const load_command *cmd = findCommand(hdr, LC_SYMTAB)) {
727     auto *c = reinterpret_cast<const symtab_command *>(cmd);
728     ArrayRef<NList> nList(reinterpret_cast<const NList *>(buf + c->symoff),
729                           c->nsyms);
730     const char *strtab = reinterpret_cast<const char *>(buf) + c->stroff;
731     bool subsectionsViaSymbols = hdr->flags & MH_SUBSECTIONS_VIA_SYMBOLS;
732     parseSymbols<LP>(sectionHeaders, nList, strtab, subsectionsViaSymbols);
733   }
734 
735   // The relocations may refer to the symbols, so we parse them after we have
736   // parsed all the symbols.
737   for (size_t i = 0, n = subsections.size(); i < n; ++i)
738     if (!subsections[i].empty())
739       parseRelocations(sectionHeaders, sectionHeaders[i], subsections[i]);
740 
741   parseDebugInfo();
742   if (config->emitDataInCodeInfo)
743     parseDataInCode();
744 }
745 
746 void ObjFile::parseDebugInfo() {
747   std::unique_ptr<DwarfObject> dObj = DwarfObject::create(this);
748   if (!dObj)
749     return;
750 
751   auto *ctx = make<DWARFContext>(
752       std::move(dObj), "",
753       [&](Error err) {
754         warn(toString(this) + ": " + toString(std::move(err)));
755       },
756       [&](Error warning) {
757         warn(toString(this) + ": " + toString(std::move(warning)));
758       });
759 
760   // TODO: Since object files can contain a lot of DWARF info, we should verify
761   // that we are parsing just the info we need
762   const DWARFContext::compile_unit_range &units = ctx->compile_units();
763   // FIXME: There can be more than one compile unit per object file. See
764   // PR48637.
765   auto it = units.begin();
766   compileUnit = it->get();
767 }
768 
769 void ObjFile::parseDataInCode() {
770   const auto *buf = reinterpret_cast<const uint8_t *>(mb.getBufferStart());
771   const load_command *cmd = findCommand(buf, LC_DATA_IN_CODE);
772   if (!cmd)
773     return;
774   const auto *c = reinterpret_cast<const linkedit_data_command *>(cmd);
775   dataInCodeEntries = {
776       reinterpret_cast<const data_in_code_entry *>(buf + c->dataoff),
777       c->datasize / sizeof(data_in_code_entry)};
778   assert(is_sorted(dataInCodeEntries, [](const data_in_code_entry &lhs,
779                                          const data_in_code_entry &rhs) {
780     return lhs.offset < rhs.offset;
781   }));
782 }
783 
784 // The path can point to either a dylib or a .tbd file.
785 static DylibFile *loadDylib(StringRef path, DylibFile *umbrella) {
786   Optional<MemoryBufferRef> mbref = readFile(path);
787   if (!mbref) {
788     error("could not read dylib file at " + path);
789     return nullptr;
790   }
791   return loadDylib(*mbref, umbrella);
792 }
793 
794 // TBD files are parsed into a series of TAPI documents (InterfaceFiles), with
795 // the first document storing child pointers to the rest of them. When we are
796 // processing a given TBD file, we store that top-level document in
797 // currentTopLevelTapi. When processing re-exports, we search its children for
798 // potentially matching documents in the same TBD file. Note that the children
799 // themselves don't point to further documents, i.e. this is a two-level tree.
800 //
801 // Re-exports can either refer to on-disk files, or to documents within .tbd
802 // files.
803 static DylibFile *findDylib(StringRef path, DylibFile *umbrella,
804                             const InterfaceFile *currentTopLevelTapi) {
805   if (path::is_absolute(path, path::Style::posix))
806     for (StringRef root : config->systemLibraryRoots)
807       if (Optional<std::string> dylibPath =
808               resolveDylibPath((root + path).str()))
809         return loadDylib(*dylibPath, umbrella);
810 
811   // TODO: Handle -dylib_file
812 
813   SmallString<128> newPath;
814   if (config->outputType == MH_EXECUTE &&
815       path.consume_front("@executable_path/")) {
816     // ld64 allows overriding this with the undocumented flag -executable_path.
817     // lld doesn't currently implement that flag.
818     path::append(newPath, path::parent_path(config->outputFile), path);
819     path = newPath;
820   } else if (path.consume_front("@loader_path/")) {
821     fs::real_path(umbrella->getName(), newPath);
822     path::remove_filename(newPath);
823     path::append(newPath, path);
824     path = newPath;
825   } else if (path.startswith("@rpath/")) {
826     for (StringRef rpath : umbrella->rpaths) {
827       newPath.clear();
828       if (rpath.consume_front("@loader_path/")) {
829         fs::real_path(umbrella->getName(), newPath);
830         path::remove_filename(newPath);
831       }
832       path::append(newPath, rpath, path.drop_front(strlen("@rpath/")));
833       if (Optional<std::string> dylibPath = resolveDylibPath(newPath))
834         return loadDylib(*dylibPath, umbrella);
835     }
836   }
837 
838   if (currentTopLevelTapi) {
839     for (InterfaceFile &child :
840          make_pointee_range(currentTopLevelTapi->documents())) {
841       assert(child.documents().empty());
842       if (path == child.getInstallName()) {
843         auto file = make<DylibFile>(child, umbrella);
844         file->parseReexports(child);
845         return file;
846       }
847     }
848   }
849 
850   if (Optional<std::string> dylibPath = resolveDylibPath(path))
851     return loadDylib(*dylibPath, umbrella);
852 
853   return nullptr;
854 }
855 
856 // If a re-exported dylib is public (lives in /usr/lib or
857 // /System/Library/Frameworks), then it is considered implicitly linked: we
858 // should bind to its symbols directly instead of via the re-exporting umbrella
859 // library.
860 static bool isImplicitlyLinked(StringRef path) {
861   if (!config->implicitDylibs)
862     return false;
863 
864   if (path::parent_path(path) == "/usr/lib")
865     return true;
866 
867   // Match /System/Library/Frameworks/$FOO.framework/**/$FOO
868   if (path.consume_front("/System/Library/Frameworks/")) {
869     StringRef frameworkName = path.take_until([](char c) { return c == '.'; });
870     return path::filename(path) == frameworkName;
871   }
872 
873   return false;
874 }
875 
876 static void loadReexport(StringRef path, DylibFile *umbrella,
877                          const InterfaceFile *currentTopLevelTapi) {
878   DylibFile *reexport = findDylib(path, umbrella, currentTopLevelTapi);
879   if (!reexport)
880     error("unable to locate re-export with install name " + path);
881 }
882 
883 DylibFile::DylibFile(MemoryBufferRef mb, DylibFile *umbrella,
884                      bool isBundleLoader)
885     : InputFile(DylibKind, mb), refState(RefState::Unreferenced),
886       isBundleLoader(isBundleLoader) {
887   assert(!isBundleLoader || !umbrella);
888   if (umbrella == nullptr)
889     umbrella = this;
890   this->umbrella = umbrella;
891 
892   auto *buf = reinterpret_cast<const uint8_t *>(mb.getBufferStart());
893   auto *hdr = reinterpret_cast<const mach_header *>(mb.getBufferStart());
894 
895   // Initialize installName.
896   if (const load_command *cmd = findCommand(hdr, LC_ID_DYLIB)) {
897     auto *c = reinterpret_cast<const dylib_command *>(cmd);
898     currentVersion = read32le(&c->dylib.current_version);
899     compatibilityVersion = read32le(&c->dylib.compatibility_version);
900     installName =
901         reinterpret_cast<const char *>(cmd) + read32le(&c->dylib.name);
902   } else if (!isBundleLoader) {
903     // macho_executable and macho_bundle don't have LC_ID_DYLIB,
904     // so it's OK.
905     error("dylib " + toString(this) + " missing LC_ID_DYLIB load command");
906     return;
907   }
908 
909   if (config->printEachFile)
910     message(toString(this));
911   inputFiles.insert(this);
912 
913   deadStrippable = hdr->flags & MH_DEAD_STRIPPABLE_DYLIB;
914 
915   if (!checkCompatibility(this))
916     return;
917 
918   for (auto *cmd : findCommands<rpath_command>(hdr, LC_RPATH)) {
919     StringRef rpath{reinterpret_cast<const char *>(cmd) + cmd->path};
920     rpaths.push_back(rpath);
921   }
922 
923   // Initialize symbols.
924   exportingFile = isImplicitlyLinked(installName) ? this : this->umbrella;
925   if (const load_command *cmd = findCommand(hdr, LC_DYLD_INFO_ONLY)) {
926     auto *c = reinterpret_cast<const dyld_info_command *>(cmd);
927     parseTrie(buf + c->export_off, c->export_size,
928               [&](const Twine &name, uint64_t flags) {
929                 StringRef savedName = saver.save(name);
930                 if (handleLDSymbol(savedName))
931                   return;
932                 bool isWeakDef = flags & EXPORT_SYMBOL_FLAGS_WEAK_DEFINITION;
933                 bool isTlv = flags & EXPORT_SYMBOL_FLAGS_KIND_THREAD_LOCAL;
934                 symbols.push_back(symtab->addDylib(savedName, exportingFile,
935                                                    isWeakDef, isTlv));
936               });
937   } else {
938     error("LC_DYLD_INFO_ONLY not found in " + toString(this));
939     return;
940   }
941 }
942 
943 void DylibFile::parseLoadCommands(MemoryBufferRef mb) {
944   auto *hdr = reinterpret_cast<const mach_header *>(mb.getBufferStart());
945   const uint8_t *p = reinterpret_cast<const uint8_t *>(mb.getBufferStart()) +
946                      target->headerSize;
947   for (uint32_t i = 0, n = hdr->ncmds; i < n; ++i) {
948     auto *cmd = reinterpret_cast<const load_command *>(p);
949     p += cmd->cmdsize;
950 
951     if (!(hdr->flags & MH_NO_REEXPORTED_DYLIBS) &&
952         cmd->cmd == LC_REEXPORT_DYLIB) {
953       const auto *c = reinterpret_cast<const dylib_command *>(cmd);
954       StringRef reexportPath =
955           reinterpret_cast<const char *>(c) + read32le(&c->dylib.name);
956       loadReexport(reexportPath, exportingFile, nullptr);
957     }
958 
959     // FIXME: What about LC_LOAD_UPWARD_DYLIB, LC_LAZY_LOAD_DYLIB,
960     // LC_LOAD_WEAK_DYLIB, LC_REEXPORT_DYLIB (..are reexports from dylibs with
961     // MH_NO_REEXPORTED_DYLIBS loaded for -flat_namespace)?
962     if (config->namespaceKind == NamespaceKind::flat &&
963         cmd->cmd == LC_LOAD_DYLIB) {
964       const auto *c = reinterpret_cast<const dylib_command *>(cmd);
965       StringRef dylibPath =
966           reinterpret_cast<const char *>(c) + read32le(&c->dylib.name);
967       DylibFile *dylib = findDylib(dylibPath, umbrella, nullptr);
968       if (!dylib)
969         error(Twine("unable to locate library '") + dylibPath +
970               "' loaded from '" + toString(this) + "' for -flat_namespace");
971     }
972   }
973 }
974 
975 // Some versions of XCode ship with .tbd files that don't have the right
976 // platform settings.
977 static constexpr std::array<StringRef, 3> skipPlatformChecks{
978     "/usr/lib/system/libsystem_kernel.dylib",
979     "/usr/lib/system/libsystem_platform.dylib",
980     "/usr/lib/system/libsystem_pthread.dylib"};
981 
982 DylibFile::DylibFile(const InterfaceFile &interface, DylibFile *umbrella,
983                      bool isBundleLoader)
984     : InputFile(DylibKind, interface), refState(RefState::Unreferenced),
985       isBundleLoader(isBundleLoader) {
986   // FIXME: Add test for the missing TBD code path.
987 
988   if (umbrella == nullptr)
989     umbrella = this;
990   this->umbrella = umbrella;
991 
992   installName = saver.save(interface.getInstallName());
993   compatibilityVersion = interface.getCompatibilityVersion().rawValue();
994   currentVersion = interface.getCurrentVersion().rawValue();
995 
996   if (config->printEachFile)
997     message(toString(this));
998   inputFiles.insert(this);
999 
1000   if (!is_contained(skipPlatformChecks, installName) &&
1001       !is_contained(interface.targets(), config->platformInfo.target)) {
1002     error(toString(this) + " is incompatible with " +
1003           std::string(config->platformInfo.target));
1004     return;
1005   }
1006 
1007   exportingFile = isImplicitlyLinked(installName) ? this : umbrella;
1008   auto addSymbol = [&](const Twine &name) -> void {
1009     symbols.push_back(symtab->addDylib(saver.save(name), exportingFile,
1010                                        /*isWeakDef=*/false,
1011                                        /*isTlv=*/false));
1012   };
1013   // TODO(compnerd) filter out symbols based on the target platform
1014   // TODO: handle weak defs, thread locals
1015   for (const auto *symbol : interface.symbols()) {
1016     if (!symbol->getArchitectures().has(config->arch()))
1017       continue;
1018 
1019     if (handleLDSymbol(symbol->getName()))
1020       continue;
1021 
1022     switch (symbol->getKind()) {
1023     case SymbolKind::GlobalSymbol:
1024       addSymbol(symbol->getName());
1025       break;
1026     case SymbolKind::ObjectiveCClass:
1027       // XXX ld64 only creates these symbols when -ObjC is passed in. We may
1028       // want to emulate that.
1029       addSymbol(objc::klass + symbol->getName());
1030       addSymbol(objc::metaclass + symbol->getName());
1031       break;
1032     case SymbolKind::ObjectiveCClassEHType:
1033       addSymbol(objc::ehtype + symbol->getName());
1034       break;
1035     case SymbolKind::ObjectiveCInstanceVariable:
1036       addSymbol(objc::ivar + symbol->getName());
1037       break;
1038     }
1039   }
1040 }
1041 
1042 void DylibFile::parseReexports(const InterfaceFile &interface) {
1043   const InterfaceFile *topLevel =
1044       interface.getParent() == nullptr ? &interface : interface.getParent();
1045   for (InterfaceFileRef intfRef : interface.reexportedLibraries()) {
1046     InterfaceFile::const_target_range targets = intfRef.targets();
1047     if (is_contained(skipPlatformChecks, intfRef.getInstallName()) ||
1048         is_contained(targets, config->platformInfo.target))
1049       loadReexport(intfRef.getInstallName(), exportingFile, topLevel);
1050   }
1051 }
1052 
1053 // $ld$ symbols modify the properties/behavior of the library (e.g. its install
1054 // name, compatibility version or hide/add symbols) for specific target
1055 // versions.
1056 bool DylibFile::handleLDSymbol(StringRef originalName) {
1057   if (!originalName.startswith("$ld$"))
1058     return false;
1059 
1060   StringRef action;
1061   StringRef name;
1062   std::tie(action, name) = originalName.drop_front(strlen("$ld$")).split('$');
1063   if (action == "previous")
1064     handleLDPreviousSymbol(name, originalName);
1065   else if (action == "install_name")
1066     handleLDInstallNameSymbol(name, originalName);
1067   return true;
1068 }
1069 
1070 void DylibFile::handleLDPreviousSymbol(StringRef name, StringRef originalName) {
1071   // originalName: $ld$ previous $ <installname> $ <compatversion> $
1072   // <platformstr> $ <startversion> $ <endversion> $ <symbol-name> $
1073   StringRef installName;
1074   StringRef compatVersion;
1075   StringRef platformStr;
1076   StringRef startVersion;
1077   StringRef endVersion;
1078   StringRef symbolName;
1079   StringRef rest;
1080 
1081   std::tie(installName, name) = name.split('$');
1082   std::tie(compatVersion, name) = name.split('$');
1083   std::tie(platformStr, name) = name.split('$');
1084   std::tie(startVersion, name) = name.split('$');
1085   std::tie(endVersion, name) = name.split('$');
1086   std::tie(symbolName, rest) = name.split('$');
1087   // TODO: ld64 contains some logic for non-empty symbolName as well.
1088   if (!symbolName.empty())
1089     return;
1090   unsigned platform;
1091   if (platformStr.getAsInteger(10, platform) ||
1092       platform != static_cast<unsigned>(config->platform()))
1093     return;
1094 
1095   VersionTuple start;
1096   if (start.tryParse(startVersion)) {
1097     warn("failed to parse start version, symbol '" + originalName +
1098          "' ignored");
1099     return;
1100   }
1101   VersionTuple end;
1102   if (end.tryParse(endVersion)) {
1103     warn("failed to parse end version, symbol '" + originalName + "' ignored");
1104     return;
1105   }
1106   if (config->platformInfo.minimum < start ||
1107       config->platformInfo.minimum >= end)
1108     return;
1109 
1110   this->installName = saver.save(installName);
1111 
1112   if (!compatVersion.empty()) {
1113     VersionTuple cVersion;
1114     if (cVersion.tryParse(compatVersion)) {
1115       warn("failed to parse compatibility version, symbol '" + originalName +
1116            "' ignored");
1117       return;
1118     }
1119     compatibilityVersion = encodeVersion(cVersion);
1120   }
1121 }
1122 
1123 void DylibFile::handleLDInstallNameSymbol(StringRef name,
1124                                           StringRef originalName) {
1125   // originalName: $ld$ install_name $ os<version> $ install_name
1126   StringRef condition, installName;
1127   std::tie(condition, installName) = name.split('$');
1128   VersionTuple version;
1129   if (!condition.consume_front("os") || version.tryParse(condition))
1130     warn("failed to parse os version, symbol '" + originalName + "' ignored");
1131   else if (version == config->platformInfo.minimum)
1132     this->installName = saver.save(installName);
1133 }
1134 
1135 ArchiveFile::ArchiveFile(std::unique_ptr<object::Archive> &&f)
1136     : InputFile(ArchiveKind, f->getMemoryBufferRef()), file(std::move(f)) {
1137   for (const object::Archive::Symbol &sym : file->symbols())
1138     symtab->addLazy(sym.getName(), this, sym);
1139 }
1140 
1141 void ArchiveFile::fetch(const object::Archive::Symbol &sym) {
1142   object::Archive::Child c =
1143       CHECK(sym.getMember(), toString(this) +
1144                                  ": could not get the member for symbol " +
1145                                  toMachOString(sym));
1146 
1147   if (!seen.insert(c.getChildOffset()).second)
1148     return;
1149 
1150   MemoryBufferRef mb =
1151       CHECK(c.getMemoryBufferRef(),
1152             toString(this) +
1153                 ": could not get the buffer for the member defining symbol " +
1154                 toMachOString(sym));
1155 
1156   if (tar && c.getParent()->isThin())
1157     tar->append(relativeToRoot(CHECK(c.getFullName(), this)), mb.getBuffer());
1158 
1159   uint32_t modTime = toTimeT(
1160       CHECK(c.getLastModified(), toString(this) +
1161                                      ": could not get the modification time "
1162                                      "for the member defining symbol " +
1163                                      toMachOString(sym)));
1164 
1165   // `sym` is owned by a LazySym, which will be replace<>()d by make<ObjFile>
1166   // and become invalid after that call. Copy it to the stack so we can refer
1167   // to it later.
1168   const object::Archive::Symbol symCopy = sym;
1169 
1170   if (Optional<InputFile *> file =
1171           loadArchiveMember(mb, modTime, getName(), /*objCOnly=*/false)) {
1172     inputFiles.insert(*file);
1173     // ld64 doesn't demangle sym here even with -demangle.
1174     // Match that: intentionally don't call toMachOString().
1175     printArchiveMemberLoad(symCopy.getName(), *file);
1176   }
1177 }
1178 
1179 static macho::Symbol *createBitcodeSymbol(const lto::InputFile::Symbol &objSym,
1180                                           BitcodeFile &file) {
1181   StringRef name = saver.save(objSym.getName());
1182 
1183   // TODO: support weak references
1184   if (objSym.isUndefined())
1185     return symtab->addUndefined(name, &file, /*isWeakRef=*/false);
1186 
1187   assert(!objSym.isCommon() && "TODO: support common symbols in LTO");
1188 
1189   // TODO: Write a test demonstrating why computing isPrivateExtern before
1190   // LTO compilation is important.
1191   bool isPrivateExtern = false;
1192   switch (objSym.getVisibility()) {
1193   case GlobalValue::HiddenVisibility:
1194     isPrivateExtern = true;
1195     break;
1196   case GlobalValue::ProtectedVisibility:
1197     error(name + " has protected visibility, which is not supported by Mach-O");
1198     break;
1199   case GlobalValue::DefaultVisibility:
1200     break;
1201   }
1202 
1203   return symtab->addDefined(name, &file, /*isec=*/nullptr, /*value=*/0,
1204                             /*size=*/0, objSym.isWeak(), isPrivateExtern,
1205                             /*isThumb=*/false,
1206                             /*isReferencedDynamically=*/false,
1207                             /*noDeadStrip=*/false);
1208 }
1209 
1210 BitcodeFile::BitcodeFile(MemoryBufferRef mbref)
1211     : InputFile(BitcodeKind, mbref) {
1212   obj = check(lto::InputFile::create(mbref));
1213 
1214   // Convert LTO Symbols to LLD Symbols in order to perform resolution. The
1215   // "winning" symbol will then be marked as Prevailing at LTO compilation
1216   // time.
1217   for (const lto::InputFile::Symbol &objSym : obj->symbols())
1218     symbols.push_back(createBitcodeSymbol(objSym, *this));
1219 }
1220 
1221 template void ObjFile::parse<LP64>();
1222