bootstrap: optimize modules loaded in the built-in snapshot #45849

joyeecheung · 2022-12-14T00:57:07Z

To make the patch easier to review I have split it into smaller commits, though it's probably also okay to review the entire diff since most of the changes are superficial.

Locally I got:

                                                                                     confidence improvement accuracy (*)   (**)  (***)
misc/startup.js count=30 mode='process' script='benchmark/fixtures/require-builtins'        ***      4.14 %       ±0.59% ±0.79% ±1.03%
misc/startup.js count=30 mode='process' script='test/fixtures/semicolon'                    ***     11.11 %       ±0.75% ±1.00% ±1.30%
misc/startup.js count=30 mode='worker' script='benchmark/fixtures/require-builtins'         ***      3.67 %       ±0.73% ±0.97% ±1.27%
misc/startup.js count=30 mode='worker' script='test/fixtures/semicolon'                     ***     10.93 %       ±0.90% ±1.20% ±1.56%

bootstrap: support module_wrap binding in snapshot

bootstrap: include event_target into the built-in snapshot

Since the module has to be loaded during bootstrap anyway.

modules: move modules/cjs/helpers.js to modules/helpers.js

The helpers are actually shared by the two loaders, so move them
under modules/ directly.

lib: add getLazy() method to internal/util

This patch adds a getLazy() method to facilitate initialize-once
lazy loading in the internals.

lib: lazy-load deps in source_map_cache.js

So that the file can be snapshotted.

lib: lazy-load deps in modules/run_main.js

So that the file can be snapshotted

modules: move callbacks and conditions into modules/esm/utils.js

This moves the following utils into modules/esm/utils.js:

Code related to default conditions
The callbackMap (which is now created in the module instead of
hanging off the module_wrap binding, since the C++ land
does not need it).
Per-isolate module callbacks

These are self-contained code that can be included into the
built-in snapshot.

bootstrap: make CJS loader snapshotable

This patch makes the top-level access to runtime states in the
CJS loader lazy, and move the side-effects into a
initializeCJS() function that gets called during pre-execution.
As a result the CJS loader can be included into the built-in
snapshot.

bootstrap: optimize modules loaded in the built-in snapshot

Preload essential modules and lazy-load non-essential ones.
After this patch, all modules listed by running this snippet:

const list = process.moduleLoadList.join('\n');
require('fs').writeSync(1, list, 'utf-8');

(which is roughly the same list as the one in
test-bootstrap-module.js for the main thread)
are loaded from the snapshot so no additional compilation cost
is incurred.

Since the module has to be loaded during bootstrap anyway.

The helpers are actually shared by the two loaders, so move them under modules/ directly.

This patch adds a getLazy() method to facilitate initialize-once lazy loading in the internals.

So that the file can be snapshotted.

So that the file can be snapshotted

This moves the following utils into modules/esm/utils.js: - Code related to default conditions - The callbackMap (which is now created in the module instead of hanging off the module_wrap binding, since the C++ land does not need it). - Per-isolate module callbacks These are self-contained code that can be included into the built-in snapshot.

This patch makes the top-level access to runtime states in the CJS loader lazy, and move the side-effects into a initializeCJS() function that gets called during pre-execution. As a result the CJS loader can be included into the built-in snapshot.

Preload essential modules and lazy-load non-essential ones. After this patch, all modules listed by running this snippet: ``` const list = process.moduleLoadList.join('\n'); require('fs').writeSync(1, list, 'utf-8'); ``` (which is roughly the same list as the one in test-bootstrap-module.js for the main thread) are loaded from the snapshot so no additional compilation cost is incurred.

nodejs-github-bot · 2022-12-14T00:57:11Z

Review requested:

@nodejs/modules
@nodejs/startup
@nodejs/vm

nodejs-github-bot · 2022-12-14T00:58:05Z

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

GeoffreyBooth · 2022-12-14T01:22:15Z

What’s the relationship between this PR and #45828? Is this just the first of the several commits you mentioned?

joyeecheung · 2022-12-14T01:24:22Z

@GeoffreyBooth This is a trimmed down version of #45828 that does not attempt to snapshot the ESM loader (except some really small bits)

GeoffreyBooth · 2022-12-14T01:28:49Z

