Enable sharing JObjects across isolates
#1060
Merged
Conversation
This file contains 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
…iveFinalizers for JReference
HosseinYousefi
changed the title
JObjects across isolatesJObjects across isolates
PR HealthCoverage
|
| File | Coverage |
|---|---|
| pkgs/jni/example/integration_test/on_device_jni_test.dart | 💔 Not covered |
| pkgs/jni/lib/src/errors.dart | 💔 Not covered |
| pkgs/jni/lib/src/jni.dart | 💔 Not covered |
| pkgs/jni/lib/src/jobject.dart | 💔 Not covered |
| pkgs/jni/lib/src/jreference.dart | 💔 Not covered |
| pkgs/jni/lib/src/third_party/jni_bindings_generated.dart | 💔 Not covered |
| pkgs/jnigen/example/kotlin_plugin/example/lib/main.dart | 💔 Not covered |
| pkgs/jnigen/tool/generate_runtime_tests.dart | 💔 Not covered |
This check for test coverage is informational (issues shown here will not fail the PR).
This check can be disabled by tagging the PR with skip-coverage-check
License Headers ⚠️
Details
// Copyright (c) 2024, the Dart project authors. Please see the AUTHORS file
// for details. All rights reserved. Use of this source code is governed by a
// BSD-style license that can be found in the LICENSE file.
| Files |
|---|
| pkgs/jni/lib/src/third_party/jni_bindings_generated.dart |
| pkgs/jnigen/example/kotlin_plugin/example/lib/main.dart |
All source files should start with a license header.
Unrelated files missing license headers
| Files |
|---|
| pkgs/ffi/example/main.dart |
| pkgs/ffigen/example/libclang-example/generated_bindings.dart |
| pkgs/ffigen/example/objective_c/avf_audio_bindings.dart |
| pkgs/ffigen/example/shared_bindings/generate.dart |
| pkgs/ffigen/example/shared_bindings/lib/generated/a_gen.dart |
| pkgs/ffigen/example/shared_bindings/lib/generated/a_shared_b_gen.dart |
| pkgs/ffigen/example/shared_bindings/lib/generated/base_gen.dart |
| pkgs/ffigen/example/simple/generated_bindings.dart |
| pkgs/ffigen/example/swift/swift_api_bindings.dart |
| pkgs/ffigen/lib/src/config_provider/config_spec.dart |
| pkgs/ffigen/lib/src/header_parser/clang_bindings/clang_bindings.dart |
| pkgs/ffigen/test/collision_tests/expected_bindings/_expected_decl_decl_collision_bindings.dart |
| pkgs/ffigen/test/collision_tests/expected_bindings/_expected_decl_symbol_address_collision_bindings.dart |
| pkgs/ffigen/test/collision_tests/expected_bindings/_expected_decl_type_name_collision_bindings.dart |
| pkgs/ffigen/test/collision_tests/expected_bindings/_expected_reserved_keyword_collision_bindings.dart |
| pkgs/ffigen/test/header_parser_tests/expected_bindings/_expected_comment_markup_bindings.dart |
| pkgs/ffigen/test/header_parser_tests/expected_bindings/_expected_dart_handle_bindings.dart |
| pkgs/ffigen/test/header_parser_tests/expected_bindings/_expected_forward_decl_bindings.dart |
| pkgs/ffigen/test/header_parser_tests/expected_bindings/_expected_functions_bindings.dart |
| pkgs/ffigen/test/header_parser_tests/expected_bindings/_expected_imported_types_bindings.dart |
| pkgs/ffigen/test/header_parser_tests/expected_bindings/_expected_native_func_typedef_bindings.dart |
| pkgs/ffigen/test/header_parser_tests/expected_bindings/_expected_opaque_dependencies_bindings.dart |
| pkgs/ffigen/test/header_parser_tests/expected_bindings/_expected_packed_structs_bindings.dart |
| pkgs/ffigen/test/header_parser_tests/expected_bindings/_expected_regress_384_bindings.dart |
| pkgs/ffigen/test/header_parser_tests/expected_bindings/_expected_struct_fptr_fields_bindings.dart |
| pkgs/ffigen/test/header_parser_tests/expected_bindings/_expected_typedef_bindings.dart |
| pkgs/ffigen/test/header_parser_tests/expected_bindings/_expected_unions_bindings.dart |
| pkgs/ffigen/test/header_parser_tests/expected_bindings/_expected_varargs_bindings.dart |
| pkgs/ffigen/test/large_integration_tests/_expected_cjson_bindings.dart |
| pkgs/ffigen/test/large_integration_tests/_expected_libclang_bindings.dart |
| pkgs/ffigen/test/large_integration_tests/_expected_sqlite_bindings.dart |
| pkgs/ffigen/test/native_test/_expected_native_test_bindings.dart |
| pkgs/jni/lib/src/lang/jcharacter.dart |
| pkgs/jni/lib/src/third_party/generated_bindings.dart |
| pkgs/jni/lib/src/third_party/global_env_extensions.dart |
| pkgs/jnigen/android_test_runner/lib/main.dart |
| pkgs/jnigen/example/in_app_java/lib/android_utils.dart |
| pkgs/jnigen/example/kotlin_plugin/lib/kotlin_bindings.dart |
| pkgs/jnigen/example/kotlin_plugin/lib/kotlin_plugin.dart |
| pkgs/jnigen/example/pdfbox_plugin/lib/pdfbox_plugin.dart |
| pkgs/jnigen/example/pdfbox_plugin/lib/src/third_party/_init.dart |
| pkgs/jnigen/example/pdfbox_plugin/lib/src/third_party/org/apache/pdfbox/pdmodel/PDDocument.dart |
| pkgs/jnigen/example/pdfbox_plugin/lib/src/third_party/org/apache/pdfbox/pdmodel/PDDocumentInformation.dart |
| pkgs/jnigen/example/pdfbox_plugin/lib/src/third_party/org/apache/pdfbox/pdmodel/_package.dart |
| pkgs/jnigen/example/pdfbox_plugin/lib/src/third_party/org/apache/pdfbox/text/PDFTextStripper.dart |
| pkgs/jnigen/example/pdfbox_plugin/lib/src/third_party/org/apache/pdfbox/text/_package.dart |
| pkgs/jnigen/lib/src/bindings/descriptor.dart |
| pkgs/jnigen/lib/src/elements/elements.g.dart |
| pkgs/jnigen/test/jackson_core_test/third_party/c_based/dart_bindings/com/fasterxml/jackson/core/_package.dart |
| pkgs/jnigen/test/jackson_core_test/third_party/dart_only/dart_bindings/com/fasterxml/jackson/core/_package.dart |
| pkgs/jnigen/tool/command_runner.dart |
This check can be disabled by tagging the PR with skip-license-check
Package publish validation ✔️
Details
| Package | Version | Status |
|---|---|---|
| package:ffi | 2.1.2 | already published at pub.dev |
| package:ffigen | 12.0.0-wip | WIP (no publish necessary) |
| package:jni | 0.8.0-wip | WIP (no publish necessary) |
| package:jnigen | 0.8.0-wip | WIP (no publish necessary) |
| package:native_assets_builder | 0.6.1 | already published at pub.dev |
| package:native_assets_cli | 0.5.4 | already published at pub.dev |
| package:native_toolchain_c | 0.4.1 | already published at pub.dev |
Documentation at https://github.com/dart-lang/ecosystem/wiki/Publishing-automation.
HosseinYousefi
force-pushed
the
share-jobjects-isolate
branch
from
cd3fc3a to
15ecede
Compare
|
Could you add a PR description with the overall approach? And document what we do guard against and what we don't guard against. (e.g. we don't guard against concurrently using in one isolate and deleting in another). |
dcharkes
requested changes
Mar 27, 2024
There was a problem hiding this comment.
We need to be clear on what kind of safety guarantees we provide.
use-after-free will throw from Dart
use-on-isolate-b-after-free-on-isolate-a will throw from Dart
double-free will throw from Dart
free-on-isolate-b-after-free-on-isolate-a will throw from Dart
concurrent-free-on-two-isolates will throw from Dart (if we use compare and swap)
concurrent-use-and-free will not throw from Dart. It will crash. Please open an issue to address this in a follow up PR and document why we don't address it in this PR.
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.
Closes #1054. Closes #981.
Approach:
We use a
FinalizableHandlewhich is for an entire isolate group as opposed to aNativeFinalizerwhich belongs to a single isolate. This way we can use@pragma('vm:deeply-immutable')onJReferenceto share the reference object between multiple isolates while the finalizable handle takes care of the global reference deletion.The guarantees we provide:
In general, if we're not eagerly freeing via
.release(), things work.