Skip to content

Commit e71beba

Browse files
yhwangMylesBorins
yhwang
authored and
MylesBorins
committed
src: explicitly register built-in modules
Previously, built-in modules are registered before main() via __attribute__((constructor)) mechanism in GCC and similiar mechanism in MSVC. This causes some issues when node is built as static library. Calling module registration function for built-in modules in node::Init() helps to avoid the issues. Signed-off-by: Yihong Wang <[email protected]> Backport-PR-URL: #18179 PR-URL: #16565 Refs: #14986 (comment) Reviewed-By: Gireesh Punathil <[email protected]> Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: Ben Noordhuis <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Colin Ihrig <[email protected]>
1 parent 439112a commit e71beba

35 files changed

+167
-37
lines changed

‎node.gyp

+1
Original file line numberDiff line numberDiff line change
@@ -798,6 +798,7 @@
798798
'defines': [ 'NODE_WANT_INTERNALS=1' ],
799799

800800
'sources': [
801+
'test/cctest/node_module_reg.cc',
801802
'test/cctest/node_test_fixture.cc',
802803
'test/cctest/test_aliased_buffer.cc',
803804
'test/cctest/test_base64.cc',

‎src/async-wrap.cc

+1-2
Original file line numberDiff line numberDiff line change
@@ -729,8 +729,7 @@ void EmitAsyncDestroy(Isolate* isolate, async_context asyncContext) {
729729

730730
} // namespace node
731731

732-
NODE_MODULE_CONTEXT_AWARE_BUILTIN(async_wrap, node::AsyncWrap::Initialize)
733-
732+
NODE_BUILTIN_MODULE_CONTEXT_AWARE(async_wrap, node::AsyncWrap::Initialize)
734733

735734
// Only legacy public API below this line.
736735

‎src/cares_wrap.cc

+1-1
Original file line numberDiff line numberDiff line change
@@ -2241,4 +2241,4 @@ void Initialize(Local<Object> target,
22412241
} // namespace cares_wrap
22422242
} // namespace node
22432243

2244-
NODE_MODULE_CONTEXT_AWARE_BUILTIN(cares_wrap, node::cares_wrap::Initialize)
2244+
NODE_BUILTIN_MODULE_CONTEXT_AWARE(cares_wrap, node::cares_wrap::Initialize)

‎src/fs_event_wrap.cc

+1-1
Original file line numberDiff line numberDiff line change
@@ -222,4 +222,4 @@ void FSEventWrap::Close(const FunctionCallbackInfo<Value>& args) {
222222
} // anonymous namespace
223223
} // namespace node
224224

225-
NODE_MODULE_CONTEXT_AWARE_BUILTIN(fs_event_wrap, node::FSEventWrap::Initialize)
225+
NODE_BUILTIN_MODULE_CONTEXT_AWARE(fs_event_wrap, node::FSEventWrap::Initialize)

‎src/inspector_js_api.cc

+1-1
Original file line numberDiff line numberDiff line change
@@ -348,5 +348,5 @@ void InitInspectorBindings(Local<Object> target, Local<Value> unused,
348348
} // namespace inspector
349349
} // namespace node
350350

