使用 DTrace 和 SystemTap 对 CPython 进行插桩

作者:

David Malcolm

作者:

Łukasz Langa

DTrace 和 SystemTap 是监控工具,它们都提供了一种方法来检查计算机系统上的进程正在做什么。它们都使用特定于领域的语言,允许用户编写脚本,这些脚本可以

  • 过滤要观察的进程

  • 从感兴趣的进程中收集数据

  • 生成有关数据的报告

从 Python 3.6 开始,CPython 可以使用嵌入的“标记”(也称为“探针”)进行构建,这些标记可以被 DTrace 或 SystemTap 脚本观察,从而更容易监控系统上的 CPython 进程正在做什么。

CPython 实现细节:DTrace 标记是 CPython 解释器的实现细节。不保证 CPython 版本之间的探针兼容性。在更改 CPython 版本时,DTrace 脚本可能会停止工作或无法正常工作,恕不另行通知。

启用静态标记

macOS 附带对 DTrace 的内置支持。在 Linux 上,为了使用嵌入的 SystemTap 标记构建 CPython,必须安装 SystemTap 开发工具。

在 Linux 机器上,可以通过以下方式完成:

$ yum install systemtap-sdt-devel

$ sudo apt-get install systemtap-sdt-dev

然后必须使用 configured with the --with-dtrace option 配置 CPython。

checking for --with-dtrace... yes

在 macOS 上,可以通过在后台运行 Python 进程并列出 Python 提供程序提供的探针来列出可用的 DTrace 探针

$ python3.6 -q &
$ sudo dtrace -l -P python$!  # or: dtrace -l -m python3.6

   ID   PROVIDER            MODULE                          FUNCTION NAME
29564 python18035        python3.6          _PyEval_EvalFrameDefault function-entry
29565 python18035        python3.6             dtrace_function_entry function-entry
29566 python18035        python3.6          _PyEval_EvalFrameDefault function-return
29567 python18035        python3.6            dtrace_function_return function-return
29568 python18035        python3.6                           collect gc-done
29569 python18035        python3.6                           collect gc-start
29570 python18035        python3.6          _PyEval_EvalFrameDefault line
29571 python18035        python3.6                 maybe_dtrace_line line

在 Linux 上,可以通过查看构建的二进制文件是否包含“.note.stapsdt”部分来验证 SystemTap 静态标记是否已存在。

$ readelf -S ./python | grep .note.stapsdt
[30] .note.stapsdt        NOTE         0000000000000000 00308d78

如果您将 Python 构建为共享库(使用 --enable-shared 配置选项),则需要在共享库中查找。例如

$ readelf -S libpython3.3dm.so.1.0 | grep .note.stapsdt
[29] .note.stapsdt        NOTE         0000000000000000 00365b68

足够现代的 readelf 可以打印元数据

$ readelf -n ./python

Displaying notes found at file offset 0x00000254 with length 0x00000020:
    Owner                 Data size          Description
    GNU                  0x00000010          NT_GNU_ABI_TAG (ABI version tag)
        OS: Linux, ABI: 2.6.32

Displaying notes found at file offset 0x00000274 with length 0x00000024:
    Owner                 Data size          Description
    GNU                  0x00000014          NT_GNU_BUILD_ID (unique build ID bitstring)
        Build ID: df924a2b08a7e89f6e11251d4602022977af2670

Displaying notes found at file offset 0x002d6c30 with length 0x00000144:
    Owner                 Data size          Description
    stapsdt              0x00000031          NT_STAPSDT (SystemTap probe descriptors)
        Provider: python
        Name: gc__start
        Location: 0x00000000004371c3, Base: 0x0000000000630ce2, Semaphore: 0x00000000008d6bf6
        Arguments: -4@%ebx
    stapsdt              0x00000030          NT_STAPSDT (SystemTap probe descriptors)
        Provider: python
        Name: gc__done
        Location: 0x00000000004374e1, Base: 0x0000000000630ce2, Semaphore: 0x00000000008d6bf8
        Arguments: -8@%rax
    stapsdt              0x00000045          NT_STAPSDT (SystemTap probe descriptors)
        Provider: python
        Name: function__entry
        Location: 0x000000000053db6c, Base: 0x0000000000630ce2, Semaphore: 0x00000000008d6be8
        Arguments: 8@%rbp 8@%r12 -4@%eax
    stapsdt              0x00000046          NT_STAPSDT (SystemTap probe descriptors)
        Provider: python
        Name: function__return
        Location: 0x000000000053dba8, Base: 0x0000000000630ce2, Semaphore: 0x00000000008d6bea
        Arguments: 8@%rbp 8@%r12 -4@%eax

