Received-SPF: pass (google.com: domain of linux-kernel+bounces-140699-linux.lists.archive=gmail.com@vger.kernel.org designates 139.178.88.99 as permitted sender) client-ip=139.178.88.99;
From: Yanfei Xu <yanfei.xu@intel.com>
To: peterz@infradead.org,
	mingo@redhat.com,
	acme@kernel.org,
	mark.rutland@arm.com,
	alexander.shishkin@linux.intel.com,
	jolsa@kernel.org,
	namhyung@kernel.org,
	irogers@google.com,
	adrian.hunter@intel.com,
	kan.liang@linux.intel.com
Cc: linux-perf-users@vger.kernel.org,
	linux-kernel@vger.kernel.org,
	yanfei.xu@intel.com
Subject: [PATCH] perf parse-events: Avoid two scenarios involving the reordering of topdown events
Date: Thu, 11 Apr 2024 22:48:52 +0800
Message-Id: <20240411144852.2507143-1-yanfei.xu@intel.com>
Precedence: bulk
MIME-Version: 1.0
Content-Transfer-Encoding: 8bit

We found that even an events group with slots but without topdown events
will still reroder to place the slots first. It's unnecessary, and may
break tools expecting the command line order to match the printed order.
The issue was previously fixed [1], but was later discarded since [2].

Add an extra check of evsel leader, variable must_be_in_group, to ensure
the slots event is only moved if the group has non-slots topdown events.

Without the patch:

  $ perf stat  -e '{cpu/cpu-cycles/,slots}'  sleep 1
  WARNING: events were regrouped to match PMUs

   Performance counter stats for 'sleep 1':

           2,663,256      slots:u
             443,876      cpu/cpu-cycles/u

         1.001079566 seconds time elapsed

         0.001054000 seconds user
         0.000000000 seconds sys

With the patch:

  $ perf stat  -e '{cpu/cpu-cycles/,slots}'  sleep 1

   Performance counter stats for 'sleep 1':

            469,039      cpu/cpu-cycles/u
          2,814,234      slots:u

        1.001148306 seconds time elapsed

        0.001123000 seconds user
        0.000000000 seconds sys

In cases where both slots and topdown events are present, moving the
slots event to be the first event is necessary. However there is no
requirement to move the topdown events to be adjacent to slots event.
So keep the original order of the topdown events is expected. Further
more, if a group doesn't have slots event, the topdown events will be
unexpectedly moved to the head of the group.

Remove the movements regarding topdown events in arch_evlist__cmp()

Without the patch:

  $ perf stat -e '{slots,cpu/cpu-cycles/,cpu/topdown-bad-spec/}' sleep 1
  WARNING: events were regrouped to match PMUs

   Performance counter stats for 'sleep 1':

          2,681,460      slots:u
            336,496      cpu/topdown-bad-spec/u
            446,910      cpu/cpu-cycles/u

        1.001210088 seconds time elapsed

        0.001160000 seconds user
        0.000000000 seconds sys

With the patch:

  $ perf stat -e '{slots,cpu/cpu-cycles/,cpu/topdown-bad-spec/}' sleep 1

   Performance counter stats for 'sleep 1':

          2,715,486      slots:u
            452,581      cpu/cpu-cycles/u
            340,766      cpu/topdown-bad-spec/u

        1.001116709 seconds time elapsed

        0.001111000 seconds user
        0.000000000 seconds sys

[1] https://lore.kernel.org/lkml/20220321223344.1034479-1-irogers@google.com/#/
[2] https://lore.kernel.org/lkml/20230302041211.852330-10-irogers@google.com/#/

Fixes: 347c2f0a0988 ("perf parse-events: Sort and group parsed events")
Signed-off-by: Yanfei Xu <yanfei.xu@intel.com>
---
 tools/perf/arch/x86/util/evlist.c | 13 +++++--------
 tools/perf/arch/x86/util/evsel.c  |  6 ++++++
 tools/perf/util/evsel.h           |  2 ++
 tools/perf/util/parse-events.c    |  9 ++++++---
 4 files changed, 19 insertions(+), 11 deletions(-)

