^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 1) // SPDX-License-Identifier: GPL-2.0
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 2) /*
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 3) * builtin-list.c
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 4) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 5) * Builtin list command: list all event types
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 6) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 7) * Copyright (C) 2009, Thomas Gleixner <tglx@linutronix.de>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 8) * Copyright (C) 2008-2009, Red Hat Inc, Ingo Molnar <mingo@redhat.com>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 9) * Copyright (C) 2011, Red Hat Inc, Arnaldo Carvalho de Melo <acme@redhat.com>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 10) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 11) #include "builtin.h"
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 12)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 13) #include "util/parse-events.h"
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 14) #include "util/pmu.h"
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 15) #include "util/debug.h"
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 16) #include "util/metricgroup.h"
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 17) #include <subcmd/pager.h>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 18) #include <subcmd/parse-options.h>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 19) #include <stdio.h>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 20)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 21) static bool desc_flag = true;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 22) static bool details_flag;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 23)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 24) int cmd_list(int argc, const char **argv)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 25) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 26) int i;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 27) bool raw_dump = false;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 28) bool long_desc_flag = false;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 29) bool deprecated = false;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 30) struct option list_options[] = {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 31) OPT_BOOLEAN(0, "raw-dump", &raw_dump, "Dump raw events"),
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 32) OPT_BOOLEAN('d', "desc", &desc_flag,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 33) "Print extra event descriptions. --no-desc to not print."),
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 34) OPT_BOOLEAN('v', "long-desc", &long_desc_flag,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 35) "Print longer event descriptions."),
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 36) OPT_BOOLEAN(0, "details", &details_flag,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 37) "Print information on the perf event names and expressions used internally by events."),
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 38) OPT_BOOLEAN(0, "deprecated", &deprecated,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 39) "Print deprecated events."),
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 40) OPT_INCR(0, "debug", &verbose,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 41) "Enable debugging output"),
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 42) OPT_END()
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 43) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 44) const char * const list_usage[] = {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 45) "perf list [<options>] [hw|sw|cache|tracepoint|pmu|sdt|metric|metricgroup|event_glob]",
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 46) NULL
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 47) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 48)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 49) set_option_flag(list_options, 0, "raw-dump", PARSE_OPT_HIDDEN);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 50)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 51) argc = parse_options(argc, argv, list_options, list_usage,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 52) PARSE_OPT_STOP_AT_NON_OPTION);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 53)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 54) setup_pager();
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 55)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 56) if (!raw_dump && pager_in_use())
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 57) printf("\nList of pre-defined events (to be used in -e):\n\n");
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 58)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 59) if (argc == 0) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 60) print_events(NULL, raw_dump, !desc_flag, long_desc_flag,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 61) details_flag, deprecated);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 62) return 0;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 63) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 64)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 65) for (i = 0; i < argc; ++i) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 66) char *sep, *s;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 67)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 68) if (strcmp(argv[i], "tracepoint") == 0)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 69) print_tracepoint_events(NULL, NULL, raw_dump);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 70) else if (strcmp(argv[i], "hw") == 0 ||
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 71) strcmp(argv[i], "hardware") == 0)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 72) print_symbol_events(NULL, PERF_TYPE_HARDWARE,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 73) event_symbols_hw, PERF_COUNT_HW_MAX, raw_dump);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 74) else if (strcmp(argv[i], "sw") == 0 ||
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 75) strcmp(argv[i], "software") == 0) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 76) print_symbol_events(NULL, PERF_TYPE_SOFTWARE,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 77) event_symbols_sw, PERF_COUNT_SW_MAX, raw_dump);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 78) print_tool_events(NULL, raw_dump);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 79) } else if (strcmp(argv[i], "cache") == 0 ||
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 80) strcmp(argv[i], "hwcache") == 0)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 81) print_hwcache_events(NULL, raw_dump);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 82) else if (strcmp(argv[i], "pmu") == 0)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 83) print_pmu_events(NULL, raw_dump, !desc_flag,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 84) long_desc_flag, details_flag,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 85) deprecated);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 86) else if (strcmp(argv[i], "sdt") == 0)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 87) print_sdt_events(NULL, NULL, raw_dump);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 88) else if (strcmp(argv[i], "metric") == 0 || strcmp(argv[i], "metrics") == 0)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 89) metricgroup__print(true, false, NULL, raw_dump, details_flag);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 90) else if (strcmp(argv[i], "metricgroup") == 0 || strcmp(argv[i], "metricgroups") == 0)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 91) metricgroup__print(false, true, NULL, raw_dump, details_flag);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 92) else if ((sep = strchr(argv[i], ':')) != NULL) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 93) int sep_idx;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 94)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 95) sep_idx = sep - argv[i];
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 96) s = strdup(argv[i]);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 97) if (s == NULL)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 98) return -1;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 99)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 100) s[sep_idx] = '\0';
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 101) print_tracepoint_events(s, s + sep_idx + 1, raw_dump);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 102) print_sdt_events(s, s + sep_idx + 1, raw_dump);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 103) metricgroup__print(true, true, s, raw_dump, details_flag);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 104) free(s);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 105) } else {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 106) if (asprintf(&s, "*%s*", argv[i]) < 0) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 107) printf("Critical: Not enough memory! Trying to continue...\n");
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 108) continue;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 109) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 110) print_symbol_events(s, PERF_TYPE_HARDWARE,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 111) event_symbols_hw, PERF_COUNT_HW_MAX, raw_dump);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 112) print_symbol_events(s, PERF_TYPE_SOFTWARE,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 113) event_symbols_sw, PERF_COUNT_SW_MAX, raw_dump);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 114) print_tool_events(s, raw_dump);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 115) print_hwcache_events(s, raw_dump);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 116) print_pmu_events(s, raw_dump, !desc_flag,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 117) long_desc_flag,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 118) details_flag,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 119) deprecated);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 120) print_tracepoint_events(NULL, s, raw_dump);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 121) print_sdt_events(NULL, s, raw_dump);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 122) metricgroup__print(true, true, s, raw_dump, details_flag);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 123) free(s);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 124) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 125) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 126) return 0;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 127) }