[PATCH v1 6/8] perf stat: Display metric threshold value in CSV output

From: Ian Rogers
Date: Fri Oct 04 2024 - 19:42:54 EST


Add a column with a metric threshold value. For example, the bad/good
in the last column below:
```
$ perf stat -a -M topdownl1 -x, -I 1000
1.000103288,4677067630,,TOPDOWN.SLOTS,16029302700,100.00,31.1,% tma_backend_bound,bad
1.000103288,,,,,,51.0,% tma_frontend_bound,bad
1.000103288,,,,,,7.6,% tma_bad_speculation,good
1.000103288,,,,,,10.2,% tma_retiring,good
1.000103288,476781750,,topdown-retiring,16029302700,100.00,,
1.000103288,2389693619,,topdown-fe-bound,16029302700,100.00,,
1.000103288,1431602465,,topdown-be-bound,16029302700,100.00,,
1.000103288,378991388,,topdown-bad-spec,16029302700,100.00,,
1.000103288,4934535,,INT_MISC.CLEARS_COUNT,16029339890,100.00,,
1.000103288,56474476,,IDQ.MS_UOPS,16029292873,100.00,,
1.000103288,3188888,,INT_MISC.UOP_DROPPING,16029239908,100.00,,
1.000103288,484429099,,UOPS_RETIRED.SLOTS,16029176080,100.00,,
1.000103288,49066178,,UOPS_DECODED.DEC0,16029100912,100.00,,
1.000103288,26472844,,cpu/UOPS_DECODED.DEC0,cmask=1/,16029009707,100.00,,
1.000103288,709313662,,UOPS_ISSUED.ANY,16028914990,100.00,,
1.000103288,346833383,,IDQ.MITE_UOPS,16028820330,100.00,,
```

Signed-off-by: Ian Rogers <irogers@xxxxxxxxxx>
---
tools/perf/Documentation/perf-stat.txt | 1 +
tools/perf/tests/shell/stat+csv_output.sh | 24 ++++++++++----------
tools/perf/util/stat-display.c | 27 +++++++++++++++++++----
3 files changed, 36 insertions(+), 16 deletions(-)

diff --git a/tools/perf/Documentation/perf-stat.txt b/tools/perf/Documentation/perf-stat.txt
index 2bc063672486..9bfa1a085e98 100644
--- a/tools/perf/Documentation/perf-stat.txt
+++ b/tools/perf/Documentation/perf-stat.txt
@@ -622,6 +622,7 @@ The fields are in this order:
- optional variance if multiple values are collected with -r
- optional metric value
- optional unit of metric
+ - optional how the value relates to a metric threshold

Additional metrics may be printed with all earlier fields being empty.

diff --git a/tools/perf/tests/shell/stat+csv_output.sh b/tools/perf/tests/shell/stat+csv_output.sh
index fc2d8cc6e5e0..a3bc3c99b534 100755
--- a/tools/perf/tests/shell/stat+csv_output.sh
+++ b/tools/perf/tests/shell/stat+csv_output.sh
@@ -31,19 +31,19 @@ function commachecker()
local exp=0

case "$1"
- in "--no-args") exp=6
- ;; "--system-wide") exp=6
- ;; "--event") exp=6
- ;; "--interval") exp=7
+ in "--no-args") exp=7
+ ;; "--system-wide") exp=7
+ ;; "--event") exp=7
+ ;; "--interval") exp=8
;; "--per-thread") exp=7
- ;; "--system-wide-no-aggr") exp=7
- [ "$(uname -m)" = "s390x" ] && exp='^[6-7]$'
- ;; "--per-core") exp=8
- ;; "--per-socket") exp=8
- ;; "--per-node") exp=8
- ;; "--per-die") exp=8
- ;; "--per-cluster") exp=8
- ;; "--per-cache") exp=8
+ ;; "--system-wide-no-aggr") exp=8
+ [ "$(uname -m)" = "s390x" ] && exp='^[7-8]$'
+ ;; "--per-core") exp=9
+ ;; "--per-socket") exp=9
+ ;; "--per-node") exp=9
+ ;; "--per-die") exp=9
+ ;; "--per-cluster") exp=9
+ ;; "--per-cache") exp=9
esac

while read line
diff --git a/tools/perf/util/stat-display.c b/tools/perf/util/stat-display.c
index 0035f92274bc..c8f3f5a30542 100644
--- a/tools/perf/util/stat-display.c
+++ b/tools/perf/util/stat-display.c
@@ -85,6 +85,19 @@ const char *metric_threshold_classify__color(enum metric_threshold_classify thre
return colors[thresh];
}

+static const char *metric_threshold_classify__str(enum metric_threshold_classify thresh)
+{
+ const char * const strs[] = {
+ "unknown",
+ "bad",
+ "nearly bad",
+ "less good",
+ "good",
+ };
+ static_assert(ARRAY_SIZE(strs) - 1 == METRIC_THRESHOLD_GOOD, "missing enum value");
+ return strs[thresh];
+}
+
static void print_running_std(struct perf_stat_config *config, u64 run, u64 ena)
{
if (run != ena)
@@ -454,14 +467,15 @@ static void new_line_csv(struct perf_stat_config *config, void *ctx)
fputs(config->csv_sep, os->fh);
}

-static void print_metric_csv(struct perf_stat_config *config __maybe_unused,
+static void print_metric_csv(struct perf_stat_config *config,
void *ctx,
- enum metric_threshold_classify thresh __maybe_unused,
+ enum metric_threshold_classify thresh,
const char *fmt, const char *unit, double val)
{
struct outstate *os = ctx;
FILE *out = os->fh;
char buf[64], *vals, *ends;
+ const char *thresh_str = "";

if (unit == NULL || fmt == NULL) {
fprintf(out, "%s%s", config->csv_sep, config->csv_sep);
@@ -472,7 +486,12 @@ static void print_metric_csv(struct perf_stat_config *config __maybe_unused,
while (isdigit(*ends) || *ends == '.')
ends++;
*ends = 0;
- fprintf(out, "%s%s%s%s", config->csv_sep, vals, config->csv_sep, skip_spaces(unit));
+ if (thresh != METRIC_THRESHOLD_UNKNOWN || !rblist__empty(&config->metric_events))
+ thresh_str = metric_threshold_classify__str(thresh);
+ fprintf(out, "%s%s%s%s%s%s",
+ config->csv_sep, vals,
+ config->csv_sep, skip_spaces(unit),
+ config->csv_sep, thresh_str);
}

static void print_metric_json(struct perf_stat_config *config __maybe_unused,
@@ -528,7 +547,7 @@ static void print_metricgroup_header_csv(struct perf_stat_config *config,

for (i = 0; i < os->nfields; i++)
fputs(config->csv_sep, os->fh);
- fprintf(config->output, "%s", metricgroup_name);
+ fprintf(config->output, "%s%s", metricgroup_name, config->csv_sep);
new_line_csv(config, ctx);
}

--
2.47.0.rc0.187.ge670bccf7e-goog