Loading...
1// SPDX-License-Identifier: GPL-2.0
2/*
3 * builtin-list.c
4 *
5 * Builtin list command: list all event types
6 *
7 * Copyright (C) 2009, Thomas Gleixner <tglx@linutronix.de>
8 * Copyright (C) 2008-2009, Red Hat Inc, Ingo Molnar <mingo@redhat.com>
9 * Copyright (C) 2011, Red Hat Inc, Arnaldo Carvalho de Melo <acme@redhat.com>
10 */
11#include "builtin.h"
12
13#include "util/print-events.h"
14#include "util/pmus.h"
15#include "util/pmu.h"
16#include "util/debug.h"
17#include "util/metricgroup.h"
18#include "util/pfm.h"
19#include "util/string2.h"
20#include "util/strlist.h"
21#include "util/strbuf.h"
22#include "util/tool_pmu.h"
23#include <subcmd/pager.h>
24#include <subcmd/parse-options.h>
25#include <linux/zalloc.h>
26#include <ctype.h>
27#include <stdarg.h>
28#include <stdio.h>
29
30/**
31 * struct print_state - State and configuration passed to the default_print
32 * functions.
33 */
34struct print_state {
35 /** @fp: File to write output to. */
36 FILE *fp;
37 /**
38 * @pmu_glob: Optionally restrict PMU and metric matching to PMU or
39 * debugfs subsystem name.
40 */
41 char *pmu_glob;
42 /** @event_glob: Optional pattern matching glob. */
43 char *event_glob;
44 /** @name_only: Print event or metric names only. */
45 bool name_only;
46 /** @desc: Print the event or metric description. */
47 bool desc;
48 /** @long_desc: Print longer event or metric description. */
49 bool long_desc;
50 /** @deprecated: Print deprecated events or metrics. */
51 bool deprecated;
52 /**
53 * @detailed: Print extra information on the perf event such as names
54 * and expressions used internally by events.
55 */
56 bool detailed;
57 /** @metrics: Controls printing of metric and metric groups. */
58 bool metrics;
59 /** @metricgroups: Controls printing of metric and metric groups. */
60 bool metricgroups;
61 /** @last_topic: The last printed event topic. */
62 char *last_topic;
63 /** @last_metricgroups: The last printed metric group. */
64 char *last_metricgroups;
65 /** @visited_metrics: Metrics that are printed to avoid duplicates. */
66 struct strlist *visited_metrics;
67};
68
69static void default_print_start(void *ps)
70{
71 struct print_state *print_state = ps;
72
73 if (!print_state->name_only && pager_in_use()) {
74 fprintf(print_state->fp,
75 "\nList of pre-defined events (to be used in -e or -M):\n\n");
76 }
77}
78
79static void default_print_end(void *print_state __maybe_unused) {}
80
81static const char *skip_spaces_or_commas(const char *str)
82{
83 while (isspace(*str) || *str == ',')
84 ++str;
85 return str;
86}
87
88static void wordwrap(FILE *fp, const char *s, int start, int max, int corr)
89{
90 int column = start;
91 int n;
92 bool saw_newline = false;
93 bool comma = false;
94
95 while (*s) {
96 int wlen = strcspn(s, " ,\t\n");
97 const char *sep = comma ? "," : " ";
98
99 if ((column + wlen >= max && column > start) || saw_newline) {
100 fprintf(fp, comma ? ",\n%*s" : "\n%*s", start, "");
101 column = start + corr;
102 }
103 if (column <= start)
104 sep = "";
105 n = fprintf(fp, "%s%.*s", sep, wlen, s);
106 if (n <= 0)
107 break;
108 saw_newline = s[wlen] == '\n';
109 s += wlen;
110 comma = s[0] == ',';
111 column += n;
112 s = skip_spaces_or_commas(s);
113 }
114}
115
116static void default_print_event(void *ps, const char *topic, const char *pmu_name,
117 const char *event_name, const char *event_alias,
118 const char *scale_unit __maybe_unused,
119 bool deprecated, const char *event_type_desc,
120 const char *desc, const char *long_desc,
121 const char *encoding_desc)
122{
123 struct print_state *print_state = ps;
124 int pos;
125 FILE *fp = print_state->fp;
126
127 if (deprecated && !print_state->deprecated)
128 return;
129
130 if (print_state->pmu_glob && pmu_name && !strglobmatch(pmu_name, print_state->pmu_glob))
131 return;
132
133 if (print_state->event_glob &&
134 (!event_name || !strglobmatch(event_name, print_state->event_glob)) &&
135 (!event_alias || !strglobmatch(event_alias, print_state->event_glob)) &&
136 (!topic || !strglobmatch_nocase(topic, print_state->event_glob)))
137 return;
138
139 if (print_state->name_only) {
140 if (event_alias && strlen(event_alias))
141 fprintf(fp, "%s ", event_alias);
142 else
143 fprintf(fp, "%s ", event_name);
144 return;
145 }
146
147 if (strcmp(print_state->last_topic, topic ?: "")) {
148 if (topic)
149 fprintf(fp, "\n%s:\n", topic);
150 zfree(&print_state->last_topic);
151 print_state->last_topic = strdup(topic ?: "");
152 }
153
154 if (event_alias && strlen(event_alias))
155 pos = fprintf(fp, " %s OR %s", event_name, event_alias);
156 else
157 pos = fprintf(fp, " %s", event_name);
158
159 if (!topic && event_type_desc) {
160 for (; pos < 53; pos++)
161 fputc(' ', fp);
162 fprintf(fp, "[%s]\n", event_type_desc);
163 } else
164 fputc('\n', fp);
165
166 if (long_desc && print_state->long_desc) {
167 fprintf(fp, "%*s", 8, "[");
168 wordwrap(fp, long_desc, 8, pager_get_columns(), 0);
169 fprintf(fp, "]\n");
170 } else if (desc && print_state->desc) {
171 char *desc_with_unit = NULL;
172 int desc_len = -1;
173
174 if (pmu_name && strcmp(pmu_name, "default_core")) {
175 desc_len = strlen(desc);
176 desc_len = asprintf(&desc_with_unit,
177 desc_len > 0 && desc[desc_len - 1] != '.'
178 ? "%s. Unit: %s" : "%s Unit: %s",
179 desc, pmu_name);
180 }
181 fprintf(fp, "%*s", 8, "[");
182 wordwrap(fp, desc_len > 0 ? desc_with_unit : desc, 8, pager_get_columns(), 0);
183 fprintf(fp, "]\n");
184 free(desc_with_unit);
185 }
186
187 if (print_state->detailed && encoding_desc) {
188 fprintf(fp, "%*s", 8, "");
189 wordwrap(fp, encoding_desc, 8, pager_get_columns(), 0);
190 fputc('\n', fp);
191 }
192}
193
194static void default_print_metric(void *ps,
195 const char *group,
196 const char *name,
197 const char *desc,
198 const char *long_desc,
199 const char *expr,
200 const char *threshold,
201 const char *unit __maybe_unused)
202{
203 struct print_state *print_state = ps;
204 FILE *fp = print_state->fp;
205
206 if (print_state->event_glob &&
207 (!print_state->metrics || !name || !strglobmatch(name, print_state->event_glob)) &&
208 (!print_state->metricgroups || !group || !strglobmatch(group, print_state->event_glob)))
209 return;
210
211 if (!print_state->name_only && !print_state->last_metricgroups) {
212 if (print_state->metricgroups) {
213 fprintf(fp, "\nMetric Groups:\n");
214 if (!print_state->metrics)
215 fputc('\n', fp);
216 } else {
217 fprintf(fp, "\nMetrics:\n\n");
218 }
219 }
220 if (!print_state->last_metricgroups ||
221 strcmp(print_state->last_metricgroups, group ?: "")) {
222 if (group && print_state->metricgroups) {
223 if (print_state->name_only) {
224 fprintf(fp, "%s ", group);
225 } else {
226 const char *gdesc = print_state->desc
227 ? describe_metricgroup(group)
228 : NULL;
229 const char *print_colon = "";
230
231 if (print_state->metrics) {
232 print_colon = ":";
233 fputc('\n', fp);
234 }
235
236 if (gdesc)
237 fprintf(fp, "%s%s [%s]\n", group, print_colon, gdesc);
238 else
239 fprintf(fp, "%s%s\n", group, print_colon);
240 }
241 }
242 zfree(&print_state->last_metricgroups);
243 print_state->last_metricgroups = strdup(group ?: "");
244 }
245 if (!print_state->metrics)
246 return;
247
248 if (print_state->name_only) {
249 if (print_state->metrics &&
250 !strlist__has_entry(print_state->visited_metrics, name)) {
251 fprintf(fp, "%s ", name);
252 strlist__add(print_state->visited_metrics, name);
253 }
254 return;
255 }
256 fprintf(fp, " %s\n", name);
257
258 if (long_desc && print_state->long_desc) {
259 fprintf(fp, "%*s", 8, "[");
260 wordwrap(fp, long_desc, 8, pager_get_columns(), 0);
261 fprintf(fp, "]\n");
262 } else if (desc && print_state->desc) {
263 fprintf(fp, "%*s", 8, "[");
264 wordwrap(fp, desc, 8, pager_get_columns(), 0);
265 fprintf(fp, "]\n");
266 }
267 if (expr && print_state->detailed) {
268 fprintf(fp, "%*s", 8, "[");
269 wordwrap(fp, expr, 8, pager_get_columns(), 0);
270 fprintf(fp, "]\n");
271 }
272 if (threshold && print_state->detailed) {
273 fprintf(fp, "%*s", 8, "[");
274 wordwrap(fp, threshold, 8, pager_get_columns(), 0);
275 fprintf(fp, "]\n");
276 }
277}
278
279struct json_print_state {
280 /** @fp: File to write output to. */
281 FILE *fp;
282 /** Should a separator be printed prior to the next item? */
283 bool need_sep;
284};
285
286static void json_print_start(void *ps)
287{
288 struct json_print_state *print_state = ps;
289 FILE *fp = print_state->fp;
290
291 fprintf(fp, "[\n");
292}
293
294static void json_print_end(void *ps)
295{
296 struct json_print_state *print_state = ps;
297 FILE *fp = print_state->fp;
298
299 fprintf(fp, "%s]\n", print_state->need_sep ? "\n" : "");
300}
301
302static void fix_escape_fprintf(FILE *fp, struct strbuf *buf, const char *fmt, ...)
303{
304 va_list args;
305
306 va_start(args, fmt);
307 strbuf_setlen(buf, 0);
308 for (size_t fmt_pos = 0; fmt_pos < strlen(fmt); fmt_pos++) {
309 switch (fmt[fmt_pos]) {
310 case '%':
311 fmt_pos++;
312 switch (fmt[fmt_pos]) {
313 case 's': {
314 const char *s = va_arg(args, const char*);
315
316 strbuf_addstr(buf, s);
317 break;
318 }
319 case 'S': {
320 const char *s = va_arg(args, const char*);
321
322 for (size_t s_pos = 0; s_pos < strlen(s); s_pos++) {
323 switch (s[s_pos]) {
324 case '\n':
325 strbuf_addstr(buf, "\\n");
326 break;
327 case '\r':
328 strbuf_addstr(buf, "\\r");
329 break;
330 case '\\':
331 fallthrough;
332 case '\"':
333 strbuf_addch(buf, '\\');
334 fallthrough;
335 default:
336 strbuf_addch(buf, s[s_pos]);
337 break;
338 }
339 }
340 break;
341 }
342 default:
343 pr_err("Unexpected format character '%c'\n", fmt[fmt_pos]);
344 strbuf_addch(buf, '%');
345 strbuf_addch(buf, fmt[fmt_pos]);
346 }
347 break;
348 default:
349 strbuf_addch(buf, fmt[fmt_pos]);
350 break;
351 }
352 }
353 va_end(args);
354 fputs(buf->buf, fp);
355}
356
357static void json_print_event(void *ps, const char *topic, const char *pmu_name,
358 const char *event_name, const char *event_alias,
359 const char *scale_unit,
360 bool deprecated, const char *event_type_desc,
361 const char *desc, const char *long_desc,
362 const char *encoding_desc)
363{
364 struct json_print_state *print_state = ps;
365 bool need_sep = false;
366 FILE *fp = print_state->fp;
367 struct strbuf buf;
368
369 strbuf_init(&buf, 0);
370 fprintf(fp, "%s{\n", print_state->need_sep ? ",\n" : "");
371 print_state->need_sep = true;
372 if (pmu_name) {
373 fix_escape_fprintf(fp, &buf, "\t\"Unit\": \"%S\"", pmu_name);
374 need_sep = true;
375 }
376 if (topic) {
377 fix_escape_fprintf(fp, &buf, "%s\t\"Topic\": \"%S\"",
378 need_sep ? ",\n" : "",
379 topic);
380 need_sep = true;
381 }
382 if (event_name) {
383 fix_escape_fprintf(fp, &buf, "%s\t\"EventName\": \"%S\"",
384 need_sep ? ",\n" : "",
385 event_name);
386 need_sep = true;
387 }
388 if (event_alias && strlen(event_alias)) {
389 fix_escape_fprintf(fp, &buf, "%s\t\"EventAlias\": \"%S\"",
390 need_sep ? ",\n" : "",
391 event_alias);
392 need_sep = true;
393 }
394 if (scale_unit && strlen(scale_unit)) {
395 fix_escape_fprintf(fp, &buf, "%s\t\"ScaleUnit\": \"%S\"",
396 need_sep ? ",\n" : "",
397 scale_unit);
398 need_sep = true;
399 }
400 if (event_type_desc) {
401 fix_escape_fprintf(fp, &buf, "%s\t\"EventType\": \"%S\"",
402 need_sep ? ",\n" : "",
403 event_type_desc);
404 need_sep = true;
405 }
406 if (deprecated) {
407 fix_escape_fprintf(fp, &buf, "%s\t\"Deprecated\": \"%S\"",
408 need_sep ? ",\n" : "",
409 deprecated ? "1" : "0");
410 need_sep = true;
411 }
412 if (desc) {
413 fix_escape_fprintf(fp, &buf, "%s\t\"BriefDescription\": \"%S\"",
414 need_sep ? ",\n" : "",
415 desc);
416 need_sep = true;
417 }
418 if (long_desc) {
419 fix_escape_fprintf(fp, &buf, "%s\t\"PublicDescription\": \"%S\"",
420 need_sep ? ",\n" : "",
421 long_desc);
422 need_sep = true;
423 }
424 if (encoding_desc) {
425 fix_escape_fprintf(fp, &buf, "%s\t\"Encoding\": \"%S\"",
426 need_sep ? ",\n" : "",
427 encoding_desc);
428 need_sep = true;
429 }
430 fprintf(fp, "%s}", need_sep ? "\n" : "");
431 strbuf_release(&buf);
432}
433
434static void json_print_metric(void *ps __maybe_unused, const char *group,
435 const char *name, const char *desc,
436 const char *long_desc, const char *expr,
437 const char *threshold, const char *unit)
438{
439 struct json_print_state *print_state = ps;
440 bool need_sep = false;
441 FILE *fp = print_state->fp;
442 struct strbuf buf;
443
444 strbuf_init(&buf, 0);
445 fprintf(fp, "%s{\n", print_state->need_sep ? ",\n" : "");
446 print_state->need_sep = true;
447 if (group) {
448 fix_escape_fprintf(fp, &buf, "\t\"MetricGroup\": \"%S\"", group);
449 need_sep = true;
450 }
451 if (name) {
452 fix_escape_fprintf(fp, &buf, "%s\t\"MetricName\": \"%S\"",
453 need_sep ? ",\n" : "",
454 name);
455 need_sep = true;
456 }
457 if (expr) {
458 fix_escape_fprintf(fp, &buf, "%s\t\"MetricExpr\": \"%S\"",
459 need_sep ? ",\n" : "",
460 expr);
461 need_sep = true;
462 }
463 if (threshold) {
464 fix_escape_fprintf(fp, &buf, "%s\t\"MetricThreshold\": \"%S\"",
465 need_sep ? ",\n" : "",
466 threshold);
467 need_sep = true;
468 }
469 if (unit) {
470 fix_escape_fprintf(fp, &buf, "%s\t\"ScaleUnit\": \"%S\"",
471 need_sep ? ",\n" : "",
472 unit);
473 need_sep = true;
474 }
475 if (desc) {
476 fix_escape_fprintf(fp, &buf, "%s\t\"BriefDescription\": \"%S\"",
477 need_sep ? ",\n" : "",
478 desc);
479 need_sep = true;
480 }
481 if (long_desc) {
482 fix_escape_fprintf(fp, &buf, "%s\t\"PublicDescription\": \"%S\"",
483 need_sep ? ",\n" : "",
484 long_desc);
485 need_sep = true;
486 }
487 fprintf(fp, "%s}", need_sep ? "\n" : "");
488 strbuf_release(&buf);
489}
490
491static bool json_skip_duplicate_pmus(void *ps __maybe_unused)
492{
493 return false;
494}
495
496static bool default_skip_duplicate_pmus(void *ps)
497{
498 struct print_state *print_state = ps;
499
500 return !print_state->long_desc;
501}
502
503int cmd_list(int argc, const char **argv)
504{
505 int i, ret = 0;
506 struct print_state default_ps = {
507 .fp = stdout,
508 .desc = true,
509 };
510 struct print_state json_ps = {
511 .fp = stdout,
512 };
513 void *ps = &default_ps;
514 struct print_callbacks print_cb = {
515 .print_start = default_print_start,
516 .print_end = default_print_end,
517 .print_event = default_print_event,
518 .print_metric = default_print_metric,
519 .skip_duplicate_pmus = default_skip_duplicate_pmus,
520 };
521 const char *cputype = NULL;
522 const char *unit_name = NULL;
523 const char *output_path = NULL;
524 bool json = false;
525 struct option list_options[] = {
526 OPT_BOOLEAN(0, "raw-dump", &default_ps.name_only, "Dump raw events"),
527 OPT_BOOLEAN('j', "json", &json, "JSON encode events and metrics"),
528 OPT_BOOLEAN('d', "desc", &default_ps.desc,
529 "Print extra event descriptions. --no-desc to not print."),
530 OPT_BOOLEAN('v', "long-desc", &default_ps.long_desc,
531 "Print longer event descriptions."),
532 OPT_BOOLEAN(0, "details", &default_ps.detailed,
533 "Print information on the perf event names and expressions used internally by events."),
534 OPT_STRING('o', "output", &output_path, "file", "output file name"),
535 OPT_BOOLEAN(0, "deprecated", &default_ps.deprecated,
536 "Print deprecated events."),
537 OPT_STRING(0, "cputype", &cputype, "cpu type",
538 "Limit PMU or metric printing to the given PMU (e.g. cpu, core or atom)."),
539 OPT_STRING(0, "unit", &unit_name, "PMU name",
540 "Limit PMU or metric printing to the specified PMU."),
541 OPT_INCR(0, "debug", &verbose,
542 "Enable debugging output"),
543 OPT_END()
544 };
545 const char * const list_usage[] = {
546#ifdef HAVE_LIBPFM
547 "perf list [<options>] [hw|sw|cache|tracepoint|pmu|sdt|metric|metricgroup|event_glob|pfm]",
548#else
549 "perf list [<options>] [hw|sw|cache|tracepoint|pmu|sdt|metric|metricgroup|event_glob]",
550#endif
551 NULL
552 };
553
554 set_option_flag(list_options, 0, "raw-dump", PARSE_OPT_HIDDEN);
555 /* Hide hybrid flag for the more generic 'unit' flag. */
556 set_option_flag(list_options, 0, "cputype", PARSE_OPT_HIDDEN);
557
558 argc = parse_options(argc, argv, list_options, list_usage,
559 PARSE_OPT_STOP_AT_NON_OPTION);
560
561 if (output_path) {
562 default_ps.fp = fopen(output_path, "w");
563 json_ps.fp = default_ps.fp;
564 }
565
566 setup_pager();
567
568 if (!default_ps.name_only)
569 setup_pager();
570
571 if (json) {
572 print_cb = (struct print_callbacks){
573 .print_start = json_print_start,
574 .print_end = json_print_end,
575 .print_event = json_print_event,
576 .print_metric = json_print_metric,
577 .skip_duplicate_pmus = json_skip_duplicate_pmus,
578 };
579 ps = &json_ps;
580 } else {
581 default_ps.last_topic = strdup("");
582 assert(default_ps.last_topic);
583 default_ps.visited_metrics = strlist__new(NULL, NULL);
584 assert(default_ps.visited_metrics);
585 if (unit_name)
586 default_ps.pmu_glob = strdup(unit_name);
587 else if (cputype) {
588 const struct perf_pmu *pmu = perf_pmus__pmu_for_pmu_filter(cputype);
589
590 if (!pmu) {
591 pr_err("ERROR: cputype is not supported!\n");
592 ret = -1;
593 goto out;
594 }
595 default_ps.pmu_glob = strdup(pmu->name);
596 }
597 }
598 print_cb.print_start(ps);
599
600 if (argc == 0) {
601 default_ps.metrics = true;
602 default_ps.metricgroups = true;
603 print_events(&print_cb, ps);
604 goto out;
605 }
606
607 for (i = 0; i < argc; ++i) {
608 char *sep, *s;
609
610 if (strcmp(argv[i], "tracepoint") == 0)
611 print_tracepoint_events(&print_cb, ps);
612 else if (strcmp(argv[i], "hw") == 0 ||
613 strcmp(argv[i], "hardware") == 0)
614 print_symbol_events(&print_cb, ps, PERF_TYPE_HARDWARE,
615 event_symbols_hw, PERF_COUNT_HW_MAX);
616 else if (strcmp(argv[i], "sw") == 0 ||
617 strcmp(argv[i], "software") == 0) {
618 char *old_pmu_glob = default_ps.pmu_glob;
619
620 print_symbol_events(&print_cb, ps, PERF_TYPE_SOFTWARE,
621 event_symbols_sw, PERF_COUNT_SW_MAX);
622 default_ps.pmu_glob = strdup("tool");
623 if (!default_ps.pmu_glob) {
624 ret = -1;
625 goto out;
626 }
627 perf_pmus__print_pmu_events(&print_cb, ps);
628 zfree(&default_ps.pmu_glob);
629 default_ps.pmu_glob = old_pmu_glob;
630 } else if (strcmp(argv[i], "cache") == 0 ||
631 strcmp(argv[i], "hwcache") == 0)
632 print_hwcache_events(&print_cb, ps);
633 else if (strcmp(argv[i], "pmu") == 0)
634 perf_pmus__print_pmu_events(&print_cb, ps);
635 else if (strcmp(argv[i], "sdt") == 0)
636 print_sdt_events(&print_cb, ps);
637 else if (strcmp(argv[i], "metric") == 0 || strcmp(argv[i], "metrics") == 0) {
638 default_ps.metricgroups = false;
639 default_ps.metrics = true;
640 metricgroup__print(&print_cb, ps);
641 } else if (strcmp(argv[i], "metricgroup") == 0 ||
642 strcmp(argv[i], "metricgroups") == 0) {
643 default_ps.metricgroups = true;
644 default_ps.metrics = false;
645 metricgroup__print(&print_cb, ps);
646 }
647#ifdef HAVE_LIBPFM
648 else if (strcmp(argv[i], "pfm") == 0)
649 print_libpfm_events(&print_cb, ps);
650#endif
651 else if ((sep = strchr(argv[i], ':')) != NULL) {
652 char *old_pmu_glob = default_ps.pmu_glob;
653
654 default_ps.event_glob = strdup(argv[i]);
655 if (!default_ps.event_glob) {
656 ret = -1;
657 goto out;
658 }
659
660 print_tracepoint_events(&print_cb, ps);
661 print_sdt_events(&print_cb, ps);
662 default_ps.metrics = true;
663 default_ps.metricgroups = true;
664 metricgroup__print(&print_cb, ps);
665 zfree(&default_ps.event_glob);
666 default_ps.pmu_glob = old_pmu_glob;
667 } else {
668 if (asprintf(&s, "*%s*", argv[i]) < 0) {
669 printf("Critical: Not enough memory! Trying to continue...\n");
670 continue;
671 }
672 default_ps.event_glob = s;
673 print_symbol_events(&print_cb, ps, PERF_TYPE_HARDWARE,
674 event_symbols_hw, PERF_COUNT_HW_MAX);
675 print_symbol_events(&print_cb, ps, PERF_TYPE_SOFTWARE,
676 event_symbols_sw, PERF_COUNT_SW_MAX);
677 print_hwcache_events(&print_cb, ps);
678 perf_pmus__print_pmu_events(&print_cb, ps);
679 print_tracepoint_events(&print_cb, ps);
680 print_sdt_events(&print_cb, ps);
681 default_ps.metrics = true;
682 default_ps.metricgroups = true;
683 metricgroup__print(&print_cb, ps);
684 free(s);
685 }
686 }
687
688out:
689 print_cb.print_end(ps);
690 free(default_ps.pmu_glob);
691 free(default_ps.last_topic);
692 free(default_ps.last_metricgroups);
693 strlist__delete(default_ps.visited_metrics);
694 if (output_path)
695 fclose(default_ps.fp);
696
697 return ret;
698}
1// SPDX-License-Identifier: GPL-2.0
2/*
3 * builtin-list.c
4 *
5 * Builtin list command: list all event types
6 *
7 * Copyright (C) 2009, Thomas Gleixner <tglx@linutronix.de>
8 * Copyright (C) 2008-2009, Red Hat Inc, Ingo Molnar <mingo@redhat.com>
9 * Copyright (C) 2011, Red Hat Inc, Arnaldo Carvalho de Melo <acme@redhat.com>
10 */
11#include "builtin.h"
12
13#include "util/print-events.h"
14#include "util/pmu.h"
15#include "util/pmu-hybrid.h"
16#include "util/debug.h"
17#include "util/metricgroup.h"
18#include "util/string2.h"
19#include "util/strlist.h"
20#include "util/strbuf.h"
21#include <subcmd/pager.h>
22#include <subcmd/parse-options.h>
23#include <linux/zalloc.h>
24#include <stdarg.h>
25#include <stdio.h>
26
27/**
28 * struct print_state - State and configuration passed to the default_print
29 * functions.
30 */
31struct print_state {
32 /**
33 * @pmu_glob: Optionally restrict PMU and metric matching to PMU or
34 * debugfs subsystem name.
35 */
36 char *pmu_glob;
37 /** @event_glob: Optional pattern matching glob. */
38 char *event_glob;
39 /** @name_only: Print event or metric names only. */
40 bool name_only;
41 /** @desc: Print the event or metric description. */
42 bool desc;
43 /** @long_desc: Print longer event or metric description. */
44 bool long_desc;
45 /** @deprecated: Print deprecated events or metrics. */
46 bool deprecated;
47 /**
48 * @detailed: Print extra information on the perf event such as names
49 * and expressions used internally by events.
50 */
51 bool detailed;
52 /** @metrics: Controls printing of metric and metric groups. */
53 bool metrics;
54 /** @metricgroups: Controls printing of metric and metric groups. */
55 bool metricgroups;
56 /** @last_topic: The last printed event topic. */
57 char *last_topic;
58 /** @last_metricgroups: The last printed metric group. */
59 char *last_metricgroups;
60 /** @visited_metrics: Metrics that are printed to avoid duplicates. */
61 struct strlist *visited_metrics;
62};
63
64static void default_print_start(void *ps)
65{
66 struct print_state *print_state = ps;
67
68 if (!print_state->name_only && pager_in_use())
69 printf("\nList of pre-defined events (to be used in -e or -M):\n\n");
70}
71
72static void default_print_end(void *print_state __maybe_unused) {}
73
74static void wordwrap(const char *s, int start, int max, int corr)
75{
76 int column = start;
77 int n;
78 bool saw_newline = false;
79
80 while (*s) {
81 int wlen = strcspn(s, " \t\n");
82
83 if ((column + wlen >= max && column > start) || saw_newline) {
84 printf("\n%*s", start, "");
85 column = start + corr;
86 }
87 n = printf("%s%.*s", column > start ? " " : "", wlen, s);
88 if (n <= 0)
89 break;
90 saw_newline = s[wlen] == '\n';
91 s += wlen;
92 column += n;
93 s = skip_spaces(s);
94 }
95}
96
97static void default_print_event(void *ps, const char *pmu_name, const char *topic,
98 const char *event_name, const char *event_alias,
99 const char *scale_unit __maybe_unused,
100 bool deprecated, const char *event_type_desc,
101 const char *desc, const char *long_desc,
102 const char *encoding_desc,
103 const char *metric_name, const char *metric_expr)
104{
105 struct print_state *print_state = ps;
106 int pos;
107
108 if (deprecated && !print_state->deprecated)
109 return;
110
111 if (print_state->pmu_glob && pmu_name && !strglobmatch(pmu_name, print_state->pmu_glob))
112 return;
113
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)))
118 return;
119
120 if (print_state->name_only) {
121 if (event_alias && strlen(event_alias))
122 printf("%s ", event_alias);
123 else
124 printf("%s ", event_name);
125 return;
126 }
127
128 if (strcmp(print_state->last_topic, topic ?: "")) {
129 if (topic)
130 printf("\n%s:\n", topic);
131 free(print_state->last_topic);
132 print_state->last_topic = strdup(topic ?: "");
133 }
134
135 if (event_alias && strlen(event_alias))
136 pos = printf(" %s OR %s", event_name, event_alias);
137 else
138 pos = printf(" %s", event_name);
139
140 if (!topic && event_type_desc) {
141 for (; pos < 53; pos++)
142 putchar(' ');
143 printf("[%s]\n", event_type_desc);
144 } else
145 putchar('\n');
146
147 if (desc && print_state->desc) {
148 printf("%*s", 8, "[");
149 wordwrap(desc, 8, pager_get_columns(), 0);
150 printf("]\n");
151 }
152 long_desc = long_desc ?: desc;
153 if (long_desc && print_state->long_desc) {
154 printf("%*s", 8, "[");
155 wordwrap(long_desc, 8, pager_get_columns(), 0);
156 printf("]\n");
157 }
158
159 if (print_state->detailed && encoding_desc) {
160 printf("%*s", 8, "");
161 wordwrap(encoding_desc, 8, pager_get_columns(), 0);
162 if (metric_name)
163 printf(" MetricName: %s", metric_name);
164 if (metric_expr)
165 printf(" MetricExpr: %s", metric_expr);
166 putchar('\n');
167 }
168}
169
170static void default_print_metric(void *ps,
171 const char *group,
172 const char *name,
173 const char *desc,
174 const char *long_desc,
175 const char *expr,
176 const char *unit __maybe_unused)
177{
178 struct print_state *print_state = ps;
179
180 if (print_state->event_glob &&
181 (!print_state->metrics || !name || !strglobmatch(name, print_state->event_glob)) &&
182 (!print_state->metricgroups || !group || !strglobmatch(group, print_state->event_glob)))
183 return;
184
185 if (!print_state->name_only && !print_state->last_metricgroups) {
186 if (print_state->metricgroups) {
187 printf("\nMetric Groups:\n");
188 if (!print_state->metrics)
189 putchar('\n');
190 } else {
191 printf("\nMetrics:\n\n");
192 }
193 }
194 if (!print_state->last_metricgroups ||
195 strcmp(print_state->last_metricgroups, group ?: "")) {
196 if (group && print_state->metricgroups) {
197 if (print_state->name_only)
198 printf("%s ", group);
199 else if (print_state->metrics)
200 printf("\n%s:\n", group);
201 else
202 printf("%s\n", group);
203 }
204 free(print_state->last_metricgroups);
205 print_state->last_metricgroups = strdup(group ?: "");
206 }
207 if (!print_state->metrics)
208 return;
209
210 if (print_state->name_only) {
211 if (print_state->metrics &&
212 !strlist__has_entry(print_state->visited_metrics, name)) {
213 printf("%s ", name);
214 strlist__add(print_state->visited_metrics, name);
215 }
216 return;
217 }
218 printf(" %s\n", name);
219
220 if (desc && print_state->desc) {
221 printf("%*s", 8, "[");
222 wordwrap(desc, 8, pager_get_columns(), 0);
223 printf("]\n");
224 }
225 if (long_desc && print_state->long_desc) {
226 printf("%*s", 8, "[");
227 wordwrap(long_desc, 8, pager_get_columns(), 0);
228 printf("]\n");
229 }
230 if (expr && print_state->detailed) {
231 printf("%*s", 8, "[");
232 wordwrap(expr, 8, pager_get_columns(), 0);
233 printf("]\n");
234 }
235}
236
237struct json_print_state {
238 /** Should a separator be printed prior to the next item? */
239 bool need_sep;
240};
241
242static void json_print_start(void *print_state __maybe_unused)
243{
244 printf("[\n");
245}
246
247static void json_print_end(void *ps)
248{
249 struct json_print_state *print_state = ps;
250
251 printf("%s]\n", print_state->need_sep ? "\n" : "");
252}
253
254static void fix_escape_printf(struct strbuf *buf, const char *fmt, ...)
255{
256 va_list args;
257
258 va_start(args, fmt);
259 strbuf_setlen(buf, 0);
260 for (size_t fmt_pos = 0; fmt_pos < strlen(fmt); fmt_pos++) {
261 switch (fmt[fmt_pos]) {
262 case '%':
263 fmt_pos++;
264 switch (fmt[fmt_pos]) {
265 case 's': {
266 const char *s = va_arg(args, const char*);
267
268 strbuf_addstr(buf, s);
269 break;
270 }
271 case 'S': {
272 const char *s = va_arg(args, const char*);
273
274 for (size_t s_pos = 0; s_pos < strlen(s); s_pos++) {
275 switch (s[s_pos]) {
276 case '\n':
277 strbuf_addstr(buf, "\\n");
278 break;
279 case '\\':
280 __fallthrough;
281 case '\"':
282 strbuf_addch(buf, '\\');
283 __fallthrough;
284 default:
285 strbuf_addch(buf, s[s_pos]);
286 break;
287 }
288 }
289 break;
290 }
291 default:
292 pr_err("Unexpected format character '%c'\n", fmt[fmt_pos]);
293 strbuf_addch(buf, '%');
294 strbuf_addch(buf, fmt[fmt_pos]);
295 }
296 break;
297 default:
298 strbuf_addch(buf, fmt[fmt_pos]);
299 break;
300 }
301 }
302 va_end(args);
303 fputs(buf->buf, stdout);
304}
305
306static void json_print_event(void *ps, const char *pmu_name, const char *topic,
307 const char *event_name, const char *event_alias,
308 const char *scale_unit,
309 bool deprecated, const char *event_type_desc,
310 const char *desc, const char *long_desc,
311 const char *encoding_desc,
312 const char *metric_name, const char *metric_expr)
313{
314 struct json_print_state *print_state = ps;
315 bool need_sep = false;
316 struct strbuf buf;
317
318 strbuf_init(&buf, 0);
319 printf("%s{\n", print_state->need_sep ? ",\n" : "");
320 print_state->need_sep = true;
321 if (pmu_name) {
322 fix_escape_printf(&buf, "\t\"Unit\": \"%S\"", pmu_name);
323 need_sep = true;
324 }
325 if (topic) {
326 fix_escape_printf(&buf, "%s\t\"Topic\": \"%S\"", need_sep ? ",\n" : "", topic);
327 need_sep = true;
328 }
329 if (event_name) {
330 fix_escape_printf(&buf, "%s\t\"EventName\": \"%S\"", need_sep ? ",\n" : "",
331 event_name);
332 need_sep = true;
333 }
334 if (event_alias && strlen(event_alias)) {
335 fix_escape_printf(&buf, "%s\t\"EventAlias\": \"%S\"", need_sep ? ",\n" : "",
336 event_alias);
337 need_sep = true;
338 }
339 if (scale_unit && strlen(scale_unit)) {
340 fix_escape_printf(&buf, "%s\t\"ScaleUnit\": \"%S\"", need_sep ? ",\n" : "",
341 scale_unit);
342 need_sep = true;
343 }
344 if (event_type_desc) {
345 fix_escape_printf(&buf, "%s\t\"EventType\": \"%S\"", need_sep ? ",\n" : "",
346 event_type_desc);
347 need_sep = true;
348 }
349 if (deprecated) {
350 fix_escape_printf(&buf, "%s\t\"Deprecated\": \"%S\"", need_sep ? ",\n" : "",
351 deprecated ? "1" : "0");
352 need_sep = true;
353 }
354 if (desc) {
355 fix_escape_printf(&buf, "%s\t\"BriefDescription\": \"%S\"", need_sep ? ",\n" : "",
356 desc);
357 need_sep = true;
358 }
359 if (long_desc) {
360 fix_escape_printf(&buf, "%s\t\"PublicDescription\": \"%S\"", need_sep ? ",\n" : "",
361 long_desc);
362 need_sep = true;
363 }
364 if (encoding_desc) {
365 fix_escape_printf(&buf, "%s\t\"Encoding\": \"%S\"", need_sep ? ",\n" : "",
366 encoding_desc);
367 need_sep = true;
368 }
369 if (metric_name) {
370 fix_escape_printf(&buf, "%s\t\"MetricName\": \"%S\"", need_sep ? ",\n" : "",
371 metric_name);
372 need_sep = true;
373 }
374 if (metric_expr) {
375 fix_escape_printf(&buf, "%s\t\"MetricExpr\": \"%S\"", need_sep ? ",\n" : "",
376 metric_expr);
377 need_sep = true;
378 }
379 printf("%s}", need_sep ? "\n" : "");
380 strbuf_release(&buf);
381}
382
383static void json_print_metric(void *ps __maybe_unused, const char *group,
384 const char *name, const char *desc,
385 const char *long_desc, const char *expr,
386 const char *unit)
387{
388 struct json_print_state *print_state = ps;
389 bool need_sep = false;
390 struct strbuf buf;
391
392 strbuf_init(&buf, 0);
393 printf("%s{\n", print_state->need_sep ? ",\n" : "");
394 print_state->need_sep = true;
395 if (group) {
396 fix_escape_printf(&buf, "\t\"MetricGroup\": \"%S\"", group);
397 need_sep = true;
398 }
399 if (name) {
400 fix_escape_printf(&buf, "%s\t\"MetricName\": \"%S\"", need_sep ? ",\n" : "", name);
401 need_sep = true;
402 }
403 if (expr) {
404 fix_escape_printf(&buf, "%s\t\"MetricExpr\": \"%S\"", need_sep ? ",\n" : "", expr);
405 need_sep = true;
406 }
407 if (unit) {
408 fix_escape_printf(&buf, "%s\t\"ScaleUnit\": \"%S\"", need_sep ? ",\n" : "", unit);
409 need_sep = true;
410 }
411 if (desc) {
412 fix_escape_printf(&buf, "%s\t\"BriefDescription\": \"%S\"", need_sep ? ",\n" : "",
413 desc);
414 need_sep = true;
415 }
416 if (long_desc) {
417 fix_escape_printf(&buf, "%s\t\"PublicDescription\": \"%S\"", need_sep ? ",\n" : "",
418 long_desc);
419 need_sep = true;
420 }
421 printf("%s}", need_sep ? "\n" : "");
422 strbuf_release(&buf);
423}
424
425int cmd_list(int argc, const char **argv)
426{
427 int i, ret = 0;
428 struct print_state default_ps = {};
429 struct print_state json_ps = {};
430 void *ps = &default_ps;
431 struct print_callbacks print_cb = {
432 .print_start = default_print_start,
433 .print_end = default_print_end,
434 .print_event = default_print_event,
435 .print_metric = default_print_metric,
436 };
437 const char *hybrid_name = NULL;
438 const char *unit_name = NULL;
439 bool json = false;
440 struct option list_options[] = {
441 OPT_BOOLEAN(0, "raw-dump", &default_ps.name_only, "Dump raw events"),
442 OPT_BOOLEAN('j', "json", &json, "JSON encode events and metrics"),
443 OPT_BOOLEAN('d', "desc", &default_ps.desc,
444 "Print extra event descriptions. --no-desc to not print."),
445 OPT_BOOLEAN('v', "long-desc", &default_ps.long_desc,
446 "Print longer event descriptions."),
447 OPT_BOOLEAN(0, "details", &default_ps.detailed,
448 "Print information on the perf event names and expressions used internally by events."),
449 OPT_BOOLEAN(0, "deprecated", &default_ps.deprecated,
450 "Print deprecated events."),
451 OPT_STRING(0, "cputype", &hybrid_name, "hybrid cpu type",
452 "Limit PMU or metric printing to the given hybrid PMU (e.g. core or atom)."),
453 OPT_STRING(0, "unit", &unit_name, "PMU name",
454 "Limit PMU or metric printing to the specified PMU."),
455 OPT_INCR(0, "debug", &verbose,
456 "Enable debugging output"),
457 OPT_END()
458 };
459 const char * const list_usage[] = {
460 "perf list [<options>] [hw|sw|cache|tracepoint|pmu|sdt|metric|metricgroup|event_glob]",
461 NULL
462 };
463
464 set_option_flag(list_options, 0, "raw-dump", PARSE_OPT_HIDDEN);
465 /* Hide hybrid flag for the more generic 'unit' flag. */
466 set_option_flag(list_options, 0, "cputype", PARSE_OPT_HIDDEN);
467
468 argc = parse_options(argc, argv, list_options, list_usage,
469 PARSE_OPT_STOP_AT_NON_OPTION);
470
471 setup_pager();
472
473 if (!default_ps.name_only)
474 setup_pager();
475
476 if (json) {
477 print_cb = (struct print_callbacks){
478 .print_start = json_print_start,
479 .print_end = json_print_end,
480 .print_event = json_print_event,
481 .print_metric = json_print_metric,
482 };
483 ps = &json_ps;
484 } else {
485 default_ps.desc = !default_ps.long_desc;
486 default_ps.last_topic = strdup("");
487 assert(default_ps.last_topic);
488 default_ps.visited_metrics = strlist__new(NULL, NULL);
489 assert(default_ps.visited_metrics);
490 if (unit_name)
491 default_ps.pmu_glob = strdup(unit_name);
492 else if (hybrid_name) {
493 default_ps.pmu_glob = perf_pmu__hybrid_type_to_pmu(hybrid_name);
494 if (!default_ps.pmu_glob)
495 pr_warning("WARNING: hybrid cputype is not supported!\n");
496 }
497 }
498 print_cb.print_start(ps);
499
500 if (argc == 0) {
501 default_ps.metrics = true;
502 default_ps.metricgroups = true;
503 print_events(&print_cb, ps);
504 goto out;
505 }
506
507 for (i = 0; i < argc; ++i) {
508 char *sep, *s;
509
510 if (strcmp(argv[i], "tracepoint") == 0)
511 print_tracepoint_events(&print_cb, ps);
512 else if (strcmp(argv[i], "hw") == 0 ||
513 strcmp(argv[i], "hardware") == 0)
514 print_symbol_events(&print_cb, ps, PERF_TYPE_HARDWARE,
515 event_symbols_hw, PERF_COUNT_HW_MAX);
516 else if (strcmp(argv[i], "sw") == 0 ||
517 strcmp(argv[i], "software") == 0) {
518 print_symbol_events(&print_cb, ps, PERF_TYPE_SOFTWARE,
519 event_symbols_sw, PERF_COUNT_SW_MAX);
520 print_tool_events(&print_cb, ps);
521 } else if (strcmp(argv[i], "cache") == 0 ||
522 strcmp(argv[i], "hwcache") == 0)
523 print_hwcache_events(&print_cb, ps);
524 else if (strcmp(argv[i], "pmu") == 0)
525 print_pmu_events(&print_cb, ps);
526 else if (strcmp(argv[i], "sdt") == 0)
527 print_sdt_events(&print_cb, ps);
528 else if (strcmp(argv[i], "metric") == 0 || strcmp(argv[i], "metrics") == 0) {
529 default_ps.metricgroups = false;
530 default_ps.metrics = true;
531 metricgroup__print(&print_cb, ps);
532 } else if (strcmp(argv[i], "metricgroup") == 0 ||
533 strcmp(argv[i], "metricgroups") == 0) {
534 default_ps.metricgroups = true;
535 default_ps.metrics = false;
536 metricgroup__print(&print_cb, ps);
537 } else if ((sep = strchr(argv[i], ':')) != NULL) {
538 char *old_pmu_glob = default_ps.pmu_glob;
539
540 default_ps.event_glob = strdup(argv[i]);
541 if (!default_ps.event_glob) {
542 ret = -1;
543 goto out;
544 }
545
546 print_tracepoint_events(&print_cb, ps);
547 print_sdt_events(&print_cb, ps);
548 default_ps.metrics = true;
549 default_ps.metricgroups = true;
550 metricgroup__print(&print_cb, ps);
551 zfree(&default_ps.event_glob);
552 default_ps.pmu_glob = old_pmu_glob;
553 } else {
554 if (asprintf(&s, "*%s*", argv[i]) < 0) {
555 printf("Critical: Not enough memory! Trying to continue...\n");
556 continue;
557 }
558 default_ps.event_glob = s;
559 print_symbol_events(&print_cb, ps, PERF_TYPE_HARDWARE,
560 event_symbols_hw, PERF_COUNT_HW_MAX);
561 print_symbol_events(&print_cb, ps, PERF_TYPE_SOFTWARE,
562 event_symbols_sw, PERF_COUNT_SW_MAX);
563 print_tool_events(&print_cb, ps);
564 print_hwcache_events(&print_cb, ps);
565 print_pmu_events(&print_cb, ps);
566 print_tracepoint_events(&print_cb, ps);
567 print_sdt_events(&print_cb, ps);
568 default_ps.metrics = true;
569 default_ps.metricgroups = true;
570 metricgroup__print(&print_cb, ps);
571 free(s);
572 }
573 }
574
575out:
576 print_cb.print_end(ps);
577 free(default_ps.pmu_glob);
578 free(default_ps.last_topic);
579 free(default_ps.last_metricgroups);
580 strlist__delete(default_ps.visited_metrics);
581 return ret;
582}