From 065a32f064ac8927e4fcdee28ecb2b64370a4a6d Mon Sep 17 00:00:00 2001
From: Myles Borins <mylesborins@google.com>
Date: Thu, 13 Feb 2020 15:27:47 -0800
Subject: [PATCH] Revert "src: make --use-largepages a runtime option"

This reverts commit fcbd2d245ac917785cb59ff51e0f599a7886df6b.

PR-URL: https://github.com/nodejs/node/pull/31782
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
---
 configure.py                              | 33 +++++++++++++++++++++++
 doc/api/cli.md                            | 17 ------------
 doc/node.1                                | 10 -------
 node.gyp                                  |  5 ++--
 node.gypi                                 |  6 +++--
 src/large_pages/node_large_page.cc        | 19 ++++++-------
 src/node.cc                               | 30 +++++++--------------
 src/node_options.cc                       |  9 -------
 src/node_options.h                        |  1 -
 test/parallel/test-startup-large-pages.js | 29 --------------------
 10 files changed, 58 insertions(+), 101 deletions(-)
 delete mode 100644 test/parallel/test-startup-large-pages.js

diff --git a/configure.py b/configure.py
index 210bd8ec279909..14f5665e0299a2 100755
--- a/configure.py
+++ b/configure.py
@@ -398,6 +398,17 @@
     dest='with_etw',
     help='build with ETW (default is true on Windows)')
 
