1 // SPDX-License-Identifier: GPL-2.0
3 * builtin-buildid-cache.c
5 * Builtin buildid-cache command: Manages build-id cache
7 * Copyright (C) 2010, Red Hat Inc.
8 * Copyright (C) 2010, Arnaldo Carvalho de Melo <acme@redhat.com>
10 #include <sys/types.h>
17 #include "namespaces.h"
18 #include "util/debug.h"
19 #include "util/header.h"
20 #include <subcmd/pager.h>
21 #include <subcmd/parse-options.h>
22 #include "util/strlist.h"
23 #include "util/build-id.h"
24 #include "util/session.h"
26 #include "util/symbol.h"
27 #include "util/time-utils.h"
28 #include "util/util.h"
29 #include "util/probe-file.h"
30 #include <linux/string.h>
32 static int build_id_cache__kcore_buildid(const char *proc_dir, char *sbuildid)
34 char root_dir[PATH_MAX];
37 strlcpy(root_dir, proc_dir, sizeof(root_dir));
39 p = strrchr(root_dir, '/');
43 return sysfs__sprintf_build_id(root_dir, sbuildid);
46 static int build_id_cache__kcore_dir(char *dir, size_t sz)
48 return fetch_current_timestamp(dir, sz);
51 static bool same_kallsyms_reloc(const char *from_dir, char *to_dir)
56 u64 addr1 = 0, addr2 = 0;
59 scnprintf(from, sizeof(from), "%s/kallsyms", from_dir);
60 scnprintf(to, sizeof(to), "%s/kallsyms", to_dir);
62 for (i = 0; (name = ref_reloc_sym_names[i]) != NULL; i++) {
63 err = kallsyms__get_function_start(from, name, &addr1);
71 if (kallsyms__get_function_start(to, name, &addr2))
74 return addr1 == addr2;
77 static int build_id_cache__kcore_existing(const char *from_dir, char *to_dir,
82 char to_subdir[PATH_MAX];
91 scnprintf(from, sizeof(from), "%s/modules", from_dir);
97 if (dent->d_type != DT_DIR)
99 scnprintf(to, sizeof(to), "%s/%s/modules", to_dir,
101 scnprintf(to_subdir, sizeof(to_subdir), "%s/%s",
102 to_dir, dent->d_name);
103 if (!compare_proc_modules(from, to) &&
104 same_kallsyms_reloc(from_dir, to_subdir)) {
105 strlcpy(to_dir, to_subdir, to_dir_sz);
116 static int build_id_cache__add_kcore(const char *filename, bool force)
118 char dir[32], sbuildid[SBUILD_ID_SIZE];
119 char from_dir[PATH_MAX], to_dir[PATH_MAX];
122 strlcpy(from_dir, filename, sizeof(from_dir));
124 p = strrchr(from_dir, '/');
125 if (!p || strcmp(p + 1, "kcore"))
129 if (build_id_cache__kcore_buildid(from_dir, sbuildid) < 0)
132 scnprintf(to_dir, sizeof(to_dir), "%s/%s/%s",
133 buildid_dir, DSO__NAME_KCORE, sbuildid);
136 !build_id_cache__kcore_existing(from_dir, to_dir, sizeof(to_dir))) {
137 pr_debug("same kcore found in %s\n", to_dir);
141 if (build_id_cache__kcore_dir(dir, sizeof(dir)))
144 scnprintf(to_dir, sizeof(to_dir), "%s/%s/%s/%s",
145 buildid_dir, DSO__NAME_KCORE, sbuildid, dir);
147 if (mkdir_p(to_dir, 0755))
150 if (kcore_copy(from_dir, to_dir)) {
151 /* Remove YYYYmmddHHMMSShh directory */
152 if (!rmdir(to_dir)) {
153 p = strrchr(to_dir, '/');
156 /* Try to remove buildid directory */
157 if (!rmdir(to_dir)) {
158 p = strrchr(to_dir, '/');
161 /* Try to remove [kernel.kcore] directory */
168 pr_debug("kcore added to build-id cache directory %s\n", to_dir);
173 static int build_id_cache__add_file(const char *filename, struct nsinfo *nsi)
175 char sbuild_id[SBUILD_ID_SIZE];
176 u8 build_id[BUILD_ID_SIZE];
180 nsinfo__mountns_enter(nsi, &nsc);
181 err = filename__read_build_id(filename, &build_id, sizeof(build_id));
182 nsinfo__mountns_exit(&nsc);
184 pr_debug("Couldn't read a build-id in %s\n", filename);
188 build_id__sprintf(build_id, sizeof(build_id), sbuild_id);
189 err = build_id_cache__add_s(sbuild_id, filename, nsi,
191 pr_debug("Adding %s %s: %s\n", sbuild_id, filename,
192 err ? "FAIL" : "Ok");
196 static int build_id_cache__remove_file(const char *filename, struct nsinfo *nsi)
198 u8 build_id[BUILD_ID_SIZE];
199 char sbuild_id[SBUILD_ID_SIZE];
204 nsinfo__mountns_enter(nsi, &nsc);
205 err = filename__read_build_id(filename, &build_id, sizeof(build_id));
206 nsinfo__mountns_exit(&nsc);
208 pr_debug("Couldn't read a build-id in %s\n", filename);
212 build_id__sprintf(build_id, sizeof(build_id), sbuild_id);
213 err = build_id_cache__remove_s(sbuild_id);
214 pr_debug("Removing %s %s: %s\n", sbuild_id, filename,
215 err ? "FAIL" : "Ok");
220 static int build_id_cache__purge_path(const char *pathname, struct nsinfo *nsi)
222 struct strlist *list;
223 struct str_node *pos;
226 err = build_id_cache__list_build_ids(pathname, nsi, &list);
230 strlist__for_each_entry(pos, list) {
231 err = build_id_cache__remove_s(pos->s);
232 pr_debug("Removing %s %s: %s\n", pos->s, pathname,
233 err ? "FAIL" : "Ok");
237 strlist__delete(list);
240 pr_debug("Purging %s: %s\n", pathname, err ? "FAIL" : "Ok");
245 static int build_id_cache__purge_all(void)
247 struct strlist *list;
248 struct str_node *pos;
252 list = build_id_cache__list_all(false);
254 pr_debug("Failed to get buildids: -%d\n", errno);
258 strlist__for_each_entry(pos, list) {
259 buf = build_id_cache__origname(pos->s);
260 err = build_id_cache__remove_s(pos->s);
261 pr_debug("Removing %s (%s): %s\n", buf, pos->s,
262 err ? "FAIL" : "Ok");
267 strlist__delete(list);
269 pr_debug("Purged all: %s\n", err ? "FAIL" : "Ok");
273 static bool dso__missing_buildid_cache(struct dso *dso, int parm __maybe_unused)
275 char filename[PATH_MAX];
276 u8 build_id[BUILD_ID_SIZE];
278 if (dso__build_id_filename(dso, filename, sizeof(filename), false) &&
279 filename__read_build_id(filename, build_id,
280 sizeof(build_id)) != sizeof(build_id)) {
284 pr_warning("Problems with %s file, consider removing it from the cache\n",
286 } else if (memcmp(dso->build_id, build_id, sizeof(dso->build_id))) {
287 pr_warning("Problems with %s file, consider removing it from the cache\n",
294 static int build_id_cache__fprintf_missing(struct perf_session *session, FILE *fp)
296 perf_session__fprintf_dsos_buildid(session, fp, dso__missing_buildid_cache, 0);
300 static int build_id_cache__update_file(const char *filename, struct nsinfo *nsi)
302 u8 build_id[BUILD_ID_SIZE];
303 char sbuild_id[SBUILD_ID_SIZE];
308 nsinfo__mountns_enter(nsi, &nsc);
309 err = filename__read_build_id(filename, &build_id, sizeof(build_id));
310 nsinfo__mountns_exit(&nsc);
312 pr_debug("Couldn't read a build-id in %s\n", filename);
317 build_id__sprintf(build_id, sizeof(build_id), sbuild_id);
318 if (build_id_cache__cached(sbuild_id))
319 err = build_id_cache__remove_s(sbuild_id);
322 err = build_id_cache__add_s(sbuild_id, filename, nsi, false,
325 pr_debug("Updating %s %s: %s\n", sbuild_id, filename,
326 err ? "FAIL" : "Ok");
331 static int build_id_cache__show_all(void)
333 struct strlist *bidlist;
337 bidlist = build_id_cache__list_all(true);
339 pr_debug("Failed to get buildids: -%d\n", errno);
342 strlist__for_each_entry(nd, bidlist) {
343 buf = build_id_cache__origname(nd->s);
344 fprintf(stdout, "%s %s\n", nd->s, buf);
347 strlist__delete(bidlist);
351 int cmd_buildid_cache(int argc, const char **argv)
353 struct strlist *list;
354 struct str_node *pos;
358 bool list_files = false;
359 bool opts_flag = false;
360 bool purge_all = false;
361 char const *add_name_list_str = NULL,
362 *remove_name_list_str = NULL,
363 *purge_name_list_str = NULL,
364 *missing_filename = NULL,
365 *update_name_list_str = NULL,
366 *kcore_filename = NULL;
367 char sbuf[STRERR_BUFSIZE];
369 struct perf_data data = {
370 .mode = PERF_DATA_MODE_READ,
372 struct perf_session *session = NULL;
373 struct nsinfo *nsi = NULL;
375 const struct option buildid_cache_options[] = {
376 OPT_STRING('a', "add", &add_name_list_str,
377 "file list", "file(s) to add"),
378 OPT_STRING('k', "kcore", &kcore_filename,
379 "file", "kcore file to add"),
380 OPT_STRING('r', "remove", &remove_name_list_str, "file list",
381 "file(s) to remove"),
382 OPT_STRING('p', "purge", &purge_name_list_str, "file list",
383 "file(s) to remove (remove old caches too)"),
384 OPT_BOOLEAN('P', "purge-all", &purge_all, "purge all cached files"),
385 OPT_BOOLEAN('l', "list", &list_files, "list all cached files"),
386 OPT_STRING('M', "missing", &missing_filename, "file",
387 "to find missing build ids in the cache"),
388 OPT_BOOLEAN('f', "force", &force, "don't complain, do it"),
389 OPT_STRING('u', "update", &update_name_list_str, "file list",
390 "file(s) to update"),
391 OPT_INCR('v', "verbose", &verbose, "be more verbose"),
392 OPT_INTEGER(0, "target-ns", &ns_id, "target pid for namespace context"),
395 const char * const buildid_cache_usage[] = {
396 "perf buildid-cache [<options>]",
400 argc = parse_options(argc, argv, buildid_cache_options,
401 buildid_cache_usage, 0);
403 opts_flag = add_name_list_str || kcore_filename ||
404 remove_name_list_str || purge_name_list_str ||
405 missing_filename || update_name_list_str ||
408 if (argc || !(list_files || opts_flag))
409 usage_with_options(buildid_cache_usage, buildid_cache_options);
411 /* -l is exclusive. It can not be used with other options. */
412 if (list_files && opts_flag) {
413 usage_with_options_msg(buildid_cache_usage,
414 buildid_cache_options, "-l is exclusive.\n");
418 nsi = nsinfo__new(ns_id);
420 if (missing_filename) {
421 data.path = missing_filename;
424 session = perf_session__new(&data, false, NULL);
429 if (symbol__init(session ? &session->header.env : NULL) < 0)
435 ret = build_id_cache__show_all();
439 if (add_name_list_str) {
440 list = strlist__new(add_name_list_str, NULL);
442 strlist__for_each_entry(pos, list)
443 if (build_id_cache__add_file(pos->s, nsi)) {
444 if (errno == EEXIST) {
445 pr_debug("%s already in the cache\n",
449 pr_warning("Couldn't add %s: %s\n",
450 pos->s, str_error_r(errno, sbuf, sizeof(sbuf)));
453 strlist__delete(list);
457 if (remove_name_list_str) {
458 list = strlist__new(remove_name_list_str, NULL);
460 strlist__for_each_entry(pos, list)
461 if (build_id_cache__remove_file(pos->s, nsi)) {
462 if (errno == ENOENT) {
463 pr_debug("%s wasn't in the cache\n",
467 pr_warning("Couldn't remove %s: %s\n",
468 pos->s, str_error_r(errno, sbuf, sizeof(sbuf)));
471 strlist__delete(list);
475 if (purge_name_list_str) {
476 list = strlist__new(purge_name_list_str, NULL);
478 strlist__for_each_entry(pos, list)
479 if (build_id_cache__purge_path(pos->s, nsi)) {
480 if (errno == ENOENT) {
481 pr_debug("%s wasn't in the cache\n",
485 pr_warning("Couldn't remove %s: %s\n",
486 pos->s, str_error_r(errno, sbuf, sizeof(sbuf)));
489 strlist__delete(list);
494 if (build_id_cache__purge_all()) {
495 pr_warning("Couldn't remove some caches. Error: %s.\n",
496 str_error_r(errno, sbuf, sizeof(sbuf)));
500 if (missing_filename)
501 ret = build_id_cache__fprintf_missing(session, stdout);
503 if (update_name_list_str) {
504 list = strlist__new(update_name_list_str, NULL);
506 strlist__for_each_entry(pos, list)
507 if (build_id_cache__update_file(pos->s, nsi)) {
508 if (errno == ENOENT) {
509 pr_debug("%s wasn't in the cache\n",
513 pr_warning("Couldn't update %s: %s\n",
514 pos->s, str_error_r(errno, sbuf, sizeof(sbuf)));
517 strlist__delete(list);
521 if (kcore_filename && build_id_cache__add_kcore(kcore_filename, force))
522 pr_warning("Couldn't add %s\n", kcore_filename);
525 perf_session__delete(session);