linux-perf-users.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Ian Rogers <irogers@google.com>
To: Peter Zijlstra <peterz@infradead.org>,
	Ingo Molnar <mingo@redhat.com>,
	 Arnaldo Carvalho de Melo <acme@kernel.org>,
	Namhyung Kim <namhyung@kernel.org>,
	 Mark Rutland <mark.rutland@arm.com>,
	 Alexander Shishkin <alexander.shishkin@linux.intel.com>,
	Jiri Olsa <jolsa@kernel.org>,  Ian Rogers <irogers@google.com>,
	Adrian Hunter <adrian.hunter@intel.com>,
	 Kan Liang <kan.liang@linux.intel.com>,
	James Clark <james.clark@linaro.org>,
	 Xu Yang <xu.yang_2@nxp.com>,
	"Masami Hiramatsu (Google)" <mhiramat@kernel.org>,
	 Collin Funk <collin.funk1@gmail.com>,
	Howard Chu <howardchu95@gmail.com>,
	 Weilin Wang <weilin.wang@intel.com>,
	Andi Kleen <ak@linux.intel.com>,
	 "Dr. David Alan Gilbert" <linux@treblig.org>,
	Thomas Richter <tmricht@linux.ibm.com>,
	 Tiezhu Yang <yangtiezhu@loongson.cn>,
	Gautam Menghani <gautam@linux.ibm.com>,
	 Thomas Falcon <thomas.falcon@intel.com>,
	Chun-Tse Shao <ctshao@google.com>,
	 linux-kernel@vger.kernel.org, linux-perf-users@vger.kernel.org
Subject: [PATCH v7 10/16] perf python: Add function returning dictionary of all events on a PMU
Date: Mon, 14 Jul 2025 09:43:58 -0700	[thread overview]
Message-ID: <20250714164405.111477-11-irogers@google.com> (raw)
In-Reply-To: <20250714164405.111477-1-irogers@google.com>

Allow all events on a PMU to be gathered, similar to how perf list
gathers event information.

An example usage:
```
$ python
Python 3.12.9 (main, Feb  5 2025, 01:31:18) [GCC 14.2.0] on linux
>>> import perf
>>> for pmu in perf.pmus():
...   print(pmu.events())
...
[{'name': 'mem_load_retired.l3_hit', 'desc': 'Retired load instructions...
```

Signed-off-by: Ian Rogers <irogers@google.com>
---
 tools/perf/util/python.c | 71 ++++++++++++++++++++++++++++++++++++++++
 1 file changed, 71 insertions(+)

diff --git a/tools/perf/util/python.c b/tools/perf/util/python.c
index 860df6436f87..845476411576 100644
--- a/tools/perf/util/python.c
+++ b/tools/perf/util/python.c
@@ -660,6 +660,71 @@ static PyObject *pyrf_pmu__name(PyObject *self)
 	return PyUnicode_FromString(ppmu->pmu->name);
 }
 
