Skip to content

Optional xcframework support for Linux #7239

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

Merged
dschaefer2 merged 19 commits into from
Nov 11, 2025
Merged

Optional xcframework support for Linux #7239

Changes from 2 commits
Commits
Show all changes
19 commits
Select commit Hold shift + click to select a range
427bc40
Optional xcframework for Linux
ordo-ci Jan 10, 2024
4c83efc
Merge branch 'main' into optional-linux-xcframework-main
hassila Oct 2, 2025
9034d5f
no xcframework support on android
vsarunas Oct 13, 2025
5f16e18
Merge branch 'swiftlang:main' into optional-linux-xcframework-main
vsarunas Oct 13, 2025
a8750a1
remove env variable; add --experimental-xcframeworks-on-linux
vsarunas Oct 15, 2025
33f6cee
add back linux to asXCFrameworkPlatformString
vsarunas Oct 15, 2025
e063924
move logic to BuildPlan level
vsarunas Oct 15, 2025
56d3ddd
fix accidental whitespace
vsarunas Oct 15, 2025
28a78b1
move to memoize and move android check
vsarunas Oct 15, 2025
a303a0f
add BuildPlan test for Linux XCF flag
vsarunas Oct 17, 2025
cd9bcd3
Add a functional test for XCF with LibraryEvolution on Linux
vsarunas Oct 17, 2025
774a84f
Merge branch 'swiftlang:main' into optional-linux-xcframework-main
vsarunas Oct 22, 2025
233feab
Merge branch 'swiftlang:main' into optional-linux-xcframework-main
vsarunas Oct 27, 2025
bf4ceac
fix tests on windows
vsarunas Oct 28, 2025
688b872
Merge branch 'swiftlang:main' into optional-linux-xcframework-main
vsarunas Oct 28, 2025
f92fdb0
fix tests on windows via ifdef
vsarunas Oct 28, 2025
fce61bc
Merge branch 'swiftlang:main' into optional-linux-xcframework-main
vsarunas Oct 29, 2025
325bbab
pr feedback
vsarunas Nov 4, 2025
f88a984
Merge branch 'swiftlang:main' into optional-linux-xcframework-main
vsarunas Nov 4, 2025
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
4 changes: 3 additions & 1 deletion Sources/SPMBuildCore/BinaryTarget+Extensions.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -123,7 +123,7 @@ extension Triple.OS {
/// Returns a representation of the receiver that can be compared with platform strings declared in an XCFramework.
fileprivate var asXCFrameworkPlatformString: String? {
switch self {
case .darwin, .linux, .wasi, .win32, .openbsd, .freebsd, .noneOS:
case .darwin, .wasi, .win32, .openbsd, .freebsd, .noneOS:
return nil // XCFrameworks do not support any of these platforms today.
case .macosx:
return "macos"
Expand All @@ -133,6 +133,8 @@ extension Triple.OS {
return "tvos"
case .watchos:
return "watchos"
case .linux:
Copy link
Contributor

@jakepetroules jakepetroules Oct 2, 2025

Choose a reason for hiding this comment

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

This would need to return nil for Android triples. We should move the extension from Triple.OS to Triple and check both the os and environment fields; ensuring the environment field is gnu or musl, or at least not android/androideabi.

Copy link
Contributor

@vsarunas vsarunas Oct 13, 2025

Choose a reason for hiding this comment

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

Hi @jakepetroules ,

Moved and added an android check

return ProcessInfo.processInfo.environment["_SWIFTPM_EXPERIMENTAL_LINUX_XCFRAMEWORK"] == "1" ? "linux" : nil
Copy link
Member

@dschaefer2 dschaefer2 Oct 6, 2025

Choose a reason for hiding this comment

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

I prefer this being an experimental flag that we can make hidden if necessary. This is how we did the prebuilts.

Copy link
Member

@dschaefer2 dschaefer2 Oct 6, 2025

Choose a reason for hiding this comment

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

I'm just actively trying to make sure SwiftPM doesn't necessitate the need for Environment changes. It's just too many degrees of separation between where they're set and where they're used.

Copy link
Contributor

@vsarunas vsarunas Oct 13, 2025

Choose a reason for hiding this comment

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

Hi @dschaefer2 ,

Do you mean to define a hidden boolean flag under GlobalOptions.BuildOptions in Options.swift and then to pass this to BuildParameters via SwiftCommandState and making use of this in:

  1. BuildPlan+Swift.swift
  2. BuildPlan+Product.swift
  3. BuildPlan+Clang.swift

Or is there more locations where changes are required?

Copy link
Member

@dschaefer2 dschaefer2 Oct 14, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

Yeah, the environment variable is pretty deep in the call tree here. That whole getter has a pretty heavy side effect relying on the name being nil to disallow a platform. Not a choice I would have made :). But let's not change too much.

We should really check at the BuildPlan level wherever we're calling parseXCFramework and only do linux if the flag is enabled.

Copy link
Contributor

@vsarunas vsarunas Oct 14, 2025

Choose a reason for hiding this comment

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

Ok, any preference on what the flag should be named ?

/// Hidden option to allow XCFrameworks on Linux
@Flag(
    name: .customLong("experimental-xcframeworks-on-linux"),
    help: .hidden
)
public var enableXCFrameworksOnLinux: Bool = false

Copy link
Member

@dschaefer2 dschaefer2 Oct 14, 2025

Choose a reason for hiding this comment

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

That looks fine.

Copy link
Contributor

@vsarunas vsarunas Oct 15, 2025

Choose a reason for hiding this comment

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

Hi @dschaefer2,

I have removed the env variable and added swift-build --experimental-xcframeworks-on-linux, which compiles our product successfully.

Copy link
Member

@dschaefer2 dschaefer2 Oct 16, 2025

Choose a reason for hiding this comment

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

Excellent. Thanks! I'm wondering if there's a test we can add to make sure it stays working as we make changes in there.

Copy link
Contributor

@vsarunas vsarunas Oct 16, 2025

Choose a reason for hiding this comment

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

Do you mean something like testXCFrameworkBinaryTargets(), to create a new test function for Linux ?

Copy link
Contributor

@vsarunas vsarunas Oct 17, 2025

Choose a reason for hiding this comment

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

Hi @dschaefer2 ,

I have added a test on BuildPlan for the optional flag validation and also a functional test which compiles a library with Library Evolution; packages this into XCF; builds and runs a test binary on Linux.

default:
return nil // XCFrameworks do not support any of these platforms today.
}
Expand Down