Skip to content

Make sdkRootPath property of swift-sdk.json targetTriples object optional #8687

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

Jump to bottom
Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Make sdkRootPath property of swift-sdk.json targetTriples object optional #8687

wants to merge 2 commits into from

Conversation

marcprux
Copy link
Contributor

Makes the "sdkRootPath" property of swift-sdk.json optional.

Motivation:

The Android SDK bundle (swiftlang/swift#80788) does not include the Android NDK's sysroot in the bundle itself, but instead relies on it being installed locally. The install location will vary, and the user will be able to configure it with a command (modulo #8584) like:

swift sdk configure --sdk-root-path ~/Library/Android/sdk/ndk/27.0.12077973/toolchains/llvm/prebuilt/darwin-x86_64/sysroot/ swift-6.2-RELEASE-android-0.1 aarch64-unknown-linux-android28

However, since the SwiftSDKMetadataV4.sdkRootPath property is declared as non-optional, some value must be included in the swift-sdk.json file.

@MaxDesiatov at swiftlang/swift#80788 (comment) mentions:

As for making it optional, I don't quite remember the exact issue that caused it to become non-optional. After all, making it optional is technically not a breaking change, so potentially could be considered if necessary.

Modifications:

Change SwiftSDKMetadataV4.sdkRootPath from String to String?

Result:

The swift-sdk.json can now contain destinations that do not specify a sdkRootPath property.

@MaxDesiatov
Copy link
Contributor

Would you mind adding tests that verify this change? Thanks!

@MaxDesiatov MaxDesiatov added needs tests This change needs test coverage cross-compilation labels May 18, 2025
@finagolfin finagolfin added the swift sdk Changes impacting `swift sdk` tool label May 18, 2025
@rauhul
Copy link
Member

rauhul commented May 18, 2025

Changes like this 100% need to have accompanying documentation, otherwise anyone reading the SE is going to be extremely confused.

@marcprux marcprux changed the title Make SwiftSDKMetadataV4.sdkRootPath optional Make sdkRootPath property of swift-sdk.json targetTriples object optional May 18, 2025
@marcprux
Copy link
Contributor Author

Changes like this 100% need to have accompanying documentation,

Happy to document as needed, but I don't believe the optionality of sdkRootPath is currently stated anywhere. Where do you think I should add docs?

otherwise anyone reading the SE is going to be extremely confused.

What's an SE?

@marcprux
Copy link
Contributor Author

Would you mind adding tests that verify this change? Thanks!

Added in afdaa3f. Happy to add more tests for this if you have suggestions.

@MaxDesiatov
Copy link
Contributor

What's an SE?

Swift Evolution

@MaxDesiatov
Copy link
Contributor

@swift-ci test

@MaxDesiatov
Copy link
Contributor

@swift-ci test windows

@MaxDesiatov MaxDesiatov added needs documentation and removed needs tests This change needs test coverage labels May 19, 2025
@MaxDesiatov
Copy link
Contributor

@swift-ci test windows

1 similar comment
@MaxDesiatov
Copy link
Contributor

@swift-ci test windows

@MaxDesiatov
Copy link
Contributor

@swift-ci test windows self hosted

@MaxDesiatov
Copy link
Contributor

@swift-ci test self hosted windows

@finagolfin
Copy link
Member

@swift-ci test

@finagolfin
Copy link
Member

We should try to get SwiftPM's SDK bundle feature working with external C/C++ SDKs before the 6.2 release. The other big bug Marc found is #8584.

@finagolfin finagolfin moved this to In Progress in Swift on Android Jun 12, 2025
@finagolfin
Copy link
Member

@swift-ci test self hosted macos

@finagolfin
Copy link
Member

@swift-ci test self hosted

@finagolfin
Copy link
Member

@rauhul, "test self hosted macos" did nothing, do we need to add it or is it just flaky?

@finagolfin
Copy link
Member

Alright, this is ready to go, only the SDK bundle proposal has not been amended to show this change. Marc, want to edit that?

marcprux added a commit to marcprux/swift-evolution that referenced this pull request Jun 20, 2025
@marcprux
Update sdkRootPath to be optional in swift-sdk.json
388f78c 
In swiftlang/swift-package-manager#8687 make sdkRootPath an optional field.
@marcprux marcprux mentioned this pull request Jun 20, 2025
Open
@dschaefer2
Copy link
Member

dschaefer2 commented Jun 20, 2025 •
edited
Loading

@heckj @bripeticca Do we have documentation on Swift SDK's yet that would cover this yet?

I think we want to move away from the evolution proposals being our documentation.

@marcprux marcprux mentioned this pull request Jun 21, 2025
Merged
@finagolfin
Copy link
Member

I don't think there is yet any documentation of these SDK bundle internal config files other than the evolution proposal, so that seems to be the only place that would need to be updated for this pull.

MaxDesiatov added a commit that referenced this pull request Jul 13, 2025
@marcprux @MaxDesiatov
Allow omitting the target triple for swift sdk configure (#8856)
69f851d 
You can now run `swift sdk configure --sdk-root-path /some/sdk/root
sdk-id` without needing to specify the target triple

### Motivation:

The Android SDK
(swiftlang/swift#80788 (comment))
needs to have its `sdkRootPath` configured to point to an external NDK
sysroot. But it contains many different target triples, like
`armv7-unknown-linux-androideabi33` and
`x86_64-unknown-linux-android29`, all of which need to be configured to
point to the same sysroot. Following on to
#8687 and
swiftlang/swift-evolution#2888, this PR enables
running a single command to configure the entire SDK, like so:

```
swift run swift-sdk configure --sdk-root-path ~/Library/Android/sdk/ndk/27.0.12077973/toolchains/llvm/prebuilt/darwin-x86_64/sysroot swift-6.1-RELEASE-android-24-0.1
```

This will result in configurations being created for each of the target
triples for the SDK ID.

<details>

```
% swift run swift-sdk configure --sdk-root-path ~/Library/Android/sdk/ndk/27.0.12077973/toolchains/llvm/prebuilt/darwin-x86_64/sysroot swift-6.1-RELEASE-android-24-0.1
info: These properties of Swift SDK `swift-6.1-RELEASE-android-24-0.1` for target triple `aarch64-unknown-linux-android25` were successfully updated: sdkRootPath.
info: These properties of Swift SDK `swift-6.1-RELEASE-android-24-0.1` for target triple `armv7-unknown-linux-androideabi33` were successfully updated: sdkRootPath.
info: These properties of Swift SDK `swift-6.1-RELEASE-android-24-0.1` for target triple `aarch64-unknown-linux-android26` were successfully updated: sdkRootPath.
info: These properties of Swift SDK `swift-6.1-RELEASE-android-24-0.1` for target triple `armv7-unknown-linux-androideabi35` were successfully updated: sdkRootPath.
info: These properties of Swift SDK `swift-6.1-RELEASE-android-24-0.1` for target triple `aarch64-unknown-linux-android31` were successfully updated: sdkRootPath.
info: These properties of Swift SDK `swift-6.1-RELEASE-android-24-0.1` for target triple `armv7-unknown-linux-androideabi29` were successfully updated: sdkRootPath.
info: These properties of Swift SDK `swift-6.1-RELEASE-android-24-0.1` for target triple `aarch64-unknown-linux-android32` were successfully updated: sdkRootPath.
info: These properties of Swift SDK `swift-6.1-RELEASE-android-24-0.1` for target triple `aarch64-unknown-linux-android34` were successfully updated: sdkRootPath.
info: These properties of Swift SDK `swift-6.1-RELEASE-android-24-0.1` for target triple `x86_64-unknown-linux-android27` were successfully updated: sdkRootPath.
info: These properties of Swift SDK `swift-6.1-RELEASE-android-24-0.1` for target triple `armv7-unknown-linux-androideabi25` were successfully updated: sdkRootPath.
info: These properties of Swift SDK `swift-6.1-RELEASE-android-24-0.1` for target triple `armv7-unknown-linux-androideabi26` were successfully updated: sdkRootPath.
info: These properties of Swift SDK `swift-6.1-RELEASE-android-24-0.1` for target triple `armv7-unknown-linux-androideabi24` were successfully updated: sdkRootPath.
info: These properties of Swift SDK `swift-6.1-RELEASE-android-24-0.1` for target triple `x86_64-unknown-linux-android33` were successfully updated: sdkRootPath.
info: These properties of Swift SDK `swift-6.1-RELEASE-android-24-0.1` for target triple `aarch64-unknown-linux-android35` were successfully updated: sdkRootPath.
info: These properties of Swift SDK `swift-6.1-RELEASE-android-24-0.1` for target triple `x86_64-unknown-linux-android29` were successfully updated: sdkRootPath.
info: These properties of Swift SDK `swift-6.1-RELEASE-android-24-0.1` for target triple `x86_64-unknown-linux-android32` were successfully updated: sdkRootPath.
info: These properties of Swift SDK `swift-6.1-RELEASE-android-24-0.1` for target triple `x86_64-unknown-linux-android25` were successfully updated: sdkRootPath.
info: These properties of Swift SDK `swift-6.1-RELEASE-android-24-0.1` for target triple `aarch64-unknown-linux-android24` were successfully updated: sdkRootPath.
info: These properties of Swift SDK `swift-6.1-RELEASE-android-24-0.1` for target triple `armv7-unknown-linux-androideabi30` were successfully updated: sdkRootPath.
info: These properties of Swift SDK `swift-6.1-RELEASE-android-24-0.1` for target triple `x86_64-unknown-linux-android26` were successfully updated: sdkRootPath.
info: These properties of Swift SDK `swift-6.1-RELEASE-android-24-0.1` for target triple `aarch64-unknown-linux-android33` were successfully updated: sdkRootPath.
info: These properties of Swift SDK `swift-6.1-RELEASE-android-24-0.1` for target triple `armv7-unknown-linux-androideabi32` were successfully updated: sdkRootPath.
info: These properties of Swift SDK `swift-6.1-RELEASE-android-24-0.1` for target triple `x86_64-unknown-linux-android35` were successfully updated: sdkRootPath.
info: These properties of Swift SDK `swift-6.1-RELEASE-android-24-0.1` for target triple `x86_64-unknown-linux-android34` were successfully updated: sdkRootPath.
info: These properties of Swift SDK `swift-6.1-RELEASE-android-24-0.1` for target triple `x86_64-unknown-linux-android31` were successfully updated: sdkRootPath.
info: These properties of Swift SDK `swift-6.1-RELEASE-android-24-0.1` for target triple `aarch64-unknown-linux-android28` were successfully updated: sdkRootPath.
info: These properties of Swift SDK `swift-6.1-RELEASE-android-24-0.1` for target triple `aarch64-unknown-linux-android27` were successfully updated: sdkRootPath.
info: These properties of Swift SDK `swift-6.1-RELEASE-android-24-0.1` for target triple `x86_64-unknown-linux-android24` were successfully updated: sdkRootPath.
info: These properties of Swift SDK `swift-6.1-RELEASE-android-24-0.1` for target triple `x86_64-unknown-linux-android30` were successfully updated: sdkRootPath.
info: These properties of Swift SDK `swift-6.1-RELEASE-android-24-0.1` for target triple `armv7-unknown-linux-androideabi28` were successfully updated: sdkRootPath.
info: These properties of Swift SDK `swift-6.1-RELEASE-android-24-0.1` for target triple `x86_64-unknown-linux-android28` were successfully updated: sdkRootPath.
info: These properties of Swift SDK `swift-6.1-RELEASE-android-24-0.1` for target triple `armv7-unknown-linux-androideabi27` were successfully updated: sdkRootPath.
info: These properties of Swift SDK `swift-6.1-RELEASE-android-24-0.1` for target triple `aarch64-unknown-linux-android30` were successfully updated: sdkRootPath.
info: These properties of Swift SDK `swift-6.1-RELEASE-android-24-0.1` for target triple `armv7-unknown-linux-androideabi34` were successfully updated: sdkRootPath.
info: These properties of Swift SDK `swift-6.1-RELEASE-android-24-0.1` for target triple `armv7-unknown-linux-androideabi31` were successfully updated: sdkRootPath.
info: These properties of Swift SDK `swift-6.1-RELEASE-android-24-0.1` for target triple `aarch64-unknown-linux-android29` were successfully updated: sdkRootPath.

% ls ~/Library/org.swift.swiftpm/swift-sdks/configuration/
swift-6.1-RELEASE-android-24-0.1_aarch64-unknown-linux-android24.json
swift-6.1-RELEASE-android-24-0.1_aarch64-unknown-linux-android25.json
swift-6.1-RELEASE-android-24-0.1_aarch64-unknown-linux-android26.json
swift-6.1-RELEASE-android-24-0.1_aarch64-unknown-linux-android27.json
swift-6.1-RELEASE-android-24-0.1_aarch64-unknown-linux-android28.json
swift-6.1-RELEASE-android-24-0.1_aarch64-unknown-linux-android29.json
swift-6.1-RELEASE-android-24-0.1_aarch64-unknown-linux-android30.json
swift-6.1-RELEASE-android-24-0.1_aarch64-unknown-linux-android31.json
swift-6.1-RELEASE-android-24-0.1_aarch64-unknown-linux-android32.json
swift-6.1-RELEASE-android-24-0.1_aarch64-unknown-linux-android33.json
swift-6.1-RELEASE-android-24-0.1_aarch64-unknown-linux-android34.json
swift-6.1-RELEASE-android-24-0.1_aarch64-unknown-linux-android35.json
swift-6.1-RELEASE-android-24-0.1_armv7-unknown-linux-androideabi24.json
swift-6.1-RELEASE-android-24-0.1_armv7-unknown-linux-androideabi25.json
swift-6.1-RELEASE-android-24-0.1_armv7-unknown-linux-androideabi26.json
swift-6.1-RELEASE-android-24-0.1_armv7-unknown-linux-androideabi27.json
swift-6.1-RELEASE-android-24-0.1_armv7-unknown-linux-androideabi28.json
swift-6.1-RELEASE-android-24-0.1_armv7-unknown-linux-androideabi29.json
swift-6.1-RELEASE-android-24-0.1_armv7-unknown-linux-androideabi30.json
swift-6.1-RELEASE-android-24-0.1_armv7-unknown-linux-androideabi31.json
swift-6.1-RELEASE-android-24-0.1_armv7-unknown-linux-androideabi32.json
swift-6.1-RELEASE-android-24-0.1_armv7-unknown-linux-androideabi33.json
swift-6.1-RELEASE-android-24-0.1_armv7-unknown-linux-androideabi34.json
swift-6.1-RELEASE-android-24-0.1_armv7-unknown-linux-androideabi35.json
swift-6.1-RELEASE-android-24-0.1_x86_64-unknown-linux-android24.json
swift-6.1-RELEASE-android-24-0.1_x86_64-unknown-linux-android25.json
swift-6.1-RELEASE-android-24-0.1_x86_64-unknown-linux-android26.json
swift-6.1-RELEASE-android-24-0.1_x86_64-unknown-linux-android27.json
swift-6.1-RELEASE-android-24-0.1_x86_64-unknown-linux-android28.json
swift-6.1-RELEASE-android-24-0.1_x86_64-unknown-linux-android29.json
swift-6.1-RELEASE-android-24-0.1_x86_64-unknown-linux-android30.json
swift-6.1-RELEASE-android-24-0.1_x86_64-unknown-linux-android31.json
swift-6.1-RELEASE-android-24-0.1_x86_64-unknown-linux-android32.json
swift-6.1-RELEASE-android-24-0.1_x86_64-unknown-linux-android33.json
swift-6.1-RELEASE-android-24-0.1_x86_64-unknown-linux-android34.json
swift-6.1-RELEASE-android-24-0.1_x86_64-unknown-linux-android35.json

% cat ~/Library/org.swift.swiftpm/swift-sdks/configuration/swift-6.1-RELEASE-android-24-0.1_x86_64-unknown-linux-android31.json
{
  "sdkRootPath" : "/Users/marc/Library/Android/sdk/ndk/27.0.12077973/toolchains/llvm/prebuilt/darwin-x86_64/sysroot",
  "swiftResourcesPath" : "/Users/marc/Library/org.swift.swiftpm/swift-sdks/swift-6.1-RELEASE-android-24-0.1.artifactbundle/swift-6.1-release-android-24-sdk/android-27c-sysroot/usr/lib/swift",
  "swiftStaticResourcesPath" : "/Users/marc/Library/org.swift.swiftpm/swift-sdks/swift-6.1-RELEASE-android-24-0.1.artifactbundle/swift-6.1-release-android-24-sdk/android-27c-sysroot/usr/lib/swift_static-x86_64",
  "toolsetPaths" : [
    "/Users/marc/Library/org.swift.swiftpm/swift-sdks/swift-6.1-RELEASE-android-24-0.1.artifactbundle/swift-6.1-release-android-24-sdk/swift-toolset.json"
  ]
}
```
</details>

In addition, this fixes
#8584, where
`swift sdk configure` with a specified target triple didn't work at all,
and instead would configure some random target triple for the specified
SDK.

### Modifications:

Make the `targetTriple` flag for `ConfigureSwiftSDK` optional and, when
nil, apply the command to all triples included in the specified SDK.

### Result:

Fixes #8584 and
enables configuring multiple target triples with a single `swift sdk
configure` command.

---------

Co-authored-by: Max Desiatov <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jakepetroules jakepetroules jakepetroules approved these changes

@dschaefer2 dschaefer2 Awaiting requested review from dschaefer2 dschaefer2 is a code owner

@shawnhyam shawnhyam Awaiting requested review from shawnhyam shawnhyam is a code owner

@bripeticca bripeticca Awaiting requested review from bripeticca bripeticca is a code owner

@plemarquand plemarquand Awaiting requested review from plemarquand plemarquand is a code owner

@owenv owenv Awaiting requested review from owenv owenv is a code owner

@bkhouri bkhouri Awaiting requested review from bkhouri bkhouri is a code owner

@cmcgee1024 cmcgee1024 Awaiting requested review from cmcgee1024 cmcgee1024 is a code owner

@daveyc123 daveyc123 Awaiting requested review from daveyc123 daveyc123 is a code owner

Assignees
No one assigned
Labels
cross-compilation needs documentation swift sdk Changes impacting `swift sdk` tool
Projects
Swift on Android
Status: In Progress
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
6 participants
@marcprux @MaxDesiatov @rauhul @finagolfin @dschaefer2 @jakepetroules