nginx 1.18 源代码分析 (五)

1. phases

nginx将数据处理过程划分为几个阶段(phase)。

2. ngx_http_phase_handler_pt 与 ngx_http_handler_pt

每个阶段可以挂接若干处理函数,ngx_http_core_run_phase() 按阶段调用这些函数。不管是Nginx自身的nginx_module,还是使用者的ngx_module,都可以挂接自己的处理函数。这个处理函数的原型定义是ngx_http_handler_pt。

typedef ngx_int_t (*ngx_http_handler_pt)(ngx_http_request_t *r);

挂接的位置是ngx_http_core_main_conf_t.phases[]数组,保存ngx_http_phase_t结构。Ngx_http_phase_t.handlers[]是一个ngx_http_phase_t数组,每个phase一个元素。Ngx_http_phase_t的成员handlers也是一个数组,该阶段的处理函数ngx_http_handler_pt都注册在这里。

实际上处理http请求时,并不是使用ngx_http_core_main_conf_t.phases[],而是ngx_http_core_main_conf_t.phase_engine。Ngx_http_phase_engint_t.handlers是一个ngx_http_phase_handler_t。

ngx_http_handler_pt只是ngx_module挂接的处理函数。Ngx_http_phase_handler_pt则是每个phase指定的校验函数。如果校验通过,校验函数才会调用处理函数。

typedef ngx_int_t (*ngx_http_phase_handler_pt)(ngx_http_request_t *r, 
ngx_http_phase_handler_t *ph);

ngx_http_phase_handler_t包括了校验函数和处理函数。

  • 成员checker是phase校验函数。
  • 成员handler是处理函数。
  • 成员next指定每个ngx_http_phase_handler_t实例在http请求处理过程中的“下一站”。

3. ngx_http_init_phases()

ngx_http_init_phases() 初始化ngx_http_core_main_conf.phases[]中的处理函数数组。

4. ngx_http_module_t::postconfiguration()

在ngx_http_module_t::postconfiguration()中,nginx模块向ngx_http_core_main_conf_t.phases中,加入自己的的处理函数。对于ngx_http_auth_basic_module模块,就是ngx_http_auth_basic_init()。

  • 调用ngx_array_push(),向NGX_HTTP_ACCESS_PHASE阶段,加入处理函数ngx_http_auth_basic_handler。

5. ngx_http_init_phase_handlers()

ngx_http_init_phase_handlers()初始化ngx_core_main_conf_t.phase_engine.handlers[]。

  • 遍历ngx_http_core_main_conf_t.phases[],计算其中的处理函数数量。
  • 调用ngx_pcalloc()分配对应的ngx_http_phase_handler_t数组,也就是ngx_core_main_conf_t.phase_engine.handlers[]。
  • 遍历ngx_http_core_main_conf_t.phases[]数组,将其中的处理函数,一一复制到ngx_http_core_main_conf_t.phase_engine.handlers[]中,同时补充相应phase的校验函数。同时每个ngx_http_phase_handler_t的下一站,也就是它的成员next。

这个过程的大致情形如下图。

  • 图左边的每个阶段为一个实线框, 每个阶段指定一个校验函数ngx_http_phase_handler_pt,一组处理函数ngx_http_handler_t。
  • 图右边,所有的ngx_http_phase_handler_t实际上是保存在同一个数组中。虚线框是为了使复制的关系看得更清楚。

6. ngx_http_block()

在ngx_http_block()中调用以上函数。

如下是缺省情况(不定制或拓展nginx的功能)下,最后ngx_http_core_main_conf_t.phase_engine.handlers[]的布局。

7. ngx_http_core_run_phases()

ngx_http_core_run_phases() 在一个循环中访问ngx_http_core_main_conf_t.phase_engine.handlers[],调用其中的校验函数和处理函数。

访问位置由ngx_http_request_t.phase_handler指定,这个值一开始为0,后来校验函数会改变它,所以ngx_http_core_run_phase()会在ngx_http_core_main_conf_t.phase_engine.handlers[]中跳转。

校验函数和处理函数的一个例子是ngx_http_core_access_phase()和ngx_http_auth_basic_handler()。

7.1 ngx_http_phase_handler_t::handler()

在ngx_http_auth_basic_handler()中,

  • 调用ngx_http_auth_basic_user(),得到用户数据。
  • 调用ngx_open_file(),打开用户数据文件。
  • 在一个循环中调用ngx_read_file(),读取用户数据文件的记录。将请求中的用户信息与记录比较,看是否匹配。

7.2 ngx_http_phase_handler_t::checker()

在ngx_http_core_access_phase()中,

  • 调用当前ngx_http_phase_handler_t实例的handler函数,这里是ngx_http_auth_basic_handler()。

  • 根据handler函数的返回结果跳转,一般有三种情况。

    • 一是handler函数的结果不能确定怎么处理请求,所以ngx_http_request_t.phase_handler递增1。这样ngx_http_core_run_phases()的下一次循环,将跳转到数组phase_engine.handlers[]的下一个元素去执行。
    • 二是handler函数的结果确定本阶段的任务已经完成,所以请求ngx_http_request_t.phase_handler设置为当前ngx_http_phase_handler_t.next的值。这样ngx_http_core_run_phases()的下一次循环,将跳到该值指向的位置。这个值在ngx_http_init_phase_handlers()确定。
    • 三是handler函数的结果确定所有任务已经结束(比如请求失败),所以返回NGX_OK。这时ngx_http_core_run_phases()会终止循环。

相关链接

nginx 1.18 源代码分析 (一)
nginx 1.18 源代码分析 (二)
nginx 1.18 源代码分析 (三)
nginx 1.18 源代码分析 (四)
nginx 1.18 源代码分析 (五)
nginx 1.18 源代码分析 (六)

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

推荐阅读更多精彩内容