上面的元数据包含 SystemTap 的信息,描述了它如何修补策略性放置的机器代码指令以启用 SystemTap 脚本使用的跟踪挂钩。

静态 DTrace 探针

以下 DTrace 脚本示例可用于显示 Python 脚本的调用/返回层次结构,仅跟踪在调用名为“start”的函数内的调用。换句话说,导入时函数调用将不会被列出

self int indent;

python$target:::function-entry
/copyinstr(arg1) == "start"/
{
        self->trace = 1;
}

python$target:::function-entry
/self->trace/
{
        printf("%d\t%*s:", timestamp, 15, probename);
        printf("%*s", self->indent, "");
        printf("%s:%s:%d\n", basename(copyinstr(arg0)), copyinstr(arg1), arg2);
        self->indent++;
}

python$target:::function-return
/self->trace/
{
        self->indent--;
        printf("%d\t%*s:", timestamp, 15, probename);
        printf("%*s", self->indent, "");
        printf("%s:%s:%d\n", basename(copyinstr(arg0)), copyinstr(arg1), arg2);
}

python$target:::function-return
/copyinstr(arg1) == "start"/
{
        self->trace = 0;
}

它可以像这样调用

$ sudo dtrace -q -s call_stack.d -c "python3.6 script.py"

输出如下所示

156641360502280  function-entry:call_stack.py:start:23
156641360518804  function-entry: call_stack.py:function_1:1
156641360532797  function-entry:  call_stack.py:function_3:9
156641360546807 function-return:  call_stack.py:function_3:10
156641360563367 function-return: call_stack.py:function_1:2
156641360578365  function-entry: call_stack.py:function_2:5
156641360591757  function-entry:  call_stack.py:function_1:1
156641360605556  function-entry:   call_stack.py:function_3:9
156641360617482 function-return:   call_stack.py:function_3:10
156641360629814 function-return:  call_stack.py:function_1:2
156641360642285 function-return: call_stack.py:function_2:6
156641360656770  function-entry: call_stack.py:function_3:9
156641360669707 function-return: call_stack.py:function_3:10
156641360687853  function-entry: call_stack.py:function_4:13
156641360700719 function-return: call_stack.py:function_4:14
156641360719640  function-entry: call_stack.py:function_5:18
156641360732567 function-return: call_stack.py:function_5:21
156641360747370 function-return:call_stack.py:start:28

静态 SystemTap 标记

使用 SystemTap 集成的低级方法是直接使用静态标记。这要求您明确说明包含它们的二进制文件。

例如,此 SystemTap 脚本可用于显示 Python 脚本的调用/返回层次结构

probe process("python").mark("function__entry") {
     filename = user_string($arg1);
     funcname = user_string($arg2);
     lineno = $arg3;

     printf("%s => %s in %s:%d\\n",
            thread_indent(1), funcname, filename, lineno);
}

probe process("python").mark("function__return") {
    filename = user_string($arg1);
    funcname = user_string($arg2);
    lineno = $arg3;

    printf("%s <= %s in %s:%d\\n",
           thread_indent(-1), funcname, filename, lineno);
}

它可以像这样调用

$ stap \
  show-call-hierarchy.stp \
  -c "./python test.py"

输出如下所示

11408 python(8274):        => __contains__ in Lib/_abcoll.py:362
11414 python(8274):         => __getitem__ in Lib/os.py:425
11418 python(8274):          => encode in Lib/os.py:490
11424 python(8274):          <= encode in Lib/os.py:493
11428 python(8274):         <= __getitem__ in Lib/os.py:426
11433 python(8274):        <= __contains__ in Lib/_abcoll.py:366

其中列表示

  • 自脚本开始以来的微秒时间

  • 可执行文件的名称

  • 进程的 PID

其余部分表示脚本执行时的调用/返回层次结构。

对于 --enable-shared 构建的 CPython,标记包含在 libpython 共享库中,探针的点路径需要反映这一点。例如,上面示例中的这一行

