当我们快乐的使用js写服务端程序的时候,是否想过如此酸爽的编程体验是如何实现的。为了满足自己的好奇心,我特意下载了node的源码,进行了一次深度跟踪。
我们看一下readFile
这个程序到底是如何实现的吧。由于v8很复杂,所以这篇文章中v8如何帮助我们在js和cpp来回调用就忽略了,等我把v8也研究了再来补上。js,node,和libuv的代码,会比较详细的跟踪。
跟踪方法
- 新建测试文件
新建一个文件:fsdemo.js
, 用这个文件来调试吧。
var fs = require("fs");
// 异步读取
fs.readFile('vcbuild.bat', function(err, data) {
if (err) {
return console.error("Yin : in the fsdemo.js :: 异步读取发生错误 : " + err);
}
console.log("Yin : in the fsdemo.js :: 异步读取完毕 !\n");
// console.log("异步读取: " + data.toString());
});
// 同步读取
// var data = fs.readFileSync('input.txt');
// console.log("同步读取: " + data.toString());
console.log("Yin : in the fsdemo.js :: 程序执行完毕。\n");
下载node
https://github.com/nodejs/node
切换到4.4.7版本。最新的跟不上,太老的bug多,我们跟踪一个LTSb按本吧。
我是在windows上用visual studio看代码,所以直接运行vcbuild。
确保按照readme的说明编译成功哦。打上log
先过一遍代码后,可以在感兴趣的地方打上log。如果希望用断点调试,也可以直接在VS中F11
,找到入口。后面会贴上我增加的log,感兴趣的同学可以自己对照着改改。反复调试
一次找到所有的路径是很困难的,因为异步的代码会跳来跳去,所以需要仔细思考,才能找到整条路径。
Log讲解
在调试了以4,5个小时后,感觉已经摸清了异步调用的基本流程。感兴趣的朋友可以仔细看看。下面的log需要你对代码页非常熟悉。
** 1. 加载需要测试的文件 **
Yin : in the node_file.cc! :: Open
Yin : in the node_file.cc! :: Open :: SYNC_CALL! path = \?\D:\projects\node\fsdemo.js
Yin : in the fs.c :: uv_fs_open!
Yin : in the fs.c :: uv_fs_open :: fs__open(req);!
Yin : in the fs.c :: fs__open
Yin : in the node_file.cc! :: Read
Yin : in the node_file.cc! :: Read :: SYNC_CALL, <fd = 3>
Yin : in the fs.c :: uv_fs_read!
Yin : in the fs.c :: uv_fs_read :: fs__read(req); <fd = 3>!
Yin : in the fs.c :: fs__read
Yin : in the fs.c :: fs__read :: ReadFile <index = 0>
上面的log向我们展示了node本身加载fsdemo.js的过程。通过log可以看到这个过程是同步的,最后通过libuv的fs__read
完成读取工作。
** 2. js读取文件**
Yin : in the fs.js :: fs.readFile!
Yin : in the node_file.cc! :: Open
Yin : in the node_file.cc! :: Open :: ASYNC_CALL! path = \?\D:\projects\node\vcbuild.bat
Yin : in the fs.c :: uv_fs_open!
Yin : in the fs.c ::** uv_fs_open :: QUEUE_FS_TP_JOB**!
Yin : in the threadpool.c :: worker
Yin : in the fs.c :: uv__fs_work :: <fstype = open>
Yin : in the fs.c :: fs__open
Yin : in the threadpool.c :: worker :: uv_async_send <&w->loop->wq_async = 23934432>
Yin : in the fsdemo.js :: 程序执行完毕。
通过上面的log,我们可以知道读取文件用的是异步方式,任务被放到队列中,由线程池去执行具体的任务,现在可以看到第一个任务是open,调用fs__open
。open完成后,还会通知主线程(uv_async_send
)。还可以注意到 fsdemo.js这时候已经执行完毕了。
3. open文件的过程
Yin : in core.c :: uv_run
Yin : in the req-inl.h :: uv_process_reqs
Yin : in the node.cc :: StartNodeInstance :: <loop number = 1, more event = 1>
Yin : in core.c :: uv_run
Yin : in the req-inl.h :: uv_process_reqs
Yin : in the req-inl.h :: uv_process_reqs : UV_WAKEUP
Yin : in the threadpool.c :: uv__work_done
Yin : in the threadpool.c :: uv__work_done :: w->done(w, err)
Yin : in the fs.c :: uv__fs_done
Yin : in the node_file.cc! :: After
Yin : in the node_file.cc! :: After :: MakeCallback :: <argc = 2, argv =h???烫烫�>
Yin : in the fs.js :: readFileAfterOpen !
我们可以看到主线程会有一个循环处理事件。现在有一个UV_WAKEUP
事件要处理。事件处理完成后会再回调fs.js
里面的readFileAfterOpen
函数。
需要说明的是这里面忽略了另一个线程如何通知主循环的细节,window平台是通过IOCP,可以搜索函数GetQueuedCompletionStatus
了解细节,liunx上并不是这样。
4. check文件状态
Yin : in the threadpool.c :: worker
Yin : in the node.cc :: StartNodeInstance :: <loop number = 2, more event = 1>
Yin : in core.c :: uv_run
Yin : in the req-inl.h :: uv_process_reqs
Yin : in the fs.c :: uv__fs_work :: <fstype = fstat>
Yin : in the threadpool.c :: worker :: uv_async_send <&w->loop->wq_async = 23934432>
Yin : in the node.cc :: StartNodeInstance :: <loop number = 3, more event = 1>
Yin : in core.c :: uv_run
Yin : in the req-inl.h :: uv_process_reqs
Yin : in the req-inl.h :: uv_process_reqs : UV_WAKEUP
Yin : in the threadpool.c :: uv__work_done
Yin : in the threadpool.c :: uv__work_done :: w->done(w, err)
Yin : in the fs.c :: uv__fs_done
Yin : in the node_file.cc! :: After
Yin : in the node_file.cc! :: After :: MakeCallback :: <argc = 2, argv =h???烫烫�>
Yin : in the fs.js :: readFileAfterStat !
这里通过log发现读取之前还检查了一下文件状态,前面都open到fd了,还check啥状态,我觉得这里可以优化,这个就不仔细深究了。
5. 读文件
Yin : in the fs.js :: ReadFileContext.prototype.read !
Yin : in the node_file.cc! :: Read
Yin : in the node_file.cc! :: Read :: ASYNC_CALL, <fd = 3>
Yin : in the fs.c :: uv_fs_read!
Yin : in the fs.c :: uv_fs_read :: QUEUE_FS_TP_JOB <fd = 3>!
Yin : in the threadpool.c :: worker
Yin : in the node.cc :: StartNodeInstance :: <loop number = 4, more event = 1>
Yin : in the fs.c :: uv__fs_work :: <fstype = read>
Yin : in core.c :: uv_run
Yin : in the fs.c :: fs__read
Yin : in the req-inl.h :: uv_process_reqs
Yin : in the fs.c :: fs__read :: ReadFile <index = 0>
Yin : in the threadpool.c :: worker :: uv_async_send <&w->loop->wq_async = 23934432>
Yin : in the node.cc :: StartNodeInstance :: <loop number = 5, more event = 1>
Yin : in core.c :: uv_run
Yin : in the req-inl.h :: uv_process_reqs
Yin : in the req-inl.h :: uv_process_reqs : UV_WAKEUP
Yin : in the threadpool.c :: uv__work_done
Yin : in the threadpool.c :: uv__work_done :: w->done(w, err)
Yin : in the fs.c :: uv__fs_done
读文件也是异步的,和打开文件很像
6.关闭文件并调用js回调
Yin : in the node_file.cc! :: After
Yin : in the node_file.cc! :: After :: MakeCallback :: <argc = 2, argv =h???烫烫�>
Yin : in the fs.js :: ReadFileContext.prototype.close !
Yin : in the threadpool.c :: worker
Yin : in the node.cc :: StartNodeInstance :: <loop number = 6, more event = 1>
Yin : in core.c :: uv_run
Yin : in the req-inl.h :: uv_process_reqs
Yin : in the fs.c :: uv__fs_work :: <fstype = close>
Yin : in the threadpool.c :: worker :: uv_async_send <&w->loop->wq_async = 23934432>
Yin : in the node.cc :: StartNodeInstance :: <loop number = 7, more event = 1>
Yin : in core.c :: uv_run
Yin : in the req-inl.h :: uv_process_reqs
Yin : in the req-inl.h :: uv_process_reqs : UV_WAKEUP
Yin : in the threadpool.c :: uv__work_done
Yin : in the threadpool.c :: uv__work_done :: w->done(w, err)
Yin : in the fs.c :: uv__fs_done
Yin : in the node_file.cc! :: After
Yin : in the node_file.cc! :: After :: MakeCallback :: <argc = 1, argv =h?>
Yin : in the fs.js :: readFileAfterClose !
Yin : in the fsdemo.js :: 异步读取完毕 !
Yin : in the node.cc :: StartNodeInstance :: <loop number = 8, more event = 0>
可以看到最后回到了js文件。
结论
可以看到,用js几行代码完成的事情,实际上流程非常复杂,上面的代码还不包括v8如何解析js的情况,如果能把这些都搞清楚了,才是大牛吧。
对代码的修改可以看这个diff文件。
https://github.com/benhaben/blog/issues/15