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