【Nginx源码】ngx_command_t学习

已于 2023-08-08 10:42:12 修改
阅读量171 收藏
点赞数
文章标签： ngx_command_t nginx源码
于 2023-08-07 10:27:29 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/Edidaughter/article/details/132141253
版权 
结构体定义：
// 指令结构体，用于定义nginx指令
// ngx_command_t (ngx_core.h)
struct ngx_command_s {
    //指令的名字
    ngx_str_t             name;

    //指令的类型，是NGX_CONF_XXX的组合，决定指令出现的位置、参数数量、类型等
    // NGX_HTTP_MAIN_CONF/NGX_HTTP_SRV_CONF/NGX_HTTP_LOC_CONF
    ngx_uint_t            type;

    // 指令解析函数，是函数指针
    // 预设有ngx_conf_set_flag_slot等，见本文件
    // cf：解析的环境结构体,重要的是cf->args，是指令字符串数组
    // cmd：该指令的结构体
    // conf当前的配置结构体，需转型后才能使用
    char               *(*set)(ngx_conf_t *cf, ngx_command_t *cmd, void *conf);

    // 专门给http/stream模块使用，决定存储在main/srv/loc的哪个层次
    // NGX_HTTP_MAIN_CONF_OFFSET/NGX_HTTP_SRV_CONF_OFFSET/NGX_HTTP_LOC_CONF_OFFSET
    // NGX_STREAM_MAIN_CONF_OFFSET
    // 其他类型的模块不使用，直接为0
    ngx_uint_t            conf;

    // 变量在conf结构体里的偏移量，可用offsetof得到
    // 主要用于nginx内置的命令解析函数，自己写命令解析函数可以置为0
    ngx_uint_t            offset;

    //解析后处理的数据
    void                 *post;
};

多态函数调用搜索关键字-ngx_conf_file.c：
rv = cmd->set(cf, cmd, conf);



看看这个：
static char *
ngx_http_core_types(ngx_conf_t *cf, ngx_command_t *cmd, void *conf)
{
    ngx_http_core_loc_conf_t *clcf = conf;

    char        *rv;
    ngx_conf_t   save;

    if (clcf->types == NULL) {
        clcf->types = ngx_array_create(cf->pool, 64, sizeof(ngx_hash_key_t));
        if (clcf->types == NULL) {
            return NGX_CONF_ERROR;
        }
    }

    save = *cf;
    cf->handler = ngx_http_core_type;
    cf->handler_conf = conf;

    rv = ngx_conf_parse(cf, NULL);

    *cf = save;

    return rv;
}


char *
ngx_conf_set_str_slot(ngx_conf_t *cf, ngx_command_t *cmd, void *conf)
{
    char  *p = conf;

    ngx_str_t        *field, *value;
    ngx_conf_post_t  *post;

    field = (ngx_str_t *) (p + cmd->offset);

    if (field->data) {
        return "is duplicate";
    }

    value = cf->args->elts;

    *field = value[1];

    if (cmd->post) {
        post = cmd->post;
        return post->post_handler(cf, post, field);
    }

    return NGX_CONF_OK;
}

比较这两个set函数，ngx_http_core_types这个函数里将cf->handler赋值了，但是
ngx_conf_set_str_slot没有，所以在ngx_conf_parse中：
char *
ngx_conf_parse(ngx_conf_t *cf, ngx_str_t *filename)
{
   for ( ;; ) {
        rc = ngx_conf_read_token(cf);
        // ...
        if (cf->handler) 
		{

            /*
             * the custom handler, i.e., that is used in the http's
             * "types { ... }" directive
             */

            if (rc == NGX_CONF_BLOCK_START) {
                ngx_conf_log_error(NGX_LOG_EMERG, cf, 0, "unexpected \"{\"");
                goto failed;
            }
            
            // 特殊的解析处理函数，可以自己定义{}的解析处理，比较自由
            // 例如 types {}、content_by_lua_block {}
            //printf("file = %s, line= %d, func =%s.\n",__FILE__,__LINE__,__func__);
            rv = (*cf->handler)(cf, NULL, cf->handler_conf);
			//printf("file = %s, line= %d, func =%s.\n",__FILE__,__LINE__,__func__);
            if (rv == NGX_CONF_OK) {
				//printf("file = %s, line= %d, func =%s.\n",__FILE__,__LINE__,__func__);
                continue;
            }

            if (rv == NGX_CONF_ERROR) {
                goto failed;
            }

            ngx_conf_log_error(NGX_LOG_EMERG, cf, 0, "%s", rv);

            goto failed;
        }
   }
}

