ngx_create_pidfile

1 定义ngx_create_pidfile 函数 定义在 ./nginx-1.24.0/src/core/ngx_cycle.cngx_int_tngx_create_pidfile(ngx_str_t*name,ngx_log_t*log){size_tlen;ngx_int_trc;ngx_uint_tcreate;ngx_file_tfile;u_char pid[NGX_INT64_LEN2];if(ngx_processNGX_PROCESS_MASTER){returnNGX_OK;}ngx_memzero(file,sizeof(ngx_file_t));file.name*name;file.loglog;createngx_test_config?NGX_FILE_CREATE_OR_OPEN:NGX_FILE_TRUNCATE;file.fdngx_open_file(file.name.data,NGX_FILE_RDWR,create,NGX_FILE_DEFAULT_ACCESS);if(file.fdNGX_INVALID_FILE){ngx_log_error(NGX_LOG_EMERG,log,ngx_errno,ngx_open_file_n \%s\ failed,file.name.data);returnNGX_ERROR;}rcNGX_OK;if(!ngx_test_config){lenngx_snprintf(pid,NGX_INT64_LEN2,%P%N,ngx_pid)-pid;if(ngx_write_file(file,pid,len,0)NGX_ERROR){rcNGX_ERROR;}}if(ngx_close_file(file.fd)NGX_FILE_ERROR){ngx_log_error(NGX_LOG_ALERT,log,ngx_errno,ngx_close_file_n \%s\ failed,file.name.data);}returnrc;}用于创建或更新 nginx 的 PID 文件 将当前主进程的进程号PID写入指定文件。2 详解1 函数签名ngx_int_tngx_create_pidfile(ngx_str_t*name,ngx_log_t*log)返回值 该函数返回一个状态码 NGX_OK为 0表示成功。 NGX_ERROR为 -1表示失败。参数 参数 1ngx_str_t *name 指定 PID 文件的路径和文件名 参数 2ngx_log_t *log 提供日志上下文2 逻辑流程1 局部变量 2 进程类型判断 3 初始化文件结构 4 设置文件打开标志 5 打开或创建PID 文件 6 写入 PID 7 返回处理结果状态码1 局部变量{size_tlen;ngx_int_trc;ngx_uint_tcreate;ngx_file_tfile;u_char pid[NGX_INT64_LEN2];NGX_INT64_LEN Nginx 宏定义表示 64 位整数转换为十进制字符串所需的最大字符数 值为 (sizeof(-9223372036854775808) - 1) 通常是 20。 1用于存储换行符 \nPID 文件惯例以换行结尾。 1用于存储字符串结束符 \0C 字符串标准。 合计 2。 作用作为格式化 PID 字符串的缓冲区。2 进程类型判断if(ngx_processNGX_PROCESS_MASTER){returnNGX_OK;}#1 ngx_process 这是一个全局变量表示当前进程的类型。 NGX_PROCESS_MASTER 这是一个宏定义常量代表主进程的类型标识。#2 检查当前进程的类型标识是否大于主进程标识。 由于 NGX_PROCESS_MASTER 通常为 0而其他进程类型大于 0 这个判断等价于“当前进程是不是主进程” 如果条件成立是真说明当前是子进程Worker 或 Helper。 如果条件不成立是假说明当前是主进程。 提前返回return NGX_OK; 如果是子进程直接结束函数返回 NGX_OK成功。 如果是主进程跳过此 if 块继续执行后续的文件打开和写入逻辑。#3 为什么只有主进程创建 PID 文件 PID 文件通常是 nginx.pid用于记录主进程的进程 ID 以便外部管理工具如 nginx -s reload、nginx -s stop能够通过向该 PID 发送信号来控制 nginx。 如果由工作进程写入 PID 文件那么外部信号将发送给工作进程 而工作进程不会处理 reload、stop 等控制信号这些信号应由主进程处理从而导致管理命令失效。3 初始化文件结构ngx_memzero(file,sizeof(ngx_file_t));file.name*name;file.loglog;将 file 结构体所占用的内存全部清零 将传入的路径字符串name赋值给文件结构的 name 成员 将日志指针赋值给文件结构的 log 成员4 设置文件打开标志createngx_test_config?NGX_FILE_CREATE_OR_OPEN:NGX_FILE_TRUNCATE;根据是否处于配置测试模式设置文件打开标志。 ngx_test_config 是一个全局标志 当 nginx 以 -t 参数启动时被设置为非零值表示仅测试配置文件不实际运行服务。 若处于测试模式使用 NGX_FILE_CREATE_OR_OPEN打开或创建文件但不截断。 否则使用 NGX_FILE_TRUNCATE打开并截断文件清空原有内容。 意义 测试模式下的保护 测试配置时可能系统中已有正在运行的 nginx 实例其 PID 文件不能被覆盖或清空。 使用 NGX_FILE_CREATE_OR_OPEN 可以保留原有内容仅验证文件是否可写 避免破坏正在运行的 nginx 的管理入口。 正常启动时的正确行为 正常启动时需要将当前主进程的 PID 写入文件 因此先用 NGX_FILE_TRUNCATE 清空文件 确保文件中只有最新的 PID且不包含旧数据。5 打开或创建PID 文件file.fdngx_open_file(file.name.data,NGX_FILE_RDWR,create,NGX_FILE_DEFAULT_ACCESS);if(file.fdNGX_INVALID_FILE){ngx_log_error(NGX_LOG_EMERG,log,ngx_errno,ngx_open_file_n \%s\ failed,file.name.data);returnNGX_ERROR;}rcNGX_OK;调用 nginx 封装的 open 函数实际打开或创建PID 文件并返回文件描述符。 参数解析 file.name.data文件路径字符串以 \0 结尾。 NGX_FILE_RDWR以读写方式打开虽然只进行写入但有些系统要求读写才能截断。 create上一步确定的打开标志NGX_FILE_CREATE_OR_OPEN 或 NGX_FILE_TRUNCATE。 NGX_FILE_DEFAULT_ACCESS默认权限通常是 0644即所有者可读写组和其他只读。检查 ngx_open_file 是否失败若失败则记录错误并返回。初始化返回状态为成功6 写入 PIDif(!ngx_test_config){lenngx_snprintf(pid,NGX_INT64_LEN2,%P%N,ngx_pid)-pid;if(ngx_write_file(file,pid,len,0)NGX_ERROR){rcNGX_ERROR;}}if(ngx_close_file(file.fd)NGX_FILE_ERROR){ngx_log_error(NGX_LOG_ALERT,log,ngx_errno,ngx_close_file_n \%s\ failed,file.name.data);}#1 非测试模式 格式化 PID 字符串 写入文件并更新返回码 若写入成功函数返回 NGX_OK 若失败返回 NGX_ERROR并记录详细错误如磁盘满、权限不足等。 写入失败时将局部变量 rc 改为 NGX_ERROR。 rc 先前已被初始化为 NGX_OK用于记录最终返回状态。 这样即使写入失败也会继续执行后续的关闭操作避免资源泄漏。 为什么写入失败不立即返回 文件描述符必须被关闭无论写入是否成功。 因此函数需要继续执行关闭逻辑最后统一返回 rc 的值。 #2 关闭文件描述符7 返回处理结果状态码returnrc;}