[{"_1":2,"_3":-5,"_4":-5},"loaderData",{"_5":6,"_7":8},"actionData","errors","root",{"_11":-5},"routes/user.$name.collections",{"_9":10,"_11":12,"_13":14,"_15":16,"_17":18,"_19":20},"topics",[35,36],"user",{"_21":22,"_13":14,"_23":24,"_25":14,"_26":27,"_28":29,"_30":31,"_32":16,"_33":34},"loginname","hamflx","page",1,"limit",20,"total",2,"id","40183","avatar_url","https://avatars1.githubusercontent.com/u/13356747?v=4","githubUsername","create_at","2020-07-07 03:26:58.695","score",5,"topic_count",0,"reply_count","is_star",false,{"_21":58,"_38":39,"_40":41,"_42":59,"_44":60,"_46":61,"_48":34,"_49":34,"_32":31,"_51":62,"_26":61,"_54":63},{"_21":37,"_38":39,"_40":41,"_42":43,"_44":45,"_46":47,"_48":34,"_49":34,"_32":50,"_51":52,"_26":53,"_54":55},"43383","author_id","35618","tab","share","content","github：https://github.com/theanarkh/read-libuv-code\r\n\r\n下载：https://11111-1252105172.cos.ap-shanghai.myqcloud.com/Libuv%E6%BA%90%E7%A0%81%E5%88%86%E6%9E%90v0.0.1.pdf","title","Libuv源码分析v0.0.1.pdf","last_reply_at","2020-08-03 19:25:13.752","good","top",7,"visit_count",6863,"2020-06-07 04:57:45.917","author",{"_13":56,"_23":57},"theanarkh","https://avatars.githubusercontent.com/u/21155906?v=4","43621","本文分享一下nodejs中js调用c++模块的一些内容。js调用c++模块是v8提供的能力，nodejs是使用了这个能力。这样我们只需要面对js，剩下的事情交给nodejs就行。本文首先讲一下利用v8如何实现js调用c++，然后再讲一下nodejs是怎么做的。\r\n\r\n## 1 js调用c++\r\n首先介绍一下v8中两个非常核心的类FunctionTemplate和ObjectTemplate。顾名思义，这两个类是定义模板的，好比建房子时的设计图一样，通过设计图，我们就可以造出对应的房子。v8也是，定义某种模板，就可以通过这个模板创建出对应的实例。下面介绍一下这些概念（为了方便，下面都是伪代码)。\r\n### 1.1 定义一个函数模板\r\n```bash\r\nLocal exampleFunctionTemplate = v8::FunctionTemplate::New(isolate(), New);\r\n// 定义函数的类名\r\nexampleFunctionTemplate->SetClassName(‘TCP’)\r\n```\r\n首先定义一个FunctionTemplate对象。我们看到FunctionTemplate的第二个入参是一个函数，当我们执行由FunctionTemplate创建的函数时，v8就会执行New函数。当然我们也可以不传。\r\n### 1.2 定义函数模板的prototype内容\r\nprototype就是js里的function.prototype。如果你理解js里的知识，就很容易理解c++的代码。\r\n```bash\r\n v8::Local t = v8::FunctionTemplate::New(isolate(), callback);\r\n t->SetClassName('test'); \r\n // 在prototype上定义两个属性\r\n exampleFunctionTemplate->PrototypeTemplate()->Set('name', t);\r\n exampleFunctionTemplate->PrototypeTemplate()->Set('hello', 'world');\r\n```\r\n### 1.3 定义函数模板对应的实例模板的内容\r\n实例模板就是一个ObjectTemplate对象。他定义了，当以new的方式执行由函数模板创建出来的函数时的返回值。\r\n```bash\r\nfunction A() {\r\n\tthis.a = 1;\r\n\tthis.b = 2;\r\n}\r\nnew A();\r\n```\r\n实例模板类似上面代码中A函数里面的代码。我们看看在v8里怎么定义。\r\n```bash\r\nt->InstanceTemplate()->Set(key, val);\r\nt->InstanceTemplate()->SetInternalFieldCount(1);\r\n```\r\nInstanceTemplate返回的是一个ObjectTemplate对象。SetInternalFieldCount这个函数比较特殊，也是比较重要的一个地方，我们知道对象就是一块内存，对象有他自己的内存布局，我们知道在c++里，我们定义一个类，也就定义了对象的布局。比如我们有以下定义。\r\n```bash\r\nclass demo\r\n{\r\n private:\r\n int a;\r\n int b;\r\n};\r\n```\r\n在内存中布局如下。\r\n![](https://img-blog.csdnimg.cn/2020071901341392.png)\r\n上面这种方式有个问题，就是类定义之后，内存布局就固定了。而v8是自己去控制对象的内存布局的。当我们在v8中定义一个类的时候，是没有任何属性的。我们看一下v8中HeapObject类的定义。\r\n```bash\r\nclass HeapObject: public Object {\r\n static const int kMapOffset = Object::kSize; // Object::kSize是0\r\n static const int kSize = kMapOffset + kPointerSize;\r\n};\r\n```\r\n这时候的内存布局如下。\r\n![](https://img-blog.csdnimg.cn/2020071901560747.png)\r\n然后我们再看一下HeapObject子类HeapNumber的定义。\r\n```bash\r\nclass HeapNumber: public HeapObject {\r\n // kSize之前的空间存储map对象的指针\r\n static const int kValueOffset = HeapObject::kSize;\r\n // kValueOffset - kSize之间存储数字的值\r\n static const int kSize = kValueOffset + kDoubleSize;\r\n};\r\n```\r\n内存布局如下\r\n![](https://img-blog.csdnimg.cn/20200719015527383.png)\r\n\r\n我们发现这些类只有几个类变量，类变量是不保存在对象内存空间的。这些类变量就是定义了对象每个域所占内存空间的信息，当我们定义一个HeapObject对象的时候，v8首先申请一块内存，然后把这块内存首地址强行转成对应对象的指针。然后通过类变量对属性的内存进行存取。我们看看在v8里如何申请一个HeapNumber对象\r\n```bash\r\nObject* Heap::AllocateHeapNumber(double value, PretenureFlag pretenure) {\r\n // 在哪个空间分配内存，比如新生代，老生代\r\n AllocationSpace space = (pretenure == TENURED) ? CODE_SPACE : NEW_SPACE;\r\n // 在space上分配一个HeapNumber对象大小的内存\r\n Object* result = AllocateRaw(HeapNumber::kSize, space);\r\n /*\r\n\t 转成HeapObect，设置map属性，map属性是表示对象类型、大小等信息的\r\n */\r\n HeapObject::cast(result)->set_map(heap_number_map());\r\n // 转成HeapNumber对象\r\n HeapNumber::cast(result)->set_value(value);\r\n return result;\r\n}\r\n```\r\n回到对象模板的问题。我们看一下对象模板的定义。\r\n\r\n```bash\r\nclass TemplateInfo: public Struct {\r\n static const int kTagOffset = HeapObject::kSize;\r\n static const int kPropertyListOffset = kTagOffset + kPointerSize;\r\n static const int kHeaderSize = kPropertyListOffset + kPointerSize;\r\n};\r\n\r\nclass ObjectTemplateInfo: public TemplateInfo {\r\n static const int kConstructorOffset = TemplateInfo::kHeaderSize;\r\n static const int kInternalFieldCountOffset = kConstructorOffset + kPointerSize;\r\n static const int kSize = kInternalFieldCountOffset + kHeaderSize;\r\n};\r\n```\r\n内存布局如下\r\n![](https://img-blog.csdnimg.cn/20200719024001949.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L1RIRUFOQVJLSA==,size_16,color_FFFFFF,t_70)\r\n\r\n回到对象模板的问题，我们看看Set(key, val)做了什么。\r\n```bash\r\nvoid Template::Set(v8::Handle name, v8::Handle value,\r\n v8::PropertyAttribute attribute) {\r\n // ...\r\n i::Handle list(Utils::OpenHandle(this)->property_list());\r\n NeanderArray array(list);\r\n array.add(Utils::OpenHandle(*name));\r\n array.add(Utils::OpenHandle(*value));\r\n array.add(Utils::OpenHandle(*v8::Integer::New(attribute)));\r\n}\r\n```\r\n上面的代码大致就是给一个list后面追加一些内容。我们看看这个list是怎么来的，即property_list函数的实现。\r\n```bash\r\n// 读取对象中某个属性的值\r\n#define READ_FIELD(p, offset) (*reinterpret_cast(FIELD_ADDR(p, offset))\r\n\r\nstatic Object* cast(Object* value) { \r\n\treturn value;\r\n}\r\n\r\nObject* TemplateInfo::property_list() { \r\n\treturn Object::cast(READ_FIELD(this, kPropertyListOffset)); \r\n}\r\n```\r\n从上面代码中我们知道，内部布局如下。\r\n![](https://img-blog.csdnimg.cn/20200719023936554.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L1RIRUFOQVJLSA==,size_16,color_FFFFFF,t_70)\r\n\r\n根据内存布局，我们知道property_list的值是list指向的值。所以Set(key, val)操作的内存并不是对象本身的内存，对象利用一个指针指向一块内存保存Set(key, val)的值。SetInternalFieldCount函数就不一样了，他会影响（扩张）对象本身的内存。我们来看一下他的实现。\r\n```bash\r\nvoid ObjectTemplate::SetInternalFieldCount(int value) {\r\n // 修改的是kInternalFieldCountOffset对应的内存的值\r\n Utils::OpenHandle(this)->set_internal_field_count(i::Smi::FromInt(value));\r\n}\r\n```\r\n我们看到SetInternalFieldCount函数的实现很简单，就是在对象本身的内存中保存一个数字。接下来我们看看这个字段的使用。后面会详细介绍他的用处。\r\n```bash\r\nHandle Factory::CreateApiFunction(\r\n Handle obj,\r\n bool is_global) {\r\n \r\n int internal_field_count = 0;\r\n if (!obj->instance_template()->IsUndefined()) {\r\n // 获取函数模板的实例模板\r\n Handle instance_template = Handle(ObjectTemplateInfo::cast(obj->instance_template()));\r\n // 获取实例模板的internal_field_count字段的值（通过SetInternalFieldCount设置的那个值）\r\n internal_field_count = Smi::cast(instance_template->internal_field_count())->value();\r\n }\r\n // 计算新建对象需要的空间，如果\r\n int instance_size = kPointerSize * internal_field_count;\r\n if (is_global) {\r\n instance_size += JSGlobalObject::kSize;\r\n } else {\r\n instance_size += JSObject::kHeaderSize;\r\n }\r\n\r\n InstanceType type = is_global ? JS_GLOBAL_OBJECT_TYPE : JS_OBJECT_TYPE;\r\n // 新建一个函数对象\r\n Handle result =\r\n Factory::NewFunction(Factory::empty_symbol(), type, instance_size,\r\n code, true);\r\n} \r\n```\r\n我们看到internal_field_count的值的意义是，会扩张对象的内存，比如一个对象本身只有n字节，如果定义internal_field_count的值是1，对象的内存就会变成n+internal_field_count * 一个指针的字节数。内存布局如下。\r\n![](https://img-blog.csdnimg.cn/20200719024425217.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L1RIRUFOQVJLSA==,size_16,color_FFFFFF,t_70)\r\n1.4 通过函数模板创建一个函数\r\n\r\n```bash\r\nAFunctionTemplate->GetFunction();\r\nglobal->Set('demo', AFunctionTemplate->GetFunction());\r\n```\r\n这样我们就可以在js里直接调用demo这个变量，然后对应的函数就会被执行。这就是js调用c++的原理。\r\n\r\n### 2 nodejs是如何处理js调用c++问题的\r\nnodejs没有给每个功能定义一个全局变量，而是通过另外一种方式实现js调用c++。我们以tcp模块为例。在tcp_wrap.cc文件最后有一句代码\r\n```bash\r\nNODE_BUILTIN_MODULE_CONTEXT_AWARE(tcp_wrap, node::TCPWrap::Initialize)\r\n```\r\n这是一个宏，展开后如下\r\n\r\n```bash\r\n#define NODE_BUILTIN_MODULE_CONTEXT_AWARE(modname, regfunc) \\\r\n NODE_MODULE_CONTEXT_AWARE_CPP(modname, regfunc, nullptr, NM_F_BUILTIN)\r\n\r\n\r\n#define NODE_MODULE_CONTEXT_AWARE_CPP(modname, regfunc, priv, flags) \\\r\n static node::node_module _module = { \\\r\n NODE_MODULE_VERSION, \\\r\n flags, \\\r\n nullptr, \\\r\n __FILE__, \\\r\n nullptr, \\\r\n (node::addon_context_register_func) (regfunc), \\\r\n NODE_STRINGIFY(modname), \\\r\n priv, \\\r\n nullptr \\\r\n }; \\\r\n void _register_ ## modname() { \\\r\n node_module_register(&_module); \\\r\n }\r\n```\r\n我们看到，宏展开后，首先定义了一个node_module 结构体。然后定义了一个_register_ xxx的函数。这个函数在nodejs初始化的时候会执行\r\n```bash\r\nvoid RegisterBuiltinModules() {\r\n// 宏展开后就是执行一系列的_register_xxx函数\r\n#define V(modname) _register_##modname();\r\n NODE_BUILTIN_MODULES(V)\r\n#undef V\r\n}\r\n```\r\n我们看到_register_ xxx函数执行了\r\n\r\n```bash\r\nnode_module_register(&_module);\r\n```\r\nnode_module_register定义如下\r\n```bash\r\nextern \"C\" void node_module_register(void* m) {\r\n struct node_module* mp = reinterpret_cast(m);\r\n mp->nm_link = modlist_builtin;\r\n modlist_builtin = mp;\r\n}\r\n```\r\n就是把一个个node_module加入到链表中。完成了模块的注册。我们来看看如何使用这个模块。\r\n```bash\r\nconstant { TCP } = process.binding('tcp_wrap');\r\nnew TCP(...);\r\n```\r\n我们看到nodejs是通过process.binding来实现c++模块的调用的。nodejs通过定义一个全局变量process统一处理c++模块的调用，而不是定义一堆全局对象。下面我们看process.binding的实现，跳过nodejs的缓存处理，直接看c++的实现。\r\n```bash\r\n\r\nstatic Local