351-
NODE_MODULE_CONTEXT_AWARE_BUILTIN(inspector,
351+
NODE_BUILTIN_MODULE_CONTEXT_AWARE(inspector,
352352
node::inspector::InitInspectorBindings);

‎src/js_stream.cc

+1-1
Original file line numberDiff line numberDiff line change
@@ -251,4 +251,4 @@ void JSStream::Initialize(Local<Object> target,
251251

252252
} // namespace node
253253

254-
NODE_MODULE_CONTEXT_AWARE_BUILTIN(js_stream, node::JSStream::Initialize)
254+
NODE_BUILTIN_MODULE_CONTEXT_AWARE(js_stream, node::JSStream::Initialize)

‎src/node.cc

+22-2
Original file line numberDiff line numberDiff line change
@@ -120,6 +120,16 @@ typedef int mode_t;
120120
extern char **environ;
121121
#endif
122122

123+
// This is used to load built-in modules. Instead of using
124+
// __attribute__((constructor)), we call the _register_<modname>
125+
// function for each built-in modules explicitly in
126+
// node::RegisterBuiltinModules(). This is only forward declaration.
127+
// The definitions are in each module's implementation when calling
128+
// the NODE_BUILTIN_MODULE_CONTEXT_AWARE.
129+
#define V(modname) void _register_##modname();
130+
NODE_BUILTIN_MODULES(V)
131+
#undef V
132+
123133
namespace node {
124134

125135
using v8::Array;
@@ -4572,6 +4582,9 @@ void Init(int* argc,
45724582
// Initialize prog_start_time to get relative uptime.
45734583
prog_start_time = static_cast<double>(uv_now(uv_default_loop()));
45744584

4585+
// Register built-in modules
4586+
node::RegisterBuiltinModules();
4587+
45754588
// Make inherited handles noninheritable.
45764589
uv_disable_stdio_inheritance();
45774590

@@ -4947,11 +4960,18 @@ int Start(int argc, char** argv) {
49474960
return exit_code;
49484961
}
49494962

4963+
// Call built-in modules' _register_<module name> function to
4964+
// do module registration explicitly.
4965+
void RegisterBuiltinModules() {
4966+
#define V(modname) _register_##modname();
4967+
NODE_BUILTIN_MODULES(V)
4968+
#undef V
4969+
}
49504970

49514971
} // namespace node
49524972

49534973
#if !HAVE_INSPECTOR
4954-
static void InitEmptyBindings() {}
4974+
void InitEmptyBindings() {}
49554975

4956-
NODE_MODULE_CONTEXT_AWARE_BUILTIN(inspector, InitEmptyBindings)
4976+
NODE_BUILTIN_MODULE_CONTEXT_AWARE(inspector, InitEmptyBindings)
49574977
#endif // !HAVE_INSPECTOR

‎src/node_buffer.cc

+1-1
Original file line numberDiff line numberDiff line change
@@ -1304,4 +1304,4 @@ void Initialize(Local<Object> target,
13041304
} // namespace Buffer
13051305
} // namespace node
13061306

1307-
NODE_MODULE_CONTEXT_AWARE_BUILTIN(buffer, node::Buffer::Initialize)
1307+
NODE_BUILTIN_MODULE_CONTEXT_AWARE(buffer, node::Buffer::Initialize)

‎src/node_config.cc

+1-1
Original file line numberDiff line numberDiff line change
@@ -129,4 +129,4 @@ static void InitConfig(Local<Object> target,
129129

130130
} // namespace node
131131

132-
NODE_MODULE_CONTEXT_AWARE_BUILTIN(config, node::InitConfig)
132+
NODE_BUILTIN_MODULE_CONTEXT_AWARE(config, node::InitConfig)

‎src/node_contextify.cc

+1-1
Original file line numberDiff line numberDiff line change
@@ -1085,4 +1085,4 @@ void InitContextify(Local<Object> target,
10851085
} // anonymous namespace
10861086
} // namespace node
10871087

1088-
NODE_MODULE_CONTEXT_AWARE_BUILTIN(contextify, node::InitContextify)
1088+
NODE_BUILTIN_MODULE_CONTEXT_AWARE(contextify, node::InitContextify)

‎src/node_crypto.cc

+1-1
Original file line numberDiff line numberDiff line change
@@ -6195,4 +6195,4 @@ void InitCrypto(Local<Object> target,
61956195
} // namespace crypto
61966196
} // namespace node
61976197

6198-
NODE_MODULE_CONTEXT_AWARE_BUILTIN(crypto, node::crypto::InitCrypto)
6198+
NODE_BUILTIN_MODULE_CONTEXT_AWARE(crypto, node::crypto::InitCrypto)