+parser.add_option('--use-largepages',
+    action='store_true',
+    dest='node_use_large_pages',
+    help='build with Large Pages support. This feature is supported only on Linux kernel' +
+         '>= 2.6.38 with Transparent Huge pages enabled and FreeBSD')
+
+parser.add_option('--use-largepages-script-lld',
+    action='store_true',
+    dest='node_use_large_pages_script_lld',
+    help='link against the LLVM ld linker script. Implies -fuse-ld=lld in the linker flags')
+
 intl_optgroup.add_option('--with-intl',
     action='store',
     dest='with_intl',
@@ -1050,6 +1061,28 @@ def configure_node(o):
   else:
     o['variables']['node_use_dtrace'] = 'false'
 
+  if options.node_use_large_pages and not flavor in ('linux', 'freebsd', 'mac'):
+    raise Exception(
+      'Large pages are supported only on Linux, FreeBSD and MacOS Systems.')
+  if options.node_use_large_pages and flavor in ('linux', 'freebsd', 'mac'):
+    if options.shared or options.enable_static:
+      raise Exception(
+        'Large pages are supported only while creating node executable.')
+    if target_arch!="x64":
+      raise Exception(
+        'Large pages are supported only x64 platform.')
+    if flavor == 'mac':
+      info('macOS server with 32GB or more is recommended')
+    if flavor == 'linux':
+      # Example full version string: 2.6.32-696.28.1.el6.x86_64
+      FULL_KERNEL_VERSION=os.uname()[2]
+      KERNEL_VERSION=FULL_KERNEL_VERSION.split('-')[0]
+      if KERNEL_VERSION < "2.6.38" and flavor == 'linux':
+        raise Exception(
+          'Large pages need Linux kernel version >= 2.6.38')
+  o['variables']['node_use_large_pages'] = b(options.node_use_large_pages)
+  o['variables']['node_use_large_pages_script_lld'] = b(options.node_use_large_pages_script_lld)
+
   if options.no_ifaddrs:
     o['defines'] += ['SUNOS_NO_IFADDRS']
 
diff --git a/doc/api/cli.md b/doc/api/cli.md
index 979c1214f5c59e..7703d0b6bd99d2 100644
--- a/doc/api/cli.md
+++ b/doc/api/cli.md
@@ -881,22 +881,6 @@ environment variables.
 
 See `SSL_CERT_DIR` and `SSL_CERT_FILE`.
 
-### `--use-largepages=mode`
-<!-- YAML
-added: v12.16.0
--->
-
-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
@@ -1153,7 +1137,6 @@ 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`
diff --git a/doc/node.1 b/doc/node.1
index e847842307be95..675bfc9a4851d4 100644
--- a/doc/node.1
+++ b/doc/node.1
@@ -421,16 +421,6 @@ See
 and
 .Ev SSL_CERT_FILE .
 .
-.It Fl -use-largepages Ns = Ns Ar mode
-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.
-.Pp
-.Ar mode
-must have one of the following values:
-`off` (the default value, meaning do not map), `on` (map and ignore failure,
-reporting it to stderr), or `silent` (map and silently ignore failure).
-.
 .It Fl -v8-options
 Print V8 command-line options.
 .
diff --git a/node.gyp b/node.gyp
index 51c424d65bdfe8..9806b165ab78eb 100644
--- a/node.gyp
+++ b/node.gyp
@@ -843,9 +843,10 @@
             }],
           ],
         }],
-        [ 'OS in "linux freebsd mac" and '
-          'target_arch=="x64"', {
+        [ 'node_use_large_pages=="true" and OS in "linux freebsd mac"', {
           'defines': [ 'NODE_ENABLE_LARGE_CODE_PAGES=1' ],
+          # The current implementation of Large Pages is under Linux.
+          # Other implementations are possible but not currently supported.
           'sources': [
             'src/large_pages/node_large_page.cc',
             'src/large_pages/node_large_page.h'
diff --git a/node.gypi b/node.gypi
index 687da8b501ceff..144544214316a3 100644
--- a/node.gypi
+++ b/node.gypi
@@ -309,7 +309,8 @@
     }],
     [ 'OS=="linux" and '
       'target_arch=="x64" and '
-      'llvm_version=="0.0"', {
+      'node_use_large_pages=="true" and '
+      'node_use_large_pages_script_lld=="false"', {
       'ldflags': [
         '-Wl,-T',
         '<!(realpath src/large_pages/ld.implicit.script)',
@@ -317,7 +318,8 @@
     }],
     [ 'OS=="linux" and '
       'target_arch=="x64" and '
-      'llvm_version!="0.0"', {
+      'node_use_large_pages=="true" and '
+      'node_use_large_pages_script_lld=="true"', {
       'ldflags': [
         '-Wl,-T',
         '<!(realpath src/large_pages/ld.implicit.script.lld)',
diff --git a/src/large_pages/node_large_page.cc b/src/large_pages/node_large_page.cc
index 3897b819e81bad..4e2f8fc4410316 100644
--- a/src/large_pages/node_large_page.cc
+++ b/src/large_pages/node_large_page.cc
@@ -62,7 +62,7 @@
 // Map a new area and copy the original code there
 // Use mmap using the start address with MAP_FIXED so we get exactly the
 // same virtual address
-// Use madvise with MADV_HUGEPAGE to use Anonymous 2M Pages
+// Use madvise with MADV_HUGE_PAGE to use Anonymous 2M Pages
 // If successful copy the code there and unmap the original region.
 
 extern char __nodetext;
@@ -308,7 +308,7 @@ static bool IsSuperPagesEnabled() {
 // a. map a new area and copy the original code there
 // b. mmap using the start address with MAP_FIXED so we get exactly
 //    the same virtual address (except on macOS).
-// c. madvise with MADV_HUGEPAGE
+// c. madvise with MADV_HUGE_PAGE
 // d. If successful copy the code there and unmap the original region
 int
 #if !defined(__APPLE__)
@@ -333,6 +333,9 @@ MoveTextRegionToLargePages(const text_region& r) {
     PrintSystemError(errno);
     return -1;
   }
+  OnScopeLeave munmap_on_return([nmem, size]() {
+    if (-1 == munmap(nmem, size)) PrintSystemError(errno);
+  });
 
   memcpy(nmem, r.from, size);
 
@@ -349,14 +352,13 @@ MoveTextRegionToLargePages(const text_region& r) {
     return -1;
   }
 
-  ret = madvise(tmem, size, 14 /* MADV_HUGEPAGE */);
+  ret = madvise(tmem, size, MADV_HUGEPAGE);
   if (ret == -1) {
     PrintSystemError(errno);
     ret = munmap(tmem, size);
     if (ret == -1) {
       PrintSystemError(errno);
     }
-    if (-1 == munmap(nmem, size)) PrintSystemError(errno);
     return -1;
   }
   memcpy(start, nmem, size);
@@ -367,7 +369,6 @@ MoveTextRegionToLargePages(const text_region& r) {
               MAP_ALIGNED_SUPER, -1 , 0);
   if (tmem == MAP_FAILED) {
     PrintSystemError(errno);
-    if (-1 == munmap(nmem, size)) PrintSystemError(errno);
     return -1;
   }
 #elif defined(__APPLE__)
@@ -382,7 +383,6 @@ MoveTextRegionToLargePages(const text_region& r) {
               VM_FLAGS_SUPERPAGE_SIZE_2MB, 0);
   if (tmem == MAP_FAILED) {
     PrintSystemError(errno);
-    if (-1 == munmap(nmem, size)) PrintSystemError(errno);
     return -1;
   }
   memcpy(tmem, nmem, size);
@@ -393,7 +393,6 @@ MoveTextRegionToLargePages(const text_region& r) {
     if (ret == -1) {
       PrintSystemError(errno);
     }
-    if (-1 == munmap(nmem, size)) PrintSystemError(errno);
     return -1;
   }
   memcpy(start, tmem, size);
@@ -406,10 +405,8 @@ MoveTextRegionToLargePages(const text_region& r) {
     if (ret == -1) {
       PrintSystemError(errno);
     }
-    if (-1 == munmap(nmem, size)) PrintSystemError(errno);
     return -1;
   }
-  if (-1 == munmap(nmem, size)) PrintSystemError(errno);
   return ret;
 }
 
@@ -421,12 +418,12 @@ int MapStaticCodeToLargePages() {
     return -1;
   }
 
-#if defined(__linux__) || defined(__FreeBSD__)
+#if defined(__linux__)
   if (r.from > reinterpret_cast<void*>(&MoveTextRegionToLargePages))
     return MoveTextRegionToLargePages(r);
 
   return -1;
-#elif defined(__APPLE__)
+#elif defined(__FreeBSD__) || defined(__APPLE__)
   return MoveTextRegionToLargePages(r);
 #endif
 }
diff --git a/src/node.cc b/src/node.cc
index 05c87c62d6db6c..80916e5244aa36 100644
--- a/src/node.cc
+++ b/src/node.cc
@@ -64,7 +64,9 @@
 #include "inspector/worker_inspector.h"  // ParentInspectorHandle
 #endif
 
+#ifdef NODE_ENABLE_LARGE_CODE_PAGES
 #include "large_pages/node_large_page.h"
+#endif
 
 #ifdef NODE_REPORT
 #include "node_report.h"
@@ -952,6 +954,14 @@ InitializationResult InitializeOncePerProcess(int argc, char** argv) {
 
   CHECK_GT(argc, 0);
 
+#ifdef NODE_ENABLE_LARGE_CODE_PAGES
+  if (node::IsLargePagesEnabled()) {
+    if (node::MapStaticCodeToLargePages() != 0) {
+      fprintf(stderr, "Reverting to default page size\n");
+    }
+  }
+#endif
+
   // Hack around with the argv pointer. Used for process.title = "blah".
   argv = uv_setup_args(argc, argv);
 
@@ -971,26 +981,6 @@ InitializationResult InitializeOncePerProcess(int argc, char** argv) {
     }
   }
 
-#if defined(NODE_ENABLE_LARGE_CODE_PAGES) && NODE_ENABLE_LARGE_CODE_PAGES
-  if (per_process::cli_options->use_largepages == "on" ||
-      per_process::cli_options->use_largepages == "silent") {
-    if (node::IsLargePagesEnabled()) {
-      if (node::MapStaticCodeToLargePages() != 0 &&
-          per_process::cli_options->use_largepages != "silent") {
-        fprintf(stderr,
-                "Mapping code to large pages failed. Reverting to default page "
-                "size.\n");
-      }
-    } else if (per_process::cli_options->use_largepages != "silent") {
-      fprintf(stderr, "Large pages are not enabled.\n");
-    }
-  }
-#else
-  if (per_process::cli_options->use_largepages == "on") {
-    fprintf(stderr, "Mapping to large pages is not supported.\n");
-  }
-#endif  // NODE_ENABLE_LARGE_CODE_PAGES
-
   if (per_process::cli_options->print_version) {
     printf("%s\n", NODE_VERSION);
     result.exit_code = 0;
diff --git a/src/node_options.cc b/src/node_options.cc
index 89f8894379969a..ed46978236675a 100644
--- a/src/node_options.cc
+++ b/src/node_options.cc
@@ -65,11 +65,6 @@ void PerProcessOptions::CheckOptions(std::vector<std::string>* errors) {
                       "used, not both");
   }
 #endif
-  if (use_largepages != "off" &&
-      use_largepages != "on" &&
-      use_largepages != "silent") {
-    errors->push_back("invalid value for --use-largepages");
-  }
   per_isolate->CheckOptions(errors);
 }
 
@@ -793,10 +788,6 @@ PerProcessOptionsParser::PerProcessOptionsParser(
             kAllowedInEnvironment);
 #endif
 #endif
-  AddOption("--use-largepages",
-            "Map the Node.js static code to large pages",
-            &PerProcessOptions::use_largepages,
-            kAllowedInEnvironment);
 
   // v12.x backwards compat flags removed in V8 7.9.
   AddOption("--fast_calls_with_arguments_mismatches", "", NoOp{});
diff --git a/src/node_options.h b/src/node_options.h
index 95fe32ebd99bd9..60daf360d98d91 100644
--- a/src/node_options.h
+++ b/src/node_options.h
@@ -238,7 +238,6 @@ class PerProcessOptions : public Options {
   bool force_fips_crypto = false;
 #endif
 #endif
-  std::string use_largepages = "off";
 
 #ifdef NODE_REPORT
   std::vector<std::string> cmdline;
diff --git a/test/parallel/test-startup-large-pages.js b/test/parallel/test-startup-large-pages.js
deleted file mode 100644
index d5589ee547f760..00000000000000
--- a/test/parallel/test-startup-large-pages.js
+++ /dev/null
@@ -1,29 +0,0 @@
-'use strict';
-
-// Make sure that Node.js runs correctly with the --use-largepages option.
-
-require('../common');
-const assert = require('assert');
-const { spawnSync } = require('child_process');
-
-{
-  const child = spawnSync(process.execPath,
-                          [ '--use-largepages=on', '-p', '42' ]);
-  const stdout = child.stdout.toString().match(/\S+/g);
-  assert.strictEqual(child.status, 0);
-  assert.strictEqual(child.signal, null);
-  assert.strictEqual(stdout.length, 1);
-  assert.strictEqual(stdout[0], '42');
-}
-
-{
-  const child = spawnSync(process.execPath,
-                          [ '--use-largepages=xyzzy', '-p', '42' ]);
-  assert.strictEqual(child.status, 9);
-  assert.strictEqual(child.signal, null);
-  assert.strictEqual(child.stderr.toString().match(/\S+/g).slice(1).join(' '),
-                     'invalid value for --use-largepages');
-}
-
-// TODO(gabrielschulhof): Make assertions about the stderr, which may or may not
-// contain a message indicating that mapping to large pages has failed.