Skip to content

Commit d17d7bd

Browse files
joyeecheungTrott
joyeecheung
authored and
Trott
committed
src: move version metadata into node_metadata{.h, .cc}
This patch moves the computation of version metadata from node.cc into node_metadata{.h, .cc}, and creates a macro that can be used to iterate over the available version keys (v8, uv, .etc). This makes the code clearer as now we no longer need to add all the headers in node.cc just to compute the versions, and makes it easier to reuse the version definitions. PR-URL: nodejs#24774 Reviewed-By: Richard Lau <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Colin Ihrig <[email protected]>
1 parent 7761881 commit d17d7bd

File tree

4 files changed

+117
-90
lines changed

4 files changed

+117
-90
lines changed

‎node.gyp

+2
Original file line numberDiff line numberDiff line change
@@ -359,6 +359,7 @@
359359
'src/node_http2.cc',
360360
'src/node_i18n.cc',
361361
'src/node_messaging.cc',
362+
'src/node_metadata.cc',
362363
'src/node_native_module.cc',
363364
'src/node_options.cc',
364365
'src/node_os.cc',
@@ -430,6 +431,7 @@
430431
'src/node_i18n.h',
431432
'src/node_internals.h',
432433
'src/node_messaging.h',
434+
'src/node_metadata.h',
433435
'src/node_mutex.h',
434436
'src/node_native_module.h',
435437
'src/node_object_wrap.h',

‎src/node.cc

+9-90
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@
2525
#include "node_context_data.h"
2626
#include "node_errors.h"
2727
#include "node_internals.h"
28+
#include "node_metadata.h"
2829
#include "node_native_module.h"
2930
#include "node_perf.h"
3031
#include "node_platform.h"
@@ -48,16 +49,9 @@
4849
#include "node_dtrace.h"
4950
#endif
5051

51-
#include "ares.h"
5252
#include "async_wrap-inl.h"
5353
#include "env-inl.h"
5454
#include "handle_wrap.h"
55-
#ifdef NODE_EXPERIMENTAL_HTTP
56-
# include "llhttp.h"
57-
#else /* !NODE_EXPERIMENTAL_HTTP */
58-
# include "http_parser.h"
59-
#endif /* NODE_EXPERIMENTAL_HTTP */
60-
#include "nghttp2/nghttp2ver.h"
6155
#include "req_wrap-inl.h"
6256
#include "string_bytes.h"
6357
#include "tracing/agent.h"
@@ -68,7 +62,6 @@
6862
#include "libplatform/libplatform.h"
6963
#endif // NODE_USE_V8_PLATFORM
7064
#include "v8-profiler.h"
71-
#include "zlib.h"
7265

7366
#ifdef NODE_ENABLE_VTUNE_PROFILING
7467
#include "../deps/v8/src/third_party/vtune/v8-vtune.h"
@@ -156,22 +149,6 @@ using v8::Value;
156149

157150
static bool v8_is_profiling = false;
158151

159-
#ifdef NODE_EXPERIMENTAL_HTTP
160-
static const char llhttp_version[] =
161-
NODE_STRINGIFY(LLHTTP_VERSION_MAJOR)
162-
"."
163-
NODE_STRINGIFY(LLHTTP_VERSION_MINOR)
164-
"."
165-
NODE_STRINGIFY(LLHTTP_VERSION_PATCH);
166-
#else /* !NODE_EXPERIMENTAL_HTTP */
167-
static const char http_parser_version[] =
168-
NODE_STRINGIFY(HTTP_PARSER_VERSION_MAJOR)
169-
"."
170-
NODE_STRINGIFY(HTTP_PARSER_VERSION_MINOR)
171-
"."
172-
NODE_STRINGIFY(HTTP_PARSER_VERSION_PATCH);
173-
#endif /* NODE_EXPERIMENTAL_HTTP */
174-
175152
// Bit flag used to track security reverts (see node_revert.h)
176153
unsigned int reverted = 0;
177154

@@ -210,27 +187,12 @@ class NodeTraceStateObserver :
210187
auto trace_process = tracing::TracedValue::Create();
211188
trace_process->BeginDictionary("versions");
212189

