[PATCH] perf hist: Remove output field from sort-list properly

[PATCH] perf hist: Remove output field from sort-list properly

[Namhyung Kim]

When it removes an output format for cancelled children or latency, it
should delete itself from the sort list as well.  Otherwise assertion
in fmt_free() will fire.

  $ perf report -H --stdio
  perf: ui/hist.c:603: fmt_free: Assertion `!(!list_empty(&fmt->sort_list))' failed.
  Aborted (core dumped)

Also convert to perf_hpp__column_unregister() for the same open codes.

Fixes: dbd11b6bdab12f60 ("perf hist: Remove formats in hierarchy when cancel children")
Signed-off-by: Namhyung Kim <namhyung@kernel.org>
---
 tools/perf/ui/hist.c | 15 +++++----------
 1 file changed, 5 insertions(+), 10 deletions(-)

diff --git a/tools/perf/ui/hist.c b/tools/perf/ui/hist.c
index 3ffce69fc823e0bf..bc0689fceeb18bde 100644
--- a/tools/perf/ui/hist.c
+++ b/tools/perf/ui/hist.c
@@ -696,6 +696,7 @@ void perf_hpp_list__prepend_sort_field(struct perf_hpp_list *list,
 static void perf_hpp__column_unregister(struct perf_hpp_fmt *format)
 {
 	list_del_init(&format->list);
+	list_del_init(&format->sort_list);
 	fmt_free(format);
 }
 
@@ -818,18 +819,12 @@ void perf_hpp__reset_output_field(struct perf_hpp_list *list)
 	struct perf_hpp_fmt *fmt, *tmp;
 
 	/* reset output fields */
-	perf_hpp_list__for_each_format_safe(list, fmt, tmp) {
-		list_del_init(&fmt->list);
-		list_del_init(&fmt->sort_list);
-		fmt_free(fmt);
-	}
+	perf_hpp_list__for_each_format_safe(list, fmt, tmp)
+		perf_hpp__column_unregister(fmt);
 
 	/* reset sort keys */
-	perf_hpp_list__for_each_sort_list_safe(list, fmt, tmp) {
-		list_del_init(&fmt->list);
-		list_del_init(&fmt->sort_list);
-		fmt_free(fmt);
-	}
+	perf_hpp_list__for_each_sort_list_safe(list, fmt, tmp)
+		perf_hpp__column_unregister(fmt);
 }
 
 /*
-- 
2.49.0.906.g1f30a19c02-goog

Re: [PATCH] perf hist: Remove output field from sort-list properly

[Arnaldo Carvalho de Melo]

On Wed, Apr 30, 2025 at 11:03:21AM -0700, Namhyung Kim wrote:
> When it removes an output format for cancelled children or latency, it
> should delete itself from the sort list as well.  Otherwise assertion
> in fmt_free() will fire.
> 
>   $ perf report -H --stdio
>   perf: ui/hist.c:603: fmt_free: Assertion `!(!list_empty(&fmt->sort_list))' failed.
>   Aborted (core dumped)
> 
> Also convert to perf_hpp__column_unregister() for the same open codes.
> 
> Fixes: dbd11b6bdab12f60 ("perf hist: Remove formats in hierarchy when cancel children")
> Signed-off-by: Namhyung Kim <namhyung@kernel.org>

Tested and added the following patch just before this one.

Please check.

Thanks, applied to perf-tools-next.

- Arnaldo

From 0184752e038f00ea2ccdc4ef4fdb6713ef2a328e Mon Sep 17 00:00:00 2001
From: Arnaldo Carvalho de Melo <acme@redhat.com>
Date: Fri, 2 May 2025 12:48:28 -0300
Subject: [PATCH 1/2] perf test perf-report-hierarchy: Add new test

Super simple test to check that at least we're not segfaulting when
trying to use 'perf report --hierarchy', more subtests should be added
to make sure the output is the expected one.

