nginx源码分析--多阶段请求处理

读取完请求头后，nginx进入请求的处理阶段（请求体的读取已经在多阶段处理中了）。简单的情况下，客户端发送过的统一资源定位符(url)对应服务器上某一路径上的资源，web服务器需要做的仅仅是将url映射到本地文件系统的路径，然后读取相应文件并返回给客户端。但这仅仅是最初的互联网的需求，而如今互联网出现了各种各样复杂的需求，要求web服务器能够处理诸如安全及权限控制，多媒体内容和动态网页等等问题。这些复杂的需求导致web服务器不再是一个短小的程序，而变成了一个必须经过仔细设计，模块化的系统。nginx良好的模块化特性体现在其对请求处理流程的多阶段划分当中，多阶段处理流程就好像一条流水线，一个nginx进程可以并发的处理处于不同阶段的多个请求。nginx允许开发者在处理流程的任意阶段注册模块，在启动阶段，nginx会把各个阶段注册的所有模块处理函数按序的组织成一条执行链。

nginx实际把请求处理流程划分为了11个阶段，这样划分的原因是将请求的执行逻辑细分，各阶段按照处理时机定义了清晰的执行语义，开发者可以很容易分辨自己需要开发的模块应该定义在什么阶段，下面介绍一下各阶段:

NGX_HTTP_POST_READ_PHASE： 接收完请求头之后的第一个阶段，它位于uri重写之前，实际上很少有模块会注册在该阶段，默认的情况下，该阶段被跳过；

NGX_HTTP_SERVER_REWRITE_PHASE： server级别的uri重写阶段，也就是该阶段执行处于server块内，location块外的重写指令，前面的章节已经说明在读取请求头的过程中nginx会根据host及端口找到对应的虚拟主机配置；

NGX_HTTP_FIND_CONFIG_PHASE： 寻找location配置阶段，该阶段使用重写之后的uri来查找对应的location，值得注意的是该阶段可能会被执行多次，因为也可能有location级别的重写指令；

NGX_HTTP_REWRITE_PHASE： location级别的uri重写阶段，该阶段执行location基本的重写指令，也可能会被执行多次；

NGX_HTTP_POST_REWRITE_PHASE： location级别重写的后一阶段，用来检查上阶段是否有uri重写，并根据结果跳转到合适的阶段；

NGX_HTTP_PREACCESS_PHASE： 访问权限控制的前一阶段，该阶段在权限控制阶段之前，一般也用于访问控制，比如限制访问频率，链接数等；

NGX_HTTP_ACCESS_PHASE： 访问权限控制阶段，比如基于ip黑白名单的权限控制，基于用户名密码的权限控制等；

NGX_HTTP_POST_ACCESS_PHASE： 访问权限控制的后一阶段，该阶段根据权限控制阶段的执行结果进行相应处理；

NGX_HTTP_TRY_FILES_PHASE： try_files指令的处理阶段，如果没有配置try_files指令，则该阶段被跳过；

NGX_HTTP_CONTENT_PHASE：内容生成阶段，该阶段产生响应，并发送到客户端；

NGX_HTTP_LOG_PHASE： 日志记录阶段，该阶段记录访问日志；

多阶段执行链

nginx按请求处理的执行顺序将处理流程划分为多个阶段，一般每个阶段又可以注册多个模块处理函数，nginx按阶段将这些处理函数组织成了一个执行链，这个执行链保存在http主配置（ngx_http_core_main_conf_t）的phase_engine字段中，phase_engine字段的类型为ngx_http_phase_engine_t：

[cpp] view plaincopy

1. typedef struct {  
2.     ngx_http_phase_handler_t  *handlers;  
3.     ngx_uint_t                 server_rewrite_index;  
4.     ngx_uint_t                 location_rewrite_index;  
5. } ngx_http_phase_engine_t;  

其中handlers字段即为执行链，实际上它是一个数组，而每个元素之间又被串成链表，从而允许执行流程向前，或者向后的阶段跳转，执行链节点的数据结构定义如下：
[cpp] view plaincopy

1. struct ngx_http_phase_handler_s {  
2.     ngx_http_phase_handler_pt  checker;  
3.     ngx_http_handler_pt        handler;  
4.     ngx_uint_t                 next;  
5. };  

