8000 src: make --use-largepages a runtime option · nodejs/node@49a7e73 · GitHub
[go: up one dir, main page]
Skip to content
8000

Commit 49a7e73

Browse files
Gabriel Schulhofdevnexen
authored and
BridgeAR
committed
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: #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>
1 parent a83d338 commit 49a7e73

File tree

10 files changed

+101
-58
lines changed

10 files changed

+101
-58
lines changed

‎configure.py‎

Lines changed: 0 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -404,17 +404,6 @@
404404
dest='with_etw',
405405
help='build with ETW (default is true on Windows)')
406406

407-
parser.add_option('--use-largepages',
408-
action='store_true',
409-
dest='node_use_large_pages',
410-
help='build with Large Pages support. This feature is supported only on Linux kernel' +
411-
'>= 2.6.38 with Transparent Huge pages enabled and FreeBSD')
412-
413-
parser.add_option('--use-largepages-script-lld',
414-
action='store_true',
415-
dest='node_use_large_pages_script_lld',
416-
help='link against the LLVM ld linker script. Implies -fuse-ld=lld in the linker flags')
417-
418407
intl_optgroup.add_option('--with-intl',
419408
action='store',
420409
dest='with_intl',
@@ -1068,28 +1057,6 @@ def configure_node(o):
10681057
else:
10691058
o['variables']['node_use_dtrace'] = 'false'
10701059

1071-
if options.node_use_large_pages and not flavor in ('linux', 'freebsd', 'mac'):
1072-
raise Exception(
1073 8000 -
'Large pages are supported only on Linux, FreeBSD and MacOS Systems.')
1074-
if options.node_use_large_pages and flavor in ('linux', 'freebsd', 'mac'):
1075-
if options.shared or options.enable_static:
1076-
raise Exception(
1077-
'Large pages are supported only while creating node executable.')
1078-
if target_arch!="x64":
1079-
raise Exception(
1080-
'Large pages are supported only x64 platform.')
1081-
if flavor == 'mac':
1082-
info('macOS server with 32GB or more is recommended')
1083-
if flavor == 'linux':
1084-
# Example full version string: 2.6.32-696.28.1.el6.x86_64
1085-
FULL_KERNEL_VERSION=os.uname()[2]
1086-
KERNEL_VERSION=FULL_KERNEL_VERSION.split('-')[0]
1087-
if KERNEL_VERSION < "2.6.38" and flavor == 'linux':
1088-
raise Exception(
1089-
'Large pages need Linux kernel version >= 2.6.38')
1090-
o['variables']['node_use_large_pages'] = b(options.node_use_large_pages)
1091-
o['variables']['node_use_large_pages_script_lld'] = b(options.node_use_large_pages_script_lld)
1092-
10931060
if options.no_ifaddrs:
10941061
o['defines'] += ['SUNOS_NO_IFADDRS']
10951062

‎doc/api/cli.md‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -876,6 +876,22 @@ environment variables.
876876

877877
See `SSL_CERT_DIR` and `SSL_CERT_FILE`.
878878

879+
### `--use-largepages=mode`
880+
<!-- YAML
881+
added: REPLACEME
882+
-->
883+
884+
Re-map the Node.js static code to large memory pages at startup. If supported on
885+
the target system, this will cause the Node.js static code to be moved onto 2
886+
MiB pages instead of 4 KiB pages.
887+
888+
The following values are valid for `mode`:
889+
* `off`: No mapping will be attempted. This is the default.
890+
* `on`: If supported by the OS, mapping will be attempted. Failure to map will
891+
be ignored and a message will be printed to standard error.
892+
* `silent`: If supported by the OS, mapping will be attempted. Failure to map
893+
will be ignored and will not be reported.
894+
879895
### `--v8-options`
880896
<!-- YAML
881897
added: v0.1.3
@@ -1133,6 +1149,7 @@ Node.js options that are allowed are:
11331149
* `--track-heap-objects`
11341150
* `--unhandled-rejections`
11351151
* `--use-bundled-ca`
1152+
* `--use-largepages`
11361153
* `--use-openssl-ca`
11371154
* `--v8-pool-size`
11381155
* `--zero-fill-buffers`

‎doc/node.1‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -402,6 +402,16 @@ See
402402
and
403403
.Ev SSL_CERT_FILE .
404404
.
405+
.It Fl -use-largepages Ns = Ns Ar mode
406+
Re-map the Node.js static code to large memory pages at startup. If supported on
407+
the target system, this will cause the Node.js static code to be moved onto 2
408+
MiB pages instead of 4 KiB pages.
409+
.Pp
410+
.Ar mode
411+
must have one of the following values:
412+
`off` (the default value, meaning do not map), `on` (map and ignore failure,
413+
reporting it to stderr), or `silent` (map and silently ignore failure).
414+
.
405415
.It Fl -v8-options
406416
Print V8 command-line options.
407417
.

‎node.gyp‎

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -836,10 +836,9 @@
836836
}],
837837
],
838838
}],
839-
[ 'node_use_large_pages=="true" and OS in "linux freebsd mac"', {
839+
[ 'OS in "linux freebsd mac" and '
840+
'target_arch=="x64"', {
840841
'defines': [ 'NODE_ENABLE_LARGE_CODE_PAGES=1' ],
841-
# The current implementation of Large Pages is under Linux.
842-
# Other implementations are possible but not currently supported.
843842
'sources': [
844843
'src/large_pages/node_large_page.cc',
845844
'src/large_pages/node_large_page.h'

‎node.gypi‎

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -308,17 +308,15 @@
308308
}],
309309
[ 'OS=="linux" and '
310310
'target_arch=="x64" and '
311-
'node_use_large_pages=="true" and '
312-
'node_use_large_pages_script_lld=="false"', {
311+
'llvm_version=="0.0"', {
313312
'ldflags': [
314313
'-Wl,-T',
315314
'<!(realpath src/large_pages/ld.implicit.script)',
316315
]
317316
}],
318317
[ 'OS=="linux" and '
319318
'target_arch=="x64" and '
320-
'node_use_large_pages=="true" and '
321-
'node_use_large_pages_script_lld=="true"', {
319+
'llvm_version!="0.0"', {
322320
'ldflags': [
323321
'-Wl,-T',
324322
'<!(realpath src/large_pages/ld.implicit.script.lld)',

‎src/large_pages/node_large_page.cc‎

Lines changed: 11 additions & 8 deletions
< 67DE td data-grid-cell-id="diff-930e2e7e309763acbb831b1cc081a2a76c92e2a3d0be150a9e933bdc7a1747f0-355-352-2" data-line-anchor="diff-930e2e7e309763acbb831b1cc081a2a76c92e2a3d0be150a9e933bdc7a1747f0R352" data-selected="false" role="gridcell" style="background-color:var(--diffBlob-additionLine-bgColor, var(--diffBlob-addition-bgColor-line));padding-right:24px" tabindex="-1" valign="top" class="focusable-grid-cell diff-text-cell right-side-diff-cell left-side">+
ret = madvise(tmem, size, 14 /* MADV_HUGEPAGE */);
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@
6262
// Map a new area and copy the original code there
6363
// Use mmap using the start address with MAP_FIXED so we get exactly the
6464
// same virtual address
65-
// Use madvise with MADV_HUGE_PAGE to use Anonymous 2M Pages
65+
// Use madvise with MADV_HUGEPAGE to use Anonymous 2M Pages
6666
// If successful copy the code there and unmap the original region.
6767

6868
extern char __nodetext;
@@ -308,7 +308,7 @@ static bool IsSuperPagesEnabled() {
308308
// a. map a new area and copy the original code there
309309
// b. mmap using the start address with MAP_FIXED so we get exactly
310310
// the same virtual address (except on macOS).
311-
// c. madvise with MADV_HUGE_PAGE
311+
// c. madvise with MADV_HUGEPAGE
312312
// d. If successful copy the code there and unmap the original region
313313
int
314314
#if !defined(__APPLE__)
@@ -333,9 +333,6 @@ MoveTextRegionToLargePages(const text_region& r) {
333333
PrintSystemError(errno);
334334
return -1;
335335
}
336-
auto munmap_on_return = OnScopeLeave([nmem, size]() {
337-
if (-1 == munmap(nmem, size)) PrintSystemError(errno);
338-
});
339336

340337
memcpy(nmem, r.from, size);
341338

@@ -352,13 +349,14 @@ MoveTextRegionToLargePages(const text_region& r) {
352349
return -1;
353350
}
354351

355-
ret = madvise(tmem, size, MADV_HUGEPAGE);
352
356353
if (ret == -1) {
357354
PrintSystemError(errno);
358355
ret = munmap(tmem, size);
359356
if (ret == -1) {
360357
PrintSystemError(errno);
361358
}
359+
if (-1 == munmap(nmem, size)) PrintSystemError(errno);
362360
return -1;
363361
}
364362
memcpy(start, nmem, size);
@@ -369,6 +367,7 @@ MoveTextRegionToLargePages(const text_region& r) {
369367
MAP_ALIGNED_SUPER, -1 , 0);
370368
if (tmem == MAP_FAILED) {
371369
PrintSystemError(errno);
370+
if (-1 == munmap(nmem, size)) PrintSystemError(errno);
372371
return -1;
373372
}
374373
#elif defined(__APPLE__)
@@ -383,6 + 65CE 382,7 @@ MoveTextRegionToLargePages(const text_region& r) {
383382
VM_FLAGS_SUPERPAGE_SIZE_2MB, 0);
384383
if (tmem == MAP_FAILED) {
385384
PrintSystemError(errno);
385+
if (-1 == munmap(nmem, size)) PrintSystemError(errno);
386386
return -1;
387387
}
388388
memcpy(tmem, nmem, size);
@@ -393,6 +393,7 @@ MoveTextRegionToLargePages(const text_region& r) {
393393
if (ret == -1) {
394394
PrintSystemError(errno);
395395
}
396+
if (-1 == munmap(nmem, size)) PrintSystemError(errno);
396397
return -1;
397398
}
398399
memcpy(start, tmem, size);
@@ -405,8 +406,10 @@ MoveTextRegionToLargePages(const text_region& r) {
405406
if (ret == -1) {
406407
PrintSystemError(errno);
407408
}
409+
if (-1 == munmap(nmem, size)) PrintSystemError(errno);
408410
return -1;
409411
}
412+
if (-1 == munmap(nmem, size)) PrintSystemError(errno);
410413
return ret;
411414
}
412415

@@ -418,12 +421,12 @@ int MapStaticCodeToLargePages() {
418421
return -1;
419422
}
420423

421-
#if defined(__linux__)
424+
#if defined(__linux__) || defined(__FreeBSD__)
422425
if (r.from > reinterpret_cast<void*>(&MoveTextRegionToLargePages))
423426
return MoveTextRegionToLargePages(r);
424427

425428
return -1;
426-
#elif defined(__FreeBSD__) || defined(__APPLE__)
429+
#elif defined(__APPLE__)
427430
return MoveTextRegionToLargePages(r);
428431
#endif
429432
}

‎src/node.cc‎

Lines changed: 20 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -64,9 +64,7 @@
6464
#include "inspector/worker_inspector.h" // ParentInspectorHandle
6565
#endif
6666

67-
#ifdef NODE_ENABLE_LARGE_CODE_PAGES
6867
#include "large_pages/node_large_page.h"
69-
#endif
7068

7169
#ifdef NODE_REPORT
7270
#include "node_report.h"
@@ -1000,14 +998,6 @@ InitializationResult InitializeOncePerProcess(int argc, char** argv) {
1000998

1001999
CHECK_GT(argc, 0);
10021000

1003-
#ifdef NODE_ENABLE_LARGE_CODE_PAGES
1004-
if (node::IsLargePagesEnabled()) {
1005-
if (node::MapStaticCodeToLargePages() != 0) {
1006-
fprintf(stderr, "Reverting to default page size\n");
1007-
}
1008-
}
1009-
#endif
1010-
10111001
// Hack around with the argv pointer. Used for process.title = "blah".
10121002
argv = uv_setup_args(argc, argv);
10131003

@@ -1027,6 +1017,26 @@ InitializationResult InitializeOncePerProcess(int argc, char** argv) {
10271017
}
10281018
}
10291019

1020+
#if defined(NODE_ENABLE_LARGE_CODE_PAGES) && NODE_ENABLE_LARGE_CODE_PAGES
1021+
if (per_process::cli_options->use_largepages == "on" ||
1022+
per_process::cli_options->use_largepages == "silent") {
1023+
if (node::IsLargePagesEnabled()) {
1024+
if (node::MapStaticCodeToLargePages() != 0 &&
1025+
per_process::cli_options->use_largepages != "silent") {
1026+
fprintf(stderr,
1027+
"Mapping code to large pages failed. Reverting to default page "
1028+
"size.\n");
1029+
}
1030+
} else if (per_process::cli_options->use_largepages != "silent") {
1031+
fprintf(stderr, "Large pages are not enabled.\n");
1032+
}
1033+
}
1034+
#else
1035+
if (per_process::cli_options->use_largepages == "on") {
1036+
fprintf(stderr, "Mapping to large pages is not supported.\n");
1037+
}
1038+
#endif // NODE_ENABLE_LARGE_CODE_PAGES
1039+
10301040
if (per_process::cli_options->print_version) {
10311041
printf("%s\n", NODE_VERSION);
10321042
result.exit_code = 0;

‎src/node_options.cc‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -63,6 +63,11 @@ void PerProcessOptions::CheckOptions(std::vector<std::string>* errors) {
6363
"used, not both");
6464
}
6565
#endif
66+
if (use_largepages != "off" &&
67+
use_largepages != "on" &&
68+
use_largepages != "silent") {
69+
errors->push_back("invalid value for --use-largepages");
70+
}
6671
per_isolate->CheckOptions(errors);
6772
}
6873

@@ -752,6 +757,10 @@ PerProcessOptionsParser::PerProcessOptionsParser(
752757
kAllowedInEnvironment);
753758
#endif
754759
#endif
760+
AddOption("--use-largepages",
761+
"Map the Node.js static code to large pages",
762+
&PerProcessOptions::use_largepages,
763+
kAllowedInEnvironment);
755764

756765
Insert(iop, &PerProcessOptions::get_per_isolate_options);
757766
}

‎src/node_options.h‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -237,6 +237,7 @@ class PerProcessOptions : public Options {
237237
bool force_fips_crypto = false;
238238
#endif
239239
#endif
240+
std::string use_largepages = "off";
240241

241242
#ifdef NODE_REPORT
242243
std::vector<std::string> cmdline;

‎test/parallel/test-startup-large-pages.js‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
'use strict';
2+
3+
// Make sure that Node.js runs correctly with the --use-largepages option.
4+
5+
require('../common');
6+
const assert = require('assert');
7+
const { spawnSync } = require('child_process');
8+
9+
{
10+
const child = spawnSync(process.execPath,
11+
[ '--use-largepages=on', '-p', '42' ]);
12+
const stdout = child.stdout.toString().match(/\S+/g);
13+
assert.strictEqual(child.status, 0);
14+
assert.strictEqual(child.signal, null);
15+
assert.strictEqual(stdout.length, 1);
16+
assert.strictEqual(stdout[0], '42');
17+
}
18+
19+
{
20+
const child = spawnSync(process.execPath,
21+
[ '--use-largepages=xyzzy', '-p', '42' ]);
22+
assert.strictEqual(child.status, 9);
23+
assert.strictEqual(child.signal, null);
24+
assert.strictEqual(child.stderr.toString().match(/\S+/g).slice(1).join(' '),
25+
'invalid value for --use-largepages');
26+
}
27+
28+
// TODO(gabrielschulhof): Make assertions about the stderr, which may or may not
29+
// contain a message indicating that mapping to large pages has failed.

0 commit comments

Comments
 (0)
0