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

接下来，继续理解helloworld模块中的指令。

helloworld中的代码 /* Commands */ static ngx_command_t ngx_http_hello_world_commands[] = { { ngx_string("hello_world"), NGX_HTTP_LOC_CONF|NGX_CONF_NOARGS, ngx_http_hello_world, 0, 0, NULL }, ngx_null_command };

有代码可以看出模块的指令在源码中ngx_command_t结构的变量，ngx_command_t的声明在src/core/ngx_conf_file.h中：

struct ngx_command_s { ngx_str_t name; ngx_uint_t type; char *(*set)(ngx_conf_t *cf, ngx_command_t *cmd, void *conf); ngx_uint_t conf; ngx_uint_t offset; void *post; };

一一作对比来看看每个变量的具体含义：

name是指指令名称的字符串，不可以包含空格。

 

type是用来设置指令在配置文件位置的哪一部分使用是合法的可选值(在src/core/ngx_conf_file.h中保存了参数配置信息，其他模块中包含位置可选值)如下：

 

src/core/ngx_conf_file.h 参数配置信息 #define NGX_CONF_NOARGS 0x00000001 //指令没有参数 #define NGX_CONF_TAKE1 0x00000002 //指令读入2个参数 #define NGX_CONF_TAKE2 0x00000004 //…. #define NGX_CONF_TAKE3 0x00000008 #define NGX_CONF_TAKE4 0x00000010 #define NGX_CONF_TAKE5 0x00000020 #define NGX_CONF_TAKE6 0x00000040 #define NGX_CONF_TAKE7 0x00000080 #define NGX_CONF_MAX_ARGS 8 #define NGX_CONF_TAKE12 (NGX_CONF_TAKE1|NGX_CONF_TAKE2) //有1个或2个参数 #define NGX_CONF_TAKE13 (NGX_CONF_TAKE1|NGX_CONF_TAKE3) #define NGX_CONF_TAKE23 (NGX_CONF_TAKE2|NGX_CONF_TAKE3) #define NGX_CONF_TAKE123 (NGX_CONF_TAKE1|NGX_CONF_TAKE2|NGX_CONF_TAKE3) #define NGX_CONF_TAKE1234 (NGX_CONF_TAKE1|NGX_CONF_TAKE2|NGX_CONF_TAKE3 \ |NGX_CONF_TAKE4) #define NGX_CONF_ARGS_NUMBER 0x000000ff #define NGX_CONF_BLOCK 0x00000100 //块域 后面跟{…} 例如events{…} #define NGX_CONF_FLAG 0x00000200 //指令读入1个布尔型数据 #define NGX_CONF_ANY 0x00000400 #define NGX_CONF_1MORE 0x00000800 //指令至少一个参数 #define NGX_CONF_2MORE 0x00001000 #define NGX_CONF_MULTI 0x00002000 //多个参数 位置配置信息src/http/ngx_http_config.h中 #define NGX_HTTP_MAIN_CONF 0x02000000 //指令出现在全局配置部分是合法的 #define NGX_HTTP_SRV_CONF 0x04000000 //指令出现在server主机配置部分是合法的 #define NGX_HTTP_LOC_CONF 0x08000000 //指令出现在location部分是合法的 #define NGX_HTTP_UPS_CONF 0x10000000 //指令出现在upstream配置部分是合法的 #define NGX_HTTP_SIF_CONF 0x20000000 //… #define NGX_HTTP_LIF_CONF 0x40000000 #define NGX_HTTP_LMT_CONF 0x80000000

在读上书信息是，希望各位有配置过nginx的经验，否则可能不会理解很深。

 

set是一个函数指针，这个函数主要是从配置文件中把该指令的参数(存放在ngx_conf_t中)转换为合适的数据类型，并将转换后的值保存到模块的配置结构体中(viod *conf)，这个配置结构体又是用void *指向的，这里和之前讲过的一样，每个模块的结构体是不同的。这样正是这个回调函数的三个参数，这些结构体的命名格式为：ngx_<module name>_conf_t,

offset主要是存放转换后的值在配置结构体的偏移。

 

并不是所有的模块都要定义一个配置结构体，因为set也可能是一个简单的操作函数，它可能只是从配置中（ngx_conf_t）读取一些数据进行简单的操作，比如errlog模块的“error_log”指令就是调用ngx_error_log写一条日志，并不需要存储什么配置数据。

 

conf和offset，offset前面已经提到，它是配置结构体中成员的偏移。conf也是一个偏移值，不过它是配置文件结构体的（ngx_conf_t）成员ctx的成员的偏移，一般是用来把ctx中指定偏移位置的成员赋值给void *conf。

post指向模块读配置的时候需要的一些零碎变量。

从上面的分析可以看出，每个模块会映射到配置文件中的某个位置，全局位置的配置会被下一级的配置继承，比如http_main会被http_svr继承，http_svr会被http_loc继承，这些继承在源码中是调用模块上下文的合并配置的接口完成的。