probe process("python").mark("function__entry") {

应该改为

probe process("python").library("libpython3.6dm.so.1.0").mark("function__entry") {

(假设使用 调试构建 的 CPython 3.6)

可用的静态标记

function__entry(str filename, str funcname, int lineno)

此标记指示 Python 函数的执行已开始。它只针对纯 Python(字节码)函数触发。

文件名、函数名和行号作为位置参数提供给跟踪脚本,必须使用 $arg1$arg2$arg3 访问。

  • $arg1 : (const char *) 文件名,可以使用 user_string($arg1) 访问

  • $arg2 : (const char *) 函数名,可以使用 user_string($arg2) 访问

  • $arg3 : int 行号

function__return(str filename, str funcname, int lineno)

此标记是 function__entry() 的反面,指示 Python 函数的执行已结束(通过 return 或异常)。它只针对纯 Python(字节码)函数触发。

参数与 function__entry() 相同。

line(str filename, str funcname, int lineno)

此标记指示即将执行 Python 代码行。它等效于使用 Python 分析器进行逐行跟踪。它不会在 C 函数中触发。

参数与 function__entry() 相同。

gc__start(int generation)

当 Python 解释器开始垃圾回收周期时触发。 arg0 是要扫描的代,类似于 gc.collect()

gc__done(long collected)

当 Python 解释器完成垃圾回收周期时触发。 arg0 是已收集对象的数目。

import__find__load__start(str modulename)

importlib 尝试查找和加载模块之前触发。 arg0 是模块名。

在版本 3.7 中添加。

import__find__load__done(str modulename, int found)

在调用 importlib 的 find_and_load 函数之后触发。 arg0 是模块名,arg1 指示模块是否已成功加载。

在版本 3.7 中添加。

audit(str event, void *tuple)

当调用 sys.audit()PySys_Audit() 时触发。 arg0 是事件名称(作为 C 字符串),arg1 是指向元组对象的 PyObject 指针。

在版本 3.8 中添加。

SystemTap Tapsets

使用 SystemTap 集成的一种更高级的方法是使用“tapset”:SystemTap 等效于库,它隐藏了静态标记的一些底层细节。

以下是一个基于非共享构建的 CPython 的 tapset 文件

/*
   Provide a higher-level wrapping around the function__entry and
   function__return markers:
 \*/
probe python.function.entry = process("python").mark("function__entry")
{
    filename = user_string($arg1);
    funcname = user_string($arg2);
    lineno = $arg3;
    frameptr = $arg4
}
probe python.function.return = process("python").mark("function__return")
{
    filename = user_string($arg1);
    funcname = user_string($arg2);
    lineno = $arg3;
    frameptr = $arg4
}

如果将此文件安装在 SystemTap 的 tapset 目录中(例如 /usr/share/systemtap/tapset),那么这些额外的探测点将可用

python.function.entry(str filename, str funcname, int lineno, frameptr)

此探测点表示 Python 函数的执行已开始。它仅针对纯 Python(字节码)函数触发。

python.function.return(str filename, str funcname, int lineno, frameptr)

此探测点是 python.function.return 的反面,表示 Python 函数的执行已结束(通过 return 或异常)。它仅针对纯 Python(字节码)函数触发。

示例

此 SystemTap 脚本使用上面的 tapset 更简洁地实现上面给出的跟踪 Python 函数调用层次结构的示例,而无需直接命名静态标记

probe python.function.entry
{
  printf("%s => %s in %s:%d\n",
         thread_indent(1), funcname, filename, lineno);
}

probe python.function.return
{
  printf("%s <= %s in %s:%d\n",
         thread_indent(-1), funcname, filename, lineno);
}

以下脚本使用上面的 tapset 提供所有正在运行的 CPython 代码的类似 top 的视图,每秒显示整个系统中前 20 个最常进入的字节码帧

global fn_calls;

probe python.function.entry
{
    fn_calls[pid(), filename, funcname, lineno] += 1;
}

probe timer.ms(1000) {
    printf("\033[2J\033[1;1H") /* clear screen \*/
    printf("%6s %80s %6s %30s %6s\n",
           "PID", "FILENAME", "LINE", "FUNCTION", "CALLS")
    foreach ([pid, filename, funcname, lineno] in fn_calls- limit 20) {
        printf("%6d %80s %6d %30s %6d\n",
            pid, filename, lineno, funcname,
            fn_calls[pid, filename, funcname, lineno]);
    }
    delete fn_calls;
}