重慶分公司,新征程啟航
為企業提供網站建設、域名注冊、服務器等服務
為企業提供網站建設、域名注冊、服務器等服務
title: Node.js 源碼分析 - 原生模塊(C++模塊)的注冊
date: 2018-11-28 21:04:49
tags:
- Node.js
- Node.js 源碼分析
- 源碼分析
categories:
- Node.js 源碼分析
此文最初于四年前發布在個人站上的,現遷移至此重發,原鏈接:https://laogen.site/nodejs/nodejs-src/register-builtin-modules/
《Node.js 源碼分析》 系列目錄頁:https://laogen.site/nodejs/nodejs-src/index/
創新互聯是一家集網站建設,東安企業網站建設,東安品牌網站建設,網站定制,東安網站建設報價,網絡營銷,網絡優化,東安網站推廣為一體的創新建站企業,幫助傳統企業提升企業形象加強企業競爭力。可充分滿足這一群體相比中小企業更為豐富、高端、多元的互聯網需求。同時我們時刻保持專業、時尚、前沿,時刻以成就客戶成長自我,堅持不斷學習、思考、沉淀、凈化自己,讓我們為更多的企業打造出實用型網站。
上一篇提到 RegisterBuiltinModules()
注冊了原生 C++ 模塊沒有詳細展開,這里就從這個函數展開。
/* src/node.cc:3066 */
void RegisterBuiltinModules() {
#define V(modname) _register_##modname();
NODE_BUILTIN_MODULES(V)
#undef V
}
首先定義了一個宏 V
為 _register_##modname()
, 可以看出 V
展開后是一個函數調用類似這樣: _register_xx()
;
隨后,RegisterBuiltinModules()
實際是宏 NODE_BUILTIN_MODULES(V)
來實現的,我們看看它的定義:
/* src/node_internals.h:147 */
#define NODE_BUILTIN_MODULES(V) \
NODE_BUILTIN_STANDARD_MODULES(V)
// ...
進一步查看 NODE_BUILTIN_STANDARD_MODULES(V)
的定義:
/* src/node_internals.h:106 */
#define NODE_BUILTIN_STANDARD_MODULES(V) \
V(async_wrap) \
V(buffer) \
V(cares_wrap) \
V(config) \
V(contextify) \
V(domain) \
V(fs) \
V(fs_event_wrap) \
V(heap_utils) \
V(http2) \
V(http_parser) \
V(inspector) \
V(js_stream) \
V(messaging) \
V(module_wrap) \
V(options) \
V(os) \
V(performance) \
V(pipe_wrap) \
V(process_wrap) \
V(serdes) \
V(signal_wrap) \
V(spawn_sync) \
V(stream_pipe) \
V(stream_wrap) \
V(string_decoder) \
V(symbols) \
V(tcp_wrap) \
V(timer_wrap) \
V(trace_events) \
V(tty_wrap) \
V(types) \
V(udp_wrap) \
V(url) \
V(util) \
V(uv) \
V(v8) \
V(worker) \
V(zlib)
這個宏定義中多次調用宏 V
,還記得這個宏嗎,在上面定義的:#define V(modname) _register_##modname();
,那我們把它展開后就是:
/* src/node_internals.h:106 */
#define NODE_BUILTIN_STANDARD_MODULES(V) \
_register_async_wrap();
_register_buffer();
_register_cares_wrap();
_register_config();
_register_contextify();
_register_domain();
_register_fs();
_register_fs_event_wrap();
_register_heap_utils();
_register_http2();
_register_http_parser();
_register_inspector();
_register_js_stream();
_register_messaging();
_register_module_wrap();
_register_options();
_register_os();
_register_performance();
_register_pipe_wrap();
_register_process_wrap();
_register_serdes();
_register_signal_wrap();
_register_spawn_sync();
_register_stream_pipe();
_register_stream_wrap();
_register_string_decoder();
_register_symbols();
_register_tcp_wrap();
_register_timer_wrap();
_register_trace_events();
_register_tty_wrap();
_register_types();
_register_udp_wrap();
_register_url();
_register_util();
_register_uv();
_register_v8();
_register_worker();
_register_zlib();
最終,RegisterBuiltinModules()
展開后大概是這樣的:
void RegisterBuiltinModules() {
_register_async_wrap();
_register_buffer();
// ...
_register_os();
// ...
}
經過層層的宏展開,我們看到 RegisterBuiltinModules()
的原貌,就是調用了一些全局注冊函數,這樣就能理解了。
接下來,我們打算看看這些注冊函數是在哪里定義的。 我全局搜索了整個代碼目錄,也沒找到這些函數中的任何一個,看來又是通過宏定義的。
那我們就挑一個原生模塊的源碼,來看看里面有沒有上面注冊函數的定義,我挑了模塊名為 os
的模塊,它的源碼位于 src/node_os.cc
:
/* src/node_os.cc */
namespace node {
namespace os {
// ...
static void GetHostname(const FunctionCallbackInfo& args) {
// ...
}
static void GetOSType(const FunctionCallbackInfo& args) {
// ...
}
static void GetOSRelease(const FunctionCallbackInfo& args) {
// ...
}
static void GetCPUInfo(const FunctionCallbackInfo& args) {
// ...
}
static void GetFreeMemory(const FunctionCallbackInfo& args) {
// ...
}
static void GetTotalMemory(const FunctionCallbackInfo& args) {
// ...
}
static void GetUptime(const FunctionCallbackInfo& args) {
// ...
}
static void GetLoadAvg(const FunctionCallbackInfo& args) {
// ...
}
static void GetInterfaceAddresses(const FunctionCallbackInfo& args) {
// ...
}
static void GetHomeDirectory(const FunctionCallbackInfo& args) {
// ...
}
static void GetUserInfo(const FunctionCallbackInfo& args) {
// ...
}
static void SetPriority(const FunctionCallbackInfo& args) {
// ...
}
static void GetPriority(const FunctionCallbackInfo& args) {
// ...
}
// 這個初始化函數是每個原生模塊都會定義的,它的參數也是一致的
void Initialize(Local
這個 os
模塊先是定義了一些函數,代碼最后一行是個宏調用,這個宏把模塊名 os
和 Initialize
函數做為其參數,我們找到它的定義如下:
/* src/node_internals.h:169 */
#define NODE_BUILTIN_MODULE_CONTEXT_AWARE(modname, regfunc) \
NODE_MODULE_CONTEXT_AWARE_CPP(modname, regfunc, nullptr, NM_F_BUILTIN)
又是一個宏定義,繼續跟下去:
/* src/node_internals.h:152*/
#define NODE_MODULE_CONTEXT_AWARE_CPP(modname, regfunc, priv, flags) \
static node::node_module _module = { \
NODE_MODULE_VERSION, \
flags, \
nullptr, \
__FILE__, \
nullptr, \
(node::addon_context_register_func) (regfunc), \
NODE_STRINGIFY(modname), \
priv, \
nullptr \
}; \
void _register_ ## modname() { \
node_module_register(&_module); \
}
這個宏的定義里好像看到了我們要找的代碼,我們在這里就可以把 NODE_BUILTIN_MODULE_CONTEXT_AWARE(os, node::os::Initialize)
完全展開了:
// 創建一個 node_module 對象 _module
static node::node_module _module = {
NODE_MODULE_VERSION,
NM_F_BUILTIN,
nullptr,
__FILE__,
nullptr,
(node::addon_context_register_func) (node::os::Initialize),
NODE_STRINGIFY(os),
nullptr,
nullptr
};
// 定義我們要找的 _register_os() 函數
void _register_os() {
node_module_register(&_module);
}
到此,我們就明白了 RegisterBuiltinModules()
函數中調用的 _register_os()
是在哪里定義的了,隨后查看了所有原生模塊的代碼,最后一行都是以同樣的方式定義相應的 _register_xx()
。
其中 node::node_module
類型就代表一個模塊的信息。
所謂注冊 os
模塊實際是調用了 node_module_register(node_module *)
函數完成的,我們繼續來看看 node_module_register()
函數和 node::node_module
:
/* src/node.h:518*/
struct node_module {
int nm_version;
unsigned int nm_flags;
void* nm_dso_handle;
const char* nm_filename;
// 上例中 Initialize 函數被賦到 nm_register_func 里
node::addon_register_func nm_register_func;
node::addon_context_register_func nm_context_register_func;
const char* nm_modname; // 模塊的名字
void* nm_priv;
struct node_module* nm_link;
};
/* src/node.cc:1094 */
extern "C" void node_module_register(void* m) {
struct node_module* mp = reinterpret_cast(m);
if (mp->nm_flags & NM_F_BUILTIN) {
// 鏈表操作
mp->nm_link = modlist_builtin;
modlist_builtin = mp;
} else if (mp->nm_flags & NM_F_INTERNAL) {
// 鏈表操作
mp->nm_link = modlist_internal;
modlist_internal = mp;
} else if (!node_is_initialized) {
// "Linked" modules are included as part of the node project.
// Like builtins they are registered *before* node::Init runs.
mp->nm_flags = NM_F_LINKED;
mp->nm_link = modlist_linked;
modlist_linked = mp;
} else {
uv_key_set(&thread_local_modpending, mp);
}
}
到這里就清晰了, 所謂原生模塊的注冊,實際上就是將一個類型為 node::node_module
的模塊對象,添加到不同類別的全局鏈表中。
上述代碼中用3個全局鏈表:modlist_builtin
modlist_internal
modlist_linked
分別保存不同類型的模塊,本文我們說的是 BUILTIN
類型的,也就是第一個。
我把這幾個鏈表的定義位置發出來:
/* src/node.cc:175 */
static node_module* modlist_builtin; // 我們現在只關注 builtin 模塊
static node_module* modlist_internal;
static node_module* modlist_linked;
static node_module* modlist_addon;
這個原生模塊的注冊過程就寫到這里,邏輯還是比較簡單的,只是連續的宏定義讓代碼不那么直觀。
原生模塊加載寫完后,接下來,會繼續寫原生模塊的加載篇。
Maslow (wangfugen@126.com), laf.js 作者。
lafyun.com 開源云開發平臺,前端變全棧,無需服務端。