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