1/*
2 * builtin-buildid-list.c
3 *
4 * Builtin buildid-list command: list buildids in perf.data, in the running
5 * kernel and in ELF files.
6 *
7 * Copyright (C) 2009, Red Hat Inc.
8 * Copyright (C) 2009, Arnaldo Carvalho de Melo <acme@redhat.com>
9 */
10#include "builtin.h"
11#include "util/build-id.h"
12#include "util/debug.h"
13#include "util/dso.h"
14#include "util/map.h"
15#include <subcmd/pager.h>
16#include <subcmd/parse-options.h>
17#include "util/session.h"
18#include "util/symbol.h"
19#include "util/data.h"
20#include "util/util.h"
21#include <errno.h>
22#include <inttypes.h>
23#include <linux/err.h>
24
25static int buildid__map_cb(struct map *map, void *arg __maybe_unused)
26{
27	const struct dso *dso = map__dso(map);
28	char bid_buf[SBUILD_ID_SIZE];
29
30	memset(bid_buf, 0, sizeof(bid_buf));
31	if (dso->has_build_id)
32		build_id__sprintf(&dso->bid, bid_buf);
33	printf("%s %16" PRIx64 " %16" PRIx64, bid_buf, map__start(map), map__end(map));
34	if (dso->long_name != NULL) {
35		printf(" %s", dso->long_name);
36	} else if (dso->short_name != NULL) {
37		printf(" %s", dso->short_name);
38	}
39	printf("\n");
40
41	return 0;
42}
43
44static void buildid__show_kernel_maps(void)
45{
46	struct machine *machine;
47
48	machine = machine__new_host();
49	machine__for_each_kernel_map(machine, buildid__map_cb, NULL);
50	machine__delete(machine);
51}
52
53static int sysfs__fprintf_build_id(FILE *fp)
54{
55	char sbuild_id[SBUILD_ID_SIZE];
56	int ret;
57
58	ret = sysfs__sprintf_build_id("/", sbuild_id);
59	if (ret != sizeof(sbuild_id))
60		return ret < 0 ? ret : -EINVAL;
61
62	return fprintf(fp, "%s\n", sbuild_id);
63}
64
65static int filename__fprintf_build_id(const char *name, FILE *fp)
66{
67	char sbuild_id[SBUILD_ID_SIZE];
68	int ret;
69
70	ret = filename__sprintf_build_id(name, sbuild_id);
71	if (ret != sizeof(sbuild_id))
72		return ret < 0 ? ret : -EINVAL;
73
74	return fprintf(fp, "%s\n", sbuild_id);
75}
76
77static bool dso__skip_buildid(struct dso *dso, int with_hits)
78{
79	return with_hits && !dso->hit;
80}
81
82static int perf_session__list_build_ids(bool force, bool with_hits)
83{
84	struct perf_session *session;
85	struct perf_data data = {
86		.path  = input_name,
87		.mode  = PERF_DATA_MODE_READ,
88		.force = force,
89	};
90
91	symbol__elf_init();
92	/*
93	 * See if this is an ELF file first:
94	 */
95	if (filename__fprintf_build_id(input_name, stdout) > 0)
96		goto out;
97
98	session = perf_session__new(&data, &build_id__mark_dso_hit_ops);
99	if (IS_ERR(session))
100		return PTR_ERR(session);
101
102	/*
103	 * We take all buildids when the file contains AUX area tracing data
104	 * because we do not decode the trace because it would take too long.
105	 */
106	if (!perf_data__is_pipe(&data) &&
107	    perf_header__has_feat(&session->header, HEADER_AUXTRACE))
108		with_hits = false;
109
110	if (!perf_header__has_feat(&session->header, HEADER_BUILD_ID))
111		with_hits = true;
112
113	if (zstd_init(&(session->zstd_data), 0) < 0)
114		pr_warning("Decompression initialization failed. Reported data may be incomplete.\n");
115
116	/*
117	 * in pipe-mode, the only way to get the buildids is to parse
118	 * the record stream. Buildids are stored as RECORD_HEADER_BUILD_ID
119	 */
120	if (with_hits || perf_data__is_pipe(&data))
121		perf_session__process_events(session);
122
123	perf_session__fprintf_dsos_buildid(session, stdout, dso__skip_buildid, with_hits);
124	perf_session__delete(session);
125out:
126	return 0;
127}
128
129int cmd_buildid_list(int argc, const char **argv)
130{
131	bool show_kernel = false;
132	bool show_kernel_maps = false;
133	bool with_hits = false;
134	bool force = false;
135	const struct option options[] = {
136	OPT_BOOLEAN('H', "with-hits", &with_hits, "Show only DSOs with hits"),
137	OPT_STRING('i', "input", &input_name, "file", "input file name"),
138	OPT_BOOLEAN('f', "force", &force, "don't complain, do it"),
139	OPT_BOOLEAN('k', "kernel", &show_kernel, "Show current kernel build id"),
140	OPT_BOOLEAN('m', "kernel-maps", &show_kernel_maps,
141	    "Show build id of current kernel + modules"),
142	OPT_INCR('v', "verbose", &verbose, "be more verbose"),
143	OPT_END()
144	};
145	const char * const buildid_list_usage[] = {
146		"perf buildid-list [<options>]",
147		NULL
148	};
149
150	argc = parse_options(argc, argv, options, buildid_list_usage, 0);
151	setup_pager();
152
153	if (show_kernel) {
154		return !(sysfs__fprintf_build_id(stdout) > 0);
155	} else if (show_kernel_maps) {
156		buildid__show_kernel_maps();
157		return 0;
158	}
159
160	return perf_session__list_build_ids(force, with_hits);
161}
162