1 // SPDX-License-Identifier: GPL-2.0
12 #include "metricgroup.h"
15 #include <linux/zalloc.h>
17 #include "util/hashmap.h"
19 struct stats walltime_nsecs_stats;
20 struct rusage_stats ru_stats;
23 CTX_BIT_USER = 1 << 0,
24 CTX_BIT_KERNEL = 1 << 1,
26 CTX_BIT_HOST = 1 << 3,
27 CTX_BIT_IDLE = 1 << 4,
36 STAT_STALLED_CYCLES_FRONT,
37 STAT_STALLED_CYCLES_BACK,
55 static int evsel_context(const struct evsel *evsel)
59 if (evsel->core.attr.exclude_kernel)
60 ctx |= CTX_BIT_KERNEL;
61 if (evsel->core.attr.exclude_user)
63 if (evsel->core.attr.exclude_hv)
65 if (evsel->core.attr.exclude_host)
67 if (evsel->core.attr.exclude_idle)
73 void perf_stat__reset_shadow_stats(void)
75 memset(&walltime_nsecs_stats, 0, sizeof(walltime_nsecs_stats));
76 memset(&ru_stats, 0, sizeof(ru_stats));
79 static enum stat_type evsel__stat_type(const struct evsel *evsel)
81 /* Fake perf_hw_cache_op_id values for use with evsel__match. */
82 u64 PERF_COUNT_hw_cache_l1d_miss = PERF_COUNT_HW_CACHE_L1D |
83 ((PERF_COUNT_HW_CACHE_OP_READ) << 8) |
84 ((PERF_COUNT_HW_CACHE_RESULT_MISS) << 16);
85 u64 PERF_COUNT_hw_cache_l1i_miss = PERF_COUNT_HW_CACHE_L1I |
86 ((PERF_COUNT_HW_CACHE_OP_READ) << 8) |
87 ((PERF_COUNT_HW_CACHE_RESULT_MISS) << 16);
88 u64 PERF_COUNT_hw_cache_ll_miss = PERF_COUNT_HW_CACHE_LL |
89 ((PERF_COUNT_HW_CACHE_OP_READ) << 8) |
90 ((PERF_COUNT_HW_CACHE_RESULT_MISS) << 16);
91 u64 PERF_COUNT_hw_cache_dtlb_miss = PERF_COUNT_HW_CACHE_DTLB |
92 ((PERF_COUNT_HW_CACHE_OP_READ) << 8) |
93 ((PERF_COUNT_HW_CACHE_RESULT_MISS) << 16);
94 u64 PERF_COUNT_hw_cache_itlb_miss = PERF_COUNT_HW_CACHE_ITLB |
95 ((PERF_COUNT_HW_CACHE_OP_READ) << 8) |
96 ((PERF_COUNT_HW_CACHE_RESULT_MISS) << 16);
98 if (evsel__is_clock(evsel))
100 else if (evsel__match(evsel, HARDWARE, HW_CPU_CYCLES))
102 else if (evsel__match(evsel, HARDWARE, HW_INSTRUCTIONS))
103 return STAT_INSTRUCTIONS;
104 else if (evsel__match(evsel, HARDWARE, HW_STALLED_CYCLES_FRONTEND))
105 return STAT_STALLED_CYCLES_FRONT;
106 else if (evsel__match(evsel, HARDWARE, HW_STALLED_CYCLES_BACKEND))
107 return STAT_STALLED_CYCLES_BACK;
108 else if (evsel__match(evsel, HARDWARE, HW_BRANCH_INSTRUCTIONS))
109 return STAT_BRANCHES;
110 else if (evsel__match(evsel, HARDWARE, HW_BRANCH_MISSES))
111 return STAT_BRANCH_MISS;
112 else if (evsel__match(evsel, HARDWARE, HW_CACHE_REFERENCES))
113 return STAT_CACHE_REFS;
114 else if (evsel__match(evsel, HARDWARE, HW_CACHE_MISSES))
115 return STAT_CACHE_MISSES;
116 else if (evsel__match(evsel, HW_CACHE, HW_CACHE_L1D))
117 return STAT_L1_DCACHE;
118 else if (evsel__match(evsel, HW_CACHE, HW_CACHE_L1I))
119 return STAT_L1_ICACHE;
120 else if (evsel__match(evsel, HW_CACHE, HW_CACHE_LL))
121 return STAT_LL_CACHE;
122 else if (evsel__match(evsel, HW_CACHE, HW_CACHE_DTLB))
123 return STAT_DTLB_CACHE;
124 else if (evsel__match(evsel, HW_CACHE, HW_CACHE_ITLB))
125 return STAT_ITLB_CACHE;
126 else if (evsel__match(evsel, HW_CACHE, hw_cache_l1d_miss))
127 return STAT_L1D_MISS;
128 else if (evsel__match(evsel, HW_CACHE, hw_cache_l1i_miss))
129 return STAT_L1I_MISS;
130 else if (evsel__match(evsel, HW_CACHE, hw_cache_ll_miss))
132 else if (evsel__match(evsel, HW_CACHE, hw_cache_dtlb_miss))
133 return STAT_DTLB_MISS;
134 else if (evsel__match(evsel, HW_CACHE, hw_cache_itlb_miss))
135 return STAT_ITLB_MISS;
139 static const char *get_ratio_color(const double ratios[3], double val)
141 const char *color = PERF_COLOR_NORMAL;
144 color = PERF_COLOR_RED;
145 else if (val > ratios[1])
146 color = PERF_COLOR_MAGENTA;
147 else if (val > ratios[2])
148 color = PERF_COLOR_YELLOW;
153 static double find_stat(const struct evsel *evsel, int aggr_idx, enum stat_type type)
155 const struct evsel *cur;
156 int evsel_ctx = evsel_context(evsel);
158 evlist__for_each_entry(evsel->evlist, cur) {
159 struct perf_stat_aggr *aggr;
161 /* Ignore the evsel that is being searched from. */
165 /* Ignore evsels that are part of different groups. */
166 if (evsel->core.leader->nr_members > 1 &&
167 evsel->core.leader != cur->core.leader)
169 /* Ignore evsels with mismatched modifiers. */
170 if (evsel_ctx != evsel_context(cur))
172 /* Ignore if not the cgroup we're looking for. */
173 if (evsel->cgrp != cur->cgrp)
175 /* Ignore if not the stat we're looking for. */
176 if (type != evsel__stat_type(cur))
180 * Except the SW CLOCK events,
181 * ignore if not the PMU we're looking for.
183 if ((type != STAT_NSECS) && (evsel->pmu != cur->pmu))
186 aggr = &cur->stats->aggr[aggr_idx];
187 if (type == STAT_NSECS)
188 return aggr->counts.val;
189 return aggr->counts.val * cur->scale;
194 static void print_ratio(struct perf_stat_config *config,
195 const struct evsel *evsel, int aggr_idx,
196 double numerator, struct perf_stat_output_ctx *out,
197 enum stat_type denominator_type,
198 const double color_ratios[3], const char *unit)
200 double denominator = find_stat(evsel, aggr_idx, denominator_type);
202 if (numerator && denominator) {
203 double ratio = numerator / denominator * 100.0;
204 const char *color = get_ratio_color(color_ratios, ratio);
206 out->print_metric(config, out->ctx, color, "%7.2f%%", unit, ratio);
208 out->print_metric(config, out->ctx, NULL, NULL, unit, 0);
211 static void print_stalled_cycles_front(struct perf_stat_config *config,
212 const struct evsel *evsel,
213 int aggr_idx, double stalled,
214 struct perf_stat_output_ctx *out)
216 static const double color_ratios[3] = {50.0, 30.0, 10.0};
218 print_ratio(config, evsel, aggr_idx, stalled, out, STAT_CYCLES, color_ratios,
219 "frontend cycles idle");
222 static void print_stalled_cycles_back(struct perf_stat_config *config,
223 const struct evsel *evsel,
224 int aggr_idx, double stalled,
225 struct perf_stat_output_ctx *out)
227 static const double color_ratios[3] = {75.0, 50.0, 20.0};
229 print_ratio(config, evsel, aggr_idx, stalled, out, STAT_CYCLES, color_ratios,
230 "backend cycles idle");
233 static void print_branch_miss(struct perf_stat_config *config,
234 const struct evsel *evsel,
235 int aggr_idx, double misses,
236 struct perf_stat_output_ctx *out)
238 static const double color_ratios[3] = {20.0, 10.0, 5.0};
240 print_ratio(config, evsel, aggr_idx, misses, out, STAT_BRANCHES, color_ratios,
244 static void print_l1d_miss(struct perf_stat_config *config,
245 const struct evsel *evsel,
246 int aggr_idx, double misses,
247 struct perf_stat_output_ctx *out)
249 static const double color_ratios[3] = {20.0, 10.0, 5.0};
251 print_ratio(config, evsel, aggr_idx, misses, out, STAT_L1_DCACHE, color_ratios,
252 "of all L1-dcache accesses");
255 static void print_l1i_miss(struct perf_stat_config *config,
256 const struct evsel *evsel,
257 int aggr_idx, double misses,
258 struct perf_stat_output_ctx *out)
260 static const double color_ratios[3] = {20.0, 10.0, 5.0};
262 print_ratio(config, evsel, aggr_idx, misses, out, STAT_L1_ICACHE, color_ratios,
263 "of all L1-icache accesses");
266 static void print_ll_miss(struct perf_stat_config *config,
267 const struct evsel *evsel,
268 int aggr_idx, double misses,
269 struct perf_stat_output_ctx *out)
271 static const double color_ratios[3] = {20.0, 10.0, 5.0};
273 print_ratio(config, evsel, aggr_idx, misses, out, STAT_LL_CACHE, color_ratios,
274 "of all LL-cache accesses");
277 static void print_dtlb_miss(struct perf_stat_config *config,
278 const struct evsel *evsel,
279 int aggr_idx, double misses,
280 struct perf_stat_output_ctx *out)
282 static const double color_ratios[3] = {20.0, 10.0, 5.0};
284 print_ratio(config, evsel, aggr_idx, misses, out, STAT_DTLB_CACHE, color_ratios,
285 "of all dTLB cache accesses");
288 static void print_itlb_miss(struct perf_stat_config *config,
289 const struct evsel *evsel,
290 int aggr_idx, double misses,
291 struct perf_stat_output_ctx *out)
293 static const double color_ratios[3] = {20.0, 10.0, 5.0};
295 print_ratio(config, evsel, aggr_idx, misses, out, STAT_ITLB_CACHE, color_ratios,
296 "of all iTLB cache accesses");
299 static void print_cache_miss(struct perf_stat_config *config,
300 const struct evsel *evsel,
301 int aggr_idx, double misses,
302 struct perf_stat_output_ctx *out)
304 static const double color_ratios[3] = {20.0, 10.0, 5.0};
306 print_ratio(config, evsel, aggr_idx, misses, out, STAT_CACHE_REFS, color_ratios,
307 "of all cache refs");
310 static void print_instructions(struct perf_stat_config *config,
311 const struct evsel *evsel,
312 int aggr_idx, double instructions,
313 struct perf_stat_output_ctx *out)
315 print_metric_t print_metric = out->print_metric;
316 void *ctxp = out->ctx;
317 double cycles = find_stat(evsel, aggr_idx, STAT_CYCLES);
318 double max_stalled = max(find_stat(evsel, aggr_idx, STAT_STALLED_CYCLES_FRONT),
319 find_stat(evsel, aggr_idx, STAT_STALLED_CYCLES_BACK));
322 print_metric(config, ctxp, NULL, "%7.2f ", "insn per cycle",
323 instructions / cycles);
325 print_metric(config, ctxp, NULL, NULL, "insn per cycle", 0);
327 if (max_stalled && instructions) {
328 out->new_line(config, ctxp);
329 print_metric(config, ctxp, NULL, "%7.2f ", "stalled cycles per insn",
330 max_stalled / instructions);
334 static void print_cycles(struct perf_stat_config *config,
335 const struct evsel *evsel,
336 int aggr_idx, double cycles,
337 struct perf_stat_output_ctx *out)
339 double nsecs = find_stat(evsel, aggr_idx, STAT_NSECS);
341 if (cycles && nsecs) {
342 double ratio = cycles / nsecs;
344 out->print_metric(config, out->ctx, NULL, "%8.3f", "GHz", ratio);
346 out->print_metric(config, out->ctx, NULL, NULL, "GHz", 0);
349 static void print_nsecs(struct perf_stat_config *config,
350 const struct evsel *evsel,
351 int aggr_idx __maybe_unused, double nsecs,
352 struct perf_stat_output_ctx *out)
354 print_metric_t print_metric = out->print_metric;
355 void *ctxp = out->ctx;
356 double wall_time = avg_stats(&walltime_nsecs_stats);
359 print_metric(config, ctxp, NULL, "%8.3f", "CPUs utilized",
360 nsecs / (wall_time * evsel->scale));
362 print_metric(config, ctxp, NULL, NULL, "CPUs utilized", 0);
365 static int prepare_metric(const struct metric_expr *mexp,
366 const struct evsel *evsel,
367 struct expr_parse_ctx *pctx,
370 struct evsel * const *metric_events = mexp->metric_events;
371 struct metric_ref *metric_refs = mexp->metric_refs;
374 for (i = 0; metric_events[i]; i++) {
377 int source_count = 0;
379 if (evsel__is_tool(metric_events[i])) {
383 switch (metric_events[i]->tool_event) {
384 case PERF_TOOL_DURATION_TIME:
385 stats = &walltime_nsecs_stats;
388 case PERF_TOOL_USER_TIME:
389 stats = &ru_stats.ru_utime_usec_stat;
392 case PERF_TOOL_SYSTEM_TIME:
393 stats = &ru_stats.ru_stime_usec_stat;
397 pr_err("Invalid tool event 'none'");
400 pr_err("Invalid tool event 'max'");
403 pr_err("Unknown tool event '%s'", evsel__name(metric_events[i]));
406 val = avg_stats(stats) * scale;
409 struct perf_stat_evsel *ps = metric_events[i]->stats;
410 struct perf_stat_aggr *aggr;
413 * If there are multiple uncore PMUs and we're not
414 * reading the leader's stats, determine the stats for
415 * the appropriate uncore PMU.
417 if (evsel && evsel->metric_leader &&
418 evsel->pmu != evsel->metric_leader->pmu &&
419 mexp->metric_events[i]->pmu == evsel->metric_leader->pmu) {
422 evlist__for_each_entry(evsel->evlist, pos) {
423 if (pos->pmu != evsel->pmu)
425 if (pos->metric_leader != mexp->metric_events[i])
432 aggr = &ps->aggr[aggr_idx];
436 if (!metric_events[i]->supported) {
438 * Not supported events will have a count of 0,
439 * which can be confusing in a
440 * metric. Explicitly set the value to NAN. Not
441 * counted events (enable time of 0) are read as
447 val = aggr->counts.val;
449 source_count = evsel__source_count(metric_events[i]);
452 n = strdup(evsel__metric_id(metric_events[i]));
456 expr__add_id_val_source_count(pctx, n, val, source_count);
459 for (int j = 0; metric_refs && metric_refs[j].metric_name; j++) {
460 int ret = expr__add_ref(pctx, &metric_refs[j]);
469 static void generic_metric(struct perf_stat_config *config,
470 struct metric_expr *mexp,
473 struct perf_stat_output_ctx *out)
475 print_metric_t print_metric = out->print_metric;
476 const char *metric_name = mexp->metric_name;
477 const char *metric_expr = mexp->metric_expr;
478 const char *metric_threshold = mexp->metric_threshold;
479 const char *metric_unit = mexp->metric_unit;
480 struct evsel * const *metric_events = mexp->metric_events;
481 int runtime = mexp->runtime;
482 struct expr_parse_ctx *pctx;
483 double ratio, scale, threshold;
485 void *ctxp = out->ctx;
486 const char *color = NULL;
488 pctx = expr__ctx_new();
492 if (config->user_requested_cpu_list)
493 pctx->sctx.user_requested_cpu_list = strdup(config->user_requested_cpu_list);
494 pctx->sctx.runtime = runtime;
495 pctx->sctx.system_wide = config->system_wide;
496 i = prepare_metric(mexp, evsel, pctx, aggr_idx);
498 expr__ctx_free(pctx);
501 if (!metric_events[i]) {
502 if (expr__parse(&ratio, pctx, metric_expr) == 0) {
506 if (metric_threshold &&
507 expr__parse(&threshold, pctx, metric_threshold) == 0 &&
509 color = fpclassify(threshold) == FP_ZERO
510 ? PERF_COLOR_GREEN : PERF_COLOR_RED;
513 if (metric_unit && metric_name) {
514 if (perf_pmu__convert_scale(metric_unit,
515 &unit, &scale) >= 0) {
518 if (strstr(metric_expr, "?"))
519 scnprintf(metric_bf, sizeof(metric_bf),
520 "%s %s_%d", unit, metric_name, runtime);
522 scnprintf(metric_bf, sizeof(metric_bf),
523 "%s %s", unit, metric_name);
525 print_metric(config, ctxp, color, "%8.1f",
528 print_metric(config, ctxp, color, "%8.2f",
531 out->force_header ? evsel->name : "",
535 print_metric(config, ctxp, color, /*unit=*/NULL,
537 (metric_name ?: evsel->name) : "", 0);
540 print_metric(config, ctxp, color, /*unit=*/NULL,
542 (metric_name ?: evsel->name) : "", 0);
545 expr__ctx_free(pctx);
548 double test_generic_metric(struct metric_expr *mexp, int aggr_idx)
550 struct expr_parse_ctx *pctx;
553 pctx = expr__ctx_new();
557 if (prepare_metric(mexp, /*evsel=*/NULL, pctx, aggr_idx) < 0)
560 if (expr__parse(&ratio, pctx, mexp->metric_expr))
564 expr__ctx_free(pctx);
568 static void perf_stat__print_metricgroup_header(struct perf_stat_config *config,
572 struct perf_stat_output_ctx *out)
574 bool need_full_name = perf_pmus__num_core_pmus() > 1;
575 static const char *last_name;
576 static const char *last_pmu;
580 * A metricgroup may have several metric events,
581 * e.g.,TopdownL1 on e-core of ADL.
582 * The name has been output by the first metric
583 * event. Only align with other metics from
584 * different metric events.
586 if (last_name && !strcmp(last_name, name)) {
587 if (!need_full_name || !strcmp(last_pmu, evsel->pmu_name)) {
588 out->print_metricgroup_header(config, ctxp, NULL);
594 scnprintf(full_name, sizeof(full_name), "%s (%s)", name, evsel->pmu_name);
596 scnprintf(full_name, sizeof(full_name), "%s", name);
598 out->print_metricgroup_header(config, ctxp, full_name);
601 last_pmu = evsel->pmu_name;
605 * perf_stat__print_shadow_stats_metricgroup - Print out metrics associated with the evsel
606 * For the non-default, all metrics associated
607 * with the evsel are printed.
608 * For the default mode, only the metrics from
609 * the same metricgroup and the name of the
610 * metricgroup are printed. To print the metrics
611 * from the next metricgroup (if available),
612 * invoke the function with correspoinding
615 void *perf_stat__print_shadow_stats_metricgroup(struct perf_stat_config *config,
620 struct perf_stat_output_ctx *out,
621 struct rblist *metric_events)
623 struct metric_event *me;
624 struct metric_expr *mexp = from;
625 void *ctxp = out->ctx;
626 bool header_printed = false;
627 const char *name = NULL;
629 me = metricgroup__lookup(metric_events, evsel, false);
634 mexp = list_first_entry(&me->head, typeof(*mexp), nd);
636 list_for_each_entry_from(mexp, &me->head, nd) {
637 /* Print the display name of the Default metricgroup */
638 if (!config->metric_only && me->is_default) {
640 name = mexp->default_metricgroup_name;
642 * Two or more metricgroup may share the same metric
643 * event, e.g., TopdownL1 and TopdownL2 on SPR.
644 * Return and print the prefix, e.g., noise, running
645 * for the next metricgroup.
647 if (strcmp(name, mexp->default_metricgroup_name))
649 /* Only print the name of the metricgroup once */
650 if (!header_printed) {
651 header_printed = true;
652 perf_stat__print_metricgroup_header(config, evsel, ctxp,
658 out->new_line(config, ctxp);
659 generic_metric(config, mexp, evsel, aggr_idx, out);
665 void perf_stat__print_shadow_stats(struct perf_stat_config *config,
667 double avg, int aggr_idx,
668 struct perf_stat_output_ctx *out,
669 struct rblist *metric_events)
671 typedef void (*stat_print_function_t)(struct perf_stat_config *config,
672 const struct evsel *evsel,
673 int aggr_idx, double misses,
674 struct perf_stat_output_ctx *out);
675 static const stat_print_function_t stat_print_function[STAT_MAX] = {
676 [STAT_INSTRUCTIONS] = print_instructions,
677 [STAT_BRANCH_MISS] = print_branch_miss,
678 [STAT_L1D_MISS] = print_l1d_miss,
679 [STAT_L1I_MISS] = print_l1i_miss,
680 [STAT_DTLB_MISS] = print_dtlb_miss,
681 [STAT_ITLB_MISS] = print_itlb_miss,
682 [STAT_LL_MISS] = print_ll_miss,
683 [STAT_CACHE_MISSES] = print_cache_miss,
684 [STAT_STALLED_CYCLES_FRONT] = print_stalled_cycles_front,
685 [STAT_STALLED_CYCLES_BACK] = print_stalled_cycles_back,
686 [STAT_CYCLES] = print_cycles,
687 [STAT_NSECS] = print_nsecs,
689 print_metric_t print_metric = out->print_metric;
690 void *ctxp = out->ctx;
693 if (config->iostat_run) {
694 iostat_print_metric(config, evsel, out);
696 stat_print_function_t fn = stat_print_function[evsel__stat_type(evsel)];
699 fn(config, evsel, aggr_idx, avg, out);
701 double nsecs = find_stat(evsel, aggr_idx, STAT_NSECS);
705 char unit_buf[10] = "/sec";
706 double ratio = convert_unit_double(1000000000.0 * avg / nsecs,
710 snprintf(unit_buf, sizeof(unit_buf), "%c/sec", unit);
711 print_metric(config, ctxp, NULL, "%8.3f", unit_buf, ratio);
717 perf_stat__print_shadow_stats_metricgroup(config, evsel, aggr_idx,
718 &num, NULL, out, metric_events);
721 print_metric(config, ctxp, NULL, NULL, NULL, 0);
725 * perf_stat__skip_metric_event - Skip the evsel in the Default metricgroup,
726 * if it's not running or not the metric event.
728 bool perf_stat__skip_metric_event(struct evsel *evsel,
729 struct rblist *metric_events,
732 if (!evsel->default_metricgroup)
738 return !metricgroup__lookup(metric_events, evsel, false);