sea: add support for V8 bytecode-only caching by RaisinTen · Pull Request #48191 · nodejs/node

RaisinTen · 2023-05-26T15:33:26Z

This improves the startup performance of SEAs.

For example, the comparison of the startup performance benchmarks of a Node.js SEA built using the CJS bundle of Yarn's source code shows a 24% improvement on my x86_64 macOS:

$ hyperfine -N -w 30 -L cmd 'with_code_cache/yarn help','without_code_cache/yarn help' '{cmd}'
Benchmark 1: with_code_cache/yarn help
  Time (mean ± σ):     210.8 ms ±   1.3 ms    [User: 224.0 ms, System: 25.2 ms]
  Range (min … max):   209.0 ms … 213.4 ms    14 runs

Benchmark 2: without_code_cache/yarn help
  Time (mean ± σ):     279.1 ms ±   2.3 ms    [User: 284.9 ms, System: 30.1 ms]
  Range (min … max):   276.6 ms … 284.4 ms    10 runs

Summary
  'with_code_cache/yarn help' ran
    1.32 ± 0.01 times faster than 'without_code_cache/yarn help'

Fixes: nodejs/single-executable#73

cc @kvakil

nodejs-github-bot · 2023-05-26T15:33:30Z

Review requested:

@nodejs/loaders
@nodejs/modules
@nodejs/single-executable
@nodejs/startup

src/node_sea.cc

src/node_contextify.cc

src/node_sea.cc

It expresses the intent in a clearer way. Refs: nodejs#48191 (comment) Signed-off-by: Darshan Sen <[email protected]>

Refs: nodejs#48191 (comment) Signed-off-by: Darshan Sen <[email protected]>

lib/internal/util/embedding.js

Refs: nodejs#48191 (comment) Signed-off-by: Darshan Sen <[email protected]>

src/node_contextify.cc

src/node_sea.cc

Refs: nodejs#48191 (comment) Signed-off-by: Darshan Sen <[email protected]>

joyeecheung

I don't think this includes any tests for the new feature? We should at least have some to exercise the code paths..

src/node_sea.cc

lib/internal/modules/cjs/loader.js

RaisinTen · 2023-06-02T06:09:55Z

I don't think this includes any tests for the new feature? We should at least have some to exercise the code paths..

This change generates the code cache and uses it by default, so the existing E2E SEA tests should already be exercising the added code paths, right?

Refs: nodejs#48191 (comment) Signed-off-by: Darshan Sen <[email protected]>

src/node_sea.cc

Refs: nodejs#48191 (comment) Signed-off-by: Darshan Sen <[email protected]>

kvakil

Thanks, this is great! I left some nits

