使用 DTrace pid provider 调试 nginx

本文假设读者对 nginx 内部结构和 DTrace 有基本了解。

虽然使用 --with-debug 选项构建的 nginx 已经提供了大量有关请求处理的信息，但有时需要更彻底地跟踪代码路径的特定部分，同时省略其余的调试输出。DTrace pid provider（可在 Solaris、macOS 上使用）是探索用户态程序内部结构的有用工具，因为它不需要任何代码更改，并且可以帮助完成此任务。一个用于跟踪和打印 nginx 函数调用的简单 DTrace 脚本可能如下所示：

#pragma D option flowindent

pid$target:nginx::entry {
}

pid$target:nginx::return {
}

然而，DTrace 用于函数调用跟踪的功能仅提供有限量的有用信息。实时检查函数参数通常更有趣，但也更复杂一些。下面的示例旨在帮助读者更熟悉 DTrace 以及使用 DTrace 分析 nginx 行为的过程。

使用 DTrace 调试 nginx 的常见场景之一如下：附加到 nginx worker 进程以记录请求行和请求开始时间。相应的附加函数是 ngx_http_process_request()，并且相关的参数是指向 ngx_http_request_t 结构的指针。用于此类请求日志记录的 DTrace 脚本可以非常简单，如下所示：

pid$target::*ngx_http_process_request:entry
{
    this->request = (ngx_http_request_t *)copyin(arg0, sizeof(ngx_http_request_t));
    this->request_line = stringof(copyin((uintptr_t)this->request->request_line.data,
                                         this->request->request_line.len));
    printf("request line = %s\n", this->request_line);
    printf("request start sec = %d\n", this->request->start_sec);
}

需要注意的是，在上面的示例中，DTrace 需要对 ngx_http_request_t 结构有所了解。不幸的是，虽然可以在 DTrace 脚本中使用特定的 #include 指令，然后将其传递给 C 预处理器（使用 -C 标志），但这实际上不起作用。由于存在大量交叉依赖关系，几乎所有 nginx 头文件都必须包含。反过来，根据 configure 脚本的设置，nginx 头文件将包含 PCRE、OpenSSL 和各种系统头文件。虽然理论上与特定 nginx 构建相关的所有这些头文件都可以包含在 DTrace 脚本的预处理和编译中，但实际上 DTrace 脚本很可能会因为某些头文件中的未知语法而编译失败。

上述问题可以通过在 DTrace 脚本中仅包含相关且必需的结构和类型定义来解决。DTrace 必须知道结构、类型的大小以及字段偏移量。因此，通过手动优化结构定义以供 DTrace 使用，可以进一步减少依赖关系。

让我们以上面的 DTrace 脚本示例为例，看看它需要哪些结构定义才能正常工作。

首先应包含由 configure 生成的 objs/ngx_auto_config.h 文件，因为它定义了许多影响各种 #ifdef 的常量。之后，一些基本类型和定义，如 ngx_str_t、ngx_table_elt_t、ngx_uint_t 等，应放在 DTrace 脚本的开头。这些定义是紧凑的，常用且不太可能频繁更改。

接下来是 ngx_http_request_t 结构，它包含许多指向其他结构的指针。由于这些指针实际上与此脚本无关，并且它们具有相同的大小，因此可以用 void 指针替换它们。不过，与其更改定义，不如添加适当的 typedef。

typedef ngx_http_upstream_t     void;
typedef ngx_http_request_body_t void;

最后但同样重要的是，需要添加两个成员结构（ngx_http_headers_in_t、ngx_http_headers_out_t）的定义、回调函数的声明和常量的定义。

最终的 DTrace 脚本可以从此处下载。

以下示例显示了运行此脚本的输出

# dtrace -C -I ./objs -s trace_process_request.d -p 4848
dtrace: script 'trace_process_request.d' matched 1 probe
CPU     ID                    FUNCTION:NAME
  1      4 .XAbmO.ngx_http_process_request:entry request line = GET / HTTP/1.1
request start sec = 1349162898

  0      4 .XAbmO.ngx_http_process_request:entry request line = GET /en/docs/nginx_dtrace_pid_provider.html HTTP/1.1
request start sec = 1349162899

使用类似的技术，读者应该能够跟踪其他 nginx 函数调用。

使用 DTrace pid provider 调试 nginx

另请参阅