ngx_set_environment

1 定义ngx_set_environment 函数 定义在 ./nginx-1.24.0/src/core/nginx.cchar**ngx_set_environment(ngx_cycle_t*cycle,ngx_uint_t*last){char**p,**env;ngx_str_t*var;ngx_uint_ti,n;ngx_core_conf_t*ccf;ngx_pool_cleanup_t*cln;ccf(ngx_core_conf_t*)ngx_get_conf(cycle-conf_ctx,ngx_core_module);if(lastNULLccf-environment){returnccf-environment;}varccf-env.elts;for(i0;iccf-env.nelts;i){if(ngx_strcmp(var[i].data,TZ)0||ngx_strncmp(var[i].data,TZ,3)0){gototz_found;}}varngx_array_push(ccf-env);if(varNULL){returnNULL;}var-len2;var-data(u_char*)TZ;varccf-env.elts;tz_found:n0;for(i0;iccf-env.nelts;i){if(var[i].data[var[i].len]){n;continue;}for(pngx_os_environ;*p;p){if(ngx_strncmp(*p,var[i].data,var[i].len)0(*p)[var[i].len]){n;break;}}}if(last){envngx_alloc((*lastn1)*sizeof(char*),cycle-log);if(envNULL){returnNULL;}*lastn;}else{clnngx_pool_cleanup_add(cycle-pool,0);if(clnNULL){returnNULL;}envngx_alloc((n1)*sizeof(char*),cycle-log);if(envNULL){returnNULL;}cln-handlerngx_cleanup_environment;cln-dataenv;}n0;for(i0;iccf-env.nelts;i){if(var[i].data[var[i].len]){env[n](char*)var[i].data;continue;}for(pngx_os_environ;*p;p){if(ngx_strncmp(*p,var[i].data,var[i].len)0(*p)[var[i].len]){env[n]*p;break;}}}env[n]NULL;if(lastNULL){ccf-environmentenv;environenv;}returnenv;}ngx_set_environment 函数的作用是 根据 Nginx 配置文件中的 env 指令构建并替换进程的环境变量数组。 Nginx 出于安全与稳定性考虑默认会清空从父进程继承的大部分环境变量。 但管理员可通过 env 指令显式保留或设置特定变量 该函数负责 收集配置中声明的变量并强制补全时区变量 TZ保障日志时间戳准确。 统计最终需要的环境变量数量分配内存构建 char ** 数组。 将构建好的数组赋值给全局 environ 变量使 C 标准库及后续通过 exec 启动的子进程继承该环境。 支持完整构建模式与增量追加模式通过 last 参数区分。2 详解1 函数签名char**ngx_set_environment(ngx_cycle_t*cycle,ngx_uint_t*last)返回值 返回构建完成的环境变量表 一个字符串数组指针数组数组的最后一个元素必须是 NULL参数1 ngx_cycle_t *cycle 运行周期上下文环境 参数2 ngx_uint_t *last 它是一个“输入-输出”参数 last NULL 从零开始统计、分配、填充完整环境数组。 结果缓存至 ccf-environment 直接替换全局 environ env last ! NULL *last 表示调用方已持有的旧环境变量数量 出参*last 被更新为本次新增的变量数量 n。 函数不修改全局 environ2 逻辑流程1 局部变量 2 复用缓存 3 确保时区变量 4 统计环境变量数目 5 分配内存 6 填充环境变量指针数组 7 更新全局状态 8 返回环境变量指针数组的地址1 局部变量{char**p,**env;ngx_str_t*var;ngx_uint_ti,n;ngx_core_conf_t*ccf;ngx_pool_cleanup_t*cln;ccf(ngx_core_conf_t*)ngx_get_conf(cycle-conf_ctx,ngx_core_module);获取 核心配置2 复用缓存if(lastNULLccf-environment){returnccf-environment;}#1 比较指针 last 是否为空指针 判断调用者传入的模式。 若为 NULL表示调用者需要函数执行完整的标准初始化流程即替换全局 environ 并缓存结果 #2 environment 字段用于缓存上一次成功构建的环境变量指针数组。 非 NULL 表示该数组之前已被成功构建且依然有效。 两个条件同时满足时才执行分支内的代码 #3 立即结束函数执行 并将缓存的指针 ccf-environment 作为返回值 有缓存可以使用无需再次构建3 确保时区变量varccf-env.elts;获取配置环境数组的起始地址for(i0;iccf-env.nelts;i){if(ngx_strcmp(var[i].data,TZ)0||ngx_strncmp(var[i].data,TZ,3)0){gototz_found;}}#1 遍历配置中声明的所有环境变量 #2 判断当前配置项是否为时区变量 判断当前字符串内容是否完全等于 TZ即仅声明变量名不带 和值。 判断当前字符串的前 3 个字符是否等于 TZ即已经包含赋值。 逻辑或任一条件满足即视为找到 TZ 变量。 只要存在任意一种形式就认为 TZ 变量已在配置中 同时捕获“仅声明保留”和“显式赋值”两种写法 确保无论管理员如何配置只要涉及 TZ 即可识别。 #3 若在数组中找到了 TZ 相关项 则直接跳转到标签 tz_found 处继续执行 跳过后续“手动添加 TZ 到数组”的代码段。varngx_array_push(ccf-env);if(varNULL){returnNULL;}var-len2;var-data(u_char*)TZ;varccf-env.elts;#1 向 ccf-env 动态数组的尾部追加一个新的元素 #2 设置新追加的元素 长度字段为 2 绑定字符串字面量地址 #3 重新获取数组基址 由于 ngx_array_push 可能导致数组扩容重新分配更大的内存块并将原有数据复制到新位置 ccf-env.elts 的起始地址可能已经改变。因此必须重新获取数组的起始地址并赋给 var4 统计环境变量数目tz_found:n0;for(i0;iccf-env.nelts;i){if(var[i].data[var[i].len]){n;continue;}for(pngx_os_environ;*p;p){if(ngx_strncmp(*p,var[i].data,var[i].len)0(*p)[var[i].len]){n;break;}}}统计最终环境变量表中实际有效的条目数量#1 tz_found: C 语言标签label 作为前面 goto tz_found; 语句的跳转目标。 无论 TZ 变量原本就在 ccf-env 数组中 还是刚刚被手动追加 程序执行流都会汇聚于此 开始进行环境变量的计数阶段。#2 初始化计数器 n 为 0。 n 用于累计最终要放入环境变量表中的条目数量#3 遍历配置文件中所有通过 env 指令声明的环境变量项#4 识别“显式赋值”格式 Nginx 配置解析器约定 若配置为 env VARVALUE; len 仅记录键名长度data[len] 位置恰好是分隔符 。 若为 env VAR;该位置通常为 \0 或空格。 精准区分“自带值的显式变量”与“仅声明键名的继承变量”。 n; 将计数器 n 增加 1表示这个完整的环境变量条目将被纳入最终列表。 如果配置项本身已经是一个完整的 NAMEVALUE 字符串 那么它无需去系统环境中查找对应的值直接就可以作为环境变量条目使用。因此必然占用一个槽位。 continue; 跳过当前循环的剩余部分直接进入下一次迭代处理下一个 env 配置项。#5 遍历操作系统原始环境表 尝试为当前仅声明了变量名的配置项找到对应的值 if (ngx_strncmp(*p, var[i].data, var[i].len) 0 (*p)[var[i].len] ) 精确匹配环境变量名 条件1 OS 变量前缀与配置键名完全一致。 条件2 检查系统环境条目中紧跟在变量名后的字符是否为 确保了只有变量名完全相同且紧接着 的条目才会被认定为匹配 计数器 n 增加 1表示找到了一个匹配的系统环境变量条目它将被纳入新环境表5 分配内存if(last){envngx_alloc((*lastn1)*sizeof(char*),cycle-log);if(envNULL){returnNULL;}*lastn;#1 last ! NULL 是追加模式 表示调用方已持有部分环境变量需追加合并新变量。 #2 分配内存 总大小 旧变量数(*last) 新增变量数(n) NULL结尾符(1)。乘以指针大小得字节数。 #3 将本次统计到的新增数量 n 写回调用方传入的指针地址 告知调用方“新数组尾部预留了 n 个槽位”。 调用方据此将旧环境变量拷贝至数组前半部分 完成完整 environ 表的拼装}else{clnngx_pool_cleanup_add(cycle-pool,0);if(clnNULL){returnNULL;}envngx_alloc((n1)*sizeof(char*),cycle-log);if(envNULL){returnNULL;}cln-handlerngx_cleanup_environment;cln-dataenv;}#1 last NULL 是完整构建模式 #2 注册内存池清理回调函数 参数 0 表示不需要为清理回调的 data 字段额外分配内存 数据由外部指针管理 #3 为环境变量指针数组分配内存。此处分配的数量为 (n 1)即 n 个有效环境变量指针 1 个末尾 NULL 哨兵 #4 绑定自定义释放函数 data 字段用于向清理回调传递必要的信息 回调函数 ngx_cleanup_environment 会接收到 env 指针作为其参数 从而能够正确地释放这块内存6 填充环境变量指针数组n0;将计数器变量 n 重置为 0for(i0;iccf-env.nelts;i){if(var[i].data[var[i].len]){env[n](char*)var[i].data;continue;}for(pngx_os_environ;*p;p){if(ngx_strncmp(*p,var[i].data,var[i].len)0(*p)[var[i].len]){env[n]*p;break;}}}#1 遍历配置声明列表 #2 识别显式赋值变量 若配置项自身包含等号如 env FOOBAR; 则直接使用该完整字符串而无需去系统环境中查找。 将当前配置项字符串的指针赋值给环境变量数组的第 n 个位置并将索引 n 自增 1。 跳过处理下一个 #3 内层循环遍历系统原始环境表 查找同名变量 直接引用操作系统环境变量池中的字符串 将系统环境变量字符串的指针*p直接赋值给新环境表的第 n 个位置并将索引 n 自增 1。env[n]NULL;添加 终止符 必须以 NULL 指针作为结束标记7 更新全局状态if(lastNULL){ccf-environmentenv;environenv;}检查 last 是否为空决定是否执行全局状态更新。 只有 last NULL 才需要将新构建的环境表缓存到核心配置中 并替换全局 environ 变量 对于last ! NULL追加模式环境表由调用者使用8 返回环境变量指针数组的地址returnenv;}返回新构建的环境变量指针数组的地址