Ubuntu 下 nginx-1.24.0 源码分析 - ngx_get_options函数

声明

就在 main函数所在的 nginx.c 中：

static ngx_int_t ngx_get_options(int argc, char *const *argv);

---

实现

static ngx_int_t
ngx_get_options(int argc, char *const *argv)
{u_char     *p;ngx_int_t   i;for (i = 1; i < argc; i++) {p = (u_char *) argv[i];if (*p++ != '-') {ngx_log_stderr(0, "invalid option: \"%s\"", argv[i]);return NGX_ERROR;}while (*p) {switch (*p++) {case '?':case 'h':ngx_show_version = 1;ngx_show_help = 1;break;case 'v':ngx_show_version = 1;break;case 'V':ngx_show_version = 1;ngx_show_configure = 1;break;case 't':ngx_test_config = 1;break;case 'T':ngx_test_config = 1;ngx_dump_config = 1;break;case 'q':ngx_quiet_mode = 1;break;case 'p':if (*p) {ngx_prefix = p;goto next;}if (argv[++i]) {ngx_prefix = (u_char *) argv[i];goto next;}ngx_log_stderr(0, "option \"-p\" requires directory name");return NGX_ERROR;case 'e':if (*p) {ngx_error_log = p;} else if (argv[++i]) {ngx_error_log = (u_char *) argv[i];} else {ngx_log_stderr(0, "option \"-e\" requires file name");return NGX_ERROR;}if (ngx_strcmp(ngx_error_log, "stderr") == 0) {ngx_error_log = (u_char *) "";}goto next;case 'c':if (*p) {ngx_conf_file = p;goto next;}if (argv[++i]) {ngx_conf_file = (u_char *) argv[i];goto next;}ngx_log_stderr(0, "option \"-c\" requires file name");return NGX_ERROR;case 'g':if (*p) {ngx_conf_params = p;goto next;}if (argv[++i]) {ngx_conf_params = (u_char *) argv[i];goto next;}ngx_log_stderr(0, "option \"-g\" requires parameter");return NGX_ERROR;case 's':if (*p) {ngx_signal = (char *) p;} else if (argv[++i]) {ngx_signal = argv[i];} else {ngx_log_stderr(0, "option \"-s\" requires parameter");return NGX_ERROR;}if (ngx_strcmp(ngx_signal, "stop") == 0|| ngx_strcmp(ngx_signal, "quit") == 0|| ngx_strcmp(ngx_signal, "reopen") == 0|| ngx_strcmp(ngx_signal, "reload") == 0){ngx_process = NGX_PROCESS_SIGNALLER;goto next;}ngx_log_stderr(0, "invalid option: \"-s %s\"", ngx_signal);return NGX_ERROR;default:ngx_log_stderr(0, "invalid option: \"%c\"", *(p - 1));return NGX_ERROR;}}next:continue;}return NGX_OK;
}

 

它的任务是解析用户在命令行中输入的参数。

static ngx_int_t
ngx_get_options(int argc, char *const *argv)

• static：这个关键字表示这个函数只能在当前文件中使用，外面的文件不能直接调用它。

• ngx_int_t：这是一个自定义的整数类型，用来表示函数的返回值

• argc：表示命令行参数的个数，比如你输入了 nginx -h -v，那么 argc 就是 3（包括程序名和两个参数）（和 main 函数的 argc 一致）。

• argv：是一个数组，存储了所有命令行参数的内容。（和 main 函数的 argv 一致）

• 返回值：成功返回 NGX_OK，失败返回 NGX_ERROR。

#define  NGX_OK          0
#define  NGX_ERROR      -1

这2个宏的定义都在 ngx_core.h 中

