src: remove util-inl.h from header files

Its intended that *-inl.h header files are only included into the src
files that call the inline methods. Explicitly include it into the files
that need it.

PR-URL: https://github.com/nodejs/node/pull/27631
Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>

58 files changed, 64 insertions, 28 deletions

diff --git a/src/aliased_buffer.h b/src/aliased_buffer.h
index 868d495be9..5083ae9a1f 100644
--- a/src/aliased_buffer.h
+++ b/src/aliased_buffer.h
@@ -4,7 +4,7 @@
 #if defined(NODE_WANT_INTERNALS) && NODE_WANT_INTERNALS
 
 #include <cinttypes>
-#include "util-inl.h"
+#include "util.h"
 #include "v8.h"
 
 namespace node {
diff --git a/src/api/utils.cc b/src/api/utils.cc
index b0998b6fb7..da7281a68f 100644
--- a/src/api/utils.cc
+++ b/src/api/utils.cc
@@ -1,5 +1,6 @@
 #include "node.h"
 #include "node_internals.h"
+#include "util-inl.h"
 
 #include <csignal>
 
diff --git a/src/base_object-inl.h b/src/base_object-inl.h
index fd61c15fea..50d8aba4a9 100644
--- a/src/base_object-inl.h
+++ b/src/base_object-inl.h
@@ -26,7 +26,7 @@
 
 #include "base_object.h"
 #include "env-inl.h"
-#include "util-inl.h"
+#include "util.h"
 #include "v8.h"
 
 namespace node {
diff --git a/src/debug_utils.cc b/src/debug_utils.cc
index bff2f9ae91..b86710fba6 100644
--- a/src/debug_utils.cc
+++ b/src/debug_utils.cc
@@ -1,4 +1,5 @@
 #include "debug_utils.h"
+#include "util-inl.h"
 
 #ifdef __POSIX__
 #if defined(__linux__)
diff --git a/src/env.cc b/src/env.cc
index 197cd5bd90..5f408f18f1 100644
--- a/src/env.cc
+++ b/src/env.cc
@@ -13,6 +13,7 @@
 #include "node_worker.h"
 #include "tracing/agent.h"
 #include "tracing/traced_value.h"
+#include "util-inl.h"
 #include "v8-profiler.h"
 
 #include <algorithm>
diff --git a/src/heap_utils.cc b/src/heap_utils.cc
index 654dfabafe..ee0665cfe2 100644
--- a/src/heap_utils.cc
+++ b/src/heap_utils.cc
@@ -1,5 +1,6 @@
 #include "env-inl.h"
 #include "stream_base-inl.h"
+#include "util-inl.h"
 
 using v8::Array;
 using v8::Boolean;
diff --git a/src/inspector/tracing_agent.cc b/src/inspector/tracing_agent.cc
index 09d213d8ae..d87eec6a64 100644
--- a/src/inspector/tracing_agent.cc
+++ b/src/inspector/tracing_agent.cc
@@ -4,6 +4,7 @@
 #include "node_v8_platform-inl.h"
 
 #include "env-inl.h"
+#include "util-inl.h"
 #include "v8.h"
 
 #include <set>
diff --git a/src/inspector/worker_inspector.cc b/src/inspector/worker_inspector.cc
index b7fab6ea6b..48679d2f69 100644
--- a/src/inspector/worker_inspector.cc
+++ b/src/inspector/worker_inspector.cc
@@ -1,5 +1,6 @@
 #include "worker_inspector.h"
 #include "main_thread_interface.h"
+#include "util-inl.h"
 
 #include <memory>
 
diff --git a/src/inspector_agent.cc b/src/inspector_agent.cc
index 6ef262945b..d82e88d612 100644
--- a/src/inspector_agent.cc
+++ b/src/inspector_agent.cc
@@ -12,6 +12,7 @@
 #include "node_options-inl.h"
 #include "node_process.h"
 #include "node_url.h"
+#include "util-inl.h"
 #include "v8-inspector.h"
 #include "v8-platform.h"
 
diff --git a/src/inspector_io.cc b/src/inspector_io.cc
index 75bcfff5f7..7ba19087d0 100644
--- a/src/inspector_io.cc
+++ b/src/inspector_io.cc
@@ -11,7 +11,7 @@
 #include "node_internals.h"
 #include "node_mutex.h"
 #include "v8-inspector.h"
-#include "util.h"
+#include "util-inl.h"
 #include "zlib.h"
 
 #include <deque>
diff --git a/src/inspector_js_api.cc b/src/inspector_js_api.cc
index 4948bd8797..5caf3fa09a 100644
--- a/src/inspector_js_api.cc
+++ b/src/inspector_js_api.cc
@@ -1,6 +1,7 @@
 #include "base_object-inl.h"
 #include "inspector_agent.h"
 #include "inspector_io.h"
+#include "util-inl.h"
 #include "v8.h"
 #include "v8-inspector.h"
 
diff --git a/src/inspector_profiler.cc b/src/inspector_profiler.cc
index 4dfad49019..0f778c88dd 100644
--- a/src/inspector_profiler.cc
+++ b/src/inspector_profiler.cc
@@ -5,7 +5,7 @@
 #include "node_file.h"
 #include "node_internals.h"
 #include "v8-inspector.h"
-#include "util.h"
+#include "util-inl.h"
 
 namespace node {
 namespace profiler {
diff --git a/src/inspector_socket.h b/src/inspector_socket.h
index 649b7f445d..a6a18923d1 100644
--- a/src/inspector_socket.h
+++ b/src/inspector_socket.h
@@ -3,7 +3,7 @@
 
 #if defined(NODE_WANT_INTERNALS) && NODE_WANT_INTERNALS
 
-#include "util-inl.h"
+#include "util.h"
 #include "uv.h"
 
 #include <string>
diff --git a/src/inspector_socket_server.cc b/src/inspector_socket_server.cc
index 5f1bdbc1e6..6bb0437222 100644
--- a/src/inspector_socket_server.cc
+++ b/src/inspector_socket_server.cc
@@ -1,6 +1,7 @@
 #include "inspector_socket_server.h"
 
 #include "node.h"
+#include "util-inl.h"
 #include "uv.h"
 #include "zlib.h"
 
diff --git a/src/js_native_api_v8.cc b/src/js_native_api_v8.cc
index befef0af65..286086ab6a 100644
--- a/src/js_native_api_v8.cc
+++ b/src/js_native_api_v8.cc
@@ -4,6 +4,7 @@
 #define NAPI_EXPERIMENTAL
 #include "js_native_api_v8.h"
 #include "js_native_api.h"
+#include "util-inl.h"
 
 #define CHECK_MAYBE_NOTHING(env, maybe, status) \
   RETURN_STATUS_IF_FALSE((env), !((maybe).IsNothing()), (status))
diff --git a/src/js_native_api_v8.h b/src/js_native_api_v8.h
index 9d896ae1f2..88c59869a0 100644
--- a/src/js_native_api_v8.h
+++ b/src/js_native_api_v8.h
@@ -150,7 +150,7 @@ inline napi_value JsValueFromV8LocalValue(v8::Local<v8::Value> local) {
 
 inline v8::Local<v8::Value> V8LocalValueFromJsValue(napi_value v) {
   v8::Local<v8::Value> local;
-  memcpy(&local, &v, sizeof(v));
+  memcpy(static_cast<void*>(&local), &v, sizeof(v));
   return local;
 }
 
diff --git a/src/js_stream.cc b/src/js_stream.cc
index d29e748da8..1d61605d64 100644
--- a/src/js_stream.cc
+++ b/src/js_stream.cc
@@ -5,6 +5,7 @@
 #include "node_buffer.h"
 #include "node_errors.h"
 #include "stream_base-inl.h"
+#include "util-inl.h"
 #include "v8.h"
 
 namespace node {
diff --git a/src/node.cc b/src/node.cc
index ac0e7dfce3..953465e04a 100644
--- a/src/node.cc
+++ b/src/node.cc
@@ -24,6 +24,7 @@
 // ========== local headers ==========
 
 #include "debug_utils.h"
+#include "env-inl.h"
 #include "node_binding.h"
 #include "node_internals.h"
 #include "node_main_instance.h"
diff --git a/src/node.h b/src/node.h
index 5098dc9c7e..5af0655a84 100644
--- a/src/node.h
+++ b/src/node.h
@@ -99,6 +99,14 @@
 # endif
 #endif
 
+#if defined(NODE_WANT_INTERNALS) && NODE_WANT_INTERNALS
+// Internally, do not include util-inl.h into files unless they need it's
+// inline definitions.
+#else
+// Externally, it must be included for backwards API compatibility.
+#  include <util-inl.h>
+#endif
+
 // Forward-declare libuv loop
 struct uv_loop_s;
 
diff --git a/src/node_api.cc b/src/node_api.cc
index ab48caa237..f8b0d8b550 100644
--- a/src/node_api.cc
+++ b/src/node_api.cc
@@ -6,6 +6,7 @@
 #include "node_binding.h"
 #include "node_errors.h"
 #include "node_internals.h"
+#include "util-inl.h"
 
 #include <memory>
 
diff --git a/src/node_constants.cc b/src/node_constants.cc
index bdbef2bfbc..aa2afc59d9 100644
--- a/src/node_constants.cc
+++ b/src/node_constants.cc
@@ -21,6 +21,7 @@
 
 #include "node_constants.h"
 #include "node_internals.h"
+#include "util-inl.h"
 
 #include "zlib.h"
 
diff --git a/src/node_contextify.cc b/src/node_contextify.cc
index f8d43e062e..6590da62c5 100644
--- a/src/node_contextify.cc
+++ b/src/node_contextify.cc
@@ -27,6 +27,7 @@
 #include "node_context_data.h"
 #include "node_errors.h"
 #include "module_wrap.h"
+#include "util-inl.h"
 
 namespace node {
 namespace contextify {
diff --git a/src/node_credentials.cc b/src/node_credentials.cc
index c8685ac488..d384504f2a 100644
--- a/src/node_credentials.cc
+++ b/src/node_credentials.cc
@@ -1,4 +1,5 @@
 #include "node_internals.h"
+#include "util-inl.h"
 
 #ifdef NODE_IMPLEMENTS_POSIX_CREDENTIALS
 #include <grp.h>  // getgrnam()
diff --git a/src/node_crypto_bio.h b/src/node_crypto_bio.h
index ef7012ba72..fef91750d5 100644
--- a/src/node_crypto_bio.h
+++ b/src/node_crypto_bio.h
@@ -26,8 +26,8 @@
 
 #include "node_crypto.h"
 #include "openssl/bio.h"
-#include "env-inl.h"
-#include "util-inl.h"
+#include "env.h"
+#include "util.h"
 #include "v8.h"
 
 namespace node {
diff --git a/src/node_crypto_clienthello-inl.h b/src/node_crypto_clienthello-inl.h
index 1262186a92..7d1671f72e 100644
--- a/src/node_crypto_clienthello-inl.h
+++ b/src/node_crypto_clienthello-inl.h
@@ -25,7 +25,7 @@
 #if defined(NODE_WANT_INTERNALS) && NODE_WANT_INTERNALS
 
 #include "node_crypto_clienthello.h"
-#include "util-inl.h"
+#include "util.h"
 
 namespace node {
 namespace crypto {
diff --git a/src/node_dtrace.cc b/src/node_dtrace.cc
index 910c19df73..fc58734c59 100644
--- a/src/node_dtrace.cc
+++ b/src/node_dtrace.cc
@@ -42,6 +42,7 @@
 #define NODE_GC_DONE(arg0, arg1, arg2)
 #endif
 
+#include "env-inl.h"
 #include "node_errors.h"
 
 #include <cstring>
diff --git a/src/node_env_var.cc b/src/node_env_var.cc
index abcf918506..4b398ce7cd 100644
--- a/src/node_env_var.cc
+++ b/src/node_env_var.cc
@@ -1,6 +1,6 @@
+#include "env-inl.h"
 #include "node_errors.h"
 #include "node_process.h"
-#include "util.h"
 
 #ifdef __APPLE__
 #include <crt_externs.h>
diff --git a/src/node_errors.cc b/src/node_errors.cc
index e2cd65b4ef..1cd9052383 100644
--- a/src/node_errors.cc
+++ b/src/node_errors.cc
@@ -8,6 +8,7 @@
 #endif
 #include "node_process.h"
 #include "node_v8_platform-inl.h"
+#include "util-inl.h"
 
 namespace node {
 
diff --git a/src/node_errors.h b/src/node_errors.h
index 49575f0bd1..7162d05c1a 100644
--- a/src/node_errors.h
+++ b/src/node_errors.h
@@ -4,8 +4,8 @@
 #if defined(NODE_WANT_INTERNALS) && NODE_WANT_INTERNALS
 
 #include "node.h"
-#include "util-inl.h"
-#include "env-inl.h"
+#include "util.h"
+#include "env.h"
 #include "v8.h"
 
 // Use ostringstream to print exact-width integer types
diff --git a/src/node_file.cc b/src/node_file.cc
index 36463c9e6f..4da2a4f53c 100644
--- a/src/node_file.cc
+++ b/src/node_file.cc
@@ -24,7 +24,7 @@
 #include "node_buffer.h"
 #include "node_process.h"
 #include "node_stat_watcher.h"
-#include "util.h"
+#include "util-inl.h"
 
 #include "tracing/trace_event.h"
 
diff --git a/src/node_http2.cc b/src/node_http2.cc
index 55cee019b0..0c650290c2 100644
--- a/src/node_http2.cc
+++ b/src/node_http2.cc
@@ -5,7 +5,7 @@
 #include "node_http2.h"
 #include "node_http2_state.h"
 #include "node_perf.h"
-#include "util.h"
+#include "util-inl.h"
 
 #include <algorithm>
 
diff --git a/src/node_http_parser_llhttp.cc b/src/node_http_parser_llhttp.cc
index 423fb5e104..d2063873f1 100644
--- a/src/node_http_parser_llhttp.cc
+++ b/src/node_http_parser_llhttp.cc
@@ -2,6 +2,7 @@
 
 #include "node_http_parser_impl.h"
 #include "node_metadata.h"
+#include "util-inl.h"
 
 namespace node {
 
diff --git a/src/node_http_parser_traditional.cc b/src/node_http_parser_traditional.cc
index 89ef65979c..7b413af8b6 100644
--- a/src/node_http_parser_traditional.cc
+++ b/src/node_http_parser_traditional.cc
@@ -4,6 +4,7 @@
 
 #include "node_http_parser_impl.h"
 #include "node_metadata.h"
+#include "util-inl.h"
 
 namespace node {
 namespace per_process {
diff --git a/src/node_internals.h b/src/node_internals.h
index 5e99ac4c66..91cc0efd50 100644
--- a/src/node_internals.h
+++ b/src/node_internals.h
@@ -29,7 +29,7 @@
 #include "node_binding.h"
 #include "node_mutex.h"
 #include "tracing/trace_event.h"
-#include "util-inl.h"
+#include "util.h"
 #include "uv.h"
 #include "v8.h"
 
diff --git a/src/node_main_instance.cc b/src/node_main_instance.cc
index 977a689a35..f4f20f4322 100644
--- a/src/node_main_instance.cc
+++ b/src/node_main_instance.cc
@@ -2,6 +2,7 @@
 #include "node_internals.h"
 #include "node_options-inl.h"
 #include "node_v8_platform-inl.h"
+#include "util-inl.h"
 
 namespace node {
 
diff --git a/src/node_messaging.cc b/src/node_messaging.cc
index 77ed959477..c7d0b32700 100644
--- a/src/node_messaging.cc
+++ b/src/node_messaging.cc
@@ -6,7 +6,7 @@
 #include "node_buffer.h"
 #include "node_errors.h"
 #include "node_process.h"
-#include "util.h"
+#include "util-inl.h"
 
 using node::contextify::ContextifyContext;
 using v8::Array;
diff --git a/src/node_os.cc b/src/node_os.cc
index 5dd3146900..d2387f2dc9 100644
--- a/src/node_os.cc
+++ b/src/node_os.cc
@@ -21,7 +21,6 @@
 
 #include "env-inl.h"
 #include "string_bytes.h"
-#include "util.h"
 
 #ifdef __MINGW32__
 # include <io.h>
diff --git a/src/node_perf.cc b/src/node_perf.cc
index 8f982049c7..0863202030 100644
--- a/src/node_perf.cc
+++ b/src/node_perf.cc
@@ -3,6 +3,7 @@
 #include "node_perf.h"
 #include "node_buffer.h"
 #include "node_process.h"
+#include "util-inl.h"
 
 #include <cinttypes>
 
diff --git a/src/node_platform.cc b/src/node_platform.cc
index 8c097c03c7..406146b841 100644
--- a/src/node_platform.cc
+++ b/src/node_platform.cc
@@ -3,7 +3,6 @@
 
 #include "env-inl.h"
 #include "debug_utils.h"
-#include "util.h"
 #include <algorithm>
 #include <cmath>
 #include <memory>
diff --git a/src/node_report_module.cc b/src/node_report_module.cc
index f303685adb..f35d23a06e 100644
--- a/src/node_report_module.cc
+++ b/src/node_report_module.cc
@@ -3,7 +3,7 @@
 #include "node_internals.h"
 #include "node_options.h"
 #include "node_report.h"
-#include "util.h"
+#include "util-inl.h"
 
 #include "handle_wrap.h"
 #include "node_buffer.h"
diff --git a/src/node_report_utils.cc b/src/node_report_utils.cc
index 24f3b6175d..33d7c52b34 100644
--- a/src/node_report_utils.cc
+++ b/src/node_report_utils.cc
@@ -1,5 +1,6 @@
 #include "node_internals.h"
 #include "node_report.h"
+#include "util-inl.h"
 
 namespace report {
 
diff --git a/src/node_serdes.cc b/src/node_serdes.cc
index 6e4bab5ce1..41ee8afd8c 100644
--- a/src/node_serdes.cc
+++ b/src/node_serdes.cc
@@ -1,6 +1,7 @@
 #include "node_internals.h"
 #include "node_buffer.h"
 #include "node_errors.h"
+#include "util-inl.h"
 #include "base_object-inl.h"
 
 namespace node {
diff --git a/src/node_stat_watcher.cc b/src/node_stat_watcher.cc
index e4346678c0..b7fb45900f 100644
--- a/src/node_stat_watcher.cc
+++ b/src/node_stat_watcher.cc
@@ -23,7 +23,7 @@
 #include "async_wrap-inl.h"
 #include "env.h"
 #include "node_file.h"
-#include "util.h"
+#include "util-inl.h"
 
 #include <cstring>
 #include <cstdlib>
diff --git a/src/node_symbols.cc b/src/node_symbols.cc
index af660b0a8e..cb6c5583bb 100644
--- a/src/node_symbols.cc
+++ b/src/node_symbols.cc
@@ -1,5 +1,6 @@
 #include "env-inl.h"
 #include "node_binding.h"
+#include "util.h"
 
 namespace node {
 
diff --git a/src/node_task_queue.cc b/src/node_task_queue.cc
index af1d96fab2..a277b8bd2a 100644
--- a/src/node_task_queue.cc
+++ b/src/node_task_queue.cc
@@ -3,6 +3,7 @@
 #include "node_errors.h"
 #include "node_internals.h"
 #include "node_process.h"
+#include "util-inl.h"
 #include "v8.h"
 
 #include <atomic>
diff --git a/src/node_trace_events.cc b/src/node_trace_events.cc
index 74ba5bb480..13072a3340 100644
--- a/src/node_trace_events.cc
+++ b/src/node_trace_events.cc
@@ -4,6 +4,7 @@
 #include "node_internals.h"
 #include "node_v8_platform-inl.h"
 #include "tracing/agent.h"
+#include "util-inl.h"
 
 #include <set>
 #include <string>
diff --git a/src/node_url.cc b/src/node_url.cc
index e5e9eff74c..6565688d02 100644
--- a/src/node_url.cc
+++ b/src/node_url.cc
@@ -2,7 +2,7 @@
 #include "base_object-inl.h"
 #include "node_errors.h"
 #include "node_i18n.h"
-#include "util.h"
+#include "util-inl.h"
 
 #include <cmath>
 #include <cstdio>
diff --git a/src/node_util.cc b/src/node_util.cc
index 0c498e2838..9e506f0e65 100644
--- a/src/node_util.cc
+++ b/src/node_util.cc
@@ -1,5 +1,5 @@
 #include "node_errors.h"
-#include "util.h"
+#include "util-inl.h"
 #include "base_object-inl.h"
 
 namespace node {
diff --git a/src/node_watchdog.cc b/src/node_watchdog.cc
index 482d590a52..7c62aafa82 100644
--- a/src/node_watchdog.cc
+++ b/src/node_watchdog.cc
@@ -24,6 +24,7 @@
 #include "debug_utils.h"
 #include "node_errors.h"
 #include "node_internals.h"
+#include "util-inl.h"
 
 namespace node {
 
diff --git a/src/node_worker.cc b/src/node_worker.cc
index f95407a5ed..20b883664d 100644
--- a/src/node_worker.cc
+++ b/src/node_worker.cc
@@ -4,7 +4,7 @@
 #include "node_buffer.h"
 #include "node_options-inl.h"
 #include "node_perf.h"
-#include "util.h"
+#include "util-inl.h"
 #include "async_wrap-inl.h"
 
 #if NODE_USE_V8_PLATFORM && HAVE_INSPECTOR
diff --git a/src/req_wrap-inl.h b/src/req_wrap-inl.h
index 5fb9654148..cf89fb58a7 100644
--- a/src/req_wrap-inl.h
+++ b/src/req_wrap-inl.h
@@ -5,8 +5,6 @@
 
 #include "req_wrap.h"
 #include "async_wrap-inl.h"
-#include "env-inl.h"
-#include "util-inl.h"
 #include "uv.h"
 
 namespace node {
diff --git a/src/sharedarraybuffer_metadata.cc b/src/sharedarraybuffer_metadata.cc
index 722a20065f..9ba604b506 100644
--- a/src/sharedarraybuffer_metadata.cc
+++ b/src/sharedarraybuffer_metadata.cc
@@ -2,6 +2,7 @@
 
 #include "base_object-inl.h"
 #include "node_errors.h"
+#include "util-inl.h"
 
 #include <utility>
 
diff --git a/src/spawn_sync.cc b/src/spawn_sync.cc
index 4c8885f04a..0751bc21a7 100644
--- a/src/spawn_sync.cc
+++ b/src/spawn_sync.cc
@@ -24,6 +24,7 @@
 #include "env-inl.h"
 #include "node_internals.h"
 #include "string_bytes.h"
+#include "util-inl.h"
 
 #include <cstring>
 
diff --git a/src/stream_pipe.cc b/src/stream_pipe.cc
index bacf8fe771..a6b975ab26 100644
--- a/src/stream_pipe.cc
+++ b/src/stream_pipe.cc
@@ -1,6 +1,7 @@
 #include "stream_pipe.h"
 #include "stream_base-inl.h"
 #include "node_buffer.h"
+#include "util-inl.h"
 
 using v8::Context;
 using v8::Function;
diff --git a/src/string_decoder.cc b/src/string_decoder.cc
index 210983de2a..6ec84e0e11 100644
--- a/src/string_decoder.cc
+++ b/src/string_decoder.cc
@@ -4,6 +4,7 @@
 #include "env-inl.h"
 #include "node_buffer.h"
 #include "string_bytes.h"
+#include "util.h"
 
 using v8::Array;
 using v8::ArrayBufferView;
diff --git a/src/timers.cc b/src/timers.cc
index ef07d908f4..f35ae1cf64 100644
--- a/src/timers.cc
+++ b/src/timers.cc
@@ -1,5 +1,5 @@
 #include "env-inl.h"
-#include "util.h"
+#include "util-inl.h"
 #include "v8.h"
 
 #include <cstdint>
diff --git a/src/util.cc b/src/util.cc
index 78ac680f39..51f11b4539 100644
--- a/src/util.cc
+++ b/src/util.cc
@@ -19,7 +19,8 @@
 // OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
 // USE OR OTHER DEALINGS IN THE SOFTWARE.
 
-#include "util.h"
+#include "util.h"  // NOLINT(build/include_inline)
+#include "util-inl.h"
 
 #include "node_buffer.h"
 #include "node_errors.h"
diff --git a/src/uv.cc b/src/uv.cc
index 0c937e876f..bf50c88111 100644
--- a/src/uv.cc
+++ b/src/uv.cc
@@ -23,7 +23,6 @@
 #include "env-inl.h"
 #include "node.h"
 #include "node_process.h"
-#include "util.h"
 
 namespace node {