nginx脚本原理if指令实现详解

爱编码的钓鱼佬

已于 2024-09-14 15:51:31 修改

阅读量1.3k

点赞数 29

分类专栏： nginx 文章标签： nginx 脚本原理脚本编译变量实现原理

于 2024-06-12 15:51:21 首次发布

本文链接：https://blog.csdn.net/wb1986218/article/details/139624528

版权

nginx 专栏收录该内容

4 篇文章 0 订阅

订阅专栏

之前的文章我们探讨了nginx的变量，接着就是脚本原理，也就是复杂变量，理解了前面的实现原理，接下来了解if，break，return,set就要简单多。

指令有不少，没必要全部探讨，了解了其中之一即可，实现基本原理都一样，实现方式大同小异。理解了指令实现原理，我们就可以开发属于自己的配置指令。

我们以if指令为例，配置如下

if($remote=127.0.0.1){ #注：是= 不是==

return 200 'you request is from local';

}

以此来分析nginx是如何编译(翻译)该指令，并如何执行的。

（题外话，我的源码取自angie，nginx版本为1.25.4）

其脚本基本原理不变：

将指令翻译成一个个执行单元，然后依次执行每个单元

其指令存放在ngx_http_rewrite_loc_conf_t的code数组中，后续是否有指令需要执行也是判断此数组是否为空

if指令的实现源码在 ngx_http_rewrite_module.c中，（此模块在http rewrite阶段实现，为什么在此阶段实现可以自行google或bing，但是确实有必要去了解下）

编译：

我们先看if的配置解析函数，一开始就是重新建立了一个loc_conf，至于为什么就是上面黑字提到的。

其中的ngx_http_rewrite_if_condition则是处理和编译if($remote=127.0.0.1)这个条件字符串

大致流程是

找出变量调用ngx_http_rewrite_variable生成其code_t

找到=号后的值，调用ngx_http_rewrite_value生成其code_t

最后生成=号的code_t和if的code_t

1.首先找出表达式中变量 remote和值 127.0.0.1，并顺带判断表达式的合法性

2.调用ngx_http_rewrite_variable为变量remote生成值计算的code_t，code_t取自上面说的code数组,其执行函数为ngx_http_script_var_code。跟之前的复杂变量不同的是，这里不需要计算变量长度。

3.提取=号后面的常量值或变量或复杂变量，我们看处理函数ngx_http_rewrite_value的源码

static char *
ngx_http_rewrite_value(ngx_conf_t *cf, ngx_http_rewrite_loc_conf_t *lcf,
    ngx_str_t *value)
{
    ngx_int_t                              n;
    ngx_http_script_compile_t              sc;
    ngx_http_script_value_code_t          *val;
    ngx_http_script_complex_value_code_t  *complex;

    n = ngx_http_script_variables_count(value);//获取变量数量

    if (n == 0) {
        //按常量处理，常量值使用
        val = ngx_http_script_start_code(cf->pool, &lcf->codes,
                                         sizeof(ngx_http_script_value_code_t));
        if (val == NULL) {
            return NGX_CONF_ERROR;
        }

        n = ngx_atoi(value->data, value->len);

        if (n == NGX_ERROR) {
            n = 0;
        }

        val->code = ngx_http_script_value_code;//执行函数
        val->value = (uintptr_t) n;
        val->text_len = (uintptr_t) value->len;//保存常量长度
        val->text_data = (uintptr_t) value->data;//保存常量值首地址

        return NGX_CONF_OK;
    }
    //下面走复杂变量的编译逻辑，前面文章有详述，这不再解析了
    complex = ngx_http_script_start_code(cf->pool, &lcf->codes,
                                 sizeof(ngx_http_script_complex_value_code_t));
    if (complex == NULL) {
        return NGX_CONF_ERROR;
    }

    complex->code = ngx_http_script_complex_value_code;
    complex->lengths = NULL;

    ngx_memzero(&sc, sizeof(ngx_http_script_compile_t));

    sc.cf = cf;
    sc.source = value;
    sc.lengths = &complex->lengths;
    sc.values = &lcf->codes;
    sc.variables = n;
    sc.complete_lengths = 1;

    if (ngx_http_script_compile(&sc) != NGX_OK) {
        return NGX_CONF_ERROR;
    }

    return NGX_CONF_OK;
}

函数也比较简单，=号后面的条件是常量还是变量(或复杂变量)，如果是常量直接生成ngx_http_script_value_code_t，存放常量的值和长度，执行函数为ngx_http_script_value_code

然后就是为运算符=，生成了一个code_t ，其执行函数为ngx_http_script_equal_code

最后为if生成一个ngx_http_script_if_code_t，其执行函数是ngx_http_script_if_code

到这里的，我们配置示例中的if指令就算编译完成了。

执行：

从上面的编译不知道大家是否能看出或体会一点点"味道"，熟悉函数调用的可能会体会到似曾相识的感觉。有一种压栈的感觉，先把参数和其值压栈，再压运算符=，最后再压入if指令。

接下来我们看执行了，我们看ngx_http_rewrite_handler函数

首先是看有没有需要执行的指令，即codes数组是否为空。

如果有，则生成ngx_http_script_engine_t来执行之前编辑好的指令集。

e->sp = ngx_pcalloc(r->pool,
rlcf->stack_size * sizeof(ngx_http_variable_value_t));

