perf python: Add callchain support

Implement pyrf_callchain_node and pyrf_callchain types for lazy
iteration over callchain frames. Add callchain property to
sample_event.

Assisted-by: Gemini:gemini-3.1-pro-preview
Signed-off-by: Ian Rogers <irogers@google.com>
Cc: Adrian Hunter <adrian.hunter@intel.com>
Cc: Alice Rogers <alice.mei.rogers@gmail.com>
Cc: Dapeng Mi <dapeng1.mi@linux.intel.com>
Cc: Ingo Molnar <mingo@redhat.com>
Cc: James Clark <james.clark@linaro.org>
Cc: Leo Yan <leo.yan@linux.dev>
Cc: Namhyung Kim <namhyung@kernel.org>
Cc: Peter Zijlstra <peterz@infradead.org>
Cc: Thomas Richter <tmricht@linux.ibm.com>
Signed-off-by: Arnaldo Carvalho de Melo <acme@redhat.com>
Signed-off-by: Namhyung Kim <namhyung@kernel.org>
This commit is contained in:
Ian Rogers 2026-06-15 18:15:35 -07:00 committed by Namhyung Kim
parent 64344eee2d
commit 88439191ad

View File

@ -87,6 +87,8 @@ struct pyrf_event {
struct addr_location al;
/** @al_resolved: True when machine__resolve been called. */
bool al_resolved;
/** @callchain: Resolved callchain, eagerly computed if requested. */
PyObject *callchain;
/** @event: The underlying perf_event that may be in a file or ring buffer. */
union perf_event event;
};
@ -124,6 +126,7 @@ static void pyrf_event__delete(struct pyrf_event *pevent)
{
if (pevent->al_resolved)
addr_location__exit(&pevent->al);
Py_XDECREF(pevent->callchain);
perf_sample__exit(&pevent->sample);
Py_TYPE(pevent)->tp_free((PyObject *)pevent);
}
@ -785,6 +788,144 @@ static PyObject *pyrf_sample_event__insn(PyObject *self, PyObject *args __maybe_
pevent->sample.insn_len);
}
struct pyrf_callchain_node {
PyObject_HEAD
u64 ip;
struct map *map;
struct symbol *sym;
};
static void pyrf_callchain_node__delete(struct pyrf_callchain_node *pnode)
{
map__put(pnode->map);
Py_TYPE(pnode)->tp_free((PyObject *)pnode);
}
static PyObject *pyrf_callchain_node__get_ip(struct pyrf_callchain_node *pnode,
void *closure __maybe_unused)
{
return PyLong_FromUnsignedLongLong(pnode->ip);
}
static PyObject *pyrf_callchain_node__get_symbol(struct pyrf_callchain_node *pnode,
void *closure __maybe_unused)
{
if (pnode->sym)
return PyUnicode_FromString(pnode->sym->name);
return PyUnicode_FromString("[unknown]");
}
static PyObject *pyrf_callchain_node__get_dso(struct pyrf_callchain_node *pnode,
void *closure __maybe_unused)
{
const char *dsoname = "[unknown]";
if (pnode->map) {
struct dso *dso = map__dso(pnode->map);
if (dso) {
if (symbol_conf.show_kernel_path && dso__long_name(dso))
dsoname = dso__long_name(dso);
else
dsoname = dso__name(dso);
}
}
return PyUnicode_FromString(dsoname);
}
static PyGetSetDef pyrf_callchain_node__getset[] = {
{ .name = "ip", .get = (getter)pyrf_callchain_node__get_ip, },
{ .name = "symbol", .get = (getter)pyrf_callchain_node__get_symbol, },
{ .name = "dso", .get = (getter)pyrf_callchain_node__get_dso, },
{ .name = NULL, },
};
static PyTypeObject pyrf_callchain_node__type = {
PyVarObject_HEAD_INIT(NULL, 0)
.tp_name = "perf.callchain_node",
.tp_basicsize = sizeof(struct pyrf_callchain_node),
.tp_dealloc = (destructor)pyrf_callchain_node__delete,
.tp_flags = Py_TPFLAGS_DEFAULT|Py_TPFLAGS_BASETYPE,
.tp_doc = "perf callchain node object.",
.tp_getset = pyrf_callchain_node__getset,
};
struct pyrf_callchain_frame {
u64 ip;
struct map *map;
struct symbol *sym;
};
struct pyrf_callchain {
PyObject_HEAD
struct pyrf_callchain_frame *frames;
u64 nr_frames;
};
static void pyrf_callchain__delete(struct pyrf_callchain *pchain)
{
if (pchain->frames) {
for (u64 i = 0; i < pchain->nr_frames; i++)
map__put(pchain->frames[i].map);
free(pchain->frames);
}
Py_TYPE(pchain)->tp_free((PyObject *)pchain);
}
static Py_ssize_t pyrf_callchain__length(PyObject *obj)
{
struct pyrf_callchain *pchain = (void *)obj;
return pchain->nr_frames;
}
static PyObject *pyrf_callchain__item(PyObject *obj, Py_ssize_t i)
{
struct pyrf_callchain *pchain = (void *)obj;
struct pyrf_callchain_node *pnode;
if (i < 0 || i >= (Py_ssize_t)pchain->nr_frames) {
PyErr_SetString(PyExc_IndexError, "Index out of range");
return NULL;
}
pnode = PyObject_New(struct pyrf_callchain_node, &pyrf_callchain_node__type);
if (!pnode)
return NULL;
pnode->ip = pchain->frames[i].ip;
pnode->map = map__get(pchain->frames[i].map);
pnode->sym = pchain->frames[i].sym;
return (PyObject *)pnode;
}
static PySequenceMethods pyrf_callchain__sequence_methods = {
.sq_length = pyrf_callchain__length,
.sq_item = pyrf_callchain__item,
};
static PyTypeObject pyrf_callchain__type = {
PyVarObject_HEAD_INIT(NULL, 0)
.tp_name = "perf.callchain",
.tp_basicsize = sizeof(struct pyrf_callchain),
.tp_dealloc = (destructor)pyrf_callchain__delete,
.tp_flags = Py_TPFLAGS_DEFAULT|Py_TPFLAGS_BASETYPE,
.tp_doc = "perf callchain object.",
.tp_as_sequence = &pyrf_callchain__sequence_methods,
};
static PyObject *pyrf_sample_event__get_callchain(PyObject *self, void *closure __maybe_unused)
{
struct pyrf_event *pevent = (void *)self;
if (!pevent->callchain)
Py_RETURN_NONE;
Py_INCREF(pevent->callchain);
return pevent->callchain;
}
static PyObject*
pyrf_sample_event__getattro(struct pyrf_event *pevent, PyObject *attr_name)
{
@ -799,6 +940,12 @@ pyrf_sample_event__getattro(struct pyrf_event *pevent, PyObject *attr_name)
}
static PyGetSetDef pyrf_sample_event__getset[] = {
{
.name = "callchain",
.get = pyrf_sample_event__get_callchain,
.set = NULL,
.doc = "event callchain.",
},
{
.name = "raw_buf",
.get = (getter)pyrf_sample_event__get_raw_buf,
@ -968,6 +1115,12 @@ static int pyrf_event__setup_types(void)
err = PyType_Ready(&pyrf_context_switch_event__type);
if (err < 0)
goto out;
err = PyType_Ready(&pyrf_callchain_node__type);
if (err < 0)
goto out;
err = PyType_Ready(&pyrf_callchain__type);
if (err < 0)
goto out;
out:
return err;
}
@ -987,13 +1140,19 @@ static PyTypeObject *pyrf_event__type[] = {
[PERF_RECORD_SWITCH_CPU_WIDE] = &pyrf_context_switch_event__type,
};
static PyObject *pyrf_event__new(const union perf_event *event, struct evsel *evsel)
static PyObject *pyrf_event__new(const union perf_event *event, struct evsel *evsel,
struct perf_session *session,
struct machine *machine)
{
struct pyrf_event *pevent;
struct perf_sample *sample;
int err;
u32 min_size;
bool needs_swap;
if (!machine)
machine = session ? &session->machines.host : NULL;
if (event->header.type >= ARRAY_SIZE(pyrf_event__type) ||
pyrf_event__type[event->header.type] == NULL) {
return PyErr_Format(PyExc_TypeError, "Unexpected header type %u",
@ -1025,6 +1184,7 @@ static PyObject *pyrf_event__new(const union perf_event *event, struct evsel *ev
pevent->event.mmap2.filename[sizeof(pevent->event.mmap2.filename) - 1] = '\0';
perf_sample__init(&pevent->sample, /*all=*/true);
pevent->callchain = NULL;
pevent->al_resolved = false;
addr_location__init(&pevent->al);
@ -1042,6 +1202,50 @@ static PyObject *pyrf_event__new(const union perf_event *event, struct evsel *ev
return PyErr_Format(PyExc_OSError,
"perf: can't parse sample, err=%d", err);
}
sample = &pevent->sample;
if (machine && sample->callchain) {
struct addr_location al;
struct callchain_cursor *cursor;
u64 i;
struct pyrf_callchain *pchain;
addr_location__init(&al);
if (machine__resolve(machine, &al, sample) >= 0) {
cursor = get_tls_callchain_cursor();
if (thread__resolve_callchain(al.thread, cursor, sample,
NULL, NULL, PERF_MAX_STACK_DEPTH) == 0) {
callchain_cursor_commit(cursor);
pchain = PyObject_New(struct pyrf_callchain, &pyrf_callchain__type);
if (!pchain) {
addr_location__exit(&al);
Py_DECREF(pevent);
return NULL;
}
pchain->nr_frames = cursor->nr;
pchain->frames = calloc(pchain->nr_frames,
sizeof(*pchain->frames));
if (!pchain->frames) {
Py_DECREF(pchain);
addr_location__exit(&al);
Py_DECREF(pevent);
return PyErr_NoMemory();
}
struct callchain_cursor_node *node;
for (i = 0; i < pchain->nr_frames; i++) {
node = callchain_cursor_current(cursor);
pchain->frames[i].ip = node->ip;
pchain->frames[i].map =
map__get(node->ms.map);
pchain->frames[i].sym = node->ms.sym;
callchain_cursor_advance(cursor);
}
pevent->callchain = (PyObject *)pchain;
}
addr_location__exit(&al);
}
}
return (PyObject *)pevent;
}
@ -2417,7 +2621,7 @@ static PyObject *pyrf_evlist__read_on_cpu(struct pyrf_evlist *pevlist,
perf_mmap__consume(&md->core);
Py_RETURN_NONE;
}
pyevent = pyrf_event__new(event, evsel);
pyevent = pyrf_event__new(event, evsel, evlist__session(evlist), /*machine=*/NULL);
perf_mmap__consume(&md->core);
if (pyevent == NULL)
return PyErr_Occurred() ? NULL : PyErr_NoMemory();
@ -3185,10 +3389,10 @@ struct pyrf_session {
static int pyrf_session_tool__sample(const struct perf_tool *tool,
union perf_event *event,
struct perf_sample *sample,
struct machine *machine __maybe_unused)
struct machine *machine)
{
struct pyrf_session *psession = container_of(tool, struct pyrf_session, tool);
PyObject *pyevent = pyrf_event__new(event, sample->evsel);
PyObject *pyevent = pyrf_event__new(event, sample->evsel, psession->session, machine);
PyObject *ret;
if (pyevent == NULL)
@ -3296,6 +3500,9 @@ static PyObject *pyrf_session__new(PyTypeObject *type, PyObject *args, PyObject
}
psession->session = session;
symbol_conf.use_callchain = true;
symbol_conf.show_kernel_path = true;
symbol_conf.inline_name = false;
if (symbol__init(perf_session__env(session)) < 0) {
PyErr_SetString(PyExc_OSError, "perf: symbol__init failed");
goto err_out;
@ -3475,6 +3682,12 @@ PyMODINIT_FUNC PyInit_perf(void)
Py_INCREF(&pyrf_thread__type);
PyModule_AddObject(module, "thread", (PyObject *)&pyrf_thread__type);
Py_INCREF(&pyrf_callchain__type);
PyModule_AddObject(module, "callchain", (PyObject *)&pyrf_callchain__type);
Py_INCREF(&pyrf_callchain_node__type);
PyModule_AddObject(module, "callchain_node", (PyObject *)&pyrf_callchain_node__type);
Py_INCREF(&pyrf_mmap_event__type);
PyModule_AddObject(module, "mmap_event", (PyObject *)&pyrf_mmap_event__type);