Commit d9dc8874 authored Jan 26, 2023 by Ian Rogers Committed by Arnaldo Carvalho de Melo Feb 03, 2023

perf pmu-events: Remove now unused event and metric variables

Previous changes separated the uses of pmu_event and pmu_metric,
however, both structures contained all the variables of event and
metric. This change removes the event variables from metric and the
metric variables from event.

Note, this change removes the setting of evsel's metric_name/expr as
these fields are no longer part of struct pmu_event. The metric
remains but is no longer implicitly requested when the event is. This
impacts a few Intel uncore events, however, as the ScaleUnit is shared
by the event and the metric this utility is questionable. Also the
MetricNames look broken (contain spaces) in some cases and when trying
to use the functionality with '-e' the metrics fail but regular
metrics with '-M' work. For example, on SkylakeX '-M' works:

```
$ perf stat -M LLC_MISSES.PCIE_WRITE -a sleep 1

 Performance counter stats for 'system wide':

                 0      UNC_IIO_DATA_REQ_OF_CPU.MEM_WRITE.PART2 #  57896.0 Bytes  LLC_MISSES.PCIE_WRITE  (49.84%)
             7,174      UNC_IIO_DATA_REQ_OF_CPU.MEM_WRITE.PART1                                        (49.85%)
                 0      UNC_IIO_DATA_REQ_OF_CPU.MEM_WRITE.PART3                                        (50.16%)
                63      UNC_IIO_DATA_REQ_OF_CPU.MEM_WRITE.PART0                                        (50.15%)

       1.004576381 seconds time elapsed
```

whilst the event '-e' version is broken even with --group/-g (fwiw, we should also remove -g [1]):

```
$ perf stat -g -e LLC_MISSES.PCIE_WRITE -g -a sleep 1
Add UNC_IIO_DATA_REQ_OF_CPU.MEM_WRITE.PART2 event to groups to get metric expression for LLC_MISSES.PCIE_WRITE
Add UNC_IIO_DATA_REQ_OF_CPU.MEM_WRITE.PART1 event to groups to get metric expression for LLC_MISSES.PCIE_WRITE
Add UNC_IIO_DATA_REQ_OF_CPU.MEM_WRITE.PART3 event to groups to get metric expression for LLC_MISSES.PCIE_WRITE
Add UNC_IIO_DATA_REQ_OF_CPU.MEM_WRITE.PART0 event to groups to get metric expression for LLC_MISSES.PCIE_WRITE
Add UNC_IIO_DATA_REQ_OF_CPU.MEM_WRITE.PART2 event to groups to get metric expression for LLC_MISSES.PCIE_WRITE
Add UNC_IIO_DATA_REQ_OF_CPU.MEM_WRITE.PART1 event to groups to get metric expression for LLC_MISSES.PCIE_WRITE
Add UNC_IIO_DATA_REQ_OF_CPU.MEM_WRITE.PART3 event to groups to get metric expression for LLC_MISSES.PCIE_WRITE
Add UNC_IIO_DATA_REQ_OF_CPU.MEM_WRITE.PART0 event to groups to get metric expression for LLC_MISSES.PCIE_WRITE
Add UNC_IIO_DATA_REQ_OF_CPU.MEM_WRITE.PART2 event to groups to get metric expression for LLC_MISSES.PCIE_WRITE
Add UNC_IIO_DATA_REQ_OF_CPU.MEM_WRITE.PART1 event to groups to get metric expression for LLC_MISSES.PCIE_WRITE
Add UNC_IIO_DATA_REQ_OF_CPU.MEM_WRITE.PART3 event to groups to get metric expression for LLC_MISSES.PCIE_WRITE
Add UNC_IIO_DATA_REQ_OF_CPU.MEM_WRITE.PART0 event to groups to get metric expression for LLC_MISSES.PCIE_WRITE
Add UNC_IIO_DATA_REQ_OF_CPU.MEM_WRITE.PART2 event to groups to get metric expression for LLC_MISSES.PCIE_WRITE
Add UNC_IIO_DATA_REQ_OF_CPU.MEM_WRITE.PART1 event to groups to get metric expression for LLC_MISSES.PCIE_WRITE
Add UNC_IIO_DATA_REQ_OF_CPU.MEM_WRITE.PART3 event to groups to get metric expression for LLC_MISSES.PCIE_WRITE
Add UNC_IIO_DATA_REQ_OF_CPU.MEM_WRITE.PART0 event to groups to get metric expression for LLC_MISSES.PCIE_WRITE
Add UNC_IIO_DATA_REQ_OF_CPU.MEM_WRITE.PART2 event to groups to get metric expression for LLC_MISSES.PCIE_WRITE
Add UNC_IIO_DATA_REQ_OF_CPU.MEM_WRITE.PART1 event to groups to get metric expression for LLC_MISSES.PCIE_WRITE
Add UNC_IIO_DATA_REQ_OF_CPU.MEM_WRITE.PART3 event to groups to get metric expression for LLC_MISSES.PCIE_WRITE
Add UNC_IIO_DATA_REQ_OF_CPU.MEM_WRITE.PART0 event to groups to get metric expression for LLC_MISSES.PCIE_WRITE
Add UNC_IIO_DATA_REQ_OF_CPU.MEM_WRITE.PART2 event to groups to get metric expression for LLC_MISSES.PCIE_WRITE
Add UNC_IIO_DATA_REQ_OF_CPU.MEM_WRITE.PART1 event to groups to get metric expression for LLC_MISSES.PCIE_WRITE
Add UNC_IIO_DATA_REQ_OF_CPU.MEM_WRITE.PART3 event to groups to get metric expression for LLC_MISSES.PCIE_WRITE
Add UNC_IIO_DATA_REQ_OF_CPU.MEM_WRITE.PART0 event to groups to get metric expression for LLC_MISSES.PCIE_WRITE

 Performance counter stats for 'system wide':

            27,316 Bytes LLC_MISSES.PCIE_WRITE

       1.004505469 seconds time elapsed
```

