nodejs模块加载分析(1)

前言

上篇 nodejs 启动流程分析中,遗留了几个问题。这一篇,主要讲讲模块加载流程。大家都应该熟悉 timer 模块的相关功能。我们就以 timer 为引子,一步步看下去吧。

C++ init 方法开始

下列函数都在 src/node.cc 中:

void Init(std::vector<std::string>* argv,
          std::vector<std::string>* exec_argv) {
  ...
  // 注册内部模块。
  RegisterBuiltinModules();
  ...
}

乍一看,这个 RegisterBuiltinModules 方法应该就是关键所在了。那看看他是什么吧。

void RegisterBuiltinModules() {
#define V(modname) _register_##modname();
  NODE_BUILTIN_MODULES(V)
#undef V
}

原来不是方法,而是一个宏定义。那我们再看看 NODE_BUILTIN_MODULES 这个是什么吧。下列文件位于src/node_internals.h 中:

#define NODE_BUILTIN_MODULES(V)                                               \
  NODE_BUILTIN_STANDARD_MODULES(V)                                            \
  NODE_BUILTIN_OPENSSL_MODULES(V)                                             \
  NODE_BUILTIN_ICU_MODULES(V)

乖乖,又是一个宏。简直就是宏的地狱。让我们耐着性子,再往下看看。

#define NODE_BUILTIN_STANDARD_MODULES(V)                                      \
    V(async_wrap)                                                             \
    ...
    V(timer)                                                                 \

其他两个宏类似,就不放上来了。在这个宏里面,貌似看到了想要查找的 timer 。那我们把这个三个宏合成一下,看看是什么吧。

_register_timer();

其他类似,不再赘述。原来这个宏就是依次调用了 _register_xx 方法。插一句,在 C++ 宏里面,## 代表字符串连接。相当于用 ## 之前的字符串 拼接上 ## 之后的字符串。现在看来,找到这个 _register_timer() 方法就是关键了。全文搜索一下 _register_timer() 方法,发现无法找到。再尝试搜索一下 register 这个关键字,可以找到一个宏如下,在文件src/node_internals.h中:

#define NODE_MODULE_CONTEXT_AWARE_CPP(modname, regfunc, priv, flags)          \
  static node::node_module _module = {                                        \
    NODE_MODULE_VERSION,   /*版本号*/                                          \
    flags,                 /*模块类型,builtin,internal,linked*/                \
    nullptr,               /*nm_dso_handle. 未知*/                             \
    __FILE__,              /*文件名*/                                          \
    nullptr,               /*注册方法*/                                         \
    (node::addon_context_register_func) (regfunc),    /*注册上下文*/            \
    NODE_STRINGIFY(modname),          /*模块名*/                               \
    priv,                             /*私有*/                                 \
    nullptr                           /*下一个 node_module 模块节点*/            \
  };                                                                          \
  void _register_ ## modname() {                                              \
    node_module_register(&_module);                                           \
  }

可以看到,这个宏定义了一个结构体,node_module 是在 src/node.h里面定义的。这个宏把模块名,注册方法,私有指针,模块类型传递进来了。然后还定义了一个方法,就是我们要找的 _register_##modname方法。其中又调用了 mode_module_register 方法。此处我们先不着急看实现,而是先去看看是谁调用了这个宏。搜索下来发现,在文件src/node_internals.h中有这样一个宏:

#define NODE_MODULE_CONTEXT_AWARE_INTERNAL(modname, regfunc)                  \
  NODE_MODULE_CONTEXT_AWARE_CPP(modname, regfunc, nullptr, NM_F_INTERNAL)

NODE_MODULE_CONTEXT_AWARE_INTERNAL 这个宏调用了上面的宏,并且将模块名,注册方法传递进来,私有变量传null,模块类型传内置模块类型。接着再看看谁调用了NODE_MODULE_CONTEXT_AWARE_INTERNAL。搜索可以看到很多处调用,我们找到我们关心的 src/timers.cc文件查看:

void Initialize(Local<Object> target,
                       Local<Value> unused,
                       Local<Context> context) {
  ...
  env->SetMethod(target, "getLibuvNow", GetLibuvNow);
  ...
  target->Set(env->context(),
              FIXED_ONE_BYTE_STRING(env->isolate(), "immediateInfo"),
              env->immediate_info()->fields().GetJSArray()).FromJust();
}
NODE_MODULE_CONTEXT_AWARE_INTERNAL(timers, node::Initialize)