+static bool add_to_dict(PyObject *dict, const char *key, const char *value)
+{
+	PyObject *pkey, *pvalue;
+	bool ret;
+
+	if (value == NULL)
+		return true;
+
+	pkey = PyUnicode_FromString(key);
+	pvalue = PyUnicode_FromString(value);
+
+	ret = pkey && pvalue && PyDict_SetItem(dict, pkey, pvalue) == 0;
+	Py_XDECREF(pkey);
+	Py_XDECREF(pvalue);
+	return ret;
+}
+
+static int pyrf_pmu__events_cb(void *state, struct pmu_event_info *info)
+{
+	PyObject *py_list = state;
+	PyObject *dict = PyDict_New();
+
+	if (!dict)
+		return -ENOMEM;
+
+	if (!add_to_dict(dict, "name", info->name) ||
+	    !add_to_dict(dict, "alias", info->alias) ||
+	    !add_to_dict(dict, "scale_unit", info->scale_unit) ||
+	    !add_to_dict(dict, "desc", info->desc) ||
+	    !add_to_dict(dict, "long_desc", info->long_desc) ||
+	    !add_to_dict(dict, "encoding_desc", info->encoding_desc) ||
+	    !add_to_dict(dict, "topic", info->topic) ||
+	    !add_to_dict(dict, "event_type_desc", info->event_type_desc) ||
+	    !add_to_dict(dict, "str", info->str) ||
+	    !add_to_dict(dict, "deprecated", info->deprecated ? "deprecated" : NULL) ||
+	    PyList_Append(py_list, dict) != 0) {
+		Py_DECREF(dict);
+		return -ENOMEM;
+	}
+	Py_DECREF(dict);
+	return 0;
+}
+
+static PyObject *pyrf_pmu__events(PyObject *self)
+{
+	struct pyrf_pmu *ppmu = (void *)self;
+	PyObject *py_list = PyList_New(0);
+	int ret;
+
+	if (!py_list)
+		return NULL;
+
+	ret = perf_pmu__for_each_event(ppmu->pmu,
+				       /*skip_duplicate_pmus=*/false,
+				       py_list,
+				       pyrf_pmu__events_cb);
+	if (ret) {
+		Py_DECREF(py_list);
+		errno = -ret;
+		PyErr_SetFromErrno(PyExc_OSError);
+		return NULL;
+	}
+	return py_list;
+}
+
 static PyObject *pyrf_pmu__repr(PyObject *self)
 {
 	struct pyrf_pmu *ppmu = (void *)self;
@@ -670,6 +735,12 @@ static PyObject *pyrf_pmu__repr(PyObject *self)
 static const char pyrf_pmu__doc[] = PyDoc_STR("perf Performance Monitoring Unit (PMU) object.");
 
 static PyMethodDef pyrf_pmu__methods[] = {
+	{
+		.ml_name  = "events",
+		.ml_meth  = (PyCFunction)pyrf_pmu__events,
+		.ml_flags = METH_NOARGS,
+		.ml_doc	  = PyDoc_STR("Name of the PMU including suffixes.")
+	},
 	{
 		.ml_name  = "name",
 		.ml_meth  = (PyCFunction)pyrf_pmu__name,
-- 
2.50.0.727.gbf7dc18ff4-goog


  parent reply	other threads:[~2025-07-14 16:44 UTC|newest]

Thread overview: 41+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-07-14 16:43 [PATCH v7 00/16] New perf ilist app Ian Rogers
2025-07-14 16:43 ` [PATCH v7 01/16] perf python: Add more exceptions on error paths Ian Rogers
2025-07-23 16:48   ` Arnaldo Carvalho de Melo
2025-07-23 18:12   ` Namhyung Kim
2025-07-23 18:21     ` Ian Rogers
2025-07-23 22:24       ` Ian Rogers
2025-07-14 16:43 ` [PATCH v7 02/16] perf jevents: Add common software event json Ian Rogers
2025-07-23 16:52   ` Arnaldo Carvalho de Melo
2025-07-23 18:24   ` Namhyung Kim
2025-07-23 22:34     ` Ian Rogers
2025-07-24  0:10       ` Namhyung Kim
2025-07-24  1:47         ` Ian Rogers
2025-07-24 16:58           ` Namhyung Kim
2025-07-14 16:43 ` [PATCH v7 03/16] perf parse-events: Remove non-json software events Ian Rogers
2025-07-24  0:20   ` Namhyung Kim
2025-07-14 16:43 ` [PATCH v7 04/16] perf tp_pmu: Factor existing tracepoint logic to new file Ian Rogers
2025-07-23 16:57   ` Arnaldo Carvalho de Melo
2025-07-14 16:43 ` [PATCH v7 05/16] perf tp_pmu: Add event APIs Ian Rogers
2025-07-23 18:57   ` Arnaldo Carvalho de Melo
2025-07-14 16:43 ` [PATCH v7 06/16] perf list: Remove tracepoint printing code Ian Rogers
2025-07-14 16:43 ` [PATCH v7 07/16] perf list: Skip ABI PMUs when printing pmu values Ian Rogers
2025-07-14 16:43 ` [PATCH v7 08/16] perf python: Improve the tracepoint function if no libtraceevent Ian Rogers
2025-07-14 16:43 ` [PATCH v7 09/16] perf python: Add basic PMU abstraction and pmus sequence Ian Rogers
2025-07-14 16:43 ` Ian Rogers [this message]
2025-07-14 16:43 ` [PATCH v7 11/16] perf ilist: Add new python ilist command Ian Rogers
2025-07-21  7:32   ` Gautam Menghani
2025-07-21 13:41     ` Ian Rogers
2025-07-23 18:33   ` Falcon, Thomas
2025-07-23 21:33     ` Ian Rogers
2025-07-14 16:44 ` [PATCH v7 12/16] perf python: Add parse_metrics function Ian Rogers
2025-07-14 16:44 ` [PATCH v7 13/16] perf python: Add evlist metrics function Ian Rogers
2025-07-14 16:44 ` [PATCH v7 14/16] perf python: Add evlist compute_metric Ian Rogers
2025-07-14 16:44 ` [PATCH v7 15/16] perf python: Add metrics function Ian Rogers
2025-07-14 16:44 ` [PATCH v7 16/16] perf ilist: Add support for metrics Ian Rogers
2025-07-23 15:32 ` [PATCH v7 00/16] New perf ilist app Ian Rogers
2025-07-23 18:00   ` Namhyung Kim
2025-07-23 18:15     ` Ian Rogers
2025-07-23 19:08     ` Arnaldo Carvalho de Melo
2025-07-23 19:11       ` Arnaldo Carvalho de Melo
2025-07-23 19:24         ` Arnaldo Carvalho de Melo
2025-07-23 21:30           ` Ian Rogers

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20250714164405.111477-11-irogers@google.com \
    --to=irogers@google.com \
    --cc=acme@kernel.org \
    --cc=adrian.hunter@intel.com \
    --cc=ak@linux.intel.com \
    --cc=alexander.shishkin@linux.intel.com \
    --cc=collin.funk1@gmail.com \
    --cc=ctshao@google.com \
    --cc=gautam@linux.ibm.com \
    --cc=howardchu95@gmail.com \
    --cc=james.clark@linaro.org \
    --cc=jolsa@kernel.org \
    --cc=kan.liang@linux.intel.com \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-perf-users@vger.kernel.org \
    --cc=linux@treblig.org \
    --cc=mark.rutland@arm.com \
    --cc=mhiramat@kernel.org \
    --cc=mingo@redhat.com \
    --cc=namhyung@kernel.org \
    --cc=peterz@infradead.org \
    --cc=thomas.falcon@intel.com \
    --cc=tmricht@linux.ibm.com \
    --cc=weilin.wang@intel.com \
    --cc=xu.yang_2@nxp.com \
    --cc=yangtiezhu@loongson.cn \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).