再看一个例子，它的handler也会被赋值：
char *
ngx_http_lua_content_by_lua_block(ngx_conf_t *cf, ngx_command_t *cmd,
    void *conf)
{
    char        *rv;
    ngx_conf_t   save;

    save = *cf;
    cf->handler = ngx_http_lua_content_by_lua;
    cf->handler_conf = conf;

    rv = ngx_http_lua_conf_lua_block_parse(cf, cmd);

    *cf = save;

    return rv;
}

cmdname = access_log.                  cmdtype = ce000800.       cmdsetfunc = ngx_http_log_set_log
cmdname = add_header.                  cmdtype = 4e00000c.       cmdsetfunc = ngx_http_headers_expires
cmdname = body_filter_by_lua_file.     cmdtype = 4e000002.       cmdsetfunc = ngx_http_lua_body_filter_by_lua
cmdname = client_body_buffer_size.     cmdtype = e000002.        cmdsetfunc = ngx_conf_set_size_slot
cmdname = client_body_temp_path.       cmdtype = e00001e.        cmdsetfunc = ngx_conf_set_path_slot
cmdname = client_max_body_size.        cmdtype = e000002.        cmdsetfunc = ngx_conf_set_off_slot
cmdname = default_type.                cmdtype = e000002.        cmdsetfunc = ngx_conf_set_str_slot
cmdname = error_log.                   cmdtype = e000800.        cmdsetfunc = ngx_error_log|ngx_http_core_error_log|ngx_mail_core_error_log|ngx_stream_core_error_log
cmdname = error_page.                  cmdtype = 4e001000.       cmdsetfunc = ngx_http_core_error_page
cmdname = events.                      cmdtype = 1000101.        cmdsetfunc = ngx_events_block
cmdname = gzip.                        cmdtype = 4e000200.       cmdsetfunc = ngx_conf_set_flag_slot
cmdname = gzip_comp_level.             cmdtype = e000002.        cmdsetfunc = ngx_conf_set_num_slot
cmdname = gzip_disable.                cmdtype = e000800.        cmdsetfunc = ngx_http_gzip_disable
cmdname = gzip_min_length.             cmdtype = e000002.        cmdsetfunc = ngx_conf_set_size_slot
cmdname = gzip_types.                  cmdtype = e000800.        cmdsetfunc = ngx_conf_set_size_slot
cmdname = gzip_vary.                   cmdtype = e000200.        cmdsetfunc = ngx_conf_set_flag_slot
cmdname = http.                        cmdtype = 1000101.        cmdsetfunc = ngx_http_block
cmdname = if.                          cmdtype = c000900.        cmdsetfunc = ngx_http_rewrite_if|
cmdname = include.                     cmdtype = ff000002.       cmdsetfunc = ngx_conf_include
cmdname = init_by_lua_file.            cmdtype = 2000002.        cmdsetfunc = ngx_http_lua_init_by_lua
cmdname = keepalive_timeout.           cmdtype = e000006.        cmdsetfunc = ngx_http_core_keepalive|ngx_conf_set_msec_slot
cmdname = large_client_header_buffers. cmdtype = 6000004.        cmdsetfunc = ngx_conf_set_bufs_slot
cmdname = listen.                      cmdtype = 4000800.        cmdsetfunc = ngx_http_core_listen|ngx_mail_core_listen|ngx_stream_core_listen
cmdname = location.                    cmdtype = c000106.        cmdsetfunc = ngx_http_core_location
cmdname = log_format.                  cmdtype = 2001000.        cmdsetfunc = ngx_http_log_set_format|ngx_stream_log_set_format
cmdname = lua_code_cache.              cmdtype = 4e000200.       cmdsetfunc = ngx_http_lua_code_cache
cmdname = lua_shared_dict.             cmdtype = 2000004.        cmdsetfunc = ngx_http_lua_shared_dict
cmdname = map.                         cmdtype = 2000104.        cmdsetfunc = ngx_http_map_block|ngx_stream_map_block
cmdname = multi_accept.                cmdtype = 2000200.        cmdsetfunc = ngx_conf_set_flag_slot
cmdname = proxy_buffering.             cmdtype = e000200.        cmdsetfunc = ngx_conf_set_flag_slot
cmdname = proxy_buffers.               cmdtype = e000004.        cmdsetfunc = ngx_conf_set_bufs_slot
cmdname = proxy_buffer_size.           cmdtype = e000002.        cmdsetfunc = ngx_conf_set_size_slot|ngx_conf_set_size_slot
cmdname = proxy_busy_buffers_size.     cmdtype = e000002.        cmdsetfunc = ngx_conf_set_size_slot
cmdname = proxy_cache_path.            cmdtype = 2001000.        cmdsetfunc = ngx_http_file_cache_set_slot
cmdname = proxy_connect_timeout.       cmdtype = e000002.        cmdsetfunc = ngx_conf_set_msec_slot|ngx_conf_set_msec_slot
cmdname = proxy_http_version.          cmdtype = e000002.        cmdsetfunc = ngx_conf_set_enum_slot
cmdname = proxy_pass.                  cmdtype = c8000002.       cmdsetfunc = ngx_http_proxy_pass|ngx_stream_proxy_pass
cmdname = proxy_read_timeout.          cmdtype = e000002.        cmdsetfunc = ngx_conf_set_msec_slot
cmdname = proxy_send_timeout.          cmdtype = e000002.        cmdsetfunc = ngx_conf_set_msec_slot
cmdname = proxy_set_header.            cmdtype = e000004.        cmdsetfunc = ngx_conf_set_keyval_slot
cmdname = proxy_temp_file_write_size.  cmdtype = e000002.        cmdsetfunc = ngx_conf_set_size_slot
cmdname = return.                      cmdtype = 6c000006.       cmdsetfunc = ngx_http_rewrite_return|ngx_stream_return
cmdname = rewrite_by_lua_file.         cmdtype = 4e000002.       cmdsetfunc = ngx_http_lua_rewrite_by_lua
cmdname = root.                        cmdtype = 4e000002.       cmdsetfunc = ngx_http_core_root
cmdname = sendfile.                    cmdtype = 4e000200.       cmdsetfunc = ngx_conf_set_flag_slot
cmdname = server.                      cmdtype = 10000800.       cmdsetfunc = ngx_http_core_server|ngx_http_upstream_server|ngx_mail_core_server|ngx_stream_core_server|ngx_stream_upstream_server
cmdname = server.                      cmdtype = 2000101.        cmdsetfunc = ngx_http_core_server|ngx_http_upstream_server|ngx_mail_core_server|ngx_stream_core_server|ngx_stream_upstream_server
cmdname = server_name.                 cmdtype = 4000800.        cmdsetfunc = ngx_http_core_server_name|ngx_conf_set_str_slot
cmdname = set.                         cmdtype = 6c000004.       cmdsetfunc = ngx_http_rewrite_set|ngx_stream_set
cmdname = ssl_certificate.             cmdtype = 6000002.        cmdsetfunc = ngx_conf_set_str_array_slot|ngx_conf_set_str_array_slot|ngx_conf_set_str_array_slot
cmdname = ssl_certificate_key.         cmdtype = 6000002.        cmdsetfunc = ngx_conf_set_str_array_slot|ngx_conf_set_str_array_slot|ngx_conf_set_str_array_slot
cmdname = ssl_ciphers.                 cmdtype = 6000002.        cmdsetfunc = ngx_conf_set_str_slot|ngx_conf_set_str_slot|ngx_conf_set_str_slot
cmdname = ssl_prefer_server_ciphers.   cmdtype = 6000200.        cmdsetfunc = ngx_conf_set_flag_slot|ngx_conf_set_flag_slot|ngx_conf_set_flag_slot
cmdname = ssl_session_cache.           cmdtype = 6000006.        cmdsetfunc = ngx_http_ssl_session_cache|ngx_mail_ssl_session_cache|ngx_stream_ssl_session_cache
cmdname = ssl_session_timeout.         cmdtype = 6000002.        cmdsetfunc = ngx_conf_set_sec_slot|ngx_conf_set_sec_slot|ngx_conf_set_sec_slot
cmdname = sub_filter_once.             cmdtype = e000200.        cmdsetfunc = ngx_conf_set_flag_slot
cmdname = subs_filter.                 cmdtype = e001000.        cmdsetfunc = ngx_http_subs_filter
cmdname = subs_filter_types.           cmdtype = e000800.        cmdsetfunc = ngx_http_types_slot
cmdname = types.                       cmdtype = e000101.        cmdsetfunc = ngx_http_core_types
cmdname = upstream.                    cmdtype = 2000102.        cmdsetfunc = ngx_http_upstream|ngx_stream_upstream
cmdname = use.                         cmdtype = 2000002.        cmdsetfunc = ngx_event_use
cmdname = user.                        cmdtype = 1010006.        cmdsetfunc = ngx_set_user
cmdname = user_login.                  cmdtype = 8000001.        cmdsetfunc = ngx_http_user_login
cmdname = worker_connections.          cmdtype = 2000002.        cmdsetfunc = ngx_event_connections
cmdname = worker_processes.            cmdtype = 1010002.        cmdsetfunc = ngx_set_worker_processes
cmdname = worker_rlimit_nofile.        cmdtype = 1010002.        cmdsetfunc = ngx_conf_set_num_slot