Okay, well even still this seems like a significant improvement. The benchmarks you posted here are almost as good as in #45828, so it seems like you’ve achieved the bulk of the performance boost already in this PR alone.

joyeecheung · 2022-12-14T02:13:18Z

From the CI: https://ci.nodejs.org/view/Node.js%20benchmark/job/benchmark-node-micro-benchmarks/1264/

02:34:00                                                                                      confidence improvement accuracy (*)   (**)  (***)
02:34:01 misc/startup.js count=30 mode='process' script='benchmark/fixtures/require-builtins'        ***      3.32 %       ±0.84% ±1.11% ±1.45%
02:34:01 misc/startup.js count=30 mode='process' script='test/fixtures/semicolon'                    ***     10.02 %       ±1.17% ±1.57% ±2.04%
02:34:01 misc/startup.js count=30 mode='worker' script='benchmark/fixtures/require-builtins'         ***      5.03 %       ±0.90% ±1.20% ±1.56%
02:34:01 misc/startup.js count=30 mode='worker' script='test/fixtures/semicolon'                     ***     11.24 %       ±1.27% ±1.69% ±2.21%

GeoffreyBooth

Thanks for doing this. I can’t speak for the bootstrap parts but the module refactors look great!

lib/internal/modules/esm/utils.js

lib/internal/util.js

test/sequential/test-inspector-break-when-eval.js

lib/internal/modules/cjs/loader.js

lib/internal/modules/esm/utils.js

lib/internal/modules/helpers.js

lib/internal/modules/cjs/loader.js

nodejs-github-bot · 2022-12-14T16:44:21Z

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

lib/internal/process/pre_execution.js

nodejs/node#45849

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

PR-URL: nodejs/node#45849 Backport-PR-URL: nodejs/node#46425 Reviewed-By: Geoffrey Booth <[email protected]> Reviewed-By: Chengzhong Wu <[email protected]>

Since the module has to be loaded during bootstrap anyway. PR-URL: nodejs/node#45849 Backport-PR-URL: nodejs/node#46425 Reviewed-By: Geoffrey Booth <[email protected]> Reviewed-By: Chengzhong Wu <[email protected]>

The helpers are actually shared by the two loaders, so move them under modules/ directly. PR-URL: nodejs/node#45849 Backport-PR-URL: nodejs/node#46425 Reviewed-By: Geoffrey Booth <[email protected]> Reviewed-By: Chengzhong Wu <[email protected]>

This patch adds a getLazy() method to facilitate initialize-once lazy loading in the internals. PR-URL: nodejs/node#45849 Backport-PR-URL: nodejs/node#46425 Reviewed-By: Geoffrey Booth <[email protected]> Reviewed-By: Chengzhong Wu <[email protected]>

So that the file can be snapshotted. PR-URL: nodejs/node#45849 Backport-PR-URL: nodejs/node#46425 Reviewed-By: Geoffrey Booth <[email protected]> Reviewed-By: Chengzhong Wu <[email protected]>

So that the file can be snapshotted PR-URL: nodejs/node#45849 Backport-PR-URL: nodejs/node#46425 Reviewed-By: Geoffrey Booth <[email protected]> Reviewed-By: Chengzhong Wu <[email protected]>

This moves the following utils into modules/esm/utils.js: - Code related to default conditions - The callbackMap (which is now created in the module instead of hanging off the module_wrap binding, since the C++ land does not need it). - Per-isolate module callbacks These are self-contained code that can be included into the built-in snapshot. PR-URL: nodejs/node#45849 Backport-PR-URL: nodejs/node#46425 Reviewed-By: Geoffrey Booth <[email protected]> Reviewed-By: Chengzhong Wu <[email protected]>

This patch makes the top-level access to runtime states in the CJS loader lazy, and move the side-effects into a initializeCJS() function that gets called during pre-execution. As a result the CJS loader can be included into the built-in snapshot. PR-URL: nodejs/node#45849 Backport-PR-URL: nodejs/node#46425 Reviewed-By: Geoffrey Booth <[email protected]> Reviewed-By: Chengzhong Wu <[email protected]>