‎src/node_file.cc

+1-1
Original file line numberDiff line numberDiff line change
@@ -1518,4 +1518,4 @@ void InitFs(Local<Object> target,
15181518

15191519
} // end namespace node
15201520

1521-
NODE_MODULE_CONTEXT_AWARE_BUILTIN(fs, node::InitFs)
1521+
NODE_BUILTIN_MODULE_CONTEXT_AWARE(fs, node::InitFs)

‎src/node_http2.cc

+1-1
Original file line numberDiff line numberDiff line change
@@ -2250,4 +2250,4 @@ HTTP_STATUS_CODES(V)
22502250
} // namespace http2
22512251
} // namespace node
22522252

2253-
NODE_MODULE_CONTEXT_AWARE_BUILTIN(http2, node::http2::Initialize)
2253+
NODE_BUILTIN_MODULE_CONTEXT_AWARE(http2, node::http2::Initialize)

‎src/node_http_parser.cc

+1-1
Original file line numberDiff line numberDiff line change
@@ -810,4 +810,4 @@ void InitHttpParser(Local<Object> target,
810810
} // anonymous namespace
811811
} // namespace node
812812

813-
NODE_MODULE_CONTEXT_AWARE_BUILTIN(http_parser, node::InitHttpParser)
813+
NODE_BUILTIN_MODULE_CONTEXT_AWARE(http_parser, node::InitHttpParser)

‎src/node_i18n.cc

+1-1
Original file line numberDiff line numberDiff line change
@@ -874,6 +874,6 @@ void Init(Local<Object> target,
874874
} // namespace i18n
875875
} // namespace node
876876

877-
NODE_MODULE_CONTEXT_AWARE_BUILTIN(icu, node::i18n::Init)
877+
NODE_BUILTIN_MODULE_CONTEXT_AWARE(icu, node::i18n::Init)
878878

879879
#endif // NODE_HAVE_I18N_SUPPORT

‎src/node_internals.h

+83-3
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,81 @@ struct sockaddr;
5656
constant_attributes).FromJust(); \
5757
} while (0)
5858