(One last note wrt startup time: it's unfortunate that we store the source code as UTF8 because then we need to transcode/copy it into Latin1/UTF16 in order to actually put it into V8. Ideally we'd use external strings instead. That's not really related to this diff, but thought I'd note it since we're one the subject. :)

src/node_contextify.cc

src/node_sea.cc

joyeecheung · 2023-06-10T22:36:22Z

it's unfortunate that we store the source code as UTF8 because then we need to transcode/copy it into Latin1/UTF16 in order to actually put it into V8

I think this could be made configurable because storing the strings as UTF8 could save quite some space if the source actually contains two-byte characters, which may be more important to users than the startup cost depending on their use case.

Original commit message: [compiler] fix CompileFunction ignoring kEagerCompile v8::ScriptCompiler::CompileFunction was ignoring kEagerCompile. Unlike the other functions in v8::ScriptCompiler, it was not actually propagating kEagerCompile to the parser. The newly updated test fails without this change. I did some archeology and found that this was commented out since the original CL in https://crrev.com/c/980944. As far as I know Node.js is the main consumer of this particular API. This CL speeds up Node.js's overall startup time by ~13%. Change-Id: Ifc3cd6653555194d46ca48db14f7ba7a4afe0053 Reviewed-on: https://chromium-review.googlesource.com/c/v8/v8/+/4571822 Commit-Queue: Marja Hölttä <[email protected]> Reviewed-by: Marja Hölttä <[email protected]> Cr-Commit-Position: refs/heads/main@{#87944} Refs: v8/v8@cb00db4 Refs: nodejs#48191 (comment) Signed-off-by: Darshan Sen <[email protected]>

It expresses the intent in a clearer way. Refs: nodejs#48191 (comment) Signed-off-by: Darshan Sen <[email protected]>

Refs: nodejs#48191 (comment) Signed-off-by: Darshan Sen <[email protected]>

Refs: https://github.com/nodejs/node/pull/48191/files/300f3f4a03d7f418fb565a479f19b67c22d80a07#r1269593383 Signed-off-by: Darshan Sen <[email protected]>

Refs: https://github.com/nodejs/node/pull/48191/files/300f3f4a03d7f418fb565a479f19b67c22d80a07#r1269601154 Signed-off-by: Darshan Sen <[email protected]>

Signed-off-by: Darshan Sen <[email protected]>

RaisinTen · 2023-07-21T07:29:33Z

Done @joyeecheung, PTAL

joyeecheung

LGTM, thanks

nodejs-github-bot · 2023-07-26T05:55:11Z

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

nodejs-github-bot · 2023-07-26T10:10:37Z

Landed in 6cd6789

Refs: nodejs/single-executable#73 Signed-off-by: Darshan Sen <[email protected]> PR-URL: nodejs#48191 Fixes: nodejs/single-executable#73 Reviewed-By: Yagiz Nizipli <[email protected]> Reviewed-By: Stephen Belanger <[email protected]> Reviewed-By: Joyee Cheung <[email protected]>

Refs: nodejs/single-executable#73 Signed-off-by: Darshan Sen <[email protected]> PR-URL: #48191 Fixes: nodejs/single-executable#73 Reviewed-By: Yagiz Nizipli <[email protected]> Reviewed-By: Stephen Belanger <[email protected]> Reviewed-By: Joyee Cheung <[email protected]>

nodejs/node#48191

nodejs-github-bot added c++ Issues and PRs that require attention from people who are familiar with C++. lib / src Issues and PRs related to general changes in the lib or src directory. needs-ci PRs that need a full CI run. labels May 26, 2023

RaisinTen mentioned this pull request May 26, 2023

bytecode-only SEA caching? nodejs/single-executable#73

Closed

anonrig reviewed May 26, 2023

View reviewed changes

src/node_sea.cc Outdated Show resolved Hide resolved

src/node_contextify.cc Outdated Show resolved Hide resolved

src/node_sea.cc Outdated Show resolved Hide resolved

RaisinTen added a commit to RaisinTen/node that referenced this pull request May 27, 2023

src: use std::nullopt instead of {}

d8593ca

It expresses the intent in a clearer way. Refs: nodejs#48191 (comment) Signed-off-by: Darshan Sen <[email protected]>

RaisinTen added a commit to RaisinTen/node that referenced this pull request May 27, 2023

src: pass parameters vector by a pointer

05199d8

Refs: nodejs#48191 (comment) Signed-off-by: Darshan Sen <[email protected]>

RaisinTen added the commit-queue-squash Add this label to instruct the Commit Queue to squash all the PR commits into the first one. label May 27, 2023

anonrig approved these changes May 27, 2023

View reviewed changes

joyeecheung reviewed May 28, 2023

View reviewed changes

lib/internal/util/embedding.js Show resolved Hide resolved

RaisinTen added a commit to RaisinTen/node that referenced this pull request May 29, 2023

sea: fix entry point file name

397f384

Refs: nodejs#48191 (comment) Signed-off-by: Darshan Sen <[email protected]>

jasnell reviewed May 29, 2023

View reviewed changes

src/node_contextify.cc Outdated Show resolved Hide resolved

joyeecheung reviewed May 31, 2023

View reviewed changes

src/node_sea.cc Outdated Show resolved Hide resolved

Qard approved these changes May 31, 2023

View reviewed changes

RaisinTen added a commit to RaisinTen/node that referenced this pull request Jun 1, 2023

src: use DataView instead of Buffer for code cache

5dfdbd1

Refs: nodejs#48191 (comment) Signed-off-by: Darshan Sen <[email protected]>

joyeecheung reviewed Jun 1, 2023

View reviewed changes

src/node_sea.cc Outdated Show resolved Hide resolved

lib/internal/modules/cjs/loader.js Outdated Show resolved Hide resolved

RaisinTen added a commit to RaisinTen/node that referenced this pull request Jun 2, 2023

sea: warn if code cache is rejected

1610dd6

Refs: nodejs#48191 (comment) Signed-off-by: Darshan Sen <[email protected]>

RaisinTen added the single-executable Issues and PRs related to single-executable applications label Jun 2, 2023

RaisinTen commented Jun 2, 2023

View reviewed changes

src/node_sea.cc Show resolved Hide resolved

aymen94 approved these changes Jun 6, 2023

View reviewed changes

RaisinTen added a commit to RaisinTen/node that referenced this pull request Jun 8, 2023

src: add TODO for supporting import()

7a19ac1

Refs: nodejs#48191 (comment) Signed-off-by: Darshan Sen <[email protected]>

kvakil reviewed Jun 9, 2023

View reviewed changes

src/node_contextify.cc Outdated Show resolved Hide resolved

src/node_contextify.cc Outdated Show resolved Hide resolved

src/node_sea.cc Outdated Show resolved Hide resolved

RaisinTen mentioned this pull request Jun 27, 2023

deps: V8: cherry-pick cb00db4dba6c #48576

Closed

RaisinTen added a commit to RaisinTen/node that referenced this pull request Jun 27, 2023

src: use std::nullopt instead of {}

ee798d6

It expresses the intent in a clearer way. Refs: nodejs#48191 (comment) Signed-off-by: Darshan Sen <[email protected]>

RaisinTen added a commit to RaisinTen/node that referenced this pull request Jun 27, 2023

src: pass parameters vector by a pointer

dc8bca5

Refs: nodejs#48191 (comment) Signed-off-by: Darshan Sen <[email protected]>

RaisinTen added a commit to RaisinTen/node that referenced this pull request Jun 27, 2023

sea: fix entry point file name

f5eec14

Refs: nodejs#48191 (comment) Signed-off-by: Darshan Sen <[email protected]>

RaisinTen added 3 commits July 21, 2023 12:40

src: guard against calling sea.getCodePath() in userland

80cd1ff

Refs: https://github.com/nodejs/node/pull/48191/files/300f3f4a03d7f418fb565a479f19b67c22d80a07#r1269593383 Signed-off-by: Darshan Sen <[email protected]>

src: remove unnecessary HandleScope

d44aa0d

Refs: https://github.com/nodejs/node/pull/48191/files/300f3f4a03d7f418fb565a479f19b67c22d80a07#r1269601154 Signed-off-by: Darshan Sen <[email protected]>

test: fix test/parallel/test-node-output-errors.mjs error

91bf2df

Signed-off-by: Darshan Sen <[email protected]>

RaisinTen force-pushed the sea-V8-code-cache branch from 300f3f4 to 91bf2df Compare July 21, 2023 07:28

joyeecheung approved these changes Jul 25, 2023

View reviewed changes

This comment was marked as outdated.

Sign in to view

github-actions bot mentioned this pull request Jul 26, 2023

CI Reliability 2023-07-26 nodejs/reliability#624

Open

14 tasks

RaisinTen added author ready PRs that have at least one approval, no pending requests for changes, and a CI started. commit-queue Add this label to land a pull request using GitHub Actions. labels Jul 26, 2023

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

nodejs-github-bot merged commit 6cd6789 into nodejs:main Jul 26, 2023

RaisinTen deleted the sea-V8-code-cache branch July 26, 2023 10:25

github-actions bot mentioned this pull request Jul 27, 2023

CI Reliability 2023-07-27 nodejs/reliability#625

Open

18 tasks

This was referenced Jul 28, 2023

CI Reliability 2023-07-28 nodejs/reliability#626

Open

CI Reliability 2023-07-29 nodejs/reliability#627

Open

CI Reliability 2023-07-30 nodejs/reliability#628

Open

CI Reliability 2023-07-31 nodejs/reliability#629

Open

UlisesGascon mentioned this pull request Aug 15, 2023

v20.6.0 proposal #49185

Merged

codebytere added a commit to electron/electron that referenced this pull request Nov 6, 2023

sea: add support for V8 bytecode-only caching

43c93e2

nodejs/node#48191

Uh oh!

Conversation

RaisinTen commented May 26, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

nodejs-github-bot commented May 26, 2023

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

joyeecheung left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

RaisinTen commented Jun 2, 2023

Uh oh!

Uh oh!

kvakil left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

joyeecheung commented Jun 10, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

RaisinTen commented Jul 21, 2023

Uh oh!

joyeecheung left a comment

Choose a reason for hiding this comment

Uh oh!

This comment was marked as outdated.

nodejs-github-bot commented Jul 26, 2023

Uh oh!

nodejs-github-bot commented Jul 26, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

8 participants

RaisinTen commented May 26, 2023 •

edited

Loading

kvakil left a comment •

edited

Loading

joyeecheung commented Jun 10, 2023 •

edited

Loading