1 // SPDX-License-Identifier: GPL-2.0
5 * Builtin list command: list all event types
13 #include "util/print-events.h"
14 #include "util/pmus.h"
16 #include "util/debug.h"
17 #include "util/metricgroup.h"
19 #include "util/string2.h"
20 #include "util/strlist.h"
21 #include "util/strbuf.h"
22 #include <subcmd/pager.h>
23 #include <subcmd/parse-options.h>
24 #include <linux/zalloc.h>
30 * struct print_state - State and configuration passed to the default_print
34 /** @fp: File to write output to. */
37 * @pmu_glob: Optionally restrict PMU and metric matching to PMU or
38 * debugfs subsystem name.
41 /** @event_glob: Optional pattern matching glob. */
43 /** @name_only: Print event or metric names only. */
45 /** @desc: Print the event or metric description. */
47 /** @long_desc: Print longer event or metric description. */
49 /** @deprecated: Print deprecated events or metrics. */
52 * @detailed: Print extra information on the perf event such as names
53 * and expressions used internally by events.
56 /** @metrics: Controls printing of metric and metric groups. */
58 /** @metricgroups: Controls printing of metric and metric groups. */
60 /** @last_topic: The last printed event topic. */
62 /** @last_metricgroups: The last printed metric group. */
63 char *last_metricgroups;
64 /** @visited_metrics: Metrics that are printed to avoid duplicates. */
65 struct strlist *visited_metrics;
68 static void default_print_start(void *ps)
70 struct print_state *print_state = ps;
72 if (!print_state->name_only && pager_in_use()) {
73 fprintf(print_state->fp,
74 "\nList of pre-defined events (to be used in -e or -M):\n\n");
78 static void default_print_end(void *print_state __maybe_unused) {}
80 static const char *skip_spaces_or_commas(const char *str)
82 while (isspace(*str) || *str == ',')
87 static void wordwrap(FILE *fp, const char *s, int start, int max, int corr)
91 bool saw_newline = false;
95 int wlen = strcspn(s, " ,\t\n");
96 const char *sep = comma ? "," : " ";
98 if ((column + wlen >= max && column > start) || saw_newline) {
99 fprintf(fp, comma ? ",\n%*s" : "\n%*s", start, "");
100 column = start + corr;
104 n = fprintf(fp, "%s%.*s", sep, wlen, s);
107 saw_newline = s[wlen] == '\n';
111 s = skip_spaces_or_commas(s);
115 static void default_print_event(void *ps, const char *pmu_name, const char *topic,
116 const char *event_name, const char *event_alias,
117 const char *scale_unit __maybe_unused,
118 bool deprecated, const char *event_type_desc,
119 const char *desc, const char *long_desc,
120 const char *encoding_desc)
122 struct print_state *print_state = ps;
124 FILE *fp = print_state->fp;
126 if (deprecated && !print_state->deprecated)
129 if (print_state->pmu_glob && pmu_name && !strglobmatch(pmu_name, print_state->pmu_glob))
132 if (print_state->event_glob &&
133 (!event_name || !strglobmatch(event_name, print_state->event_glob)) &&
134 (!event_alias || !strglobmatch(event_alias, print_state->event_glob)) &&
135 (!topic || !strglobmatch_nocase(topic, print_state->event_glob)))
138 if (print_state->name_only) {
139 if (event_alias && strlen(event_alias))
140 fprintf(fp, "%s ", event_alias);
142 fprintf(fp, "%s ", event_name);
146 if (strcmp(print_state->last_topic, topic ?: "")) {
148 fprintf(fp, "\n%s:\n", topic);
149 zfree(&print_state->last_topic);
150 print_state->last_topic = strdup(topic ?: "");
153 if (event_alias && strlen(event_alias))
154 pos = fprintf(fp, " %s OR %s", event_name, event_alias);
156 pos = fprintf(fp, " %s", event_name);
158 if (!topic && event_type_desc) {
159 for (; pos < 53; pos++)
161 fprintf(fp, "[%s]\n", event_type_desc);
165 if (desc && print_state->desc) {
166 char *desc_with_unit = NULL;
169 if (pmu_name && strcmp(pmu_name, "default_core")) {
170 desc_len = strlen(desc);
171 desc_len = asprintf(&desc_with_unit,
172 desc[desc_len - 1] != '.'
173 ? "%s. Unit: %s" : "%s Unit: %s",
176 fprintf(fp, "%*s", 8, "[");
177 wordwrap(fp, desc_len > 0 ? desc_with_unit : desc, 8, pager_get_columns(), 0);
179 free(desc_with_unit);
181 long_desc = long_desc ?: desc;
182 if (long_desc && print_state->long_desc) {
183 fprintf(fp, "%*s", 8, "[");
184 wordwrap(fp, long_desc, 8, pager_get_columns(), 0);
188 if (print_state->detailed && encoding_desc) {
189 fprintf(fp, "%*s", 8, "");
190 wordwrap(fp, encoding_desc, 8, pager_get_columns(), 0);
195 static void default_print_metric(void *ps,
199 const char *long_desc,
201 const char *threshold,
202 const char *unit __maybe_unused)
204 struct print_state *print_state = ps;
205 FILE *fp = print_state->fp;
207 if (print_state->event_glob &&
208 (!print_state->metrics || !name || !strglobmatch(name, print_state->event_glob)) &&
209 (!print_state->metricgroups || !group || !strglobmatch(group, print_state->event_glob)))
212 if (!print_state->name_only && !print_state->last_metricgroups) {
213 if (print_state->metricgroups) {
214 fprintf(fp, "\nMetric Groups:\n");
215 if (!print_state->metrics)
218 fprintf(fp, "\nMetrics:\n\n");
221 if (!print_state->last_metricgroups ||
222 strcmp(print_state->last_metricgroups, group ?: "")) {
223 if (group && print_state->metricgroups) {
224 if (print_state->name_only) {
225 fprintf(fp, "%s ", group);
227 const char *gdesc = print_state->desc
228 ? describe_metricgroup(group)
230 const char *print_colon = "";
232 if (print_state->metrics) {
238 fprintf(fp, "%s%s [%s]\n", group, print_colon, gdesc);
240 fprintf(fp, "%s%s\n", group, print_colon);
243 zfree(&print_state->last_metricgroups);
244 print_state->last_metricgroups = strdup(group ?: "");
246 if (!print_state->metrics)
249 if (print_state->name_only) {
250 if (print_state->metrics &&
251 !strlist__has_entry(print_state->visited_metrics, name)) {
252 fprintf(fp, "%s ", name);
253 strlist__add(print_state->visited_metrics, name);
257 fprintf(fp, " %s\n", name);
259 if (desc && print_state->desc) {
260 fprintf(fp, "%*s", 8, "[");
261 wordwrap(fp, desc, 8, pager_get_columns(), 0);
264 if (long_desc && print_state->long_desc) {
265 fprintf(fp, "%*s", 8, "[");
266 wordwrap(fp, long_desc, 8, pager_get_columns(), 0);
269 if (expr && print_state->detailed) {
270 fprintf(fp, "%*s", 8, "[");
271 wordwrap(fp, expr, 8, pager_get_columns(), 0);
274 if (threshold && print_state->detailed) {
275 fprintf(fp, "%*s", 8, "[");
276 wordwrap(fp, threshold, 8, pager_get_columns(), 0);
281 struct json_print_state {
282 /** @fp: File to write output to. */
284 /** Should a separator be printed prior to the next item? */
288 static void json_print_start(void *ps)
290 struct json_print_state *print_state = ps;
291 FILE *fp = print_state->fp;
296 static void json_print_end(void *ps)
298 struct json_print_state *print_state = ps;
299 FILE *fp = print_state->fp;
301 fprintf(fp, "%s]\n", print_state->need_sep ? "\n" : "");
304 static void fix_escape_fprintf(FILE *fp, struct strbuf *buf, const char *fmt, ...)
309 strbuf_setlen(buf, 0);
310 for (size_t fmt_pos = 0; fmt_pos < strlen(fmt); fmt_pos++) {
311 switch (fmt[fmt_pos]) {
314 switch (fmt[fmt_pos]) {
316 const char *s = va_arg(args, const char*);
318 strbuf_addstr(buf, s);
322 const char *s = va_arg(args, const char*);
324 for (size_t s_pos = 0; s_pos < strlen(s); s_pos++) {
327 strbuf_addstr(buf, "\\n");
330 strbuf_addstr(buf, "\\r");
335 strbuf_addch(buf, '\\');
338 strbuf_addch(buf, s[s_pos]);
345 pr_err("Unexpected format character '%c'\n", fmt[fmt_pos]);
346 strbuf_addch(buf, '%');
347 strbuf_addch(buf, fmt[fmt_pos]);
351 strbuf_addch(buf, fmt[fmt_pos]);
359 static void json_print_event(void *ps, const char *pmu_name, const char *topic,
360 const char *event_name, const char *event_alias,
361 const char *scale_unit,
362 bool deprecated, const char *event_type_desc,
363 const char *desc, const char *long_desc,
364 const char *encoding_desc)
366 struct json_print_state *print_state = ps;
367 bool need_sep = false;
368 FILE *fp = print_state->fp;
371 strbuf_init(&buf, 0);
372 fprintf(fp, "%s{\n", print_state->need_sep ? ",\n" : "");
373 print_state->need_sep = true;
375 fix_escape_fprintf(fp, &buf, "\t\"Unit\": \"%S\"", pmu_name);
379 fix_escape_fprintf(fp, &buf, "%s\t\"Topic\": \"%S\"",
380 need_sep ? ",\n" : "",
385 fix_escape_fprintf(fp, &buf, "%s\t\"EventName\": \"%S\"",
386 need_sep ? ",\n" : "",
390 if (event_alias && strlen(event_alias)) {
391 fix_escape_fprintf(fp, &buf, "%s\t\"EventAlias\": \"%S\"",
392 need_sep ? ",\n" : "",
396 if (scale_unit && strlen(scale_unit)) {
397 fix_escape_fprintf(fp, &buf, "%s\t\"ScaleUnit\": \"%S\"",
398 need_sep ? ",\n" : "",
402 if (event_type_desc) {
403 fix_escape_fprintf(fp, &buf, "%s\t\"EventType\": \"%S\"",
404 need_sep ? ",\n" : "",
409 fix_escape_fprintf(fp, &buf, "%s\t\"Deprecated\": \"%S\"",
410 need_sep ? ",\n" : "",
411 deprecated ? "1" : "0");
415 fix_escape_fprintf(fp, &buf, "%s\t\"BriefDescription\": \"%S\"",
416 need_sep ? ",\n" : "",
421 fix_escape_fprintf(fp, &buf, "%s\t\"PublicDescription\": \"%S\"",
422 need_sep ? ",\n" : "",
427 fix_escape_fprintf(fp, &buf, "%s\t\"Encoding\": \"%S\"",
428 need_sep ? ",\n" : "",
432 fprintf(fp, "%s}", need_sep ? "\n" : "");
433 strbuf_release(&buf);
436 static void json_print_metric(void *ps __maybe_unused, const char *group,
437 const char *name, const char *desc,
438 const char *long_desc, const char *expr,
439 const char *threshold, const char *unit)
441 struct json_print_state *print_state = ps;
442 bool need_sep = false;
443 FILE *fp = print_state->fp;
446 strbuf_init(&buf, 0);
447 fprintf(fp, "%s{\n", print_state->need_sep ? ",\n" : "");
448 print_state->need_sep = true;
450 fix_escape_fprintf(fp, &buf, "\t\"MetricGroup\": \"%S\"", group);
454 fix_escape_fprintf(fp, &buf, "%s\t\"MetricName\": \"%S\"",
455 need_sep ? ",\n" : "",
460 fix_escape_fprintf(fp, &buf, "%s\t\"MetricExpr\": \"%S\"",
461 need_sep ? ",\n" : "",
466 fix_escape_fprintf(fp, &buf, "%s\t\"MetricThreshold\": \"%S\"",
467 need_sep ? ",\n" : "",
472 fix_escape_fprintf(fp, &buf, "%s\t\"ScaleUnit\": \"%S\"",
473 need_sep ? ",\n" : "",
478 fix_escape_fprintf(fp, &buf, "%s\t\"BriefDescription\": \"%S\"",
479 need_sep ? ",\n" : "",
484 fix_escape_fprintf(fp, &buf, "%s\t\"PublicDescription\": \"%S\"",
485 need_sep ? ",\n" : "",
489 fprintf(fp, "%s}", need_sep ? "\n" : "");
490 strbuf_release(&buf);
493 static bool json_skip_duplicate_pmus(void *ps __maybe_unused)
498 static bool default_skip_duplicate_pmus(void *ps)
500 struct print_state *print_state = ps;
502 return !print_state->long_desc;
505 int cmd_list(int argc, const char **argv)
508 struct print_state default_ps = {
511 struct print_state json_ps = {
514 void *ps = &default_ps;
515 struct print_callbacks print_cb = {
516 .print_start = default_print_start,
517 .print_end = default_print_end,
518 .print_event = default_print_event,
519 .print_metric = default_print_metric,
520 .skip_duplicate_pmus = default_skip_duplicate_pmus,
522 const char *cputype = NULL;
523 const char *unit_name = NULL;
524 const char *output_path = NULL;
526 struct option list_options[] = {
527 OPT_BOOLEAN(0, "raw-dump", &default_ps.name_only, "Dump raw events"),
528 OPT_BOOLEAN('j', "json", &json, "JSON encode events and metrics"),
529 OPT_BOOLEAN('d', "desc", &default_ps.desc,
530 "Print extra event descriptions. --no-desc to not print."),
531 OPT_BOOLEAN('v', "long-desc", &default_ps.long_desc,
532 "Print longer event descriptions."),
533 OPT_BOOLEAN(0, "details", &default_ps.detailed,
534 "Print information on the perf event names and expressions used internally by events."),
535 OPT_STRING('o', "output", &output_path, "file", "output file name"),
536 OPT_BOOLEAN(0, "deprecated", &default_ps.deprecated,
537 "Print deprecated events."),
538 OPT_STRING(0, "cputype", &cputype, "cpu type",
539 "Limit PMU or metric printing to the given PMU (e.g. cpu, core or atom)."),
540 OPT_STRING(0, "unit", &unit_name, "PMU name",
541 "Limit PMU or metric printing to the specified PMU."),
542 OPT_INCR(0, "debug", &verbose,
543 "Enable debugging output"),
546 const char * const list_usage[] = {
548 "perf list [<options>] [hw|sw|cache|tracepoint|pmu|sdt|metric|metricgroup|event_glob|pfm]",
550 "perf list [<options>] [hw|sw|cache|tracepoint|pmu|sdt|metric|metricgroup|event_glob]",
555 set_option_flag(list_options, 0, "raw-dump", PARSE_OPT_HIDDEN);
556 /* Hide hybrid flag for the more generic 'unit' flag. */
557 set_option_flag(list_options, 0, "cputype", PARSE_OPT_HIDDEN);
559 argc = parse_options(argc, argv, list_options, list_usage,
560 PARSE_OPT_STOP_AT_NON_OPTION);
563 default_ps.fp = fopen(output_path, "w");
564 json_ps.fp = default_ps.fp;
569 if (!default_ps.name_only)
573 print_cb = (struct print_callbacks){
574 .print_start = json_print_start,
575 .print_end = json_print_end,
576 .print_event = json_print_event,
577 .print_metric = json_print_metric,
578 .skip_duplicate_pmus = json_skip_duplicate_pmus,
582 default_ps.desc = !default_ps.long_desc;
583 default_ps.last_topic = strdup("");
584 assert(default_ps.last_topic);
585 default_ps.visited_metrics = strlist__new(NULL, NULL);
586 assert(default_ps.visited_metrics);
588 default_ps.pmu_glob = strdup(unit_name);
590 const struct perf_pmu *pmu = perf_pmus__pmu_for_pmu_filter(cputype);
593 pr_err("ERROR: cputype is not supported!\n");
597 default_ps.pmu_glob = strdup(pmu->name);
600 print_cb.print_start(ps);
603 default_ps.metrics = true;
604 default_ps.metricgroups = true;
605 print_events(&print_cb, ps);
609 for (i = 0; i < argc; ++i) {
612 if (strcmp(argv[i], "tracepoint") == 0)
613 print_tracepoint_events(&print_cb, ps);
614 else if (strcmp(argv[i], "hw") == 0 ||
615 strcmp(argv[i], "hardware") == 0)
616 print_symbol_events(&print_cb, ps, PERF_TYPE_HARDWARE,
617 event_symbols_hw, PERF_COUNT_HW_MAX);
618 else if (strcmp(argv[i], "sw") == 0 ||
619 strcmp(argv[i], "software") == 0) {
620 print_symbol_events(&print_cb, ps, PERF_TYPE_SOFTWARE,
621 event_symbols_sw, PERF_COUNT_SW_MAX);
622 print_tool_events(&print_cb, ps);
623 } else if (strcmp(argv[i], "cache") == 0 ||
624 strcmp(argv[i], "hwcache") == 0)
625 print_hwcache_events(&print_cb, ps);
626 else if (strcmp(argv[i], "pmu") == 0)
627 perf_pmus__print_pmu_events(&print_cb, ps);
628 else if (strcmp(argv[i], "sdt") == 0)
629 print_sdt_events(&print_cb, ps);
630 else if (strcmp(argv[i], "metric") == 0 || strcmp(argv[i], "metrics") == 0) {
631 default_ps.metricgroups = false;
632 default_ps.metrics = true;
633 metricgroup__print(&print_cb, ps);
634 } else if (strcmp(argv[i], "metricgroup") == 0 ||
635 strcmp(argv[i], "metricgroups") == 0) {
636 default_ps.metricgroups = true;
637 default_ps.metrics = false;
638 metricgroup__print(&print_cb, ps);
641 else if (strcmp(argv[i], "pfm") == 0)
642 print_libpfm_events(&print_cb, ps);
644 else if ((sep = strchr(argv[i], ':')) != NULL) {
645 char *old_pmu_glob = default_ps.pmu_glob;
647 default_ps.event_glob = strdup(argv[i]);
648 if (!default_ps.event_glob) {
653 print_tracepoint_events(&print_cb, ps);
654 print_sdt_events(&print_cb, ps);
655 default_ps.metrics = true;
656 default_ps.metricgroups = true;
657 metricgroup__print(&print_cb, ps);
658 zfree(&default_ps.event_glob);
659 default_ps.pmu_glob = old_pmu_glob;
661 if (asprintf(&s, "*%s*", argv[i]) < 0) {
662 printf("Critical: Not enough memory! Trying to continue...\n");
665 default_ps.event_glob = s;
666 print_symbol_events(&print_cb, ps, PERF_TYPE_HARDWARE,
667 event_symbols_hw, PERF_COUNT_HW_MAX);
668 print_symbol_events(&print_cb, ps, PERF_TYPE_SOFTWARE,
669 event_symbols_sw, PERF_COUNT_SW_MAX);
670 print_tool_events(&print_cb, ps);
671 print_hwcache_events(&print_cb, ps);
672 perf_pmus__print_pmu_events(&print_cb, ps);
673 print_tracepoint_events(&print_cb, ps);
674 print_sdt_events(&print_cb, ps);
675 default_ps.metrics = true;
676 default_ps.metricgroups = true;
677 metricgroup__print(&print_cb, ps);
683 print_cb.print_end(ps);
684 free(default_ps.pmu_glob);
685 free(default_ps.last_topic);
686 free(default_ps.last_metricgroups);
687 strlist__delete(default_ps.visited_metrics);
689 fclose(default_ps.fp);