xref: /llvm-project-15.0.7/lld/MachO/Driver.cpp (revision bbffece3)
1 //===- Driver.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 #include "Driver.h"
10 #include "Config.h"
11 #include "ICF.h"
12 #include "InputFiles.h"
13 #include "LTO.h"
14 #include "MarkLive.h"
15 #include "ObjC.h"
16 #include "OutputSection.h"
17 #include "OutputSegment.h"
18 #include "SectionPriorities.h"
19 #include "SymbolTable.h"
20 #include "Symbols.h"
21 #include "SyntheticSections.h"
22 #include "Target.h"
23 #include "UnwindInfoSection.h"
24 #include "Writer.h"
25 
26 #include "lld/Common/Args.h"
27 #include "lld/Common/Driver.h"
28 #include "lld/Common/ErrorHandler.h"
29 #include "lld/Common/LLVM.h"
30 #include "lld/Common/Memory.h"
31 #include "lld/Common/Reproduce.h"
32 #include "lld/Common/Version.h"
33 #include "llvm/ADT/DenseSet.h"
34 #include "llvm/ADT/StringExtras.h"
35 #include "llvm/ADT/StringRef.h"
36 #include "llvm/BinaryFormat/MachO.h"
37 #include "llvm/BinaryFormat/Magic.h"
38 #include "llvm/Config/llvm-config.h"
39 #include "llvm/LTO/LTO.h"
40 #include "llvm/Object/Archive.h"
41 #include "llvm/Option/ArgList.h"
42 #include "llvm/Support/CommandLine.h"
43 #include "llvm/Support/FileSystem.h"
44 #include "llvm/Support/Host.h"
45 #include "llvm/Support/MemoryBuffer.h"
46 #include "llvm/Support/Parallel.h"
47 #include "llvm/Support/Path.h"
48 #include "llvm/Support/TarWriter.h"
49 #include "llvm/Support/TargetSelect.h"
50 #include "llvm/Support/TimeProfiler.h"
51 #include "llvm/TextAPI/PackedVersion.h"
52 
53 #include <algorithm>
54 
55 using namespace llvm;
56 using namespace llvm::MachO;
57 using namespace llvm::object;
58 using namespace llvm::opt;
59 using namespace llvm::sys;
60 using namespace lld;
61 using namespace lld::macho;
62 
63 std::unique_ptr<Configuration> macho::config;
64 std::unique_ptr<DependencyTracker> macho::depTracker;
65 
66 static HeaderFileType getOutputType(const InputArgList &args) {
67   // TODO: -r, -dylinker, -preload...
68   Arg *outputArg = args.getLastArg(OPT_bundle, OPT_dylib, OPT_execute);
69   if (outputArg == nullptr)
70     return MH_EXECUTE;
71 
72   switch (outputArg->getOption().getID()) {
73   case OPT_bundle:
74     return MH_BUNDLE;
75   case OPT_dylib:
76     return MH_DYLIB;
77   case OPT_execute:
78     return MH_EXECUTE;
79   default:
80     llvm_unreachable("internal error");
81   }
82 }
83 
84 static DenseMap<CachedHashStringRef, StringRef> resolvedLibraries;
85 static Optional<StringRef> findLibrary(StringRef name) {
86   CachedHashStringRef key(name);
87   auto entry = resolvedLibraries.find(key);
88   if (entry != resolvedLibraries.end())
89     return entry->second;
90 
91   auto doFind = [&] {
92     if (config->searchDylibsFirst) {
93       if (Optional<StringRef> path = findPathCombination(
94               "lib" + name, config->librarySearchPaths, {".tbd", ".dylib"}))
95         return path;
96       return findPathCombination("lib" + name, config->librarySearchPaths,
97                                  {".a"});
98     }
99     return findPathCombination("lib" + name, config->librarySearchPaths,
100                                {".tbd", ".dylib", ".a"});
101   };
102 
103   Optional<StringRef> path = doFind();
104   if (path)
105     resolvedLibraries[key] = *path;
106 
107   return path;
108 }
109 
110 static DenseMap<CachedHashStringRef, StringRef> resolvedFrameworks;
111 static Optional<StringRef> findFramework(StringRef name) {
112   CachedHashStringRef key(name);
113   auto entry = resolvedFrameworks.find(key);
114   if (entry != resolvedFrameworks.end())
115     return entry->second;
116 
117   SmallString<260> symlink;
118   StringRef suffix;
119   std::tie(name, suffix) = name.split(",");
120   for (StringRef dir : config->frameworkSearchPaths) {
121     symlink = dir;
122     path::append(symlink, name + ".framework", name);
123 
124     if (!suffix.empty()) {
125       // NOTE: we must resolve the symlink before trying the suffixes, because
126       // there are no symlinks for the suffixed paths.
127       SmallString<260> location;
128       if (!fs::real_path(symlink, location)) {
129         // only append suffix if realpath() succeeds
130         Twine suffixed = location + suffix;
131         if (fs::exists(suffixed))
132           return resolvedFrameworks[key] = saver().save(suffixed.str());
133       }
134       // Suffix lookup failed, fall through to the no-suffix case.
135     }
136 
137     if (Optional<StringRef> path = resolveDylibPath(symlink.str()))
138       return resolvedFrameworks[key] = *path;
139   }
140   return {};
141 }
142 
143 static bool warnIfNotDirectory(StringRef option, StringRef path) {
144   if (!fs::exists(path)) {
145     warn("directory not found for option -" + option + path);
146     return false;
147   } else if (!fs::is_directory(path)) {
148     warn("option -" + option + path + " references a non-directory path");
149     return false;
150   }
151   return true;
152 }
153 
154 static std::vector<StringRef>
155 getSearchPaths(unsigned optionCode, InputArgList &args,
156                const std::vector<StringRef> &roots,
157                const SmallVector<StringRef, 2> &systemPaths) {
158   std::vector<StringRef> paths;
159   StringRef optionLetter{optionCode == OPT_F ? "F" : "L"};
160   for (StringRef path : args::getStrings(args, optionCode)) {
161     // NOTE: only absolute paths are re-rooted to syslibroot(s)
162     bool found = false;
163     if (path::is_absolute(path, path::Style::posix)) {
164       for (StringRef root : roots) {
165         SmallString<261> buffer(root);
166         path::append(buffer, path);
167         // Do not warn about paths that are computed via the syslib roots
168         if (fs::is_directory(buffer)) {
169           paths.push_back(saver().save(buffer.str()));
170           found = true;
171         }
172       }
173     }
174     if (!found && warnIfNotDirectory(optionLetter, path))
175       paths.push_back(path);
176   }
177 
178   // `-Z` suppresses the standard "system" search paths.
179   if (args.hasArg(OPT_Z))
180     return paths;
181 
182   for (const StringRef &path : systemPaths) {
183     for (const StringRef &root : roots) {
184       SmallString<261> buffer(root);
185       path::append(buffer, path);
186       if (fs::is_directory(buffer))
187         paths.push_back(saver().save(buffer.str()));
188     }
189   }
190   return paths;
191 }
192 
193 static std::vector<StringRef> getSystemLibraryRoots(InputArgList &args) {
194   std::vector<StringRef> roots;
195   for (const Arg *arg : args.filtered(OPT_syslibroot))
196     roots.push_back(arg->getValue());
197   // NOTE: the final `-syslibroot` being `/` will ignore all roots
198   if (!roots.empty() && roots.back() == "/")
199     roots.clear();
200   // NOTE: roots can never be empty - add an empty root to simplify the library
201   // and framework search path computation.
202   if (roots.empty())
203     roots.emplace_back("");
204   return roots;
205 }
206 
207 static std::vector<StringRef>
208 getLibrarySearchPaths(InputArgList &args, const std::vector<StringRef> &roots) {
209   return getSearchPaths(OPT_L, args, roots, {"/usr/lib", "/usr/local/lib"});
210 }
211 
212 static std::vector<StringRef>
213 getFrameworkSearchPaths(InputArgList &args,
214                         const std::vector<StringRef> &roots) {
215   return getSearchPaths(OPT_F, args, roots,
216                         {"/Library/Frameworks", "/System/Library/Frameworks"});
217 }
218 
219 static llvm::CachePruningPolicy getLTOCachePolicy(InputArgList &args) {
220   SmallString<128> ltoPolicy;
221   auto add = [&ltoPolicy](Twine val) {
222     if (!ltoPolicy.empty())
223       ltoPolicy += ":";
224     val.toVector(ltoPolicy);
225   };
226   for (const Arg *arg :
227        args.filtered(OPT_thinlto_cache_policy, OPT_prune_interval_lto,
228                      OPT_prune_after_lto, OPT_max_relative_cache_size_lto)) {
229     switch (arg->getOption().getID()) {
230     case OPT_thinlto_cache_policy:
231       add(arg->getValue());
232       break;
233     case OPT_prune_interval_lto:
234       if (!strcmp("-1", arg->getValue()))
235         add("prune_interval=87600h"); // 10 years
236       else
237         add(Twine("prune_interval=") + arg->getValue() + "s");
238       break;
239     case OPT_prune_after_lto:
240       add(Twine("prune_after=") + arg->getValue() + "s");
241       break;
242     case OPT_max_relative_cache_size_lto:
243       add(Twine("cache_size=") + arg->getValue() + "%");
244       break;
245     }
246   }
247   return CHECK(parseCachePruningPolicy(ltoPolicy), "invalid LTO cache policy");
248 }
249 
250 static DenseMap<StringRef, ArchiveFile *> loadedArchives;
251 
252 static InputFile *addFile(StringRef path, ForceLoad forceLoadArchive,
253                           bool isLazy = false, bool isExplicit = true,
254                           bool isBundleLoader = false) {
255   Optional<MemoryBufferRef> buffer = readFile(path);
256   if (!buffer)
257     return nullptr;
258   MemoryBufferRef mbref = *buffer;
259   InputFile *newFile = nullptr;
260 
261   file_magic magic = identify_magic(mbref.getBuffer());
262   switch (magic) {
263   case file_magic::archive: {
264     // Avoid loading archives twice. If the archives are being force-loaded,
265     // loading them twice would create duplicate symbol errors. In the
266     // non-force-loading case, this is just a minor performance optimization.
267     // We don't take a reference to cachedFile here because the
268     // loadArchiveMember() call below may recursively call addFile() and
269     // invalidate this reference.
270     auto entry = loadedArchives.find(path);
271     if (entry != loadedArchives.end())
272       return entry->second;
273 
274     std::unique_ptr<object::Archive> archive = CHECK(
275         object::Archive::create(mbref), path + ": failed to parse archive");
276 
277     if (!archive->isEmpty() && !archive->hasSymbolTable())
278       error(path + ": archive has no index; run ranlib to add one");
279 
280     auto *file = make<ArchiveFile>(std::move(archive));
281     if ((forceLoadArchive == ForceLoad::Default && config->allLoad) ||
282         forceLoadArchive == ForceLoad::Yes) {
283       if (Optional<MemoryBufferRef> buffer = readFile(path)) {
284         Error e = Error::success();
285         for (const object::Archive::Child &c : file->getArchive().children(e)) {
286           StringRef reason =
287               forceLoadArchive == ForceLoad::Yes ? "-force_load" : "-all_load";
288           if (Error e = file->fetch(c, reason))
289             error(toString(file) + ": " + reason +
290                   " failed to load archive member: " + toString(std::move(e)));
291         }
292         if (e)
293           error(toString(file) +
294                 ": Archive::children failed: " + toString(std::move(e)));
295       }
296     } else if (forceLoadArchive == ForceLoad::Default &&
297                config->forceLoadObjC) {
298       for (const object::Archive::Symbol &sym : file->getArchive().symbols())
299         if (sym.getName().startswith(objc::klass))
300           file->fetch(sym);
301 
302       // TODO: no need to look for ObjC sections for a given archive member if
303       // we already found that it contains an ObjC symbol.
304       if (Optional<MemoryBufferRef> buffer = readFile(path)) {
305         Error e = Error::success();
306         for (const object::Archive::Child &c : file->getArchive().children(e)) {
307           Expected<MemoryBufferRef> mb = c.getMemoryBufferRef();
308           if (!mb || !hasObjCSection(*mb))
309             continue;
310           if (Error e = file->fetch(c, "-ObjC"))
311             error(toString(file) + ": -ObjC failed to load archive member: " +
312                   toString(std::move(e)));
313         }
314         if (e)
315           error(toString(file) +
316                 ": Archive::children failed: " + toString(std::move(e)));
317       }
318     }
319 
320     file->addLazySymbols();
321     newFile = loadedArchives[path] = file;
322     break;
323   }
324   case file_magic::macho_object:
325     newFile = make<ObjFile>(mbref, getModTime(path), "", isLazy);
326     break;
327   case file_magic::macho_dynamically_linked_shared_lib:
328   case file_magic::macho_dynamically_linked_shared_lib_stub:
329   case file_magic::tapi_file:
330     if (DylibFile *dylibFile =
331             loadDylib(mbref, nullptr, /*isBundleLoader=*/false, isExplicit))
332       newFile = dylibFile;
333     break;
334   case file_magic::bitcode:
335     newFile = make<BitcodeFile>(mbref, "", 0, isLazy);
336     break;
337   case file_magic::macho_executable:
338   case file_magic::macho_bundle:
339     // We only allow executable and bundle type here if it is used
340     // as a bundle loader.
341     if (!isBundleLoader)
342       error(path + ": unhandled file type");
343     if (DylibFile *dylibFile = loadDylib(mbref, nullptr, isBundleLoader))
344       newFile = dylibFile;
345     break;
346   default:
347     error(path + ": unhandled file type");
348   }
349   if (newFile && !isa<DylibFile>(newFile)) {
350     if ((isa<ObjFile>(newFile) || isa<BitcodeFile>(newFile)) && newFile->lazy &&
351         config->forceLoadObjC) {
352       for (Symbol *sym : newFile->symbols)
353         if (sym && sym->getName().startswith(objc::klass)) {
354           extract(*newFile, "-ObjC");
355           break;
356         }
357       if (newFile->lazy && hasObjCSection(mbref))
358         extract(*newFile, "-ObjC");
359     }
360 
361     // printArchiveMemberLoad() prints both .a and .o names, so no need to
362     // print the .a name here. Similarly skip lazy files.
363     if (config->printEachFile && magic != file_magic::archive && !isLazy)
364       message(toString(newFile));
365     inputFiles.insert(newFile);
366   }
367   return newFile;
368 }
369 
370 static void addLibrary(StringRef name, bool isNeeded, bool isWeak,
371                        bool isReexport, bool isExplicit,
372                        ForceLoad forceLoadArchive) {
373   if (Optional<StringRef> path = findLibrary(name)) {
374     if (auto *dylibFile = dyn_cast_or_null<DylibFile>(
375             addFile(*path, forceLoadArchive, /*isLazy=*/false, isExplicit))) {
376       if (isNeeded)
377         dylibFile->forceNeeded = true;
378       if (isWeak)
379         dylibFile->forceWeakImport = true;
380       if (isReexport) {
381         config->hasReexports = true;
382         dylibFile->reexport = true;
383       }
384     }
385     return;
386   }
387   error("library not found for -l" + name);
388 }
389 
390 static DenseSet<StringRef> loadedObjectFrameworks;
391 static void addFramework(StringRef name, bool isNeeded, bool isWeak,
392                          bool isReexport, bool isExplicit,
393                          ForceLoad forceLoadArchive) {
394   if (Optional<StringRef> path = findFramework(name)) {
395     if (loadedObjectFrameworks.contains(*path))
396       return;
397 
398     InputFile *file =
399         addFile(*path, forceLoadArchive, /*isLazy=*/false, isExplicit);
400     if (auto *dylibFile = dyn_cast_or_null<DylibFile>(file)) {
401       if (isNeeded)
402         dylibFile->forceNeeded = true;
403       if (isWeak)
404         dylibFile->forceWeakImport = true;
405       if (isReexport) {
406         config->hasReexports = true;
407         dylibFile->reexport = true;
408       }
409     } else if (isa_and_nonnull<ObjFile>(file) ||
410                isa_and_nonnull<BitcodeFile>(file)) {
411       // Cache frameworks containing object or bitcode files to avoid duplicate
412       // symbols. Frameworks containing static archives are cached separately
413       // in addFile() to share caching with libraries, and frameworks
414       // containing dylibs should allow overwriting of attributes such as
415       // forceNeeded by subsequent loads
416       loadedObjectFrameworks.insert(*path);
417     }
418     return;
419   }
420   error("framework not found for -framework " + name);
421 }
422 
423 // Parses LC_LINKER_OPTION contents, which can add additional command line
424 // flags. This directly parses the flags instead of using the standard argument
425 // parser to improve performance.
426 void macho::parseLCLinkerOption(InputFile *f, unsigned argc, StringRef data) {
427   SmallVector<StringRef, 4> argv;
428   size_t offset = 0;
429   for (unsigned i = 0; i < argc && offset < data.size(); ++i) {
430     argv.push_back(data.data() + offset);
431     offset += strlen(data.data() + offset) + 1;
432   }
433   if (argv.size() != argc || offset > data.size())
434     fatal(toString(f) + ": invalid LC_LINKER_OPTION");
435 
436   unsigned i = 0;
437   StringRef arg = argv[i];
438   if (arg.consume_front("-l")) {
439     ForceLoad forceLoadArchive =
440         config->forceLoadSwift && arg.startswith("swift") ? ForceLoad::Yes
441                                                           : ForceLoad::No;
442     addLibrary(arg, /*isNeeded=*/false, /*isWeak=*/false,
443                /*isReexport=*/false, /*isExplicit=*/false, forceLoadArchive);
444   } else if (arg == "-framework") {
445     StringRef name = argv[++i];
446     addFramework(name, /*isNeeded=*/false, /*isWeak=*/false,
447                  /*isReexport=*/false, /*isExplicit=*/false, ForceLoad::No);
448   } else {
449     error(arg + " is not allowed in LC_LINKER_OPTION");
450   }
451 }
452 
453 static void addFileList(StringRef path, bool isLazy) {
454   Optional<MemoryBufferRef> buffer = readFile(path);
455   if (!buffer)
456     return;
457   MemoryBufferRef mbref = *buffer;
458   for (StringRef path : args::getLines(mbref))
459     addFile(rerootPath(path), ForceLoad::Default, isLazy);
460 }
461 
462 // We expect sub-library names of the form "libfoo", which will match a dylib
463 // with a path of .*/libfoo.{dylib, tbd}.
464 // XXX ld64 seems to ignore the extension entirely when matching sub-libraries;
465 // I'm not sure what the use case for that is.
466 static bool markReexport(StringRef searchName, ArrayRef<StringRef> extensions) {
467   for (InputFile *file : inputFiles) {
468     if (auto *dylibFile = dyn_cast<DylibFile>(file)) {
469       StringRef filename = path::filename(dylibFile->getName());
470       if (filename.consume_front(searchName) &&
471           (filename.empty() ||
472            find(extensions, filename) != extensions.end())) {
473         dylibFile->reexport = true;
474         return true;
475       }
476     }
477   }
478   return false;
479 }
480 
481 // This function is called on startup. We need this for LTO since
482 // LTO calls LLVM functions to compile bitcode files to native code.
483 // Technically this can be delayed until we read bitcode files, but
484 // we don't bother to do lazily because the initialization is fast.
485 static void initLLVM() {
486   InitializeAllTargets();
487   InitializeAllTargetMCs();
488   InitializeAllAsmPrinters();
489   InitializeAllAsmParsers();
490 }
491 
492 static void compileBitcodeFiles() {
493   TimeTraceScope timeScope("LTO");
494   auto *lto = make<BitcodeCompiler>();
495   for (InputFile *file : inputFiles)
496     if (auto *bitcodeFile = dyn_cast<BitcodeFile>(file))
497       if (!file->lazy)
498         lto->add(*bitcodeFile);
499 
500   for (ObjFile *file : lto->compile())
501     inputFiles.insert(file);
502 }
503 
504 // Replaces common symbols with defined symbols residing in __common sections.
505 // This function must be called after all symbol names are resolved (i.e. after
506 // all InputFiles have been loaded.) As a result, later operations won't see
507 // any CommonSymbols.
508 static void replaceCommonSymbols() {
509   TimeTraceScope timeScope("Replace common symbols");
510   ConcatOutputSection *osec = nullptr;
511   for (Symbol *sym : symtab->getSymbols()) {
512     auto *common = dyn_cast<CommonSymbol>(sym);
513     if (common == nullptr)
514       continue;
515 
516     // Casting to size_t will truncate large values on 32-bit architectures,
517     // but it's not really worth supporting the linking of 64-bit programs on
518     // 32-bit archs.
519     ArrayRef<uint8_t> data = {nullptr, static_cast<size_t>(common->size)};
520     // FIXME avoid creating one Section per symbol?
521     auto *section =
522         make<Section>(common->getFile(), segment_names::data,
523                       section_names::common, S_ZEROFILL, /*addr=*/0);
524     auto *isec = make<ConcatInputSection>(*section, data, common->align);
525     if (!osec)
526       osec = ConcatOutputSection::getOrCreateForInput(isec);
527     isec->parent = osec;
528     inputSections.push_back(isec);
529 
530     // FIXME: CommonSymbol should store isReferencedDynamically, noDeadStrip
531     // and pass them on here.
532     replaceSymbol<Defined>(
533         sym, sym->getName(), common->getFile(), isec, /*value=*/0, /*size=*/0,
534         /*isWeakDef=*/false, /*isExternal=*/true, common->privateExtern,
535         /*includeInSymtab=*/true, /*isThumb=*/false,
536         /*isReferencedDynamically=*/false, /*noDeadStrip=*/false);
537   }
538 }
539 
540 static void initializeSectionRenameMap() {
541   if (config->dataConst) {
542     SmallVector<StringRef> v{section_names::got,
543                              section_names::authGot,
544                              section_names::authPtr,
545                              section_names::nonLazySymbolPtr,
546                              section_names::const_,
547                              section_names::cfString,
548                              section_names::moduleInitFunc,
549                              section_names::moduleTermFunc,
550                              section_names::objcClassList,
551                              section_names::objcNonLazyClassList,
552                              section_names::objcCatList,
553                              section_names::objcNonLazyCatList,
554                              section_names::objcProtoList,
555                              section_names::objcImageInfo};
556     for (StringRef s : v)
557       config->sectionRenameMap[{segment_names::data, s}] = {
558           segment_names::dataConst, s};
559   }
560   config->sectionRenameMap[{segment_names::text, section_names::staticInit}] = {
561       segment_names::text, section_names::text};
562   config->sectionRenameMap[{segment_names::import, section_names::pointers}] = {
563       config->dataConst ? segment_names::dataConst : segment_names::data,
564       section_names::nonLazySymbolPtr};
565 }
566 
567 static inline char toLowerDash(char x) {
568   if (x >= 'A' && x <= 'Z')
569     return x - 'A' + 'a';
570   else if (x == ' ')
571     return '-';
572   return x;
573 }
574 
575 static std::string lowerDash(StringRef s) {
576   return std::string(map_iterator(s.begin(), toLowerDash),
577                      map_iterator(s.end(), toLowerDash));
578 }
579 
580 struct PlatformVersion {
581   PlatformType platform = PLATFORM_UNKNOWN;
582   llvm::VersionTuple minimum;
583   llvm::VersionTuple sdk;
584 };
585 
586 static PlatformVersion parsePlatformVersion(const Arg *arg) {
587   assert(arg->getOption().getID() == OPT_platform_version);
588   StringRef platformStr = arg->getValue(0);
589   StringRef minVersionStr = arg->getValue(1);
590   StringRef sdkVersionStr = arg->getValue(2);
591 
592   PlatformVersion platformVersion;
593 
594   // TODO(compnerd) see if we can generate this case list via XMACROS
595   platformVersion.platform =
596       StringSwitch<PlatformType>(lowerDash(platformStr))
597           .Cases("macos", "1", PLATFORM_MACOS)
598           .Cases("ios", "2", PLATFORM_IOS)
599           .Cases("tvos", "3", PLATFORM_TVOS)
600           .Cases("watchos", "4", PLATFORM_WATCHOS)
601           .Cases("bridgeos", "5", PLATFORM_BRIDGEOS)
602           .Cases("mac-catalyst", "6", PLATFORM_MACCATALYST)
603           .Cases("ios-simulator", "7", PLATFORM_IOSSIMULATOR)
604           .Cases("tvos-simulator", "8", PLATFORM_TVOSSIMULATOR)
605           .Cases("watchos-simulator", "9", PLATFORM_WATCHOSSIMULATOR)
606           .Cases("driverkit", "10", PLATFORM_DRIVERKIT)
607           .Default(PLATFORM_UNKNOWN);
608   if (platformVersion.platform == PLATFORM_UNKNOWN)
609     error(Twine("malformed platform: ") + platformStr);
610   // TODO: check validity of version strings, which varies by platform
611   // NOTE: ld64 accepts version strings with 5 components
612   // llvm::VersionTuple accepts no more than 4 components
613   // Has Apple ever published version strings with 5 components?
614   if (platformVersion.minimum.tryParse(minVersionStr))
615     error(Twine("malformed minimum version: ") + minVersionStr);
616   if (platformVersion.sdk.tryParse(sdkVersionStr))
617     error(Twine("malformed sdk version: ") + sdkVersionStr);
618   return platformVersion;
619 }
620 
621 // Has the side-effect of setting Config::platformInfo.
622 static PlatformType parsePlatformVersions(const ArgList &args) {
623   std::map<PlatformType, PlatformVersion> platformVersions;
624   const PlatformVersion *lastVersionInfo = nullptr;
625   for (const Arg *arg : args.filtered(OPT_platform_version)) {
626     PlatformVersion version = parsePlatformVersion(arg);
627 
628     // For each platform, the last flag wins:
629     // `-platform_version macos 2 3 -platform_version macos 4 5` has the same
630     // effect as just passing `-platform_version macos 4 5`.
631     // FIXME: ld64 warns on multiple flags for one platform. Should we?
632     platformVersions[version.platform] = version;
633     lastVersionInfo = &platformVersions[version.platform];
634   }
635 
636   if (platformVersions.empty()) {
637     error("must specify -platform_version");
638     return PLATFORM_UNKNOWN;
639   }
640   if (platformVersions.size() > 2) {
641     error("must specify -platform_version at most twice");
642     return PLATFORM_UNKNOWN;
643   }
644   if (platformVersions.size() == 2) {
645     // FIXME: If you implement support for this, add a diagnostic if
646     // outputType is not dylib or bundle -- linkers shouldn't be able to
647     // write zippered executables.
648     warn("writing zippered outputs not yet implemented, "
649          "ignoring all but last -platform_version flag");
650   }
651   config->platformInfo.minimum = lastVersionInfo->minimum;
652   config->platformInfo.sdk = lastVersionInfo->sdk;
653   return lastVersionInfo->platform;
654 }
655 
656 // Has the side-effect of setting Config::target.
657 static TargetInfo *createTargetInfo(InputArgList &args) {
658   StringRef archName = args.getLastArgValue(OPT_arch);
659   if (archName.empty()) {
660     error("must specify -arch");
661     return nullptr;
662   }
663 
664   PlatformType platform = parsePlatformVersions(args);
665   config->platformInfo.target =
666       MachO::Target(getArchitectureFromName(archName), platform);
667 
668   uint32_t cpuType;
669   uint32_t cpuSubtype;
670   std::tie(cpuType, cpuSubtype) = getCPUTypeFromArchitecture(config->arch());
671 
672   switch (cpuType) {
673   case CPU_TYPE_X86_64:
674     return createX86_64TargetInfo();
675   case CPU_TYPE_ARM64:
676     return createARM64TargetInfo();
677   case CPU_TYPE_ARM64_32:
678     return createARM64_32TargetInfo();
679   case CPU_TYPE_ARM:
680     return createARMTargetInfo(cpuSubtype);
681   default:
682     error("missing or unsupported -arch " + archName);
683     return nullptr;
684   }
685 }
686 
687 static UndefinedSymbolTreatment
688 getUndefinedSymbolTreatment(const ArgList &args) {
689   StringRef treatmentStr = args.getLastArgValue(OPT_undefined);
690   auto treatment =
691       StringSwitch<UndefinedSymbolTreatment>(treatmentStr)
692           .Cases("error", "", UndefinedSymbolTreatment::error)
693           .Case("warning", UndefinedSymbolTreatment::warning)
694           .Case("suppress", UndefinedSymbolTreatment::suppress)
695           .Case("dynamic_lookup", UndefinedSymbolTreatment::dynamic_lookup)
696           .Default(UndefinedSymbolTreatment::unknown);
697   if (treatment == UndefinedSymbolTreatment::unknown) {
698     warn(Twine("unknown -undefined TREATMENT '") + treatmentStr +
699          "', defaulting to 'error'");
700     treatment = UndefinedSymbolTreatment::error;
701   } else if (config->namespaceKind == NamespaceKind::twolevel &&
702              (treatment == UndefinedSymbolTreatment::warning ||
703               treatment == UndefinedSymbolTreatment::suppress)) {
704     if (treatment == UndefinedSymbolTreatment::warning)
705       error("'-undefined warning' only valid with '-flat_namespace'");
706     else
707       error("'-undefined suppress' only valid with '-flat_namespace'");
708     treatment = UndefinedSymbolTreatment::error;
709   }
710   return treatment;
711 }
712 
713 static ICFLevel getICFLevel(const ArgList &args) {
714   StringRef icfLevelStr = args.getLastArgValue(OPT_icf_eq);
715   auto icfLevel = StringSwitch<ICFLevel>(icfLevelStr)
716                       .Cases("none", "", ICFLevel::none)
717                       .Case("safe", ICFLevel::safe)
718                       .Case("all", ICFLevel::all)
719                       .Default(ICFLevel::unknown);
720   if (icfLevel == ICFLevel::unknown) {
721     warn(Twine("unknown --icf=OPTION `") + icfLevelStr +
722          "', defaulting to `none'");
723     icfLevel = ICFLevel::none;
724   } else if (icfLevel == ICFLevel::safe) {
725     warn(Twine("`--icf=safe' is not yet implemented, reverting to `none'"));
726     icfLevel = ICFLevel::none;
727   }
728   return icfLevel;
729 }
730 
731 static void warnIfDeprecatedOption(const Option &opt) {
732   if (!opt.getGroup().isValid())
733     return;
734   if (opt.getGroup().getID() == OPT_grp_deprecated) {
735     warn("Option `" + opt.getPrefixedName() + "' is deprecated in ld64:");
736     warn(opt.getHelpText());
737   }
738 }
739 
740 static void warnIfUnimplementedOption(const Option &opt) {
741   if (!opt.getGroup().isValid() || !opt.hasFlag(DriverFlag::HelpHidden))
742     return;
743   switch (opt.getGroup().getID()) {
744   case OPT_grp_deprecated:
745     // warn about deprecated options elsewhere
746     break;
747   case OPT_grp_undocumented:
748     warn("Option `" + opt.getPrefixedName() +
749          "' is undocumented. Should lld implement it?");
750     break;
751   case OPT_grp_obsolete:
752     warn("Option `" + opt.getPrefixedName() +
753          "' is obsolete. Please modernize your usage.");
754     break;
755   case OPT_grp_ignored:
756     warn("Option `" + opt.getPrefixedName() + "' is ignored.");
757     break;
758   case OPT_grp_ignored_silently:
759     break;
760   default:
761     warn("Option `" + opt.getPrefixedName() +
762          "' is not yet implemented. Stay tuned...");
763     break;
764   }
765 }
766 
767 static const char *getReproduceOption(InputArgList &args) {
768   if (const Arg *arg = args.getLastArg(OPT_reproduce))
769     return arg->getValue();
770   return getenv("LLD_REPRODUCE");
771 }
772 
773 static void parseClangOption(StringRef opt, const Twine &msg) {
774   std::string err;
775   raw_string_ostream os(err);
776 
777   const char *argv[] = {"lld", opt.data()};
778   if (cl::ParseCommandLineOptions(2, argv, "", &os))
779     return;
780   os.flush();
781   error(msg + ": " + StringRef(err).trim());
782 }
783 
784 static uint32_t parseDylibVersion(const ArgList &args, unsigned id) {
785   const Arg *arg = args.getLastArg(id);
786   if (!arg)
787     return 0;
788 
789   if (config->outputType != MH_DYLIB) {
790     error(arg->getAsString(args) + ": only valid with -dylib");
791     return 0;
792   }
793 
794   PackedVersion version;
795   if (!version.parse32(arg->getValue())) {
796     error(arg->getAsString(args) + ": malformed version");
797     return 0;
798   }
799 
800   return version.rawValue();
801 }
802 
803 static uint32_t parseProtection(StringRef protStr) {
804   uint32_t prot = 0;
805   for (char c : protStr) {
806     switch (c) {
807     case 'r':
808       prot |= VM_PROT_READ;
809       break;
810     case 'w':
811       prot |= VM_PROT_WRITE;
812       break;
813     case 'x':
814       prot |= VM_PROT_EXECUTE;
815       break;
816     case '-':
817       break;
818     default:
819       error("unknown -segprot letter '" + Twine(c) + "' in " + protStr);
820       return 0;
821     }
822   }
823   return prot;
824 }
825 
826 static std::vector<SectionAlign> parseSectAlign(const opt::InputArgList &args) {
827   std::vector<SectionAlign> sectAligns;
828   for (const Arg *arg : args.filtered(OPT_sectalign)) {
829     StringRef segName = arg->getValue(0);
830     StringRef sectName = arg->getValue(1);
831     StringRef alignStr = arg->getValue(2);
832     if (alignStr.startswith("0x") || alignStr.startswith("0X"))
833       alignStr = alignStr.drop_front(2);
834     uint32_t align;
835     if (alignStr.getAsInteger(16, align)) {
836       error("-sectalign: failed to parse '" + StringRef(arg->getValue(2)) +
837             "' as number");
838       continue;
839     }
840     if (!isPowerOf2_32(align)) {
841       error("-sectalign: '" + StringRef(arg->getValue(2)) +
842             "' (in base 16) not a power of two");
843       continue;
844     }
845     sectAligns.push_back({segName, sectName, align});
846   }
847   return sectAligns;
848 }
849 
850 PlatformType macho::removeSimulator(PlatformType platform) {
851   switch (platform) {
852   case PLATFORM_IOSSIMULATOR:
853     return PLATFORM_IOS;
854   case PLATFORM_TVOSSIMULATOR:
855     return PLATFORM_TVOS;
856   case PLATFORM_WATCHOSSIMULATOR:
857     return PLATFORM_WATCHOS;
858   default:
859     return platform;
860   }
861 }
862 
863 static bool dataConstDefault(const InputArgList &args) {
864   static const std::vector<std::pair<PlatformType, VersionTuple>> minVersion = {
865       {PLATFORM_MACOS, VersionTuple(10, 15)},
866       {PLATFORM_IOS, VersionTuple(13, 0)},
867       {PLATFORM_TVOS, VersionTuple(13, 0)},
868       {PLATFORM_WATCHOS, VersionTuple(6, 0)},
869       {PLATFORM_BRIDGEOS, VersionTuple(4, 0)}};
870   PlatformType platform = removeSimulator(config->platformInfo.target.Platform);
871   auto it = llvm::find_if(minVersion,
872                           [&](const auto &p) { return p.first == platform; });
873   if (it != minVersion.end())
874     if (config->platformInfo.minimum < it->second)
875       return false;
876 
877   switch (config->outputType) {
878   case MH_EXECUTE:
879     return !args.hasArg(OPT_no_pie);
880   case MH_BUNDLE:
881     // FIXME: return false when -final_name ...
882     // has prefix "/System/Library/UserEventPlugins/"
883     // or matches "/usr/libexec/locationd" "/usr/libexec/terminusd"
884     return true;
885   case MH_DYLIB:
886     return true;
887   case MH_OBJECT:
888     return false;
889   default:
890     llvm_unreachable(
891         "unsupported output type for determining data-const default");
892   }
893   return false;
894 }
895 
896 void SymbolPatterns::clear() {
897   literals.clear();
898   globs.clear();
899 }
900 
901 void SymbolPatterns::insert(StringRef symbolName) {
902   if (symbolName.find_first_of("*?[]") == StringRef::npos)
903     literals.insert(CachedHashStringRef(symbolName));
904   else if (Expected<GlobPattern> pattern = GlobPattern::create(symbolName))
905     globs.emplace_back(*pattern);
906   else
907     error("invalid symbol-name pattern: " + symbolName);
908 }
909 
910 bool SymbolPatterns::matchLiteral(StringRef symbolName) const {
911   return literals.contains(CachedHashStringRef(symbolName));
912 }
913 
914 bool SymbolPatterns::matchGlob(StringRef symbolName) const {
915   for (const GlobPattern &glob : globs)
916     if (glob.match(symbolName))
917       return true;
918   return false;
919 }
920 
921 bool SymbolPatterns::match(StringRef symbolName) const {
922   return matchLiteral(symbolName) || matchGlob(symbolName);
923 }
924 
925 static void handleSymbolPatterns(InputArgList &args,
926                                  SymbolPatterns &symbolPatterns,
927                                  unsigned singleOptionCode,
928                                  unsigned listFileOptionCode) {
929   for (const Arg *arg : args.filtered(singleOptionCode))
930     symbolPatterns.insert(arg->getValue());
931   for (const Arg *arg : args.filtered(listFileOptionCode)) {
932     StringRef path = arg->getValue();
933     Optional<MemoryBufferRef> buffer = readFile(path);
934     if (!buffer) {
935       error("Could not read symbol file: " + path);
936       continue;
937     }
938     MemoryBufferRef mbref = *buffer;
939     for (StringRef line : args::getLines(mbref)) {
940       line = line.take_until([](char c) { return c == '#'; }).trim();
941       if (!line.empty())
942         symbolPatterns.insert(line);
943     }
944   }
945 }
946 
947 static void createFiles(const InputArgList &args) {
948   TimeTraceScope timeScope("Load input files");
949   // This loop should be reserved for options whose exact ordering matters.
950   // Other options should be handled via filtered() and/or getLastArg().
951   bool isLazy = false;
952   for (const Arg *arg : args) {
953     const Option &opt = arg->getOption();
954     warnIfDeprecatedOption(opt);
955     warnIfUnimplementedOption(opt);
956 
957     switch (opt.getID()) {
958     case OPT_INPUT:
959       addFile(rerootPath(arg->getValue()), ForceLoad::Default, isLazy);
960       break;
961     case OPT_needed_library:
962       if (auto *dylibFile = dyn_cast_or_null<DylibFile>(
963               addFile(rerootPath(arg->getValue()), ForceLoad::Default)))
964         dylibFile->forceNeeded = true;
965       break;
966     case OPT_reexport_library:
967       if (auto *dylibFile = dyn_cast_or_null<DylibFile>(
968               addFile(rerootPath(arg->getValue()), ForceLoad::Default))) {
969         config->hasReexports = true;
970         dylibFile->reexport = true;
971       }
972       break;
973     case OPT_weak_library:
974       if (auto *dylibFile = dyn_cast_or_null<DylibFile>(
975               addFile(rerootPath(arg->getValue()), ForceLoad::Default)))
976         dylibFile->forceWeakImport = true;
977       break;
978     case OPT_filelist:
979       addFileList(arg->getValue(), isLazy);
980       break;
981     case OPT_force_load:
982       addFile(rerootPath(arg->getValue()), ForceLoad::Yes);
983       break;
984     case OPT_l:
985     case OPT_needed_l:
986     case OPT_reexport_l:
987     case OPT_weak_l:
988       addLibrary(arg->getValue(), opt.getID() == OPT_needed_l,
989                  opt.getID() == OPT_weak_l, opt.getID() == OPT_reexport_l,
990                  /*isExplicit=*/true, ForceLoad::Default);
991       break;
992     case OPT_framework:
993     case OPT_needed_framework:
994     case OPT_reexport_framework:
995     case OPT_weak_framework:
996       addFramework(arg->getValue(), opt.getID() == OPT_needed_framework,
997                    opt.getID() == OPT_weak_framework,
998                    opt.getID() == OPT_reexport_framework, /*isExplicit=*/true,
999                    ForceLoad::Default);
1000       break;
1001     case OPT_start_lib:
1002       if (isLazy)
1003         error("nested --start-lib");
1004       isLazy = true;
1005       break;
1006     case OPT_end_lib:
1007       if (!isLazy)
1008         error("stray --end-lib");
1009       isLazy = false;
1010       break;
1011     default:
1012       break;
1013     }
1014   }
1015 }
1016 
1017 static void gatherInputSections() {
1018   TimeTraceScope timeScope("Gathering input sections");
1019   int inputOrder = 0;
1020   for (const InputFile *file : inputFiles) {
1021     for (const Section *section : file->sections) {
1022       if (section->name == section_names::compactUnwind)
1023         // Compact unwind entries require special handling elsewhere.
1024         continue;
1025       ConcatOutputSection *osec = nullptr;
1026       for (const Subsection &subsection : section->subsections) {
1027         if (auto *isec = dyn_cast<ConcatInputSection>(subsection.isec)) {
1028           if (isec->isCoalescedWeak())
1029             continue;
1030           isec->outSecOff = inputOrder++;
1031           if (!osec)
1032             osec = ConcatOutputSection::getOrCreateForInput(isec);
1033           isec->parent = osec;
1034           inputSections.push_back(isec);
1035         } else if (auto *isec =
1036                        dyn_cast<CStringInputSection>(subsection.isec)) {
1037           if (in.cStringSection->inputOrder == UnspecifiedInputOrder)
1038             in.cStringSection->inputOrder = inputOrder++;
1039           in.cStringSection->addInput(isec);
1040         } else if (auto *isec =
1041                        dyn_cast<WordLiteralInputSection>(subsection.isec)) {
1042           if (in.wordLiteralSection->inputOrder == UnspecifiedInputOrder)
1043             in.wordLiteralSection->inputOrder = inputOrder++;
1044           in.wordLiteralSection->addInput(isec);
1045         } else {
1046           llvm_unreachable("unexpected input section kind");
1047         }
1048       }
1049     }
1050   }
1051   assert(inputOrder <= UnspecifiedInputOrder);
1052 }
1053 
1054 static void foldIdenticalLiterals() {
1055   // We always create a cStringSection, regardless of whether dedupLiterals is
1056   // true. If it isn't, we simply create a non-deduplicating CStringSection.
1057   // Either way, we must unconditionally finalize it here.
1058   in.cStringSection->finalizeContents();
1059   if (in.wordLiteralSection)
1060     in.wordLiteralSection->finalizeContents();
1061 }
1062 
1063 static void referenceStubBinder() {
1064   bool needsStubHelper = config->outputType == MH_DYLIB ||
1065                          config->outputType == MH_EXECUTE ||
1066                          config->outputType == MH_BUNDLE;
1067   if (!needsStubHelper || !symtab->find("dyld_stub_binder"))
1068     return;
1069 
1070   // dyld_stub_binder is used by dyld to resolve lazy bindings. This code here
1071   // adds a opportunistic reference to dyld_stub_binder if it happens to exist.
1072   // dyld_stub_binder is in libSystem.dylib, which is usually linked in. This
1073   // isn't needed for correctness, but the presence of that symbol suppresses
1074   // "no symbols" diagnostics from `nm`.
1075   // StubHelperSection::setup() adds a reference and errors out if
1076   // dyld_stub_binder doesn't exist in case it is actually needed.
1077   symtab->addUndefined("dyld_stub_binder", /*file=*/nullptr, /*isWeak=*/false);
1078 }
1079 
1080 bool macho::link(ArrayRef<const char *> argsArr, llvm::raw_ostream &stdoutOS,
1081                  llvm::raw_ostream &stderrOS, bool exitEarly,
1082                  bool disableOutput) {
1083   // This driver-specific context will be freed later by lldMain().
1084   auto *ctx = new CommonLinkerContext;
1085 
1086   ctx->e.initialize(stdoutOS, stderrOS, exitEarly, disableOutput);
1087   ctx->e.cleanupCallback = []() {
1088     resolvedFrameworks.clear();
1089     resolvedLibraries.clear();
1090     cachedReads.clear();
1091     concatOutputSections.clear();
1092     inputFiles.clear();
1093     inputSections.clear();
1094     loadedArchives.clear();
1095     loadedObjectFrameworks.clear();
1096     syntheticSections.clear();
1097     thunkMap.clear();
1098 
1099     firstTLVDataSection = nullptr;
1100     tar = nullptr;
1101     memset(&in, 0, sizeof(in));
1102 
1103     resetLoadedDylibs();
1104     resetOutputSegments();
1105     resetWriter();
1106     InputFile::resetIdCount();
1107   };
1108 
1109   ctx->e.logName = args::getFilenameWithoutExe(argsArr[0]);
1110 
1111   MachOOptTable parser;
1112   InputArgList args = parser.parse(argsArr.slice(1));
1113 
1114   ctx->e.errorLimitExceededMsg = "too many errors emitted, stopping now "
1115                                  "(use --error-limit=0 to see all errors)";
1116   ctx->e.errorLimit = args::getInteger(args, OPT_error_limit_eq, 20);
1117   ctx->e.verbose = args.hasArg(OPT_verbose);
1118 
1119   if (args.hasArg(OPT_help_hidden)) {
1120     parser.printHelp(argsArr[0], /*showHidden=*/true);
1121     return true;
1122   }
1123   if (args.hasArg(OPT_help)) {
1124     parser.printHelp(argsArr[0], /*showHidden=*/false);
1125     return true;
1126   }
1127   if (args.hasArg(OPT_version)) {
1128     message(getLLDVersion());
1129     return true;
1130   }
1131 
1132   config = std::make_unique<Configuration>();
1133   symtab = std::make_unique<SymbolTable>();
1134   target = createTargetInfo(args);
1135   depTracker = std::make_unique<DependencyTracker>(
1136       args.getLastArgValue(OPT_dependency_info));
1137   if (errorCount())
1138     return false;
1139 
1140   if (args.hasArg(OPT_pagezero_size)) {
1141     uint64_t pagezeroSize = args::getHex(args, OPT_pagezero_size, 0);
1142 
1143     // ld64 does something really weird. It attempts to realign the value to the
1144     // page size, but assumes the the page size is 4K. This doesn't work with
1145     // most of Apple's ARM64 devices, which use a page size of 16K. This means
1146     // that it will first 4K align it by rounding down, then round up to 16K.
1147     // This probably only happened because no one using this arg with anything
1148     // other then 0, so no one checked if it did what is what it says it does.
1149 
1150     // So we are not copying this weird behavior and doing the it in a logical
1151     // way, by always rounding down to page size.
1152     if (!isAligned(Align(target->getPageSize()), pagezeroSize)) {
1153       pagezeroSize -= pagezeroSize % target->getPageSize();
1154       warn("__PAGEZERO size is not page aligned, rounding down to 0x" +
1155            Twine::utohexstr(pagezeroSize));
1156     }
1157 
1158     target->pageZeroSize = pagezeroSize;
1159   }
1160 
1161   config->osoPrefix = args.getLastArgValue(OPT_oso_prefix);
1162   if (!config->osoPrefix.empty()) {
1163     // Expand special characters, such as ".", "..", or  "~", if present.
1164     // Note: LD64 only expands "." and not other special characters.
1165     // That seems silly to imitate so we will not try to follow it, but rather
1166     // just use real_path() to do it.
1167 
1168     // The max path length is 4096, in theory. However that seems quite long
1169     // and seems unlikely that any one would want to strip everything from the
1170     // path. Hence we've picked a reasonably large number here.
1171     SmallString<1024> expanded;
1172     if (!fs::real_path(config->osoPrefix, expanded,
1173                        /*expand_tilde=*/true)) {
1174       // Note: LD64 expands "." to be `<current_dir>/`
1175       // (ie., it has a slash suffix) whereas real_path() doesn't.
1176       // So we have to append '/' to be consistent.
1177       StringRef sep = sys::path::get_separator();
1178       // real_path removes trailing slashes as part of the normalization, but
1179       // these are meaningful for our text based stripping
1180       if (config->osoPrefix.equals(".") || config->osoPrefix.endswith(sep))
1181         expanded += sep;
1182       config->osoPrefix = saver().save(expanded.str());
1183     }
1184   }
1185 
1186   // Must be set before any InputSections and Symbols are created.
1187   config->deadStrip = args.hasArg(OPT_dead_strip);
1188 
1189   config->systemLibraryRoots = getSystemLibraryRoots(args);
1190   if (const char *path = getReproduceOption(args)) {
1191     // Note that --reproduce is a debug option so you can ignore it
1192     // if you are trying to understand the whole picture of the code.
1193     Expected<std::unique_ptr<TarWriter>> errOrWriter =
1194         TarWriter::create(path, path::stem(path));
1195     if (errOrWriter) {
1196       tar = std::move(*errOrWriter);
1197       tar->append("response.txt", createResponseFile(args));
1198       tar->append("version.txt", getLLDVersion() + "\n");
1199     } else {
1200       error("--reproduce: " + toString(errOrWriter.takeError()));
1201     }
1202   }
1203 
1204   if (auto *arg = args.getLastArg(OPT_threads_eq)) {
1205     StringRef v(arg->getValue());
1206     unsigned threads = 0;
1207     if (!llvm::to_integer(v, threads, 0) || threads == 0)
1208       error(arg->getSpelling() + ": expected a positive integer, but got '" +
1209             arg->getValue() + "'");
1210     parallel::strategy = hardware_concurrency(threads);
1211     config->thinLTOJobs = v;
1212   }
1213   if (auto *arg = args.getLastArg(OPT_thinlto_jobs_eq))
1214     config->thinLTOJobs = arg->getValue();
1215   if (!get_threadpool_strategy(config->thinLTOJobs))
1216     error("--thinlto-jobs: invalid job count: " + config->thinLTOJobs);
1217 
1218   for (const Arg *arg : args.filtered(OPT_u)) {
1219     config->explicitUndefineds.push_back(symtab->addUndefined(
1220         arg->getValue(), /*file=*/nullptr, /*isWeakRef=*/false));
1221   }
1222 
1223   for (const Arg *arg : args.filtered(OPT_U))
1224     config->explicitDynamicLookups.insert(arg->getValue());
1225 
1226   config->mapFile = args.getLastArgValue(OPT_map);
1227   config->optimize = args::getInteger(args, OPT_O, 1);
1228   config->outputFile = args.getLastArgValue(OPT_o, "a.out");
1229   config->finalOutput =
1230       args.getLastArgValue(OPT_final_output, config->outputFile);
1231   config->astPaths = args.getAllArgValues(OPT_add_ast_path);
1232   config->headerPad = args::getHex(args, OPT_headerpad, /*Default=*/32);
1233   config->headerPadMaxInstallNames =
1234       args.hasArg(OPT_headerpad_max_install_names);
1235   config->printDylibSearch =
1236       args.hasArg(OPT_print_dylib_search) || getenv("RC_TRACE_DYLIB_SEARCHING");
1237   config->printEachFile = args.hasArg(OPT_t);
1238   config->printWhyLoad = args.hasArg(OPT_why_load);
1239   config->omitDebugInfo = args.hasArg(OPT_S);
1240   config->outputType = getOutputType(args);
1241   config->errorForArchMismatch = args.hasArg(OPT_arch_errors_fatal);
1242   if (const Arg *arg = args.getLastArg(OPT_bundle_loader)) {
1243     if (config->outputType != MH_BUNDLE)
1244       error("-bundle_loader can only be used with MachO bundle output");
1245     addFile(arg->getValue(), ForceLoad::Default, /*isLazy=*/false,
1246             /*isExplicit=*/false,
1247             /*isBundleLoader=*/true);
1248   }
1249   if (const Arg *arg = args.getLastArg(OPT_umbrella)) {
1250     if (config->outputType != MH_DYLIB)
1251       warn("-umbrella used, but not creating dylib");
1252     config->umbrella = arg->getValue();
1253   }
1254   config->ltoObjPath = args.getLastArgValue(OPT_object_path_lto);
1255   config->ltoo = args::getInteger(args, OPT_lto_O, 2);
1256   if (config->ltoo > 3)
1257     error("--lto-O: invalid optimization level: " + Twine(config->ltoo));
1258   config->thinLTOCacheDir = args.getLastArgValue(OPT_cache_path_lto);
1259   config->thinLTOCachePolicy = getLTOCachePolicy(args);
1260   config->runtimePaths = args::getStrings(args, OPT_rpath);
1261   config->allLoad = args.hasFlag(OPT_all_load, OPT_noall_load, false);
1262   config->archMultiple = args.hasArg(OPT_arch_multiple);
1263   config->applicationExtension = args.hasFlag(
1264       OPT_application_extension, OPT_no_application_extension, false);
1265   config->exportDynamic = args.hasArg(OPT_export_dynamic);
1266   config->forceLoadObjC = args.hasArg(OPT_ObjC);
1267   config->forceLoadSwift = args.hasArg(OPT_force_load_swift_libs);
1268   config->deadStripDylibs = args.hasArg(OPT_dead_strip_dylibs);
1269   config->demangle = args.hasArg(OPT_demangle);
1270   config->implicitDylibs = !args.hasArg(OPT_no_implicit_dylibs);
1271   config->emitFunctionStarts =
1272       args.hasFlag(OPT_function_starts, OPT_no_function_starts, true);
1273   config->emitBitcodeBundle = args.hasArg(OPT_bitcode_bundle);
1274   config->emitDataInCodeInfo =
1275       args.hasFlag(OPT_data_in_code_info, OPT_no_data_in_code_info, true);
1276   config->icfLevel = getICFLevel(args);
1277   config->dedupLiterals =
1278       args.hasFlag(OPT_deduplicate_literals, OPT_icf_eq, false) ||
1279       config->icfLevel != ICFLevel::none;
1280   config->warnDylibInstallName = args.hasFlag(
1281       OPT_warn_dylib_install_name, OPT_no_warn_dylib_install_name, false);
1282   config->callGraphProfileSort = args.hasFlag(
1283       OPT_call_graph_profile_sort, OPT_no_call_graph_profile_sort, true);
1284   config->printSymbolOrder = args.getLastArgValue(OPT_print_symbol_order);
1285 
1286   // FIXME: Add a commandline flag for this too.
1287   config->zeroModTime = getenv("ZERO_AR_DATE");
1288 
1289   std::array<PlatformType, 3> encryptablePlatforms{
1290       PLATFORM_IOS, PLATFORM_WATCHOS, PLATFORM_TVOS};
1291   config->emitEncryptionInfo =
1292       args.hasFlag(OPT_encryptable, OPT_no_encryption,
1293                    is_contained(encryptablePlatforms, config->platform()));
1294 
1295 #ifndef LLVM_HAVE_LIBXAR
1296   if (config->emitBitcodeBundle)
1297     error("-bitcode_bundle unsupported because LLD wasn't built with libxar");
1298 #endif
1299 
1300   if (const Arg *arg = args.getLastArg(OPT_install_name)) {
1301     if (config->warnDylibInstallName && config->outputType != MH_DYLIB)
1302       warn(
1303           arg->getAsString(args) +
1304           ": ignored, only has effect with -dylib [--warn-dylib-install-name]");
1305     else
1306       config->installName = arg->getValue();
1307   } else if (config->outputType == MH_DYLIB) {
1308     config->installName = config->finalOutput;
1309   }
1310 
1311   if (args.hasArg(OPT_mark_dead_strippable_dylib)) {
1312     if (config->outputType != MH_DYLIB)
1313       warn("-mark_dead_strippable_dylib: ignored, only has effect with -dylib");
1314     else
1315       config->markDeadStrippableDylib = true;
1316   }
1317 
1318   if (const Arg *arg = args.getLastArg(OPT_static, OPT_dynamic))
1319     config->staticLink = (arg->getOption().getID() == OPT_static);
1320 
1321   if (const Arg *arg =
1322           args.getLastArg(OPT_flat_namespace, OPT_twolevel_namespace))
1323     config->namespaceKind = arg->getOption().getID() == OPT_twolevel_namespace
1324                                 ? NamespaceKind::twolevel
1325                                 : NamespaceKind::flat;
1326 
1327   config->undefinedSymbolTreatment = getUndefinedSymbolTreatment(args);
1328 
1329   if (config->outputType == MH_EXECUTE)
1330     config->entry = symtab->addUndefined(args.getLastArgValue(OPT_e, "_main"),
1331                                          /*file=*/nullptr,
1332                                          /*isWeakRef=*/false);
1333 
1334   config->librarySearchPaths =
1335       getLibrarySearchPaths(args, config->systemLibraryRoots);
1336   config->frameworkSearchPaths =
1337       getFrameworkSearchPaths(args, config->systemLibraryRoots);
1338   if (const Arg *arg =
1339           args.getLastArg(OPT_search_paths_first, OPT_search_dylibs_first))
1340     config->searchDylibsFirst =
1341         arg->getOption().getID() == OPT_search_dylibs_first;
1342 
1343   config->dylibCompatibilityVersion =
1344       parseDylibVersion(args, OPT_compatibility_version);
1345   config->dylibCurrentVersion = parseDylibVersion(args, OPT_current_version);
1346 
1347   config->dataConst =
1348       args.hasFlag(OPT_data_const, OPT_no_data_const, dataConstDefault(args));
1349   // Populate config->sectionRenameMap with builtin default renames.
1350   // Options -rename_section and -rename_segment are able to override.
1351   initializeSectionRenameMap();
1352   // Reject every special character except '.' and '$'
1353   // TODO(gkm): verify that this is the proper set of invalid chars
1354   StringRef invalidNameChars("!\"#%&'()*+,-/:;<=>?@[\\]^`{|}~");
1355   auto validName = [invalidNameChars](StringRef s) {
1356     if (s.find_first_of(invalidNameChars) != StringRef::npos)
1357       error("invalid name for segment or section: " + s);
1358     return s;
1359   };
1360   for (const Arg *arg : args.filtered(OPT_rename_section)) {
1361     config->sectionRenameMap[{validName(arg->getValue(0)),
1362                               validName(arg->getValue(1))}] = {
1363         validName(arg->getValue(2)), validName(arg->getValue(3))};
1364   }
1365   for (const Arg *arg : args.filtered(OPT_rename_segment)) {
1366     config->segmentRenameMap[validName(arg->getValue(0))] =
1367         validName(arg->getValue(1));
1368   }
1369 
1370   config->sectionAlignments = parseSectAlign(args);
1371 
1372   for (const Arg *arg : args.filtered(OPT_segprot)) {
1373     StringRef segName = arg->getValue(0);
1374     uint32_t maxProt = parseProtection(arg->getValue(1));
1375     uint32_t initProt = parseProtection(arg->getValue(2));
1376     if (maxProt != initProt && config->arch() != AK_i386)
1377       error("invalid argument '" + arg->getAsString(args) +
1378             "': max and init must be the same for non-i386 archs");
1379     if (segName == segment_names::linkEdit)
1380       error("-segprot cannot be used to change __LINKEDIT's protections");
1381     config->segmentProtections.push_back({segName, maxProt, initProt});
1382   }
1383 
1384   handleSymbolPatterns(args, config->exportedSymbols, OPT_exported_symbol,
1385                        OPT_exported_symbols_list);
1386   handleSymbolPatterns(args, config->unexportedSymbols, OPT_unexported_symbol,
1387                        OPT_unexported_symbols_list);
1388   if (!config->exportedSymbols.empty() && !config->unexportedSymbols.empty()) {
1389     error("cannot use both -exported_symbol* and -unexported_symbol* options\n"
1390           ">>> ignoring unexports");
1391     config->unexportedSymbols.clear();
1392   }
1393   // Explicitly-exported literal symbols must be defined, but might
1394   // languish in an archive if unreferenced elsewhere. Light a fire
1395   // under those lazy symbols!
1396   for (const CachedHashStringRef &cachedName : config->exportedSymbols.literals)
1397     symtab->addUndefined(cachedName.val(), /*file=*/nullptr,
1398                          /*isWeakRef=*/false);
1399 
1400   for (const Arg *arg : args.filtered(OPT_why_live))
1401     config->whyLive.insert(arg->getValue());
1402   if (!config->whyLive.empty() && !config->deadStrip)
1403     warn("-why_live has no effect without -dead_strip, ignoring");
1404 
1405   config->saveTemps = args.hasArg(OPT_save_temps);
1406 
1407   config->adhocCodesign = args.hasFlag(
1408       OPT_adhoc_codesign, OPT_no_adhoc_codesign,
1409       (config->arch() == AK_arm64 || config->arch() == AK_arm64e) &&
1410           config->platform() == PLATFORM_MACOS);
1411 
1412   if (args.hasArg(OPT_v)) {
1413     message(getLLDVersion(), lld::errs());
1414     message(StringRef("Library search paths:") +
1415                 (config->librarySearchPaths.empty()
1416                      ? ""
1417                      : "\n\t" + join(config->librarySearchPaths, "\n\t")),
1418             lld::errs());
1419     message(StringRef("Framework search paths:") +
1420                 (config->frameworkSearchPaths.empty()
1421                      ? ""
1422                      : "\n\t" + join(config->frameworkSearchPaths, "\n\t")),
1423             lld::errs());
1424   }
1425 
1426   config->progName = argsArr[0];
1427 
1428   config->timeTraceEnabled = args.hasArg(
1429       OPT_time_trace, OPT_time_trace_granularity_eq, OPT_time_trace_file_eq);
1430   config->timeTraceGranularity =
1431       args::getInteger(args, OPT_time_trace_granularity_eq, 500);
1432 
1433   // Initialize time trace profiler.
1434   if (config->timeTraceEnabled)
1435     timeTraceProfilerInitialize(config->timeTraceGranularity, config->progName);
1436 
1437   {
1438     TimeTraceScope timeScope("ExecuteLinker");
1439 
1440     initLLVM(); // must be run before any call to addFile()
1441     createFiles(args);
1442 
1443     config->isPic = config->outputType == MH_DYLIB ||
1444                     config->outputType == MH_BUNDLE ||
1445                     (config->outputType == MH_EXECUTE &&
1446                      args.hasFlag(OPT_pie, OPT_no_pie, true));
1447 
1448     // Now that all dylibs have been loaded, search for those that should be
1449     // re-exported.
1450     {
1451       auto reexportHandler = [](const Arg *arg,
1452                                 const std::vector<StringRef> &extensions) {
1453         config->hasReexports = true;
1454         StringRef searchName = arg->getValue();
1455         if (!markReexport(searchName, extensions))
1456           error(arg->getSpelling() + " " + searchName +
1457                 " does not match a supplied dylib");
1458       };
1459       std::vector<StringRef> extensions = {".tbd"};
1460       for (const Arg *arg : args.filtered(OPT_sub_umbrella))
1461         reexportHandler(arg, extensions);
1462 
1463       extensions.push_back(".dylib");
1464       for (const Arg *arg : args.filtered(OPT_sub_library))
1465         reexportHandler(arg, extensions);
1466     }
1467 
1468     cl::ResetAllOptionOccurrences();
1469 
1470     // Parse LTO options.
1471     if (const Arg *arg = args.getLastArg(OPT_mcpu))
1472       parseClangOption(saver().save("-mcpu=" + StringRef(arg->getValue())),
1473                        arg->getSpelling());
1474 
1475     for (const Arg *arg : args.filtered(OPT_mllvm))
1476       parseClangOption(arg->getValue(), arg->getSpelling());
1477 
1478     compileBitcodeFiles();
1479     replaceCommonSymbols();
1480 
1481     StringRef orderFile = args.getLastArgValue(OPT_order_file);
1482     if (!orderFile.empty())
1483       priorityBuilder.parseOrderFile(orderFile);
1484 
1485     referenceStubBinder();
1486 
1487     // FIXME: should terminate the link early based on errors encountered so
1488     // far?
1489 
1490     createSyntheticSections();
1491     createSyntheticSymbols();
1492 
1493     if (!config->exportedSymbols.empty()) {
1494       parallelForEach(symtab->getSymbols(), [](Symbol *sym) {
1495         if (auto *defined = dyn_cast<Defined>(sym)) {
1496           StringRef symbolName = defined->getName();
1497           if (config->exportedSymbols.match(symbolName)) {
1498             if (defined->privateExtern) {
1499               if (defined->weakDefCanBeHidden) {
1500                 // weak_def_can_be_hidden symbols behave similarly to
1501                 // private_extern symbols in most cases, except for when
1502                 // it is explicitly exported.
1503                 // The former can be exported but the latter cannot.
1504                 defined->privateExtern = false;
1505               } else {
1506                 warn("cannot export hidden symbol " + symbolName +
1507                      "\n>>> defined in " + toString(defined->getFile()));
1508               }
1509             }
1510           } else {
1511             defined->privateExtern = true;
1512           }
1513         }
1514       });
1515     } else if (!config->unexportedSymbols.empty()) {
1516       parallelForEach(symtab->getSymbols(), [](Symbol *sym) {
1517         if (auto *defined = dyn_cast<Defined>(sym))
1518           if (config->unexportedSymbols.match(defined->getName()))
1519             defined->privateExtern = true;
1520       });
1521     }
1522 
1523     for (const Arg *arg : args.filtered(OPT_sectcreate)) {
1524       StringRef segName = arg->getValue(0);
1525       StringRef sectName = arg->getValue(1);
1526       StringRef fileName = arg->getValue(2);
1527       Optional<MemoryBufferRef> buffer = readFile(fileName);
1528       if (buffer)
1529         inputFiles.insert(make<OpaqueFile>(*buffer, segName, sectName));
1530     }
1531 
1532     for (const Arg *arg : args.filtered(OPT_add_empty_section)) {
1533       StringRef segName = arg->getValue(0);
1534       StringRef sectName = arg->getValue(1);
1535       inputFiles.insert(make<OpaqueFile>(MemoryBufferRef(), segName, sectName));
1536     }
1537 
1538     gatherInputSections();
1539     if (config->callGraphProfileSort)
1540       priorityBuilder.extractCallGraphProfile();
1541 
1542     if (config->deadStrip)
1543       markLive();
1544 
1545     // ICF assumes that all literals have been folded already, so we must run
1546     // foldIdenticalLiterals before foldIdenticalSections.
1547     foldIdenticalLiterals();
1548     if (config->icfLevel != ICFLevel::none)
1549       foldIdenticalSections();
1550 
1551     // Write to an output file.
1552     if (target->wordSize == 8)
1553       writeResult<LP64>();
1554     else
1555       writeResult<ILP32>();
1556 
1557     depTracker->write(getLLDVersion(), inputFiles, config->outputFile);
1558   }
1559 
1560   if (config->timeTraceEnabled) {
1561     checkError(timeTraceProfilerWrite(
1562         args.getLastArgValue(OPT_time_trace_file_eq).str(),
1563         config->outputFile));
1564 
1565     timeTraceProfilerCleanup();
1566   }
1567   return errorCount() == 0;
1568 }
1569