59+
60+
#if HAVE_OPENSSL
61+
#define NODE_BUILTIN_OPENSSL_MODULES(V) V(crypto) V(tls_wrap)
62+
#else
63+
#define NODE_BUILTIN_OPENSSL_MODULES(V)
64+
#endif
65+
66+
#if NODE_HAVE_I18N_SUPPORT
67+
#define NODE_BUILTIN_ICU_MODULES(V) V(icu)
68+
#else
69+
#define NODE_BUILTIN_ICU_MODULES(V)
70+
#endif
71+
72+
// A list of built-in modules. In order to do module registration
73+
// in node::Init(), need to add built-in modules in the following list.
74+
// Then in node::RegisterBuiltinModules(), it calls modules' registration
75+
// function. This helps the built-in modules are loaded properly when
76+
// node is built as static library. No need to depends on the
77+
// __attribute__((constructor)) like mechanism in GCC.
78+
#define NODE_BUILTIN_STANDARD_MODULES(V) \
79+
V(async_wrap) \
80+
V(buffer) \
81+
V(cares_wrap) \
82+
V(config) \
83+
V(contextify) \
84+
V(fs) \
85+
V(fs_event_wrap) \
86+
V(http2) \
87+
V(http_parser) \
88+
V(inspector) \
89+
V(js_stream) \
90+
V(module_wrap) \
91+
V(os) \
92+
V(performance) \
93+
V(pipe_wrap) \
94+
V(process_wrap) \
95+
V(serdes) \
96+
V(signal_wrap) \
97+
V(spawn_sync) \
98+
V(stream_wrap) \
99+
V(tcp_wrap) \
100+
V(timer_wrap) \
101+
V(tty_wrap) \
102+
V(udp_wrap) \
103+
V(url) \
104+
V(util) \
105+
V(uv) \
106+
V(v8) \
107+
V(zlib)
108+
109+
#define NODE_BUILTIN_MODULES(V) \
110+
NODE_BUILTIN_STANDARD_MODULES(V) \
111+
NODE_BUILTIN_OPENSSL_MODULES(V) \
112+
NODE_BUILTIN_ICU_MODULES(V)
113+
114+
#define NODE_MODULE_CONTEXT_AWARE_CPP(modname, regfunc, priv, flags) \
115+
static node::node_module _module = { \
116+
NODE_MODULE_VERSION, \
117+
flags, \
118+
nullptr, \
119+
__FILE__, \
120+
nullptr, \
121+
(node::addon_context_register_func) (regfunc), \
122+
NODE_STRINGIFY(modname), \
123+
priv, \
124+
nullptr \
125+
}; \
126+
void _register_ ## modname() { \
127+
node_module_register(&_module); \
128+
}
129+
130+
131+
#define NODE_BUILTIN_MODULE_CONTEXT_AWARE(modname, regfunc) \
132+
NODE_MODULE_CONTEXT_AWARE_CPP(modname, regfunc, nullptr, NM_F_BUILTIN)
133+
59134
namespace node {
60135

61136
// Set in node.cc by ParseArgs with the value of --openssl-config.
@@ -182,6 +257,12 @@ void SetupProcessObject(Environment* env,
182257
int exec_argc,
183258
const char* const* exec_argv);
184259

260+
// Call _register<module_name> functions for all of
261+
// the built-in modules. Because built-in modules don't
262+
// use the __attribute__((constructor)). Need to
263+
// explicitly call the _register* functions.
264+
void RegisterBuiltinModules();
265+
185266
enum Endianness {
186267
kLittleEndian, // _Not_ LITTLE_ENDIAN, clashes with endian.h.
187268
kBigEndian
@@ -305,9 +386,8 @@ class InternalCallbackScope {
305386
bool closed_ = false;
306387
};
307388

308-
#define NODE_MODULE_CONTEXT_AWARE_INTERNAL(modname, regfunc) \
309-
/* NOLINTNEXTLINE (readability/null_usage) */ \
310-
NODE_MODULE_CONTEXT_AWARE_X(modname, regfunc, NULL, NM_F_INTERNAL) \
389+
#define NODE_MODULE_CONTEXT_AWARE_INTERNAL(modname, regfunc) \
390+
NODE_MODULE_CONTEXT_AWARE_CPP(modname, regfunc, nullptr, NM_F_INTERNAL)
311391

312392
} // namespace node
313393

‎src/node_os.cc

+1-1
Original file line numberDiff line numberDiff line change
@@ -430,4 +430,4 @@ void Initialize(Local<Object> target,
430430
} // namespace os
431431
} // namespace node
432432

433-
NODE_MODULE_CONTEXT_AWARE_BUILTIN(os, node::os::Initialize)
433+
NODE_BUILTIN_MODULE_CONTEXT_AWARE(os, node::os::Initialize)

‎src/node_perf.cc

+1-1
Original file line numberDiff line numberDiff line change
@@ -390,4 +390,4 @@ void Init(Local<Object> target,
390390
} // namespace performance
391391
} // namespace node
392392

393-
NODE_MODULE_CONTEXT_AWARE_BUILTIN(performance, node::performance::Init)
393+
NODE_BUILTIN_MODULE_CONTEXT_AWARE(performance, node::performance::Init)

‎src/node_serdes.cc

+1-1
Original file line numberDiff line numberDiff line change
@@ -483,4 +483,4 @@ void InitializeSerdesBindings(Local<Object> target,
483483
} // anonymous namespace
484484
} // namespace node
485485

486-
NODE_MODULE_CONTEXT_AWARE_BUILTIN(serdes, node::InitializeSerdesBindings)
486+
NODE_BUILTIN_MODULE_CONTEXT_AWARE(serdes, node::InitializeSerdesBindings)

