nginx源码阅读(十一).ngx_epoll_module模块(上)

前言

事件模块中有封装了多种I/O多路复用机制的模块,这里只分析epoll对应的ngx_epoll_module模块,如果你对其他的感兴趣,可以参照本小节分析的源码及步骤,因为其他驱动模块的实现与ngx_epoll_module都是大同小异的。
首先我们还是从通用接口ngx_module_t下手。

模块的通用接口

ngx_module_t  ngx_epoll_module = {
    /* 使用宏填充前7位 */
    NGX_MODULE_V1,
    /* ctx指向的事件模块的接口 */
    &ngx_epoll_module_ctx,               /* module context */
    /* commands指向的解析配置项的结构体 */
    ngx_epoll_commands,                  /* module directives */
    /* 模块的类型 */
    NGX_EVENT_MODULE,                    /* module type */
    NULL,                                /* init master */
    NULL,                                /* init module */
    NULL,                                /* init process */
    NULL,                                /* init thread */
    NULL,                                /* exit thread */
    NULL,                                /* exit process */
    NULL,                                /* exit master */
    /* 填充预留位 */
    NGX_MODULE_V1_PADDING
};

ngx_module_t中的七个方法都没有实现,因此该结构体也没什么好说的,等下我们会分别分析ngx_epoll_module_ctx和ngx_epoll_commands。

感兴趣的配置项

ngx_epoll_commands的实现如下:

static ngx_command_t  ngx_epoll_commands[] = {

    /* epoll_events对应的是epoll_wait的第3个参数
     * 即调用epoll_wait时内核一次性最多可返回多少个事件
     * 有了这个配置,我们就可以预分配epoll_event结构体了
     */
    { ngx_string("epoll_events"),
      NGX_EVENT_CONF|NGX_CONF_TAKE1,
      ngx_conf_set_num_slot,
      0,
      offsetof(ngx_epoll_conf_t, events),
      NULL },

    /* 初始分配的异步I/O事件个数 */
    { ngx_string("worker_aio_requests"),
      NGX_EVENT_CONF|NGX_CONF_TAKE1,
      ngx_conf_set_num_slot,
      0,
      offsetof(ngx_epoll_conf_t, aio_requests),
      NULL },

      ngx_null_command
};

关于ngx_conf_set_num_slot函数,何时会被调用,请参考前一小节,它的作用就是设置传入的配置项结构体中成员的值。具体的看代码分析:

/* 首先介绍一下它的参数
 * cf: 保存从配置文件读取到的原始字符串以及相关信息。这个参数的args字段是一个ngx_str_t类型的数组,该数组首元素是这个配置指令本身,第二个元素开始才是参数
 * cmd: 该配置指令对应的ngx_command_t结构
 * conf: 存储该配置项的结构体
 */
char *
ngx_conf_set_num_slot(ngx_conf_t *cf, ngx_command_t *cmd, void *conf)
{
    char  *p = conf;

    ngx_int_t        *np;
    ngx_str_t        *value;
    ngx_conf_post_t  *post;


    /* offset成员由offsetof函数计算得出
     * 该成员一般是设置存储配置项结构体的某个成员的1值是使用
     * 即计算出该成员在结构体中的偏移量
     */
    np = (ngx_int_t *) (p + cmd->offset);

    /* 若该值已经被设置了,则直接返回"is duplicate"代表已经赋值
     * 而不是覆盖
     */
    if (*np != NGX_CONF_UNSET) {
        return "is duplicate";
    }

    /* 获取从配置文件读取到的参数
     * 并将配置指令对应的值转为整数
     * 将该值赋给需要设置的结构体成员
    value = cf->args->elts;
    *np = ngx_atoi(value[1].data, value[1].len);
    if (*np == NGX_ERROR) {
        return "invalid number";
    }

    //post成员可指向任何一个在读取配置过程中需要的数据,以便于进行配置读取的处理。大多时候不需要,设为0即可。
    if (cmd->post) {
        post = cmd->post;
        return post->post_handler(cf, post, np);
    }

    return NGX_CONF_OK;
}

存储配置项的结构体

不难看出ngx_epol