sea: add support for V8 bytecode-only caching #48191

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]>

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

* chore: upgrade to Node.js v20 * src: allow embedders to override NODE_MODULE_VERSION nodejs/node#49279 * src: fix missing trailing , nodejs/node#46909 * src,tools: initialize cppgc nodejs/node#45704 * tools: allow passing absolute path of config.gypi in js2c nodejs/node#49162 * tools: port js2c.py to C++ nodejs/node#46997 * doc,lib: disambiguate the old term, NativeModule nodejs/node#45673 * chore: fixup Node.js BSSL tests * nodejs/node#49492 * nodejs/node#44498 * deps: upgrade to libuv 1.45.0 nodejs/node#48078 * deps: update V8 to 10.7 nodejs/node#44741 * test: use gcUntil() in test-v8-serialize-leak nodejs/node#49168 * module: make CJS load from ESM loader nodejs/node#47999 * src: make BuiltinLoader threadsafe and non-global nodejs/node#45942 * chore: address changes to CJS/ESM loading * module: make CJS load from ESM loader (nodejs/node#47999) * lib: improve esm resolve performance (nodejs/node#46652) * bootstrap: optimize modules loaded in the built-in snapshot nodejs/node#45849 * test: mark test-runner-output as flaky nodejs/node#49854 * lib: lazy-load deps in modules/run_main.js nodejs/node#45849 * url: use private properties for brand check nodejs/node#46904 * test: refactor `test-node-output-errors` nodejs/node#48992 * assert: deprecate callTracker nodejs/node#47740 * src: cast v8::Object::GetInternalField() return value to v8::Value nodejs/node#48943 * test: adapt test-v8-stats for V8 update nodejs/node#45230 * tls: ensure TLS Sockets are closed if the underlying wrap closes nodejs/node#49327 * test: deflake test-tls-socket-close nodejs/node#49575 * net: fix crash due to simultaneous close/shutdown on JS Stream Sockets nodejs/node#49400 * net: use asserts in JS Socket Stream to catch races in future nodejs/node#49400 * lib: fix BroadcastChannel initialization location nodejs/node#46864 * src: create BaseObject with node::Realm nodejs/node#44348 * src: implement DataQueue and non-memory resident Blob nodejs/node#45258 * sea: add support for V8 bytecode-only caching nodejs/node#48191 * chore: fixup patch indices * gyp: put filenames in variables nodejs/node#46965 * build: modify js2c.py into GN executable * fix: (WIP) handle string replacement of fs -> original-fs * [v20.x] backport vm-related memory fixes nodejs/node#49874 * src: make BuiltinLoader threadsafe and non-global nodejs/node#45942 * src: avoid copying string in fs_permission nodejs/node#47746 * look upon my works ye mighty and dispair * chore: patch cleanup * [api] Remove AllCan Read/Write https://chromium-review.googlesource.com/c/v8/v8/+/5006387 * fix: missing include for NODE_EXTERN * chore: fixup patch indices * fix: fail properly when js2c fails in Node.js * build: fix js2c root_gen_dir * fix: lib/fs.js -> lib/original-fs.js * build: fix original-fs file xforms * fixup! module: make CJS load from ESM loader * build: get rid of CppHeap for now * build: add patch to prevent extra fs lookup on esm load * build: greatly simplify js2c modifications Moves our original-fs modifications back into a super simple python script action, wires up the output of that action into our call to js2c * chore: update to handle moved internal/modules/helpers file * test: update @types/node test * feat: enable preventing cppgc heap creation * feat: optionally prevent calling V8::EnableWebAssemblyTrapHandler * fix: no cppgc initialization in the renderer * gyp: put filenames in variables nodejs/node#46965 * test: disable single executable tests * fix: nan tests failing on node headers missing file * tls,http2: send fatal alert on ALPN mismatch nodejs/node#44031 * test: disable snapshot tests * nodejs/node#47887 * nodejs/node#49684 * nodejs/node#44193 * build: use deps/v8 for v8/tools Node.js hard depends on these in their builtins * test: fix edge snapshot stack traces nodejs/node#49659 * build: remove js2c //base dep * build: use electron_js2c_toolchain to build node_js2c * fix: don't create SafeSet outside packageResolve Fixes failure in parallel/test-require-delete-array-iterator: === release test-require-delete-array-iterator === Path: parallel/test-require-delete-array-iterator node:internal/per_context/primordials:426 constructor(i) { super(i); } // eslint-disable-line no-useless-constructor ^ TypeError: object is not iterable (cannot read property Symbol(Symbol.iterator)) at new Set (<anonymous>) at new SafeSet (node:internal/per_context/primordials:426:22) * fix: failing crashReporter tests on Linux These were failing because our change from node::InitializeNodeWithArgs to node::InitializeOncePerProcess meant that we now inadvertently called PlatformInit, which reset signal handling. This meant that our intentional crash function ElectronBindings::Crash no longer worked and the renderer process no longer crashed when process.crash() was called. We don't want to use Node.js' default signal handling in the renderer process, so we disable it by passing kNoDefaultSignalHandling to node::InitializeOncePerProcess. * build: only create cppgc heap on non-32 bit platforms * chore: clean up util:CompileAndCall * src: fix compatility with upcoming V8 12.1 APIs nodejs/node#50709 * fix: use thread_local BuiltinLoader * chore: fixup v8 patch indices --------- Co-authored-by: Keeley Hammond <[email protected]> Co-authored-by: Samuel Attard <[email protected]>

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 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

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

sea: add support for V8 bytecode-only caching

1ab0ee1

nodejs/node#48191

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

sea: add support for V8 bytecode-only caching

9f46ae1

nodejs/node#48191

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

sea: add support for V8 bytecode-only caching

b6bf9e0

nodejs/node#48191

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

sea: add support for V8 bytecode-only caching

fb11aa8

nodejs/node#48191

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

sea: add support for V8 bytecode-only caching

2d49778

nodejs/node#48191

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

sea: add support for V8 bytecode-only caching

b68cd28

nodejs/node#48191

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

sea: add support for V8 bytecode-only caching

828846c

nodejs/node#48191

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

sea: add support for V8 bytecode-only caching #48191

sea: add support for V8 bytecode-only caching #48191

RaisinTen commented May 26, 2023 •

edited

Loading

nodejs-github-bot commented May 26, 2023

joyeecheung left a comment

RaisinTen commented Jun 2, 2023

kvakil left a comment •

edited

Loading

joyeecheung commented Jun 10, 2023 •

edited

Loading

nodejs-github-bot commented Jul 26, 2023

sea: add support for V8 bytecode-only caching #48191

sea: add support for V8 bytecode-only caching #48191

Conversation

RaisinTen commented May 26, 2023 • edited Loading

nodejs-github-bot commented May 26, 2023

joyeecheung left a comment

Choose a reason for hiding this comment

RaisinTen commented Jun 2, 2023

kvakil left a comment • edited Loading

Choose a reason for hiding this comment

joyeecheung commented Jun 10, 2023 • edited Loading

nodejs-github-bot commented Jul 26, 2023

RaisinTen commented May 26, 2023 •

edited

Loading

kvakil left a comment •

edited

Loading

joyeecheung commented Jun 10, 2023 •

edited

Loading