The code also carries warnings where the user is supposed to select
events for metrics [2] but given the lack of use of such a feature,
let's clean the code and just remove.

[1] https://lore.kernel.org/lkml/20220707195610.303254-1-irogers@google.com/
[2] https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/tree/tools/perf/util/stat-shadow.c?id=01b8957b738f42f96a130079bc951b3cc78c5b8a#n425



Reviewed-by: John Garry <john.g.garry@oracle.com>
Reviewed-by: Kajol Jain <kjain@linux.ibm.com>
Signed-off-by: Ian Rogers <irogers@google.com>
Cc: Adrian Hunter <adrian.hunter@intel.com>
Cc: Alexander Shishkin <alexander.shishkin@linux.intel.com>
Cc: Caleb Biggers <caleb.biggers@intel.com>
Cc: Florian Fischer <florian.fischer@muhq.space>
Cc: Ian Rogers <irogers@google.com>
Cc: Ingo Molnar <mingo@redhat.com>
Cc: James Clark <james.clark@arm.com>
Cc: Jing Zhang <renyu.zj@linux.alibaba.com>
Cc: Jiri Olsa <jolsa@kernel.org>
Cc: Kan Liang <kan.liang@linux.intel.com>
Cc: Kang Minchul <tegongkang@gmail.com>
Cc: Kim Phillips <kim.phillips@amd.com>
Cc: Leo Yan <leo.yan@linaro.org>
Cc: Mark Rutland <mark.rutland@arm.com>
Cc: Mike Leach <mike.leach@linaro.org>
Cc: Namhyung Kim <namhyung@kernel.org>
Cc: Perry Taylor <perry.taylor@intel.com>
Cc: Peter Zijlstra <peterz@infradead.org>
Cc: Ravi Bangoria <ravi.bangoria@amd.com>
Cc: Rob Herring <robh@kernel.org>
Cc: Sandipan Das <sandipan.das@amd.com>
Cc: Stephane Eranian <eranian@google.com>
Cc: Will Deacon <will@kernel.org>
Cc: Xing Zhengjun <zhengjun.xing@linux.intel.com>
Cc: linux-arm-kernel@lists.infradead.org
Cc: linuxppc-dev@lists.ozlabs.org
Link: https://lore.kernel.org/r/20230126233645.200509-7-irogers@google.com


