Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/nodejs/node.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
path: root/doc/api
diff options
context:
space:
mode:
authorGabriel Schulhof <gabriel.schulhof@intel.com>2019-12-13 22:59:37 +0300
committerRuben Bridgewater <ruben@bridgewater.de>2020-01-03 18:12:10 +0300
commit49a7e73898d5a90e861f1ed96cc91f7dd3e750d5 (patch)
treea9b6297ebd00a544c2ea36eb42b12d1c299daa7a /doc/api
parenta83d33810258772fde859d485698229dafaea6ed (diff)
src: make --use-largepages a runtime option
Moves the option that instructs Node.js to-remap its static code to large pages from a configure-time option to a runtime option. This should make it easy to assess the performance impact of such a change without having to custom-build. PR-URL: https://github.com/nodejs/node/pull/30954 Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl> Reviewed-By: David Carlier <devnexen@gmail.com> Reviewed-By: David Carlier <devnexen@gmail.com> Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com> Reviewed-By: Denys Otrishko <shishugi@gmail.com> Co-authored-by: David Carlier <devnexen@gmail.com>
Diffstat (limited to 'doc/api')
-rw-r--r--doc/api/cli.md17
1 files changed, 17 insertions, 0 deletions
diff --git a/doc/api/cli.md b/doc/api/cli.md
index f3d5df070cc..d098a199e05 100644
--- a/doc/api/cli.md
+++ b/doc/api/cli.md
@@ -876,6 +876,22 @@ environment variables.
See `SSL_CERT_DIR` and `SSL_CERT_FILE`.
+### `--use-largepages=mode`
+<!-- YAML
+added: REPLACEME
+-->
+
+Re-map the Node.js static code to large memory pages at startup. If supported on
+the target system, this will cause the Node.js static code to be moved onto 2
+MiB pages instead of 4 KiB pages.
+
+The following values are valid for `mode`:
+* `off`: No mapping will be attempted. This is the default.
+* `on`: If supported by the OS, mapping will be attempted. Failure to map will
+ be ignored and a message will be printed to standard error.
+* `silent`: If supported by the OS, mapping will be attempted. Failure to map
+ will be ignored and will not be reported.
+
### `--v8-options`
<!-- YAML
added: v0.1.3
@@ -1133,6 +1149,7 @@ Node.js options that are allowed are:
* `--track-heap-objects`
* `--unhandled-rejections`
* `--use-bundled-ca`
+* `--use-largepages`
* `--use-openssl-ca`
* `--v8-pool-size`
* `--zero-fill-buffers`