diff --git a/tools/perf/arch/x86/util/evlist.c b/tools/perf/arch/x86/util/evlist.c
index b1ce0c52d88d..eed0a74c561a 100644
--- a/tools/perf/arch/x86/util/evlist.c
+++ b/tools/perf/arch/x86/util/evlist.c
@@ -75,17 +75,14 @@ int arch_evlist__add_default_attrs(struct evlist *evlist,
 
 int arch_evlist__cmp(const struct evsel *lhs, const struct evsel *rhs)
 {
+	struct evsel *leader;
+
 	if (topdown_sys_has_perf_metrics() &&
 	    (arch_evsel__must_be_in_group(lhs) || arch_evsel__must_be_in_group(rhs))) {
+		leader = evsel__leader(rhs);
 		/* Ensure the topdown slots comes first. */
-		if (strcasestr(lhs->name, "slots") && !strcasestr(lhs->name, "uops_retired.slots"))
-			return -1;
-		if (strcasestr(rhs->name, "slots") && !strcasestr(rhs->name, "uops_retired.slots"))
-			return 1;
-		/* Followed by topdown events. */
-		if (strcasestr(lhs->name, "topdown") && !strcasestr(rhs->name, "topdown"))
-			return -1;
-		if (!strcasestr(lhs->name, "topdown") && strcasestr(rhs->name, "topdown"))
+		if (strcasestr(rhs->name, "slots") && !strcasestr(rhs->name, "uops_retired.slots")
+			&& leader->must_be_in_group)
 			return 1;
 	}
 
diff --git a/tools/perf/arch/x86/util/evsel.c b/tools/perf/arch/x86/util/evsel.c
index 090d0f371891..16f42fcfbe0b 100644
--- a/tools/perf/arch/x86/util/evsel.c
+++ b/tools/perf/arch/x86/util/evsel.c
@@ -44,6 +44,12 @@ bool arch_evsel__must_be_in_group(const struct evsel *evsel)
 	    strcasestr(evsel->name, "uops_retired.slots"))
 		return false;
 
+	if (strcasestr(evsel->name, "topdown")) {
+		struct evsel *leader = evsel__leader(evsel);
+
+		leader->must_be_in_group = true;
+	}
+
 	return strcasestr(evsel->name, "topdown") || strcasestr(evsel->name, "slots");
 }
 
diff --git a/tools/perf/util/evsel.h b/tools/perf/util/evsel.h
index 517cff431de2..a7ab266bc915 100644
--- a/tools/perf/util/evsel.h
+++ b/tools/perf/util/evsel.h
@@ -98,6 +98,8 @@ struct evsel {
 		bool			bpf_counter;
 		bool			use_config_name;
 		bool			skippable;
+		/* any evsels with the flag set must be in a group */
+		bool            must_be_in_group;
 		int			bpf_fd;
 		struct bpf_object	*bpf_obj;
 		struct list_head	config_terms;
diff --git a/tools/perf/util/parse-events.c b/tools/perf/util/parse-events.c
index 6f8b0fa17689..37950056a661 100644
--- a/tools/perf/util/parse-events.c
+++ b/tools/perf/util/parse-events.c
@@ -2052,9 +2052,12 @@ static int parse_events__sort_events_and_fix_groups(struct list_head *list)
 		 */
 		pos->core.idx = idx++;
 
-		/* Remember an index to sort all forced grouped events together to. */
-		if (force_grouped_idx == -1 && pos == pos_leader && pos->core.nr_members < 2 &&
-		    arch_evsel__must_be_in_group(pos))
+		/*
+		 * Remember an index to sort all forced grouped events together to,
+		 * and check each evsel for setting must_be_in_group of its leader.
+		 */
+		if (arch_evsel__must_be_in_group(pos) && force_grouped_idx == -1 &&
+			pos == pos_leader && pos->core.nr_members < 2)
 			force_grouped_idx = pos->core.idx;
 	}
 
-- 
2.40.1