‎src/node_url.cc

+1-1
Original file line numberDiff line numberDiff line change
@@ -2220,4 +2220,4 @@ static void Init(Local<Object> target,
22202220
} // namespace url
22212221
} // namespace node
22222222

2223-
NODE_MODULE_CONTEXT_AWARE_BUILTIN(url, node::url::Init)
2223+
NODE_BUILTIN_MODULE_CONTEXT_AWARE(url, node::url::Init)

‎src/node_util.cc

+1-1
Original file line numberDiff line numberDiff line change
@@ -238,4 +238,4 @@ void Initialize(Local<Object> target,
238238
} // namespace util
239239
} // namespace node
240240

241-
NODE_MODULE_CONTEXT_AWARE_BUILTIN(util, node::util::Initialize)
241+
NODE_BUILTIN_MODULE_CONTEXT_AWARE(util, node::util::Initialize)

‎src/node_v8.cc

+2-1
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@
2020
// USE OR OTHER DEALINGS IN THE SOFTWARE.
2121

2222
#include "node.h"
23+
#include "node_internals.h"
2324
#include "env-inl.h"
2425
#include "util-inl.h"
2526
#include "v8.h"
@@ -206,4 +207,4 @@ void InitializeV8Bindings(Local<Object> target,
206207

207208
} // namespace node
208209

209-
NODE_MODULE_CONTEXT_AWARE_BUILTIN(v8, node::InitializeV8Bindings)
210+
NODE_BUILTIN_MODULE_CONTEXT_AWARE(v8, node::InitializeV8Bindings)

‎src/node_zlib.cc

+1-1
Original file line numberDiff line numberDiff line change
@@ -701,4 +701,4 @@ void InitZlib(Local<Object> target,
701701
} // anonymous namespace
702702
} // namespace node
703703

704-
NODE_MODULE_CONTEXT_AWARE_BUILTIN(zlib, node::InitZlib)
704+
NODE_BUILTIN_MODULE_CONTEXT_AWARE(zlib, node::InitZlib)

‎src/pipe_wrap.cc

+1-1
Original file line numberDiff line numberDiff line change
@@ -203,4 +203,4 @@ void PipeWrap::Connect(const FunctionCallbackInfo<Value>& args) {
203203

204204
} // namespace node
205205

206-
NODE_MODULE_CONTEXT_AWARE_BUILTIN(pipe_wrap, node::PipeWrap::Initialize)
206+
NODE_BUILTIN_MODULE_CONTEXT_AWARE(pipe_wrap, node::PipeWrap::Initialize)

‎src/process_wrap.cc

+1-1
Original file line numberDiff line numberDiff line change
@@ -311,4 +311,4 @@ class ProcessWrap : public HandleWrap {
311311
} // anonymous namespace
312312
} // namespace node
313313

314-
NODE_MODULE_CONTEXT_AWARE_BUILTIN(process_wrap, node::ProcessWrap::Initialize)
314+
NODE_BUILTIN_MODULE_CONTEXT_AWARE(process_wrap, node::ProcessWrap::Initialize)

‎src/signal_wrap.cc

+1-1
Original file line numberDiff line numberDiff line change
@@ -127,4 +127,4 @@ class SignalWrap : public HandleWrap {
127127
} // namespace node
128128

129129

130-
NODE_MODULE_CONTEXT_AWARE_BUILTIN(signal_wrap, node::SignalWrap::Initialize)
130+
NODE_BUILTIN_MODULE_CONTEXT_AWARE(signal_wrap, node::SignalWrap::Initialize)

‎src/spawn_sync.cc

+1-1
Original file line numberDiff line numberDiff line change
@@ -1081,5 +1081,5 @@ void SyncProcessRunner::KillTimerCloseCallback(uv_handle_t* handle) {
10811081

10821082
} // namespace node
10831083

