Change how libraries are specified to the linker

- remove the platform specifics from computeLibraryArgs, we now just
  use LIBRARY_PREFIX and remove any suffix for searchPathFlagsForLD,
  and moved this into the LinkerSpec.LibrarySpecifier extension, this
  allows for proper searching of libraries, and linking of dynamic
  libraries on Windows.

Author: daveinglis

Sources/SWBCore/Settings/BuiltinMacros.swift

@@ -685,6 +685,7 @@ public final class BuiltinMacros {
     public static let EXECUTABLE_DEBUG_DYLIB_MAPPED_PLATFORM = BuiltinMacros.declareStringMacro("EXECUTABLE_DEBUG_DYLIB_MAPPED_PLATFORM")
     public static let EXECUTABLE_BLANK_INJECTION_DYLIB_PATH = BuiltinMacros.declareStringMacro("EXECUTABLE_BLANK_INJECTION_DYLIB_PATH")
 
+    public static let EXECUTABLE_PREFIX = BuiltinMacros.declareStringMacro("EXECUTABLE_PREFIX")
     public static let EXECUTABLE_SUFFIX = BuiltinMacros.declareStringMacro("EXECUTABLE_SUFFIX")
     public static let EXECUTABLE_VARIANT_SUFFIX = BuiltinMacros.declareStringMacro("EXECUTABLE_VARIANT_SUFFIX")
     public static let EXPORTED_SYMBOLS_FILE = BuiltinMacros.declarePathMacro("EXPORTED_SYMBOLS_FILE")
@@ -1764,6 +1765,7 @@ public final class BuiltinMacros {
         EXECUTABLE_DEBUG_DYLIB_MAPPED_INSTALL_NAME,
         EXECUTABLE_DEBUG_DYLIB_MAPPED_PLATFORM,
         EXECUTABLE_BLANK_INJECTION_DYLIB_PATH,
+        EXECUTABLE_PREFIX,
         EXECUTABLE_SUFFIX,
         EXECUTABLE_VARIANT_SUFFIX,
         EXCLUDED_ARCHS,

Sources/SWBCore/SpecImplementations/LinkerSpec.swift

@@ -89,7 +89,9 @@ open class LinkerSpec : CommandLineToolSpec, @unchecked Sendable {
         /// The path to the privacy file, if one exists.
         public let privacyFile: Path?
 
-        public init(kind: Kind, path: Path, mode: Mode, useSearchPaths: Bool, swiftModulePaths: [String: Path], swiftModuleAdditionalLinkerArgResponseFilePaths: [String: Path], explicitDependencies: [Path] = [], topLevelItemPath: Path? = nil, dsymPath: Path? = nil, xcframeworkSourcePath: Path? = nil, privacyFile: Path? = nil) {
+        public let libPrefix: String
+
+        public init(kind: Kind, path: Path, mode: Mode, useSearchPaths: Bool, swiftModulePaths: [String: Path], swiftModuleAdditionalLinkerArgResponseFilePaths: [String: Path], refSettings: Settings? = nil, explicitDependencies: [Path] = [], topLevelItemPath: Path? = nil, dsymPath: Path? = nil, xcframeworkSourcePath: Path? = nil, privacyFile: Path? = nil) {
             self.kind = kind
             self.path = path
             self.mode = mode
@@ -101,6 +103,7 @@ open class LinkerSpec : CommandLineToolSpec, @unchecked Sendable {
             self.dsymPath = dsymPath
             self.xcframeworkSourcePath = xcframeworkSourcePath
             self.privacyFile = privacyFile
+            self.libPrefix = refSettings?.globalScope.evaluate(BuiltinMacros.EXECUTABLE_PREFIX) ?? ""
         }
     }
 

Sources/SWBCore/SpecImplementations/Tools/LinkerTools.swift

@@ -1289,41 +1289,12 @@ public final class LdLinkerSpec : GenericLinkerSpec, SpecIdentifierType, @unchec
     private static func computeLibraryArgs(_ libraries: [LibrarySpecifier], scope: MacroEvaluationScope) -> (args: [String], inputs: [Path]) {
         // Construct the library arguments.
         return libraries.compactMap { specifier -> (args: [String], inputs: [Path]) in
-            let basename = specifier.path.basename
-
-            // FIXME: This isn't a good system, we need to redesign how we talk to the linker w.r.t. search paths and our notion of paths.
             switch specifier.kind {
-            case .static:
-                if specifier.useSearchPaths, basename.hasPrefix("lib"), basename.hasSuffix(".a") {
-                    return (specifier.searchPathFlagsForLd(basename.withoutPrefix("lib").withoutSuffix(".a")), [])
-                }
-                return (specifier.absolutePathFlagsForLd(), [specifier.path])
-            case .dynamic:
-                let suffix = ".\(scope.evaluate(BuiltinMacros.DYNAMIC_LIBRARY_EXTENSION))"
-                if specifier.useSearchPaths, basename.hasPrefix("lib"), basename.hasSuffix(suffix) {
-                    return (specifier.searchPathFlagsForLd(basename.withoutPrefix("lib").withoutSuffix(suffix)), [])
-                }
-                return (specifier.absolutePathFlagsForLd(), [specifier.path])
-            case .textBased:
-                if specifier.useSearchPaths, basename.hasPrefix("lib"), basename.hasSuffix(".tbd") {
-                    // .merge and .reexport are not supported for text-based libraries.
-                    return (specifier.searchPathFlagsForLd(basename.withoutPrefix("lib").withoutSuffix(".tbd")), [])
-                }
-                return (specifier.absolutePathFlagsForLd(), [specifier.path])
-            case .framework:
-                let frameworkName = Path(basename).withoutSuffix
+            case .static, .dynamic, .textBased, .framework:
                 if specifier.useSearchPaths {
-                    return (specifier.searchPathFlagsForLd(frameworkName), [])
-                }
-                let absPathArgs = specifier.absolutePathFlagsForLd()
-                let returnPath: Path
-                if let pathArg = absPathArgs.last, Path(pathArg).basename == frameworkName {
-                    returnPath = Path(pathArg)
+                    return (specifier.searchPathFlagsForLd(), [])
                 }
-                else {
-                    returnPath = specifier.path
-                }
-                return (absPathArgs, [returnPath])
+                return (specifier.absolutePathFlagsForLd(), [specifier.path])
             case .object:
                 // Object files are added to linker inputs in the sources task producer.
                 return ([], [])
@@ -1559,35 +1530,39 @@ public final class LdLinkerSpec : GenericLinkerSpec, SpecIdentifierType, @unchec
 
 /// Extensions to `LinkerSpec.LibrarySpecifier` specific to the dynamic linker.
 fileprivate extension LinkerSpec.LibrarySpecifier {
-    func searchPathFlagsForLd(_ name: String) -> [String] {
+    func searchPathFlagsForLd() -> [String] {
+        let strippedName = Path(path.basename).withoutSuffix.withoutPrefix(libPrefix)
         switch (kind, mode) {
-        case (.dynamic, .normal):
-            return ["-l" + name]
+        case (.static, .weak):
+            return ["-weak-l", strippedName]
+        case (.static, _), 
+             (.dynamic, .normal):
+            return ["-l", strippedName]
         case (.dynamic, .reexport):
-            return ["-Xlinker", "-reexport-l" + name]
+            return ["-Xlinker", "-reexport-l", strippedName]
         case (.dynamic, .merge):
-            return ["-Xlinker", "-merge-l" + name]
+            return ["-Xlinker", "-merge-l", strippedName]
         case (.dynamic, .reexport_merge):
-            return ["-Xlinker", "-no_merge-l" + name]
+            return ["-Xlinker", "-no_merge-l", strippedName]
         case (.dynamic, .weak):
-            return ["-weak-l" + name]
-        case (.static, .weak),
-             (.textBased, .weak):
-            return ["-weak-l" + name]
-        case (.static, _),
-             (.textBased, _):
+            return ["-weak-l", strippedName]
+        case (.textBased, .weak):
+            // Until the tbd product type have a build setting for there prefix we just hard code this here for now
+            return ["-weak-l", Path(path.basename).withoutSuffix.withoutPrefix("lib")]
+        case (.textBased, _):
             // Other modes are not supported for these kinds.
-            return ["-l" + name]
+            // Until the tbd product type have a build setting for there prefix we just hard code this here for now
+            return ["-l" + Path(path.basename).withoutSuffix.withoutPrefix("lib")]
         case (.framework, .normal):
-            return ["-framework", name]
+            return ["-framework", strippedName]
         case (.framework, .reexport):
-            return ["-Xlinker", "-reexport_framework", "-Xlinker", name]
+            return ["-Xlinker", "-reexport_framework", "-Xlinker", strippedName]
         case (.framework, .merge):
-            return ["-Xlinker", "-merge_framework", "-Xlinker", name]
+            return ["-Xlinker", "-merge_framework", "-Xlinker", strippedName]
         case (.framework, .reexport_merge):
-            return ["-Xlinker", "-no_merge_framework", "-Xlinker", name]
+            return ["-Xlinker", "-no_merge_framework", "-Xlinker", strippedName]
         case (.framework, .weak):
-            return ["-weak_framework", name]
+            return ["-weak_framework", strippedName]
         case (.object, _):
             // Object files are added to linker inputs in the sources task producer.
             return []
@@ -1724,9 +1699,9 @@ public final class LibtoolLinkerSpec : GenericLinkerSpec, SpecIdentifierType, @u
                     delegate.warning("Product \(cbc.output.basename) cannot weak-link \(specifier.kind) \(basename)")
                 }
 
-                if specifier.useSearchPaths, basename.hasPrefix("lib"), basename.hasSuffix(".a") {
+                if specifier.useSearchPaths {
                     // Locate using search paths: Add a -l option and *don't* add the path to the library as an input to the task.
-                    return ["-l" + basename.withoutPrefix("lib").withoutSuffix(".a")]
+                    return specifier.searchPathFlagsForLd()
                 }
                 else {
                     // Locate using an absolute path: Add the path as an option and as an input to the task.

Sources/SWBGenericUnixPlatform/Specs/Unix.xcspec

@@ -36,6 +36,7 @@
             // Testability is needed to generate code to invoke discovered XCTest tests
             SWIFT_ENABLE_TESTABILITY = YES;
             EXECUTABLE_SUFFIX = ".$(EXECUTABLE_EXTENSION)";
+            EXECUTABLE_PREFIX = "lib";
             EXECUTABLE_EXTENSION = "so";
             LD_DYLIB_INSTALL_NAME = "$(EXECUTABLE_PATH)";
         };

Sources/SWBTaskConstruction/TaskProducers/BuildPhaseTaskProducers/SourcesTaskProducer.swift

@@ -506,6 +506,7 @@ package final class SourcesTaskProducer: FilesBasedBuildPhaseTaskProducerBase, F
                     useSearchPaths: useSearchPaths,
                     swiftModulePaths: swiftModulePaths,
                     swiftModuleAdditionalLinkerArgResponseFilePaths: swiftModuleAdditionalLinkerArgResponseFilePaths,
+                    refSettings: settingsForRef,
                     privacyFile: privacyFile
                 )
             } else if fileType.conformsTo(context.lookupFileType(identifier: "compiled.mach-o.dylib")!) {
@@ -516,6 +517,7 @@ package final class SourcesTaskProducer: FilesBasedBuildPhaseTaskProducerBase, F
                     useSearchPaths: useSearchPaths,
                     swiftModulePaths: [:],
                     swiftModuleAdditionalLinkerArgResponseFilePaths: [:],
+                    refSettings: settingsForRef,
                     privacyFile: privacyFile
                 )
             } else if fileType.conformsTo(context.lookupFileType(identifier: "sourcecode.text-based-dylib-definition")!) {
@@ -526,6 +528,7 @@ package final class SourcesTaskProducer: FilesBasedBuildPhaseTaskProducerBase, F
                     useSearchPaths: useSearchPaths,
                     swiftModulePaths: [:],
                     swiftModuleAdditionalLinkerArgResponseFilePaths: [:],
+                    refSettings: settingsForRef,
                     privacyFile: privacyFile
                 )
             } else if fileType.conformsTo(context.lookupFileType(identifier: "wrapper.framework")!) {
@@ -571,6 +574,7 @@ package final class SourcesTaskProducer: FilesBasedBuildPhaseTaskProducerBase, F
                     useSearchPaths: useSearchPaths,
                     swiftModulePaths: [:],
                     swiftModuleAdditionalLinkerArgResponseFilePaths: [:],
+                    refSettings: settingsForRef,
                     topLevelItemPath: topLevelItemPath,
                     dsymPath: dsymPath,
                     privacyFile: privacyFile
@@ -580,7 +584,7 @@ package final class SourcesTaskProducer: FilesBasedBuildPhaseTaskProducerBase, F
                     kind: .object,
                     path: absolutePath,
                     mode: buildFile.shouldLinkWeakly ? .weak : .normal,
-                    useSearchPaths: useSearchPaths,
+                    useSearchPaths: false,
                     swiftModulePaths: swiftModulePaths,
                     swiftModuleAdditionalLinkerArgResponseFilePaths: swiftModuleAdditionalLinkerArgResponseFilePaths,
                     privacyFile: privacyFile

Sources/SWBTestSupport/TestWorkspaces.swift

@@ -1028,23 +1028,15 @@ package final class TestStandardTarget: TestInternalTarget, Sendable {
                 return "\(name).app"
             case .commandLineTool,
                  .hostBuildTool,
-                 .swiftpmTestRunner:
-                return "\(name)"
+                 .swiftpmTestRunner,
+                 .staticLibrary, 
+                 .objectFile, 
+                 .objectLibrary,
+                 .dynamicLibrary:
+                return "$(EXECUTABLE_NAME)"
             case .framework,
                  .staticFramework:
                 return "\(name).framework"
-            case .staticLibrary:
-                return "lib\(name).a"
-            case .objectFile:
-                return "\(name).o"
-            case .objectLibrary:
-                return "\(name).objlib"
-            case .dynamicLibrary:
-                // FIXME: This should be based on the target platform, not the host. See also: <rdar://problem/29410050> Swift Build doesn't support product references with non-constant basenames
-                guard let suffix = try? ProcessInfo.processInfo.hostOperatingSystem().imageFormat.dynamicLibraryExtension else {
-                    return ""
-                }
-                return "lib\(name).\(suffix)"
             case .bundle:
                 return "\(name).bundle"
             case .xpcService:

Sources/SWBWindowsPlatform/Plugin.swift

@@ -170,7 +170,7 @@ struct WindowsSDKRegistryExtension: SDKRegistryExtension {
             "GENERATE_INTERMEDIATE_TEXT_BASED_STUBS": "NO",
 
             "LIBRARY_SEARCH_PATHS": "$(inherited) $(SDKROOT)/usr/lib/swift/windows/$(CURRENT_ARCH)",
-            "TEST_LIBRARY_SEARCH_PATHS": .plString("\(testingLibraryPath.strWithPosixSlashes)/Testing-$(SWIFT_TESTING_VERSION)/usr/lib/swift/windows/$(CURRENT_ARCH) \(testingLibraryPath.strWithPosixSlashes)/XCTest-$(XCTEST_VERSION)/usr/lib/swift/windows/$(CURRENT_ARCH)"),
+            "TEST_LIBRARY_SEARCH_PATHS": .plString("\(testingLibraryPath.strWithPosixSlashes)/Testing-$(SWIFT_TESTING_VERSION)/usr/lib/swift/windows/ \(testingLibraryPath.strWithPosixSlashes)/Testing-$(SWIFT_TESTING_VERSION)/usr/lib/swift/windows/$(CURRENT_ARCH) \(testingLibraryPath.strWithPosixSlashes)/XCTest-$(XCTEST_VERSION)/usr/lib/swift/windows/$(CURRENT_ARCH) \(testingLibraryPath.strWithPosixSlashes)/XCTest-$(XCTEST_VERSION)/usr/lib/swift/windows"),
             "OTHER_SWIFT_FLAGS": "$(inherited) -libc $(DEFAULT_USE_RUNTIME)",
 
             "DEFAULT_USE_RUNTIME": "MD",

Tests/SWBBuildSystemTests/BuildOperationTests.swift

@@ -546,7 +546,7 @@ fileprivate struct BuildOperationTests: CoreBasedTests {
         }
     }
 
-    @Test(.requireSDKs(.host), .skipHostOS(.macOS), .skipHostOS(.windows, "cannot find testing library"))
+    @Test(.requireSDKs(.host), .skipHostOS(.macOS))
     func unitTestWithGeneratedEntryPoint() async throws {
         try await withTemporaryDirectory(removeTreeOnDeinit: false) { (tmpDir: Path) in
             let testProject = try await TestProject(
@@ -582,7 +582,7 @@ fileprivate struct BuildOperationTests: CoreBasedTests {
                         buildPhases: [
                             TestSourcesBuildPhase(),
                             TestFrameworksBuildPhase([
-                                "MyTests.so"
+                                TestBuildFile(.target("MyTests"))
                             ])
                         ],
                         dependencies: ["MyTests"]
@@ -593,7 +593,7 @@ fileprivate struct BuildOperationTests: CoreBasedTests {
                         buildConfigurations: [
                             TestBuildConfiguration("Debug", buildSettings: [
                                 "LD_RUNPATH_SEARCH_PATHS": "$(RPATH_ORIGIN)",
-                                "LD_DYLIB_INSTALL_NAME": "MyTests.so"
+                                "LD_DYLIB_INSTALL_NAME": "$(EXECUTABLE_NAME)"
                             ])
                         ],
                         buildPhases: [
@@ -604,19 +604,15 @@ fileprivate struct BuildOperationTests: CoreBasedTests {
                         ], dependencies: [
                             "library"
                         ],
-                        productReferenceName: "MyTests.so"
+                        productReferenceName: "$(EXECUTABLE_NAME)"
                     ),
                     TestStandardTarget(
                         "library",
                         type: .dynamicLibrary,
                         buildConfigurations: [
                             TestBuildConfiguration("Debug", buildSettings: [
                                 "LD_RUNPATH_SEARCH_PATHS": "$(RPATH_ORIGIN)",
-                                "LD_DYLIB_INSTALL_NAME": "liblibrary.so",
-
-                                // FIXME: Find a way to make these default
-                                "EXECUTABLE_PREFIX": "lib",
-                                "EXECUTABLE_PREFIX[sdk=windows*]": "",
+                                "LD_DYLIB_INSTALL_NAME": "$(EXECUTABLE_NAME)",
                             ])
                         ],
                         buildPhases: [
@@ -670,7 +666,7 @@ fileprivate struct BuildOperationTests: CoreBasedTests {
         }
     }
 
-    @Test(.requireSDKs(.host), .skipHostOS(.macOS), .skipHostOS(.windows, "cannot find testing library"))
+    @Test(.requireSDKs(.host), .skipHostOS(.macOS))
     func unitTestWithGeneratedEntryPoint_testabilityDisabled() async throws {
         try await withTemporaryDirectory(removeTreeOnDeinit: false) { (tmpDir: Path) in
             let testProject = try await TestProject(
@@ -708,7 +704,7 @@ fileprivate struct BuildOperationTests: CoreBasedTests {
                         buildPhases: [
                             TestSourcesBuildPhase(),
                             TestFrameworksBuildPhase([
-                                "MyTests.so"
+                                TestBuildFile(.target("MyTests"))
                             ])
                         ],
                         dependencies: ["MyTests"]
@@ -719,7 +715,7 @@ fileprivate struct BuildOperationTests: CoreBasedTests {
                         buildConfigurations: [
                             TestBuildConfiguration("Debug", buildSettings: [
                                 "LD_RUNPATH_SEARCH_PATHS": "$(RPATH_ORIGIN)",
-                                "LD_DYLIB_INSTALL_NAME": "MyTests.so"
+                                "LD_DYLIB_INSTALL_NAME": "$(EXECUTABLE_NAME)"
                             ])
                         ],
                         buildPhases: [
@@ -730,15 +726,15 @@ fileprivate struct BuildOperationTests: CoreBasedTests {
                         ], dependencies: [
                             "library"
                         ],
-                        productReferenceName: "MyTests.so"
+                        productReferenceName: "$(EXECUTABLE_NAME)"
                     ),
                     TestStandardTarget(
                         "library",
                         type: .dynamicLibrary,
                         buildConfigurations: [
                             TestBuildConfiguration("Debug", buildSettings: [
                                 "LD_RUNPATH_SEARCH_PATHS": "$(RPATH_ORIGIN)",
-                                "LD_DYLIB_INSTALL_NAME": "liblibrary.so",
+                                "LD_DYLIB_INSTALL_NAME": "$(EXECUTABLE_NAME)",
 
                                 // FIXME: Find a way to make these default
                                 "EXECUTABLE_PREFIX": "lib",

Tests/SWBTaskConstructionTests/UnitTestTaskConstructionTests.swift

@@ -355,7 +355,6 @@ fileprivate struct UnitTestTaskConstructionTests: CoreBasedTests {
                         ])
                     ],
                     dependencies: [],
-                    productReferenceName: "$(EXCTABLE_NAME)"
                 ),
             ])
         let core = try await getCore()