NotificationsYou must be signed in to change notification settings
Fork32.2k
Star112k

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Jump to bottom

Closed

joyeecheung wants to merge15 commits intonodejs:mainfromjoyeecheung:lazyload2

Closed

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

joyeecheung wants to merge15 commits intonodejs:mainfromjoyeecheung:lazyload2

Conversation

Copy link

Member

joyeecheung commentedDec 14, 2022

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.

joyeecheung added9 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 themunder modules/ directly.

lib: add getLazy() method to internal/util

9c65244

This patch adds a getLazy() method to facilitate initialize-oncelazy 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

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

ae5d36c

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 callbacksThese are self-contained code that can be included into thebuilt-in snapshot.

bootstrap: make CJS loader snapshotable

203164b

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

bootstrap: optimize modules loaded in the built-in snapshot

f3b3652

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 intest-bootstrap-module.js for the main thread)are loaded from the snapshot so no additional compilation costis incurred.

Copy link

Collaborator

nodejs-github-bot commentedDec 14, 2022

Review requested:

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

nodejs-github-bot added lib / src

Issues and PRs related to general changes in the lib or src directory.

needs-ciPRs that need a full CI run. labels

Dec 14, 2022

Copy link

Collaborator

nodejs-github-bot commentedDec 14, 2022

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

Copy link

Member

GeoffreyBooth commentedDec 14, 2022

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

Copy link

MemberAuthor

joyeecheung commentedDec 14, 2022

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

Copy link

Member

GeoffreyBooth commentedDec 14, 2022

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.

Copy link

MemberAuthor

joyeecheung commentedDec 14, 2022

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 approved these changes

Dec 14, 2022

View reviewed changes

Copy link

Member

GeoffreyBooth left a comment•
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

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

lib/internal/modules/esm/utils.js OutdatedShow resolvedHide resolved

lib/internal/util.js OutdatedShow resolvedHide resolved

test/sequential/test-inspector-break-when-eval.js OutdatedShow resolvedHide resolved

aduh95 reviewed

Dec 14, 2022

View reviewed changes

lib/internal/modules/cjs/loader.js OutdatedShow resolvedHide resolved

lib/internal/modules/esm/utils.jsShow resolvedHide resolved

lib/internal/modules/helpers.jsShow resolvedHide resolved

ljharb reviewed

Dec 14, 2022

View reviewed changes

lib/internal/modules/cjs/loader.jsShow resolvedHide resolved

joyeecheung added3 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-14nodejs/TSC#1319

Closed

joyeecheung added2 commits

December 14, 2022 17:41

fixup! bootstrap: make CJS loader snapshotable

e8a4b5e

fixup! bootstrap: make CJS loader snapshotable

faa6501

Copy link

Collaborator

nodejs-github-bot commentedDec 14, 2022

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

github-actionsbot mentioned this pull request

Dec 15, 2022

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

Open

9 tasks

legendecas reviewed

Dec 15, 2022

View reviewed changes

lib/internal/process/pre_execution.js OutdatedShow resolvedHide 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

jkleinsc pushed a commit to electron/electron that referenced this pull request

Nov 30, 2023