Preload essential modules and lazy-load non-essential ones. After this patch, all modules listed by running this snippet: ``` const list = process.moduleLoadList.join('\n'); require('fs').writeSync(1, list, 'utf-8'); ``` (which is roughly the same list as the one in test-bootstrap-module.js for the main thread) are loaded from the snapshot so no additional compilation cost is incurred. PR-URL: nodejs/node#45849 Backport-PR-URL: nodejs/node#46425 Reviewed-By: Geoffrey Booth <[email protected]> Reviewed-By: Chengzhong Wu <[email protected]>

PR-URL: nodejs/node#45849 Backport-PR-URL: nodejs/node#46425 Reviewed-By: Geoffrey Booth <[email protected]> Reviewed-By: Chengzhong Wu <[email protected]>

Since the module has to be loaded during bootstrap anyway. PR-URL: nodejs/node#45849 Backport-PR-URL: nodejs/node#46425 Reviewed-By: Geoffrey Booth <[email protected]> Reviewed-By: Chengzhong Wu <[email protected]>

The helpers are actually shared by the two loaders, so move them under modules/ directly. PR-URL: nodejs/node#45849 Backport-PR-URL: nodejs/node#46425 Reviewed-By: Geoffrey Booth <[email protected]> Reviewed-By: Chengzhong Wu <[email protected]>

This patch adds a getLazy() method to facilitate initialize-once lazy loading in the internals. PR-URL: nodejs/node#45849 Backport-PR-URL: nodejs/node#46425 Reviewed-By: Geoffrey Booth <[email protected]> Reviewed-By: Chengzhong Wu <[email protected]>

So that the file can be snapshotted. PR-URL: nodejs/node#45849 Backport-PR-URL: nodejs/node#46425 Reviewed-By: Geoffrey Booth <[email protected]> Reviewed-By: Chengzhong Wu <[email protected]>

So that the file can be snapshotted PR-URL: nodejs/node#45849 Backport-PR-URL: nodejs/node#46425 Reviewed-By: Geoffrey Booth <[email protected]> Reviewed-By: Chengzhong Wu <[email protected]>

This moves the following utils into modules/esm/utils.js: - Code related to default conditions - The callbackMap (which is now created in the module instead of hanging off the module_wrap binding, since the C++ land does not need it). - Per-isolate module callbacks These are self-contained code that can be included into the built-in snapshot. PR-URL: nodejs/node#45849 Backport-PR-URL: nodejs/node#46425 Reviewed-By: Geoffrey Booth <[email protected]> Reviewed-By: Chengzhong Wu <[email protected]>

This patch makes the top-level access to runtime states in the CJS loader lazy, and move the side-effects into a initializeCJS() function that gets called during pre-execution. As a result the CJS loader can be included into the built-in snapshot. PR-URL: nodejs/node#45849 Backport-PR-URL: nodejs/node#46425 Reviewed-By: Geoffrey Booth <[email protected]> Reviewed-By: Chengzhong Wu <[email protected]>

Preload essential modules and lazy-load non-essential ones. After this patch, all modules listed by running this snippet: ``` const list = process.moduleLoadList.join('\n'); require('fs').writeSync(1, list, 'utf-8'); ``` (which is roughly the same list as the one in test-bootstrap-module.js for the main thread) are loaded from the snapshot so no additional compilation cost is incurred. PR-URL: nodejs/node#45849 Backport-PR-URL: nodejs/node#46425 Reviewed-By: Geoffrey Booth <[email protected]> Reviewed-By: Chengzhong Wu <[email protected]>

joyeecheung added 9 commits December 13, 2022 21:59

bootstrap: support module_wrap binding in snapshot

b801b22

bootstrap: include event_target into the built-in snapshot

43db8f8

Since the module has to be loaded during bootstrap anyway.

modules: move modules/cjs/helpers.js to modules/helpers.js

b9509a1

The helpers are actually shared by the two loaders, so move them under modules/ directly.

lib: add getLazy() method to internal/util

9c65244

This patch adds a getLazy() method to facilitate initialize-once lazy loading in the internals.

lib: lazy-load deps in source_map_cache.js

30e18ee

So that the file can be snapshotted.

lib: lazy-load deps in modules/run_main.js

e263a61

So that the file can be snapshotted

nodejs-github-bot added 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 Dec 14, 2022

