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

声明

在 nginx.c 开头

static void ngx_show_version_info(void);

实现

static void
ngx_show_version_info(void)
{ngx_write_stderr("nginx version: " NGINX_VER_BUILD NGX_LINEFEED);if (ngx_show_help) {ngx_write_stderr("Usage: nginx [-?hvVtTq] [-s signal] [-p prefix]" NGX_LINEFEED"             [-e filename] [-c filename] [-g directives]"NGX_LINEFEED NGX_LINEFEED"Options:" NGX_LINEFEED"  -?,-h         : this help" NGX_LINEFEED"  -v            : show version and exit" NGX_LINEFEED"  -V            : show version and configure options then exit"NGX_LINEFEED"  -t            : test configuration and exit" NGX_LINEFEED"  -T            : test configuration, dump it and exit"NGX_LINEFEED"  -q            : suppress non-error messages ""during configuration testing" NGX_LINEFEED"  -s signal     : send signal to a master process: ""stop, quit, reopen, reload" NGX_LINEFEED
#ifdef NGX_PREFIX"  -p prefix     : set prefix path (default: " NGX_PREFIX ")"NGX_LINEFEED
#else"  -p prefix     : set prefix path (default: NONE)" NGX_LINEFEED
#endif"  -e filename   : set error log file (default: "
#ifdef NGX_ERROR_LOG_STDERR"stderr)" NGX_LINEFEED
#elseNGX_ERROR_LOG_PATH ")" NGX_LINEFEED
#endif"  -c filename   : set configuration file (default: " NGX_CONF_PATH")" NGX_LINEFEED"  -g directives : set global directives out of configuration ""file" NGX_LINEFEED NGX_LINEFEED);}if (ngx_show_configure) {#ifdef NGX_COMPILERngx_write_stderr("built by " NGX_COMPILER NGX_LINEFEED);
#endif#if (NGX_SSL)if (ngx_strcmp(ngx_ssl_version(), OPENSSL_VERSION_TEXT) == 0) {ngx_write_stderr("built with " OPENSSL_VERSION_TEXT NGX_LINEFEED);} else {ngx_write_stderr("built with " OPENSSL_VERSION_TEXT" (running with ");ngx_write_stderr((char *) (uintptr_t) ngx_ssl_version());ngx_write_stderr(")" NGX_LINEFEED);}
#ifdef SSL_CTRL_SET_TLSEXT_HOSTNAMEngx_write_stderr("TLS SNI support enabled" NGX_LINEFEED);
#elsengx_write_stderr("TLS SNI support disabled" NGX_LINEFEED);
#endif
#endifngx_write_stderr("configure arguments:" NGX_CONFIGURE NGX_LINEFEED);}
}

这段代码的作用是显示 Nginx 的版本信，帮助信息和编译配置  

当用户运行 Nginx 并带上特定的参数（比如 -v 或 -h）时，

这段代码会告诉用户 Nginx 的版本号

这段代码主要做了两件事：

1. 显示版本信息：告诉用户 Nginx 的版本号。

2. 显示帮助信息：如果用户需要，就显示如何使用 Nginx 的各种参数。

static void ngx_show_version_info(void)

 static 是一个关键字，表示这个函数只能在当前文件中使用，外部文件无法调用它

void 表示这个函数没有返回值，没有参数

{ngx_write_stderr("nginx version: " NGINX_VER_BUILD NGX_LINEFEED);

向标准错误流（stderr）写入 Nginx 的版本信息。

无论用户是否请求帮助（-h）或详细配置（-V），版本信息始终显示

 

ngx_write_stderr 是一个函数，用来把信息写到标准错误输出（通常是屏幕）

NGINX_VER_BUILD 是一个宏，包含了 Nginx 的版本信息。

NGX_LINEFEED 是一个宏，跨平台换行符（Windows用\r\n，Linux用\n）

ngx_write_stderr

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

NGINX_VER_BUILD

在 nginx.h 中:

#ifdef NGX_BUILD
#define NGINX_VER_BUILD    NGINX_VER " (" NGX_BUILD ")"
#else
#define NGINX_VER_BUILD    NGINX_VER
#endif

NGX_BUILD 

NGX_BUILD 是一个可选的宏，用于定义 Nginx 的构建信息

它通常在编译时通过 ./configure --build=name 命令设置。例如，如果在编译时指定了 --build=stable，那么 NGX_BUILD 的值将会是 "stable"

我这里当前是没有 定义 NGX_BUILD 的

• 如果定义了NGX_BUILD：

  • 将版本号与构建信息拼接，格式为：NGINX_VER (NGX_BUILD)。

  • 示例：nginx/1.25.3 (2023-10-01 OpenSSL 1.1.1)。

• 如果未定义NGX_BUILD：

  • 直接使用NGINX_VER，仅显示基础版本号。

  • 示例：nginx/1.25.3

NGINX_VER

是一个宏，用于定义 Nginx 的版本信息

它通常由字符串 "nginx/" 和另一个宏 NGINX_VERSION 拼接而成。例如，如果 NGINX_VERSION 被定义为 "1.21.0"，那么 NGINX_VER 的值将会是 "nginx/1.21.0"

nginx.h 中:

#define nginx_version      1024000
#define NGINX_VERSION      "1.24.0"
#define NGINX_VER          "nginx/" NGINX_VERSION

 

NGX_LINEFEED

ngx_files.h 中:

#define NGX_LINEFEED             "\x0a"

换行符“\n”在ASCII编码中的值是10

在C语言中，相邻的字符串字面量会在编译阶段自动合并为一个字符串 

当代码中的宏被展开后

"nginx version: " "1.24.0" "\n"

C 语言在编译时会自动将这些相邻的字符串拼接起来，形成完整的字符串

"nginx version: 1.24.0\n"

    if (ngx_show_help) {

处理帮助信息（-h 或 -?） 

if 是一个条件语句，用来判断某个条件是否成立。ngx_show_help 是一个变量，如果用户请求帮助信息，这个变量会被设置为真。 

这行代码的意思是：如果用户需要帮助信息，就执行下面的代码块。

用户通过-h或-?参数触发，全局变量ngx_show_help被设置为1

        ngx_write_stderr("Usage: nginx [-?hvVtTq] [-s signal] [-p prefix]" NGX_LINEFEED"             [-e filename] [-c filename] [-g directives]"NGX_LINEFEED NGX_LINEFEED"Options:" NGX_LINEFEED"  -?,-h         : this help" NGX_LINEFEED"  -v            : show version and exit" NGX_LINEFEED"  -V            : show version and configure options then exit"NGX_LINEFEED"  -t            : test configuration and exit" NGX_LINEFEED"  -T            : test configuration, dump it and exit"NGX_LINEFEED"  -q            : suppress non-error messages ""during configuration testing" NGX_LINEFEED"  -s signal     : send signal to a master process: ""stop, quit, reopen, reload" NGX_LINEFEED
#ifdef NGX_PREFIX"  -p prefix     : set prefix path (default: " NGX_PREFIX ")"NGX_LINEFEED
#else"  -p prefix     : set prefix path (default: NONE)" NGX_LINEFEED
#endif"  -e filename   : set error log file (default: "
#ifdef NGX_ERROR_LOG_STDERR"stderr)" NGX_LINEFEED
#elseNGX_ERROR_LOG_PATH ")" NGX_LINEFEED
#endif"  -c filename   : set configuration file (default: " NGX_CONF_PATH")" NGX_LINEFEED"  -g directives : set global directives out of configuration ""file" NGX_LINEFEED NGX_LINEFEED);

使用 ngx_write_stderr 逐行拼接多段字符串，避免一次性分配大内存

如果用户需要帮助，这段代码会列出所有可以用的命令参数和它们的含义。比如 -v 表示显示版本号并退出，-h 表示显示帮助信息。

#ifdef NGX_PREFIX：根据编译时的 --prefix 参数显示默认安装路径（如/usr/local/nginx/）

#ifdef NGX_ERROR_LOG_STDERR：根据配置决定错误日志默认输出到 stderr 还是文件

例如：

NGX_PREFIX

objs/ngx_auto_config.h 中：

#ifndef NGX_PREFIX
#define NGX_PREFIX  "/usr/local/nginx/"
#endif

NGX_PREFIX 宏在 Nginx 的源代码中被用来确定各种文件的默认路径，例如配置文件、日志文件等。

可以在编译时设置 --prefix=

如果没有指定 --prefix 参数，NGX_PREFIX 宏的默认值通常是 /usr/local/nginx

NGX_ERROR_LOG_STDERR

NGX_ERROR_LOG_STDERR 宏用于指定错误日志的输出目标为标准错误输出（stderr）

当 Nginx 需要记录错误日志时，如果配置了 NGX_ERROR_LOG_STDERR，则错误日志信息会被输出到标准错误流，而不是写入到文件或其他日志存储位置

我这里没有定义 NGX_ERROR_LOG_STDERR， 因为在编译前指定了--error-log-path 参数

NGX_ERROR_LOG_PATH

在 objs\ngx_auto_config.h 中：

#ifndef NGX_ERROR_LOG_PATH
#define NGX_ERROR_LOG_PATH  "/home/wsd/桌面/nginx/LOG/error.log"
#endif

NGX_ERROR_LOG_PATH 就是 --error-log-path= 参数这里指定的

NGX_CONF_PATH

objs\ngx_auto_config.h 中：

#ifndef NGX_CONF_PATH
#define NGX_CONF_PATH  "/home/wsd/桌面/nginx/conf/nginx.conf"
#endif

NGX_CONF_PATH 宏用于指定 Nginx 配置文件 nginx.conf 的路径

可以在编译时通过 --conf-path 参数指定

./configure --conf-path=/path/to/your/nginx.conf

    if (ngx_show_configure) {

处理详细配置信息（-V）

输出编译环境和配置选项

if 是条件语句，ngx_show_configure 是一个变量，如果用户请求显示配置信息，这个变量会被设置为真 

这行代码的意思是：如果用户需要查看配置信息（-V），就执行下面的代码块

用户通过-V参数触发，全局变量ngx_show_configure被设置为1

#ifdef NGX_COMPILERngx_write_stderr("built by " NGX_COMPILER NGX_LINEFEED);
#endif

fdef 是预处理指令，用来判断是否定义了 NGX_COMPILER 宏。

NGX_COMPILER 是一个宏，包含了编译 Nginx 的编译器信息。 

如果定义了 NGX_COMPILER，就输出编译 Nginx 的编译器信息

NGX_COMPILER

objs\ngx_auto_config.h

#ifndef NGX_COMPILER
#define NGX_COMPILER  "gcc 11.4.0 (Ubuntu 11.4.0-1ubuntu1~22.04) "
#endif

NGX_COMPILER 宏用于记录编译 Nginx 时所使用的编译器信息

#if (NGX_SSL)if (ngx_strcmp(ngx_ssl_version(), OPENSSL_VERSION_TEXT) == 0) {ngx_write_stderr("built with " OPENSSL_VERSION_TEXT NGX_LINEFEED);} else {ngx_write_stderr("built with " OPENSSL_VERSION_TEXT" (running with ");ngx_write_stderr((char *) (uintptr_t) ngx_ssl_version());ngx_write_stderr(")" NGX_LINEFEED);}
#ifdef SSL_CTRL_SET_TLSEXT_HOSTNAMEngx_write_stderr("TLS SNI support enabled" NGX_LINEFEED);
#elsengx_write_stderr("TLS SNI support disabled" NGX_LINEFEED);
#endif
#endif

if 是预处理指令，用来判断是否定义了 NGX_SSL 宏

ngx_strcmp 是一个函数，用来比较两个字符串是否相等

ngx_ssl_version 是一个函数，用来获取 SSL 的版本信息

NGX_SSL 表示启用了 SSL 模块。

ngx_ssl_version() 返回运行时 OpenSSL 版本，OPENSSL_VERSION_TEXT 是编译时版本。

如果版本不一致，提示用户（可能导致兼容性问题）

输出 SNI 支持状态

显示是否支持 TLS SNI（Server Name Indication）。

SSL_CTRL_SET_TLSEXT_HOSTNAME 宏的存在表示支持 SNI。

SNI 是托管多个 HTTPS 站点的关键功能，用户需知晓支持状态

NGX_SSL

objs\ngx_auto_config.h 中：

#ifndef NGX_SSL
#define NGX_SSL  1
#endif

 NGX_SSL 宏用于指示 Nginx 是否启用了 SSL/TLS 支持

在编译 Nginx 时，可以通过 --with-http_ssl_module 参数启用 SSL/TLS 支持

ngx_strcmp

ngx_string.h 中

#define ngx_strcmp(s1, s2)  strcmp((const char *) s1, (const char *) s2)

本质就是 strcmp

在 C 语言中，strcmp 是一个标准库函数，用于比较两个字符串的大小。它在 <string.h> 头文件中定义。

• 如果第一个字符串大于第二个字符串，返回正值。

• 如果两个字符串相等，返回 0。

• 如果第一个字符串小于第二个字符串，返回负值。

ngx_ssl_version

获取 SSL 的版本信息         Ubuntu 下 nginx-1.24.0 源码分析 - ngx_ssl_version 函数-CSDN博客

OPENSSL_VERSION_TEXT

OPENSSL_VERSION_TEXT 是 OpenSSL 库中定义的一个宏，用于获取 OpenSSL 的完整描述性版本文本，包括版本号和发布日期

可以用以下 代码 输出一下 OPENSSL_VERSION_TEXT 的值

gcc test.c -o test -lcrypto -lssl

#include <openssl/opensslv.h>
#include <stdio.h>int main() {printf("OpenSSL version text: %s\n", OPENSSL_VERSION_TEXT);return 0;
}

SSL_CTRL_SET_TLSEXT_HOSTNAME

SSL_CTRL_SET_TLSEXT_HOSTNAME 是 OpenSSL 中的一个宏，用于设置 TLS 扩展中的 Server Name Indication (SNI) 主机名。

可以用下面的代码输出一下 SSL_CTRL_SET_TLSEXT_HOSTNAME  的值

gcc test.c -o test -lcrypto -lssl

#include <openssl/ssl.h>
#include <stdio.h>int main() {// 输出 SSL_CTRL_SET_TLSEXT_HOSTNAME 的值printf("SSL_CTRL_SET_TLSEXT_HOSTNAME 的值是: %d\n", SSL_CTRL_SET_TLSEXT_HOSTNAME);return 0;
}

        ngx_write_stderr("configure arguments:" NGX_CONFIGURE NGX_LINEFEED);

NGX_CONFIGURE 是一个宏，包含了编译 Nginx 时的配置参数

这行代码会输出编译 Nginx 时用到的配置参数

 例如：

NGX_CONFIGURE

在 objs\ngx_auto_config.h 中：

#define NGX_CONFIGURE " --sbin-path=/home/wsd/桌面/nginx/nginx --conf-path=/home/wsd/桌面/nginx/conf/nginx.conf --error-log-path=/home/wsd/桌面/nginx/LOG/error.log --http-log-path=/home/wsd/桌面/nginx/LOG/access.log --with-pcre --with-http_ssl_module --with-http_v2_module --with-http_gzip_static_module --with-stream --with-stream_ssl_module"