nginx module

       nginx 支持模块化，系统中的很多功能就是一个模块，比如event、http、email 等，可以看出，模块在nginx中重要性，模块的定义在 src/core/ngx_conf_file.h中，

 

     struct ngx_module_s { ngx_uint_t ctx_index; //分类索引，在该类别下模块中的索引号，现在系统core、event、http和mail四种模块 ngx_uint_t index; //模块的索引,表示该模块在所有模块中的下标 ngx_uint_t spare0; ngx_uint_t spare1; ngx_uint_t spare2; ngx_uint_t spare3; ngx_uint_t version; void *ctx; //模块的上下文 ngx_command_t *commands; //命令集 ngx_uint_t type; //模块的类型 ngx_int_t (*init_master)(ngx_log_t *log); //master 初始化函数 ngx_int_t (*init_module)(ngx_cycle_t *cycle); //模块初始化函数 ngx_int_t (*init_process)(ngx_cycle_t *cycle); //进程初始化函数 ngx_int_t (*init_thread)(ngx_cycle_t *cycle); //线程初始化函数 void (*exit_thread)(ngx_cycle_t *cycle); //线程退出函数 void (*exit_process)(ngx_cycle_t *cycle); //进程退出函数 void (*exit_master)(ngx_cycle_t *cycle); //master 退出函数 uintptr_t spare_hook0; uintptr_t spare_hook1; uintptr_t spare_hook2; uintptr_t spare_hook3; uintptr_t spare_hook4; uintptr_t spare_hook5; uintptr_t spare_hook6; uintptr_t spare_hook7; };

 

 

    index 表示模块的索引号，就好比我们再公司中的的工号。最小的是从0开始的

 

    ctx_index  表示分类索引号，它表示了模块在该类模块中的索引号。比如我们在公司有了工号，在一个部门内部，为了内部管理的方便，给了你一个部门的编号。

 

    spare0,.....spare3 ,version  它们应该是版本相关的信息，待进一步考证。

 

    ctx 模块的上下文，不同的模块具有不同的上下文，所以这里使用了void* 表示，比如我们前面说的四种模块，就有四种模块上下文，分别是

ngx_core_module_t、ngx_event_module_t、ngx_http_module_t、 ngx_mail_module_t。模块上下文主要存放一些函数，这样可以实现对应模块的一些功能，比如core模块中创建模块的配置以及初始化配置都可以在上下文中做。

 

    command  模块的命令集。模块的很多行为需要用户指定和控制，这些命令集就是提供给用户的接口，用户通过配置文件，可以调用这些命令集，实现对模块的控制。

 

    type 模块的类型，就是上面介绍的core、mail、 event 和http

 

    init_master、 init_module、init_process、init_thread、exit_thread、exit_process、 exit_master是函数指针,它们初始化master、模块初始化、进程初始化、线程初始化、线程退出、进程退出、master退出等。模块并不是需要所有这些函数的，只是需要才进行定义就可以。

 

    spare_hook0 -- spare_hook7 填充？待考证。

 

 

    下面详细介绍下模块的上下文

    1  ngx_core_module_t;

    typedef struct { ngx_str_t name; //core上下文环境结构名字 void *(*create_conf)(ngx_cycle_t *cycle); //创建模块的配置 char *(*init_conf)(ngx_cycle_t *cycle, void *conf); //初始 模块的配置 } ngx_core_module_t;

    只有名字,模块配置的创建和初始化函数

 

    2  ngx_event_module_t

     typedef struct { ngx_str_t *name; //名字 void *(*create_conf)(ngx_cycle_t *cycle); //创建配置 char *(*init_conf)(ngx_cycle_t *cycle, void *conf);//初始化配置 ngx_event_actions_t actions; // 动作 } ngx_event_module_t;

     和core相比，就多了一个actions，这个在后面再介绍。

 

      3  ngx_http_module_t

      typedef struct { ngx_int_t (*preconfiguration)(ngx_conf_t *cf); //预先处理配置 ngx_int_t (*postconfiguration)(ngx_conf_t *cf); //配置后处理 void *(*create_main_conf)(ngx_conf_t *cf); //创建 主配置 char *(*init_main_conf)(ngx_conf_t *cf, void *conf); //初始化主配置 void *(*create_srv_conf)(ngx_conf_t *cf); //创建service 配置 char *(*merge_srv_conf)(ngx_conf_t *cf, void *prev, void *conf); //初始化service 配置 void *(*create_loc_conf)(ngx_conf_t *cf); //创建location配置 char *(*merge_loc_conf)(ngx_conf_t *cf, void *prev, void *conf); //初始化location配置 } ngx_http_module_t;

      因为http的配置比较复杂，包括主配置、service配置和location配置，所以这里的函数也比较的多

 

      4 ngx_mail_module_t

      typedef struct { ngx_mail_protocol_t *protocol; void *(*create_main_conf)(ngx_conf_t *cf); char *(*init_main_conf)(ngx_conf_t *cf, void *conf); void *(*create_srv_conf)(ngx_conf_t *cf); char *(*merge_srv_conf)(ngx_conf_t *cf, void *prev, void *conf); } ngx_mail_module_t;

 

      从上面的介绍可以看出，模块的上下文主要做一些模块信息的创建、初始化的工作，各个模块可以根据需求进行定制。

 

 

      最后我们看看这四个模块

 

     ngx_module_t ngx_core_module = { NGX_MODULE_V1, &ngx_core_module_ctx, /* module context */ ngx_core_commands, /* module directives */ NGX_CORE_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 };

    core模块比较简单，所有的函数都是空的。

 

     ngx_module_t ngx_events_module = { NGX_MODULE_V1, &ngx_events_module_ctx, /* module context */ ngx_events_commands, /* module directives */ NGX_CORE_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 }; 

     event也模块比较简单，所有的函数都是空的。

 

     ngx_module_t ngx_http_module = { NGX_MODULE_V1, &ngx_http_module_ctx, /* module context */ ngx_http_commands, /* module directives */ NGX_CORE_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 }; 

    http 也模块比较简单，所有的函数都是空的。