src: avoid making JSTransferable wrapper object weak #50026

legendecas · 2023-10-03T15:45:32Z

JSTransferable wrapper object is a short-lived wrapper in the scope of
the serialization or the deserialization. Make the JSTransferable
wrapper object pointer as a strongly-referenced detached BaseObjectPtr
so that a JSTransferable wrapper object and its target object will never
be garbage-collected during a ser-des process, and the wrapper object
will be immediately destroyed when the process is completed.

Fixes: #49852
Fixes: #49844

JSTransferable wrapper object is a short-lived wrapper in the scope of the serialization or the deserialization. Make the JSTransferable wrapper object pointer as a strongly-referenced detached BaseObjectPtr so that a JSTransferable wrapper object and its target object will never be garbage-collected during a ser-des process, and the wrapper object will be immediately destroyed when the process is completed.

anonrig · 2023-10-03T17:00:26Z

src/node_messaging.cc

+}
+
+JSTransferable::~JSTransferable() {
+  HandleScope scope(env()->isolate());


For education purposes: What is the purpose of initializing a scope in here?

A local handle is created with target_.Get(env()->isolate()) in the next line. A handle scope is needed in place to collect the local handle when it goes out of lexical scope.

H4ad · 2023-10-06T00:21:07Z

The crash still occurs even with this commit:

[00:00:08|%   7| 0/1 files |  4/60 runs | 1/2 configs]: perf_hooks/histogram.js node:internal/worker/io:410
  const message = receiveMessageOnPort_(port?.[kHandle] ?? port);
                  ^

Error: Unable to deserialize cloned data.
    at receiveMessageOnPort (node:internal/worker/io:410:19)
    at structuredClone (node:internal/structured_clone:24:10)
    at main (/home/h4ad/Projects/opensource/node-copy-4/benchmark/perf_hooks/histogram.js:30:22)
    at /home/h4ad/Projects/opensource/node-copy-4/benchmark/common.js:54:9
    at process.processTicksAndRejections (node:internal/process/task_queues:77:11)

Node.js v21.0.0-pre

legendecas · 2023-10-06T13:15:59Z

Stress test: https://ci.nodejs.org/job/node-stress-single-test/459/

I can reproduce with pummel/test-structuredclone-jstransferable locally on the main branch in 10 runs, and no reproduction with the patch.

legendecas · 2023-10-06T13:44:04Z

@H4ad the stress test passed. Would you mind sharing more information about your local test? Thank you.

H4ad · 2023-10-06T13:45:44Z

@legendecas Try with this code:

'use strict';

const assert = require('assert');
const common = require('../common.js');

const { createHistogram } = require('perf_hooks');

const bench = common.createBenchmark(main, {
  n: [1e5],
  operation: ['creation', 'clone'],
});

let _histogram;

function main({ n, operation }) {
  switch (operation) {
    case 'creation': {
      bench.start();
      for (let i = 0; i < n; i++)
        _histogram = createHistogram();
      bench.end(n);

      // Avoid V8 deadcode (elimination)
      assert.ok(_histogram);
      break;
    }
    case 'clone': {
      bench.start();
      for (let i = 0; i < n; i++)
        _histogram = structuredClone(createHistogram());
      bench.end(n);

      // Avoid V8 deadcode (elimination)
      assert.ok(_histogram);
      break;
    }
    default:
      throw new Error(`Unsupported operation ${operation}`);
  }
}

Put it inside benchmark/perf_hooks and then run with this new patch.

legendecas · 2023-10-06T13:47:29Z

Note that benchmark/compare.js runs the benchmark with the new node binary and the old node binary. So it would report errors for node binary without this patch. Would you mind verifying if the error happened with the new node binary? Because from what I can tell from your posted output result, it seems like you are running with benchmark/compare.js. Please correct me if I'm getting wrong.

H4ad · 2023-10-06T14:01:13Z

Oh, you are right, I forgot to compile the old version with your patch, sorry about that.

In this case, I can confirm this PR fixes my bug! Thanks for your work!

nodejs-github-bot · 2023-10-06T14:10:45Z

CI: https://ci.nodejs.org/job/node-test-pull-request/54581/

nodejs-github-bot · 2023-10-09T23:48:36Z

CI: https://ci.nodejs.org/job/node-test-pull-request/54640/

nodejs-github-bot · 2023-10-10T00:36:46Z

CI: https://ci.nodejs.org/job/node-test-pull-request/54642/

mcollina

lgtm

nodejs-github-bot · 2023-10-10T07:42:32Z

Landed in 78a1570

JSTransferable wrapper object is a short-lived wrapper in the scope of the serialization or the deserialization. Make the JSTransferable wrapper object pointer as a strongly-referenced detached BaseObjectPtr so that a JSTransferable wrapper object and its target object will never be garbage-collected during a ser-des process, and the wrapper object will be immediately destroyed when the process is completed. PR-URL: nodejs#50026 Fixes: nodejs#49852 Fixes: nodejs#49844 Reviewed-By: Yagiz Nizipli <yagiz@nizipli.com> Reviewed-By: Matteo Collina <matteo.collina@gmail.com>

nodejs-github-bot added c++ Issues and PRs that require attention from people who are familiar with C++. needs-ci PRs that need a full CI run. labels Oct 3, 2023

anonrig reviewed Oct 3, 2023

View reviewed changes

legendecas mentioned this pull request Oct 4, 2023

Unable to deserialize cloned data #49844

Closed

H4ad approved these changes Oct 6, 2023

View reviewed changes

legendecas added the request-ci Add this label to start a Jenkins CI on a PR. label Oct 6, 2023

github-actions bot removed the request-ci Add this label to start a Jenkins CI on a PR. label Oct 6, 2023

github-actions bot mentioned this pull request Oct 7, 2023

CI Reliability 2023-10-07 nodejs/reliability#686

Open

19 tasks

H4ad mentioned this pull request Oct 7, 2023

perf_hooks: reduce overhead of createHistogram #50074

Closed

This was referenced Oct 8, 2023

CI Reliability 2023-10-08 nodejs/reliability#687

Open

CI Reliability 2023-10-09 nodejs/reliability#688

Open

This was referenced Oct 9, 2023

stream: reduce overhead of transfer #50107

Merged

Perf of ReflectConstruct nodejs/performance#109

Closed

anonrig approved these changes Oct 9, 2023

View reviewed changes

github-actions bot mentioned this pull request Oct 10, 2023

CI Reliability 2023-10-10 nodejs/reliability#689

Open

24 tasks

H4ad mentioned this pull request Oct 10, 2023

lib: reduce overhead of blob clone #50110

Merged

mcollina approved these changes Oct 10, 2023

View reviewed changes

legendecas added the commit-queue Add this label to land a pull request using GitHub Actions. label Oct 10, 2023

nodejs-github-bot removed the commit-queue Add this label to land a pull request using GitHub Actions. label Oct 10, 2023

nodejs-github-bot merged commit 78a1570 into nodejs:main Oct 10, 2023
62 checks passed

legendecas deleted the js_transferable_weak branch October 10, 2023 07:50

RafaelGSS mentioned this pull request Oct 10, 2023

2023-10-17, Version 21.0.0 (Current) #49870

Merged

github-actions bot mentioned this pull request Oct 11, 2023

CI Reliability 2023-10-11 nodejs/reliability#690

Open

30 tasks

targos added the dont-land-on-v20.x PRs that should not land on the v20.x-staging branch and should not be released in v20.x. label Nov 11, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

src: avoid making JSTransferable wrapper object weak #50026

src: avoid making JSTransferable wrapper object weak #50026

legendecas commented Oct 3, 2023

anonrig Oct 3, 2023

legendecas Oct 3, 2023

H4ad commented Oct 6, 2023

legendecas commented Oct 6, 2023

legendecas commented Oct 6, 2023

H4ad commented Oct 6, 2023

legendecas commented Oct 6, 2023 •

edited

Loading

H4ad commented Oct 6, 2023 •

edited

Loading

nodejs-github-bot commented Oct 6, 2023

nodejs-github-bot commented Oct 9, 2023

nodejs-github-bot commented Oct 10, 2023

mcollina left a comment

nodejs-github-bot commented Oct 10, 2023

src: avoid making JSTransferable wrapper object weak #50026

src: avoid making JSTransferable wrapper object weak #50026

Conversation

legendecas commented Oct 3, 2023

anonrig Oct 3, 2023

Choose a reason for hiding this comment

legendecas Oct 3, 2023

Choose a reason for hiding this comment

H4ad commented Oct 6, 2023

legendecas commented Oct 6, 2023

legendecas commented Oct 6, 2023

H4ad commented Oct 6, 2023

legendecas commented Oct 6, 2023 • edited Loading

H4ad commented Oct 6, 2023 • edited Loading

nodejs-github-bot commented Oct 6, 2023

nodejs-github-bot commented Oct 9, 2023

nodejs-github-bot commented Oct 10, 2023

mcollina left a comment

Choose a reason for hiding this comment

nodejs-github-bot commented Oct 10, 2023

legendecas commented Oct 6, 2023 •

edited

Loading

H4ad commented Oct 6, 2023 •

edited

Loading