Skip to contentSkip to conversation

perf stat: Add --hide-zero-events option to suppress zero-count events

PATCH Applied Aaron Tomlin 2 participants 2 messages Jul 19 – Jul 23 perf events

lore
Share & tools
lore
#0 lore raw

PATCH v3 1/1 perf stat: Add --hide-zero-events option to suppress zero-count events

When monitoring a large number of events (e.g., with wildcards such as --event 'syscalls:sys_enter_*'), many matched events will return a count of zero. This clutters the output, making it difficult to spot the active events.

Add a new option --hide-zero-events to suppress printing events that have a count of zero.

To prevent formatting and diagnostic issues, the zero-skipping logic implements the following rules:

1. In metric-only mode (i.e., --metric-only), columns must remain aligned in the output grid. We evaluate config->metric_only first to avoid skipping zero-valued columns, preventing values from shifting left and aligning under incorrect headers

2. For explicitly requested events, we ensure they are not silently hidden if they are unsupported. We only hide a zero-count event if counter->supported is true, ensuring that unsupported explicit events still report "<not supported>"

---
Changes since v2:

- Rebased against perf-tools-next/perf-tools-next (Namhyung Kim)

- Linked to v1: https://lore.kernel.org/lkml/[email protected]/

Changes since v1:

- Add shell test coverage for --hide-zero-events and --metric-only in stat.sh (Ian Rogers)

- Linked to v1: https://lore.kernel.org/lkml/[email protected]/

---
 tools/perf/Documentation/perf-stat.txt |  3 ++
 tools/perf/builtin-stat.c              |  2 ++
 tools/perf/tests/shell/stat.sh         | 46 ++++++++++++++++++++++++++
 tools/perf/util/stat-display.c         |  3 ++
 tools/perf/util/stat.h                 |  1 +
 5 files changed, 55 insertions(+)
tools/perf/Documentation/perf-stat.txt +3 -0
index b72a29c9223c..f334aabdc809 100644
@@ -162,6 +162,9 @@ null run - Don't start any counters.
 This can be useful to measure just elapsed wall-clock time - or to assess the
 raw overhead of perf stat itself, without running any counters.
 
+--hide-zero-events::
+Do not show events with a zero count.
+
 -v::
 --verbose::
         be more verbose (show counter open errors, etc)
tools/perf/builtin-stat.c +2 -0
index a85a4f30221a..d68a2617a920 100644
@@ -2505,6 +2505,8 @@ int cmd_stat(int argc, const char **argv)
 			"display details about each run (only with -r option)"),
 		OPT_BOOLEAN('n', "null", &stat_config.null_run,
 			"null run - dont start any counters"),
+		OPT_BOOLEAN(0, "hide-zero-events", &stat_config.hide_zero,
+			"Do not show events with a zero count"),
 		OPT_INCR('d', "detailed", &detailed_run,
 			"detailed run - start a lot of events"),
 		OPT_BOOLEAN('S', "sync", &sync_run,
tools/perf/tests/shell/stat.sh +46 -0

58 lines not on this page · raw message

tools/perf/util/stat-display.c +3 -0
index f94f1324d24a..b337cc23f413 100644
@@ -907,6 +907,9 @@ static bool should_skip_zero_counter(struct perf_stat_config *config,
 	/* Metric only counts won't be displayed but the metric wants to be computed. */
 	if (config->metric_only)
 		return false;
+
+	if (config->hide_zero && counter->supported)
+		return true;
 	/*
 	 * Skip value 0 when enabling --per-thread globally,
 	 * otherwise it will have too many 0 output.
tools/perf/util/stat.h +1 -0
index 4bced233d2fc..e3598037a6aa 100644
@@ -69,6 +69,7 @@ struct perf_stat_config {
 	bool			 interval_clear;
 	bool			 metric_only;
 	bool			 null_run;
+	bool			 hide_zero;
 	bool			 ru_display;
 	bool			 big_num;
 	bool			 hybrid_merge;

base-commit: 59355235f29e02eb4d88aa2d0c0d68aca901c929

Signature · 1 line
2.54.0
maintainer Applied
#1 lore raw
Quoted 9 lines · Aaron Tomlin

When monitoring a large number of events (e.g., with wildcards such as --event 'syscalls:sys_enter_*'), many matched events will return a count of zero. This clutters the output, making it difficult to spot the active events.

Add a new option --hide-zero-events to suppress printing events that have a count of zero.

[...]

Applied to perf-tools-next, thanks!

Best regards,
Namhyung