[lld-macho] Add .tbd support for frameworks

[int3]

Summary

Required for e.g. linking iOS apps since they don't have a platform-native
SDK

[int3]

update

[compnerd]

lld/MachO/Driver.cpp

87

The name makes it seem like it will match base.*. What do you think of findWithAllowedExtensions?

[int3]

lld/MachO/Driver.cpp

87

findWithExtensions? Avoids the misleading Any and is shorter :)

[int3]

rename

[smeenai]

LGTM

lld/MachO/Driver.cpp

114–115

I think this comment is out of place now?

122

Does ld64 also not check for tbds if there's a suffix?

[int3]

remove comment

lld/MachO/Driver.cpp

122

It just checks for the non-suffixed name when considering tbds. I debated on whether I should add a test for this behavior, since it's not clear to me that ld64 intended for it to work this way. The test might just be codifying an irrelevant implementation detail...

[smeenai]

lld/MachO/Driver.cpp

122

Sure, makes sense.

lld/MachO/Driver.cpp

 }
 
 void MachOOptTable::printHelp(const char *argv0, bool showHidden) const {
   PrintHelp(lld::outs(), (std::string(argv0) + " [options] file...").c_str(),
             "LLVM Linker", showHidden);
   lld::outs() << "\n";
 }
 
-static Optional<std::string> findLibrary(StringRef name) {
-  std::string stub = (llvm::Twine("lib") + name + ".tbd").str();
-  std::string shared = (llvm::Twine("lib") + name + ".dylib").str();
-  std::string archive = (llvm::Twine("lib") + name + ".a").str();
-  llvm::SmallString<260> location;
+static Optional<std::string> findWithExtension(StringRef base,
+                                               ArrayRef<StringRef> extensions) {
+  for (StringRef ext : extensions) {
+    Twine location = base + ext;
+    if (fs::exists(location))
+      return location.str();
+  }
+  return {};
+}
 
+static Optional<std::string> findLibrary(StringRef name) {
+  llvm::SmallString<261> location;
   for (StringRef dir : config->librarySearchPaths) {
-    for (StringRef library : {stub, shared, archive}) {
       location = dir;
-      llvm::sys::path::append(location, library);
-      if (fs::exists(location))
-        return location.str().str();
-    }
+      path::append(location, Twine("lib") + name);
+      if (Optional<std::string> path =
+              findWithExtension(location, {".tbd", ".dylib", ".a"}))
+        return path;
   }
   return {};
 }
 
 static Optional<std::string> findFramework(StringRef name) {
-  // TODO: support .tbd files
   llvm::SmallString<260> symlink;
-  llvm::SmallString<260> location;
   StringRef suffix;
   std::tie(name, suffix) = name.split(",");
   for (StringRef dir : config->frameworkSearchPaths) {
     symlink = dir;
     path::append(symlink, name + ".framework", name);
-    // If the symlink fails to resolve, skip to the next search path.
+
+    if (!suffix.empty()) {
       // NOTE: we must resolve the symlink before trying the suffixes, because
       // there are no symlinks for the suffixed paths.
-    if (fs::real_path(symlink, location))
-      continue;
-    if (!suffix.empty()) {
-      llvm::Twine suffixed = location + suffix;
+      llvm::SmallString<260> location;
+      if (!fs::real_path(symlink, location)) {
+        // only append suffix if realpath() succeeds
+        Twine suffixed = location + suffix;
         if (fs::exists(suffixed))
           return suffixed.str();
+      }
       // Suffix lookup failed, fall through to the no-suffix case.
     }
-    if (fs::exists(location))
-      return location.str().str();
+
+    if (Optional<std::string> path = findWithExtension(symlink, {".tbd", ""}))
+      return path;
   }
   return {};
 }
 
 static TargetInfo *createTargetInfo(opt::InputArgList &args) {
   StringRef arch = args.getLastArgValue(OPT_arch, "x86_64");
   config->arch = llvm::MachO::getArchitectureFromName(
       args.getLastArgValue(OPT_arch, arch));

lld/test/MachO/Inputs/MacOSX.sdk/System/Library/Frameworks/CoreFoundation.framework/CoreFoundation.tbd

+--- !tapi-tbd-v3
+archs:            [ x86_64 ]
+uuids:            [ 'x86_64: 00000000-0000-0000-0000-000000000000' ]
+platform:         macosx
+install-name:     '/System/Library/Frameworks/CoreFoundation.framework/CoreFoundation'
+current-version:  0001.001.1
+compatibility-version: 150
+exports:
+  - archs:        [ 'x86_64' ]
+    symbols:      [ '__CFBigNumGetInt128' ]

lld/test/MachO/stub-framework.s

+# REQUIRES: x86
+# RUN: mkdir -p %t
+# RUN: llvm-mc -filetype obj -triple x86_64-apple-darwin %s -o %t/test.o
+# RUN: lld -flavor darwinnew -o %t/test -Z -F%S/Inputs/MacOSX.sdk/System/Library/Frameworks -framework CoreFoundation %t/test.o
+#
+# RUN: llvm-objdump --macho --dylibs-used %t/test | FileCheck %s
+# CHECK: /System/Library/Frameworks/CoreFoundation.framework/CoreFoundation
+
+.section __TEXT,__text
+.global _main
+
+_main:
+  movq __CFBigNumGetInt128@GOTPCREL(%rip), %rax
+  ret