nginx源码分析(2)——http模块的初始化过程
2013-12-10 14:49
1066 查看
前一篇文章介绍了nginx的启动初始化过程,包括了所有模块的初始化过程,比如http模块、事件模块等。这里再详细介绍一下http模块的启动过程,还记得在前一篇文章中提到过ngx_conf_parse函数背后隐藏了大量的细节吗?这里就揭开这层神秘的面纱,去看看几个重要的http模块是如何初始化的。这里依然沿用上一篇文章的结构,首先来看几个重要的数据结构。
所有http模块都是ngx_http_module_t类型,所有的属性都是回调函数,在http模块初始化过程的不同阶段调用。当一个指令既允许出现在main块(在http{}块内,但是在server{}块外的区域)、server块(在server{}块内,但是在location{}块外的区域)、location块内时,就需要对这些指令进行继承和覆盖的处理,由merge_src_conf和merge_loc_conf完成。
[cpp] view
plaincopyprint?
typedef struct {
/**
* 在解析配置文件中http{}配置块前调用
*/
ngx_int_t (*preconfiguration)(ngx_conf_t *cf);
/**
* 在解析配置文件中http{}配置块后调用
*/
ngx_int_t (*postconfiguration)(ngx_conf_t *cf);
/**
* 创建http模块的main config
*/
void *(*create_main_conf)(ngx_conf_t *cf);
/**
* 初始化http模块的main config
*/
char *(*init_main_conf)(ngx_conf_t *cf, void *conf);
/**
* 创建http模块的server config
*/
void *(*create_srv_conf)(ngx_conf_t *cf);
/**
* 合并http模块的server config,用于实现server config到main config的指令的继承、覆盖
*/
char *(*merge_srv_conf)(ngx_conf_t *cf, void *prev, void *conf);
/**
* 创建http模块的location config
*/
void *(*create_loc_conf)(ngx_conf_t *cf);
/**
* 合并http模块的location config,用于实现location config到server config的指令的继承、覆盖
*/
char *(*merge_loc_conf)(ngx_conf_t *cf, void *prev, void *conf);
} ngx_http_module_t;
2. ngx_http_conf_ctx_t
此结构用于保存所有http模块的main、server和location的config结构。可以看到ngx_http_conf_ctx_t的三个属性就是三个数组,数组大小由ngx_http_max_module指定的,这个变量在指令http块的回调函数时初始化。还记得在上一篇介绍的ngx_module_t结构的ctx_index属性吗?对于一个http模块,ctx_index属性就指示了该模块的main、srv和loc的config结构在这三个数组中的下标。
[cpp] view
plaincopyprint?
typedef struct {
/**
* 所有模块的main config数组
*/
void **main_conf;
/**
* 所有模块的server config数组
*/
void **srv_conf;
/**
* 所有模块的location config数组
*/
void **loc_conf;
} ngx_http_conf_ctx_t;
在我们编写http模块时,经常要获取模块的main、srv和loc配置信息,nginx提供了两类宏来处理:
在处理请求时,可以通过:
[cpp] view
plaincopyprint?
#define ngx_http_get_module_main_conf(r, module) \
(r)->main_conf[module.ctx_index]
#define ngx_http_get_module_srv_conf(r, module) (r)->srv_conf[module.ctx_index]
#define ngx_http_get_module_loc_conf(r, module) (r)->loc_conf[module.ctx_index]
实现起来很简单只要传入的r是ngx_http_request_t类型的,module就是对应的模块,直接通过ctx_index索引就可以获取到对应配置结构。
在解析配置文件过程,通常用在指令的set回调函数中:
[cpp] view
plaincopyprint?
#define ngx_http_conf_get_module_main_conf(cf, module) \
((ngx_http_conf_ctx_t *) cf->ctx)->main_conf[module.ctx_index]
#define ngx_http_conf_get_module_srv_conf(cf, module) \
((ngx_http_conf_ctx_t *) cf->ctx)->srv_conf[module.ctx_index]
#define ngx_http_conf_get_module_loc_conf(cf, module) \
((ngx_http_conf_ctx_t *) cf->ctx)->loc_conf[module.ctx_index]
cf是ngx_conf_t类型,module同样是对应的模块。
Main
/ \
Events Http
/ \
Server Server
/ \ \
Location Location Location
这棵树中,每个节点对应一个配置块,配置文件的解析就是对这棵树的深度优先遍历,并对每个节点调用ngx_conf_parse函数。其中的Http节点对应的就是ngx_http_module模块,是由它驱动后面的server块和location块的解析,其他的细节部分会在nginx配置文件解析中讲解。下面先来看一下ngx_http_module的结构:
[cpp] view
plaincopyprint?
static ngx_command_t ngx_http_commands[] = {
{ ngx_string("http"),
NGX_MAIN_CONF|NGX_CONF_BLOCK|NGX_CONF_NOARGS,
ngx_http_block,
0,
0,
NULL },
ngx_null_command
};
static ngx_core_module_t ngx_http_module_ctx = {
ngx_string("http"),
NULL,
NULL
};
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
};
ngx_http_module模块只有一个http指令,也就是http{},这个指令的回调函数是ngx_http_block,而且它的类型中有NGX_CONF_BLOCK,所以这个模块会在解析所有core module时,在配置文件中遇到http{}块时被调用。也就是说http模块的初始化的入口就是ngx_http_block,下面具体看一下这个函数。
(1) 解析http块1
ngx_http_block在http/ngx_http.c中:
[cpp] view
plaincopyprint?
/* the main http context */
ctx = ngx_pcalloc(cf->pool, sizeof(ngx_http_conf_ctx_t));
if (ctx == NULL) {
return NGX_CONF_ERROR;
}
/**
* 将传递进来的conf赋值为ctx,即ngx_http_conf_ctx_t类型。
* 这个conf是ngx_cycle->conf_ctx数组中的元素,而这个元素就是
* ngx_http_module模块对应的config信息。所以这一步就完成了
* ngx_http_module模块config信息的初始化。
*/
*(ngx_http_conf_ctx_t **) conf = ctx;
首先为ngx_http_conf_ctx_t分配内存空间,然后将ctx复制给ngx_http_module的config信息,也就是说ngx_http_module模块的config信息的类型就是ngx_http_conf_ctx_t结构,具体过程上面注释写的很清楚。
[cpp] view
plaincopyprint?
ngx_http_max_module = 0;
for (m = 0; ngx_modules[m]; m++) {
if (ngx_modules[m]->type != NGX_HTTP_MODULE) {
continue;
}
ngx_modules[m]->ctx_index = ngx_http_max_module++;
}
这里对所有的http module进行计数,并更新模块的ctx_index属性。
[cpp] view
plaincopyprint?
/* the http main_conf context, it is the same in the all http contexts */
ctx->main_conf = ngx_pcalloc(cf->pool,
sizeof(void *) * ngx_http_max_module);
if (ctx->main_conf == NULL) {
return NGX_CONF_ERROR;
}
/*
* the http null srv_conf context, it is used to merge
* the server{}s' srv_conf's
*/
ctx->srv_conf = ngx_pcalloc(cf->pool, sizeof(void *) * ngx_http_max_module);
if (ctx->srv_conf == NULL) {
return NGX_CONF_ERROR;
}
/*
* the http null loc_conf context, it is used to merge
* the server{}s' loc_conf's
*/
ctx->loc_conf = ngx_pcalloc(cf->pool, sizeof(void *) * ngx_http_max_module);
if (ctx->loc_conf == NULL) {
return NGX_CONF_ERROR;
}
接下来,根据ngx_http_max_module为ctx的main、srv和loc数组分配空间。代码的注释说的很清楚,ctx->main_conf在所有的http上下文都是一样的,就是在server块和location块中都是一样的,而ctx->srv_conf和ctx->loc_conf是用于合并的,后面会具体介绍。
[cpp] view
plaincopyprint?
for (m = 0; ngx_modules[m]; m++) {
if (ngx_modules[m]->type != NGX_HTTP_MODULE) {
continue;
}
module = ngx_modules[m]->ctx;
mi = ngx_modules[m]->ctx_index;
if (module->create_main_conf) {
ctx->main_conf[mi] = module->create_main_conf(cf);
if (ctx->main_conf[mi] == NULL) {
return NGX_CONF_ERROR;
}
}
if (module->create_srv_conf) {
ctx->srv_conf[mi] = module->create_srv_conf(cf);
if (ctx->srv_conf[mi] == NULL) {
return NGX_CONF_ERROR;
}
}
if (module->create_loc_conf) {
ctx->loc_conf[mi] = module->create_loc_conf(cf);
if (ctx->loc_conf[mi] == NULL) {
return NGX_CONF_ERROR;
}
}
}
这段代码是调用所有http module的回调函数,创建http module的main、server和location的配置结构,并更新ctx的main_conf、srv_conf、loc_conf数组。
[cpp] view
plaincopyprint?
/* 先保存cf的副本,待所有http module的指令解析完再恢复 */
pcf = *cf;
/* 把解析http module的指令的上下文设置为ngx_http_conf_ctx_t */
cf->ctx = ctx;
/* 调用http module的preconfiguration回调函数 */
for (m = 0; ngx_modules[m]; m++) {
if (ngx_modules[m]->type != NGX_HTTP_MODULE) {
continue;
}
module = ngx_modules[m]->ctx;
if (module->preconfiguration) {
if (module->preconfiguration(cf) != NGX_OK) {
return NGX_CONF_ERROR;
}
}
}
这里先备份cf,待解析完整个http块再还原,然后把解析http module的上下文设置为ctx,接着调用所有http module的preconfiguration回调函数。
[cpp] view
plaincopyprint?
/* parse inside the http{} block */
cf->module_type = NGX_HTTP_MODULE; // 只解析NGX_HTTP_MODULE模块的指令,即http module的指令
cf->cmd_type = NGX_HTTP_MAIN_CONF; // 只解析NGX_HTTP_MAIN_CONF类型的指令
/* 只有符合module_type和cmd_type的指令才会被解析 */
rv = ngx_conf_parse(cf, NULL);
这里设置了cf的module_type和cmd_type用于决定此次配置文件解析的指令类型。这里的设置是完成http module中所有http main块中的指令的解析。显然这个ngx_conf_parse函数隐藏的细节应该是初始化main块,然后是多个server块,接下来就是location块。在nginx中每个块都会对应一个相应类型core module,比如整个配置文件的main块对应的就是ngx_core_module,events块对应的是ngx_event_core_module,而http块对应就是ngx_http_core_module。这些具体类型的core
module主要是处理相应块内的指令,并保存一些重要的配置信息。下面先看一下ngx_http_core_main_conf_t,也就是ngx_http_core_module的main config。
[cpp] view
plaincopyprint?
typedef struct {
/**
* 存储所有的ngx_http_core_srv_conf_t,元素的个数等于server块的个数。
*/
ngx_array_t servers;
/**
* 包含所有phase,以及注册的phase handler,这些handler在处理http请求时,
* 会被依次调用,通过ngx_http_phase_handler_t的next字段串联起来组成一个
* 链表。
*/
ngx_http_phase_engine_t phase_engine;
/**
* 以hash存储的所有request header
*/
ngx_hash_t headers_in_hash;
/**
* 被索引的nginx变量 ,比如通过rewrite模块的set指令设置的变量,会在这个hash
* 中分配空间,而诸如$http_XXX和$cookie_XXX等内建变量不会在此分配空间。
*/
ngx_hash_t variables_hash;
/**
* ngx_http_variable_t类型的数组,所有被索引的nginx变量被存储在这个数组中。
* ngx_http_variable_t结构中有属性index,是该变量在这个数组的下标。
*/
ngx_array_t variables;
ngx_uint_t ncaptures;
/**
* server names的hash表的允许的最大bucket数量,默认值是512。
*/
ngx_uint_t server_names_hash_max_size;
/**
* server names的hash表中每个桶允许占用的最大空间,默认值是ngx_cacheline_size
*/
ngx_uint_t server_names_hash_bucket_size;
/**
* variables的hash表的允许的最大bucket数量,默认值是512。
*/
ngx_uint_t variables_hash_max_size;
/**
* variables的hash表中每个桶允许占用的最大空间,默认值是64.
*/
ngx_uint_t variables_hash_bucket_size;
/**
* 主要用于初始化variables_hash变量。以hash方式存储所有的变量名,同时还保存
* 变量名和变量内容的kv对的数组,ngx_hash_t就是以这个数组进行初始化的。这个
* 变量时临时的, 只在解析配置文件时有效,在初始化variables_hash后,会被置为NULL。
*/
ngx_hash_keys_arrays_t *variables_keys;
/**
* 监听的所有端口,ngx_http_port_t类型,其中包含socket地址信息。
*/
ngx_array_t *ports;
ngx_uint_t try_files; /* unsigned try_files:1 */
/**
* 所有的phase的数组,其中每个元素是该phase上注册的handler的数组。
*/
ngx_http_phase_t phases[NGX_HTTP_LOG_PHASE + 1];
} ngx_http_core_main_conf_t;
可以看到这个配置结构包含很多重要的信息,比如nginx变量、phase handler数组等等。在ngx_http_core_module定义了大量的配置指令,它们都是在http{}块中出现的,其中包括两个重要的指令:
[cpp] view
plaincopyprint?
{ ngx_string("server"),
NGX_HTTP_MAIN_CONF|NGX_CONF_BLOCK|NGX_CONF_MULTI|NGX_CONF_NOARGS,
ngx_http_core_server,
0,
0,
NULL },
{ ngx_string("location"),
NGX_HTTP_SRV_CONF|NGX_HTTP_LOC_CONF|NGX_CONF_BLOCK|NGX_CONF_TAKE12,
ngx_http_core_location,
NGX_HTTP_SRV_CONF_OFFSET,
0,
NULL },
这两个指令分别是server和location,它们的类型中包含NGX_CONF_BLOCK,所以它们也是块指令,用于分别解析server块和location块。在前面ngx_http_block中,给cf->cmd_type指定的是NGX_HTTP_MAIN_CONF,而server指令的类型正好就是这个类型,而location指令的类型是NGX_HTTP_SRV_CONF。所以server指令的回调函数ngx_http_core_server在解析配置文件时遇到“server”时会被调用。下面看一下这个函数的具体内容。
(2) 解析server块1
[cpp] view
plaincopyprint?
ctx = ngx_pcalloc(cf->pool, sizeof(ngx_http_conf_ctx_t));
if (ctx == NULL) {
return NGX_CONF_ERROR;
}
http_ctx = cf->ctx; // 全局http module的配置
ctx->main_conf = http_ctx->main_conf;
为ctx分配空间,将ctx->main_conf指向ngx_http_module的config信息的main_conf,这样就保证了在解析http块、server块和location块时,使用的main_conf是同一份。
[cpp] view
plaincopyprint?
/* the server{}'s srv_conf */
ctx->srv_conf = ngx_pcalloc(cf->pool, sizeof(void *) * ngx_http_max_module);
if (ctx->srv_conf == NULL) {
return NGX_CONF_ERROR;
}
/* the server{}'s loc_conf */
ctx->loc_conf = ngx_pcalloc(cf->pool, sizeof(void *) * ngx_http_max_module);
if (ctx->loc_conf == NULL) {
return NGX_CONF_ERROR;
}
为ctx的srv_conf和loc_conf分配空间。
[cpp] view
plaincopyprint?
for (i = 0; ngx_modules[i]; i++) {
if (ngx_modules[i]->type != NGX_HTTP_MODULE) {
continue;
}
module = ngx_modules[i]->ctx;
if (module->create_srv_conf) {
mconf = module->create_srv_conf(cf);
if (mconf == NULL) {
return NGX_CONF_ERROR;
}
ctx->srv_conf[ngx_modules[i]->ctx_index] = mconf;
}
if (module->create_loc_conf) {
mconf = module->create_loc_conf(cf);
if (mconf == NULL) {
return NGX_CONF_ERROR;
}
ctx->loc_conf[ngx_modules[i]->ctx_index] = mconf;
}
}
调用所有模块的create_srv_conf和create_loc_conf回调函数创建模块的srv config和loc config,并更新ctx的srv_conf和loc_conf数组。这里,大家可能还记得在解析http块的ngx_http_block函数中,已经为ngx_http_conf_ctx_t分配空间,并调用所有http module的回调函数创建main、srv和loc配置结构。而这里在解析server块时,又重新创建了一个ngx_http_conf_ctx_t结构,并创建所有http
module的srv和loc配置结构。大家可能很纳闷,为什么要重复分配这个空间呢?实际上,这里是为了处理有些指令是可以同时出现在http块和server块中的情况,如果在server块中没有定义这个指令则会从http块继承,否则会直接覆盖http块中的定义。具体srv和loc块的合并在后续ngx_http_block中会处理。后面的location块的解析时,也同样会分配ngx_http_conf_ctx_t的内存,不过只会创建所有http module的loc的配置结构。
[cpp] view
plaincopyprint?
cscf = ctx->srv_conf[ngx_http_core_module.ctx_index];
cscf->ctx = ctx;
cmcf = ctx->main_conf[ngx_http_core_module.ctx_index];
cscfp = ngx_array_push(&cmcf->servers);
if (cscfp == NULL) {
return NGX_CONF_ERROR;
}
*cscfp = cscf;
在上面介绍ngx_http_core_module的main config时,有一个servers数组用于存储所有server块的配置结构,这段代码就是完成将正在解析的server块的配置信息push到这个数组中。
[cpp] view
plaincopyprint?
/* parse inside server{} */
pcf = *cf; // 保存cf的副本,在解析完server块后恢复
cf->ctx = ctx;
cf->cmd_type = NGX_HTTP_SRV_CONF; // 解析NGX_HTTP_SRV_CONF类型的指令,即server块下的指令
为解析server块做准备,可以看到这里直接洗NGX_HTTP_SRV_CONF类型的指令,也就是server块下的指令。接下来就看一下location块的解析,它指令回调函数是ngx_http_core_location。
(3) 解析location块
[cpp] view
plaincopyprint?
ctx = ngx_pcalloc(cf->pool, sizeof(ngx_http_conf_ctx_t));
if (ctx == NULL) {
return NGX_CONF_ERROR;
}
pctx = cf->ctx;
ctx->main_conf = pctx->main_conf;
ctx->srv_conf = pctx->srv_conf;
ctx->loc_conf = ngx_pcalloc(cf->pool, sizeof(void *) * ngx_http_max_module);
if (ctx->loc_conf == NULL) {
return NGX_CONF_ERROR;
}
和http块和server块类似,一开始就是为ngx_http_conf_ctx_t分配空间,这里把location块的ctx的main_conf指向唯一的main_conf,就是定义在ngx_http_module的配置结构的main_conf,而srv_conf指向的是server块配置结构的srv_conf。
[cpp] view
plaincopyprint?
for (i = 0; ngx_modules[i]; i++) {
if (ngx_modules[i]->type != NGX_HTTP_MODULE) {
continue;
}
module = ngx_modules[i]->ctx;
if (module->create_loc_conf) {
ctx->loc_conf[ngx_modules[i]->ctx_index] =
module->create_loc_conf(cf);
if (ctx->loc_conf[ngx_modules[i]->ctx_index] == NULL) {
return NGX_CONF_ERROR;
}
}
}
这里只创建所有http module的loc_conf。
[cpp] view
plaincopyprint?
clcf = ctx->loc_conf[ngx_http_core_module.ctx_index];
clcf->loc_conf = ctx->loc_conf;
value = cf->args->elts;
/* 分析location的匹配规则 */
if (cf->args->nelts == 3) { /* 包括location在内有3个参数 */
len = value[1].len;
mod = value[1].data;
name = &value[2];
if (len == 1 && mod[0] == '=') {
/**
* 字符串精确匹配
* location = /hello { ...
*/
clcf->name = *name;
clcf->exact_match = 1;
} else if (len == 2 && mod[0] == '^' && mod[1] == '~') {
/**
* 前缀匹配
* location ^~ /hello/ { ...
*/
clcf->name = *name;
clcf->noregex = 1;
} else if (len == 1 && mod[0] == '~') {
/**
* 区分大小写正则匹配
*/
if (ngx_http_core_regex_location(cf, clcf, name, 0) != NGX_OK) {
return NGX_CONF_ERROR;
}
} else if (len == 2 && mod[0] == '~' && mod[1] == '*') {
/**
* 不区分大小写正则匹配
*/
if (ngx_http_core_regex_location(cf, clcf, name, 1) != NGX_OK) {
return NGX_CONF_ERROR;
}
} else {
ngx_conf_log_error(NGX_LOG_EMERG, cf, 0,
"invalid location modifier \"%V\"", &value[1]);
return NGX_CONF_ERROR;
}
} else { /* 处理 两个参数的情况,location =/hello {... */
name = &value[1];
if (name->data[0] == '=') {
clcf->name.len = name->len - 1;
clcf->name.data = name->data + 1;
clcf->exact_match = 1;
} else if (name->data[0] == '^' && name->data[1] == '~') {
clcf->name.len = name->len - 2;
clcf->name.data = name->data + 2;
clcf->noregex = 1;
} else if (name->data[0] == '~') {
name->len--;
name->data++;
if (name->data[0] == '*') {
name->len--;
name->data++;
if (ngx_http_core_regex_location(cf, clcf, name, 1) != NGX_OK) {
return NGX_CONF_ERROR;
}
} else {
if (ngx_http_core_regex_location(cf, clcf, name, 0) != NGX_OK) {
return NGX_CONF_ERROR;
}
}
} else {
clcf->name = *name;
if (name->data[0] == '@') {
clcf->named = 1;
}
}
}
接下来的这段代码就是根据配置文件,分析这个location块的匹配规则,具体的分析见注释。
[cpp] view
plaincopyprint?
if (ngx_http_add_location(cf, &pclcf->locations, clcf) != NGX_OK) {
return NGX_CONF_ERROR;
}
把这个location的配置添加到locations队列里,后面会依据这个队列将所有的静态location组织成树结构。
[cpp] view
plaincopyprint?
save = *cf;
cf->ctx = ctx;
cf->cmd_type = NGX_HTTP_LOC_CONF; /* 只解析location块内的指令 */
rv = ngx_conf_parse(cf, NULL);
这段代码大家应该很熟悉了,就是用来解析location块内的指令。
(4) 解析server块2
在解析server块后,也就是从ngx_conf_parse函数返回,继续执行ngx_http_core_server函数。
[cpp] view
plaincopyprint?
if (rv == NGX_CONF_OK && !cscf->listen) {
ngx_memzero(&lsopt, sizeof(ngx_http_listen_opt_t));
sin = &lsopt.u.sockaddr_in;
sin->sin_family = AF_INET;
#if (NGX_WIN32)
sin->sin_port = htons(80);
#else
sin->sin_port = htons((getuid() == 0) ? 80 : 8000);
#endif
sin->sin_addr.s_addr = INADDR_ANY;
lsopt.socklen = sizeof(struct sockaddr_in);
lsopt.backlog = NGX_LISTEN_BACKLOG;
lsopt.rcvbuf = -1;
lsopt.sndbuf = -1;
#if (NGX_HAVE_SETFIB)
lsopt.setfib = -1;
#endif
lsopt.wildcard = 1;
(void) ngx_sock_ntop(&lsopt.u.sockaddr, lsopt.addr,
NGX_SOCKADDR_STRLEN, 1);
if (ngx_http_add_listen(cf, cscf, &lsopt) != NGX_OK) {
return NGX_CONF_ERROR;
}
}
这段代码是用于设置默认的监听socket,正常可以通过listen指令指定监听的端口、ip地址等信息,如果server块中没有指定listen指令,则这里会设置成默认监听80端口或8000端口,并且接收的ip地址是INADDR_ANY,也就是说接收任意网卡上的连接。ngx_http_add_listen定义在ngx_http.c中,用于添加监听的socket,后面在介绍nginx的事件模型初始化时会再详细介绍。
(5) 解析http块2
解析完http块后,即从ngx_conf_parse返回,下面看一下ngx_http_block后续的一些初始化工作。
[cpp] view
plaincopyprint?
cmcf = ctx->main_conf[ngx_http_core_module.ctx_index];
cscfp = cmcf->servers.elts;
for (m = 0; ngx_modules[m]; m++) {
if (ngx_modules[m]->type != NGX_HTTP_MODULE) {
continue;
}
module = ngx_modules[m]->ctx;
mi = ngx_modules[m]->ctx_index;
/* init http{} main_conf's */
if (module->init_main_conf) {
rv = module->init_main_conf(cf, ctx->main_conf[mi]);
if (rv != NGX_CONF_OK) {
goto failed;
}
}
rv = ngx_http_merge_servers(cf, cmcf, module, mi);
if (rv != NGX_CONF_OK) {
goto failed;
}
}
这段代码是初始化所有http module的main config,并将server config和loc config合并。调用所有http module的init_main_conf回调函数初始化main config,ngx_http_merge_servers函数中会调用模块的merge_srv_conf和merge_loc_conf回调函数进行合并。
[cpp] view
plaincopyprint?
for (s = 0; s < cmcf->servers.nelts; s++) {
clcf = cscfp[s]->ctx->loc_conf[ngx_http_core_module.ctx_index];
if (ngx_http_init_locations(cf, cscfp[s], clcf) != NGX_OK) {5
return NGX_CONF_ERROR;
}
if (ngx_http_init_static_location_trees(cf, clcf) != NGX_OK) {
return NGX_CONF_ERROR;
}
}
将所有静态location组织成树结构,便于在find config结构根据uri查找对应的location。
[cpp] view
plaincopyprint?
if (ngx_http_init_phases(cf, cmcf) != NGX_OK) {
return NGX_CONF_ERROR;
}
nginx把http请求处理的过程划分为11个phase,除了某几个phase外都可以注册phase handler。在上面ngx_http_core_main_conf_t中,属性phases保存了所有phase handler的数组,这里是完成每个phase的handler数组初始化。我们在进行nginx模块开发时,就是通过在相应phase的handler数组添加handler即可。
[cpp] view
plaincopyprint?
if (ngx_http_init_headers_in_hash(cf, cmcf) != NGX_OK) {
return NGX_CONF_ERROR;
}
将http请求的header初始化成hash结构,定义在ngx_http_request.c中的ngx_http_headers_in数组存储了所有的header。这里是根据这个数组去初始化hash结构。
[cpp] view
plaincopyprint?
for (m = 0; ngx_modules[m]; m++) {
if (ngx_modules[m]->type != NGX_HTTP_MODULE) {
continue;
}
module = ngx_modules[m]->ctx;
if (module->postconfiguration) {
if (module->postconfiguration(cf) != NGX_OK) {
return NGX_CONF_ERROR;
}
}
}
调用所有http module的postconfiguration回调函数。
[cpp] view
plaincopyprint?
if (ngx_http_variables_init_vars(cf) != NGX_OK) {
return NGX_CONF_ERROR;
}
将所有的被索引的nginx变量组织hash结构。根据ngx_http_core_main_conf_t->variables_keys去初始化ngx_http_core_main_conf_t->variables,初始化完毕会将variables_keys置为NULL。同时,会设置nginx内置变量的get_handler,比如http_XXX,cookie_XXX等。关于nginx变量也会开一篇文章专门介绍。
[cpp] view
plaincopyprint?
cf = pcf;
if (ngx_http_init_phase_handlers(cf, cmcf) != NGX_OK) {
return NGX_CONF_ERROR;
}
先恢复cf,接着初始化phase handler。nginx把所有的phase handler存放在ngx_http_core_main_conf_t->phase_engine->handlers数组中,这个数组是ngx_http_phase_handler_t类型的,这个结构有个next属性,指示的下一个调用的phase handler在phase_engine->handlers数组中的下标。也就是说nginx把http请求的处理流程(也就是phase
handler的顺序)组织成以next为连接的链表,这样在处理请求时只要遍历这个链表即可。
[cpp] view
plaincopyprint?
/* optimize the lists of ports, addresses and server names */
if (ngx_http_optimize_servers(cf, cmcf, cmcf->ports) != NGX_OK) {
return NGX_CONF_ERROR;
}
在ngx_http_optimize_servers函数中完成初始化ngx_http_conf_addr_t的wc_head、wc_tail和hash,就是以server_name为key,对应的ngx_http_core_srv_conf_t为值的hash结构,wc_head和wc_tail是带通配符的server_name。最重要的就是调用ngx_http_init_listening函数,它会调用ngx_http_add_listening添加ngx_listening_t,即监听socket,最后调用ngx_http_add_addrs。在ngx_http_add_listening内会调用ngx_http_create_listening创建新的ngx_listening_t,然后设置其handler为ngx_http_init_connection,这个函数在监听到新的连接时调用,具体就是在ngx_event_accept函数中。然后,设置ngx_listening_t相关的一些属性,rcvbuf、sndbuf、backlog等。
上面就是http块初始化的全过程,这里主要列出server块和location块的初始化。下一篇详细介绍nginx配置文件的解析。
1. 重要的数据结构
1. ngx_http_module_t所有http模块都是ngx_http_module_t类型,所有的属性都是回调函数,在http模块初始化过程的不同阶段调用。当一个指令既允许出现在main块(在http{}块内,但是在server{}块外的区域)、server块(在server{}块内,但是在location{}块外的区域)、location块内时,就需要对这些指令进行继承和覆盖的处理,由merge_src_conf和merge_loc_conf完成。
[cpp] view
plaincopyprint?
typedef struct {
/**
* 在解析配置文件中http{}配置块前调用
*/
ngx_int_t (*preconfiguration)(ngx_conf_t *cf);
/**
* 在解析配置文件中http{}配置块后调用
*/
ngx_int_t (*postconfiguration)(ngx_conf_t *cf);
/**
* 创建http模块的main config
*/
void *(*create_main_conf)(ngx_conf_t *cf);
/**
* 初始化http模块的main config
*/
char *(*init_main_conf)(ngx_conf_t *cf, void *conf);
/**
* 创建http模块的server config
*/
void *(*create_srv_conf)(ngx_conf_t *cf);
/**
* 合并http模块的server config,用于实现server config到main config的指令的继承、覆盖
*/
char *(*merge_srv_conf)(ngx_conf_t *cf, void *prev, void *conf);
/**
* 创建http模块的location config
*/
void *(*create_loc_conf)(ngx_conf_t *cf);
/**
* 合并http模块的location config,用于实现location config到server config的指令的继承、覆盖
*/
char *(*merge_loc_conf)(ngx_conf_t *cf, void *prev, void *conf);
} ngx_http_module_t;
2. ngx_http_conf_ctx_t
此结构用于保存所有http模块的main、server和location的config结构。可以看到ngx_http_conf_ctx_t的三个属性就是三个数组,数组大小由ngx_http_max_module指定的,这个变量在指令http块的回调函数时初始化。还记得在上一篇介绍的ngx_module_t结构的ctx_index属性吗?对于一个http模块,ctx_index属性就指示了该模块的main、srv和loc的config结构在这三个数组中的下标。
[cpp] view
plaincopyprint?
typedef struct {
/**
* 所有模块的main config数组
*/
void **main_conf;
/**
* 所有模块的server config数组
*/
void **srv_conf;
/**
* 所有模块的location config数组
*/
void **loc_conf;
} ngx_http_conf_ctx_t;
在我们编写http模块时,经常要获取模块的main、srv和loc配置信息,nginx提供了两类宏来处理:
在处理请求时,可以通过:
[cpp] view
plaincopyprint?
#define ngx_http_get_module_main_conf(r, module) \
(r)->main_conf[module.ctx_index]
#define ngx_http_get_module_srv_conf(r, module) (r)->srv_conf[module.ctx_index]
#define ngx_http_get_module_loc_conf(r, module) (r)->loc_conf[module.ctx_index]
实现起来很简单只要传入的r是ngx_http_request_t类型的,module就是对应的模块,直接通过ctx_index索引就可以获取到对应配置结构。
在解析配置文件过程,通常用在指令的set回调函数中:
[cpp] view
plaincopyprint?
#define ngx_http_conf_get_module_main_conf(cf, module) \
((ngx_http_conf_ctx_t *) cf->ctx)->main_conf[module.ctx_index]
#define ngx_http_conf_get_module_srv_conf(cf, module) \
((ngx_http_conf_ctx_t *) cf->ctx)->srv_conf[module.ctx_index]
#define ngx_http_conf_get_module_loc_conf(cf, module) \
((ngx_http_conf_ctx_t *) cf->ctx)->loc_conf[module.ctx_index]
cf是ngx_conf_t类型,module同样是对应的模块。
2. http模块的启动过程
前文已经提到了nginx配置文件解析时,会首先解析core module,然后由core module再去解析相应类型的module,比如由ngx_http_module(这是一个core module)负责解析所有的http module,而由ngx_events_module(也是一个core module)解析所有的event module。如果把配置文件看成一棵树:Main
/ \
Events Http
/ \
Server Server
/ \ \
Location Location Location
这棵树中,每个节点对应一个配置块,配置文件的解析就是对这棵树的深度优先遍历,并对每个节点调用ngx_conf_parse函数。其中的Http节点对应的就是ngx_http_module模块,是由它驱动后面的server块和location块的解析,其他的细节部分会在nginx配置文件解析中讲解。下面先来看一下ngx_http_module的结构:
[cpp] view
plaincopyprint?
static ngx_command_t ngx_http_commands[] = {
{ ngx_string("http"),
NGX_MAIN_CONF|NGX_CONF_BLOCK|NGX_CONF_NOARGS,
ngx_http_block,
0,
0,
NULL },
ngx_null_command
};
static ngx_core_module_t ngx_http_module_ctx = {
ngx_string("http"),
NULL,
NULL
};
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
};
ngx_http_module模块只有一个http指令,也就是http{},这个指令的回调函数是ngx_http_block,而且它的类型中有NGX_CONF_BLOCK,所以这个模块会在解析所有core module时,在配置文件中遇到http{}块时被调用。也就是说http模块的初始化的入口就是ngx_http_block,下面具体看一下这个函数。
(1) 解析http块1
ngx_http_block在http/ngx_http.c中:
[cpp] view
plaincopyprint?
/* the main http context */
ctx = ngx_pcalloc(cf->pool, sizeof(ngx_http_conf_ctx_t));
if (ctx == NULL) {
return NGX_CONF_ERROR;
}
/**
* 将传递进来的conf赋值为ctx,即ngx_http_conf_ctx_t类型。
* 这个conf是ngx_cycle->conf_ctx数组中的元素,而这个元素就是
* ngx_http_module模块对应的config信息。所以这一步就完成了
* ngx_http_module模块config信息的初始化。
*/
*(ngx_http_conf_ctx_t **) conf = ctx;
首先为ngx_http_conf_ctx_t分配内存空间,然后将ctx复制给ngx_http_module的config信息,也就是说ngx_http_module模块的config信息的类型就是ngx_http_conf_ctx_t结构,具体过程上面注释写的很清楚。
[cpp] view
plaincopyprint?
ngx_http_max_module = 0;
for (m = 0; ngx_modules[m]; m++) {
if (ngx_modules[m]->type != NGX_HTTP_MODULE) {
continue;
}
ngx_modules[m]->ctx_index = ngx_http_max_module++;
}
这里对所有的http module进行计数,并更新模块的ctx_index属性。
[cpp] view
plaincopyprint?
/* the http main_conf context, it is the same in the all http contexts */
ctx->main_conf = ngx_pcalloc(cf->pool,
sizeof(void *) * ngx_http_max_module);
if (ctx->main_conf == NULL) {
return NGX_CONF_ERROR;
}
/*
* the http null srv_conf context, it is used to merge
* the server{}s' srv_conf's
*/
ctx->srv_conf = ngx_pcalloc(cf->pool, sizeof(void *) * ngx_http_max_module);
if (ctx->srv_conf == NULL) {
return NGX_CONF_ERROR;
}
/*
* the http null loc_conf context, it is used to merge
* the server{}s' loc_conf's
*/
ctx->loc_conf = ngx_pcalloc(cf->pool, sizeof(void *) * ngx_http_max_module);
if (ctx->loc_conf == NULL) {
return NGX_CONF_ERROR;
}
接下来,根据ngx_http_max_module为ctx的main、srv和loc数组分配空间。代码的注释说的很清楚,ctx->main_conf在所有的http上下文都是一样的,就是在server块和location块中都是一样的,而ctx->srv_conf和ctx->loc_conf是用于合并的,后面会具体介绍。
[cpp] view
plaincopyprint?
for (m = 0; ngx_modules[m]; m++) {
if (ngx_modules[m]->type != NGX_HTTP_MODULE) {
continue;
}
module = ngx_modules[m]->ctx;
mi = ngx_modules[m]->ctx_index;
if (module->create_main_conf) {
ctx->main_conf[mi] = module->create_main_conf(cf);
if (ctx->main_conf[mi] == NULL) {
return NGX_CONF_ERROR;
}
}
if (module->create_srv_conf) {
ctx->srv_conf[mi] = module->create_srv_conf(cf);
if (ctx->srv_conf[mi] == NULL) {
return NGX_CONF_ERROR;
}
}
if (module->create_loc_conf) {
ctx->loc_conf[mi] = module->create_loc_conf(cf);
if (ctx->loc_conf[mi] == NULL) {
return NGX_CONF_ERROR;
}
}
}
这段代码是调用所有http module的回调函数,创建http module的main、server和location的配置结构,并更新ctx的main_conf、srv_conf、loc_conf数组。
[cpp] view
plaincopyprint?
/* 先保存cf的副本,待所有http module的指令解析完再恢复 */
pcf = *cf;
/* 把解析http module的指令的上下文设置为ngx_http_conf_ctx_t */
cf->ctx = ctx;
/* 调用http module的preconfiguration回调函数 */
for (m = 0; ngx_modules[m]; m++) {
if (ngx_modules[m]->type != NGX_HTTP_MODULE) {
continue;
}
module = ngx_modules[m]->ctx;
if (module->preconfiguration) {
if (module->preconfiguration(cf) != NGX_OK) {
return NGX_CONF_ERROR;
}
}
}
这里先备份cf,待解析完整个http块再还原,然后把解析http module的上下文设置为ctx,接着调用所有http module的preconfiguration回调函数。
[cpp] view
plaincopyprint?
/* parse inside the http{} block */
cf->module_type = NGX_HTTP_MODULE; // 只解析NGX_HTTP_MODULE模块的指令,即http module的指令
cf->cmd_type = NGX_HTTP_MAIN_CONF; // 只解析NGX_HTTP_MAIN_CONF类型的指令
/* 只有符合module_type和cmd_type的指令才会被解析 */
rv = ngx_conf_parse(cf, NULL);
这里设置了cf的module_type和cmd_type用于决定此次配置文件解析的指令类型。这里的设置是完成http module中所有http main块中的指令的解析。显然这个ngx_conf_parse函数隐藏的细节应该是初始化main块,然后是多个server块,接下来就是location块。在nginx中每个块都会对应一个相应类型core module,比如整个配置文件的main块对应的就是ngx_core_module,events块对应的是ngx_event_core_module,而http块对应就是ngx_http_core_module。这些具体类型的core
module主要是处理相应块内的指令,并保存一些重要的配置信息。下面先看一下ngx_http_core_main_conf_t,也就是ngx_http_core_module的main config。
[cpp] view
plaincopyprint?
typedef struct {
/**
* 存储所有的ngx_http_core_srv_conf_t,元素的个数等于server块的个数。
*/
ngx_array_t servers;
/**
* 包含所有phase,以及注册的phase handler,这些handler在处理http请求时,
* 会被依次调用,通过ngx_http_phase_handler_t的next字段串联起来组成一个
* 链表。
*/
ngx_http_phase_engine_t phase_engine;
/**
* 以hash存储的所有request header
*/
ngx_hash_t headers_in_hash;
/**
* 被索引的nginx变量 ,比如通过rewrite模块的set指令设置的变量,会在这个hash
* 中分配空间,而诸如$http_XXX和$cookie_XXX等内建变量不会在此分配空间。
*/
ngx_hash_t variables_hash;
/**
* ngx_http_variable_t类型的数组,所有被索引的nginx变量被存储在这个数组中。
* ngx_http_variable_t结构中有属性index,是该变量在这个数组的下标。
*/
ngx_array_t variables;
ngx_uint_t ncaptures;
/**
* server names的hash表的允许的最大bucket数量,默认值是512。
*/
ngx_uint_t server_names_hash_max_size;
/**
* server names的hash表中每个桶允许占用的最大空间,默认值是ngx_cacheline_size
*/
ngx_uint_t server_names_hash_bucket_size;
/**
* variables的hash表的允许的最大bucket数量,默认值是512。
*/
ngx_uint_t variables_hash_max_size;
/**
* variables的hash表中每个桶允许占用的最大空间,默认值是64.
*/
ngx_uint_t variables_hash_bucket_size;
/**
* 主要用于初始化variables_hash变量。以hash方式存储所有的变量名,同时还保存
* 变量名和变量内容的kv对的数组,ngx_hash_t就是以这个数组进行初始化的。这个
* 变量时临时的, 只在解析配置文件时有效,在初始化variables_hash后,会被置为NULL。
*/
ngx_hash_keys_arrays_t *variables_keys;
/**
* 监听的所有端口,ngx_http_port_t类型,其中包含socket地址信息。
*/
ngx_array_t *ports;
ngx_uint_t try_files; /* unsigned try_files:1 */
/**
* 所有的phase的数组,其中每个元素是该phase上注册的handler的数组。
*/
ngx_http_phase_t phases[NGX_HTTP_LOG_PHASE + 1];
} ngx_http_core_main_conf_t;
可以看到这个配置结构包含很多重要的信息,比如nginx变量、phase handler数组等等。在ngx_http_core_module定义了大量的配置指令,它们都是在http{}块中出现的,其中包括两个重要的指令:
[cpp] view
plaincopyprint?
{ ngx_string("server"),
NGX_HTTP_MAIN_CONF|NGX_CONF_BLOCK|NGX_CONF_MULTI|NGX_CONF_NOARGS,
ngx_http_core_server,
0,
0,
NULL },
{ ngx_string("location"),
NGX_HTTP_SRV_CONF|NGX_HTTP_LOC_CONF|NGX_CONF_BLOCK|NGX_CONF_TAKE12,
ngx_http_core_location,
NGX_HTTP_SRV_CONF_OFFSET,
0,
NULL },
这两个指令分别是server和location,它们的类型中包含NGX_CONF_BLOCK,所以它们也是块指令,用于分别解析server块和location块。在前面ngx_http_block中,给cf->cmd_type指定的是NGX_HTTP_MAIN_CONF,而server指令的类型正好就是这个类型,而location指令的类型是NGX_HTTP_SRV_CONF。所以server指令的回调函数ngx_http_core_server在解析配置文件时遇到“server”时会被调用。下面看一下这个函数的具体内容。
(2) 解析server块1
[cpp] view
plaincopyprint?
ctx = ngx_pcalloc(cf->pool, sizeof(ngx_http_conf_ctx_t));
if (ctx == NULL) {
return NGX_CONF_ERROR;
}
http_ctx = cf->ctx; // 全局http module的配置
ctx->main_conf = http_ctx->main_conf;
为ctx分配空间,将ctx->main_conf指向ngx_http_module的config信息的main_conf,这样就保证了在解析http块、server块和location块时,使用的main_conf是同一份。
[cpp] view
plaincopyprint?
/* the server{}'s srv_conf */
ctx->srv_conf = ngx_pcalloc(cf->pool, sizeof(void *) * ngx_http_max_module);
if (ctx->srv_conf == NULL) {
return NGX_CONF_ERROR;
}
/* the server{}'s loc_conf */
ctx->loc_conf = ngx_pcalloc(cf->pool, sizeof(void *) * ngx_http_max_module);
if (ctx->loc_conf == NULL) {
return NGX_CONF_ERROR;
}
为ctx的srv_conf和loc_conf分配空间。
[cpp] view
plaincopyprint?
for (i = 0; ngx_modules[i]; i++) {
if (ngx_modules[i]->type != NGX_HTTP_MODULE) {
continue;
}
module = ngx_modules[i]->ctx;
if (module->create_srv_conf) {
mconf = module->create_srv_conf(cf);
if (mconf == NULL) {
return NGX_CONF_ERROR;
}
ctx->srv_conf[ngx_modules[i]->ctx_index] = mconf;
}
if (module->create_loc_conf) {
mconf = module->create_loc_conf(cf);
if (mconf == NULL) {
return NGX_CONF_ERROR;
}
ctx->loc_conf[ngx_modules[i]->ctx_index] = mconf;
}
}
调用所有模块的create_srv_conf和create_loc_conf回调函数创建模块的srv config和loc config,并更新ctx的srv_conf和loc_conf数组。这里,大家可能还记得在解析http块的ngx_http_block函数中,已经为ngx_http_conf_ctx_t分配空间,并调用所有http module的回调函数创建main、srv和loc配置结构。而这里在解析server块时,又重新创建了一个ngx_http_conf_ctx_t结构,并创建所有http
module的srv和loc配置结构。大家可能很纳闷,为什么要重复分配这个空间呢?实际上,这里是为了处理有些指令是可以同时出现在http块和server块中的情况,如果在server块中没有定义这个指令则会从http块继承,否则会直接覆盖http块中的定义。具体srv和loc块的合并在后续ngx_http_block中会处理。后面的location块的解析时,也同样会分配ngx_http_conf_ctx_t的内存,不过只会创建所有http module的loc的配置结构。
[cpp] view
plaincopyprint?
cscf = ctx->srv_conf[ngx_http_core_module.ctx_index];
cscf->ctx = ctx;
cmcf = ctx->main_conf[ngx_http_core_module.ctx_index];
cscfp = ngx_array_push(&cmcf->servers);
if (cscfp == NULL) {
return NGX_CONF_ERROR;
}
*cscfp = cscf;
在上面介绍ngx_http_core_module的main config时,有一个servers数组用于存储所有server块的配置结构,这段代码就是完成将正在解析的server块的配置信息push到这个数组中。
[cpp] view
plaincopyprint?
/* parse inside server{} */
pcf = *cf; // 保存cf的副本,在解析完server块后恢复
cf->ctx = ctx;
cf->cmd_type = NGX_HTTP_SRV_CONF; // 解析NGX_HTTP_SRV_CONF类型的指令,即server块下的指令
为解析server块做准备,可以看到这里直接洗NGX_HTTP_SRV_CONF类型的指令,也就是server块下的指令。接下来就看一下location块的解析,它指令回调函数是ngx_http_core_location。
(3) 解析location块
[cpp] view
plaincopyprint?
ctx = ngx_pcalloc(cf->pool, sizeof(ngx_http_conf_ctx_t));
if (ctx == NULL) {
return NGX_CONF_ERROR;
}
pctx = cf->ctx;
ctx->main_conf = pctx->main_conf;
ctx->srv_conf = pctx->srv_conf;
ctx->loc_conf = ngx_pcalloc(cf->pool, sizeof(void *) * ngx_http_max_module);
if (ctx->loc_conf == NULL) {
return NGX_CONF_ERROR;
}
和http块和server块类似,一开始就是为ngx_http_conf_ctx_t分配空间,这里把location块的ctx的main_conf指向唯一的main_conf,就是定义在ngx_http_module的配置结构的main_conf,而srv_conf指向的是server块配置结构的srv_conf。
[cpp] view
plaincopyprint?
for (i = 0; ngx_modules[i]; i++) {
if (ngx_modules[i]->type != NGX_HTTP_MODULE) {
continue;
}
module = ngx_modules[i]->ctx;
if (module->create_loc_conf) {
ctx->loc_conf[ngx_modules[i]->ctx_index] =
module->create_loc_conf(cf);
if (ctx->loc_conf[ngx_modules[i]->ctx_index] == NULL) {
return NGX_CONF_ERROR;
}
}
}
这里只创建所有http module的loc_conf。
[cpp] view
plaincopyprint?
clcf = ctx->loc_conf[ngx_http_core_module.ctx_index];
clcf->loc_conf = ctx->loc_conf;
value = cf->args->elts;
/* 分析location的匹配规则 */
if (cf->args->nelts == 3) { /* 包括location在内有3个参数 */
len = value[1].len;
mod = value[1].data;
name = &value[2];
if (len == 1 && mod[0] == '=') {
/**
* 字符串精确匹配
* location = /hello { ...
*/
clcf->name = *name;
clcf->exact_match = 1;
} else if (len == 2 && mod[0] == '^' && mod[1] == '~') {
/**
* 前缀匹配
* location ^~ /hello/ { ...
*/
clcf->name = *name;
clcf->noregex = 1;
} else if (len == 1 && mod[0] == '~') {
/**
* 区分大小写正则匹配
*/
if (ngx_http_core_regex_location(cf, clcf, name, 0) != NGX_OK) {
return NGX_CONF_ERROR;
}
} else if (len == 2 && mod[0] == '~' && mod[1] == '*') {
/**
* 不区分大小写正则匹配
*/
if (ngx_http_core_regex_location(cf, clcf, name, 1) != NGX_OK) {
return NGX_CONF_ERROR;
}
} else {
ngx_conf_log_error(NGX_LOG_EMERG, cf, 0,
"invalid location modifier \"%V\"", &value[1]);
return NGX_CONF_ERROR;
}
} else { /* 处理 两个参数的情况,location =/hello {... */
name = &value[1];
if (name->data[0] == '=') {
clcf->name.len = name->len - 1;
clcf->name.data = name->data + 1;
clcf->exact_match = 1;
} else if (name->data[0] == '^' && name->data[1] == '~') {
clcf->name.len = name->len - 2;
clcf->name.data = name->data + 2;
clcf->noregex = 1;
} else if (name->data[0] == '~') {
name->len--;
name->data++;
if (name->data[0] == '*') {
name->len--;
name->data++;
if (ngx_http_core_regex_location(cf, clcf, name, 1) != NGX_OK) {
return NGX_CONF_ERROR;
}
} else {
if (ngx_http_core_regex_location(cf, clcf, name, 0) != NGX_OK) {
return NGX_CONF_ERROR;
}
}
} else {
clcf->name = *name;
if (name->data[0] == '@') {
clcf->named = 1;
}
}
}
接下来的这段代码就是根据配置文件,分析这个location块的匹配规则,具体的分析见注释。
[cpp] view
plaincopyprint?
if (ngx_http_add_location(cf, &pclcf->locations, clcf) != NGX_OK) {
return NGX_CONF_ERROR;
}
把这个location的配置添加到locations队列里,后面会依据这个队列将所有的静态location组织成树结构。
[cpp] view
plaincopyprint?
save = *cf;
cf->ctx = ctx;
cf->cmd_type = NGX_HTTP_LOC_CONF; /* 只解析location块内的指令 */
rv = ngx_conf_parse(cf, NULL);
这段代码大家应该很熟悉了,就是用来解析location块内的指令。
(4) 解析server块2
在解析server块后,也就是从ngx_conf_parse函数返回,继续执行ngx_http_core_server函数。
[cpp] view
plaincopyprint?
if (rv == NGX_CONF_OK && !cscf->listen) {
ngx_memzero(&lsopt, sizeof(ngx_http_listen_opt_t));
sin = &lsopt.u.sockaddr_in;
sin->sin_family = AF_INET;
#if (NGX_WIN32)
sin->sin_port = htons(80);
#else
sin->sin_port = htons((getuid() == 0) ? 80 : 8000);
#endif
sin->sin_addr.s_addr = INADDR_ANY;
lsopt.socklen = sizeof(struct sockaddr_in);
lsopt.backlog = NGX_LISTEN_BACKLOG;
lsopt.rcvbuf = -1;
lsopt.sndbuf = -1;
#if (NGX_HAVE_SETFIB)
lsopt.setfib = -1;
#endif
lsopt.wildcard = 1;
(void) ngx_sock_ntop(&lsopt.u.sockaddr, lsopt.addr,
NGX_SOCKADDR_STRLEN, 1);
if (ngx_http_add_listen(cf, cscf, &lsopt) != NGX_OK) {
return NGX_CONF_ERROR;
}
}
这段代码是用于设置默认的监听socket,正常可以通过listen指令指定监听的端口、ip地址等信息,如果server块中没有指定listen指令,则这里会设置成默认监听80端口或8000端口,并且接收的ip地址是INADDR_ANY,也就是说接收任意网卡上的连接。ngx_http_add_listen定义在ngx_http.c中,用于添加监听的socket,后面在介绍nginx的事件模型初始化时会再详细介绍。
(5) 解析http块2
解析完http块后,即从ngx_conf_parse返回,下面看一下ngx_http_block后续的一些初始化工作。
[cpp] view
plaincopyprint?
cmcf = ctx->main_conf[ngx_http_core_module.ctx_index];
cscfp = cmcf->servers.elts;
for (m = 0; ngx_modules[m]; m++) {
if (ngx_modules[m]->type != NGX_HTTP_MODULE) {
continue;
}
module = ngx_modules[m]->ctx;
mi = ngx_modules[m]->ctx_index;
/* init http{} main_conf's */
if (module->init_main_conf) {
rv = module->init_main_conf(cf, ctx->main_conf[mi]);
if (rv != NGX_CONF_OK) {
goto failed;
}
}
rv = ngx_http_merge_servers(cf, cmcf, module, mi);
if (rv != NGX_CONF_OK) {
goto failed;
}
}
这段代码是初始化所有http module的main config,并将server config和loc config合并。调用所有http module的init_main_conf回调函数初始化main config,ngx_http_merge_servers函数中会调用模块的merge_srv_conf和merge_loc_conf回调函数进行合并。
[cpp] view
plaincopyprint?
for (s = 0; s < cmcf->servers.nelts; s++) {
clcf = cscfp[s]->ctx->loc_conf[ngx_http_core_module.ctx_index];
if (ngx_http_init_locations(cf, cscfp[s], clcf) != NGX_OK) {5
return NGX_CONF_ERROR;
}
if (ngx_http_init_static_location_trees(cf, clcf) != NGX_OK) {
return NGX_CONF_ERROR;
}
}
将所有静态location组织成树结构,便于在find config结构根据uri查找对应的location。
[cpp] view
plaincopyprint?
if (ngx_http_init_phases(cf, cmcf) != NGX_OK) {
return NGX_CONF_ERROR;
}
nginx把http请求处理的过程划分为11个phase,除了某几个phase外都可以注册phase handler。在上面ngx_http_core_main_conf_t中,属性phases保存了所有phase handler的数组,这里是完成每个phase的handler数组初始化。我们在进行nginx模块开发时,就是通过在相应phase的handler数组添加handler即可。
[cpp] view
plaincopyprint?
if (ngx_http_init_headers_in_hash(cf, cmcf) != NGX_OK) {
return NGX_CONF_ERROR;
}
将http请求的header初始化成hash结构,定义在ngx_http_request.c中的ngx_http_headers_in数组存储了所有的header。这里是根据这个数组去初始化hash结构。
[cpp] view
plaincopyprint?
for (m = 0; ngx_modules[m]; m++) {
if (ngx_modules[m]->type != NGX_HTTP_MODULE) {
continue;
}
module = ngx_modules[m]->ctx;
if (module->postconfiguration) {
if (module->postconfiguration(cf) != NGX_OK) {
return NGX_CONF_ERROR;
}
}
}
调用所有http module的postconfiguration回调函数。
[cpp] view
plaincopyprint?
if (ngx_http_variables_init_vars(cf) != NGX_OK) {
return NGX_CONF_ERROR;
}
将所有的被索引的nginx变量组织hash结构。根据ngx_http_core_main_conf_t->variables_keys去初始化ngx_http_core_main_conf_t->variables,初始化完毕会将variables_keys置为NULL。同时,会设置nginx内置变量的get_handler,比如http_XXX,cookie_XXX等。关于nginx变量也会开一篇文章专门介绍。
[cpp] view
plaincopyprint?
cf = pcf;
if (ngx_http_init_phase_handlers(cf, cmcf) != NGX_OK) {
return NGX_CONF_ERROR;
}
先恢复cf,接着初始化phase handler。nginx把所有的phase handler存放在ngx_http_core_main_conf_t->phase_engine->handlers数组中,这个数组是ngx_http_phase_handler_t类型的,这个结构有个next属性,指示的下一个调用的phase handler在phase_engine->handlers数组中的下标。也就是说nginx把http请求的处理流程(也就是phase
handler的顺序)组织成以next为连接的链表,这样在处理请求时只要遍历这个链表即可。
[cpp] view
plaincopyprint?
/* optimize the lists of ports, addresses and server names */
if (ngx_http_optimize_servers(cf, cmcf, cmcf->ports) != NGX_OK) {
return NGX_CONF_ERROR;
}
在ngx_http_optimize_servers函数中完成初始化ngx_http_conf_addr_t的wc_head、wc_tail和hash,就是以server_name为key,对应的ngx_http_core_srv_conf_t为值的hash结构,wc_head和wc_tail是带通配符的server_name。最重要的就是调用ngx_http_init_listening函数,它会调用ngx_http_add_listening添加ngx_listening_t,即监听socket,最后调用ngx_http_add_addrs。在ngx_http_add_listening内会调用ngx_http_create_listening创建新的ngx_listening_t,然后设置其handler为ngx_http_init_connection,这个函数在监听到新的连接时调用,具体就是在ngx_event_accept函数中。然后,设置ngx_listening_t相关的一些属性,rcvbuf、sndbuf、backlog等。
上面就是http块初始化的全过程,这里主要列出server块和location块的初始化。下一篇详细介绍nginx配置文件的解析。
相关文章推荐
- nginx源码分析(2)——http模块的初始化过程
- Nginx源码分析 - HTTP模块篇 - ngx_http_block函数和HTTP模块的初始化
- Nginx源码分析 - HTTP模块篇 - ngx_http_wait_request_handler函数和HTTP Request解析过程
- Nginx源码分析 - HTTP模块篇 - ngx_http_optimize_servers函数和TCP连接建立过程
- nginx源码分析—模块及其初始化 .
- Nginx 源码阅读笔记9 http 模块初始化
- Nginx源码分析-启动初始化过程(一)
- Nginx源码分析 - Event事件篇 - Event模块和配置的初始化
- Nginx源码分析与实践---(一)编写一个简单的Http模块
- Nginx源码分析-启动初始化过程(二)
- Nginx源码分析---Nginx启动初始化过程(一)
- nginx源码分析—模块及其初始化
- Nginx源码分析 - Event事件篇 - Event模块和配置的初始化
- Nginx源码分析 - 主流程篇 - 模块的初始化
- nginx源码分析—模块及其初始化
- Nginx源码分析-启动初始化过程(一)
- Nginx源码分析-启动初始化过程(二)
- nginx源码分析—模块及其初始化(二)
- Nginx源码分析---Nginx启动初始化过程(二)
- nginx源码分析—模块及其初始化