与前面复杂变量不同的是，这里会为engine_t中的sp分配“栈”空间，栈大小为 rlcf->stack_size(这个大小是固定的，虽然在merge有合并，但是未提供配置，固定是10)，生成可以存储10个变量值的空间（类似cpu的sp寄存器）。看到这应该有点相似感觉了吧。

engine_t的ip类似cpu的指令寄存器，sp类似堆栈寄存器，指令执行的结果存放在sp中。前面的复杂变量只用到了ip，因此未做解析。

下面看执行，也是一样的如下

while (*(uintptr_t *) e->ip) {
code = *(ngx_http_script_code_pt *) e->ip;//取当前指令code_t
code(e); //执行指令函数
}

然后我们逐个来看编译生成的code_t的执行函数

1.执行remote变量的code_t，执行函数为ngx_http_script_var_code，计算(获取)出remote的值

void
ngx_http_script_var_code(ngx_http_script_engine_t *e)
{
    ngx_http_variable_value_t   *value;
    ngx_http_script_var_code_t  *code;

    ngx_log_debug0(NGX_LOG_DEBUG_HTTP, e->request->connection->log, 0,
                   "http script var");

    code = (ngx_http_script_var_code_t *) e->ip;//取当前code_t

    e->ip += sizeof(ngx_http_script_var_code_t);//ip偏移到下个code_t

    value = ngx_http_get_flushed_variable(e->request, code->index);//计算变量值

    if (value && !value->not_found) {
        ngx_log_debug1(NGX_LOG_DEBUG_HTTP, e->request->connection->log, 0,
                       "http script var: \"%v\"", value);

        *e->sp = *value; //值结果存放到sp中，
        e->sp++;        //sp偏移到下个位置

        return;
    }

    *e->sp = ngx_http_variable_null_value;
    e->sp++;
}

2.执行等号后的常量值的code_t，执行函数为ngx_http_script_value_code

void
ngx_http_script_value_code(ngx_http_script_engine_t *e)
{
    ngx_http_script_value_code_t  *code;

    code = (ngx_http_script_value_code_t *) e->ip;//获取当前code_t

    e->ip += sizeof(ngx_http_script_value_code_t);//ip偏移到下个code_t

    e->sp->len = code->text_len;//由于此code_t是常量，其值直接存入sp中
    e->sp->data = (u_char *) code->text_data;

    ngx_log_debug1(NGX_LOG_DEBUG_HTTP, e->request->connection->log, 0,
                   "http script value: \"%v\"", e->sp);

    e->sp++;//sp偏移到下个位置
}

3.执行等号code_t，执行函数ngx_http_script_equal_code

void ngx_http_script_equal_code(ngx_http_script_engine_t *e)
{
    ngx_http_variable_value_t  *val, *res;

    ngx_log_debug0(NGX_LOG_DEBUG_HTTP, e->request->connection->log, 0,
                   "http script equal");

    e->sp--;    //sp回退，因为常量code_t执行后，对sp++了，所以要取到常量值，必须回退
    val = e->sp;    //取到值
    res = e->sp - 1;//取变量

    e->ip += sizeof(uintptr_t);
    
    //判断变量和值是否相等
    if (val->len == res->len
        && ngx_strncmp(val->data, res->data, res->len) == 0)
    {
        *res = ngx_http_variable_true_value;//相等则设置为true值，将remote的值设置为true
        return;
    }

    ngx_log_debug0(NGX_LOG_DEBUG_HTTP, e->request->connection->log, 0,
                   "http script equal: no");

    *res = ngx_http_variable_null_value;//不等则置为空值
}

4.最后执行if指令的code_t，执行函数ngx_http_script_if_code

void ngx_http_script_if_code(ngx_http_script_engine_t *e)
{
    ngx_http_script_if_code_t  *code;

    code = (ngx_http_script_if_code_t *) e->ip;//取if_code

    ngx_log_debug0(NGX_LOG_DEBUG_HTTP, e->request->connection->log, 0,
                   "http script if");

    e->sp--;//这里为什么还要回退呢，前面的等号运算符的执行回退了一次，执行了值的sp，再回退一次，指                
             //向了remote的sp

    if (e->sp->len && (e->sp->len != 1 || e->sp->data[0] != '0')) {
        if (code->loc_conf) {
            e->request->loc_conf = code->loc_conf;
            ngx_http_update_location_config(e->request);//这里需要更新location
        }
        //第一个值有效，则 当前判断成功，指向下个指令，即if()后，{}里面的指令，在这里就是指向    
           //return的code_t
        e->ip += sizeof(ngx_http_script_if_code_t);
        return;
    }

    ngx_log_debug0(NGX_LOG_DEBUG_HTTP, e->request->connection->log, 0,
                   "http script if: false");

    e->ip += code->next;//
}

整个if的执行就到此结束了，接下来要执行的就是我们if条件成立后，{}内部的指令了。

总结如下：

编译：

1.生成运算符等号前变量的code_t，(运算符前面的必须是变量，源码就是这样实现的)，

2.生成运算符后的值code_t，值可以是常量，变量，复杂变量。
3.生成运算符的code_t

4.生成if的code_t

执行：

逐个执行code的函数，最终结果的处理逻辑是由if_code_t执行函数来完成的。

但是欲彻底理解，就如我前面提到的必须，了解这些指令为什么要在rewrite阶段，而不其他阶段，nginx的框架是如此设计的，具体的原因也不是几句话能说清楚的，文章篇幅有限，本文直将if指令的实现，其他的自行google和bing

在此感谢大家的关注和点赞，若有描述不妥或不正确不准确的希望评论区指正，感谢~