From nobody Tue Oct 7 11:54:49 2025 Received: from mail-pg1-f201.google.com (mail-pg1-f201.google.com [209.85.215.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 A41372FD89C for ; Thu, 10 Jul 2025 20:37:30 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.215.201 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1752179852; cv=none; b=d+vFH/uxpFql+QexODiCSjH8vDr9vSjgRc3uNPx1TfJeGMzoocbQbcRd0uUilYjGwNlMEhX7qd4I66wajFpMEBnDvt0j4j5zueZI9NdgueOVASdQgsdKz+10pVOLDswHf9+bXXoURRS9TntPM2kdw7qC+jaV3e2kcKTGqHFuRGc= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1752179852; c=relaxed/simple; bh=kDqb/r0HccawH5czjXeqp65wkcljd4SqQ1ZhN3nUBRU=; h=Date:In-Reply-To:Mime-Version:References:Message-ID:Subject:From: To:Content-Type; b=f6OxWfFaB5LjJJIgEULHByEIQdfcpjq5DT/McqRWp4tfdU5r2gjt9UTP9UyI1Y2ObuWk5WTrLyhV7uWonJYpOrwvkD+Jt33i3KK4NnGQ7B7BGtzLaVB7KWcV4bbWUMC+NwBddz9vORfDfwFS9ivCiECToPR59+osdprks+Vo59A= 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=4F049aKs; arc=none smtp.client-ip=209.85.215.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="4F049aKs" Received: by mail-pg1-f201.google.com with SMTP id 41be03b00d2f7-b00e4358a34so1004027a12.0 for ; Thu, 10 Jul 2025 13:37:30 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=20230601; t=1752179850; x=1752784650; darn=vger.kernel.org; h=to:from:subject:message-id:references:mime-version:in-reply-to:date :from:to:cc:subject:date:message-id:reply-to; bh=ORft+ikg92kHFRcEMbKO4fnQ+ouMdhF5CZrp1etPobk=; b=4F049aKsEMGmfAAiwqVL+mfRLNKiEhj6ehgcIlJMgSQc7+uvQrIxlNM23VRMEfaoRK hu7ibS8SoH2rjvfd//oLlJgm+1K1VXn0kfEoatnFyB5zSNz+iMmjhKI7D6XSzq+Syt7N WXfZ1L2+wmpVs3V7uzzmiAp05d/WK+BXBw+wwfezJw+OcEyznDVAj0KmkVVz7GMF7kTi /mtJO8dxk+Bp/4UM5LwXHtmijRUlMQmUzMGBL+aTmnEfOEdfXSQ/1mwaha6Fgdj131RU GiP3EM1Asr6M8QxPn9DbardzNGjaL2l1dvi1gs5qr6PIEaygnjpvXkCtu+bYIAh2P0gu nUoA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1752179850; x=1752784650; h=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=ORft+ikg92kHFRcEMbKO4fnQ+ouMdhF5CZrp1etPobk=; b=OQM7BMT5i23N69QBNg1tmZc7/2Oo66ZGGrsv273uIst3CCXPb5GRJAu7BTIXiUVJiQ dRHDof2vYiGj1YMUr/+C0v8K4+63Gpl0iQ4RbLv3IZ7jm0uoD0d932RCyNxNXIHVBU6T mhDLB0v7/MwUh9u+oHzzzpEY/juhz7dREoDXi36spoIvHycCh+cNX4yyLPOE+K9IHU5+ FgT/kXvY5pLyf+CE5XJ61YStCVTlNZ9pRIzUkbFcNPFV0d+kYFmtYeYBzKvSX3JbRiSz ArTUVXIazJ/Lkbx+BgPQJrD+3eratMuRheag/+FcebLSrpGbmQImXbhCDBIo1VlG9aX7 +clQ== X-Forwarded-Encrypted: i=1; AJvYcCWJMyaEUf8P3u3jHgEYVYdB9sEP6d7yLbJKuptKCxsABrm9zJ5ABXkYP/YPvZhWiVGoOAmwab9wCR6CoxM=@vger.kernel.org X-Gm-Message-State: AOJu0YxDWW7iByIaaFT79qkRF94VpWBwNdrBki83zeRLkxvktxKE7FVC lHaIZpmjACvjrH7EGLfz7M0whrFcifzbhIzojodlEbW+647XHZZoDWDg8KQ+MU6oJzjHScynu2Z oJA3aE4AGKQ== X-Google-Smtp-Source: AGHT+IF7CSSnIYMAeDnJXc34vUK1+ayrl+mTIe36PEYwSo090qFJfj9JokivN5DZncRiX8QFfjRbhMExHqIZ X-Received: from plhq13.prod.google.com ([2002:a17:903:11cd:b0:23d:dff4:2060]) (user=irogers job=prod-delivery.src-stubby-dispatcher) by 2002:a17:902:f70d:b0:235:be0:db4c with SMTP id d9443c01a7336-23dee28f150mr7139595ad.41.1752179850024; Thu, 10 Jul 2025 13:37:30 -0700 (PDT) Date: Thu, 10 Jul 2025 13:36:55 -0700 In-Reply-To: <20250710203656.1963075-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: <20250710203656.1963075-1-irogers@google.com> X-Mailer: git-send-email 2.50.0.727.gbf7dc18ff4-goog Message-ID: <20250710203656.1963075-14-irogers@google.com> Subject: [PATCH v5 13/14] 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 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 --- tools/perf/util/python.c | 83 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 83 insertions(+) diff --git a/tools/perf/util/python.c b/tools/perf/util/python.c index 41d290c43b7e..0ad14204c144 100644 --- a/tools/perf/util/python.c +++ b/tools/perf/util/python.c @@ -2037,7 +2037,90 @@ 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) { + 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.0.727.gbf7dc18ff4-goog