我要精通C++
关注
  • 0
    点赞
  • 踩
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
nginx源码初读（11）--让烦恼从数据结构开始(ngx_command/ngx_module/ngx_conf)
wuchunlai_2012的博客
03-10 1100
第一点：ngx_command_t ngx_core_commands是nginx中的核心模块指令， 它的类型就是ngx_command_t。在每一个module的结构体中，也都有一个ngx_command_t。typedef struct ngx_command_s ngx_command_t;struct ngx_command_s { ngx_str_t
Nginx源码分析与实践---ngx_command_t
ZX714311728的博客
03-15 3008
从上一节了解到配置项的相关属性是由ngx_command_t这个结构体设置的，下面就来看其源码，分析一下。 .../src/core/ngx_core.h : typedef struct ngx_command_s ngx_command_t;由上可知，以s结尾的和以t结尾的是同一种类型。该头文件下还有许多类似的定义。如： typedef struct ngx_modu
深度解析ngx_command_t结构
qq_62309585的博客
01-09 649
因为HTTP框架可以使用预设的14种方法自动 地将解析出的配置项写入HTTP模块代码定义的结构体中，但HTTP模块中可能会定义3个结 构体，分别用于存储main、srv、loc级别的配置项（对应于create_main_conf、 create_srv_conf、create_loc_conf方法创建的结构体），如果需要在解析完配置项后回调某个方法，就要实现 上面的ngx_conf_post_handler_pt，并将包含post_handler的ngx_conf_post_t结构体传给post指 针。
nginx 模块相关配置及结构理解
最新发布
qq_29750559的博客
11-23 510
本文主要介绍nginx 模块相关配置及结构
Nginx之配置文件的解析
weixin_30332241的博客
06-19 329
1. ngx_command_t 为了统一配置项目的解析，Nginx 定义了如下数据类型对所有的 Nginx 配置项进行了统一的描述。 typedef struct ngx_command_s ngx_command_t; struct ngx_command_s { /* * 该配置指令的名称，如 daemon, worker_processes 等 ...
ngx_devel_kit-0.3.0
07-18
ngx_devel_kit-0.3.0
Nginx模块ngx_realtime_request
04-12
ngx_realtime_request是nginx用来统计虚拟主机流量的模块, 首先和大家说下这个模块是基于域名的，将会记录这个域名的请求量、发送字节、返回http状态码的数量，特性如下： 1、基于域名记录 2、记录请求数据量 3、...
ngx_security_headers:NGINX模块，用于发送安全头
05-05
ngx_security_headers 此NGINX模块以正确的方式（c）添加了安全标头，并删除了不安全的标头。概要http { security_headers on; ...} 运行curl -IL https://example.com/将产生添加的安全标头： ...
ngx_lua_waf-master.zip_lua_nearly11h_nginx_ngx_lua_waf
09-21
WEB应用防火墙，利用nginx的组件nginx_lua的组件，利用Lua语言开发的一个防火墙，简单
ngx_dynamic_upstream:Nginx的动态上游
05-02
该指令在nginx-1.9.0-plus中可用。地位生产准备就绪。指令dynamic_upstream 句法dynamic_upstream 默认-- 语境地点现在， ngx_dynamic_upstream仅在http上下文下支持动态上游。快速开始upstream backends { zone ...
nginx 源码学习笔记（十三）——文件读写和配置文件读取
数据库天地
05-16 292
对于c语言来说，如果需要支持多个操作系统，就需要封装一下文件的读写。封装文件的读写还有一个益处就是能够把读写异常，读写的内存控制，日志的记录封装起来，以便于其他的模块更好的应用。文件的读写一般会封装成打开文件，关闭打开的文件，读写文件。 在nginx的源码中，文件读写主要放在core/ngx_file.c，core/ngx_file.h，src/os/unix/ngx_files.h和src...
ngx_command_t 结构体中type成员的取值及其意义
Rio的博客
12-27 457
ngx_command_t 结构体 struck 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; }; ...
Nginx源码分析 - 主流程篇 - 解析配置文件（13）
热门推荐
自娱自乐的代码人
07-14 1万+
Nginx源码中比较重要的一块就是配置文件的解析。一般是解析/usr/local/nginx/conf/nginx.conf文件中的配置信息。前一篇文章，我们介绍了Nginx的模块化。Nginx的功能模块都是通过cycle->modules 模块进行管理的。而每个模块都会有自己的配置文件。
nginx中的ngx_command_t结构中的set方法在何时调用
狂客队长
05-29 4779
在nginx模块中，作为标准的模块结构体ngx_module_t，此结构主要包括了ngx_command_t，ngx_http_module_t等模块的属性，配置字段及对应的处理方法，其中ngx_command_t的结构为： struct ngx_command_s { ngx_str_t name; ngx_uint_t type; char *(*set)(ngx_conf_t *c
Nginx模块开发系列1--预备知识
weixin_49406295的博客
12-04 3414
Nginx模块开发：ngx_command_t、ngx_module_t、ngx_http_module_t
nginx学习三 nginx配置项解析详解及代码实现
yanziguilai的专栏
09-16 5447
nginx配置项解析详解及代码实现 0回顾  在上一节，用nginx简单实现了一个hello world程序：当我们在浏览器中输入lochost/hello ，浏览器就返回：hello world。为什么会这样呢，简单一点说就是当我们请求访问hello这个服务，nginx就会看配置文件中是否有，如果有，根据具体的handler处理后把处理的结果返回给用户，没有就返回not found。
nginx 源码学习笔记（四）——nginx精粹-模块
玩命写博客
03-15 6497
接下来，继续理解helloworld模块中的指令。 helloworld中的代码 /* Commands */ static ngx_command_t ngx_http_hello_world_commands[] = { { ngx_string("hello_world"), NGX_HTTP_LOC_CONF|NGX_CONF_NOARGS, ngx_h
ngx_connection_t结构体
simply the best
01-26 5915
//服务器的被动连接 struct ngx_connection_s { //连接未使用时候,data域充当连接链表中的next指针. //当连接被使用时候,data域的意义由模块而定. void *data; //连接对应的读事件 ngx_event_t *read; //连接对应的写事件 ngx_event_t
nginx安装ngx_http_mp4_module
05-24
要在 Nginx 中安装 ngx_http_mp4_module 模块，需要按照以下步骤进行操作： 1. 确认 Nginx 是否支持 ngx_http_mp4_module 模块 首先需要确认 Nginx 是否支持 ngx_http_mp4_module 模块，可以使用以下命令查看 ...

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值