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