Commit 9b6512f
n-api: unlink reference during its destructor
Currently, a reference is being unlinked from the list of references
tracked by the environment when `v8impl::Reference::Delete` is called.
This causes a leak when deletion must be deferred because the finalizer
hasn't yet run, but the finalizer does not run because environment
teardown is in progress, and so no more gc runs will happen, and the
`FinalizeAll` run that happens during environment teardown does not
catch the reference because it's no longer in the list. The test below
will fail when running with ASAN:
```
./node ./test/node-api/test_worker_terminate_finalization/test.js
```
OTOH if, to address the above leak, we make a special case to not
unlink a reference during environment teardown, we run into a
situation where the reference gets deleted by
`v8impl::Reference::Delete` but does not get unlinked because it's
environment teardown time. This leaves a stale pointer in the linked
list which will result in a use-after-free in `FinalizeAll` during
environment teardown. The test below will fail if we make the above
change:
```
./node -e "require('./test/node-api/test_instance_data/build/Release/test_ref_then_set.node');"
```
Thus, we unlink a reference precisely when we destroy it – in its
destructor.
Refs: #34731
Refs: #34839
Refs: #35620
Refs: #35777
Fixes: #35778
Signed-off-by: Gabriel Schulhof <gabriel.schulhof@intel.com>
PR-URL: #35933
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Michael Dawson <midawson@redhat.com>
Reviewed-By: Zeyu Yang <himself65@outlook.com>1 parent 1b277d9 commit 9b6512f
2 files changed
Lines changed: 2 additions & 3 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -220,6 +220,8 @@ class RefBase : protected Finalizer, RefTracker { | |||
| 220 | 220 | finalize_hint); | |
| 221 | 221 | } | |
| 222 | 222 | ||
| 223 | + virtual ~RefBase() { Unlink(); } | ||
| 224 | + | ||
| 223 | 225 | inline void* Data() { | |
| 224 | 226 | return _finalize_data; | |
| 225 | 227 | } | |
@@ -240,7 +242,6 @@ class RefBase : protected Finalizer, RefTracker { | |||
| 240 | 242 | // the finalizer and _delete_self is set. In this case we | |
| 241 | 243 | // know we need to do the deletion so just do it. | |
| 242 | 244 | static inline void Delete(RefBase* reference) { | |
| 243 | - reference->Unlink(); | ||
| 244 | 245 | if ((reference->RefCount() != 0) || | |
| 245 | 246 | (reference->_delete_self) || | |
| 246 | 247 | (reference->_finalize_ran)) { | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -1,11 +1,9 @@ | |||
| 1 | 1 | 'use strict'; | |
| 2 | 2 | const common = require('../../common'); | |
| 3 | 3 | ||
| 4 | - // TODO(addaleax): Run this test once it stops failing under ASAN/valgrind. | ||
| 5 | 4 | // Refs: https://github.com/nodejs/node/issues/34731 | |
| 6 | 5 | // Refs: https://github.com/nodejs/node/pull/35777 | |
| 7 | 6 | // Refs: https://github.com/nodejs/node/issues/35778 | |
| 8 | - common.skip('Reference management in N-API leaks memory'); | ||
| 9 | 7 | ||
| 10 | 8 | const { Worker, isMainThread } = require('worker_threads'); | |
| 11 | 9 | ||
0 commit comments