Skip to content
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.

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

Documentation: Update CMake.md to use the ABI entry point #828

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

Conversation

ADKaster
Copy link
Contributor

@ADKaster ADKaster commented Nov 17, 2024

The SwiftPM entry point is unstable and the new ABIv0 entry point has already been added to the library.

Motivation:

Using the SwiftPM entry point when building tests from a CMake project as recommended in the documentation is outdated and unwise.

Modifications:

Replace the example with one using the new ABIv0 entry point.

Result:

CMake projects should stop relying on the SwiftPM entry point.

Checklist:

  • Code and documentation should follow the style of the Style Guide.
  • If public symbols are renamed or modified, DocC references should be updated.

The SwiftPM entry point is unstable and the new ABIv0 entry point has
already been added to the library.
@ADKaster
Copy link
Contributor Author

cc @compnerd

@grynspan grynspan added bug Something isn't working documentation Improvements or additions to documentation tools integration Integration of swift-testing into tools/IDEs build Affects the project's build configuration or process labels Nov 17, 2024
@ADKaster
Copy link
Contributor Author

Hm. Chatting with Jonathan on Slack some more, it seems like the fact that this works with the Swift OSS toolchain on linux is a toolchain bug: we shouldn't be able to access the private module from user code.

Another alternative (with -enable-experimental-feature Extern) looks like this:

import Foundation

typealias EntryPoint = @convention(thin) @Sendable (_ configurationJSON: UnsafeRawBufferPointer?, _ recordHandler: @escaping @Sendable (_ recordJSON: UnsafeRawBufferPointer) -> Void) async throws -> Bool

@_extern(c, "swt_abiv0_getEntryPoint")
func swt_abiv0_getEntryPoint() -> UnsafeRawPointer

@main struct Runner {
    static func main() async throws {
        let configurationJSON: UnsafeRawBufferPointer? = nil
        let recordHandler: @Sendable (UnsafeRawBufferPointer) -> Void = { _ in }

        let entryPoint = unsafeBitCast(swt_abiv0_getEntryPoint(), to: EntryPoint.self)

        if try await entryPoint(configurationJSON, recordHandler) {
            exit(EXIT_SUCCESS)
        } else {
            exit(EXIT_FAILURE)
        }
    }
}


```swift
import Testing
import Foundation
@_spi(ForToolsIntegrationOnly) import Testing
Copy link
Contributor

@grynspan grynspan Nov 18, 2024

Choose a reason for hiding this comment

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

So, yes-and-no. As we talked about in Slack, it's a bug that any @_spi content is available in the Swift toolchain right now and it's going to get removed in the future.

For the moment, code should either use dlsym()/GetProcAddress() or, if a little more adventurous, use the experimental @_extern(c) to call swt_abiv0_getEntryPoint(), then load the SwiftCC entry point from there. (@_silgen_name could be used too, but technically the calling conventions are incompatible, so caveat codor.)

We're still looking at how to expose these symbols in a way that makes it easy for test tools/harness authors but doesn't make the symbols visible to test authors by default. We're looking at adding a dedicated target in the package (if we can do so without requiring building the whole library from source) or creating a separate swift-testing-tools-support package, among other options.

static func main() async {
await Testing.__swiftPMEntryPoint() as Never
static func main() async throws {
let configurationJSON: UnsafeRawBufferPointer? = nil
Copy link
Contributor

Choose a reason for hiding this comment

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

You can leave this line out and just pass nil if you're not actually going to use it. :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working build Affects the project's build configuration or process documentation Improvements or additions to documentation tools integration Integration of swift-testing into tools/IDEs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants