Apply toolset's debugger property in swift run
#8252
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Per [SE-0378 toolsets can specify an optional `debugger` property](https://github.com/swiftlang/swift-evolution/blob/main/proposals/0387-cross-compilation-destinations.md#toolsetjson-files), which so far had no effect. We should respect this property in `swift run` invocations when any toolsets or Swift SDKs are selected. This allows running and debugging cross-compiled products in an environment other than the host, e.g. a container runtime when cross-compiled to Linux, qemu or a firmware flasher and serial port setup script with Swift Embedded for microcontrollers, or in a Wasm runtime for a WASI binary.
MaxDesiatov
added
cross-compilation
swift run
MaxDesiatov
requested review from
bnbarham,
jakepetroules,
francescomikulis,
xedin,
dschaefer2,
shawnhyam,
bripeticca,
plemarquand,
owenv and
bkhouri
as code owners
|
@swift-ci test |
|
@swift-ci test |
MaxDesiatov
changed the title
debugger property in swift-rundebugger property in swift-run
|
@swift-ci test windows |
bkhouri
reviewed
Jan 28, 2025
| @@ -40,6 +40,25 @@ final class RunCommandTests: CommandsTestCase { | |||
| XCTAssert(stdout.contains("Swift Package Manager"), "got stdout:\n" + stdout) | |||
| } | |||
|
|
|||
| // echo.sh script from the toolset won't work on Windows | |||
| #if !os(Windows) | |||
There was a problem hiding this comment.
suggestion: can we create an equivalent target that will run on Windows to ensure the functions work on that host platform?
There was a problem hiding this comment.
I'm not sure, I don't have experience with Windows and don't have means to test on Windows. IIRC the test suite doesn't even run on the Windows CI job. I'd prefer to do this in a separate PR, when we have established means of running these Windows-specific tests on CI in the first place.
kateinoigakukun
approved these changes
Jan 28, 2025
MaxDesiatov
changed the title
debugger property in swift-rundebugger property in swift run
dschaefer2
approved these changes
Jan 28, 2025
MaxDesiatov
added a commit
that referenced
this pull request
Jan 29, 2025
### Motivation: Per [SE-0378 toolsets can specify an optional `debugger` property](https://github.com/swiftlang/swift-evolution/blob/main/proposals/0387-cross-compilation-destinations.md#toolsetjson-files), which so far had no effect. We should respect this property in `swift run` invocations when any toolsets or Swift SDKs are selected. This allows running and debugging cross-compiled products in an environment other than the host, e.g. a container runtime when cross-compiled to Linux, QEMU or a firmware flasher and serial port setup script with Swift Embedded for microcontrollers, or in a Wasm runtime for a Wasm binary. ### Modifications: Updated `SwiftRunCommand` to check for the `debugger` property in toolsets or Swift SDKs when such are specified. Its value is then used to launch a freshly built binary. ### Result: Cross-compiled binaries can be directly launched and debugged with a `swift run` invocation.
This was referenced Jan 29, 2025
MaxDesiatov
added a commit
that referenced
this pull request
Feb 3, 2025
Cherry-pick of #8252, merged as 88e2af7. **Explanation**: Per [SE-0378 toolsets can specify an optional `debugger` property](https://github.com/swiftlang/swift-evolution/blob/main/proposals/0387-cross-compilation-destinations.md#toolsetjson-files), which so far had no effect. We should respect this property in `swift run` invocations when any toolsets or Swift SDKs are selected. This allows running and debugging cross-compiled products in an environment other than the host, e.g. a container runtime when cross-compiled to Linux, QEMU or a firmware flasher and serial port setup script with Swift Embedded for microcontrollers, or in a Wasm runtime for a Wasm binary. **Scope**: Only impacts `swift-run` when a toolset or a Swift SDK are selected. **Risk**: Low, due to limited scope and automated testing. **Testing**: Added a new test cause to the existing XCTest suite. **Issue**: rdar://143814083 **Reviewer**: @dschaefer2
bripeticca
pushed a commit
to bripeticca/swift-package-manager
that referenced
this pull request
Feb 28, 2025
### Motivation: Per [SE-0378 toolsets can specify an optional `debugger` property](https://github.com/swiftlang/swift-evolution/blob/main/proposals/0387-cross-compilation-destinations.md#toolsetjson-files), which so far had no effect. We should respect this property in `swift run` invocations when any toolsets or Swift SDKs are selected. This allows running and debugging cross-compiled products in an environment other than the host, e.g. a container runtime when cross-compiled to Linux, QEMU or a firmware flasher and serial port setup script with Swift Embedded for microcontrollers, or in a Wasm runtime for a Wasm binary. ### Modifications: Updated `SwiftRunCommand` to check for the `debugger` property in toolsets or Swift SDKs when such are specified. Its value is then used to launch a freshly built binary. ### Result: Cross-compiled binaries can be directly launched and debugged with a `swift run` invocation.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Motivation:
Per SE-0378 toolsets can specify an optional
debuggerproperty, which so far had no effect. We should respect this property inswift runinvocations when any toolsets or Swift SDKs are selected.This allows running and debugging cross-compiled products in an environment other than the host, e.g. a container runtime when cross-compiled to Linux, QEMU or a firmware flasher and serial port setup script with Swift Embedded for microcontrollers, or in a Wasm runtime for a Wasm binary.
Modifications:
Updated
SwiftRunCommandto check for thedebuggerproperty in toolsets or Swift SDKs when such are specified. Its value is then used to launch a freshly built binary.Result:
Cross-compiled binaries can be directly launched and debugged with a
swift runinvocation.