xref: /linux/tools/perf/builtin-evlist.c (revision 2cd86f02c017bf9733e5cd891381b7d40f6f37ad)
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 <linux/list.h>
9 
10 #include "util/evlist.h"
11 #include "util/evsel.h"
12 #include "util/evsel_fprintf.h"
13 #include "util/parse-events.h"
14 #include <subcmd/parse-options.h>
15 #include "util/session.h"
16 #include "util/data.h"
17 #include "util/debug.h"
18 #include <linux/err.h>
19 #include "util/tool.h"
20 #include "util/util.h"
21 
22 static int process_header_feature(struct perf_session *session __maybe_unused,
23 				  union perf_event *event __maybe_unused)
24 {
25 	session_done = 1;
26 	return 0;
27 }
28 
29 static int __cmd_evlist(const char *file_name, struct perf_attr_details *details)
30 {
31 	struct perf_session *session;
32 	struct evsel *pos;
33 	struct perf_data data = {
34 		.path      = file_name,
35 		.mode      = PERF_DATA_MODE_READ,
36 		.force     = details->force,
37 	};
38 	struct perf_tool tool;
39 	bool has_tracepoint = false, has_group = false;
40 
41 	perf_tool__init(&tool, /*ordered_events=*/false);
42 	/* only needed for pipe mode */
43 	tool.attr = perf_event__process_attr;
44 	tool.feature = process_header_feature;
45 	session = perf_session__new(&data, &tool);
46 	if (IS_ERR(session))
47 		return PTR_ERR(session);
48 
49 	if (data.is_pipe)
50 		perf_session__process_events(session);
51 
52 	evlist__for_each_entry(session->evlist, pos) {
53 		evsel__fprintf(pos, details, stdout);
54 
55 		if (pos->core.attr.type == PERF_TYPE_TRACEPOINT)
56 			has_tracepoint = true;
57 
58 		if (!evsel__is_group_leader(pos))
59 			has_group = true;
60 	}
61 
62 	if (has_tracepoint && !details->trace_fields)
63 		printf("# Tip: use 'perf evlist --trace-fields' to show fields for tracepoint events\n");
64 
65 	if (has_group && !details->event_group)
66 		printf("# Tip: use 'perf evlist -g' to show group information\n");
67 
68 	perf_session__delete(session);
69 	return 0;
70 }
71 
72 int cmd_evlist(int argc, const char **argv)
73 {
74 	struct perf_attr_details details = { .verbose = false, };
75 	const struct option options[] = {
76 	OPT_STRING('i', "input", &input_name, "file", "Input file name"),
77 	OPT_BOOLEAN('F', "freq", &details.freq, "Show the sample frequency"),
78 	OPT_BOOLEAN('v', "verbose", &details.verbose,
79 		    "Show all event attr details"),
80 	OPT_BOOLEAN('g', "group", &details.event_group,
81 		    "Show event group information"),
82 	OPT_BOOLEAN('f', "force", &details.force, "don't complain, do it"),
83 	OPT_BOOLEAN(0, "trace-fields", &details.trace_fields, "Show tracepoint fields"),
84 	OPT_END()
85 	};
86 	const char * const evlist_usage[] = {
87 		"perf evlist [<options>]",
88 		NULL
89 	};
90 
91 	argc = parse_options(argc, argv, options, evlist_usage, 0);
92 	if (argc)
93 		usage_with_options(evlist_usage, options);
94 
95 	if (details.event_group && (details.verbose || details.freq)) {
96 		usage_with_options_msg(evlist_usage, options,
97 			"--group option is not compatible with other options\n");
98 	}
99 
100 	return __cmd_evlist(input_name, &details);
101 }
102