This is being merged right before a fix for that that this test detects:

  # perf test hierarchy
   83: perf report --hierarchy                                         : FAILED!
  # perf test -v hierarchy
  --- start ---
  test child forked, pid 102242
  perf report --hierarchy
  Linux
  [ perf record: Woken up 1 times to write data ]
  [ perf record: Captured and wrote 0.025 MB /tmp/perf-test-report.HX0N85TlPq/perf-report-hierarchy-perf.data (6 samples) ]
  perf: ui/hist.c:603: fmt_free: Assertion `!(!list_empty(&fmt->sort_list))' failed.
  /home/acme/libexec/perf-core/tests/shell/perf-report-hierarchy.sh: line 34: 102250 Aborted                 (core dumped) perf report --hierarchy > /dev/null
  --- Cleaning up ---
  ---- end(-1) ----
   83: perf report --hierarchy                                         : FAILED!
  #

Cc: Adrian Hunter <adrian.hunter@intel.com>
Cc: Ian Rogers <irogers@google.com>
Cc: James Clark <james.clark@linaro.org>
Cc: Jiri Olsa <jolsa@kernel.org>
Cc: Kan Liang <kan.liang@linux.intel.com>
Cc: Namhyung Kim <namhyung@kernel.org>
Link: https://lore.kernel.org/lkml/20250430180321.736939-1-namhyung@kernel.org
Signed-off-by: Arnaldo Carvalho de Melo <acme@redhat.com>
---
 .../perf/tests/shell/perf-report-hierarchy.sh | 47 +++++++++++++++++++
 1 file changed, 47 insertions(+)
 create mode 100755 tools/perf/tests/shell/perf-report-hierarchy.sh

diff --git a/tools/perf/tests/shell/perf-report-hierarchy.sh b/tools/perf/tests/shell/perf-report-hierarchy.sh
new file mode 100755
index 0000000000000000..a9cc1edae36ba003
--- /dev/null
+++ b/tools/perf/tests/shell/perf-report-hierarchy.sh
@@ -0,0 +1,47 @@
+#!/bin/sh
+# perf report --hierarchy
+# SPDX-License-Identifier: GPL-2.0
+# Arnaldo Carvalho de Melo <acme@redhat.com> 
+
+set -e
+
+temp_dir=$(mktemp -d /tmp/perf-test-report.XXXXXXXXXX)
+
+perfdatafile="${temp_dir}/perf.data"
+
+err=0
+
+cleanup()
+{
+	trap - EXIT TERM INT
+	sane=$(echo "${temp_dir}" | cut -b 1-21)
+	if [ "${sane}" = "/tmp/perf-test-report" ] ; then
+		echo "--- Cleaning up ---"
+		rm -rf "${temp_dir:?}/"*
+		rmdir "${temp_dir}"
+	fi
+}
+
+trap_cleanup()
+{
+	cleanup
+	exit 1
+}
+
+trap trap_cleanup EXIT TERM INT
+
+test_report_hierarchy()
+{
+	echo "perf report --hierarchy"
+
+	perf_data="${temp_dir}/perf-report-hierarchy-perf.data"
+	perf record -o "${perf_data}" uname
+	perf report --hierarchy > /dev/null
+	echo "perf report --hierarchy test [Success]"
+}
+
+test_report_hierarchy
+
+cleanup
+
+exit $err
-- 
2.49.0

Re: [PATCH] perf hist: Remove output field from sort-list properly

[Namhyung Kim]

Hi Arnaldo,

On Fri, May 02, 2025 at 12:54:19PM -0300, Arnaldo Carvalho de Melo wrote:
> On Wed, Apr 30, 2025 at 11:03:21AM -0700, Namhyung Kim wrote:
> > When it removes an output format for cancelled children or latency, it
> > should delete itself from the sort list as well.  Otherwise assertion
> > in fmt_free() will fire.
> > 
> >   $ perf report -H --stdio
> >   perf: ui/hist.c:603: fmt_free: Assertion `!(!list_empty(&fmt->sort_list))' failed.
> >   Aborted (core dumped)
> > 
> > Also convert to perf_hpp__column_unregister() for the same open codes.
> > 
> > Fixes: dbd11b6bdab12f60 ("perf hist: Remove formats in hierarchy when cancel children")
> > Signed-off-by: Namhyung Kim <namhyung@kernel.org>
> 
> Tested and added the following patch just before this one.
> 
> Please check.
> 
> Thanks, applied to perf-tools-next.

Thanks!

