Search in registered platforms for linkers.

kcieplak · owenv · commit 95575f414113 · 2025-02-26T14:14:48.000-08:00
* Make the executableSearchPaths for a platform a StackedSearchPath
  so we can more easily search for things.
* Search the regisitered platforms for linkers as well as toolchains.
* Small workaround to avoid finding linkers in XCode SDKs.
diff --git a/Sources/SWBCore/Core.swift b/Sources/SWBCore/Core.swift
@@ -306,6 +306,7 @@ public final class Core: Sendable {
 
         // Search the default location first (unless directed not to), then search any extra locations we've been passed.
         var searchPaths: [Path]
+        let fs = localFS
         if let onlySearchAdditionalPlatformPaths = getEnvironmentVariable("XCODE_ONLY_EXTRA_PLATFORM_FOLDERS"), onlySearchAdditionalPlatformPaths.boolValue {
             searchPaths = []
         }
@@ -324,7 +325,7 @@ public final class Core: Sendable {
             }
         }
         searchPaths += UserDefaults.additionalPlatformSearchPaths
-        return PlatformRegistry(delegate: self.registryDelegate, searchPaths: searchPaths, hostOperatingSystem: hostOperatingSystem)
+        return PlatformRegistry(delegate: self.registryDelegate, searchPaths: searchPaths, hostOperatingSystem: hostOperatingSystem, fs: fs)
     }()
 
     @PluginExtensionSystemActor public var loadedPluginPaths: [Path] {
diff --git a/Sources/SWBCore/PlatformRegistry.swift b/Sources/SWBCore/PlatformRegistry.swift
@@ -180,9 +180,9 @@ public final class Platform: Sendable {
     @_spi(Testing) public var sdks: [SDK] = []
 
     /// The list of executable search paths in the platform.
-    @_spi(Testing) public var executableSearchPaths: [Path]
+    @_spi(Testing) public var executableSearchPaths: StackedSearchPath
 
-    init(_ name: String, _ displayName: String, _ familyName: String, _ familyDisplayName: String?, _ identifier: String, _ devicePlatformName: String?, _ simulatorPlatformName: String?, _ path: Path, _ version: String?, _ productBuildVersion: String?, _ defaultSettings: [String: PropertyListItem], _ additionalInfoPlistEntries: [String: PropertyListItem], _ isDeploymentPlatform: Bool, _ specRegistryProvider: any SpecRegistryProvider, preferredArchValue: String?, executableSearchPaths: [Path]) {
+    init(_ name: String, _ displayName: String, _ familyName: String, _ familyDisplayName: String?, _ identifier: String, _ devicePlatformName: String?, _ simulatorPlatformName: String?, _ path: Path, _ version: String?, _ productBuildVersion: String?, _ defaultSettings: [String: PropertyListItem], _ additionalInfoPlistEntries: [String: PropertyListItem], _ isDeploymentPlatform: Bool, _ specRegistryProvider: any SpecRegistryProvider, preferredArchValue: String?, executableSearchPaths: [Path], fs: any FSProxy) {
         self.name = name
         self.displayName = displayName
         self.familyName = familyName
@@ -198,7 +198,7 @@ public final class Platform: Sendable {
         self.isDeploymentPlatform = isDeploymentPlatform
         self.specRegistryProvider = specRegistryProvider
         self.preferredArch = preferredArchValue
-        self.executableSearchPaths = executableSearchPaths
+        self.executableSearchPaths = StackedSearchPath(paths: executableSearchPaths, fs: fs)
         self.sdkCanonicalName = name
     }
 
@@ -319,16 +319,16 @@ public final class PlatformRegistry {
             })
     }
 
-    @_spi(Testing) public init(delegate: any PlatformRegistryDelegate, searchPaths: [Path], hostOperatingSystem: OperatingSystem) {
+    @_spi(Testing) public init(delegate: any PlatformRegistryDelegate, searchPaths: [Path], hostOperatingSystem: OperatingSystem, fs: any FSProxy) {
         self.delegate = delegate
 
         for path in searchPaths {
-            registerPlatformsInDirectory(path)
+            registerPlatformsInDirectory(path, fs)
         }
 
         do {
             if hostOperatingSystem.createFallbackSystemToolchain {
-                try registerFallbackSystemPlatform(operatingSystem: hostOperatingSystem)
+                try registerFallbackSystemPlatform(operatingSystem: hostOperatingSystem, fs: fs)
             }
         } catch {
             delegate.error(error)
@@ -340,13 +340,13 @@ public final class PlatformRegistry {
 
         for platformExtension in platformInfoExtensions() {
             for (path, data) in platformExtension.additionalPlatforms() {
-                registerPlatform(path, .plDict(data))
+                registerPlatform(path, .plDict(data), fs)
             }
         }
     }
 
-    private func registerFallbackSystemPlatform(operatingSystem: OperatingSystem) throws {
-        try registerPlatform(Path("/"), .plDict(fallbackSystemPlatformSettings(operatingSystem: operatingSystem)))
+    private func registerFallbackSystemPlatform(operatingSystem: OperatingSystem, fs: any FSProxy) throws {
+        try registerPlatform(Path("/"), .plDict(fallbackSystemPlatformSettings(operatingSystem: operatingSystem)), fs)
     }
 
     private func fallbackSystemPlatformSettings(operatingSystem: OperatingSystem) throws -> [String: PropertyListItem] {
@@ -413,7 +413,7 @@ public final class PlatformRegistry {
     }
 
     /// Register all platforms in the given directory.
-    private func registerPlatformsInDirectory(_ path: Path) {
+    private func registerPlatformsInDirectory(_ path: Path, _ fs: any FSProxy) {
         for item in (try? localFS.listdir(path))?.sorted(by: <) ?? [] {
             let itemPath = path.join(item)
 
@@ -431,15 +431,14 @@ public final class PlatformRegistry {
                     // Silently skip loading the platform if it does not have an Info.plist at all.  (We will still error below if it has an Info.plist which is malformed.)
                     continue
                 }
-
-                registerPlatform(itemPath, infoPlist)
+                registerPlatform(itemPath, infoPlist, fs)
             } catch let err {
                 delegate.error(itemPath, "unable to load platform: 'Info.plist' was malformed: \(err)")
             }
         }
     }
 
-    private func registerPlatform(_ path: Path, _ data: PropertyListItem) {
+    private func registerPlatform(_ path: Path, _ data: PropertyListItem, _ fs: any FSProxy) {
         // The data should always be a dictionary.
         guard case .plDict(var items) = data else {
             delegate.error(path, "unexpected platform data")
@@ -635,7 +634,7 @@ public final class PlatformRegistry {
         ])
 
         // FIXME: Need to parse other fields. It would also be nice to diagnose unused keys like we do for Spec data (and we might want to just use the spec parser here).
-        let platform = Platform(name, displayName, familyName, familyDisplayName, identifier, devicePlatformName, simulatorPlatformName, path, version, productBuildVersion, defaultSettings, additionalInfoPlistEntries, isDeploymentPlatform, delegate, preferredArchValue: preferredArchValue, executableSearchPaths: executableSearchPaths)
+        let platform = Platform(name, displayName, familyName, familyDisplayName, identifier, devicePlatformName, simulatorPlatformName, path, version, productBuildVersion, defaultSettings, additionalInfoPlistEntries, isDeploymentPlatform, delegate, preferredArchValue: preferredArchValue, executableSearchPaths: executableSearchPaths, fs: fs)
         if let duplicatePlatform = platformsByIdentifier[identifier] {
             delegate.error(path, "platform '\(identifier)' already registered from \(duplicatePlatform.path.str)")
             return
diff --git a/Sources/SWBCore/Settings/Settings.swift b/Sources/SWBCore/Settings/Settings.swift
@@ -1015,7 +1015,7 @@ extension WorkspaceContext {
             }
 
             // Add the platform search paths.
-            for path in platform?.executableSearchPaths ?? [] {
+            for path in platform?.executableSearchPaths.paths ?? [] {
                 paths.append(path)
             }
 
diff --git a/Sources/SWBTestSupport/CoreBasedTests.swift b/Sources/SWBTestSupport/CoreBasedTests.swift
@@ -261,7 +261,15 @@ extension CoreBasedTests {
     package var ldPath: Path? {
         get async throws {
             let (core, defaultToolchain) = try await coreAndToolchain()
-            return defaultToolchain.executableSearchPaths.findExecutable(operatingSystem: core.hostOperatingSystem, basename: "ld")
+            if let executable = defaultToolchain.executableSearchPaths.findExecutable(operatingSystem: core.hostOperatingSystem, basename: "ld") {
+                return executable
+            }
+            for platform in core.platformRegistry.platforms {
+                if let executable = platform.executableSearchPaths.findExecutable(operatingSystem: core.hostOperatingSystem, basename: "ld") {
+                    return executable
+                }
+            }
+            return nil
         }
     }
     package var linkPath: Path? {
@@ -271,19 +279,45 @@ extension CoreBasedTests {
                 // Most unixes have a link executable, but that is not a linker
                 return nil
             }
-            return defaultToolchain.executableSearchPaths.findExecutable(operatingSystem: core.hostOperatingSystem, basename: "link")
+            if let executable = defaultToolchain.executableSearchPaths.findExecutable(operatingSystem: core.hostOperatingSystem, basename: "link") {
+                return executable
+            }
+            for platform in core.platformRegistry.platforms {
+                if let executable = platform.executableSearchPaths.findExecutable(operatingSystem: core.hostOperatingSystem, basename: "link") {
+                    return executable
+                }
+            }
+            return nil
         }
     }
+
     package var lldPath: Path? {
         get async throws {
             let (core, defaultToolchain) = try await coreAndToolchain()
-            return defaultToolchain.executableSearchPaths.findExecutable(operatingSystem: core.hostOperatingSystem, basename: "ld.lld")
+            if let executable = defaultToolchain.executableSearchPaths.findExecutable(operatingSystem: core.hostOperatingSystem, basename: "ld.ld") {
+                return executable
+            }
+            for platform in core.platformRegistry.platforms {
+                if let executable = platform.executableSearchPaths.findExecutable(operatingSystem: core.hostOperatingSystem, basename: "ld.ld") {
+                    return executable
+                }
+            }
+            return nil
         }
     }
+
     package var goldPath: Path? {
         get async throws {
             let (core, defaultToolchain) = try await coreAndToolchain()
-            return defaultToolchain.executableSearchPaths.findExecutable(operatingSystem: core.hostOperatingSystem, basename: "ld.gold")
+            if let executable = defaultToolchain.executableSearchPaths.findExecutable(operatingSystem: core.hostOperatingSystem, basename: "ld.gold") {
+                return executable
+            }
+            for platform in core.platformRegistry.platforms {
+                if let executable = platform.executableSearchPaths.findExecutable(operatingSystem: core.hostOperatingSystem, basename: "ld.gold") {
+                    return executable
+                }
+            }
+            return nil
         }
     }
 }
diff --git a/Sources/SWBTestSupport/DummyCommandProducer.swift b/Sources/SWBTestSupport/DummyCommandProducer.swift
@@ -56,7 +56,7 @@ package struct MockCommandProducer: CommandProducer, Sendable {
             for path in core.toolchainRegistry.defaultToolchain?.executableSearchPaths.paths ?? [] {
                 paths.append(path)
             }
-            for path in platform?.executableSearchPaths ?? [] {
+            for path in platform?.executableSearchPaths.paths ?? [] {
                 paths.append(path)
             }
             paths.append(core.developerPath.join("usr").join("bin"))
diff --git a/Tests/SWBCoreTests/PlatformRegistryTests.swift b/Tests/SWBCoreTests/PlatformRegistryTests.swift
@@ -66,7 +66,7 @@ import SWBMacro
             }
 
             let delegate = await TestDataDelegate(pluginManager: PluginManager(skipLoadingPluginIdentifiers: []))
-            let registry = PlatformRegistry(delegate: delegate, searchPaths: [tmpDirPath], hostOperatingSystem: try ProcessInfo.processInfo.hostOperatingSystem())
+            let registry = PlatformRegistry(delegate: delegate, searchPaths: [tmpDirPath], hostOperatingSystem: try ProcessInfo.processInfo.hostOperatingSystem(), fs: localFS)
             try await perform(registry, delegate)
         }
     }

Original file line number	Diff line number	Diff line change
`@@ -306,6 +306,7 @@ public final class Core: Sendable {`
`306`	`306`
`307`	`307`	`// Search the default location first (unless directed not to), then search any extra locations we've been passed.`
`308`	`308`	`var searchPaths: [Path]`
	`309`	`+ let fs = localFS`
`309`	`310`	`if let onlySearchAdditionalPlatformPaths = getEnvironmentVariable("XCODE_ONLY_EXTRA_PLATFORM_FOLDERS"), onlySearchAdditionalPlatformPaths.boolValue {`
`310`	`311`	`searchPaths = []`
`311`	`312`	`}`
`@@ -324,7 +325,7 @@ public final class Core: Sendable {`
`324`	`325`	`}`
`325`	`326`	`}`
`326`	`327`	`searchPaths += UserDefaults.additionalPlatformSearchPaths`
`327`		`- return PlatformRegistry(delegate: self.registryDelegate, searchPaths: searchPaths, hostOperatingSystem: hostOperatingSystem)`
	`328`	`+ return PlatformRegistry(delegate: self.registryDelegate, searchPaths: searchPaths, hostOperatingSystem: hostOperatingSystem, fs: fs)`
`328`	`329`	`}()`
`329`	`330`
`330`	`331`	`@PluginExtensionSystemActor public var loadedPluginPaths: [Path] {`
Original file line number	Diff line number	Diff line change
`@@ -1015,7 +1015,7 @@ extension WorkspaceContext {`
`1015`	`1015`	`}`
`1016`	`1016`
`1017`	`1017`	`// Add the platform search paths.`
`1018`		`- for path in platform?.executableSearchPaths ?? [] {`
	`1018`	`+ for path in platform?.executableSearchPaths.paths ?? [] {`
`1019`	`1019`	`paths.append(path)`
`1020`	`1020`	`}`
`1021`	`1021`
Original file line number	Diff line number	Diff line change
`@@ -56,7 +56,7 @@ package struct MockCommandProducer: CommandProducer, Sendable {`
`56`	`56`	`for path in core.toolchainRegistry.defaultToolchain?.executableSearchPaths.paths ?? [] {`
`57`	`57`	`paths.append(path)`
`58`	`58`	`}`
`59`		`- for path in platform?.executableSearchPaths ?? [] {`
	`59`	`+ for path in platform?.executableSearchPaths.paths ?? [] {`
`60`	`60`	`paths.append(path)`
`61`	`61`	`}`
`62`	`62`	`paths.append(core.developerPath.join("usr").join("bin"))`
Original file line number	Diff line number	Diff line change
`@@ -66,7 +66,7 @@ import SWBMacro`
`66`	`66`	`}`
`67`	`67`
`68`	`68`	`let delegate = await TestDataDelegate(pluginManager: PluginManager(skipLoadingPluginIdentifiers: []))`
`69`		`- let registry = PlatformRegistry(delegate: delegate, searchPaths: [tmpDirPath], hostOperatingSystem: try ProcessInfo.processInfo.hostOperatingSystem())`
	`69`	`+ let registry = PlatformRegistry(delegate: delegate, searchPaths: [tmpDirPath], hostOperatingSystem: try ProcessInfo.processInfo.hostOperatingSystem(), fs: localFS)`
`70`	`70`	`try await perform(registry, delegate)`
`71`	`71`	`}`
`72`	`72`	`}`