Инструментарий CPython с DTrace и SystemTap

Автор:David Malcolm
Автор:Łukasz Langa

DTrace и SystemTap являются инструментами мониторинга, каждый из которых обеспечивает способ проверки того, что делают процессы в компьютерной системе. Они оба используют специфичные для домена языки, позволяющие пользователю писать скрипты, которые:

  • фильтровать, какие процессы должны наблюдаться,
  • собирать данные из процессов, представляющих интерес,
  • генерировать отчёты по данным

Начиная с Python 3.6, CPython может быть построен со встроенными «маркерами», также известными как «зонды», которые могут наблюдаться скриптом DTrace или SystemTap, что облегчает мониторинг того, что делают процессы CPython в системе.

Детали реализации CPython: Маркеры DTrace - детали внедрения CPython интерпретатор. Нет никаких гарантий совместимости зондов между версиями CPython. Сценарии DTrace могут перестать работать или работать неправильно без предупреждения при изменении версий CPython.

Включение статических маркеров

macOS поставляется со встроенной поддержкой DTrace. В Linux, чтобы построить CPython со встроенными маркерами для SystemTap, необходимо установить средства разработки SystemTap.

На машине Linux это можно сделать через:

$ yum install systemtap-sdt-devel

или:

$ sudo apt-get install systemtap-sdt-dev

Затем CPython должен быть настроен --with-dtrace:

checking for --with-dtrace... yes

На macOS вы можете перечислить доступные исследования DTrace, управляя процессом Python на заднем плане, и листинг всех исследований сделал доступным поставщиком Python:

$ 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 можно проверить наличие статических маркеров SystemTap в созданном двоичном файле, увидев, содержит ли он раздел. «note.stapsdt».

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

Если вы построили Python как общая библиотека (с - включают - разделенный), вы должны посмотреть вместо этого в общей библиотеке. Например:

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

Достаточно современные средства чтения могут печатать метаданные:

$ 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». Другими словами, вызовы функции import-time не будут перечислены:

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") {

если вместо этого read:

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)

Этот маркер - обратный of:c:func: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)

Огни перед importlib пытаются найти и загрузить модуль. arg0 - имя модуля.

Добавлено в версии 3.7.

import__find__load__done(str modulename, int found)

Огни после функции find_and_load importlib называют. arg0 - имя модуля, arg1 указывает, был ли модуль успешно загружен.

Добавлено в версии 3.7.

audit(str event, void *tuple)

Срабатывает, когда вызывается sys.audit() или PySys_Audit(). arg0 - имя событий как струна до, arg1 - PyObject указатель на объект кортежа.

Добавлено в версии 3.8.

SystemTap Tapsets

Высокоуровневым способом использования интеграции SystemTap является использование «tapset»: эквивалента SystemTap библиотеки, который скрывает некоторые детали нижнего уровня статических маркеров.

Вот файл tapset, основанный на не общей сборке CPython:

/*
   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
}

Если этот файл установлен в каталоге Tapset SystemTap (например, /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, показывающий 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;
}