可以看到,模块名参数就是 timers, 初始化方法参数传递的是 Initialize 方法。到这,算是找到调用根源了。那我们接着看看 node_module_register 方法干了些什么。此方法在 src/node.cc中:

extern "C" void node_module_register(void* m) {
  struct node_module* mp = reinterpret_cast<struct node_module*>(m);
  ...
  else if (mp->nm_flags & NM_F_INTERNAL) {
    mp->nm_link = modlist_internal;
    modlist_internal = mp;
  }
  ...
}

你会惊奇的发现,这里仅仅是把所有的模块依次链接起来,形成一个链表。没有调用呀?没有初始化啊?此处注意一下变量modlist_internal,后面会用到。这里有一个 GetInternalBinding 。他被绑定到 global 对象上,会被 js 调用。此方法是必须结合js源码才能明白出处。此方法在src/node.cc中:

static void GetInternalBinding(const FunctionCallbackInfo<Value>& args) {
  ...//获取参数名。
  Local<String> module = args[0].As<String>();
  ...//获取内部模块。
  node_module* mod = get_internal_module(*module_v);
  if (mod != nullptr) {
      // 初始化。
    exports = InitModule(env, mod, module);
  }
  ...
}

让我们看看 get_builtin_module 方法,此方法在src/node.cc中:

node_module* get_internal_module(const char* name) {
  return FindModule(modlist_internal, name, NM_F_INTERNAL);
}

inline struct node_module* FindModule(struct node_module* list,
                                      const char* name,
                                      int flag) {
  struct node_module* mp;
  for (mp = list; mp != nullptr; mp = mp->nm_link) {
    if (strcmp(mp->nm_modname, name) == 0)
      break;
  }
  ...
  return mp;
}

方法内部调用了 FindModule 方法。第一个参数熟悉吗?modlist_internal!就是通过上面的 RegisterBuiltinModules 方法来生成的模块。具体的查找过程也比较简单,就是遍历这个链表,一个个比较模块名,是否相同,然后拿到模块。再继续看一下 InitModule 方法,同样位于src/node.cc

static Local<Object> InitModule(Environment* env,
                                 node_module* mod,
                                 Local<String> module) {
  ...//直接调用node_module模块的注册上下文的方法,并传入对应的一些参数。
  mod->nm_context_register_func(exports,
                                unused,
                                env->context(),
                                mod->nm_priv);
  return exports;
}

回想下上面的 timer.cc 中的 Initialize 方法,此处就是调用的地点了。至此,模块就加载到程序当中了。

尾言

分析过程中,会遇到很多的宏处理,此时可以将宏一个个展开,然后写到纸上进行分析。否则一眼很难看的清全貌。

通过本文,应该对 RegisterModules,和如何初始化模块应该有了一个大致的了解。但是你可能还是会有一些迷惑,比如 GetInternalBinding 这个方法谁调用的呢,下次来进行分析~

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 194,242评论 5 459
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 81,769评论 2 371
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 141,484评论 0 319
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 52,133评论 1 263
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 61,007评论 4 355
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 46,080评论 1 272
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 36,496评论 3 381
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 35,190评论 0 253
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 39,464评论 1 290
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 34,549评论 2 309
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 36,330评论 1 326
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 32,205评论 3 312
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 37,567评论 3 298
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 28,889评论 0 17
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,160评论 1 250
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 41,475评论 2 341
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 40,650评论 2 335

推荐阅读更多精彩内容

  • 前言 js是从网页小脚本演变过来的,至今,前端的js库,也不像一个真正的模块。前端js经历了工具类库、组件库、前端...
    白昔月阅读 3,264评论 2 11
  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,494评论 18 139
  • 一、什么是wire mock 什么是mock技术 对于某些不容易构造或者不容易获取的对象,用一个虚拟的对象来创建以...
    chuckielove阅读 4,241评论 0 8
  • 整部《速度与激情8》下来,我只记住了一句话:“That’s my girl !” 作为一名伪影迷,关于剧情和情怀就...
    甜点再甜点_阅读 1,101评论 8 9
  • 我早就意识到,自己是一个懒人。且患有严重“拖延症”。作业必留到最后写,久了以后,一个后果:晚上总是不够睡。 一天清...
    良玖阅读 218评论 0 0