Skip to content

Fix async JNI strict concurrency #730

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
nerzh wants to merge 1 commit into
base: main
Choose a base branch
from
+107 −34
Open

Fix async JNI strict concurrency #730

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
101 changes: 73 additions & 28 deletions Sources/JExtractSwiftLib/JNI/JNISwift2JavaGenerator+NativeTranslation.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -232,7 +232,8 @@ extension JNISwift2JavaGenerator {
],
conversion: .pointee(.extractSwiftValue(.placeholder, swiftType: type)),
indirectConversion: nil,
conversionCheck: nil
conversionCheck: nil,
asyncTaskCaptureNames: [NativeSwiftConversionStep.extractedSwiftValueName(for: parameterName)]
)

case .tuple([]):
Expand Down Expand Up @@ -329,7 +330,8 @@ extension JNISwift2JavaGenerator {
],
conversion: .extractMetatypeValue(.placeholder),
indirectConversion: nil,
conversionCheck: nil
conversionCheck: nil,
asyncTaskCaptureNames: [NativeSwiftConversionStep.extractedSwiftValueName(for: parameterName)]
)

case .tuple(let elements) where elements.count == 1:
Expand Down Expand Up @@ -367,6 +369,7 @@ extension JNISwift2JavaGenerator {
) throws -> NativeParameter {
var allJNIParameters: [JavaParameter] = []
var elementConversions: [(label: String?, conversion: NativeSwiftConversionStep)] = []
var asyncTaskCaptureNames: [String] = []

for (idx, element) in elements.enumerated() {
let elementParamName = "\(parameterName)_\(idx)"
Expand All @@ -380,13 +383,15 @@ extension JNISwift2JavaGenerator {
)
allJNIParameters.append(contentsOf: elementNative.parameters)
elementConversions.append((label: element.label, conversion: elementNative.conversion))
asyncTaskCaptureNames.append(contentsOf: elementNative.asyncTaskCaptureNames)
}

return NativeParameter(
parameters: allJNIParameters,
conversion: .tupleConstruct(elements: elementConversions),
indirectConversion: nil,
conversionCheck: nil
conversionCheck: nil,
asyncTaskCaptureNames: asyncTaskCaptureNames
)
}

Expand Down Expand Up @@ -452,7 +457,8 @@ extension JNISwift2JavaGenerator {
allowsJavaImplementations: allowsJavaImplementations
),
indirectConversion: nil,
conversionCheck: nil
conversionCheck: nil,
asyncTaskCaptureNames: [NativeSwiftConversionStep.swiftObjectName(for: parameterName)]
)
}

Expand Down Expand Up @@ -529,7 +535,8 @@ extension JNISwift2JavaGenerator {
)
),
indirectConversion: nil,
conversionCheck: nil
conversionCheck: nil,
asyncTaskCaptureNames: [NativeSwiftConversionStep.extractedSwiftValueName(for: parameterName)]
)

default:
Expand Down Expand Up @@ -1072,6 +1079,24 @@ extension JNISwift2JavaGenerator {

/// Represents check operations executed in if/guard conditional block for check during conversion
let conversionCheck: NativeSwiftConversionCheck?

/// Temporary values created by this parameter conversion that must be moved
/// into async task bodies through an unchecked Sendable wrapper.
let asyncTaskCaptureNames: [String]
Copy link
Copy Markdown
Contributor

@sidepelican sidepelican May 7, 2026 •
edited
Loading

Choose a reason for hiding this comment

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

NativeParameter represents a single parameter for original swift functions.
It seems unnatural to include the names of multiple values you want to send.


init(
parameters: [JavaParameter],
conversion: NativeSwiftConversionStep,
indirectConversion: NativeSwiftConversionStep?,
conversionCheck: NativeSwiftConversionCheck?,
asyncTaskCaptureNames: [String] = []
) {
self.parameters = parameters
self.conversion = conversion
self.indirectConversion = indirectConversion
self.conversionCheck = conversionCheck
self.asyncTaskCaptureNames = asyncTaskCaptureNames
}
}