chore: upgrade to Node.js v20 (#40545)

9c94fd7

* chore: upgrade to Node.js v20* src: allow embedders to override NODE_MODULE_VERSIONnodejs/node#49279* src: fix missing trailing ,nodejs/node#46909* src,tools: initialize cppgcnodejs/node#45704* tools: allow passing absolute path of config.gypi in js2cnodejs/node#49162* tools: port js2c.py to C++nodejs/node#46997* doc,lib: disambiguate the old term, NativeModulenodejs/node#45673* chore: fixup Node.js BSSL tests*nodejs/node#49492*nodejs/node#44498* deps: upgrade to libuv 1.45.0nodejs/node#48078* deps: update V8 to 10.7nodejs/node#44741* test: use gcUntil() in test-v8-serialize-leaknodejs/node#49168* module: make CJS load from ESM loadernodejs/node#47999* src: make BuiltinLoader threadsafe and non-globalnodejs/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 snapshotnodejs/node#45849* test: mark test-runner-output as flakynodejs/node#49854* lib: lazy-load deps in modules/run_main.jsnodejs/node#45849* url: use private properties for brand checknodejs/node#46904* test: refactor `test-node-output-errors`nodejs/node#48992* assert: deprecate callTrackernodejs/node#47740* src: cast v8::Object::GetInternalField() return value to v8::Valuenodejs/node#48943* test: adapt test-v8-stats for V8 updatenodejs/node#45230* tls: ensure TLS Sockets are closed if the underlying wrapclosesnodejs/node#49327* test: deflake test-tls-socket-closenodejs/node#49575* net: fix crash due to simultaneous close/shutdown on JS Stream Socketsnodejs/node#49400* net: use asserts in JS Socket Stream to catch races in futurenodejs/node#49400* lib: fix BroadcastChannel initialization locationnodejs/node#46864* src: create BaseObject with node::Realmnodejs/node#44348* src: implement DataQueue and non-memory resident Blobnodejs/node#45258* sea: add support for V8 bytecode-only cachingnodejs/node#48191* chore: fixup patch indices* gyp: put filenames in variablesnodejs/node#46965* build: modify js2c.py into GN executable* fix: (WIP) handle string replacement of fs -> original-fs* [v20.x] backport vm-related memoryfixesnodejs/node#49874* src: make BuiltinLoader threadsafe and non-globalnodejs/node#45942* src: avoid copying string in fs_permissionnodejs/node#47746* look upon my works ye mightyand dispair* chore: patch cleanup* [api] Remove AllCan Read/Writehttps://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 modificationsMoves 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 variablesnodejs/node#46965* test: disable single executable tests* fix: nan tests failing on node headers missing file* tls,http2: send fatal alert on ALPN mismatchnodejs/node#44031* test: disable snapshot tests*nodejs/node#47887*nodejs/node#49684*nodejs/node#44193* build: use deps/v8 for v8/toolsNode.js hard depends on these in their builtins* test: fix edge snapshot stack tracesnodejs/node#49659* build: remove js2c //base dep* build: use electron_js2c_toolchain to build node_js2c* fix: don't create SafeSet outside packageResolveFixes failure in parallel/test-require-delete-array-iterator:=== release test-require-delete-array-iterator ===Path: parallel/test-require-delete-array-iteratornode: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 LinuxThese were failing because our change from node::InitializeNodeWithArgs tonode::InitializeOncePerProcess meant that we now inadvertently calledPlatformInit, which reset signal handling. This meant that our intentionalcrash function ElectronBindings::Crash no longer worked and the renderer processno 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 passingkNoDefaultSignalHandling 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 APIsnodejs/node#50709* fix: use thread_local BuiltinLoader* chore: fixup v8 patch indices---------Co-authored-by: Keeley Hammond <vertedinde@electronjs.org>Co-authored-by: Samuel Attard <marshallofsound@electronjs.org>

MrHuangJser pushed a commit to MrHuangJser/electron that referenced this pull request

Dec 11, 2023

chore: upgrade to Node.js v20 (electron#40545)

34651d1

* chore: upgrade to Node.js v20* src: allow embedders to override NODE_MODULE_VERSIONnodejs/node#49279* src: fix missing trailing ,nodejs/node#46909* src,tools: initialize cppgcnodejs/node#45704* tools: allow passing absolute path of config.gypi in js2cnodejs/node#49162* tools: port js2c.py to C++nodejs/node#46997* doc,lib: disambiguate the old term, NativeModulenodejs/node#45673* chore: fixup Node.js BSSL tests*nodejs/node#49492*nodejs/node#44498* deps: upgrade to libuv 1.45.0nodejs/node#48078* deps: update V8 to 10.7nodejs/node#44741* test: use gcUntil() in test-v8-serialize-leaknodejs/node#49168* module: make CJS load from ESM loadernodejs/node#47999* src: make BuiltinLoader threadsafe and non-globalnodejs/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 snapshotnodejs/node#45849* test: mark test-runner-output as flakynodejs/node#49854* lib: lazy-load deps in modules/run_main.jsnodejs/node#45849* url: use private properties for brand checknodejs/node#46904* test: refactor `test-node-output-errors`nodejs/node#48992* assert: deprecate callTrackernodejs/node#47740* src: cast v8::Object::GetInternalField() return value to v8::Valuenodejs/node#48943* test: adapt test-v8-stats for V8 updatenodejs/node#45230* tls: ensure TLS Sockets are closed if the underlying wrapclosesnodejs/node#49327* test: deflake test-tls-socket-closenodejs/node#49575* net: fix crash due to simultaneous close/shutdown on JS Stream Socketsnodejs/node#49400* net: use asserts in JS Socket Stream to catch races in futurenodejs/node#49400* lib: fix BroadcastChannel initialization locationnodejs/node#46864* src: create BaseObject with node::Realmnodejs/node#44348* src: implement DataQueue and non-memory resident Blobnodejs/node#45258* sea: add support for V8 bytecode-only cachingnodejs/node#48191* chore: fixup patch indices* gyp: put filenames in variablesnodejs/node#46965* build: modify js2c.py into GN executable* fix: (WIP) handle string replacement of fs -> original-fs* [v20.x] backport vm-related memoryfixesnodejs/node#49874* src: make BuiltinLoader threadsafe and non-globalnodejs/node#45942* src: avoid copying string in fs_permissionnodejs/node#47746* look upon my works ye mightyand dispair* chore: patch cleanup* [api] Remove AllCan Read/Writehttps://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 modificationsMoves 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 variablesnodejs/node#46965* test: disable single executable tests* fix: nan tests failing on node headers missing file* tls,http2: send fatal alert on ALPN mismatchnodejs/node#44031* test: disable snapshot tests*nodejs/node#47887*nodejs/node#49684*nodejs/node#44193* build: use deps/v8 for v8/toolsNode.js hard depends on these in their builtins* test: fix edge snapshot stack tracesnodejs/node#49659* build: remove js2c //base dep* build: use electron_js2c_toolchain to build node_js2c* fix: don't create SafeSet outside packageResolveFixes failure in parallel/test-require-delete-array-iterator:=== release test-require-delete-array-iterator ===Path: parallel/test-require-delete-array-iteratornode: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 LinuxThese were failing because our change from node::InitializeNodeWithArgs tonode::InitializeOncePerProcess meant that we now inadvertently calledPlatformInit, which reset signal handling. This meant that our intentionalcrash function ElectronBindings::Crash no longer worked and the renderer processno 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 passingkNoDefaultSignalHandling 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 APIsnodejs/node#50709* fix: use thread_local BuiltinLoader* chore: fixup v8 patch indices---------Co-authored-by: Keeley Hammond <vertedinde@electronjs.org>Co-authored-by: Samuel Attard <marshallofsound@electronjs.org>