nginx 源码学习笔记（三）——nginx精粹-模块

下面开始真正"nginx之旅",屏住呼吸吧！

首先找好入手点，对于nginx的入手点就是ngx_module_t结构，他的声明在src/core/ngx_conf_file.h中(我的版本nginx-1.0.13)

[cpp]  view plain copy print ?

1. #define NGX_MODULE_V1          0, 0, 0, 0, 0, 0, 1  
2. #define NGX_MODULE_V1_PADDING  0, 0, 0, 0, 0, 0, 0, 0  
3.   
4. struct ngx_module_s {  
5.     ngx_uint_t            ctx_index;  
6.     ngx_uint_t            index;  
7.   
8.     ngx_uint_t            spare0;  
9.     ngx_uint_t            spare1;  
10.     ngx_uint_t            spare2;  
11.     ngx_uint_t            spare3;  
12.   
13.     ngx_uint_t            version;  
14.   
15.     void                 *ctx;  
16.     ngx_command_t        *commands;  
17.     ngx_uint_t            type;  
18.   
19.     ngx_int_t           (*init_master)(ngx_log_t *log);  
20.   
21.     ngx_int_t           (*init_module)(ngx_cycle_t *cycle);  
22.   
23.     ngx_int_t           (*init_process)(ngx_cycle_t *cycle);  
24.     ngx_int_t           (*init_thread)(ngx_cycle_t *cycle);  
25.     void                (*exit_thread)(ngx_cycle_t *cycle);  
26.     void                (*exit_process)(ngx_cycle_t *cycle);  
27.   
28.     void                (*exit_master)(ngx_cycle_t *cycle);  
29.   
30.     uintptr_t             spare_hook0;  
31.     uintptr_t             spare_hook1;  
32.     uintptr_t             spare_hook2;  
33.     uintptr_t             spare_hook3;  
34.     uintptr_t             spare_hook4;  
35.     uintptr_t             spare_hook5;  
36.     uintptr_t             spare_hook6;  
37.     uintptr_t             spare_hook7;  
38. };  

ngx_module_t 结构中成员index: 是一个模块计数器，按照每个模块在ngx_modules[]数组中的声明顺序(即在文件objs/ngx_modules.c中)，从0开始一次给每个模块赋值：

[cpp]  view plain copy print ?

1. ngx_module_t *ngx_modules[] = {  
2.     &ngx_core_module,  
3.     &ngx_errlog_module,  
4.     &ngx_conf_module,  
5.     &ngx_events_module,  
6.     &ngx_event_core_module,  
7.     &ngx_epoll_module,  
8.     &ngx_http_module,  
9.     &ngx_http_core_module,  
10.     &ngx_http_log_module,  

从src/core/nginx.c中可以找到顺序赋值的代码：

[cpp]  view plain copy print ?

1. ngx_max_module = 0;  
2. for (i = 0; ngx_modules[i]; i++) {  
3.     ngx_modules[i]->index = ngx_max_module++;  
4. }  

ngx_module_t 结构中成员ctx_index：是分类的模块计数器，nginx模块可以分为四类：core、event 、http和mail，每个模块都会各自计数的，ctx_index就是每个模块在其所属类组中的计数：代码如下

[cpp]  view plain copy print ?

1. src/event/ngx_event.c  
2. for (i = 0; ngx_modules[i]; i++) {  
3.     if (ngx_modules[i]->type != NGX_EVENT_MODULE) {  
4.         continue;  
5.     }  
6.   
7.     ngx_modules[i]->ctx_index = ngx_event_max_module++;  
8. }  
9.   
10. src/http/ngx_http.c  
11. ngx_http_max_module = 0;  
12. for (m = 0; ngx_modules[m]; m++) {  
13.     if (ngx_modules[m]->type != NGX_HTTP_MODULE) {  
14.         continue;  
15.     }  
16.   
17.     ngx_modules[m]->ctx_index = ngx_http_max_module++;  
18. }  
19.   
20. src/mail/ngx_mail.c  
21. ngx_mail_max_module = 0;  
22. for (m = 0; ngx_modules[m]; m++) {  
23.     if (ngx_modules[m]->type != NGX_MAIL_MODULE) {  
24.         continue;  
25.     }  
26.   
27.     ngx_modules[m]->ctx_index = ngx_mail_max_module++;  
28. }  

ngx_module_t 结构中成员ctx：是模块的上下文，不同种类的模块有不同的上下文，因此哪种类型的模块需要实现对应的结构体。(这里非常重要) 四种类型的结构体为：ngx_core_module_t、ngx_event_module_t、ngx_http_module_t、 ngx_mail_module_t

ngx_module_t 结构中成员commands：是模块的指令集。每一个指令在源码中对应着一个ngx_command_t结构变量，

(用于存放从nginx.conf中解析的数据)

[cpp]  view plain copy print ?

1. static ngx_command_t  ngx_core_commands[] = {  
2.   
3.     { ngx_string("daemon"),  
4.       NGX_MAIN_CONF|NGX_DIRECT_CONF|NGX_CONF_FLAG,  
5.       ngx_conf_set_flag_slot,  
6.       0,  
7.       offsetof(ngx_core_conf_t, daemon),  
8.       NULL },.....不全部列举  

ngx_module_t 结构中成员type：就是模块的类型，用于区分前面提到的core event http和mail .

ngx_module_t 结构中成员init_master、 init_module、init_process、init_thread、exit_thread、exit_process、 exit_master是函数指针，指向模块实现的自定义回调函数，这些回调函数分别在初始化master、初始化模块、初始化工作进程、初始化线程、退出线程、退出工作进程和退出master的时候被调用，如果模块需要在这些时机做处理，就可以实现对应的函数，并把它赋值给对应的函数指针来注册一个回调函数接口。

其余暂且不详。。

(ygm重点：)

ngx_module_t 结构中成员ctx：这个成员的意义是每个模块的上下文，所谓的上下文，也就是这个模块究竟可以做什么，从前面的分析可以知道nginx把所有模块分为四类（core/event/http/mail），对应的，nginx也认为模块的上下文是四种，分别用四个结构体表示：ngx_core_module_t、ngx_event_module_t、ngx_http_module_t、 ngx_mail_module_t。也就是说，如果一个模块属于core分类，那么其上下文就是ngx_core_module_t结构的变量，其他类推。这四个结构体类似于ngx_module_t，也是一些函数指针的集合，每个模块根据自己所属的分类，自定义一些操作函数，通过把这些操作函数赋值为对应分类结构体中的函数指针，这就注册了一个回调函数接口，从而就可以实现更细致的功能了。例如可以为event模块添加事件处理函数，可以为http模块添加过滤函数等。