Node.jsNode.jsNode.js

nodejs模块加载分析(1)

2018-09-12  本文已影响5人  妖怪来了

前言

上篇 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 这个方法谁调用的呢,下次来进行分析~

上一篇下一篇

猜你喜欢

热点阅读