GeoffreyBooth approved these changes Dec 14, 2022

View reviewed changes

lib/internal/modules/esm/utils.js Outdated Show resolved Hide resolved

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

test/sequential/test-inspector-break-when-eval.js Outdated Show resolved Hide resolved

aduh95 reviewed Dec 14, 2022

View reviewed changes

ljharb reviewed Dec 14, 2022

View reviewed changes

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

joyeecheung added 3 commits December 14, 2022 16:47

fixup! lib: add getLazy() method to internal/util

8d57732

fixup! modules: move callbacks and conditions into modules/esm/utils.js

0c7011a

fixup! bootstrap: make CJS loader snapshotable

cf4681e

joyeecheung mentioned this pull request Dec 14, 2022

Node.js Technical Steering Committee (TSC) Meeting 2022-12-14 nodejs/TSC#1319

Closed

joyeecheung added 2 commits December 14, 2022 17:41

fixup! bootstrap: make CJS loader snapshotable

e8a4b5e

fixup! bootstrap: make CJS loader snapshotable

faa6501

github-actions bot mentioned this pull request Dec 15, 2022

CI Reliability 2022-12-15 nodejs/reliability#458

Open

9 tasks

legendecas reviewed Dec 15, 2022

View reviewed changes

lib/internal/process/pre_execution.js Outdated Show resolved Hide resolved

joyeecheung mentioned this pull request Dec 15, 2022

src,process: initial permission model implementation #44004

Merged

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

bootstrap: optimize modules loaded in the built-in snapshot

8239fde

nodejs/node#45849

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

lib: lazy-load deps in modules/run_main.js

cd9ff20

nodejs/node#45849

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

bootstrap: optimize modules loaded in the built-in snapshot

a3bf404

nodejs/node#45849

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

lib: lazy-load deps in modules/run_main.js

a243bfd

nodejs/node#45849

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

bootstrap: optimize modules loaded in the built-in snapshot

eb85c5c

nodejs/node#45849

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

lib: lazy-load deps in modules/run_main.js

c54d829

nodejs/node#45849

targos mentioned this pull request Nov 28, 2023

v18.19.0 release proposal #50953

Merged

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

bootstrap: optimize modules loaded in the built-in snapshot

4996772

nodejs/node#45849

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

lib: lazy-load deps in modules/run_main.js

0a99fce

nodejs/node#45849

joyeecheung mentioned this pull request Jul 9, 2024

lib: make navigator not runtime-lookup process.version, arch, or platform #53765

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

bootstrap: optimize modules loaded in the built-in snapshot #45849

bootstrap: optimize modules loaded in the built-in snapshot #45849

joyeecheung commented Dec 14, 2022

nodejs-github-bot commented Dec 14, 2022

nodejs-github-bot commented Dec 14, 2022

GeoffreyBooth commented Dec 14, 2022

joyeecheung commented Dec 14, 2022

GeoffreyBooth commented Dec 14, 2022

joyeecheung commented Dec 14, 2022

GeoffreyBooth left a comment •

edited

Loading

nodejs-github-bot commented Dec 14, 2022

bootstrap: optimize modules loaded in the built-in snapshot #45849

bootstrap: optimize modules loaded in the built-in snapshot #45849

Conversation

joyeecheung commented Dec 14, 2022

bootstrap: support module_wrap binding in snapshot

bootstrap: include event_target into the built-in snapshot

modules: move modules/cjs/helpers.js to modules/helpers.js

lib: add getLazy() method to internal/util

lib: lazy-load deps in source_map_cache.js

lib: lazy-load deps in modules/run_main.js

modules: move callbacks and conditions into modules/esm/utils.js

bootstrap: make CJS loader snapshotable

bootstrap: optimize modules loaded in the built-in snapshot

nodejs-github-bot commented Dec 14, 2022

nodejs-github-bot commented Dec 14, 2022

GeoffreyBooth commented Dec 14, 2022

joyeecheung commented Dec 14, 2022

GeoffreyBooth commented Dec 14, 2022

joyeecheung commented Dec 14, 2022

GeoffreyBooth left a comment • edited Loading

Choose a reason for hiding this comment

nodejs-github-bot commented Dec 14, 2022

GeoffreyBooth left a comment •

edited

Loading