-
-
Notifications
You must be signed in to change notification settings - Fork 36.7k
node-api: fix crash on re-entering TSFN finalization during env shutdown #65967
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
Open
legendecas
wants to merge
1
commit into
nodejs:main
Choose a base branch
from
legendecas:node-api-tsfn-reentry
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+96
−3
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,57 @@ | ||
| #include <node_api.h> | ||
| #include <stdlib.h> | ||
| #include "../../js-native-api/common.h" | ||
|
|
||
| typedef struct { | ||
| napi_threadsafe_function tsfn; | ||
| } Holder; | ||
|
|
||
| static void CallJs(napi_env env, napi_value js_cb, void* context, void* data) {} | ||
|
|
||
| // Runs while the napi_env tears down, reached from the thread-safe function | ||
| // dropping its own napi_env reference. Releasing the thread-safe function | ||
| // from here reenters TSFN finalization. | ||
| static void FinalizeHolder(napi_env env, void* data, void* hint) { | ||
| Holder* holder = data; | ||
| napi_status status = | ||
| napi_release_threadsafe_function(holder->tsfn, napi_tsfn_abort); | ||
| if (status != napi_ok) { | ||
| abort(); | ||
| } | ||
| free(holder); | ||
| } | ||
|
|
||
| NAPI_MODULE_INIT() { | ||
| napi_value name; | ||
| napi_value external; | ||
| Holder* holder = malloc(sizeof(*holder)); | ||
|
|
||
| NODE_API_CALL( | ||
| env, | ||
| napi_create_string_utf8(env, "tsfn_teardown", NAPI_AUTO_LENGTH, &name)); | ||
|
|
||
| // The initial thread count is never released, so the thread-safe function is | ||
| // still ref-ed by another thread when the environment tears down. | ||
| NODE_API_CALL(env, | ||
| napi_create_threadsafe_function(env, | ||
| NULL, | ||
| NULL, | ||
| name, | ||
| 0, | ||
| 1, | ||
| NULL, | ||
| NULL, | ||
| NULL, | ||
| CallJs, | ||
| &holder->tsfn)); | ||
| // Allow the worker uv_loop to exit. | ||
| NODE_API_CALL(env, napi_unref_threadsafe_function(env, holder->tsfn)); | ||
|
|
||
| // Held by the module exports, which the module cache keeps alive, so the | ||
| // napi_external finalizer runs during napi_env teardown. | ||
| NODE_API_CALL( | ||
| env, napi_create_external(env, holder, FinalizeHolder, NULL, &external)); | ||
| NODE_API_CALL(env, napi_set_named_property(env, exports, "holder", external)); | ||
|
|
||
| return exports; | ||
| } |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| { | ||
| "targets": [ | ||
| { | ||
| "target_name": "binding", | ||
| "sources": ["binding.c"] | ||
| } | ||
| ] | ||
| } |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,20 @@ | ||
| 'use strict'; | ||
|
|
||
| const common = require('../../common'); | ||
| const assert = require('assert'); | ||
| const { Worker, isMainThread } = require('worker_threads'); | ||
|
|
||
| // A worker that exits while a native addon still owns a thread-safe function. | ||
| // The TSFN finalizer could trigger napi_env finalization and the addon | ||
| // may re-enter the TSFN finalization. | ||
| // Refs: https://github.com/nodejs/node/issues/65100 | ||
|
|
||
| if (isMainThread) { | ||
| const worker = new Worker(__filename); | ||
| worker.on('error', common.mustNotCall()); | ||
| worker.on('exit', common.mustCall((code) => { | ||
| assert.strictEqual(code, 0); | ||
| })); | ||
| } else { | ||
| require(`./build/${common.buildType}/binding`); | ||
| } |
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We discussed this PR in the 11 Sep 2026 Node-API meeting, specifically regarding of this
MaybeDelete()can be called where the state is alreadykClosed(ie. if thisMaybeDelete()gets called multiple times).We discussed that it might be beneficial to add more test cases to verify that this
CHECK_EQis safe, by adding a test case with>1forinitial_thread_countand using the multiple pathways to "finalize" the TSFN:napi_release_threadsafe_functionwithnapi_tsfn_releasemode.napi_release_threadsafe_functionwithnapi_tsfn_abort, and other threads callnapi_call_threadsafe_functionwhich returnsnapi_closing.