perf stat: Add --hide-zero-events option to suppress zero-count events
PATCH 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>"
--- tools/perf/Documentation/perf-stat.txt | 3 +++ tools/perf/builtin-stat.c | 2 ++ tools/perf/util/stat-display.c | 3 +++ tools/perf/util/stat.h | 1 + 4 files changed, 9 insertions(+)
tools/perf/Documentation/perf-stat.txt +3 -0
@@ -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
@@ -2493,6 +2493,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/util/stat-display.c +3 -0
@@ -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
@@ -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;
Signature · 1 line
2.54.0
Quoted 17 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.
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_onlyfirst to avoid skipping zero-valued columns, preventing values from shifting left and aligning under incorrect headers
Quoted 6 lines
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->supportedis true, ensuring that unsupported explicit events still report "<not supported>"Signed-off-by Aaron Tomlin <[email protected]>
I think this makes sense but perhaps the Python interface makes more sense for what you're doing. For example, the ilist app shows all events and metrics:
https://web.git.kernel.org/pub/scm/linux/kernel/git/perf/perf-tools-next.git/tree/tools/perf/python/ilist.py?h=perf-tools-next
Perhaps we could also add some tests for better coverage:
https://web.git.kernel.org/pub/scm/linux/kernel/git/perf/perf-tools-next.git/tree/tools/perf/tests/shell/stat.sh?h=perf-tools-next
Other than that:
Thanks,
Ian
Quoted 63 lines
--- tools/perf/Documentation/perf-stat.txt | 3 +++ tools/perf/builtin-stat.c | 2 ++ tools/perf/util/stat-display.c | 3 +++ tools/perf/util/stat.h | 1 + 4 files changed, 9 insertions(+)tools/perf/Documentation/perf-stat.txt +3
-0@@ -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@@ -2493,6 +2493,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/util/stat-display.c +3
-0@@ -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
-1@@ -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; --2.54.0
Quoted 5 lines · Ian Rogers
I think this makes sense but perhaps the Python interface makes more sense for what you're doing. For example, the ilist app shows all events and metrics:
https://web.git.kernel.org/pub/scm/linux/kernel/git/perf/perf-tools-next.git/tree/tools/perf/python/ilist.py?h=perf-tools-next
Quoted 7 lines
Perhaps we could also add some tests for better coverage:
https://web.git.kernel.org/pub/scm/linux/kernel/git/perf/perf-tools-next.git/tree/tools/perf/tests/shell/stat.sh?h=perf-tools-nextOther than that:
Reviewed-by Ian Rogers <[email protected]>Thanks,
Hi Ian,
Thanks for the feedback and the "Reviewed-by:" tag!
Regarding the Python interface, it's definitely a powerful tool for custom scripting and listing events. However, I prefer using 'perf stat' directly on the command line for a few reasons:
1. Standard 'perf stat' works out-of-the-box on minimal production systems where Python and the perf python bindings/dependencies might not be installed or packaged
2. Having a simple command-line flag like '--hide-zero-events' makes quick, interactive profiling directly on the CLI much more convenient
I have updated the patch to incorporate your suggestion and added shell test coverage for both '--hide-zero-events' and '--metric-only' in tools/perf/tests/shell/stat.sh. I will submit v2 shortly.
Kind regards,
Signature · 1 line
Aaron Tomlin