Signed-off-by: Arnaldo Carvalho de Melo <acme@redhat.com>

parent 96d2a746

tools/perf/builtin-list.c

+2 −18

Original line number	Diff line number	Diff line
		@@ -99,8 +99,7 @@ static void default_print_event(void ps, const char pmu_name, const char *topi
		const char *scale_unit __maybe_unused,
		bool deprecated, const char *event_type_desc,
		const char desc, const char long_desc,
		const char *encoding_desc,
		const char metric_name, const char metric_expr)
		const char *encoding_desc)
		{
		struct print_state *print_state = ps;
		int pos;
		@@ -159,10 +158,6 @@ static void default_print_event(void ps, const char pmu_name, const char *topi
		if (print_state->detailed && encoding_desc) {
		printf("%*s", 8, "");
		wordwrap(encoding_desc, 8, pager_get_columns(), 0);
		if (metric_name)
		printf(" MetricName: %s", metric_name);
		if (metric_expr)
		printf(" MetricExpr: %s", metric_expr);
		putchar('\n');
		}
		}
		@@ -308,8 +303,7 @@ static void json_print_event(void ps, const char pmu_name, const char *topic,
		const char *scale_unit,
		bool deprecated, const char *event_type_desc,
		const char desc, const char long_desc,
		const char *encoding_desc,
		const char metric_name, const char metric_expr)
		const char *encoding_desc)
		{
		struct json_print_state *print_state = ps;
		bool need_sep = false;
		@@ -366,16 +360,6 @@ static void json_print_event(void ps, const char pmu_name, const char *topic,
		encoding_desc);
		need_sep = true;
		}
		if (metric_name) {
		fix_escape_printf(&buf, "%s\t\"MetricName\": \"%S\"", need_sep ? ",\n" : "",
		metric_name);
		need_sep = true;
		}
		if (metric_expr) {
		fix_escape_printf(&buf, "%s\t\"MetricExpr\": \"%S\"", need_sep ? ",\n" : "",
		metric_expr);
		need_sep = true;
		}
		printf("%s}", need_sep ? "\n" : "");
		strbuf_release(&buf);
		}

tools/perf/pmu-events/jevents.py

+16 −4

Original line number	Diff line number	Diff line
		@@ -37,6 +37,11 @@ _json_event_attributes = [
		'metric_constraint', 'metric_expr', 'long_desc'
		]

		# Attributes that are in pmu_metric rather than pmu_event.
		_json_metric_attributes = [
		'metric_name', 'metric_group', 'metric_constraint', 'metric_expr', 'desc',
		'long_desc', 'unit', 'compat', 'aggr_mode'
		]

		def removesuffix(s: str, suffix: str) -> str:
		"""Remove the suffix from a string
		@@ -569,6 +574,9 @@ static void decompress_event(int offset, struct pmu_event *pe)
		\tconst char *p = &big_c_string[offset];
		""")
		for attr in _json_event_attributes:
		if attr in _json_metric_attributes and 'metric_' in attr:
		_args.output_file.write(f'\n\t/* Skip {attr} */\n')
		else:
		_args.output_file.write(f"""
		\tpe->{attr} = (*p == '\\0' ? NULL : p);
		""")
		@@ -576,14 +584,18 @@ static void decompress_event(int offset, struct pmu_event *pe)
		continue
		_args.output_file.write('\twhile (*p++);')
		_args.output_file.write("""}
		static void decompress_metric(int offset, struct pmu_metric *pe)

		static void decompress_metric(int offset, struct pmu_metric *pm)
		{
		\tconst char *p = &big_c_string[offset];
		""")
		for attr in _json_event_attributes:
		if attr in _json_metric_attributes:
		_args.output_file.write(f"""
		\tpe->{attr} = (*p == '\\0' ? NULL : p);
		\tpm->{attr} = (*p == '\\0' ? NULL : p);
		""")
		else:
		_args.output_file.write(f'\n\t/* Skip {attr} */\n')
		if attr == _json_event_attributes[-1]:
		continue
		_args.output_file.write('\twhile (*p++);')