{u_char     *p;ngx_int_t   i;

• u_char：这是一个无符号字符类型，用来存储单个字符。

• p：是一个指针，用来逐个检查命令行参数中的每个字符。

• i：是一个循环变量，用来遍历所有的命令行参数。

    for (i = 1; i < argc; i++) {

• 这是一个循环，从 i = 1 开始，因为 argv[0] 是程序名，我们从第一个参数开始检查。

• 循环会一直进行，直到检查完所有的参数。

        p = (u_char *) argv[i];

• 把当前参数的内容赋给指针 p，这样就可以逐个字符检查这个参数了。

        if (*p++ != '-') {ngx_log_stderr(0, "invalid option: \"%s\"", argv[i]);return NGX_ERROR;}

• 检查参数的第一个字符是否是 -，因为命令行参数通常以 - 开头，比如 -h。

• 如果不是 -，就说明这个参数格式不对，打印错误信息，并返回错误码 NGX_ERROR。

ngx_log_stderr 函数

Ubuntu 下 nginx-1.24.0 源码分析 - ngx_log_stderr 函数-CSDN博客

        while (*p) {

• 这是一个循环，用来逐个字符检查参数的内容，直到遇到字符串的结尾（*p 为 \0）。

            switch (*p++) {

• 这是一个 switch 语句，用来根据当前字符的值执行不同的操作。

• *p++ 表示先取出当前字符的值，然后把指针 p 移动到下一个字符。

            case '?':case 'h':ngx_show_version = 1;ngx_show_help = 1;break;

• 如果当前字符是 ? 或 h，就设置两个变量：

  • ngx_show_version：表示要显示 Nginx 的版本信息。

  • ngx_show_help：表示要显示帮助信息。

在 nginx.c 中定义了一些全局变量

static ngx_uint_t   ngx_show_help;
static ngx_uint_t   ngx_show_version;
static ngx_uint_t   ngx_show_configure;
static u_char      *ngx_prefix;
static u_char      *ngx_error_log;
static u_char      *ngx_conf_file;
static u_char      *ngx_conf_params;
static char        *ngx_signal;static char **ngx_os_environ;

            case 'v':ngx_show_version = 1;break;

• 如果当前字符是 v，只设置 ngx_show_version，表示显示版本信息。

            case 'V':ngx_show_version = 1;ngx_show_configure = 1;break;

• 如果当前字符是 V，设置两个变量：

  • ngx_show_version：显示版本信息。

  • ngx_show_configure：显示配置信息。

            case 't':ngx_test_config = 1;break;

• 如果当前字符是 t，设置 ngx_test_config，表示要测试配置文件是否正确。 

ngx_test_config 定义在 ngx_cycle.c 中

ngx_uint_t             ngx_test_config;
ngx_uint_t             ngx_dump_config;
ngx_uint_t             ngx_quiet_mode;

ngx_cycle.h 中 导入这个变量

extern ngx_uint_t             ngx_test_config;
extern ngx_uint_t             ngx_dump_config;
extern ngx_uint_t             ngx_quiet_mode;

            case 'T':ngx_test_config = 1;ngx_dump_config = 1;break;

• 如果当前字符是 T，设置两个变量：

  • ngx_test_config：测试配置文件。

  • ngx_dump_config：显示配置文件的内容。

            case 'q':ngx_quiet_mode = 1;break;

• 如果当前字符是 q，设置 ngx_quiet_mode，表示进入安静模式，减少日志输出。

            case 'p':if (*p) {ngx_prefix = p;goto next;}if (argv[++i]) {ngx_prefix = (u_char *) argv[i];goto next;}ngx_log_stderr(0, "option \"-p\" requires directory name");return NGX_ERROR;

• 如果当前字符是 p，表示用户想指定 Nginx 的工作目录。

  • 如果 p 指针后面还有内容（比如 -p/path/to/dir），就把这个路径赋给 ngx_prefix。

  • 如果没有，就检查下一个参数（argv[++i]），把它赋给 ngx_prefix。

  • 如果都没有，说明用户没有提供目录名，打印错误信息并返回错误码。

  • goto next 继续检查下一项参数

            case 'e':if (*p) {ngx_error_log = p;} else if (argv[++i]) {ngx_error_log = (u_char *) argv[i];} else {ngx_log_stderr(0, "option \"-e\" requires file name");return NGX_ERROR;}if (ngx_strcmp(ngx_error_log, "stderr") == 0) {ngx_error_log = (u_char *) "";}goto next;

• 如果当前字符是 e，表示用户想指定错误日志文件的位置。

  • 同样，先检查 p 指针后面的内容，或者下一个参数。

  • 如果没有提供文件名，打印错误信息并返回错误码。

  • 如果用户指定的文件名是 stderr，就设置 ngx_error_log 为空字符串，表示把错误日志输出到标准错误流。

            case 'c':if (*p) {ngx_conf_file = p;goto next;}if (argv[++i]) {ngx_conf_file = (u_char *) argv[i];goto next;}ngx_log_stderr(0, "option \"-c\" requires file name");return NGX_ERROR;

• 如果当前字符是 c，表示用户想指定配置文件的位置。

  • 检查 p 指针后面的内容，或者下一个参数。

  • 如果没有提供文件名，打印错误信息并返回错误码。

            case 'g':if (*p) {ngx_conf_params = p;goto next;}if (argv[++i]) {ngx_conf_params = (u_char *) argv[i];goto next;}ngx_log_stderr(0, "option \"-g\" requires parameter");return NGX_ERROR;

• 如果当前字符是 g，表示用户想指定配置参数。

  • 检查 p 指针后面的内容，或者下一个参数。

  • 如果没有提供参数，打印错误信息并返回错误码。

            case 's':if (*p) {ngx_signal = (char *) p;} else if (argv[++i]) {ngx_signal = argv[i];} else {ngx_log_stderr(0, "option \"-s\" requires parameter");return NGX_ERROR;}if (ngx_strcmp(ngx_signal, "stop") == 0|| ngx_strcmp(ngx_signal, "quit") == 0|| ngx_strcmp(ngx_signal, "reopen") == 0|| ngx_strcmp(ngx_signal, "reload") == 0){ngx_process = NGX_PROCESS_SIGNALLER;goto next;}ngx_log_stderr(0, "invalid option: \"-s %s\"", ngx_signal);return NGX_ERROR;

• 如果当前字符是 s，表示用户想发送一个信号给 Nginx。

  • 检查 p 指针后面的内容，或者下一个参数。

  • 如果没有提供信号名称，打印错误信息并返回错误码。

  • 如果信号名称是 stop、quit、reopen 或 reload，设置 ngx_process 为 NGX_PROCESS_SIGNALLER，表示要处理信号。

  • 如果信号名称不合法，打印错误信息并返回错误码。

            default:ngx_log_stderr(0, "invalid option: \"%c\"", *(p - 1));return NGX_ERROR;

• 如果当前字符不是上面提到的任何一个，说明这是一个非法的选项，打印错误信息并返回错误码。

            }}next:continue;}return NGX_OK;

• 如果一切正常，函数返回 NGX_OK，表示参数解析成功。