其中checker和handler都是函数指针，相同阶段的节点具有相同的checker函数，handler字段保存的是模块处理函数，一般在checker函数中会执行当前节点的handler函数，但是例外的是NGX_HTTP_FIND_CONFIG_PHASE，NGX_HTTP_POST_REWRITE_PHASE，NGX_HTTP_POST_ACCESS_PHASE和NGX_HTTP_TRY_FILES_PHASE这4个阶段不能注册模块函数。next字段为快速跳跃索引，多数情况下，执行流程是按照执行链顺序的往前执行，但在某些执行阶段的checker函数中由于执行了某个逻辑可能需要回跳至之前的执行阶段，也可能需要跳过之后的某些执行阶段，next字段保存的就是跳跃的目的索引。

和建立执行链相关的数据结构都保存在http主配置中，一个是phases字段，另外一个是phase_engine字段。其中phases字段为一个数组，它的元素个数等于阶段数目，即每个元素对应一个阶段。而phases数组的每个元素又是动态数组（ngx_array_t），每次模块注册处理函数时只需要在对应阶段的动态数组增加一个元素用来保存处理函数的指针。由于在某些执行阶段可能需要向后，或者向前跳转，简单的使用2个数组并不方便，所以nginx又组织了一个执行链，保存在了phase_engine字段，其每个节点包含一个next域用来保存跳跃目的节点的索引，而执行链的建立则在nginx初始化的post config阶段之后调用ngx_http_init_phase_handlers函数完成，下面分析一下该函数：

[cpp] view plaincopy

1. static ngx_int_t  
2. ngx_http_init_phase_handlers(ngx_conf_t *cf, ngx_http_core_main_conf_t *cmcf)  
3. {  
4.     ngx_int_t                   j;  
5.     ngx_uint_t                  i, n;  
6.     ngx_uint_t                  find_config_index, use_rewrite, use_access;  
7.     ngx_http_handler_pt        *h;  
8.     ngx_http_phase_handler_t   *ph;  
9.     ngx_http_phase_handler_pt   checker;  
10.   
11.     cmcf->phase_engine.server_rewrite_index = (ngx_uint_t) -1;  
12.     cmcf->phase_engine.location_rewrite_index = (ngx_uint_t) -1;  
13.     find_config_index = 0;  
14.     use_rewrite = cmcf->phases[NGX_HTTP_REWRITE_PHASE].handlers.nelts ? 1 : 0;  
15.     use_access = cmcf->phases[NGX_HTTP_ACCESS_PHASE].handlers.nelts ? 1 : 0;  
16.   
17.     n = use_rewrite + use_access + cmcf->try_files + 1 /* find config phase */;  
18.   
19.     for (i = 0; i < NGX_HTTP_LOG_PHASE; i++) {  
20.         n += cmcf->phases[i].handlers.nelts;  
21.     }  
22.   
23.     ph = ngx_pcalloc(cf->pool,  
24.                      n * sizeof(ngx_http_phase_handler_t) + sizeof(void *));  
25.     if (ph == NULL) {  
26.         return NGX_ERROR;  
27.     }  
28.   
29.     cmcf->phase_engine.handlers = ph;  
30.     n = 0;  
31.   
32.     for (i = 0; i < NGX_HTTP_LOG_PHASE; i++) {  
33.         h = cmcf->phases[i].handlers.elts;  
34.   
35.         switch (i) {  
36.   
37.         case NGX_HTTP_SERVER_REWRITE_PHASE:  
38.             if (cmcf->phase_engine.server_rewrite_index == (ngx_uint_t) -1) {  
39.                 cmcf->phase_engine.server_rewrite_index = n;  
40.             }  
41.             checker = ngx_http_core_rewrite_phase;  
42.   
43.             break;  
44.   
45.         case NGX_HTTP_FIND_CONFIG_PHASE:  
46.             find_config_index = n;  
47.   
48.             ph->checker = ngx_http_core_find_config_phase;  
49.             n++;  
50.             ph++;  
51.   
52.             continue;  
53.   
54.         case NGX_HTTP_REWRITE_PHASE:  
55.             if (cmcf->phase_engine.location_rewrite_index == (ngx_uint_t) -1) {  
56.                 cmcf->phase_engine.location_rewrite_index = n;  
57.             }  
58.             checker = ngx_http_core_rewrite_phase;  
59.   
60.             break;  
61.   
62.         case NGX_HTTP_POST_REWRITE_PHASE:  
63.             if (use_rewrite) {  
64.                 ph->checker = ngx_http_core_post_rewrite_phase;  
65.                 ph->next = find_config_index;  
66.                 n++;  
67.                 ph++;  
68.             }  
69.   
70.             continue;  
71.  &