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>, Jiri Olsa <jolsa@kernel.org>,
Ian Rogers <irogers@google.com>,
Adrian Hunter <adrian.hunter@intel.com>,
James Clark <james.clark@linaro.org>
Cc: linux-perf-users@vger.kernel.org, linux-kernel@vger.kernel.org
Subject: [PATCH v3 20/30] perf parse-events: Decode metric-id terms when adding events
Date: Fri, 20 Nov 2026 14:13:21 -0800 [thread overview]
Message-ID: <20261120221332.2245191-21-irogers@google.com> (raw)
In-Reply-To: <20261120221332.2245191-1-irogers@google.com>
Metric events are parsed from an event string where the identifier from
the metric expression is passed as a metric-id term. As characters such
as '@' and ',' can't appear in a term value the metricgroup code encodes
them and, after parsing, walked the parsed evlist replacing each evsel's
metric_id with its decoded version.
Move the encoding and decoding to parse-events.c, adding
parse_events__encode_metric_id() for the metricgroup code, and store the
decoded metric-id on the evsel when it is created in __add_event(). This
avoids rewriting the metric_id of evsels after parsing, leaving
metricgroup with only the replacement of the evsel names of metric
events by friendlier versions of the metric-id. While moving the
decoding, fix the out of bounds check on the encoded character index
and return -EINVAL for a bad encoding.
Signed-off-by: Ian Rogers <irogers@google.com>
---
tools/perf/util/metricgroup.c | 110 ++++++++-------------------------
tools/perf/util/parse-events.c | 82 +++++++++++++++++++++++-
tools/perf/util/parse-events.h | 1 +
3 files changed, 108 insertions(+), 85 deletions(-)
diff --git a/tools/perf/util/metricgroup.c b/tools/perf/util/metricgroup.c
index 9922445a6d15..08679392bf6d 100644
--- a/tools/perf/util/metricgroup.c
+++ b/tools/perf/util/metricgroup.c
@@ -610,57 +610,13 @@ int metricgroup__add_matching_metrics(struct evlist *evlist, bool system_wide)
find_matching_metrics_cb, &args);
}
-static const char *code_characters = ",-=@";
-
-static int encode_metric_id(struct strbuf *sb, const char *x)
-{
- int ret = 0;
-
- for (; *x; x++) {
- const char *c = strchr(code_characters, *x);
- if (c) {
- ret = strbuf_addch(sb, '!');
- if (ret)
- break;
-
- ret = strbuf_addch(sb, '0' + (c - code_characters));
- if (ret)
- break;
- } else {
- ret = strbuf_addch(sb, *x);
- if (ret)
- break;
- }
- }
- return ret;
-}
-
-static int decode_metric_id(struct strbuf *sb, const char *x)
-{
- const char *orig = x;
- size_t i;
- char c;
- int ret;
-
- for (; *x; x++) {
- c = *x;
- if (*x == '!') {
- x++;
- i = *x - '0';
- if (i > strlen(code_characters)) {
- pr_err("Bad metric-id encoding in: '%s'", orig);
- return -1;
- }
- c = code_characters[i];
- }
- ret = strbuf_addch(sb, c);
- if (ret)
- return ret;
- }
- return 0;
-}
-
-static int decode_all_metric_ids(struct evlist *perf_evlist, const char *modifier)
+/*
+ * The metric events are parsed with a metric-id holding the identifier used in
+ * the metric expression. If the evsel name is just the parsed event, which
+ * contains the encoded metric-id, use the metric-id to give a more friendly
+ * display version.
+ */
+static int set_metric_event_names(struct evlist *perf_evlist, const char *modifier)
{
struct evsel *ev;
struct strbuf sb = STRBUF_INIT;
@@ -668,51 +624,39 @@ static int decode_all_metric_ids(struct evlist *perf_evlist, const char *modifie
int ret = 0;
evlist__for_each_entry(perf_evlist, ev) {
- if (!ev->metric_id)
+ bool has_slash = false;
+
+ if (!ev->metric_id || !strstr(ev->name, "metric-id="))
continue;
ret = strbuf_setlen(&sb, 0);
if (ret)
break;
- ret = decode_metric_id(&sb, ev->metric_id);
+ ret = strbuf_addstr(&sb, ev->metric_id);
if (ret)
break;
- free((char *)ev->metric_id);
- ev->metric_id = strdup(sb.buf);
- if (!ev->metric_id) {
- ret = -ENOMEM;
- break;
+ zfree(&ev->name);
+ for (cur = strchr(sb.buf, '@') ; cur; cur = strchr(++cur, '@')) {
+ *cur = '/';
+ has_slash = true;
}
- /*
- * If the name is just the parsed event, use the metric-id to
- * give a more friendly display version.
- */
- if (strstr(ev->name, "metric-id=")) {
- bool has_slash = false;
-
- zfree(&ev->name);
- for (cur = strchr(sb.buf, '@') ; cur; cur = strchr(++cur, '@')) {
- *cur = '/';
- has_slash = true;
- }
- if (modifier) {
- if (!has_slash && !strchr(sb.buf, ':')) {
- ret = strbuf_addch(&sb, ':');
- if (ret)
- break;
- }
- ret = strbuf_addstr(&sb, modifier);
+ if (modifier) {
+ if (!has_slash && !strchr(sb.buf, ':')) {
+ ret = strbuf_addch(&sb, ':');
if (ret)
break;
}
- ev->name = strdup(sb.buf);
- if (!ev->name) {
- ret = -ENOMEM;
+ ret = strbuf_addstr(&sb, modifier);
+ if (ret)
break;
- }
+ }
+ ev->name = strdup(sb.buf);
+ if (!ev->name) {
+ ret = -ENOMEM;
+ break;
}
}
strbuf_release(&sb);
@@ -787,7 +731,7 @@ static int metricgroup__build_event_string(struct strbuf *events,
ret = strbuf_addstr(events, "/metric-id=");
RETURN_IF_NON_ZERO(ret);
}
- ret = encode_metric_id(events, id);
+ ret = parse_events__encode_metric_id(events, id);
RETURN_IF_NON_ZERO(ret);
ret = strbuf_addstr(events, "/");
RETURN_IF_NON_ZERO(ret);
@@ -1514,7 +1458,7 @@ static int parse_ids(bool metric_no_merge, bool fake_pmu,
parse_events_error__print(&parse_error, events.buf);
goto err_out;
}
- ret = decode_all_metric_ids(parsed_evlist, modifier);
+ ret = set_metric_event_names(parsed_evlist, modifier);
if (ret)
goto err_out;
diff --git a/tools/perf/util/parse-events.c b/tools/perf/util/parse-events.c
index 0044b6c27ea6..b54ab0604e4e 100644
--- a/tools/perf/util/parse-events.c
+++ b/tools/perf/util/parse-events.c
@@ -171,6 +171,73 @@ static void fix_raw(struct parse_events_terms *config_terms, struct perf_pmu *pm
}
}
+/*
+ * Characters that can't appear in a metric-id term value are encoded as '!'
+ * followed by the character's index in this string.
+ */
+static const char *metric_id_code_characters = ",-=@";
+
+/**
+ * parse_events__encode_metric_id - Encode a metric identifier as a metric-id
+ * term value.
+ * @sb: The buffer the encoded identifier is appended to.
+ * @x: The metric identifier to encode.
+ *
+ * Return: 0 on success or the strbuf error.
+ */
+int parse_events__encode_metric_id(struct strbuf *sb, const char *x)
+{
+ int ret = 0;
+
+ for (; *x; x++) {
+ const char *c = strchr(metric_id_code_characters, *x);
+
+ if (c) {
+ ret = strbuf_addch(sb, '!');
+ if (ret)
+ break;
+
+ ret = strbuf_addch(sb, '0' + (c - metric_id_code_characters));
+ if (ret)
+ break;
+ } else {
+ ret = strbuf_addch(sb, *x);
+ if (ret)
+ break;
+ }
+ }
+ return ret;
+}
+
+/*
+ * Decode a metric-id term value encoded by parse_events__encode_metric_id()
+ * into @sb.
+ */
+static int parse_events__decode_metric_id(struct strbuf *sb, const char *x)
+{
+ const char *orig = x;
+ size_t i;
+ char c;
+ int ret;
+
+ for (; *x; x++) {
+ c = *x;
+ if (*x == '!') {
+ x++;
+ i = *x - '0';
+ if (i >= strlen(metric_id_code_characters)) {
+ pr_err("Bad metric-id encoding in: '%s'", orig);
+ return -EINVAL;
+ }
+ c = metric_id_code_characters[i];
+ }
+ ret = strbuf_addch(sb, c);
+ if (ret)
+ return ret;
+ }
+ return 0;
+}
+
static struct evsel *
__add_event(struct list_head *list, int *idx,
struct perf_event_attr *attr,
@@ -261,7 +328,12 @@ __add_event(struct list_head *list, int *idx,
}
if (metric_id) {
- evsel->metric_id = strdup(metric_id);
+ struct strbuf sb = STRBUF_INIT;
+ int ret = parse_events__decode_metric_id(&sb, metric_id);
+
+ if (!ret)
+ evsel->metric_id = strdup(sb.buf);
+ strbuf_release(&sb);
if (!evsel->metric_id)
goto out_err;
}
@@ -668,6 +740,7 @@ int parse_events_add_breakpoint(struct parse_events_state *parse_state,
struct perf_event_attr attr;
LIST_HEAD(config_terms);
const char *name;
+ int ret;
memset(&attr, 0, sizeof(attr));
attr.bp_addr = addr;
@@ -698,8 +771,11 @@ int parse_events_add_breakpoint(struct parse_events_state *parse_state,
name = get_config_name(head_config);
- return add_event(list, parse_state, &attr, name, /*mertic_id=*/NULL,
+ ret = add_event(list, parse_state, &attr, name, /*mertic_id=*/NULL,
&config_terms, /*alternate_hw_config=*/PERF_COUNT_HW_MAX);
+ /* Free the config terms if they weren't moved to an evsel. */
+ free_config_terms(&config_terms);
+ return ret;
}
static int check_type_val(struct parse_events_term *term,
@@ -1624,6 +1700,8 @@ static int parse_events_add_pmu(struct parse_events_state *parse_state,
&config_terms, first_wildcard_match, term_cpu, alternate_hw_config);
perf_cpu_map__put(term_cpu);
if (!evsel) {
+ /* The config terms weren't moved to an evsel. */
+ free_config_terms(&config_terms);
parse_events_terms__exit(&parsed_terms);
return -ENOMEM;
}
diff --git a/tools/perf/util/parse-events.h b/tools/perf/util/parse-events.h
index 8df8e3cb69fe..68efbd24df9b 100644
--- a/tools/perf/util/parse-events.h
+++ b/tools/perf/util/parse-events.h
@@ -245,6 +245,7 @@ int parse_events_add_breakpoint(struct parse_events_state *parse_state,
struct evsel *parse_events__add_event(int idx, struct perf_event_attr *attr,
const char *name, const char *metric_id,
struct perf_pmu *pmu);
+int parse_events__encode_metric_id(struct strbuf *sb, const char *x);
int parse_events_multi_pmu_add(struct parse_events_state *parse_state,
const char *event_name,
--
2.56.1.750.gf70dc682cf-goog
next prev parent reply other threads:[~2026-11-20 22:15 UTC|newest]
Thread overview: 33+ messages / expand[flat|nested] mbox.gz Atom feed top
2026-11-20 22:13 [PATCH v3 00/30] perf: Per-env PMUs, metric event sharing, and recorded event metrics Ian Rogers
2026-11-20 22:13 ` [PATCH v3 01/30] perf pmus: Don't skip core PMUs as duplicates Ian Rogers
2026-11-20 22:13 ` [PATCH v3 02/30] perf script: Fix metrics computed from samples Ian Rogers
2026-11-20 22:13 ` [PATCH v3 03/30] perf script: Don't drop metric samples for CPUs missing from the evsel Ian Rogers
2026-11-20 22:13 ` [PATCH v3 04/30] perf metricgroup: Don't prefer tool events for displaying a metric Ian Rogers
2026-11-20 22:13 ` [PATCH v3 05/30] perf env: Make lazy perf_env initialization thread-safe Ian Rogers
2026-11-20 22:13 ` [PATCH v3 06/30] perf env: Add host_env() singleton Ian Rogers
2026-11-20 22:13 ` [PATCH v3 07/30] perf pmu: Add from_env parameter to perf_pmu__init() Ian Rogers
2026-11-20 22:13 ` [PATCH v3 08/30] perf pmus: Introduce struct perf_pmus and perf_env__pmus() Ian Rogers
2026-11-20 22:13 ` [PATCH v3 09/30] perf pmus: Pass struct perf_pmus to find helpers Ian Rogers
2026-11-20 22:13 ` [PATCH v3 10/30] perf pmus: Pass struct perf_pmus to scan helpers Ian Rogers
2026-11-20 22:13 ` [PATCH v3 11/30] perf pmu-events: Add e_machine to struct pmu_events_map Ian Rogers
2026-11-20 22:13 ` [PATCH v3 12/30] perf pmu-events: Pass e_machine to find_core_*_table() Ian Rogers
2026-11-20 22:13 ` [PATCH v3 13/30] perf header: Pass e_machine to strcmp_cpuid_str() Ian Rogers
2026-11-20 22:13 ` [PATCH v3 14/30] perf header: Support CPUID matching across all architectures Ian Rogers
2026-11-20 22:13 ` [PATCH v3 15/30] perf test: Make the CPUID matching test architecture independent Ian Rogers
2026-11-20 22:13 ` [PATCH v3 16/30] perf test: Add CPUID matching tests for other architectures Ian Rogers
2026-11-20 22:13 ` [PATCH v3 17/30] perf dwarf-regs: Add e_machine__same_arch() Ian Rogers
2026-11-20 22:13 ` [PATCH v3 18/30] perf metricgroup: Pass struct perf_pmus to metricgroup__for_each_metric() Ian Rogers
2026-11-20 22:13 ` [PATCH v3 19/30] perf metricgroup: Move matching of metrics to recorded events from perf script Ian Rogers
2026-11-20 22:13 ` Ian Rogers [this message]
2026-11-20 22:13 ` [PATCH v3 21/30] perf evsel: Generalize metric_id to a set of metric_ids Ian Rogers
2026-11-20 22:13 ` [PATCH v3 22/30] perf pmu: Add perf_pmu__for_each_name_from_config() Ian Rogers
2026-11-20 22:13 ` [PATCH v3 23/30] perf metricgroup: Share metric events by their counter encoding Ian Rogers
2026-11-20 22:13 ` [PATCH v3 24/30] perf stat: Share events between metrics and command line events Ian Rogers
2026-11-20 22:13 ` [PATCH v3 25/30] perf pmus: Add perf_pmus__read_from_env() Ian Rogers
2026-11-20 22:42 ` sashiko-bot
2026-11-20 22:13 ` [PATCH v3 26/30] perf metricgroup: Improve matching of metrics to recorded events Ian Rogers
2026-11-20 22:13 ` [PATCH v3 27/30] perf metricgroup: Add metricgroup__add_recorded_metrics() Ian Rogers
2026-11-20 22:13 ` [PATCH v3 28/30] perf stat report: Display metrics for recorded events Ian Rogers
2026-11-20 22:13 ` [PATCH v3 29/30] perf script: Display metrics for perf stat record data Ian Rogers
2026-11-20 22:13 ` [PATCH v3 30/30] perf test: Add stat record metrics test Ian Rogers
2026-11-20 22:42 ` [PATCH v3 00/30] perf: Per-env PMUs, metric event sharing, and recorded event metrics sashiko-bot
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=20261120221332.2245191-21-irogers@google.com \
--to=irogers@google.com \
--cc=acme@kernel.org \
--cc=adrian.hunter@intel.com \
--cc=james.clark@linaro.org \
--cc=jolsa@kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-perf-users@vger.kernel.org \
--cc=mingo@redhat.com \
--cc=namhyung@kernel.org \
--cc=peterz@infradead.org \
/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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.