node读取文件功能的代码跟踪调查

当我们快乐的使用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

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

推荐阅读更多精彩内容

  • 前言从Node.js进入人们的视野时,我们所知道的它就由这些关键字组成 事件驱动、非阻塞I/O、高效、轻量,它在官...
    Www刘阅读 1,518评论 0 18
  • 不知不觉,已经与儿时的那些小伙伴离别多年。小学毕业,便各奔东西。偶尔节假日回家,才能聚在一起,话话往事。她们有的上...
    西青阅读 420评论 3 2
  • 宣纸上未风干的画飘来墨香 我站在画旁 怀念你写的情书一行一行 看不到我眼里的忧伤 你不必勉强 我只是遗失在没有你的...
    依依惜若阅读 231评论 12 6