1 // SPDX-License-Identifier: GPL-2.0
3 #include <structmember.h>
7 #include <perf/cpumap.h>
8 #ifdef HAVE_LIBTRACEEVENT
9 #include <traceevent/event-parse.h>
11 #include <perf/mmap.h>
13 #include "callchain.h"
16 #include "print_binary.h"
17 #include "thread_map.h"
18 #include "trace-event.h"
21 #include "metricgroup.h"
22 #include "util/bpf-filter.h"
25 #include "util/pmus.h"
26 #include <internal/lib.h>
29 #if PY_MAJOR_VERSION < 3
30 #define _PyUnicode_FromString(arg) \
31 PyString_FromString(arg)
32 #define _PyUnicode_AsString(arg) \
33 PyString_AsString(arg)
34 #define _PyUnicode_FromFormat(...) \
35 PyString_FromFormat(__VA_ARGS__)
36 #define _PyLong_FromLong(arg) \
41 #define _PyUnicode_FromString(arg) \
42 PyUnicode_FromString(arg)
43 #define _PyUnicode_FromFormat(...) \
44 PyUnicode_FromFormat(__VA_ARGS__)
45 #define _PyLong_FromLong(arg) \
50 #define Py_TYPE(ob) (((PyObject*)(ob))->ob_type)
54 * Avoid bringing in event parsing.
56 int parse_event(struct evlist *evlist __maybe_unused, const char *str __maybe_unused)
62 * Provide these two so that we don't have to link against callchain.c and
63 * start dragging hist.c, etc.
65 struct callchain_param callchain_param;
67 int parse_callchain_record(const char *arg __maybe_unused,
68 struct callchain_param *param __maybe_unused)
74 * Add these not to drag util/env.c
76 struct perf_env perf_env;
78 const char *perf_env__cpuid(struct perf_env *env __maybe_unused)
83 // This one is a bit easier, wouldn't drag too much, but leave it as a stub we need it here
84 const char *perf_env__arch(struct perf_env *env __maybe_unused)
90 * These ones are needed not to drag the PMU bandwagon, jevents generated
91 * pmu_sys_event_tables, etc and evsel__find_pmu() is used so far just for
92 * doing per PMU perf_event_attr.exclude_guest handling, not really needed, so
93 * far, for the perf python binding known usecases, revisit if this become
96 struct perf_pmu *evsel__find_pmu(const struct evsel *evsel __maybe_unused)
101 int perf_pmu__scan_file(const struct perf_pmu *pmu, const char *name, const char *fmt, ...)
106 int perf_pmus__num_core_pmus(void)
111 bool evsel__is_aux_event(const struct evsel *evsel __maybe_unused)
116 bool perf_pmus__supports_extended_type(void)
122 * Add this one here not to drag util/metricgroup.c
124 int metricgroup__copy_metric_events(struct evlist *evlist, struct cgroup *cgrp,
125 struct rblist *new_metric_events,
126 struct rblist *old_metric_events)
132 * Add this one here not to drag util/trace-event-info.c
134 char *tracepoint_id_to_name(u64 config)
140 * XXX: All these evsel destructors need some better mechanism, like a linked
141 * list of destructors registered when the relevant code indeed is used instead
142 * of having more and more calls in perf_evsel__delete(). -- acme
144 * For now, add some more:
146 * Not to drag the BPF bandwagon...
148 void bpf_counter__destroy(struct evsel *evsel);
149 int bpf_counter__install_pe(struct evsel *evsel, int cpu, int fd);
150 int bpf_counter__disable(struct evsel *evsel);
152 void bpf_counter__destroy(struct evsel *evsel __maybe_unused)
156 int bpf_counter__install_pe(struct evsel *evsel __maybe_unused, int cpu __maybe_unused, int fd __maybe_unused)
161 int bpf_counter__disable(struct evsel *evsel __maybe_unused)
166 // not to drag util/bpf-filter.c
168 int perf_bpf_filter__prepare(struct evsel *evsel __maybe_unused)
173 int perf_bpf_filter__destroy(struct evsel *evsel __maybe_unused)
180 * Support debug printing even though util/debug.c is not linked. That means
181 * implementing 'verbose' and 'eprintf'.
186 int eprintf(int level, int var, const char *fmt, ...);
188 int eprintf(int level, int var, const char *fmt, ...)
195 ret = vfprintf(stderr, fmt, args);
202 /* Define PyVarObject_HEAD_INIT for python 2.5 */
203 #ifndef PyVarObject_HEAD_INIT
204 # define PyVarObject_HEAD_INIT(type, size) PyObject_HEAD_INIT(type) size,
207 #if PY_MAJOR_VERSION < 3
208 PyMODINIT_FUNC initperf(void);
210 PyMODINIT_FUNC PyInit_perf(void);
213 #define member_def(type, member, ptype, help) \
215 offsetof(struct pyrf_event, event) + offsetof(struct type, member), \
218 #define sample_member_def(name, member, ptype, help) \
220 offsetof(struct pyrf_event, sample) + offsetof(struct perf_sample, member), \
226 struct perf_sample sample;
227 union perf_event event;
230 #define sample_members \
231 sample_member_def(sample_ip, ip, T_ULONGLONG, "event type"), \
232 sample_member_def(sample_pid, pid, T_INT, "event pid"), \
233 sample_member_def(sample_tid, tid, T_INT, "event tid"), \
234 sample_member_def(sample_time, time, T_ULONGLONG, "event timestamp"), \
235 sample_member_def(sample_addr, addr, T_ULONGLONG, "event addr"), \
236 sample_member_def(sample_id, id, T_ULONGLONG, "event id"), \
237 sample_member_def(sample_stream_id, stream_id, T_ULONGLONG, "event stream id"), \
238 sample_member_def(sample_period, period, T_ULONGLONG, "event period"), \
239 sample_member_def(sample_cpu, cpu, T_UINT, "event cpu"),
241 static char pyrf_mmap_event__doc[] = PyDoc_STR("perf mmap event object.");
243 static PyMemberDef pyrf_mmap_event__members[] = {
245 member_def(perf_event_header, type, T_UINT, "event type"),
246 member_def(perf_event_header, misc, T_UINT, "event misc"),
247 member_def(perf_record_mmap, pid, T_UINT, "event pid"),
248 member_def(perf_record_mmap, tid, T_UINT, "event tid"),
249 member_def(perf_record_mmap, start, T_ULONGLONG, "start of the map"),
250 member_def(perf_record_mmap, len, T_ULONGLONG, "map length"),
251 member_def(perf_record_mmap, pgoff, T_ULONGLONG, "page offset"),
252 member_def(perf_record_mmap, filename, T_STRING_INPLACE, "backing store"),
256 static PyObject *pyrf_mmap_event__repr(struct pyrf_event *pevent)
261 if (asprintf(&s, "{ type: mmap, pid: %u, tid: %u, start: %#" PRI_lx64 ", "
262 "length: %#" PRI_lx64 ", offset: %#" PRI_lx64 ", "
264 pevent->event.mmap.pid, pevent->event.mmap.tid,
265 pevent->event.mmap.start, pevent->event.mmap.len,
266 pevent->event.mmap.pgoff, pevent->event.mmap.filename) < 0) {
267 ret = PyErr_NoMemory();
269 ret = _PyUnicode_FromString(s);
275 static PyTypeObject pyrf_mmap_event__type = {
276 PyVarObject_HEAD_INIT(NULL, 0)
277 .tp_name = "perf.mmap_event",
278 .tp_basicsize = sizeof(struct pyrf_event),
279 .tp_flags = Py_TPFLAGS_DEFAULT|Py_TPFLAGS_BASETYPE,
280 .tp_doc = pyrf_mmap_event__doc,
281 .tp_members = pyrf_mmap_event__members,
282 .tp_repr = (reprfunc)pyrf_mmap_event__repr,
285 static char pyrf_task_event__doc[] = PyDoc_STR("perf task (fork/exit) event object.");
287 static PyMemberDef pyrf_task_event__members[] = {
289 member_def(perf_event_header, type, T_UINT, "event type"),
290 member_def(perf_record_fork, pid, T_UINT, "event pid"),
291 member_def(perf_record_fork, ppid, T_UINT, "event ppid"),
292 member_def(perf_record_fork, tid, T_UINT, "event tid"),
293 member_def(perf_record_fork, ptid, T_UINT, "event ptid"),
294 member_def(perf_record_fork, time, T_ULONGLONG, "timestamp"),
298 static PyObject *pyrf_task_event__repr(struct pyrf_event *pevent)
300 return _PyUnicode_FromFormat("{ type: %s, pid: %u, ppid: %u, tid: %u, "
301 "ptid: %u, time: %" PRI_lu64 "}",
302 pevent->event.header.type == PERF_RECORD_FORK ? "fork" : "exit",
303 pevent->event.fork.pid,
304 pevent->event.fork.ppid,
305 pevent->event.fork.tid,
306 pevent->event.fork.ptid,
307 pevent->event.fork.time);
310 static PyTypeObject pyrf_task_event__type = {
311 PyVarObject_HEAD_INIT(NULL, 0)
312 .tp_name = "perf.task_event",
313 .tp_basicsize = sizeof(struct pyrf_event),
314 .tp_flags = Py_TPFLAGS_DEFAULT|Py_TPFLAGS_BASETYPE,
315 .tp_doc = pyrf_task_event__doc,
316 .tp_members = pyrf_task_event__members,
317 .tp_repr = (reprfunc)pyrf_task_event__repr,
320 static char pyrf_comm_event__doc[] = PyDoc_STR("perf comm event object.");
322 static PyMemberDef pyrf_comm_event__members[] = {
324 member_def(perf_event_header, type, T_UINT, "event type"),
325 member_def(perf_record_comm, pid, T_UINT, "event pid"),
326 member_def(perf_record_comm, tid, T_UINT, "event tid"),
327 member_def(perf_record_comm, comm, T_STRING_INPLACE, "process name"),
331 static PyObject *pyrf_comm_event__repr(struct pyrf_event *pevent)
333 return _PyUnicode_FromFormat("{ type: comm, pid: %u, tid: %u, comm: %s }",
334 pevent->event.comm.pid,
335 pevent->event.comm.tid,
336 pevent->event.comm.comm);
339 static PyTypeObject pyrf_comm_event__type = {
340 PyVarObject_HEAD_INIT(NULL, 0)
341 .tp_name = "perf.comm_event",
342 .tp_basicsize = sizeof(struct pyrf_event),
343 .tp_flags = Py_TPFLAGS_DEFAULT|Py_TPFLAGS_BASETYPE,
344 .tp_doc = pyrf_comm_event__doc,
345 .tp_members = pyrf_comm_event__members,
346 .tp_repr = (reprfunc)pyrf_comm_event__repr,
349 static char pyrf_throttle_event__doc[] = PyDoc_STR("perf throttle event object.");
351 static PyMemberDef pyrf_throttle_event__members[] = {
353 member_def(perf_event_header, type, T_UINT, "event type"),
354 member_def(perf_record_throttle, time, T_ULONGLONG, "timestamp"),
355 member_def(perf_record_throttle, id, T_ULONGLONG, "event id"),
356 member_def(perf_record_throttle, stream_id, T_ULONGLONG, "event stream id"),
360 static PyObject *pyrf_throttle_event__repr(struct pyrf_event *pevent)
362 struct perf_record_throttle *te = (struct perf_record_throttle *)(&pevent->event.header + 1);
364 return _PyUnicode_FromFormat("{ type: %sthrottle, time: %" PRI_lu64 ", id: %" PRI_lu64
365 ", stream_id: %" PRI_lu64 " }",
366 pevent->event.header.type == PERF_RECORD_THROTTLE ? "" : "un",
367 te->time, te->id, te->stream_id);
370 static PyTypeObject pyrf_throttle_event__type = {
371 PyVarObject_HEAD_INIT(NULL, 0)
372 .tp_name = "perf.throttle_event",
373 .tp_basicsize = sizeof(struct pyrf_event),
374 .tp_flags = Py_TPFLAGS_DEFAULT|Py_TPFLAGS_BASETYPE,
375 .tp_doc = pyrf_throttle_event__doc,
376 .tp_members = pyrf_throttle_event__members,
377 .tp_repr = (reprfunc)pyrf_throttle_event__repr,
380 static char pyrf_lost_event__doc[] = PyDoc_STR("perf lost event object.");
382 static PyMemberDef pyrf_lost_event__members[] = {
384 member_def(perf_record_lost, id, T_ULONGLONG, "event id"),
385 member_def(perf_record_lost, lost, T_ULONGLONG, "number of lost events"),
389 static PyObject *pyrf_lost_event__repr(struct pyrf_event *pevent)
394 if (asprintf(&s, "{ type: lost, id: %#" PRI_lx64 ", "
395 "lost: %#" PRI_lx64 " }",
396 pevent->event.lost.id, pevent->event.lost.lost) < 0) {
397 ret = PyErr_NoMemory();
399 ret = _PyUnicode_FromString(s);
405 static PyTypeObject pyrf_lost_event__type = {
406 PyVarObject_HEAD_INIT(NULL, 0)
407 .tp_name = "perf.lost_event",
408 .tp_basicsize = sizeof(struct pyrf_event),
409 .tp_flags = Py_TPFLAGS_DEFAULT|Py_TPFLAGS_BASETYPE,
410 .tp_doc = pyrf_lost_event__doc,
411 .tp_members = pyrf_lost_event__members,
412 .tp_repr = (reprfunc)pyrf_lost_event__repr,
415 static char pyrf_read_event__doc[] = PyDoc_STR("perf read event object.");
417 static PyMemberDef pyrf_read_event__members[] = {
419 member_def(perf_record_read, pid, T_UINT, "event pid"),
420 member_def(perf_record_read, tid, T_UINT, "event tid"),
424 static PyObject *pyrf_read_event__repr(struct pyrf_event *pevent)
426 return _PyUnicode_FromFormat("{ type: read, pid: %u, tid: %u }",
427 pevent->event.read.pid,
428 pevent->event.read.tid);
430 * FIXME: return the array of read values,
431 * making this method useful ;-)
435 static PyTypeObject pyrf_read_event__type = {
436 PyVarObject_HEAD_INIT(NULL, 0)
437 .tp_name = "perf.read_event",
438 .tp_basicsize = sizeof(struct pyrf_event),
439 .tp_flags = Py_TPFLAGS_DEFAULT|Py_TPFLAGS_BASETYPE,
440 .tp_doc = pyrf_read_event__doc,
441 .tp_members = pyrf_read_event__members,
442 .tp_repr = (reprfunc)pyrf_read_event__repr,
445 static char pyrf_sample_event__doc[] = PyDoc_STR("perf sample event object.");
447 static PyMemberDef pyrf_sample_event__members[] = {
449 member_def(perf_event_header, type, T_UINT, "event type"),
453 static PyObject *pyrf_sample_event__repr(struct pyrf_event *pevent)
458 if (asprintf(&s, "{ type: sample }") < 0) {
459 ret = PyErr_NoMemory();
461 ret = _PyUnicode_FromString(s);
467 #ifdef HAVE_LIBTRACEEVENT
468 static bool is_tracepoint(struct pyrf_event *pevent)
470 return pevent->evsel->core.attr.type == PERF_TYPE_TRACEPOINT;
474 tracepoint_field(struct pyrf_event *pe, struct tep_format_field *field)
476 struct tep_handle *pevent = field->event->tep;
477 void *data = pe->sample.raw_data;
478 PyObject *ret = NULL;
479 unsigned long long val;
480 unsigned int offset, len;
482 if (field->flags & TEP_FIELD_IS_ARRAY) {
483 offset = field->offset;
485 if (field->flags & TEP_FIELD_IS_DYNAMIC) {
486 val = tep_read_number(pevent, data + offset, len);
490 if (tep_field_is_relative(field->flags))
491 offset += field->offset + field->size;
493 if (field->flags & TEP_FIELD_IS_STRING &&
494 is_printable_array(data + offset, len)) {
495 ret = _PyUnicode_FromString((char *)data + offset);
497 ret = PyByteArray_FromStringAndSize((const char *) data + offset, len);
498 field->flags &= ~TEP_FIELD_IS_STRING;
501 val = tep_read_number(pevent, data + field->offset,
503 if (field->flags & TEP_FIELD_IS_POINTER)
504 ret = PyLong_FromUnsignedLong((unsigned long) val);
505 else if (field->flags & TEP_FIELD_IS_SIGNED)
506 ret = PyLong_FromLong((long) val);
508 ret = PyLong_FromUnsignedLong((unsigned long) val);
515 get_tracepoint_field(struct pyrf_event *pevent, PyObject *attr_name)
517 const char *str = _PyUnicode_AsString(PyObject_Str(attr_name));
518 struct evsel *evsel = pevent->evsel;
519 struct tep_format_field *field;
521 if (!evsel->tp_format) {
522 struct tep_event *tp_format;
524 tp_format = trace_event__tp_format_id(evsel->core.attr.config);
525 if (IS_ERR_OR_NULL(tp_format))
528 evsel->tp_format = tp_format;
531 field = tep_find_any_field(evsel->tp_format, str);
535 return tracepoint_field(pevent, field);
537 #endif /* HAVE_LIBTRACEEVENT */
540 pyrf_sample_event__getattro(struct pyrf_event *pevent, PyObject *attr_name)
542 PyObject *obj = NULL;
544 #ifdef HAVE_LIBTRACEEVENT
545 if (is_tracepoint(pevent))
546 obj = get_tracepoint_field(pevent, attr_name);
549 return obj ?: PyObject_GenericGetAttr((PyObject *) pevent, attr_name);
552 static PyTypeObject pyrf_sample_event__type = {
553 PyVarObject_HEAD_INIT(NULL, 0)
554 .tp_name = "perf.sample_event",
555 .tp_basicsize = sizeof(struct pyrf_event),
556 .tp_flags = Py_TPFLAGS_DEFAULT|Py_TPFLAGS_BASETYPE,
557 .tp_doc = pyrf_sample_event__doc,
558 .tp_members = pyrf_sample_event__members,
559 .tp_repr = (reprfunc)pyrf_sample_event__repr,
560 .tp_getattro = (getattrofunc) pyrf_sample_event__getattro,
563 static char pyrf_context_switch_event__doc[] = PyDoc_STR("perf context_switch event object.");
565 static PyMemberDef pyrf_context_switch_event__members[] = {
567 member_def(perf_event_header, type, T_UINT, "event type"),
568 member_def(perf_record_switch, next_prev_pid, T_UINT, "next/prev pid"),
569 member_def(perf_record_switch, next_prev_tid, T_UINT, "next/prev tid"),
573 static PyObject *pyrf_context_switch_event__repr(struct pyrf_event *pevent)
578 if (asprintf(&s, "{ type: context_switch, next_prev_pid: %u, next_prev_tid: %u, switch_out: %u }",
579 pevent->event.context_switch.next_prev_pid,
580 pevent->event.context_switch.next_prev_tid,
581 !!(pevent->event.header.misc & PERF_RECORD_MISC_SWITCH_OUT)) < 0) {
582 ret = PyErr_NoMemory();
584 ret = _PyUnicode_FromString(s);
590 static PyTypeObject pyrf_context_switch_event__type = {
591 PyVarObject_HEAD_INIT(NULL, 0)
592 .tp_name = "perf.context_switch_event",
593 .tp_basicsize = sizeof(struct pyrf_event),
594 .tp_flags = Py_TPFLAGS_DEFAULT|Py_TPFLAGS_BASETYPE,
595 .tp_doc = pyrf_context_switch_event__doc,
596 .tp_members = pyrf_context_switch_event__members,
597 .tp_repr = (reprfunc)pyrf_context_switch_event__repr,
600 static int pyrf_event__setup_types(void)
603 pyrf_mmap_event__type.tp_new =
604 pyrf_task_event__type.tp_new =
605 pyrf_comm_event__type.tp_new =
606 pyrf_lost_event__type.tp_new =
607 pyrf_read_event__type.tp_new =
608 pyrf_sample_event__type.tp_new =
609 pyrf_context_switch_event__type.tp_new =
610 pyrf_throttle_event__type.tp_new = PyType_GenericNew;
611 err = PyType_Ready(&pyrf_mmap_event__type);
614 err = PyType_Ready(&pyrf_lost_event__type);
617 err = PyType_Ready(&pyrf_task_event__type);
620 err = PyType_Ready(&pyrf_comm_event__type);
623 err = PyType_Ready(&pyrf_throttle_event__type);
626 err = PyType_Ready(&pyrf_read_event__type);
629 err = PyType_Ready(&pyrf_sample_event__type);
632 err = PyType_Ready(&pyrf_context_switch_event__type);
639 static PyTypeObject *pyrf_event__type[] = {
640 [PERF_RECORD_MMAP] = &pyrf_mmap_event__type,
641 [PERF_RECORD_LOST] = &pyrf_lost_event__type,
642 [PERF_RECORD_COMM] = &pyrf_comm_event__type,
643 [PERF_RECORD_EXIT] = &pyrf_task_event__type,
644 [PERF_RECORD_THROTTLE] = &pyrf_throttle_event__type,
645 [PERF_RECORD_UNTHROTTLE] = &pyrf_throttle_event__type,
646 [PERF_RECORD_FORK] = &pyrf_task_event__type,
647 [PERF_RECORD_READ] = &pyrf_read_event__type,
648 [PERF_RECORD_SAMPLE] = &pyrf_sample_event__type,
649 [PERF_RECORD_SWITCH] = &pyrf_context_switch_event__type,
650 [PERF_RECORD_SWITCH_CPU_WIDE] = &pyrf_context_switch_event__type,
653 static PyObject *pyrf_event__new(union perf_event *event)
655 struct pyrf_event *pevent;
658 if ((event->header.type < PERF_RECORD_MMAP ||
659 event->header.type > PERF_RECORD_SAMPLE) &&
660 !(event->header.type == PERF_RECORD_SWITCH ||
661 event->header.type == PERF_RECORD_SWITCH_CPU_WIDE))
664 ptype = pyrf_event__type[event->header.type];
665 pevent = PyObject_New(struct pyrf_event, ptype);
667 memcpy(&pevent->event, event, event->header.size);
668 return (PyObject *)pevent;
671 struct pyrf_cpu_map {
674 struct perf_cpu_map *cpus;
677 static int pyrf_cpu_map__init(struct pyrf_cpu_map *pcpus,
678 PyObject *args, PyObject *kwargs)
680 static char *kwlist[] = { "cpustr", NULL };
683 if (!PyArg_ParseTupleAndKeywords(args, kwargs, "|s",
687 pcpus->cpus = perf_cpu_map__new(cpustr);
688 if (pcpus->cpus == NULL)
693 static void pyrf_cpu_map__delete(struct pyrf_cpu_map *pcpus)
695 perf_cpu_map__put(pcpus->cpus);
696 Py_TYPE(pcpus)->tp_free((PyObject*)pcpus);
699 static Py_ssize_t pyrf_cpu_map__length(PyObject *obj)
701 struct pyrf_cpu_map *pcpus = (void *)obj;
703 return perf_cpu_map__nr(pcpus->cpus);
706 static PyObject *pyrf_cpu_map__item(PyObject *obj, Py_ssize_t i)
708 struct pyrf_cpu_map *pcpus = (void *)obj;
710 if (i >= perf_cpu_map__nr(pcpus->cpus))
713 return Py_BuildValue("i", perf_cpu_map__cpu(pcpus->cpus, i).cpu);
716 static PySequenceMethods pyrf_cpu_map__sequence_methods = {
717 .sq_length = pyrf_cpu_map__length,
718 .sq_item = pyrf_cpu_map__item,
721 static char pyrf_cpu_map__doc[] = PyDoc_STR("cpu map object.");
723 static PyTypeObject pyrf_cpu_map__type = {
724 PyVarObject_HEAD_INIT(NULL, 0)
725 .tp_name = "perf.cpu_map",
726 .tp_basicsize = sizeof(struct pyrf_cpu_map),
727 .tp_dealloc = (destructor)pyrf_cpu_map__delete,
728 .tp_flags = Py_TPFLAGS_DEFAULT|Py_TPFLAGS_BASETYPE,
729 .tp_doc = pyrf_cpu_map__doc,
730 .tp_as_sequence = &pyrf_cpu_map__sequence_methods,
731 .tp_init = (initproc)pyrf_cpu_map__init,
734 static int pyrf_cpu_map__setup_types(void)
736 pyrf_cpu_map__type.tp_new = PyType_GenericNew;
737 return PyType_Ready(&pyrf_cpu_map__type);
740 struct pyrf_thread_map {
743 struct perf_thread_map *threads;
746 static int pyrf_thread_map__init(struct pyrf_thread_map *pthreads,
747 PyObject *args, PyObject *kwargs)
749 static char *kwlist[] = { "pid", "tid", "uid", NULL };
750 int pid = -1, tid = -1, uid = UINT_MAX;
752 if (!PyArg_ParseTupleAndKeywords(args, kwargs, "|iii",
753 kwlist, &pid, &tid, &uid))
756 pthreads->threads = thread_map__new(pid, tid, uid);
757 if (pthreads->threads == NULL)
762 static void pyrf_thread_map__delete(struct pyrf_thread_map *pthreads)
764 perf_thread_map__put(pthreads->threads);
765 Py_TYPE(pthreads)->tp_free((PyObject*)pthreads);
768 static Py_ssize_t pyrf_thread_map__length(PyObject *obj)
770 struct pyrf_thread_map *pthreads = (void *)obj;
772 return perf_thread_map__nr(pthreads->threads);
775 static PyObject *pyrf_thread_map__item(PyObject *obj, Py_ssize_t i)
777 struct pyrf_thread_map *pthreads = (void *)obj;
779 if (i >= perf_thread_map__nr(pthreads->threads))
782 return Py_BuildValue("i", perf_thread_map__pid(pthreads->threads, i));
785 static PySequenceMethods pyrf_thread_map__sequence_methods = {
786 .sq_length = pyrf_thread_map__length,
787 .sq_item = pyrf_thread_map__item,
790 static char pyrf_thread_map__doc[] = PyDoc_STR("thread map object.");
792 static PyTypeObject pyrf_thread_map__type = {
793 PyVarObject_HEAD_INIT(NULL, 0)
794 .tp_name = "perf.thread_map",
795 .tp_basicsize = sizeof(struct pyrf_thread_map),
796 .tp_dealloc = (destructor)pyrf_thread_map__delete,
797 .tp_flags = Py_TPFLAGS_DEFAULT|Py_TPFLAGS_BASETYPE,
798 .tp_doc = pyrf_thread_map__doc,
799 .tp_as_sequence = &pyrf_thread_map__sequence_methods,
800 .tp_init = (initproc)pyrf_thread_map__init,
803 static int pyrf_thread_map__setup_types(void)
805 pyrf_thread_map__type.tp_new = PyType_GenericNew;
806 return PyType_Ready(&pyrf_thread_map__type);
815 static int pyrf_evsel__init(struct pyrf_evsel *pevsel,
816 PyObject *args, PyObject *kwargs)
818 struct perf_event_attr attr = {
819 .type = PERF_TYPE_HARDWARE,
820 .config = PERF_COUNT_HW_CPU_CYCLES,
821 .sample_type = PERF_SAMPLE_PERIOD | PERF_SAMPLE_TID,
823 static char *kwlist[] = {
855 u64 sample_period = 0;
877 if (!PyArg_ParseTupleAndKeywords(args, kwargs,
878 "|iKiKKiiiiiiiiiiiiiiiiiiiiiiKK", kwlist,
879 &attr.type, &attr.config, &attr.sample_freq,
880 &sample_period, &attr.sample_type,
881 &attr.read_format, &disabled, &inherit,
882 &pinned, &exclusive, &exclude_user,
883 &exclude_kernel, &exclude_hv, &exclude_idle,
884 &mmap, &context_switch, &comm, &freq, &inherit_stat,
885 &enable_on_exec, &task, &watermark,
886 &precise_ip, &mmap_data, &sample_id_all,
887 &attr.wakeup_events, &attr.bp_type,
888 &attr.bp_addr, &attr.bp_len, &idx))
892 if (sample_period != 0) {
893 if (attr.sample_freq != 0)
894 return -1; /* FIXME: throw right exception */
895 attr.sample_period = sample_period;
899 attr.disabled = disabled;
900 attr.inherit = inherit;
901 attr.pinned = pinned;
902 attr.exclusive = exclusive;
903 attr.exclude_user = exclude_user;
904 attr.exclude_kernel = exclude_kernel;
905 attr.exclude_hv = exclude_hv;
906 attr.exclude_idle = exclude_idle;
908 attr.context_switch = context_switch;
911 attr.inherit_stat = inherit_stat;
912 attr.enable_on_exec = enable_on_exec;
914 attr.watermark = watermark;
915 attr.precise_ip = precise_ip;
916 attr.mmap_data = mmap_data;
917 attr.sample_id_all = sample_id_all;
918 attr.size = sizeof(attr);
920 evsel__init(&pevsel->evsel, &attr, idx);
924 static void pyrf_evsel__delete(struct pyrf_evsel *pevsel)
926 evsel__exit(&pevsel->evsel);
927 Py_TYPE(pevsel)->tp_free((PyObject*)pevsel);
930 static PyObject *pyrf_evsel__open(struct pyrf_evsel *pevsel,
931 PyObject *args, PyObject *kwargs)
933 struct evsel *evsel = &pevsel->evsel;
934 struct perf_cpu_map *cpus = NULL;
935 struct perf_thread_map *threads = NULL;
936 PyObject *pcpus = NULL, *pthreads = NULL;
937 int group = 0, inherit = 0;
938 static char *kwlist[] = { "cpus", "threads", "group", "inherit", NULL };
940 if (!PyArg_ParseTupleAndKeywords(args, kwargs, "|OOii", kwlist,
941 &pcpus, &pthreads, &group, &inherit))
944 if (pthreads != NULL)
945 threads = ((struct pyrf_thread_map *)pthreads)->threads;
948 cpus = ((struct pyrf_cpu_map *)pcpus)->cpus;
950 evsel->core.attr.inherit = inherit;
952 * This will group just the fds for this single evsel, to group
953 * multiple events, use evlist.open().
955 if (evsel__open(evsel, cpus, threads) < 0) {
956 PyErr_SetFromErrno(PyExc_OSError);
964 static PyMethodDef pyrf_evsel__methods[] = {
967 .ml_meth = (PyCFunction)pyrf_evsel__open,
968 .ml_flags = METH_VARARGS | METH_KEYWORDS,
969 .ml_doc = PyDoc_STR("open the event selector file descriptor table.")
974 static char pyrf_evsel__doc[] = PyDoc_STR("perf event selector list object.");
976 static PyTypeObject pyrf_evsel__type = {
977 PyVarObject_HEAD_INIT(NULL, 0)
978 .tp_name = "perf.evsel",
979 .tp_basicsize = sizeof(struct pyrf_evsel),
980 .tp_dealloc = (destructor)pyrf_evsel__delete,
981 .tp_flags = Py_TPFLAGS_DEFAULT|Py_TPFLAGS_BASETYPE,
982 .tp_doc = pyrf_evsel__doc,
983 .tp_methods = pyrf_evsel__methods,
984 .tp_init = (initproc)pyrf_evsel__init,
987 static int pyrf_evsel__setup_types(void)
989 pyrf_evsel__type.tp_new = PyType_GenericNew;
990 return PyType_Ready(&pyrf_evsel__type);
996 struct evlist evlist;
999 static int pyrf_evlist__init(struct pyrf_evlist *pevlist,
1000 PyObject *args, PyObject *kwargs __maybe_unused)
1002 PyObject *pcpus = NULL, *pthreads = NULL;
1003 struct perf_cpu_map *cpus;
1004 struct perf_thread_map *threads;
1006 if (!PyArg_ParseTuple(args, "OO", &pcpus, &pthreads))
1009 threads = ((struct pyrf_thread_map *)pthreads)->threads;
1010 cpus = ((struct pyrf_cpu_map *)pcpus)->cpus;
1011 evlist__init(&pevlist->evlist, cpus, threads);
1015 static void pyrf_evlist__delete(struct pyrf_evlist *pevlist)
1017 evlist__exit(&pevlist->evlist);
1018 Py_TYPE(pevlist)->tp_free((PyObject*)pevlist);
1021 static PyObject *pyrf_evlist__mmap(struct pyrf_evlist *pevlist,
1022 PyObject *args, PyObject *kwargs)
1024 struct evlist *evlist = &pevlist->evlist;
1025 static char *kwlist[] = { "pages", "overwrite", NULL };
1026 int pages = 128, overwrite = false;
1028 if (!PyArg_ParseTupleAndKeywords(args, kwargs, "|ii", kwlist,
1029 &pages, &overwrite))
1032 if (evlist__mmap(evlist, pages) < 0) {
1033 PyErr_SetFromErrno(PyExc_OSError);
1041 static PyObject *pyrf_evlist__poll(struct pyrf_evlist *pevlist,
1042 PyObject *args, PyObject *kwargs)
1044 struct evlist *evlist = &pevlist->evlist;
1045 static char *kwlist[] = { "timeout", NULL };
1046 int timeout = -1, n;
1048 if (!PyArg_ParseTupleAndKeywords(args, kwargs, "|i", kwlist, &timeout))
1051 n = evlist__poll(evlist, timeout);
1053 PyErr_SetFromErrno(PyExc_OSError);
1057 return Py_BuildValue("i", n);
1060 static PyObject *pyrf_evlist__get_pollfd(struct pyrf_evlist *pevlist,
1061 PyObject *args __maybe_unused,
1062 PyObject *kwargs __maybe_unused)
1064 struct evlist *evlist = &pevlist->evlist;
1065 PyObject *list = PyList_New(0);
1068 for (i = 0; i < evlist->core.pollfd.nr; ++i) {
1070 #if PY_MAJOR_VERSION < 3
1071 FILE *fp = fdopen(evlist->core.pollfd.entries[i].fd, "r");
1076 file = PyFile_FromFile(fp, "perf", "r", NULL);
1078 file = PyFile_FromFd(evlist->core.pollfd.entries[i].fd, "perf", "r", -1,
1079 NULL, NULL, NULL, 0);
1084 if (PyList_Append(list, file) != 0) {
1094 return PyErr_NoMemory();
1098 static PyObject *pyrf_evlist__add(struct pyrf_evlist *pevlist,
1100 PyObject *kwargs __maybe_unused)
1102 struct evlist *evlist = &pevlist->evlist;
1104 struct evsel *evsel;
1106 if (!PyArg_ParseTuple(args, "O", &pevsel))
1110 evsel = &((struct pyrf_evsel *)pevsel)->evsel;
1111 evsel->core.idx = evlist->core.nr_entries;
1112 evlist__add(evlist, evsel);
1114 return Py_BuildValue("i", evlist->core.nr_entries);
1117 static struct mmap *get_md(struct evlist *evlist, int cpu)
1121 for (i = 0; i < evlist->core.nr_mmaps; i++) {
1122 struct mmap *md = &evlist->mmap[i];
1124 if (md->core.cpu.cpu == cpu)
1131 static PyObject *pyrf_evlist__read_on_cpu(struct pyrf_evlist *pevlist,
1132 PyObject *args, PyObject *kwargs)
1134 struct evlist *evlist = &pevlist->evlist;
1135 union perf_event *event;
1136 int sample_id_all = 1, cpu;
1137 static char *kwlist[] = { "cpu", "sample_id_all", NULL };
1141 if (!PyArg_ParseTupleAndKeywords(args, kwargs, "i|i", kwlist,
1142 &cpu, &sample_id_all))
1145 md = get_md(evlist, cpu);
1149 if (perf_mmap__read_init(&md->core) < 0)
1152 event = perf_mmap__read_event(&md->core);
1153 if (event != NULL) {
1154 PyObject *pyevent = pyrf_event__new(event);
1155 struct pyrf_event *pevent = (struct pyrf_event *)pyevent;
1156 struct evsel *evsel;
1158 if (pyevent == NULL)
1159 return PyErr_NoMemory();
1161 evsel = evlist__event2evsel(evlist, event);
1167 pevent->evsel = evsel;
1169 err = evsel__parse_sample(evsel, event, &pevent->sample);
1171 /* Consume the even only after we parsed it out. */
1172 perf_mmap__consume(&md->core);
1175 return PyErr_Format(PyExc_OSError,
1176 "perf: can't parse sample, err=%d", err);
1184 static PyObject *pyrf_evlist__open(struct pyrf_evlist *pevlist,
1185 PyObject *args, PyObject *kwargs)
1187 struct evlist *evlist = &pevlist->evlist;
1189 if (evlist__open(evlist) < 0) {
1190 PyErr_SetFromErrno(PyExc_OSError);
1198 static PyMethodDef pyrf_evlist__methods[] = {
1201 .ml_meth = (PyCFunction)pyrf_evlist__mmap,
1202 .ml_flags = METH_VARARGS | METH_KEYWORDS,
1203 .ml_doc = PyDoc_STR("mmap the file descriptor table.")
1207 .ml_meth = (PyCFunction)pyrf_evlist__open,
1208 .ml_flags = METH_VARARGS | METH_KEYWORDS,
1209 .ml_doc = PyDoc_STR("open the file descriptors.")
1213 .ml_meth = (PyCFunction)pyrf_evlist__poll,
1214 .ml_flags = METH_VARARGS | METH_KEYWORDS,
1215 .ml_doc = PyDoc_STR("poll the file descriptor table.")
1218 .ml_name = "get_pollfd",
1219 .ml_meth = (PyCFunction)pyrf_evlist__get_pollfd,
1220 .ml_flags = METH_VARARGS | METH_KEYWORDS,
1221 .ml_doc = PyDoc_STR("get the poll file descriptor table.")
1225 .ml_meth = (PyCFunction)pyrf_evlist__add,
1226 .ml_flags = METH_VARARGS | METH_KEYWORDS,
1227 .ml_doc = PyDoc_STR("adds an event selector to the list.")
1230 .ml_name = "read_on_cpu",
1231 .ml_meth = (PyCFunction)pyrf_evlist__read_on_cpu,
1232 .ml_flags = METH_VARARGS | METH_KEYWORDS,
1233 .ml_doc = PyDoc_STR("reads an event.")
1235 { .ml_name = NULL, }
1238 static Py_ssize_t pyrf_evlist__length(PyObject *obj)
1240 struct pyrf_evlist *pevlist = (void *)obj;
1242 return pevlist->evlist.core.nr_entries;
1245 static PyObject *pyrf_evlist__item(PyObject *obj, Py_ssize_t i)
1247 struct pyrf_evlist *pevlist = (void *)obj;
1250 if (i >= pevlist->evlist.core.nr_entries)
1253 evlist__for_each_entry(&pevlist->evlist, pos) {
1258 return Py_BuildValue("O", container_of(pos, struct pyrf_evsel, evsel));
1261 static PySequenceMethods pyrf_evlist__sequence_methods = {
1262 .sq_length = pyrf_evlist__length,
1263 .sq_item = pyrf_evlist__item,
1266 static char pyrf_evlist__doc[] = PyDoc_STR("perf event selector list object.");
1268 static PyTypeObject pyrf_evlist__type = {
1269 PyVarObject_HEAD_INIT(NULL, 0)
1270 .tp_name = "perf.evlist",
1271 .tp_basicsize = sizeof(struct pyrf_evlist),
1272 .tp_dealloc = (destructor)pyrf_evlist__delete,
1273 .tp_flags = Py_TPFLAGS_DEFAULT|Py_TPFLAGS_BASETYPE,
1274 .tp_as_sequence = &pyrf_evlist__sequence_methods,
1275 .tp_doc = pyrf_evlist__doc,
1276 .tp_methods = pyrf_evlist__methods,
1277 .tp_init = (initproc)pyrf_evlist__init,
1280 static int pyrf_evlist__setup_types(void)
1282 pyrf_evlist__type.tp_new = PyType_GenericNew;
1283 return PyType_Ready(&pyrf_evlist__type);
1286 #define PERF_CONST(name) { #name, PERF_##name }
1291 } perf__constants[] = {
1292 PERF_CONST(TYPE_HARDWARE),
1293 PERF_CONST(TYPE_SOFTWARE),
1294 PERF_CONST(TYPE_TRACEPOINT),
1295 PERF_CONST(TYPE_HW_CACHE),
1296 PERF_CONST(TYPE_RAW),
1297 PERF_CONST(TYPE_BREAKPOINT),
1299 PERF_CONST(COUNT_HW_CPU_CYCLES),
1300 PERF_CONST(COUNT_HW_INSTRUCTIONS),
1301 PERF_CONST(COUNT_HW_CACHE_REFERENCES),
1302 PERF_CONST(COUNT_HW_CACHE_MISSES),
1303 PERF_CONST(COUNT_HW_BRANCH_INSTRUCTIONS),
1304 PERF_CONST(COUNT_HW_BRANCH_MISSES),
1305 PERF_CONST(COUNT_HW_BUS_CYCLES),
1306 PERF_CONST(COUNT_HW_CACHE_L1D),
1307 PERF_CONST(COUNT_HW_CACHE_L1I),
1308 PERF_CONST(COUNT_HW_CACHE_LL),
1309 PERF_CONST(COUNT_HW_CACHE_DTLB),
1310 PERF_CONST(COUNT_HW_CACHE_ITLB),
1311 PERF_CONST(COUNT_HW_CACHE_BPU),
1312 PERF_CONST(COUNT_HW_CACHE_OP_READ),
1313 PERF_CONST(COUNT_HW_CACHE_OP_WRITE),
1314 PERF_CONST(COUNT_HW_CACHE_OP_PREFETCH),
1315 PERF_CONST(COUNT_HW_CACHE_RESULT_ACCESS),
1316 PERF_CONST(COUNT_HW_CACHE_RESULT_MISS),
1318 PERF_CONST(COUNT_HW_STALLED_CYCLES_FRONTEND),
1319 PERF_CONST(COUNT_HW_STALLED_CYCLES_BACKEND),
1321 PERF_CONST(COUNT_SW_CPU_CLOCK),
1322 PERF_CONST(COUNT_SW_TASK_CLOCK),
1323 PERF_CONST(COUNT_SW_PAGE_FAULTS),
1324 PERF_CONST(COUNT_SW_CONTEXT_SWITCHES),
1325 PERF_CONST(COUNT_SW_CPU_MIGRATIONS),
1326 PERF_CONST(COUNT_SW_PAGE_FAULTS_MIN),
1327 PERF_CONST(COUNT_SW_PAGE_FAULTS_MAJ),
1328 PERF_CONST(COUNT_SW_ALIGNMENT_FAULTS),
1329 PERF_CONST(COUNT_SW_EMULATION_FAULTS),
1330 PERF_CONST(COUNT_SW_DUMMY),
1332 PERF_CONST(SAMPLE_IP),
1333 PERF_CONST(SAMPLE_TID),
1334 PERF_CONST(SAMPLE_TIME),
1335 PERF_CONST(SAMPLE_ADDR),
1336 PERF_CONST(SAMPLE_READ),
1337 PERF_CONST(SAMPLE_CALLCHAIN),
1338 PERF_CONST(SAMPLE_ID),
1339 PERF_CONST(SAMPLE_CPU),
1340 PERF_CONST(SAMPLE_PERIOD),
1341 PERF_CONST(SAMPLE_STREAM_ID),
1342 PERF_CONST(SAMPLE_RAW),
1344 PERF_CONST(FORMAT_TOTAL_TIME_ENABLED),
1345 PERF_CONST(FORMAT_TOTAL_TIME_RUNNING),
1346 PERF_CONST(FORMAT_ID),
1347 PERF_CONST(FORMAT_GROUP),
1349 PERF_CONST(RECORD_MMAP),
1350 PERF_CONST(RECORD_LOST),
1351 PERF_CONST(RECORD_COMM),
1352 PERF_CONST(RECORD_EXIT),
1353 PERF_CONST(RECORD_THROTTLE),
1354 PERF_CONST(RECORD_UNTHROTTLE),
1355 PERF_CONST(RECORD_FORK),
1356 PERF_CONST(RECORD_READ),
1357 PERF_CONST(RECORD_SAMPLE),
1358 PERF_CONST(RECORD_MMAP2),
1359 PERF_CONST(RECORD_AUX),
1360 PERF_CONST(RECORD_ITRACE_START),
1361 PERF_CONST(RECORD_LOST_SAMPLES),
1362 PERF_CONST(RECORD_SWITCH),
1363 PERF_CONST(RECORD_SWITCH_CPU_WIDE),
1365 PERF_CONST(RECORD_MISC_SWITCH_OUT),
1369 static PyObject *pyrf__tracepoint(struct pyrf_evsel *pevsel,
1370 PyObject *args, PyObject *kwargs)
1372 #ifndef HAVE_LIBTRACEEVENT
1375 struct tep_event *tp_format;
1376 static char *kwlist[] = { "sys", "name", NULL };
1380 if (!PyArg_ParseTupleAndKeywords(args, kwargs, "|ss", kwlist,
1384 tp_format = trace_event__tp_format(sys, name);
1385 if (IS_ERR(tp_format))
1386 return _PyLong_FromLong(-1);
1388 return _PyLong_FromLong(tp_format->id);
1389 #endif // HAVE_LIBTRACEEVENT
1392 static PyMethodDef perf__methods[] = {
1394 .ml_name = "tracepoint",
1395 .ml_meth = (PyCFunction) pyrf__tracepoint,
1396 .ml_flags = METH_VARARGS | METH_KEYWORDS,
1397 .ml_doc = PyDoc_STR("Get tracepoint config.")
1399 { .ml_name = NULL, }
1402 #if PY_MAJOR_VERSION < 3
1403 PyMODINIT_FUNC initperf(void)
1405 PyMODINIT_FUNC PyInit_perf(void)
1411 #if PY_MAJOR_VERSION < 3
1412 PyObject *module = Py_InitModule("perf", perf__methods);
1414 static struct PyModuleDef moduledef = {
1415 PyModuleDef_HEAD_INIT,
1416 "perf", /* m_name */
1419 perf__methods, /* m_methods */
1420 NULL, /* m_reload */
1421 NULL, /* m_traverse */
1425 PyObject *module = PyModule_Create(&moduledef);
1428 if (module == NULL ||
1429 pyrf_event__setup_types() < 0 ||
1430 pyrf_evlist__setup_types() < 0 ||
1431 pyrf_evsel__setup_types() < 0 ||
1432 pyrf_thread_map__setup_types() < 0 ||
1433 pyrf_cpu_map__setup_types() < 0)
1434 #if PY_MAJOR_VERSION < 3
1440 /* The page_size is placed in util object. */
1441 page_size = sysconf(_SC_PAGE_SIZE);
1443 Py_INCREF(&pyrf_evlist__type);
1444 PyModule_AddObject(module, "evlist", (PyObject*)&pyrf_evlist__type);
1446 Py_INCREF(&pyrf_evsel__type);
1447 PyModule_AddObject(module, "evsel", (PyObject*)&pyrf_evsel__type);
1449 Py_INCREF(&pyrf_mmap_event__type);
1450 PyModule_AddObject(module, "mmap_event", (PyObject *)&pyrf_mmap_event__type);
1452 Py_INCREF(&pyrf_lost_event__type);
1453 PyModule_AddObject(module, "lost_event", (PyObject *)&pyrf_lost_event__type);
1455 Py_INCREF(&pyrf_comm_event__type);
1456 PyModule_AddObject(module, "comm_event", (PyObject *)&pyrf_comm_event__type);
1458 Py_INCREF(&pyrf_task_event__type);
1459 PyModule_AddObject(module, "task_event", (PyObject *)&pyrf_task_event__type);
1461 Py_INCREF(&pyrf_throttle_event__type);
1462 PyModule_AddObject(module, "throttle_event", (PyObject *)&pyrf_throttle_event__type);
1464 Py_INCREF(&pyrf_task_event__type);
1465 PyModule_AddObject(module, "task_event", (PyObject *)&pyrf_task_event__type);
1467 Py_INCREF(&pyrf_read_event__type);
1468 PyModule_AddObject(module, "read_event", (PyObject *)&pyrf_read_event__type);
1470 Py_INCREF(&pyrf_sample_event__type);
1471 PyModule_AddObject(module, "sample_event", (PyObject *)&pyrf_sample_event__type);
1473 Py_INCREF(&pyrf_context_switch_event__type);
1474 PyModule_AddObject(module, "switch_event", (PyObject *)&pyrf_context_switch_event__type);
1476 Py_INCREF(&pyrf_thread_map__type);
1477 PyModule_AddObject(module, "thread_map", (PyObject*)&pyrf_thread_map__type);
1479 Py_INCREF(&pyrf_cpu_map__type);
1480 PyModule_AddObject(module, "cpu_map", (PyObject*)&pyrf_cpu_map__type);
1482 dict = PyModule_GetDict(module);
1486 for (i = 0; perf__constants[i].name != NULL; i++) {
1487 obj = _PyLong_FromLong(perf__constants[i].value);
1490 PyDict_SetItemString(dict, perf__constants[i].name, obj);
1495 if (PyErr_Occurred())
1496 PyErr_SetString(PyExc_ImportError, "perf: Init failed!");
1497 #if PY_MAJOR_VERSION >= 3
1503 * Dummy, to avoid dragging all the test_attr infrastructure in the python
1506 void test_attr__open(struct perf_event_attr *attr, pid_t pid, struct perf_cpu cpu,
1507 int fd, int group_fd, unsigned long flags)
1511 void evlist__free_stats(struct evlist *evlist)