From nobody Mon Oct 6 03:13:57 2025 Received: from mail-pf1-f201.google.com (mail-pf1-f201.google.com [209.85.210.201]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id 2181C2620D2 for ; Fri, 25 Jul 2025 18:52:46 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.210.201 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1753469567; cv=none; b=i9VMTkDgHoLV7skx8/hI3B9i8A0COPXfYZcNaFtGoV7qtcc3Ij8j7NFw6CTXS0BBOdeNhureDLLPub7D2lJjxc7iQ8CGgNzmA7CZyDTMdLHu9jM+BUZ+nmpXgOpafStws7dBlYvwEWO83Iw5Q49LObp3dsD9i95IpABe7qSqJoU= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1753469567; c=relaxed/simple; bh=nwIPXmddXA1zM4816Vbz6lPdTIjBK/CaMTkmHr5EAk4=; h=Date:In-Reply-To:Mime-Version:References:Message-ID:Subject:From: To:Cc:Content-Type; b=kyM+cwrFqyqxuYEarrBVADC+belEpMDsJ5YO1SOXW+XW+Q+8klWKQU40J5JsoJzKoIhwfLmNhwfJAo5FzhIEVY8v3ylmIqqCyhjceFqts7AhN+SidhfJTm2rGMbFvq0Mzg9LiWEovklLjf3xlZqDfoht1i7uaDJ/wC0HYqd6AFA= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dmarc=pass (p=reject dis=none) header.from=google.com; spf=pass smtp.mailfrom=flex--irogers.bounces.google.com; dkim=pass (2048-bit key) header.d=google.com header.i=@google.com header.b=EcYnRGsZ; arc=none smtp.client-ip=209.85.210.201 Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=reject dis=none) header.from=google.com Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=flex--irogers.bounces.google.com Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=google.com header.i=@google.com header.b="EcYnRGsZ" Received: by mail-pf1-f201.google.com with SMTP id d2e1a72fcca58-764072aca31so293748b3a.2 for ; Fri, 25 Jul 2025 11:52:46 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=20230601; t=1753469565; x=1754074365; darn=vger.kernel.org; h=cc:to:from:subject:message-id:references:mime-version:in-reply-to :date:from:to:cc:subject:date:message-id:reply-to; bh=zTJ3W0ByLpHZ9CXRNmMdi9xgwMpplNAcPbcEQMrdjtY=; b=EcYnRGsZsq2lKyJxQPjsvJip36Z044qPci8sDCSiCI89eg5blL3KvxfeFI9gQt0Bo1 dQ5RaxwsDh3ol7zkNxx5RhyQ8VHPpVAuvS8BBhkv7k2gTdauOFuDVqf2+uU7UzbJ7Tnb PtS6Jpd9mWqUcOMSE87dmjojgKaIGtGwUZZsilDHRvjnUqbhwA/O/DPIvRDWW9v5XPGC NzhCcjM57n3NMHVOB4vGK/3A5w6L0K1aLq9r+yU/DMe5ui8HrxrSYQ4AuS+AYbekFG5l oiOR2G39q2aMAkWu1IgvT+Wi2yakWhBSsc/l1WxKxRFE+E8YJE6xEI6eNhtznRpiKMhw L8Lg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1753469565; x=1754074365; h=cc:to:from:subject:message-id:references:mime-version:in-reply-to :date:x-gm-message-state:from:to:cc:subject:date:message-id:reply-to; bh=zTJ3W0ByLpHZ9CXRNmMdi9xgwMpplNAcPbcEQMrdjtY=; b=aSDz1AVUE835XaYthtXxyMSLbCNHVIFTIj96EU+sS5qFTzUhjKcq3Ofio3I4i3koeJ /SpFt3EF9hclBQocd3lS2ZcX+8tgFiKSR4+8Ltzp6YK+Jt5BNGogYzY77kIdrjhdzHHw EJ4WSve36Ir/y6EcBkVwe1uas9F1mzyOb712bWX4BhagWIfzHiBZw6vN/1lsr3rueWld hqd94e/KKoCI1eIpZuteW5xxKwYTgmNMLGpy33yf+EYUM5vM1BII3De9k9GTcZ0QoNkO LSRaXEInXJbwEeLokGylTN66B4GsgTLrmvhN+efATxj1xNvYAHFgMlzq8jsJVyL4LD56 heCw== X-Forwarded-Encrypted: i=1; AJvYcCVggXZzweXv0HKjGp3DPsYlCHriOlVZ36OhIK45hxMIIYqOtTmj6uokERRFRcT6zVCfQwEH/tO3hlO9fkc=@vger.kernel.org X-Gm-Message-State: AOJu0Ywm5oLtCgE63C2u2sloYghb/4HpZrcm8Y2vX8ff6Ub9ac6CkJio kA8mokwyQEdQ64CLeyGOeYY4gdJ7GGJ+VqNEskAvSWK9gHnv3yTeGyAePli8Z9izYXqUrN2e2Fu 5dzhuQ/pH5w== X-Google-Smtp-Source: AGHT+IFxSOul8ScKq/4q+dfu++ZwKGFNHTMTnkU9owlfUOg4oAViLuM+aVMlEXBYML2I8AovmEy1y4dJRHm9 X-Received: from pfbei31.prod.google.com ([2002:a05:6a00:80df:b0:746:22b3:4c0d]) (user=irogers job=prod-delivery.src-stubby-dispatcher) by 2002:a05:6a20:970c:b0:215:ead1:b867 with SMTP id adf61e73a8af0-23d700d3688mr4110328637.14.1753469565477; Fri, 25 Jul 2025 11:52:45 -0700 (PDT) Date: Fri, 25 Jul 2025 11:52:01 -0700 In-Reply-To: <20250725185202.68671-1-irogers@google.com> Precedence: bulk X-Mailing-List: linux-kernel@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: Mime-Version: 1.0 References: <20250725185202.68671-1-irogers@google.com> X-Mailer: git-send-email 2.50.1.552.g942d659e1b-goog Message-ID: <20250725185202.68671-16-irogers@google.com> Subject: [PATCH v9 15/16] perf python: Add metrics function From: Ian Rogers To: Peter Zijlstra , Ingo Molnar , Arnaldo Carvalho de Melo , Namhyung Kim , Mark Rutland , Alexander Shishkin , Jiri Olsa , Ian Rogers , Adrian Hunter , Kan Liang , James Clark , Xu Yang , "Masami Hiramatsu (Google)" , Collin Funk , Howard Chu , Weilin Wang , Andi Kleen , "Dr. David Alan Gilbert" , Thomas Richter , Tiezhu Yang , Gautam Menghani , Thomas Falcon , Chun-Tse Shao , linux-kernel@vger.kernel.org, linux-perf-users@vger.kernel.org Cc: Arnaldo Carvalho de Melo Content-Transfer-Encoding: quoted-printable Content-Type: text/plain; charset="utf-8" The metrics function returns a list dictionaries describing metrics as strings mapping to strings, except for metric groups that are a string mapping to a list of strings. For example: ``` >>> import perf >>> perf.metrics()[0] {'MetricGroup': ['Power'], 'MetricName': 'C10_Pkg_Residency', 'PMU': 'default_core', 'MetricExpr': 'cstate_pkg@c10\\-residency@ / TSC', 'ScaleUnit': '100%', 'BriefDescription': 'C10 residency percent per packag= e'} ``` Signed-off-by: Ian Rogers Tested-by: Arnaldo Carvalho de Melo --- tools/perf/util/python.c | 86 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 86 insertions(+) diff --git a/tools/perf/util/python.c b/tools/perf/util/python.c index bee7c8a69bad..aaed7745df22 100644 --- a/tools/perf/util/python.c +++ b/tools/perf/util/python.c @@ -2073,7 +2073,93 @@ static PyObject *pyrf__parse_metrics(PyObject *self,= PyObject *args) return result; } =20 +static PyObject *pyrf__metrics_groups(const struct pmu_metric *pm) +{ + PyObject *groups =3D PyList_New(/*len=3D*/0); + const char *mg =3D pm->metric_group; + + if (!groups) + return NULL; + + while (mg) { + PyObject *val =3D NULL; + const char *sep =3D strchr(mg, ';'); + size_t len =3D sep ? (size_t)(sep - mg) : strlen(mg); + + if (len > 0) { + val =3D PyUnicode_FromStringAndSize(mg, len); + if (val) + PyList_Append(groups, val); + + Py_XDECREF(val); + } + mg =3D sep ? sep + 1 : NULL; + } + return groups; +} + +static int pyrf__metrics_cb(const struct pmu_metric *pm, + const struct pmu_metrics_table *table __maybe_unused, + void *vdata) +{ + PyObject *py_list =3D vdata; + PyObject *dict =3D PyDict_New(); + PyObject *key =3D dict ? PyUnicode_FromString("MetricGroup") : NULL; + PyObject *value =3D key ? pyrf__metrics_groups(pm) : NULL; + + if (!value || PyDict_SetItem(dict, key, value) !=3D 0) { + Py_XDECREF(key); + Py_XDECREF(value); + Py_XDECREF(dict); + return -ENOMEM; + } + + if (!add_to_dict(dict, "MetricName", pm->metric_name) || + !add_to_dict(dict, "PMU", pm->pmu) || + !add_to_dict(dict, "MetricExpr", pm->metric_expr) || + !add_to_dict(dict, "MetricThreshold", pm->metric_threshold) || + !add_to_dict(dict, "ScaleUnit", pm->unit) || + !add_to_dict(dict, "Compat", pm->compat) || + !add_to_dict(dict, "BriefDescription", pm->desc) || + !add_to_dict(dict, "PublicDescription", pm->long_desc) || + PyList_Append(py_list, dict) !=3D 0) { + Py_DECREF(dict); + return -ENOMEM; + } + Py_DECREF(dict); + return 0; +} + +static PyObject *pyrf__metrics(PyObject *self, PyObject *args) +{ + const struct pmu_metrics_table *table =3D pmu_metrics_table__find(); + PyObject *list =3D PyList_New(/*len=3D*/0); + int ret; + + if (!list) + return NULL; + + ret =3D pmu_metrics_table__for_each_metric(table, pyrf__metrics_cb, list); + if (!ret) + ret =3D pmu_for_each_sys_metric(pyrf__metrics_cb, list); + + if (ret) { + Py_DECREF(list); + errno =3D -ret; + PyErr_SetFromErrno(PyExc_OSError); + return NULL; + } + return list; +} + static PyMethodDef perf__methods[] =3D { + { + .ml_name =3D "metrics", + .ml_meth =3D (PyCFunction) pyrf__metrics, + .ml_flags =3D METH_NOARGS, + .ml_doc =3D PyDoc_STR( + "Returns a list of metrics represented as string values in dictionaries= .") + }, { .ml_name =3D "tracepoint", .ml_meth =3D (PyCFunction) pyrf__tracepoint, --=20 2.50.1.552.g942d659e1b-goog