tools/perf/pmu-events/pmu-events.h

+6 −16

Original line number	Diff line number	Diff line
		@@ -23,29 +23,19 @@ struct pmu_event {
		const char *unit;
		const char *perpkg;
		const char *aggr_mode;
		const char *metric_expr;
		const char *metric_name;
		const char *metric_group;
		const char *deprecated;
		const char *metric_constraint;
		};

		struct pmu_metric {
		const char *name;
		const char *compat;
		const char *event;
		const char *desc;
		const char *topic;
		const char *long_desc;
		const char *pmu;
		const char *unit;
		const char *perpkg;
		const char *aggr_mode;
		const char *metric_expr;
		const char *metric_name;
		const char *metric_group;
		const char *deprecated;
		const char *metric_expr;
		const char *unit;
		const char *compat;
		const char *aggr_mode;
		const char *metric_constraint;
		const char *desc;
		const char *long_desc;
		};

		struct pmu_events_table;

tools/perf/tests/pmu-events.c

+0 −27

Original line number	Diff line number	Diff line
		@@ -337,36 +337,12 @@ static int compare_pmu_events(const struct pmu_event *e1, const struct pmu_event
		return -1;
		}

		if (!is_same(e1->metric_expr, e2->metric_expr)) {
		pr_debug2("testing event e1 %s: mismatched metric_expr, %s vs %s\n",
		e1->name, e1->metric_expr, e2->metric_expr);
		return -1;
		}

		if (!is_same(e1->metric_name, e2->metric_name)) {
		pr_debug2("testing event e1 %s: mismatched metric_name, %s vs %s\n",
		e1->name, e1->metric_name, e2->metric_name);
		return -1;
		}

		if (!is_same(e1->metric_group, e2->metric_group)) {
		pr_debug2("testing event e1 %s: mismatched metric_group, %s vs %s\n",
		e1->name, e1->metric_group, e2->metric_group);
		return -1;
		}

		if (!is_same(e1->deprecated, e2->deprecated)) {
		pr_debug2("testing event e1 %s: mismatched deprecated, %s vs %s\n",
		e1->name, e1->deprecated, e2->deprecated);
		return -1;
		}

		if (!is_same(e1->metric_constraint, e2->metric_constraint)) {
		pr_debug2("testing event e1 %s: mismatched metric_constant, %s vs %s\n",
		e1->name, e1->metric_constraint, e2->metric_constraint);
		return -1;
		}

		return 0;
		}

		@@ -432,9 +408,6 @@ static int test__pmu_event_table_core_callback(const struct pmu_event *pe,
		struct perf_pmu_test_event const **test_event_table;
		bool found = false;

		if (!pe->name)
		return 0;

		if (pe->pmu)
		test_event_table = &uncore_events[0];
		else

tools/perf/util/parse-events.c

+0 −2

Original line number	Diff line number	Diff line
		@@ -1570,8 +1570,6 @@ int parse_events_add_pmu(struct parse_events_state *parse_state,
		evsel->scale = info.scale;
		evsel->per_pkg = info.per_pkg;
		evsel->snapshot = info.snapshot;
		evsel->metric_expr = info.metric_expr;
		evsel->metric_name = info.metric_name;
		return 0;
		}