Skip to content

Make targetSwiftPackagePath optional for Wasm Swift SDK generation #242

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Make targetSwiftPackagePath optional for Wasm Swift SDK generation #242

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 1 addition & 4 deletions Sources/GeneratorCLI/GeneratorCLI.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -422,15 +422,12 @@ extension GeneratorCLI {
}

func run() async throws {
guard let targetSwiftPackagePath = generatorOptions.targetSwiftPackagePath else {
throw StringError("Missing expected argument '--target-swift-package-path'")
}
let recipe = try WebAssemblyRecipe(
hostSwiftPackage: generatorOptions.hostSwiftPackagePath.map {
let hostTriples = try self.generatorOptions.deriveHostTriples()
return WebAssemblyRecipe.HostToolchainPackage(path: FilePath($0), triples: hostTriples)
},
targetSwiftPackagePath: FilePath(targetSwiftPackagePath),
targetSwiftPackagePath: generatorOptions.targetSwiftPackagePath.map { FilePath($0) },
wasiSysroot: FilePath(self.wasiSysroot),
swiftVersion: self.generatorOptions.swiftVersion,
logger: loggerWithLevel(from: self.generatorOptions)
Expand Down
127 changes: 65 additions & 62 deletions Sources/SwiftSDKGenerator/SwiftSDKRecipes/WebAssemblyRecipe.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ import struct SystemPackage.FilePath

package struct WebAssemblyRecipe: SwiftSDKRecipe {
let hostSwiftPackage: HostToolchainPackage?
let targetSwiftPackagePath: FilePath
let targetSwiftPackagePath: FilePath?
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would you mind adding a doc comment to this property explaining why this is optional? What's the use case for omitting it?

Suggested change
let targetSwiftPackagePath: FilePath?
/// ...
let targetSwiftPackagePath: FilePath?

let wasiSysroot: FilePath
let swiftVersion: String
package let logger: Logger
Expand All @@ -34,7 +34,7 @@ package struct WebAssemblyRecipe: SwiftSDKRecipe {

package init(
hostSwiftPackage: HostToolchainPackage?,
targetSwiftPackagePath: FilePath,
targetSwiftPackagePath: FilePath?,
wasiSysroot: FilePath,
swiftVersion: String,
logger: Logger
Expand All @@ -47,7 +47,10 @@ package struct WebAssemblyRecipe: SwiftSDKRecipe {
}

package var defaultArtifactID: String {
"\(self.swiftVersion)_wasm"
if hostSwiftPackage == nil && targetSwiftPackagePath == nil {
return "wasm"
}
return "\(self.swiftVersion)_wasm"
}

package let shouldSupportEmbeddedSwift = true
Expand Down Expand Up @@ -140,71 +143,71 @@ package struct WebAssemblyRecipe: SwiftSDKRecipe {
httpClient: some HTTPClientProtocol
) async throws -> SwiftSDKProduct {
let pathsConfiguration = generator.pathsConfiguration
let targetSwiftLibPath = self.targetSwiftPackagePath.appending("usr/lib")

logger.info("Copying Swift binaries for the host triple...")
var hostTriples: [Triple]? = nil
if let hostSwiftPackage {
hostTriples = hostSwiftPackage.triples
try await generator.rsync(
from: hostSwiftPackage.path.appending("usr"),
to: pathsConfiguration.toolchainDirPath
)
if let targetSwiftLibPath = self.targetSwiftPackagePath?.appending("usr/lib") {
logger.info("Copying Swift binaries for the host triple...")
if let hostSwiftPackage {
hostTriples = hostSwiftPackage.triples
try await generator.rsync(
from: hostSwiftPackage.path.appending("usr"),
to: pathsConfiguration.toolchainDirPath
)

logger.info("Removing unused toolchain components...")
let liblldbNames: [String] = try await {
let libDirPath = pathsConfiguration.toolchainDirPath.appending("usr/lib")
guard await generator.doesFileExist(at: libDirPath) else {
return []
}
return try await generator.contentsOfDirectory(at: libDirPath).filter { dirEntry in
// liblldb is version suffixed: liblldb.so.17.0.0
dirEntry.hasPrefix("liblldb")
}
}()
try await generator.removeToolchainComponents(
pathsConfiguration.toolchainDirPath,
platforms: unusedTargetPlatforms,
libraries: unusedHostLibraries + liblldbNames,
binaries: unusedHostBinaries + ["lldb", "lldb-argdumper", "lldb-server"]
)
// Merge target Swift package with the host package.
try await self.mergeTargetSwift(from: targetSwiftLibPath, generator: generator)
} else {
// Simply copy the target Swift package into the SDK bundle when building host-agnostic SDK.
try await generator.createDirectoryIfNeeded(
at: pathsConfiguration.toolchainDirPath.appending("usr")
)
try await generator.copy(
from: targetSwiftLibPath,
to: pathsConfiguration.toolchainDirPath.appending("usr/lib")
)
}

let autolinkExtractPath = pathsConfiguration.toolchainBinDirPath.appending(
"swift-autolink-extract"
)
logger.info("Removing unused toolchain components...")
let liblldbNames: [String] = try await {
let libDirPath = pathsConfiguration.toolchainDirPath.appending("usr/lib")
guard await generator.doesFileExist(at: libDirPath) else {
return []
}
return try await generator.contentsOfDirectory(at: libDirPath).filter { dirEntry in
// liblldb is version suffixed: liblldb.so.17.0.0
dirEntry.hasPrefix("liblldb")
}
}()
try await generator.removeToolchainComponents(
pathsConfiguration.toolchainDirPath,
platforms: unusedTargetPlatforms,
libraries: unusedHostLibraries + liblldbNames,
binaries: unusedHostBinaries + ["lldb", "lldb-argdumper", "lldb-server"]
)
// Merge target Swift package with the host package.
try await self.mergeTargetSwift(from: targetSwiftLibPath, generator: generator)
} else {
// Simply copy the target Swift package into the SDK bundle when building host-agnostic SDK.
try await generator.createDirectoryIfNeeded(
at: pathsConfiguration.toolchainDirPath.appending("usr")
)
try await generator.copy(
from: targetSwiftLibPath,
to: pathsConfiguration.toolchainDirPath.appending("usr/lib")
)
}

// WebAssembly object file requires `swift-autolink-extract`
if await !generator.doesFileExist(at: autolinkExtractPath),
await generator.doesFileExist(
at: generator.pathsConfiguration.toolchainBinDirPath.appending("swift")
let autolinkExtractPath = pathsConfiguration.toolchainBinDirPath.appending(
"swift-autolink-extract"
)
{
logger.info("Fixing `swift-autolink-extract` symlink...")
try await generator.createSymlink(at: autolinkExtractPath, pointingTo: "swift")
}

// TODO: Remove this once we drop support for Swift 6.2
// Embedded Swift looks up clang compiler-rt in a different path.
let embeddedCompilerRTPath = pathsConfiguration.toolchainDirPath.appending(
"usr/lib/swift/clang/lib/wasip1"
)
if await !generator.doesFileExist(at: embeddedCompilerRTPath) {
try await generator.createSymlink(
at: embeddedCompilerRTPath,
pointingTo: "../../../swift_static/clang/lib/wasi"
// WebAssembly object file requires `swift-autolink-extract`
if await !generator.doesFileExist(at: autolinkExtractPath),
await generator.doesFileExist(
at: generator.pathsConfiguration.toolchainBinDirPath.appending("swift")
)
{
logger.info("Fixing `swift-autolink-extract` symlink...")
try await generator.createSymlink(at: autolinkExtractPath, pointingTo: "swift")
}

// TODO: Remove this once we drop support for Swift 6.2
// Embedded Swift looks up clang compiler-rt in a different path.
let embeddedCompilerRTPath = pathsConfiguration.toolchainDirPath.appending(
"usr/lib/swift/clang/lib/wasip1"
)
if await !generator.doesFileExist(at: embeddedCompilerRTPath) {
try await generator.createSymlink(
at: embeddedCompilerRTPath,
pointingTo: "../../../swift_static/clang/lib/wasi"
)
}
}

// Copy the WASI sysroot into the SDK bundle.
Expand Down