1084-
NODE_MODULE_CONTEXT_AWARE_BUILTIN(spawn_sync,
1084+
NODE_BUILTIN_MODULE_CONTEXT_AWARE(spawn_sync,
10851085
node::SyncProcessRunner::Initialize)

‎src/stream_wrap.cc

+1-1
Original file line numberDiff line numberDiff line change
@@ -399,5 +399,5 @@ void LibuvStreamWrap::OnAfterWriteImpl(WriteWrap* w, void* ctx) {
399399

400400
} // namespace node
401401

402-
NODE_MODULE_CONTEXT_AWARE_BUILTIN(stream_wrap,
402+
NODE_BUILTIN_MODULE_CONTEXT_AWARE(stream_wrap,
403403
node::LibuvStreamWrap::Initialize)

‎src/tcp_wrap.cc

+1-1
Original file line numberDiff line numberDiff line change
@@ -360,4 +360,4 @@ Local<Object> AddressToJS(Environment* env,
360360

361361
} // namespace node
362362

363-
NODE_MODULE_CONTEXT_AWARE_BUILTIN(tcp_wrap, node::TCPWrap::Initialize)
363+
NODE_BUILTIN_MODULE_CONTEXT_AWARE(tcp_wrap, node::TCPWrap::Initialize)

‎src/timer_wrap.cc

+1-1
Original file line numberDiff line numberDiff line change
@@ -137,4 +137,4 @@ class TimerWrap : public HandleWrap {
137137
} // anonymous namespace
138138
} // namespace node
139139

140-
NODE_MODULE_CONTEXT_AWARE_BUILTIN(timer_wrap, node::TimerWrap::Initialize)
140+
NODE_BUILTIN_MODULE_CONTEXT_AWARE(timer_wrap, node::TimerWrap::Initialize)

‎src/tls_wrap.cc

+1-1
Original file line numberDiff line numberDiff line change
@@ -982,4 +982,4 @@ void TLSWrap::Initialize(Local<Object> target,
982982

983983
} // namespace node
984984

985-
NODE_MODULE_CONTEXT_AWARE_BUILTIN(tls_wrap, node::TLSWrap::Initialize)
985+
NODE_BUILTIN_MODULE_CONTEXT_AWARE(tls_wrap, node::TLSWrap::Initialize)

‎src/tty_wrap.cc

+1-1
Original file line numberDiff line numberDiff line change
@@ -175,4 +175,4 @@ TTYWrap::TTYWrap(Environment* env,
175175

176176
} // namespace node
177177

178-
NODE_MODULE_CONTEXT_AWARE_BUILTIN(tty_wrap, node::TTYWrap::Initialize)
178+
NODE_BUILTIN_MODULE_CONTEXT_AWARE(tty_wrap, node::TTYWrap::Initialize)

‎src/udp_wrap.cc

+1-1
Original file line numberDiff line numberDiff line change
@@ -511,4 +511,4 @@ uv_udp_t* UDPWrap::UVHandle() {
511511

512512
} // namespace node
513513

514-
NODE_MODULE_CONTEXT_AWARE_BUILTIN(udp_wrap, node::UDPWrap::Initialize)
514+
NODE_BUILTIN_MODULE_CONTEXT_AWARE(udp_wrap, node::UDPWrap::Initialize)

‎src/uv.cc

+2-1
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@
2121

2222
#include "uv.h"
2323
#include "node.h"
24+
#include "node_internals.h"
2425
#include "env-inl.h"
2526

2627
namespace node {
@@ -61,4 +62,4 @@ void InitializeUV(Local<Object> target,
6162
} // anonymous namespace
6263
} // namespace node
6364

64-
NODE_MODULE_CONTEXT_AWARE_BUILTIN(uv, node::InitializeUV)
65+
NODE_BUILTIN_MODULE_CONTEXT_AWARE(uv, node::InitializeUV)

0 commit comments

Comments
 (0)