> 
> - Arnaldo
> 
> From 0184752e038f00ea2ccdc4ef4fdb6713ef2a328e Mon Sep 17 00:00:00 2001
> From: Arnaldo Carvalho de Melo <acme@redhat.com>
> Date: Fri, 2 May 2025 12:48:28 -0300
> Subject: [PATCH 1/2] perf test perf-report-hierarchy: Add new test
> 
> Super simple test to check that at least we're not segfaulting when
> trying to use 'perf report --hierarchy', more subtests should be added
> to make sure the output is the expected one.

Thanks for doing this.  We have a test suite for perf report and there's
a test for the --hierarchy option already.  But I'm afrail it didn't
check if the command crashed.  I'm fine with adding this separately and
maybe I can add more tests later.

Thanks,
Namhyung

> 
> This is being merged right before a fix for that that this test detects:
> 
>   # perf test hierarchy
>    83: perf report --hierarchy                                         : FAILED!
>   # perf test -v hierarchy
>   --- start ---
>   test child forked, pid 102242
>   perf report --hierarchy
>   Linux
>   [ perf record: Woken up 1 times to write data ]
>   [ perf record: Captured and wrote 0.025 MB /tmp/perf-test-report.HX0N85TlPq/perf-report-hierarchy-perf.data (6 samples) ]
>   perf: ui/hist.c:603: fmt_free: Assertion `!(!list_empty(&fmt->sort_list))' failed.
>   /home/acme/libexec/perf-core/tests/shell/perf-report-hierarchy.sh: line 34: 102250 Aborted                 (core dumped) perf report --hierarchy > /dev/null
>   --- Cleaning up ---
>   ---- end(-1) ----
>    83: perf report --hierarchy                                         : FAILED!
>   #
> 
> Cc: Adrian Hunter <adrian.hunter@intel.com>
> Cc: Ian Rogers <irogers@google.com>
> Cc: James Clark <james.clark@linaro.org>
> Cc: Jiri Olsa <jolsa@kernel.org>
> Cc: Kan Liang <kan.liang@linux.intel.com>
> Cc: Namhyung Kim <namhyung@kernel.org>
> Link: https://lore.kernel.org/lkml/20250430180321.736939-1-namhyung@kernel.org
> Signed-off-by: Arnaldo Carvalho de Melo <acme@redhat.com>
> ---
>  .../perf/tests/shell/perf-report-hierarchy.sh | 47 +++++++++++++++++++
>  1 file changed, 47 insertions(+)
>  create mode 100755 tools/perf/tests/shell/perf-report-hierarchy.sh
> 
> diff --git a/tools/perf/tests/shell/perf-report-hierarchy.sh b/tools/perf/tests/shell/perf-report-hierarchy.sh
> new file mode 100755
> index 0000000000000000..a9cc1edae36ba003
> --- /dev/null
> +++ b/tools/perf/tests/shell/perf-report-hierarchy.sh
> @@ -0,0 +1,47 @@
> +#!/bin/sh
> +# perf report --hierarchy
> +# SPDX-License-Identifier: GPL-2.0
> +# Arnaldo Carvalho de Melo <acme@redhat.com> 
> +
> +set -e
> +
> +temp_dir=$(mktemp -d /tmp/perf-test-report.XXXXXXXXXX)
> +
> +perfdatafile="${temp_dir}/perf.data"
> +
> +err=0
> +
> +cleanup()
> +{
> +	trap - EXIT TERM INT
> +	sane=$(echo "${temp_dir}" | cut -b 1-21)
> +	if [ "${sane}" = "/tmp/perf-test-report" ] ; then
> +		echo "--- Cleaning up ---"
> +		rm -rf "${temp_dir:?}/"*
> +		rmdir "${temp_dir}"
> +	fi
> +}
> +
> +trap_cleanup()
> +{
> +	cleanup
> +	exit 1
> +}
> +
> +trap trap_cleanup EXIT TERM INT
> +
> +test_report_hierarchy()
> +{
> +	echo "perf report --hierarchy"
> +
> +	perf_data="${temp_dir}/perf-report-hierarchy-perf.data"
> +	perf record -o "${perf_data}" uname
> +	perf report --hierarchy > /dev/null
> +	echo "perf report --hierarchy test [Success]"
> +}
> +
> +test_report_hierarchy
> +
> +cleanup
> +
> +exit $err
> -- 
> 2.49.0
>