Suporte a Mapas do Perf

Em plataformas suportadas (no momento em que este livro foi escrito, apenas Linux), o tempo de execução pode tirar vantagem dos arquivos de mapa perf para tornar as funções Python visíveis para uma ferramenta de perfilação externa (como perf). Um processo em execução pode criar um arquivo no diretório /tmp, que contém entradas que podem mapear uma seção de código executável para um nome. Esta interface é descrita na documentação da ferramenta Linux Perf.

Em Python, essas APIs auxiliares podem ser usadas por bibliotecas e recursos que dependem da geração de código de máquina dinamicamente.

Observe que manter o bloqueio global do interpretador, ou Global Interpreter Lock (GIL), não é necessário para essas APIs.

int PyUnstable_PerfMapState_Init(void)

Esta é uma API Instável. Isso pode se alterado sem aviso em lançamentos menores.

Abre o arquivo /tmp/perf-$pid.map, a menos que já esteja aberto, e cria um bloqueio para garantir escritas seguras para thread no arquivo (desde que as escritas sejam feitas através de PyUnstable_WritePerfMapEntry() ). Normalmente, não há necessidade de chamar isso explicitamente; basta usar PyUnstable_WritePerfMapEntry() e ele inicializará o estado na primeira chamada.

Retorna 0 em caso de sucesso, -1 em caso de falha ao criar/abrir o arquivo de mapa de desempenho ou -2 em caso de falha na criação de um bloqueio. Verifique errno para mais informações sobre a causa de uma falha.

int PyUnstable_WritePerfMapEntry(const void *code_addr, unsigned int code_size, const char *entry_name)

Esta é uma API Instável. Isso pode se alterado sem aviso em lançamentos menores.

Escreve uma única entrada no arquivo /tmp/perf-$pid.map. Esta função é segura para thread. Aqui está a aparência de um exemplo de entrada:

# address      size  name
7f3529fcf759 b     py::bar:/run/t.py

Chamará PyUnstable_PerfMapState_Init() antes de escrever a entrada, se o arquivo de mapa de desempenho ainda não estiver aberto. Retorna 0 em caso de sucesso ou os mesmos códigos de erro que PyUnstable_PerfMapState_Init() em caso de falha.

void PyUnstable_PerfMapState_Fini(void)

Esta é uma API Instável. Isso pode se alterado sem aviso em lançamentos menores.

Fecha o arquivo de mapa do perf aberto por PyUnstable_PerfMapState_Init(). Isso é chamado pelo próprio tempo de execução durante o desligamento do interpretador. Em geral, não deve haver motivo para chamar isso explicitamente, exceto para lidar com cenários específicos, como bifurcação.