tools/perf/builtin-list.c

0001 // SPDX-License-Identifier: GPL-2.0
0002 /*
0003  * builtin-list.c
0004  *
0005  * Builtin list command: list all event types
0006  *
0007  * Copyright (C) 2009, Thomas Gleixner <tglx@linutronix.de>
0008  * Copyright (C) 2008-2009, Red Hat Inc, Ingo Molnar <mingo@redhat.com>
0009  * Copyright (C) 2011, Red Hat Inc, Arnaldo Carvalho de Melo <acme@redhat.com>
0010  */
0011 #include "builtin.h"
0012
0013 #include "util/print-events.h"
0014 #include "util/pmu.h"
0015 #include "util/pmu-hybrid.h"
0016 #include "util/debug.h"
0017 #include "util/metricgroup.h"
0018 #include <subcmd/pager.h>
0019 #include <subcmd/parse-options.h>
0020 #include <stdio.h>
0021
0022 static bool desc_flag = true;
0023 static bool details_flag;
0024 static const char *hybrid_type;
0025
0026 int cmd_list(int argc, const char **argv)
0027 {
0028     int i, ret = 0;
0029     bool raw_dump = false;
0030     bool long_desc_flag = false;
0031     bool deprecated = false;
0032     char *pmu_name = NULL;
0033     struct option list_options[] = {
0034         OPT_BOOLEAN(0, "raw-dump", &raw_dump, "Dump raw events"),
0035         OPT_BOOLEAN('d', "desc", &desc_flag,
0036                 "Print extra event descriptions. --no-desc to not print."),
0037         OPT_BOOLEAN('v', "long-desc", &long_desc_flag,
0038                 "Print longer event descriptions."),
0039         OPT_BOOLEAN(0, "details", &details_flag,
0040                 "Print information on the perf event names and expressions used internally by events."),
0041         OPT_BOOLEAN(0, "deprecated", &deprecated,
0042                 "Print deprecated events."),
0043         OPT_STRING(0, "cputype", &hybrid_type, "hybrid cpu type",
0044                "Print events applying cpu with this type for hybrid platform "
0045                "(e.g. core or atom)"),
0046         OPT_INCR(0, "debug", &verbose,
0047                  "Enable debugging output"),
0048         OPT_END()
0049     };
0050     const char * const list_usage[] = {
0051         "perf list [<options>] [hw|sw|cache|tracepoint|pmu|sdt|metric|metricgroup|event_glob]",
0052         NULL
0053     };
0054
0055     set_option_flag(list_options, 0, "raw-dump", PARSE_OPT_HIDDEN);
0056
0057     argc = parse_options(argc, argv, list_options, list_usage,
0058                  PARSE_OPT_STOP_AT_NON_OPTION);
0059
0060     setup_pager();
0061
0062     if (!raw_dump && pager_in_use())
0063         printf("\nList of pre-defined events (to be used in -e):\n\n");
0064
0065     if (hybrid_type) {
0066         pmu_name = perf_pmu__hybrid_type_to_pmu(hybrid_type);
0067         if (!pmu_name)
0068             pr_warning("WARNING: hybrid cputype is not supported!\n");
0069     }
0070
0071     if (argc == 0) {
0072         print_events(NULL, raw_dump, !desc_flag, long_desc_flag,
0073                 details_flag, deprecated, pmu_name);
0074         goto out;
0075     }
0076
0077     for (i = 0; i < argc; ++i) {
0078         char *sep, *s;
0079
0080         if (strcmp(argv[i], "tracepoint") == 0)
0081             print_tracepoint_events(NULL, NULL, raw_dump);
0082         else if (strcmp(argv[i], "hw") == 0 ||
0083              strcmp(argv[i], "hardware") == 0)
0084             print_symbol_events(NULL, PERF_TYPE_HARDWARE,
0085                     event_symbols_hw, PERF_COUNT_HW_MAX, raw_dump);
0086         else if (strcmp(argv[i], "sw") == 0 ||
0087              strcmp(argv[i], "software") == 0) {
0088             print_symbol_events(NULL, PERF_TYPE_SOFTWARE,
0089                     event_symbols_sw, PERF_COUNT_SW_MAX, raw_dump);
0090             print_tool_events(NULL, raw_dump);
0091         } else if (strcmp(argv[i], "cache") == 0 ||
0092              strcmp(argv[i], "hwcache") == 0)
0093             print_hwcache_events(NULL, raw_dump);
0094         else if (strcmp(argv[i], "pmu") == 0)
0095             print_pmu_events(NULL, raw_dump, !desc_flag,
0096                         long_desc_flag, details_flag,
0097                         deprecated, pmu_name);
0098         else if (strcmp(argv[i], "sdt") == 0)
0099             print_sdt_events(NULL, NULL, raw_dump);
0100         else if (strcmp(argv[i], "metric") == 0 || strcmp(argv[i], "metrics") == 0)
0101             metricgroup__print(true, false, NULL, raw_dump, details_flag, pmu_name);
0102         else if (strcmp(argv[i], "metricgroup") == 0 || strcmp(argv[i], "metricgroups") == 0)
0103             metricgroup__print(false, true, NULL, raw_dump, details_flag, pmu_name);
0104         else if ((sep = strchr(argv[i], ':')) != NULL) {
0105             int sep_idx;
0106
0107             sep_idx = sep - argv[i];
0108             s = strdup(argv[i]);
0109             if (s == NULL) {
0110                 ret = -1;
0111                 goto out;
0112             }
0113
0114             s[sep_idx] = '\0';
0115             print_tracepoint_events(s, s + sep_idx + 1, raw_dump);
0116             print_sdt_events(s, s + sep_idx + 1, raw_dump);
0117             metricgroup__print(true, true, s, raw_dump, details_flag, pmu_name);
0118             free(s);
0119         } else {
0120             if (asprintf(&s, "*%s*", argv[i]) < 0) {
0121                 printf("Critical: Not enough memory! Trying to continue...\n");
0122                 continue;
0123             }
0124             print_symbol_events(s, PERF_TYPE_HARDWARE,
0125                         event_symbols_hw, PERF_COUNT_HW_MAX, raw_dump);
0126             print_symbol_events(s, PERF_TYPE_SOFTWARE,
0127                         event_symbols_sw, PERF_COUNT_SW_MAX, raw_dump);
0128             print_tool_events(s, raw_dump);
0129             print_hwcache_events(s, raw_dump);
0130             print_pmu_events(s, raw_dump, !desc_flag,
0131                         long_desc_flag,
0132                         details_flag,
0133                         deprecated,
0134                         pmu_name);
0135             print_tracepoint_events(NULL, s, raw_dump);
0136             print_sdt_events(NULL, s, raw_dump);
0137             metricgroup__print(true, true, s, raw_dump, details_flag, pmu_name);
0138             free(s);
0139         }
0140     }
0141
0142 out:
0143     free(pmu_name);
0144     return ret;
0145 }