对 Perf Maps 的支持¶
在受支持的平台上(截至本文撰写时,仅限 Linux),运行时可以利用 perf 映射文件 使 Python 函数对外部分析工具(例如 perf)可见。运行中的进程可以在 /tmp
目录中创建一个文件,其中包含可以将可执行代码段映射到名称的条目。此接口在 Linux Perf 工具的文档中进行了描述。
在 Python 中,这些辅助 API 可以被依赖于即时生成机器代码的库和功能使用。
请注意,这些 API 不需要持有附加线程状态。
-
int PyUnstable_PerfMapState_Init(void)¶
- 这是一个不稳定 API。它可能会在次要版本中未经警告而更改。
打开
/tmp/perf-$pid.map
文件,除非它已经打开,并创建一个锁以确保对文件进行线程安全写入(前提是写入是通过PyUnstable_WritePerfMapEntry()
完成的)。通常,不需要显式调用此函数;只需使用PyUnstable_WritePerfMapEntry()
,它会在首次调用时初始化状态。成功时返回
0
,无法创建/打开 perf 映射文件时返回-1
,或无法创建锁时返回-2
。请检查errno
以获取有关失败原因的更多信息。
-
int PyUnstable_WritePerfMapEntry(const void *code_addr, unsigned int code_size, const char *entry_name)¶
- 这是一个不稳定 API。它可能会在次要版本中未经警告而更改。
向
/tmp/perf-$pid.map
文件写入一个条目。此函数是线程安全的。以下是一个示例条目的样子# address size name 7f3529fcf759 b py::bar:/run/t.py
如果 perf 映射文件尚未打开,将在写入条目之前调用
PyUnstable_PerfMapState_Init()
。成功时返回0
,失败时返回与PyUnstable_PerfMapState_Init()
相同的错误代码。
-
void PyUnstable_PerfMapState_Fini(void)¶
- 这是一个不稳定 API。它可能会在次要版本中未经警告而更改。
关闭由
PyUnstable_PerfMapState_Init()
打开的 perf 映射文件。此函数在解释器关闭期间由运行时本身调用。通常,除了处理分叉等特定场景外,没有理由显式调用此函数。