struct NativeResult {
Expand Down Expand Up @@ -1219,6 +1244,14 @@ extension JNISwift2JavaGenerator {
/// Destructures a Swift tuple result and writes each element to an out-parameter.
indirect case tupleDestructure(elements: [(index: Int, label: String?, conversion: NativeSwiftConversionStep, outParamName: String, javaType: JavaType)])

static func extractedSwiftValueName(for name: String) -> String {
"\(name)$"
}

static func swiftObjectName(for name: String) -> String {
"\(name)swiftObject$"
}

/// Promotes the outermost `.getJNIValue` to `.getJNILocalRefValue`.
/// Used for `@_cdecl` return positions to ensure the local ref survives
/// ARC destruction of temporary `JavaObject`s.
Expand Down Expand Up @@ -1268,7 +1301,7 @@ extension JNISwift2JavaGenerator {
let allowsJavaImplementations
):
let inner = inner.render(&printer, placeholder)
let variableName = "\(inner)swiftObject$"
let variableName = Self.swiftObjectName(for: inner)
let existentialType = SwiftKitPrinting.renderExistentialType(protocolTypes)
printer.print("let \(variableName): \(existentialType)")

Expand Down Expand Up @@ -1344,7 +1377,7 @@ extension JNISwift2JavaGenerator {

case .extractSwiftValue(let inner, let swiftType, let allowNil, let convertLongFromJNI):
let inner = inner.render(&printer, placeholder)
let pointerName = "\(inner)$"
let pointerName = Self.extractedSwiftValueName(for: inner)
if !allowNil {
printer.print(#"assert(\#(inner) != 0, "\#(inner) memory address was null")"#)
}
Expand All @@ -1367,7 +1400,7 @@ extension JNISwift2JavaGenerator {

case .extractMetatypeValue(let inner):
let inner = inner.render(&printer, placeholder)
let pointerName = "\(inner)$"
let pointerName = Self.extractedSwiftValueName(for: inner)
printer.print(
"""
let \(inner)Bits$ = Int(Int64(fromJNI: \(inner), in: environment))
Expand Down Expand Up @@ -1629,36 +1662,52 @@ extension JNISwift2JavaGenerator {
let completeExceptionallyMethodID
):
var globalRefs: [String] = ["globalFuture"]
var asyncTaskCaptureNames: [String] = []

func appendAsyncTaskCaptureNames(_ names: [String]) {
for name in names where !asyncTaskCaptureNames.contains(name) {
asyncTaskCaptureNames.append(name)
}
}

appendAsyncTaskCaptureNames(nativeFunctionSignature.selfParameter?.asyncTaskCaptureNames ?? [])
appendAsyncTaskCaptureNames(nativeFunctionSignature.selfTypeParameter?.asyncTaskCaptureNames ?? [])
for parameter in nativeFunctionSignature.parameters {
appendAsyncTaskCaptureNames(parameter.asyncTaskCaptureNames)
}

printer.print(
"""
struct _SwiftJavaUncheckedSendable<T>: @unchecked Sendable {
let value: T
}
"""
)

// Global ref all indirect returns
for outParameter in nativeFunctionSignature.result.outParameters {
printer.print(
"nonisolated(unsafe) let \(outParameter.name) = environment.interface.NewGlobalRef(environment, \(outParameter.name))"
"let \(outParameter.name)Sendable$ = _SwiftJavaUncheckedSendable(value: environment.interface.NewGlobalRef(environment, \(outParameter.name)))"
)
globalRefs.append(outParameter.name)
}

// We also need to global ref any objects passed in
for parameter in nativeFunctionSignature.parameters.flatMap(\.parameters) where !parameter.type.isPrimitive {
printer.print("nonisolated(unsafe) let \(parameter.name) = environment.interface.NewGlobalRef(environment, \(parameter.name))")
printer.print(
"let \(parameter.name)Sendable$ = _SwiftJavaUncheckedSendable(value: environment.interface.NewGlobalRef(environment, \(parameter.name)))"
)
globalRefs.append(parameter.name)
}

printer.print(
"""
nonisolated(unsafe) let globalFuture = environment.interface.NewGlobalRef(environment, result_future)
let globalFutureSendable$ = _SwiftJavaUncheckedSendable(value: environment.interface.NewGlobalRef(environment, result_future))
"""
)

if let selfParameter = nativeFunctionSignature.selfParameter {
for parameter in selfParameter.parameters {
printer.print("nonisolated(unsafe) let \(parameter.name)Sendable$ = \(parameter.name)$")
}
}
if let selfTypeParameter = nativeFunctionSignature.selfTypeParameter {
for parameter in selfTypeParameter.parameters {
printer.print("nonisolated(unsafe) let \(parameter.name)Sendable$ = \(parameter.name)$")
}
for name in asyncTaskCaptureNames {
printer.print("let \(name)Sendable$ = _SwiftJavaUncheckedSendable(value: \(name))")
}

func printDo(printer: inout CodePrinter) {
Expand Down Expand Up @@ -1703,15 +1752,11 @@ extension JNISwift2JavaGenerator {
}

func printTaskBody(printer: inout CodePrinter) {
if let selfParameter = nativeFunctionSignature.selfParameter {
for parameter in selfParameter.parameters {
printer.print("let \(parameter.name)$ = \(parameter.name)Sendable$")
}
for globalRef in globalRefs {
printer.print("let \(globalRef) = \(globalRef)Sendable$.value")
}
if let selfTypeParameter = nativeFunctionSignature.selfTypeParameter {
for parameter in selfTypeParameter.parameters {
printer.print("let \(parameter.name)$ = \(parameter.name)Sendable$")
}
for name in asyncTaskCaptureNames {
printer.print("let \(name) = \(name)Sendable$.value")
}
printer.printBraceBlock("defer") { printer in
// Defer might on any thread, so we need to attach environment.
Expand Down
40 changes: 34 additions & 6 deletions Tests/JExtractSwiftTests/JNI/JNIAsyncTests.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,12 +61,16 @@ struct JNIAsyncTests {
"""
@_cdecl("Java_com_example_swift_SwiftModule__00024asyncVoid__Ljava_util_concurrent_CompletableFuture_2")
public func Java_com_example_swift_SwiftModule__00024asyncVoid__Ljava_util_concurrent_CompletableFuture_2(environment: UnsafeMutablePointer<JNIEnv?>!, thisClass: jclass, result_future: jobject?) {
nonisolated(unsafe) let globalFuture = environment.interface.NewGlobalRef(environment, result_future)
struct _SwiftJavaUncheckedSendable<T>: @unchecked Sendable {
let value: T
}
let globalFutureSendable$ = _SwiftJavaUncheckedSendable(value: environment.interface.NewGlobalRef(environment, result_future))
var task: Task<Void, Never>? = nil
#if swift(>=6.2)
if #available(macOS 26.0, iOS 26.0, watchOS 26.0, tvOS 26.0, *) {
task = Task.immediate {
var environment = try! JavaVirtualMachine.shared().environment()
let globalFuture = globalFutureSendable$.value
defer {
let deferEnvironment = try! JavaVirtualMachine.shared().environment()
deferEnvironment.interface.DeleteGlobalRef(deferEnvironment, globalFuture)
Expand All @@ -80,6 +84,7 @@ struct JNIAsyncTests {
if task == nil {
task = Task {
var environment = try! JavaVirtualMachine.shared().environment()
let globalFuture = globalFutureSendable$.value
defer {
let deferEnvironment = try! JavaVirtualMachine.shared().environment()
deferEnvironment.interface.DeleteGlobalRef(deferEnvironment, globalFuture)
Expand Down Expand Up @@ -137,12 +142,16 @@ struct JNIAsyncTests {
"""
@_cdecl("Java_com_example_swift_SwiftModule__00024async__Ljava_util_concurrent_CompletableFuture_2")
public func Java_com_example_swift_SwiftModule__00024async__Ljava_util_concurrent_CompletableFuture_2(environment: UnsafeMutablePointer<JNIEnv?>!, thisClass: jclass, result_future: jobject?) {
nonisolated(unsafe) let globalFuture = environment.interface.NewGlobalRef(environment, result_future)
struct _SwiftJavaUncheckedSendable<T>: @unchecked Sendable {
let value: T
}
let globalFutureSendable$ = _SwiftJavaUncheckedSendable(value: environment.interface.NewGlobalRef(environment, result_future))
var task: Task<Void, Never>? = nil
#if swift(>=6.2)
if #available(macOS 26.0, iOS 26.0, watchOS 26.0, tvOS 26.0, *) {
task = Task.immediate {
var environment = try! JavaVirtualMachine.shared().environment()
let globalFuture = globalFutureSendable$.value
defer {
let deferEnvironment = try! JavaVirtualMachine.shared().environment()
deferEnvironment.interface.DeleteGlobalRef(deferEnvironment, globalFuture)
Expand All @@ -163,6 +172,7 @@ struct JNIAsyncTests {
if task == nil {
task = Task {
var environment = try! JavaVirtualMachine.shared().environment()
let globalFuture = globalFutureSendable$.value
defer {
let deferEnvironment = try! JavaVirtualMachine.shared().environment()
deferEnvironment.interface.DeleteGlobalRef(deferEnvironment, globalFuture)
Expand Down Expand Up @@ -227,12 +237,16 @@ struct JNIAsyncTests {
"""
@_cdecl("Java_com_example_swift_SwiftModule__00024async__JLjava_util_concurrent_CompletableFuture_2")
public func Java_com_example_swift_SwiftModule__00024async__JLjava_util_concurrent_CompletableFuture_2(environment: UnsafeMutablePointer<JNIEnv?>!, thisClass: jclass, i: jlong, result_future: jobject?) {
nonisolated(unsafe) let globalFuture = environment.interface.NewGlobalRef(environment, result_future)
struct _SwiftJavaUncheckedSendable<T>: @unchecked Sendable {
let value: T
}
let globalFutureSendable$ = _SwiftJavaUncheckedSendable(value: environment.interface.NewGlobalRef(environment, result_future))
var task: Task<Void, Never>? = nil
#if swift(>=6.2)
if #available(macOS 26.0, iOS 26.0, watchOS 26.0, tvOS 26.0, *) {
task = Task.immediate {
var environment = try! JavaVirtualMachine.shared().environment()
let globalFuture = globalFutureSendable$.value
defer {
let deferEnvironment = try! JavaVirtualMachine.shared().environment()
deferEnvironment.interface.DeleteGlobalRef(deferEnvironment, globalFuture)
Expand All @@ -247,6 +261,7 @@ struct JNIAsyncTests {
if task == nil {
task = Task {
var environment = try! JavaVirtualMachine.shared().environment()
let globalFuture = globalFutureSendable$.value
defer {
let deferEnvironment = try! JavaVirtualMachine.shared().environment()
deferEnvironment.interface.DeleteGlobalRef(deferEnvironment, globalFuture)
Expand Down Expand Up @@ -320,12 +335,18 @@ struct JNIAsyncTests {
guard let c$ else {
fatalError("c memory address was null in call to \\(#function)!")
}
nonisolated(unsafe) let globalFuture = environment.interface.NewGlobalRef(environment, result_future)
struct _SwiftJavaUncheckedSendable<T>: @unchecked Sendable {
let value: T
}
let globalFutureSendable$ = _SwiftJavaUncheckedSendable(value: environment.interface.NewGlobalRef(environment, result_future))
let c$Sendable$ = _SwiftJavaUncheckedSendable(value: c$)
var task: Task<Void, Never>? = nil
#if swift(>=6.2)
if #available(macOS 26.0, iOS 26.0, watchOS 26.0, tvOS 26.0, *) {
task = Task.immediate {
var environment = try! JavaVirtualMachine.shared().environment()
let globalFuture = globalFutureSendable$.value
let c$ = c$Sendable$.value
defer {
let deferEnvironment = try! JavaVirtualMachine.shared().environment()
deferEnvironment.interface.DeleteGlobalRef(deferEnvironment, globalFuture)
Expand All @@ -343,6 +364,8 @@ struct JNIAsyncTests {
if task == nil {
task = Task {
var environment = try! JavaVirtualMachine.shared().environment()
let globalFuture = globalFutureSendable$.value
let c$ = c$Sendable$.value
defer {
let deferEnvironment = try! JavaVirtualMachine.shared().environment()
deferEnvironment.interface.DeleteGlobalRef(deferEnvironment, globalFuture)
Expand Down Expand Up @@ -403,9 +426,14 @@ struct JNIAsyncTests {
"""
@_cdecl("Java_com_example_swift_SwiftModule__00024async__Ljava_lang_String_2Ljava_util_concurrent_CompletableFuture_2")
public func Java_com_example_swift_SwiftModule__00024async__Ljava_lang_String_2Ljava_util_concurrent_CompletableFuture_2(environment: UnsafeMutablePointer<JNIEnv?>!, thisClass: jclass, s: jstring?, result_future: jobject?) {
nonisolated(unsafe) let s = environment.interface.NewGlobalRef(environment, s)
nonisolated(unsafe) let globalFuture = environment.interface.NewGlobalRef(environment, result_future)
struct _SwiftJavaUncheckedSendable<T>: @unchecked Sendable {
let value: T
}
let sSendable$ = _SwiftJavaUncheckedSendable(value: environment.interface.NewGlobalRef(environment, s))
let globalFutureSendable$ = _SwiftJavaUncheckedSendable(value: environment.interface.NewGlobalRef(environment, result_future))
...
let globalFuture = globalFutureSendable$.value
let s = sSendable$.value
defer {
let deferEnvironment = try! JavaVirtualMachine.shared().environment()
deferEnvironment.interface.DeleteGlobalRef(deferEnvironment, globalFuture)
Expand Down
Loading