1 // SPDX-License-Identifier: GPL-2.0
7 * Copyright (C) 2009, 2010 Red Hat Inc.
8 * Copyright (C) 2009, 2010 Arnaldo Carvalho de Melo <acme@redhat.com>
10 #include "util.h" // lsdir(), mkdir_p(), rm_rf()
15 #include <sys/types.h>
16 #include "util/copyfile.h"
20 #include "namespaces.h"
24 #include <linux/kernel.h>
31 #include "probe-file.h"
34 #ifdef HAVE_DEBUGINFOD_SUPPORT
35 #include <elfutils/debuginfod.h>
38 #include <linux/ctype.h>
39 #include <linux/zalloc.h>
41 static bool no_buildid_cache;
43 int build_id__mark_dso_hit(struct perf_tool *tool __maybe_unused,
44 union perf_event *event,
45 struct perf_sample *sample,
46 struct evsel *evsel __maybe_unused,
47 struct machine *machine)
49 struct addr_location al;
50 struct thread *thread = machine__findnew_thread(machine, sample->pid,
54 pr_err("problem processing %d event, skipping it.\n",
59 if (thread__find_map(thread, sample->cpumode, sample->ip, &al))
66 static int perf_event__exit_del_thread(struct perf_tool *tool __maybe_unused,
67 union perf_event *event,
68 struct perf_sample *sample
70 struct machine *machine)
72 struct thread *thread = machine__findnew_thread(machine,
76 dump_printf("(%d:%d):(%d:%d)\n", event->fork.pid, event->fork.tid,
77 event->fork.ppid, event->fork.ptid);
80 machine__remove_thread(machine, thread);
87 struct perf_tool build_id__mark_dso_hit_ops = {
88 .sample = build_id__mark_dso_hit,
89 .mmap = perf_event__process_mmap,
90 .mmap2 = perf_event__process_mmap2,
91 .fork = perf_event__process_fork,
92 .exit = perf_event__exit_del_thread,
93 .attr = perf_event__process_attr,
94 .build_id = perf_event__process_build_id,
95 .ordered_events = true,
98 int build_id__sprintf(const u8 *build_id, int len, char *bf)
101 const u8 *raw = build_id;
104 for (i = 0; i < len; ++i) {
105 sprintf(bid, "%02x", *raw);
110 return (bid - bf) + 1;
113 int sysfs__sprintf_build_id(const char *root_dir, char *sbuild_id)
115 char notes[PATH_MAX];
116 u8 build_id[BUILD_ID_SIZE];
122 scnprintf(notes, sizeof(notes), "%s/sys/kernel/notes", root_dir);
124 ret = sysfs__read_build_id(notes, build_id, sizeof(build_id));
128 return build_id__sprintf(build_id, sizeof(build_id), sbuild_id);
131 int filename__sprintf_build_id(const char *pathname, char *sbuild_id)
133 u8 build_id[BUILD_ID_SIZE];
136 ret = filename__read_build_id(pathname, build_id, sizeof(build_id));
139 else if (ret != sizeof(build_id))
142 return build_id__sprintf(build_id, sizeof(build_id), sbuild_id);
145 /* asnprintf consolidates asprintf and snprintf */
146 static int asnprintf(char **strp, size_t size, const char *fmt, ...)
156 ret = vsnprintf(*strp, size, fmt, ap);
158 ret = vasprintf(strp, fmt, ap);
164 char *build_id_cache__kallsyms_path(const char *sbuild_id, char *bf,
167 bool retry_old = true;
169 snprintf(bf, size, "%s/%s/%s/kallsyms",
170 buildid_dir, DSO__NAME_KALLSYMS, sbuild_id);
172 if (!access(bf, F_OK))
175 /* Try old style kallsyms cache */
176 snprintf(bf, size, "%s/%s/%s",
177 buildid_dir, DSO__NAME_KALLSYMS, sbuild_id);
185 char *build_id_cache__linkname(const char *sbuild_id, char *bf, size_t size)
188 int ret = asnprintf(&bf, size, "%s/.build-id/%.2s/%s", buildid_dir,
189 sbuild_id, sbuild_id + 2);
190 if (ret < 0 || (tmp && size < (unsigned int)ret))
195 /* The caller is responsible to free the returned buffer. */
196 char *build_id_cache__origname(const char *sbuild_id)
200 char *ret = NULL, *p;
201 size_t offs = 5; /* == strlen("../..") */
204 linkname = build_id_cache__linkname(sbuild_id, NULL, 0);
208 len = readlink(linkname, buf, sizeof(buf) - 1);
213 /* The link should be "../..<origpath>/<sbuild_id>" */
214 p = strrchr(buf, '/'); /* Cut off the "/<sbuild_id>" */
215 if (p && (p > buf + offs)) {
217 if (buf[offs + 1] == '[')
219 * This is a DSO name, like [kernel.kallsyms].
220 * Skip the first '/', since this is not the
221 * cache of a regular file.
223 ret = strdup(buf + offs); /* Skip "../..[/]" */
230 /* Check if the given build_id cache is valid on current running system */
231 static bool build_id_cache__valid_id(char *sbuild_id)
233 char real_sbuild_id[SBUILD_ID_SIZE] = "";
238 pathname = build_id_cache__origname(sbuild_id);
242 if (!strcmp(pathname, DSO__NAME_KALLSYMS))
243 ret = sysfs__sprintf_build_id("/", real_sbuild_id);
244 else if (pathname[0] == '/')
245 ret = filename__sprintf_build_id(pathname, real_sbuild_id);
247 ret = -EINVAL; /* Should we support other special DSO cache? */
249 result = (strcmp(sbuild_id, real_sbuild_id) == 0);
255 static const char *build_id_cache__basename(bool is_kallsyms, bool is_vdso,
258 return is_kallsyms ? "kallsyms" : (is_vdso ? "vdso" : (is_debug ?
262 char *dso__build_id_filename(const struct dso *dso, char *bf, size_t size,
265 bool is_kallsyms = dso__is_kallsyms((struct dso *)dso);
266 bool is_vdso = dso__is_vdso((struct dso *)dso);
267 char sbuild_id[SBUILD_ID_SIZE];
269 bool alloc = (bf == NULL);
272 if (!dso->has_build_id)
275 build_id__sprintf(dso->build_id, sizeof(dso->build_id), sbuild_id);
276 linkname = build_id_cache__linkname(sbuild_id, NULL, 0);
280 /* Check if old style build_id cache */
281 if (is_regular_file(linkname))
282 ret = asnprintf(&bf, size, "%s", linkname);
284 ret = asnprintf(&bf, size, "%s/%s", linkname,
285 build_id_cache__basename(is_kallsyms, is_vdso,
287 if (ret < 0 || (!alloc && size < (unsigned int)ret))
294 #define dsos__for_each_with_build_id(pos, head) \
295 list_for_each_entry(pos, head, node) \
296 if (!pos->has_build_id) \
300 static int write_buildid(const char *name, size_t name_len, u8 *build_id,
301 pid_t pid, u16 misc, struct feat_fd *fd)
304 struct perf_record_header_build_id b;
308 len = PERF_ALIGN(len, NAME_ALIGN);
310 memset(&b, 0, sizeof(b));
311 memcpy(&b.build_id, build_id, BUILD_ID_SIZE);
313 b.header.misc = misc;
314 b.header.size = sizeof(b) + len;
316 err = do_write(fd, &b, sizeof(b));
320 return write_padded(fd, name, name_len + 1, len);
323 static int machine__write_buildid_table(struct machine *machine,
328 u16 kmisc = PERF_RECORD_MISC_KERNEL,
329 umisc = PERF_RECORD_MISC_USER;
331 if (!machine__is_host(machine)) {
332 kmisc = PERF_RECORD_MISC_GUEST_KERNEL;
333 umisc = PERF_RECORD_MISC_GUEST_USER;
336 dsos__for_each_with_build_id(pos, &machine->dsos.head) {
339 bool in_kernel = false;
341 if (!pos->hit && !dso__is_vdso(pos))
344 if (dso__is_vdso(pos)) {
345 name = pos->short_name;
346 name_len = pos->short_name_len;
347 } else if (dso__is_kcore(pos)) {
348 name = machine->mmap_name;
349 name_len = strlen(name);
351 name = pos->long_name;
352 name_len = pos->long_name_len;
355 in_kernel = pos->kernel ||
356 is_kernel_module(name,
357 PERF_RECORD_MISC_CPUMODE_UNKNOWN);
358 err = write_buildid(name, name_len, pos->build_id, machine->pid,
359 in_kernel ? kmisc : umisc, fd);
367 int perf_session__write_buildid_table(struct perf_session *session,
371 int err = machine__write_buildid_table(&session->machines.host, fd);
376 for (nd = rb_first_cached(&session->machines.guests); nd;
378 struct machine *pos = rb_entry(nd, struct machine, rb_node);
379 err = machine__write_buildid_table(pos, fd);
386 static int __dsos__hit_all(struct list_head *head)
390 list_for_each_entry(pos, head, node)
396 static int machine__hit_all_dsos(struct machine *machine)
398 return __dsos__hit_all(&machine->dsos.head);
401 int dsos__hit_all(struct perf_session *session)
406 err = machine__hit_all_dsos(&session->machines.host);
410 for (nd = rb_first_cached(&session->machines.guests); nd;
412 struct machine *pos = rb_entry(nd, struct machine, rb_node);
414 err = machine__hit_all_dsos(pos);
422 void disable_buildid_cache(void)
424 no_buildid_cache = true;
427 static bool lsdir_bid_head_filter(const char *name __maybe_unused,
430 return (strlen(d->d_name) == 2) &&
431 isxdigit(d->d_name[0]) && isxdigit(d->d_name[1]);
434 static bool lsdir_bid_tail_filter(const char *name __maybe_unused,
438 while (isxdigit(d->d_name[i]) && i < SBUILD_ID_SIZE - 3)
440 return (i == SBUILD_ID_SIZE - 3) && (d->d_name[i] == '\0');
443 struct strlist *build_id_cache__list_all(bool validonly)
445 struct strlist *toplist, *linklist = NULL, *bidlist;
446 struct str_node *nd, *nd2;
447 char *topdir, *linkdir = NULL;
448 char sbuild_id[SBUILD_ID_SIZE];
450 /* for filename__ functions */
454 /* Open the top-level directory */
455 if (asprintf(&topdir, "%s/.build-id/", buildid_dir) < 0)
458 bidlist = strlist__new(NULL, NULL);
462 toplist = lsdir(topdir, lsdir_bid_head_filter);
464 pr_debug("Error in lsdir(%s): %d\n", topdir, errno);
465 /* If there is no buildid cache, return an empty list */
471 strlist__for_each_entry(nd, toplist) {
472 if (asprintf(&linkdir, "%s/%s", topdir, nd->s) < 0)
474 /* Open the lower-level directory */
475 linklist = lsdir(linkdir, lsdir_bid_tail_filter);
477 pr_debug("Error in lsdir(%s): %d\n", linkdir, errno);
480 strlist__for_each_entry(nd2, linklist) {
481 if (snprintf(sbuild_id, SBUILD_ID_SIZE, "%s%s",
482 nd->s, nd2->s) != SBUILD_ID_SIZE - 1)
484 if (validonly && !build_id_cache__valid_id(sbuild_id))
486 if (strlist__add(bidlist, sbuild_id) < 0)
489 strlist__delete(linklist);
494 strlist__delete(toplist);
501 strlist__delete(linklist);
503 strlist__delete(bidlist);
508 static bool str_is_build_id(const char *maybe_sbuild_id, size_t len)
512 for (i = 0; i < len; i++) {
513 if (!isxdigit(maybe_sbuild_id[i]))
519 /* Return the valid complete build-id */
520 char *build_id_cache__complement(const char *incomplete_sbuild_id)
522 struct strlist *bidlist;
523 struct str_node *nd, *cand = NULL;
524 char *sbuild_id = NULL;
525 size_t len = strlen(incomplete_sbuild_id);
527 if (len >= SBUILD_ID_SIZE ||
528 !str_is_build_id(incomplete_sbuild_id, len))
531 bidlist = build_id_cache__list_all(true);
535 strlist__for_each_entry(nd, bidlist) {
536 if (strncmp(nd->s, incomplete_sbuild_id, len) != 0)
538 if (cand) { /* Error: There are more than 2 candidates. */
545 sbuild_id = strdup(cand->s);
546 strlist__delete(bidlist);
551 char *build_id_cache__cachedir(const char *sbuild_id, const char *name,
552 struct nsinfo *nsi, bool is_kallsyms,
555 char *realname = (char *)name, *filename;
556 bool slash = is_kallsyms || is_vdso;
559 realname = nsinfo__realpath(name, nsi);
564 if (asprintf(&filename, "%s%s%s%s%s", buildid_dir, slash ? "/" : "",
565 is_vdso ? DSO__NAME_VDSO : realname,
566 sbuild_id ? "/" : "", sbuild_id ?: "") < 0)
575 int build_id_cache__list_build_ids(const char *pathname, struct nsinfo *nsi,
576 struct strlist **result)
581 dir_name = build_id_cache__cachedir(NULL, pathname, nsi, false, false);
585 *result = lsdir(dir_name, lsdir_no_dot_filter);
593 #if defined(HAVE_LIBELF_SUPPORT) && defined(HAVE_GELF_GETNOTE_SUPPORT)
594 static int build_id_cache__add_sdt_cache(const char *sbuild_id,
595 const char *realname,
598 struct probe_cache *cache;
602 cache = probe_cache__new(sbuild_id, nsi);
606 nsinfo__mountns_enter(nsi, &nsc);
607 ret = probe_cache__scan_sdt(cache, realname);
608 nsinfo__mountns_exit(&nsc);
610 pr_debug4("Found %d SDTs in %s\n", ret, realname);
611 if (probe_cache__commit(cache) < 0)
614 probe_cache__delete(cache);
618 #define build_id_cache__add_sdt_cache(sbuild_id, realname, nsi) (0)
621 static char *build_id_cache__find_debug(const char *sbuild_id,
624 char *realname = NULL;
629 debugfile = calloc(1, PATH_MAX);
633 len = __symbol__join_symfs(debugfile, PATH_MAX,
634 "/usr/lib/debug/.build-id/");
635 snprintf(debugfile + len, PATH_MAX - len, "%.2s/%s.debug", sbuild_id,
638 nsinfo__mountns_enter(nsi, &nsc);
639 realname = realpath(debugfile, NULL);
640 if (realname && access(realname, R_OK))
642 nsinfo__mountns_exit(&nsc);
644 #ifdef HAVE_DEBUGINFOD_SUPPORT
645 if (realname == NULL) {
646 debuginfod_client* c = debuginfod_begin();
648 int fd = debuginfod_find_debuginfo(c,
649 (const unsigned char*)sbuild_id, 0,
652 close(fd); /* retaining reference by realname */
663 int build_id_cache__add_s(const char *sbuild_id, const char *name,
664 struct nsinfo *nsi, bool is_kallsyms, bool is_vdso)
666 const size_t size = PATH_MAX;
667 char *realname = NULL, *filename = NULL, *dir_name = NULL,
668 *linkname = zalloc(size), *tmp;
669 char *debugfile = NULL;
674 realname = nsinfo__realpath(name, nsi);
676 realname = realpath(name, NULL);
681 dir_name = build_id_cache__cachedir(sbuild_id, name, nsi, is_kallsyms,
686 /* Remove old style build-id cache */
687 if (is_regular_file(dir_name))
688 if (unlink(dir_name))
691 if (mkdir_p(dir_name, 0755))
694 /* Save the allocated buildid dirname */
695 if (asprintf(&filename, "%s/%s", dir_name,
696 build_id_cache__basename(is_kallsyms, is_vdso,
702 if (access(filename, F_OK)) {
704 if (copyfile("/proc/kallsyms", filename))
706 } else if (nsi && nsi->need_setns) {
707 if (copyfile_ns(name, filename, nsi))
709 } else if (link(realname, filename) && errno != EEXIST &&
710 copyfile(name, filename))
714 /* Some binaries are stripped, but have .debug files with their symbol
715 * table. Check to see if we can locate one of those, since the elf
716 * file itself may not be very useful to users of our tools without a
719 if (!is_kallsyms && !is_vdso &&
720 strncmp(".ko", name + strlen(name) - 3, 3)) {
721 debugfile = build_id_cache__find_debug(sbuild_id, nsi);
724 if (asprintf(&filename, "%s/%s", dir_name,
725 build_id_cache__basename(false, false, true)) < 0) {
729 if (access(filename, F_OK)) {
730 if (nsi && nsi->need_setns) {
731 if (copyfile_ns(debugfile, filename,
734 } else if (link(debugfile, filename) &&
736 copyfile(debugfile, filename))
742 if (!build_id_cache__linkname(sbuild_id, linkname, size))
744 tmp = strrchr(linkname, '/');
747 if (access(linkname, X_OK) && mkdir_p(linkname, 0755))
751 tmp = dir_name + strlen(buildid_dir) - 5;
752 memcpy(tmp, "../..", 5);
754 if (symlink(tmp, linkname) == 0)
757 /* Update SDT cache : error is just warned */
759 build_id_cache__add_sdt_cache(sbuild_id, realname, nsi) < 0)
760 pr_debug4("Failed to update/scan SDT cache for %s\n", realname);
772 static int build_id_cache__add_b(const u8 *build_id, size_t build_id_size,
773 const char *name, struct nsinfo *nsi,
774 bool is_kallsyms, bool is_vdso)
776 char sbuild_id[SBUILD_ID_SIZE];
778 build_id__sprintf(build_id, build_id_size, sbuild_id);
780 return build_id_cache__add_s(sbuild_id, name, nsi, is_kallsyms,
784 bool build_id_cache__cached(const char *sbuild_id)
787 char *filename = build_id_cache__linkname(sbuild_id, NULL, 0);
789 if (filename && !access(filename, F_OK))
796 int build_id_cache__remove_s(const char *sbuild_id)
798 const size_t size = PATH_MAX;
799 char *filename = zalloc(size),
800 *linkname = zalloc(size), *tmp;
803 if (filename == NULL || linkname == NULL)
806 if (!build_id_cache__linkname(sbuild_id, linkname, size))
809 if (access(linkname, F_OK))
812 if (readlink(linkname, filename, size - 1) < 0)
815 if (unlink(linkname))
819 * Since the link is relative, we must make it absolute:
821 tmp = strrchr(linkname, '/') + 1;
822 snprintf(tmp, size - (tmp - linkname), "%s", filename);
834 static int dso__cache_build_id(struct dso *dso, struct machine *machine)
836 bool is_kallsyms = dso__is_kallsyms(dso);
837 bool is_vdso = dso__is_vdso(dso);
838 const char *name = dso->long_name;
840 if (dso__is_kcore(dso)) {
842 name = machine->mmap_name;
844 return build_id_cache__add_b(dso->build_id, sizeof(dso->build_id), name,
845 dso->nsinfo, is_kallsyms, is_vdso);
848 static int __dsos__cache_build_ids(struct list_head *head,
849 struct machine *machine)
854 dsos__for_each_with_build_id(pos, head)
855 if (dso__cache_build_id(pos, machine))
861 static int machine__cache_build_ids(struct machine *machine)
863 return __dsos__cache_build_ids(&machine->dsos.head, machine);
866 int perf_session__cache_build_ids(struct perf_session *session)
871 if (no_buildid_cache)
874 if (mkdir(buildid_dir, 0755) != 0 && errno != EEXIST)
877 ret = machine__cache_build_ids(&session->machines.host);
879 for (nd = rb_first_cached(&session->machines.guests); nd;
881 struct machine *pos = rb_entry(nd, struct machine, rb_node);
882 ret |= machine__cache_build_ids(pos);
887 static bool machine__read_build_ids(struct machine *machine, bool with_hits)
889 return __dsos__read_build_ids(&machine->dsos.head, with_hits);
892 bool perf_session__read_build_ids(struct perf_session *session, bool with_hits)
895 bool ret = machine__read_build_ids(&session->machines.host, with_hits);
897 for (nd = rb_first_cached(&session->machines.guests); nd;
899 struct machine *pos = rb_entry(nd, struct machine, rb_node);
900 ret |= machine__read_build_ids(pos, with_hits);