213-
#ifdef NODE_EXPERIMENTAL_HTTP
214-
trace_process->SetString("llhttp", llhttp_version);
215-
#else /* !NODE_EXPERIMENTAL_HTTP */
216-
trace_process->SetString("http_parser", http_parser_version);
217-
#endif /* NODE_EXPERIMENTAL_HTTP */
218-
219-
const char node_napi_version[] = NODE_STRINGIFY(NAPI_VERSION);
220-
const char node_modules_version[] = NODE_STRINGIFY(NODE_MODULE_VERSION);
190+
#define V(key) \
191+
trace_process->SetString(#key, per_process::metadata.versions.key.c_str());
221192

222-
trace_process->SetString("node", NODE_VERSION_STRING);
223-
trace_process->SetString("v8", V8::GetVersion());
224-
trace_process->SetString("uv", uv_version_string());
225-
trace_process->SetString("zlib", ZLIB_VERSION);
226-
trace_process->SetString("ares", ARES_VERSION_STR);
227-
trace_process->SetString("modules", node_modules_version);
228-
trace_process->SetString("nghttp2", NGHTTP2_VERSION);
229-
trace_process->SetString("napi", node_napi_version);
193+
NODE_VERSIONS_KEYS(V)
194+
#undef V
230195

231-
#if HAVE_OPENSSL
232-
trace_process->SetString("openssl", crypto::GetOpenSSLVersion());
233-
#endif
234196
trace_process->EndDictionary();
235197

236198
trace_process->SetString("arch", NODE_ARCH);
@@ -943,53 +905,10 @@ void SetupProcessObject(Environment* env,
943905
Local<Object> versions = Object::New(env->isolate());
944906
READONLY_PROPERTY(process, "versions", versions);
945907

946-
#ifdef NODE_EXPERIMENTAL_HTTP
947-
READONLY_PROPERTY(versions,
948-
"llhttp",
949-
FIXED_ONE_BYTE_STRING(env->isolate(), llhttp_version));
950-
#else /* !NODE_EXPERIMENTAL_HTTP */
951-
READONLY_PROPERTY(versions,
952-
"http_parser",
953-
FIXED_ONE_BYTE_STRING(env->isolate(), http_parser_version));
954-
#endif /* NODE_EXPERIMENTAL_HTTP */
955-
956-
// +1 to get rid of the leading 'v'
957-
READONLY_PROPERTY(versions,
958-
"node",
959-
OneByteString(env->isolate(), NODE_VERSION + 1));
960-
READONLY_PROPERTY(versions,
961-
"v8",
962-
OneByteString(env->isolate(), V8::GetVersion()));
963-
READONLY_PROPERTY(versions,
964-
"uv",
965-
OneByteString(env->isolate(), uv_version_string()));
966-
READONLY_PROPERTY(versions,
967-
"zlib",
968-
FIXED_ONE_BYTE_STRING(env->isolate(), ZLIB_VERSION));
969-
READONLY_PROPERTY(versions,
970-
"ares",
971-
FIXED_ONE_BYTE_STRING(env->isolate(), ARES_VERSION_STR));
972-
973-
const char node_modules_version[] = NODE_STRINGIFY(NODE_MODULE_VERSION);
974-
READONLY_PROPERTY(
975-
versions,
976-
"modules",
977-
FIXED_ONE_BYTE_STRING(env->isolate(), node_modules_version));
978-
READONLY_PROPERTY(versions,
979-
"nghttp2",
980-
FIXED_ONE_BYTE_STRING(env->isolate(), NGHTTP2_VERSION));
981-
const char node_napi_version[] = NODE_STRINGIFY(NAPI_VERSION);
982-
READONLY_PROPERTY(
983-
versions,
984-
"napi",
985-
FIXED_ONE_BYTE_STRING(env->isolate(), node_napi_version));
986-
987-
#if HAVE_OPENSSL
988-
READONLY_PROPERTY(
989-
versions,
990-
"openssl",
991-
OneByteString(env->isolate(), crypto::GetOpenSSLVersion().c_str()));
992-
#endif
908+
#define V(key) \
909+
READONLY_STRING_PROPERTY(versions, #key, per_process::metadata.versions.key);
910+
NODE_VERSIONS_KEYS(V)
911+
#undef V
993912

994913
// process.arch
995914
READONLY_PROPERTY(process, "arch", OneByteString(env->isolate(), NODE_ARCH));

‎src/node_metadata.cc

+49
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
#include "node_metadata.h"
2+
#include "ares.h"
3+
#include "nghttp2/nghttp2ver.h"
4+
#include "node.h"
5+
#include "util.h"
6+
#include "uv.h"
7+
#include "v8.h"
8+
#include "zlib.h"
9+
10+
#if HAVE_OPENSSL
11+
#include "node_crypto.h"
12+
#endif
13+
14+
#ifdef NODE_EXPERIMENTAL_HTTP
15+
#include "llhttp.h"
16+
#else /* !NODE_EXPERIMENTAL_HTTP */
17+
#include "http_parser.h"
18+
#endif /* NODE_EXPERIMENTAL_HTTP */
19+
20+
namespace node {
21+
22+
namespace per_process {
23+
Metadata metadata;
24+
}
25+
26+
Metadata::Versions::Versions() {
27+
node = NODE_VERSION_STRING;
28+
v8 = v8::V8::GetVersion();
29+
uv = uv_version_string();
30+
zlib = ZLIB_VERSION;
31+
ares = ARES_VERSION_STR;
32+
modules = NODE_STRINGIFY(NODE_MODULE_VERSION);
33+
nghttp2 = NGHTTP2_VERSION;
34+
napi = NODE_STRINGIFY(NAPI_VERSION);
35+
36+
#ifdef NODE_EXPERIMENTAL_HTTP
37+
llhttp = NODE_STRINGIFY(LLHTTP_VERSION_MAJOR) "." NODE_STRINGIFY(
38+
LLHTTP_VERSION_MINOR) "." NODE_STRINGIFY(LLHTTP_VERSION_PATCH);
39+
#else /* !NODE_EXPERIMENTAL_HTTP */
40+
http_parser = NODE_STRINGIFY(HTTP_PARSER_VERSION_MAJOR) "." NODE_STRINGIFY(
41+
HTTP_PARSER_VERSION_MINOR) "." NODE_STRINGIFY(HTTP_PARSER_VERSION_PATCH);
42+
#endif /* NODE_EXPERIMENTAL_HTTP */
43+
44+
#if HAVE_OPENSSL
45+
openssl = crypto::GetOpenSSLVersion();
46+
#endif
47+
}
48+
49+
} // namespace node

‎src/node_metadata.h

+57
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
#ifndef SRC_NODE_METADATA_H_
2+
#define SRC_NODE_METADATA_H_
3+
4+
#if defined(NODE_WANT_INTERNALS) && NODE_WANT_INTERNALS
5+
6+
#include <string>
7+
8+
namespace node {
9+
10+
#define NODE_VERSIONS_KEYS_BASE(V) \
11+
V(node) \
12+
V(v8) \
13+
V(uv) \
14+
V(zlib) \
15+
V(ares) \
16+
V(modules) \
17+
V(nghttp2) \
18+
V(napi)
19+
20+
#ifdef NODE_EXPERIMENTAL_HTTP
21+
#define NODE_VERSIONS_KEY_HTTP(V) V(llhttp)
22+
#else /* !NODE_EXPERIMENTAL_HTTP */
23+
#define NODE_VERSIONS_KEY_HTTP(V) V(http_parser)
24+
#endif /* NODE_EXPERIMENTAL_HTTP */
25+
26+
#if HAVE_OPENSSL
27+
#define NODE_VERSIONS_KEY_CRYPTO(V) V(openssl)
28+
#else
29+
#define NODE_VERSIONS_KEY_CRYPTO(V)
30+
#endif
31+
32+
#define NODE_VERSIONS_KEYS(V) \
33+
NODE_VERSIONS_KEYS_BASE(V) \
34+
NODE_VERSIONS_KEY_HTTP(V) \
35+
NODE_VERSIONS_KEY_CRYPTO(V)
36+
37+
class Metadata {
38+
public:
39+
struct Versions {
40+
Versions();
41+
#define V(key) std::string key;
42+
NODE_VERSIONS_KEYS(V)
43+
#undef V
44+
};
45+
46+
Versions versions;
47+
};
48+
49+
// Per-process global
50+
namespace per_process {
51+
extern Metadata metadata;
52+
}
53+
54+
} // namespace node
55+
56+
#endif // defined(NODE_WANT_INTERNALS) && NODE_WANT_INTERNALS
57+
#endif // SRC_NODE_METADATA_H_

0 commit comments

Comments
 (0)