xref: /linux/tools/perf/builtin-evlist.c (revision b60a5b8dcf49af9f2c60ae82e0383ee8e62a9a52)
1 // SPDX-License-Identifier: GPL-2.0
2 /*
3  * Builtin evlist command: Show the list of event selectors present
4  * in a perf.data file.
5  */
6 #include "builtin.h"
7 
8 #include "util/util.h"
9 
10 #include <linux/list.h>
11 
12 #include "perf.h"
13 #include "util/evlist.h"
14 #include "util/evsel.h"
15 #include "util/parse-events.h"
16 #include <subcmd/parse-options.h>
17 #include "util/session.h"
18 #include "util/data.h"
19 #include "util/debug.h"
20 
21 static int __cmd_evlist(const char *file_name, struct perf_attr_details *details)
22 {
23 	struct perf_session *session;
24 	struct perf_evsel *pos;
25 	struct perf_data data = {
26 		.path      = file_name,
27 		.mode      = PERF_DATA_MODE_READ,
28 		.force     = details->force,
29 	};
30 	bool has_tracepoint = false;
31 
32 	session = perf_session__new(&data, 0, NULL);
33 	if (session == NULL)
34 		return -1;
35 
36 	evlist__for_each_entry(session->evlist, pos) {
37 		perf_evsel__fprintf(pos, details, stdout);
38 
39 		if (pos->attr.type == PERF_TYPE_TRACEPOINT)
40 			has_tracepoint = true;
41 	}
42 
43 	if (has_tracepoint && !details->trace_fields)
44 		printf("# Tip: use 'perf evlist --trace-fields' to show fields for tracepoint events\n");
45 
46 	perf_session__delete(session);
47 	return 0;
48 }
49 
50 int cmd_evlist(int argc, const char **argv)
51 {
52 	struct perf_attr_details details = { .verbose = false, };
53 	const struct option options[] = {
54 	OPT_STRING('i', "input", &input_name, "file", "Input file name"),
55 	OPT_BOOLEAN('F', "freq", &details.freq, "Show the sample frequency"),
56 	OPT_BOOLEAN('v', "verbose", &details.verbose,
57 		    "Show all event attr details"),
58 	OPT_BOOLEAN('g', "group", &details.event_group,
59 		    "Show event group information"),
60 	OPT_BOOLEAN('f', "force", &details.force, "don't complain, do it"),
61 	OPT_BOOLEAN(0, "trace-fields", &details.trace_fields, "Show tracepoint fields"),
62 	OPT_END()
63 	};
64 	const char * const evlist_usage[] = {
65 		"perf evlist [<options>]",
66 		NULL
67 	};
68 
69 	argc = parse_options(argc, argv, options, evlist_usage, 0);
70 	if (argc)
71 		usage_with_options(evlist_usage, options);
72 
73 	if (details.event_group && (details.verbose || details.freq)) {
74 		usage_with_options_msg(evlist_usage, options,
75 			"--group option is not compatible with other options\n");
76 	}
77 
78 	return __cmd_evlist(input_name, &details);
79 }
80