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];
122 scnprintf(notes, sizeof(notes), "%s/sys/kernel/notes", root_dir);
124 ret = sysfs__read_build_id(notes, &bid);
128 return build_id__sprintf(bid.data, sizeof(bid.data), sbuild_id);
131 int filename__sprintf_build_id(const char *pathname, char *sbuild_id)
136 ret = filename__read_build_id(pathname, &bid);
140 return build_id__sprintf(bid.data, sizeof(bid.data), sbuild_id);
143 /* asnprintf consolidates asprintf and snprintf */
144 static int asnprintf(char **strp, size_t size, const char *fmt, ...)
154 ret = vsnprintf(*strp, size, fmt, ap);
156 ret = vasprintf(strp, fmt, ap);
162 char *build_id_cache__kallsyms_path(const char *sbuild_id, char *bf,
165 bool retry_old = true;
167 snprintf(bf, size, "%s/%s/%s/kallsyms",
168 buildid_dir, DSO__NAME_KALLSYMS, sbuild_id);
170 if (!access(bf, F_OK))
173 /* Try old style kallsyms cache */
174 snprintf(bf, size, "%s/%s/%s",
175 buildid_dir, DSO__NAME_KALLSYMS, sbuild_id);
183 char *build_id_cache__linkname(const char *sbuild_id, char *bf, size_t size)
186 int ret = asnprintf(&bf, size, "%s/.build-id/%.2s/%s", buildid_dir,
187 sbuild_id, sbuild_id + 2);
188 if (ret < 0 || (tmp && size < (unsigned int)ret))
193 /* The caller is responsible to free the returned buffer. */
194 char *build_id_cache__origname(const char *sbuild_id)
198 char *ret = NULL, *p;
199 size_t offs = 5; /* == strlen("../..") */
202 linkname = build_id_cache__linkname(sbuild_id, NULL, 0);
206 len = readlink(linkname, buf, sizeof(buf) - 1);
211 /* The link should be "../..<origpath>/<sbuild_id>" */
212 p = strrchr(buf, '/'); /* Cut off the "/<sbuild_id>" */
213 if (p && (p > buf + offs)) {
215 if (buf[offs + 1] == '[')
217 * This is a DSO name, like [kernel.kallsyms].
218 * Skip the first '/', since this is not the
219 * cache of a regular file.
221 ret = strdup(buf + offs); /* Skip "../..[/]" */
228 /* Check if the given build_id cache is valid on current running system */
229 static bool build_id_cache__valid_id(char *sbuild_id)
231 char real_sbuild_id[SBUILD_ID_SIZE] = "";
236 pathname = build_id_cache__origname(sbuild_id);
240 if (!strcmp(pathname, DSO__NAME_KALLSYMS))
241 ret = sysfs__sprintf_build_id("/", real_sbuild_id);
242 else if (pathname[0] == '/')
243 ret = filename__sprintf_build_id(pathname, real_sbuild_id);
245 ret = -EINVAL; /* Should we support other special DSO cache? */
247 result = (strcmp(sbuild_id, real_sbuild_id) == 0);
253 static const char *build_id_cache__basename(bool is_kallsyms, bool is_vdso,
256 return is_kallsyms ? "kallsyms" : (is_vdso ? "vdso" : (is_debug ?
260 char *dso__build_id_filename(const struct dso *dso, char *bf, size_t size,
263 bool is_kallsyms = dso__is_kallsyms((struct dso *)dso);
264 bool is_vdso = dso__is_vdso((struct dso *)dso);
265 char sbuild_id[SBUILD_ID_SIZE];
267 bool alloc = (bf == NULL);
270 if (!dso->has_build_id)
273 build_id__sprintf(dso->bid.data, sizeof(dso->bid.data), sbuild_id);
274 linkname = build_id_cache__linkname(sbuild_id, NULL, 0);
278 /* Check if old style build_id cache */
279 if (is_regular_file(linkname))
280 ret = asnprintf(&bf, size, "%s", linkname);
282 ret = asnprintf(&bf, size, "%s/%s", linkname,
283 build_id_cache__basename(is_kallsyms, is_vdso,
285 if (ret < 0 || (!alloc && size < (unsigned int)ret))
292 #define dsos__for_each_with_build_id(pos, head) \
293 list_for_each_entry(pos, head, node) \
294 if (!pos->has_build_id) \
298 static int write_buildid(const char *name, size_t name_len, u8 *build_id,
299 pid_t pid, u16 misc, struct feat_fd *fd)
302 struct perf_record_header_build_id b;
306 len = PERF_ALIGN(len, NAME_ALIGN);
308 memset(&b, 0, sizeof(b));
309 memcpy(&b.build_id, build_id, BUILD_ID_SIZE);
311 b.header.misc = misc;
312 b.header.size = sizeof(b) + len;
314 err = do_write(fd, &b, sizeof(b));
318 return write_padded(fd, name, name_len + 1, len);
321 static int machine__write_buildid_table(struct machine *machine,
326 u16 kmisc = PERF_RECORD_MISC_KERNEL,
327 umisc = PERF_RECORD_MISC_USER;
329 if (!machine__is_host(machine)) {
330 kmisc = PERF_RECORD_MISC_GUEST_KERNEL;
331 umisc = PERF_RECORD_MISC_GUEST_USER;
334 dsos__for_each_with_build_id(pos, &machine->dsos.head) {
337 bool in_kernel = false;
339 if (!pos->hit && !dso__is_vdso(pos))
342 if (dso__is_vdso(pos)) {
343 name = pos->short_name;
344 name_len = pos->short_name_len;
345 } else if (dso__is_kcore(pos)) {
346 name = machine->mmap_name;
347 name_len = strlen(name);
349 name = pos->long_name;
350 name_len = pos->long_name_len;
353 in_kernel = pos->kernel ||
354 is_kernel_module(name,
355 PERF_RECORD_MISC_CPUMODE_UNKNOWN);
356 err = write_buildid(name, name_len, pos->bid.data, machine->pid,
357 in_kernel ? kmisc : umisc, fd);
365 int perf_session__write_buildid_table(struct perf_session *session,
369 int err = machine__write_buildid_table(&session->machines.host, fd);
374 for (nd = rb_first_cached(&session->machines.guests); nd;
376 struct machine *pos = rb_entry(nd, struct machine, rb_node);
377 err = machine__write_buildid_table(pos, fd);
384 static int __dsos__hit_all(struct list_head *head)
388 list_for_each_entry(pos, head, node)
394 static int machine__hit_all_dsos(struct machine *machine)
396 return __dsos__hit_all(&machine->dsos.head);
399 int dsos__hit_all(struct perf_session *session)
404 err = machine__hit_all_dsos(&session->machines.host);
408 for (nd = rb_first_cached(&session->machines.guests); nd;
410 struct machine *pos = rb_entry(nd, struct machine, rb_node);
412 err = machine__hit_all_dsos(pos);
420 void disable_buildid_cache(void)
422 no_buildid_cache = true;
425 static bool lsdir_bid_head_filter(const char *name __maybe_unused,
428 return (strlen(d->d_name) == 2) &&
429 isxdigit(d->d_name[0]) && isxdigit(d->d_name[1]);
432 static bool lsdir_bid_tail_filter(const char *name __maybe_unused,
436 while (isxdigit(d->d_name[i]) && i < SBUILD_ID_SIZE - 3)
438 return (i == SBUILD_ID_SIZE - 3) && (d->d_name[i] == '\0');
441 struct strlist *build_id_cache__list_all(bool validonly)
443 struct strlist *toplist, *linklist = NULL, *bidlist;
444 struct str_node *nd, *nd2;
445 char *topdir, *linkdir = NULL;
446 char sbuild_id[SBUILD_ID_SIZE];
448 /* for filename__ functions */
452 /* Open the top-level directory */
453 if (asprintf(&topdir, "%s/.build-id/", buildid_dir) < 0)
456 bidlist = strlist__new(NULL, NULL);
460 toplist = lsdir(topdir, lsdir_bid_head_filter);
462 pr_debug("Error in lsdir(%s): %d\n", topdir, errno);
463 /* If there is no buildid cache, return an empty list */
469 strlist__for_each_entry(nd, toplist) {
470 if (asprintf(&linkdir, "%s/%s", topdir, nd->s) < 0)
472 /* Open the lower-level directory */
473 linklist = lsdir(linkdir, lsdir_bid_tail_filter);
475 pr_debug("Error in lsdir(%s): %d\n", linkdir, errno);
478 strlist__for_each_entry(nd2, linklist) {
479 if (snprintf(sbuild_id, SBUILD_ID_SIZE, "%s%s",
480 nd->s, nd2->s) != SBUILD_ID_SIZE - 1)
482 if (validonly && !build_id_cache__valid_id(sbuild_id))
484 if (strlist__add(bidlist, sbuild_id) < 0)
487 strlist__delete(linklist);
492 strlist__delete(toplist);
499 strlist__delete(linklist);
501 strlist__delete(bidlist);
506 static bool str_is_build_id(const char *maybe_sbuild_id, size_t len)
510 for (i = 0; i < len; i++) {
511 if (!isxdigit(maybe_sbuild_id[i]))
517 /* Return the valid complete build-id */
518 char *build_id_cache__complement(const char *incomplete_sbuild_id)
520 struct strlist *bidlist;
521 struct str_node *nd, *cand = NULL;
522 char *sbuild_id = NULL;
523 size_t len = strlen(incomplete_sbuild_id);
525 if (len >= SBUILD_ID_SIZE ||
526 !str_is_build_id(incomplete_sbuild_id, len))
529 bidlist = build_id_cache__list_all(true);
533 strlist__for_each_entry(nd, bidlist) {
534 if (strncmp(nd->s, incomplete_sbuild_id, len) != 0)
536 if (cand) { /* Error: There are more than 2 candidates. */
543 sbuild_id = strdup(cand->s);
544 strlist__delete(bidlist);
549 char *build_id_cache__cachedir(const char *sbuild_id, const char *name,
550 struct nsinfo *nsi, bool is_kallsyms,
553 char *realname = (char *)name, *filename;
554 bool slash = is_kallsyms || is_vdso;
557 realname = nsinfo__realpath(name, nsi);
562 if (asprintf(&filename, "%s%s%s%s%s", buildid_dir, slash ? "/" : "",
563 is_vdso ? DSO__NAME_VDSO : realname,
564 sbuild_id ? "/" : "", sbuild_id ?: "") < 0)
573 int build_id_cache__list_build_ids(const char *pathname, struct nsinfo *nsi,
574 struct strlist **result)
579 dir_name = build_id_cache__cachedir(NULL, pathname, nsi, false, false);
583 *result = lsdir(dir_name, lsdir_no_dot_filter);
591 #if defined(HAVE_LIBELF_SUPPORT) && defined(HAVE_GELF_GETNOTE_SUPPORT)
592 static int build_id_cache__add_sdt_cache(const char *sbuild_id,
593 const char *realname,
596 struct probe_cache *cache;
600 cache = probe_cache__new(sbuild_id, nsi);
604 nsinfo__mountns_enter(nsi, &nsc);
605 ret = probe_cache__scan_sdt(cache, realname);
606 nsinfo__mountns_exit(&nsc);
608 pr_debug4("Found %d SDTs in %s\n", ret, realname);
609 if (probe_cache__commit(cache) < 0)
612 probe_cache__delete(cache);
616 #define build_id_cache__add_sdt_cache(sbuild_id, realname, nsi) (0)
619 static char *build_id_cache__find_debug(const char *sbuild_id,
622 char *realname = NULL;
627 debugfile = calloc(1, PATH_MAX);
631 len = __symbol__join_symfs(debugfile, PATH_MAX,
632 "/usr/lib/debug/.build-id/");
633 snprintf(debugfile + len, PATH_MAX - len, "%.2s/%s.debug", sbuild_id,
636 nsinfo__mountns_enter(nsi, &nsc);
637 realname = realpath(debugfile, NULL);
638 if (realname && access(realname, R_OK))
640 nsinfo__mountns_exit(&nsc);
642 #ifdef HAVE_DEBUGINFOD_SUPPORT
643 if (realname == NULL) {
644 debuginfod_client* c = debuginfod_begin();
646 int fd = debuginfod_find_debuginfo(c,
647 (const unsigned char*)sbuild_id, 0,
650 close(fd); /* retaining reference by realname */
661 int build_id_cache__add_s(const char *sbuild_id, const char *name,
662 struct nsinfo *nsi, bool is_kallsyms, bool is_vdso)
664 const size_t size = PATH_MAX;
665 char *realname = NULL, *filename = NULL, *dir_name = NULL,
666 *linkname = zalloc(size), *tmp;
667 char *debugfile = NULL;
672 realname = nsinfo__realpath(name, nsi);
674 realname = realpath(name, NULL);
679 dir_name = build_id_cache__cachedir(sbuild_id, name, nsi, is_kallsyms,
684 /* Remove old style build-id cache */
685 if (is_regular_file(dir_name))
686 if (unlink(dir_name))
689 if (mkdir_p(dir_name, 0755))
692 /* Save the allocated buildid dirname */
693 if (asprintf(&filename, "%s/%s", dir_name,
694 build_id_cache__basename(is_kallsyms, is_vdso,
700 if (access(filename, F_OK)) {
702 if (copyfile("/proc/kallsyms", filename))
704 } else if (nsi && nsi->need_setns) {
705 if (copyfile_ns(name, filename, nsi))
707 } else if (link(realname, filename) && errno != EEXIST &&
708 copyfile(name, filename))
712 /* Some binaries are stripped, but have .debug files with their symbol
713 * table. Check to see if we can locate one of those, since the elf
714 * file itself may not be very useful to users of our tools without a
717 if (!is_kallsyms && !is_vdso &&
718 strncmp(".ko", name + strlen(name) - 3, 3)) {
719 debugfile = build_id_cache__find_debug(sbuild_id, nsi);
722 if (asprintf(&filename, "%s/%s", dir_name,
723 build_id_cache__basename(false, false, true)) < 0) {
727 if (access(filename, F_OK)) {
728 if (nsi && nsi->need_setns) {
729 if (copyfile_ns(debugfile, filename,
732 } else if (link(debugfile, filename) &&
734 copyfile(debugfile, filename))
740 if (!build_id_cache__linkname(sbuild_id, linkname, size))
742 tmp = strrchr(linkname, '/');
745 if (access(linkname, X_OK) && mkdir_p(linkname, 0755))
749 tmp = dir_name + strlen(buildid_dir) - 5;
750 memcpy(tmp, "../..", 5);
752 if (symlink(tmp, linkname) == 0)
755 /* Update SDT cache : error is just warned */
757 build_id_cache__add_sdt_cache(sbuild_id, realname, nsi) < 0)
758 pr_debug4("Failed to update/scan SDT cache for %s\n", realname);
770 static int build_id_cache__add_b(const u8 *build_id, size_t build_id_size,
771 const char *name, struct nsinfo *nsi,
772 bool is_kallsyms, bool is_vdso)
774 char sbuild_id[SBUILD_ID_SIZE];
776 build_id__sprintf(build_id, build_id_size, sbuild_id);
778 return build_id_cache__add_s(sbuild_id, name, nsi, is_kallsyms,
782 bool build_id_cache__cached(const char *sbuild_id)
785 char *filename = build_id_cache__linkname(sbuild_id, NULL, 0);
787 if (filename && !access(filename, F_OK))
794 int build_id_cache__remove_s(const char *sbuild_id)
796 const size_t size = PATH_MAX;
797 char *filename = zalloc(size),
798 *linkname = zalloc(size), *tmp;
801 if (filename == NULL || linkname == NULL)
804 if (!build_id_cache__linkname(sbuild_id, linkname, size))
807 if (access(linkname, F_OK))
810 if (readlink(linkname, filename, size - 1) < 0)
813 if (unlink(linkname))
817 * Since the link is relative, we must make it absolute:
819 tmp = strrchr(linkname, '/') + 1;
820 snprintf(tmp, size - (tmp - linkname), "%s", filename);
832 static int dso__cache_build_id(struct dso *dso, struct machine *machine)
834 bool is_kallsyms = dso__is_kallsyms(dso);
835 bool is_vdso = dso__is_vdso(dso);
836 const char *name = dso->long_name;
838 if (dso__is_kcore(dso)) {
840 name = machine->mmap_name;
842 return build_id_cache__add_b(dso->bid.data, sizeof(dso->bid.data), name,
843 dso->nsinfo, is_kallsyms, is_vdso);
846 static int __dsos__cache_build_ids(struct list_head *head,
847 struct machine *machine)
852 dsos__for_each_with_build_id(pos, head)
853 if (dso__cache_build_id(pos, machine))
859 static int machine__cache_build_ids(struct machine *machine)
861 return __dsos__cache_build_ids(&machine->dsos.head, machine);
864 int perf_session__cache_build_ids(struct perf_session *session)
869 if (no_buildid_cache)
872 if (mkdir(buildid_dir, 0755) != 0 && errno != EEXIST)
875 ret = machine__cache_build_ids(&session->machines.host);
877 for (nd = rb_first_cached(&session->machines.guests); nd;
879 struct machine *pos = rb_entry(nd, struct machine, rb_node);
880 ret |= machine__cache_build_ids(pos);
885 static bool machine__read_build_ids(struct machine *machine, bool with_hits)
887 return __dsos__read_build_ids(&machine->dsos.head, with_hits);
890 bool perf_session__read_build_ids(struct perf_session *session, bool with_hits)
893 bool ret = machine__read_build_ids(&session->machines.host, with_hits);
895 for (nd = rb_first_cached(&session->machines.guests); nd;
897 struct machine *pos = rb_entry(nd, struct machine, rb_node);
898 ret |= machine__read_build_ids(pos, with_hits);