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>
29 * struct print_state - State and configuration passed to the default_print
34 * @pmu_glob: Optionally restrict PMU and metric matching to PMU or
35 * debugfs subsystem name.
38 /** @event_glob: Optional pattern matching glob. */
40 /** @name_only: Print event or metric names only. */
42 /** @desc: Print the event or metric description. */
44 /** @long_desc: Print longer event or metric description. */
46 /** @deprecated: Print deprecated events or metrics. */
49 * @detailed: Print extra information on the perf event such as names
50 * and expressions used internally by events.
53 /** @metrics: Controls printing of metric and metric groups. */
55 /** @metricgroups: Controls printing of metric and metric groups. */
57 /** @last_topic: The last printed event topic. */
59 /** @last_metricgroups: The last printed metric group. */
60 char *last_metricgroups;
61 /** @visited_metrics: Metrics that are printed to avoid duplicates. */
62 struct strlist *visited_metrics;
65 static void default_print_start(void *ps)
67 struct print_state *print_state = ps;
69 if (!print_state->name_only && pager_in_use())
70 printf("\nList of pre-defined events (to be used in -e or -M):\n\n");
73 static void default_print_end(void *print_state __maybe_unused) {}
75 static void wordwrap(const char *s, int start, int max, int corr)
79 bool saw_newline = false;
82 int wlen = strcspn(s, " \t\n");
84 if ((column + wlen >= max && column > start) || saw_newline) {
85 printf("\n%*s", start, "");
86 column = start + corr;
88 n = printf("%s%.*s", column > start ? " " : "", wlen, s);
91 saw_newline = s[wlen] == '\n';
98 static void default_print_event(void *ps, const char *pmu_name, const char *topic,
99 const char *event_name, const char *event_alias,
100 const char *scale_unit __maybe_unused,
101 bool deprecated, const char *event_type_desc,
102 const char *desc, const char *long_desc,
103 const char *encoding_desc)
105 struct print_state *print_state = ps;
108 if (deprecated && !print_state->deprecated)
111 if (print_state->pmu_glob && pmu_name && !strglobmatch(pmu_name, print_state->pmu_glob))
114 if (print_state->event_glob &&
115 (!event_name || !strglobmatch(event_name, print_state->event_glob)) &&
116 (!event_alias || !strglobmatch(event_alias, print_state->event_glob)) &&
117 (!topic || !strglobmatch_nocase(topic, print_state->event_glob)))
120 if (print_state->name_only) {
121 if (event_alias && strlen(event_alias))
122 printf("%s ", event_alias);
124 printf("%s ", event_name);
128 if (strcmp(print_state->last_topic, topic ?: "")) {
130 printf("\n%s:\n", topic);
131 zfree(&print_state->last_topic);
132 print_state->last_topic = strdup(topic ?: "");
135 if (event_alias && strlen(event_alias))
136 pos = printf(" %s OR %s", event_name, event_alias);
138 pos = printf(" %s", event_name);
140 if (!topic && event_type_desc) {
141 for (; pos < 53; pos++)
143 printf("[%s]\n", event_type_desc);
147 if (desc && print_state->desc) {
148 char *desc_with_unit = NULL;
151 if (pmu_name && strcmp(pmu_name, "default_core")) {
152 desc_len = strlen(desc);
153 desc_len = asprintf(&desc_with_unit,
154 desc[desc_len - 1] != '.'
155 ? "%s. Unit: %s" : "%s Unit: %s",
158 printf("%*s", 8, "[");
159 wordwrap(desc_len > 0 ? desc_with_unit : desc, 8, pager_get_columns(), 0);
161 free(desc_with_unit);
163 long_desc = long_desc ?: desc;
164 if (long_desc && print_state->long_desc) {
165 printf("%*s", 8, "[");
166 wordwrap(long_desc, 8, pager_get_columns(), 0);
170 if (print_state->detailed && encoding_desc) {
171 printf("%*s", 8, "");
172 wordwrap(encoding_desc, 8, pager_get_columns(), 0);
177 static void default_print_metric(void *ps,
181 const char *long_desc,
183 const char *threshold,
184 const char *unit __maybe_unused)
186 struct print_state *print_state = ps;
188 if (print_state->event_glob &&
189 (!print_state->metrics || !name || !strglobmatch(name, print_state->event_glob)) &&
190 (!print_state->metricgroups || !group || !strglobmatch(group, print_state->event_glob)))
193 if (!print_state->name_only && !print_state->last_metricgroups) {
194 if (print_state->metricgroups) {
195 printf("\nMetric Groups:\n");
196 if (!print_state->metrics)
199 printf("\nMetrics:\n\n");
202 if (!print_state->last_metricgroups ||
203 strcmp(print_state->last_metricgroups, group ?: "")) {
204 if (group && print_state->metricgroups) {
205 if (print_state->name_only)
206 printf("%s ", group);
207 else if (print_state->metrics) {
208 const char *gdesc = describe_metricgroup(group);
211 printf("\n%s: [%s]\n", group, gdesc);
213 printf("\n%s:\n", group);
215 printf("%s\n", group);
217 zfree(&print_state->last_metricgroups);
218 print_state->last_metricgroups = strdup(group ?: "");
220 if (!print_state->metrics)
223 if (print_state->name_only) {
224 if (print_state->metrics &&
225 !strlist__has_entry(print_state->visited_metrics, name)) {
227 strlist__add(print_state->visited_metrics, name);
231 printf(" %s\n", name);
233 if (desc && print_state->desc) {
234 printf("%*s", 8, "[");
235 wordwrap(desc, 8, pager_get_columns(), 0);
238 if (long_desc && print_state->long_desc) {
239 printf("%*s", 8, "[");
240 wordwrap(long_desc, 8, pager_get_columns(), 0);
243 if (expr && print_state->detailed) {
244 printf("%*s", 8, "[");
245 wordwrap(expr, 8, pager_get_columns(), 0);
248 if (threshold && print_state->detailed) {
249 printf("%*s", 8, "[");
250 wordwrap(threshold, 8, pager_get_columns(), 0);
255 struct json_print_state {
256 /** Should a separator be printed prior to the next item? */
260 static void json_print_start(void *print_state __maybe_unused)
265 static void json_print_end(void *ps)
267 struct json_print_state *print_state = ps;
269 printf("%s]\n", print_state->need_sep ? "\n" : "");
272 static void fix_escape_printf(struct strbuf *buf, const char *fmt, ...)
277 strbuf_setlen(buf, 0);
278 for (size_t fmt_pos = 0; fmt_pos < strlen(fmt); fmt_pos++) {
279 switch (fmt[fmt_pos]) {
282 switch (fmt[fmt_pos]) {
284 const char *s = va_arg(args, const char*);
286 strbuf_addstr(buf, s);
290 const char *s = va_arg(args, const char*);
292 for (size_t s_pos = 0; s_pos < strlen(s); s_pos++) {
295 strbuf_addstr(buf, "\\n");
300 strbuf_addch(buf, '\\');
303 strbuf_addch(buf, s[s_pos]);
310 pr_err("Unexpected format character '%c'\n", fmt[fmt_pos]);
311 strbuf_addch(buf, '%');
312 strbuf_addch(buf, fmt[fmt_pos]);
316 strbuf_addch(buf, fmt[fmt_pos]);
321 fputs(buf->buf, stdout);
324 static void json_print_event(void *ps, const char *pmu_name, const char *topic,
325 const char *event_name, const char *event_alias,
326 const char *scale_unit,
327 bool deprecated, const char *event_type_desc,
328 const char *desc, const char *long_desc,
329 const char *encoding_desc)
331 struct json_print_state *print_state = ps;
332 bool need_sep = false;
335 strbuf_init(&buf, 0);
336 printf("%s{\n", print_state->need_sep ? ",\n" : "");
337 print_state->need_sep = true;
339 fix_escape_printf(&buf, "\t\"Unit\": \"%S\"", pmu_name);
343 fix_escape_printf(&buf, "%s\t\"Topic\": \"%S\"", need_sep ? ",\n" : "", topic);
347 fix_escape_printf(&buf, "%s\t\"EventName\": \"%S\"", need_sep ? ",\n" : "",
351 if (event_alias && strlen(event_alias)) {
352 fix_escape_printf(&buf, "%s\t\"EventAlias\": \"%S\"", need_sep ? ",\n" : "",
356 if (scale_unit && strlen(scale_unit)) {
357 fix_escape_printf(&buf, "%s\t\"ScaleUnit\": \"%S\"", need_sep ? ",\n" : "",
361 if (event_type_desc) {
362 fix_escape_printf(&buf, "%s\t\"EventType\": \"%S\"", need_sep ? ",\n" : "",
367 fix_escape_printf(&buf, "%s\t\"Deprecated\": \"%S\"", need_sep ? ",\n" : "",
368 deprecated ? "1" : "0");
372 fix_escape_printf(&buf, "%s\t\"BriefDescription\": \"%S\"", need_sep ? ",\n" : "",
377 fix_escape_printf(&buf, "%s\t\"PublicDescription\": \"%S\"", need_sep ? ",\n" : "",
382 fix_escape_printf(&buf, "%s\t\"Encoding\": \"%S\"", need_sep ? ",\n" : "",
386 printf("%s}", need_sep ? "\n" : "");
387 strbuf_release(&buf);
390 static void json_print_metric(void *ps __maybe_unused, const char *group,
391 const char *name, const char *desc,
392 const char *long_desc, const char *expr,
393 const char *threshold, const char *unit)
395 struct json_print_state *print_state = ps;
396 bool need_sep = false;
399 strbuf_init(&buf, 0);
400 printf("%s{\n", print_state->need_sep ? ",\n" : "");
401 print_state->need_sep = true;
403 fix_escape_printf(&buf, "\t\"MetricGroup\": \"%S\"", group);
407 fix_escape_printf(&buf, "%s\t\"MetricName\": \"%S\"", need_sep ? ",\n" : "", name);
411 fix_escape_printf(&buf, "%s\t\"MetricExpr\": \"%S\"", need_sep ? ",\n" : "", expr);
415 fix_escape_printf(&buf, "%s\t\"MetricThreshold\": \"%S\"", need_sep ? ",\n" : "",
420 fix_escape_printf(&buf, "%s\t\"ScaleUnit\": \"%S\"", need_sep ? ",\n" : "", unit);
424 fix_escape_printf(&buf, "%s\t\"BriefDescription\": \"%S\"", need_sep ? ",\n" : "",
429 fix_escape_printf(&buf, "%s\t\"PublicDescription\": \"%S\"", need_sep ? ",\n" : "",
433 printf("%s}", need_sep ? "\n" : "");
434 strbuf_release(&buf);
437 static bool json_skip_duplicate_pmus(void *ps __maybe_unused)
442 static bool default_skip_duplicate_pmus(void *ps)
444 struct print_state *print_state = ps;
446 return !print_state->long_desc;
449 int cmd_list(int argc, const char **argv)
452 struct print_state default_ps = {};
453 struct print_state json_ps = {};
454 void *ps = &default_ps;
455 struct print_callbacks print_cb = {
456 .print_start = default_print_start,
457 .print_end = default_print_end,
458 .print_event = default_print_event,
459 .print_metric = default_print_metric,
460 .skip_duplicate_pmus = default_skip_duplicate_pmus,
462 const char *cputype = NULL;
463 const char *unit_name = NULL;
465 struct option list_options[] = {
466 OPT_BOOLEAN(0, "raw-dump", &default_ps.name_only, "Dump raw events"),
467 OPT_BOOLEAN('j', "json", &json, "JSON encode events and metrics"),
468 OPT_BOOLEAN('d', "desc", &default_ps.desc,
469 "Print extra event descriptions. --no-desc to not print."),
470 OPT_BOOLEAN('v', "long-desc", &default_ps.long_desc,
471 "Print longer event descriptions."),
472 OPT_BOOLEAN(0, "details", &default_ps.detailed,
473 "Print information on the perf event names and expressions used internally by events."),
474 OPT_BOOLEAN(0, "deprecated", &default_ps.deprecated,
475 "Print deprecated events."),
476 OPT_STRING(0, "cputype", &cputype, "cpu type",
477 "Limit PMU or metric printing to the given PMU (e.g. cpu, core or atom)."),
478 OPT_STRING(0, "unit", &unit_name, "PMU name",
479 "Limit PMU or metric printing to the specified PMU."),
480 OPT_INCR(0, "debug", &verbose,
481 "Enable debugging output"),
484 const char * const list_usage[] = {
486 "perf list [<options>] [hw|sw|cache|tracepoint|pmu|sdt|metric|metricgroup|event_glob|pfm]",
488 "perf list [<options>] [hw|sw|cache|tracepoint|pmu|sdt|metric|metricgroup|event_glob]",
493 set_option_flag(list_options, 0, "raw-dump", PARSE_OPT_HIDDEN);
494 /* Hide hybrid flag for the more generic 'unit' flag. */
495 set_option_flag(list_options, 0, "cputype", PARSE_OPT_HIDDEN);
497 argc = parse_options(argc, argv, list_options, list_usage,
498 PARSE_OPT_STOP_AT_NON_OPTION);
502 if (!default_ps.name_only)
506 print_cb = (struct print_callbacks){
507 .print_start = json_print_start,
508 .print_end = json_print_end,
509 .print_event = json_print_event,
510 .print_metric = json_print_metric,
511 .skip_duplicate_pmus = json_skip_duplicate_pmus,
515 default_ps.desc = !default_ps.long_desc;
516 default_ps.last_topic = strdup("");
517 assert(default_ps.last_topic);
518 default_ps.visited_metrics = strlist__new(NULL, NULL);
519 assert(default_ps.visited_metrics);
521 default_ps.pmu_glob = strdup(unit_name);
523 const struct perf_pmu *pmu = perf_pmus__pmu_for_pmu_filter(cputype);
526 pr_err("ERROR: cputype is not supported!\n");
530 default_ps.pmu_glob = strdup(pmu->name);
533 print_cb.print_start(ps);
536 default_ps.metrics = true;
537 default_ps.metricgroups = true;
538 print_events(&print_cb, ps);
542 for (i = 0; i < argc; ++i) {
545 if (strcmp(argv[i], "tracepoint") == 0)
546 print_tracepoint_events(&print_cb, ps);
547 else if (strcmp(argv[i], "hw") == 0 ||
548 strcmp(argv[i], "hardware") == 0)
549 print_symbol_events(&print_cb, ps, PERF_TYPE_HARDWARE,
550 event_symbols_hw, PERF_COUNT_HW_MAX);
551 else if (strcmp(argv[i], "sw") == 0 ||
552 strcmp(argv[i], "software") == 0) {
553 print_symbol_events(&print_cb, ps, PERF_TYPE_SOFTWARE,
554 event_symbols_sw, PERF_COUNT_SW_MAX);
555 print_tool_events(&print_cb, ps);
556 } else if (strcmp(argv[i], "cache") == 0 ||
557 strcmp(argv[i], "hwcache") == 0)
558 print_hwcache_events(&print_cb, ps);
559 else if (strcmp(argv[i], "pmu") == 0)
560 perf_pmus__print_pmu_events(&print_cb, ps);
561 else if (strcmp(argv[i], "sdt") == 0)
562 print_sdt_events(&print_cb, ps);
563 else if (strcmp(argv[i], "metric") == 0 || strcmp(argv[i], "metrics") == 0) {
564 default_ps.metricgroups = false;
565 default_ps.metrics = true;
566 metricgroup__print(&print_cb, ps);
567 } else if (strcmp(argv[i], "metricgroup") == 0 ||
568 strcmp(argv[i], "metricgroups") == 0) {
569 default_ps.metricgroups = true;
570 default_ps.metrics = false;
571 metricgroup__print(&print_cb, ps);
574 else if (strcmp(argv[i], "pfm") == 0)
575 print_libpfm_events(&print_cb, ps);
577 else if ((sep = strchr(argv[i], ':')) != NULL) {
578 char *old_pmu_glob = default_ps.pmu_glob;
580 default_ps.event_glob = strdup(argv[i]);
581 if (!default_ps.event_glob) {
586 print_tracepoint_events(&print_cb, ps);
587 print_sdt_events(&print_cb, ps);
588 default_ps.metrics = true;
589 default_ps.metricgroups = true;
590 metricgroup__print(&print_cb, ps);
591 zfree(&default_ps.event_glob);
592 default_ps.pmu_glob = old_pmu_glob;
594 if (asprintf(&s, "*%s*", argv[i]) < 0) {
595 printf("Critical: Not enough memory! Trying to continue...\n");
598 default_ps.event_glob = s;
599 print_symbol_events(&print_cb, ps, PERF_TYPE_HARDWARE,
600 event_symbols_hw, PERF_COUNT_HW_MAX);
601 print_symbol_events(&print_cb, ps, PERF_TYPE_SOFTWARE,
602 event_symbols_sw, PERF_COUNT_SW_MAX);
603 print_tool_events(&print_cb, ps);
604 print_hwcache_events(&print_cb, ps);
605 perf_pmus__print_pmu_events(&print_cb, ps);
606 print_tracepoint_events(&print_cb, ps);
607 print_sdt_events(&print_cb, ps);
608 default_ps.metrics = true;
609 default_ps.metricgroups = true;
610 metricgroup__print(&print_cb, ps);
616 print_cb.print_end(ps);
617 free(default_ps.pmu_glob);
618 free(default_ps.last_topic);
619 free(default_ps.last_metricgroups);
620 strlist__delete(default_ps.visited_metrics);