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>
15 #include <sys/types.h>
18 #include "namespaces.h"
22 #include <linux/kernel.h>
29 #include "probe-file.h"
32 #include <linux/ctype.h>
33 #include <linux/zalloc.h>
35 static bool no_buildid_cache;
37 int build_id__mark_dso_hit(struct perf_tool *tool __maybe_unused,
38 union perf_event *event,
39 struct perf_sample *sample,
40 struct perf_evsel *evsel __maybe_unused,
41 struct machine *machine)
43 struct addr_location al;
44 struct thread *thread = machine__findnew_thread(machine, sample->pid,
48 pr_err("problem processing %d event, skipping it.\n",
53 if (thread__find_map(thread, sample->cpumode, sample->ip, &al))
60 static int perf_event__exit_del_thread(struct perf_tool *tool __maybe_unused,
61 union perf_event *event,
62 struct perf_sample *sample
64 struct machine *machine)
66 struct thread *thread = machine__findnew_thread(machine,
70 dump_printf("(%d:%d):(%d:%d)\n", event->fork.pid, event->fork.tid,
71 event->fork.ppid, event->fork.ptid);
74 machine__remove_thread(machine, thread);
81 struct perf_tool build_id__mark_dso_hit_ops = {
82 .sample = build_id__mark_dso_hit,
83 .mmap = perf_event__process_mmap,
84 .mmap2 = perf_event__process_mmap2,
85 .fork = perf_event__process_fork,
86 .exit = perf_event__exit_del_thread,
87 .attr = perf_event__process_attr,
88 .build_id = perf_event__process_build_id,
89 .ordered_events = true,
92 int build_id__sprintf(const u8 *build_id, int len, char *bf)
95 const u8 *raw = build_id;
98 for (i = 0; i < len; ++i) {
99 sprintf(bid, "%02x", *raw);
104 return (bid - bf) + 1;
107 int sysfs__sprintf_build_id(const char *root_dir, char *sbuild_id)
109 char notes[PATH_MAX];
110 u8 build_id[BUILD_ID_SIZE];
116 scnprintf(notes, sizeof(notes), "%s/sys/kernel/notes", root_dir);
118 ret = sysfs__read_build_id(notes, build_id, sizeof(build_id));
122 return build_id__sprintf(build_id, sizeof(build_id), sbuild_id);
125 int filename__sprintf_build_id(const char *pathname, char *sbuild_id)
127 u8 build_id[BUILD_ID_SIZE];
130 ret = filename__read_build_id(pathname, build_id, sizeof(build_id));
133 else if (ret != sizeof(build_id))
136 return build_id__sprintf(build_id, sizeof(build_id), sbuild_id);
139 /* asnprintf consolidates asprintf and snprintf */
140 static int asnprintf(char **strp, size_t size, const char *fmt, ...)
150 ret = vsnprintf(*strp, size, fmt, ap);
152 ret = vasprintf(strp, fmt, ap);
158 char *build_id_cache__kallsyms_path(const char *sbuild_id, char *bf,
161 bool retry_old = true;
163 snprintf(bf, size, "%s/%s/%s/kallsyms",
164 buildid_dir, DSO__NAME_KALLSYMS, sbuild_id);
166 if (!access(bf, F_OK))
169 /* Try old style kallsyms cache */
170 snprintf(bf, size, "%s/%s/%s",
171 buildid_dir, DSO__NAME_KALLSYMS, sbuild_id);
179 char *build_id_cache__linkname(const char *sbuild_id, char *bf, size_t size)
182 int ret = asnprintf(&bf, size, "%s/.build-id/%.2s/%s", buildid_dir,
183 sbuild_id, sbuild_id + 2);
184 if (ret < 0 || (tmp && size < (unsigned int)ret))
189 /* The caller is responsible to free the returned buffer. */
190 char *build_id_cache__origname(const char *sbuild_id)
194 char *ret = NULL, *p;
195 size_t offs = 5; /* == strlen("../..") */
198 linkname = build_id_cache__linkname(sbuild_id, NULL, 0);
202 len = readlink(linkname, buf, sizeof(buf) - 1);
207 /* The link should be "../..<origpath>/<sbuild_id>" */
208 p = strrchr(buf, '/'); /* Cut off the "/<sbuild_id>" */
209 if (p && (p > buf + offs)) {
211 if (buf[offs + 1] == '[')
213 * This is a DSO name, like [kernel.kallsyms].
214 * Skip the first '/', since this is not the
215 * cache of a regular file.
217 ret = strdup(buf + offs); /* Skip "../..[/]" */
224 /* Check if the given build_id cache is valid on current running system */
225 static bool build_id_cache__valid_id(char *sbuild_id)
227 char real_sbuild_id[SBUILD_ID_SIZE] = "";
232 pathname = build_id_cache__origname(sbuild_id);
236 if (!strcmp(pathname, DSO__NAME_KALLSYMS))
237 ret = sysfs__sprintf_build_id("/", real_sbuild_id);
238 else if (pathname[0] == '/')
239 ret = filename__sprintf_build_id(pathname, real_sbuild_id);
241 ret = -EINVAL; /* Should we support other special DSO cache? */
243 result = (strcmp(sbuild_id, real_sbuild_id) == 0);
249 static const char *build_id_cache__basename(bool is_kallsyms, bool is_vdso,
252 return is_kallsyms ? "kallsyms" : (is_vdso ? "vdso" : (is_debug ?
256 char *dso__build_id_filename(const struct dso *dso, char *bf, size_t size,
259 bool is_kallsyms = dso__is_kallsyms((struct dso *)dso);
260 bool is_vdso = dso__is_vdso((struct dso *)dso);
261 char sbuild_id[SBUILD_ID_SIZE];
263 bool alloc = (bf == NULL);
266 if (!dso->has_build_id)
269 build_id__sprintf(dso->build_id, sizeof(dso->build_id), sbuild_id);
270 linkname = build_id_cache__linkname(sbuild_id, NULL, 0);
274 /* Check if old style build_id cache */
275 if (is_regular_file(linkname))
276 ret = asnprintf(&bf, size, "%s", linkname);
278 ret = asnprintf(&bf, size, "%s/%s", linkname,
279 build_id_cache__basename(is_kallsyms, is_vdso,
281 if (ret < 0 || (!alloc && size < (unsigned int)ret))
288 #define dsos__for_each_with_build_id(pos, head) \
289 list_for_each_entry(pos, head, node) \
290 if (!pos->has_build_id) \
294 static int write_buildid(const char *name, size_t name_len, u8 *build_id,
295 pid_t pid, u16 misc, struct feat_fd *fd)
298 struct build_id_event b;
302 len = PERF_ALIGN(len, NAME_ALIGN);
304 memset(&b, 0, sizeof(b));
305 memcpy(&b.build_id, build_id, BUILD_ID_SIZE);
307 b.header.misc = misc;
308 b.header.size = sizeof(b) + len;
310 err = do_write(fd, &b, sizeof(b));
314 return write_padded(fd, name, name_len + 1, len);
317 static int machine__write_buildid_table(struct machine *machine,
322 u16 kmisc = PERF_RECORD_MISC_KERNEL,
323 umisc = PERF_RECORD_MISC_USER;
325 if (!machine__is_host(machine)) {
326 kmisc = PERF_RECORD_MISC_GUEST_KERNEL;
327 umisc = PERF_RECORD_MISC_GUEST_USER;
330 dsos__for_each_with_build_id(pos, &machine->dsos.head) {
333 bool in_kernel = false;
335 if (!pos->hit && !dso__is_vdso(pos))
338 if (dso__is_vdso(pos)) {
339 name = pos->short_name;
340 name_len = pos->short_name_len;
341 } else if (dso__is_kcore(pos)) {
342 name = machine->mmap_name;
343 name_len = strlen(name);
345 name = pos->long_name;
346 name_len = pos->long_name_len;
349 in_kernel = pos->kernel ||
350 is_kernel_module(name,
351 PERF_RECORD_MISC_CPUMODE_UNKNOWN);
352 err = write_buildid(name, name_len, pos->build_id, machine->pid,
353 in_kernel ? kmisc : umisc, fd);
361 int perf_session__write_buildid_table(struct perf_session *session,
365 int err = machine__write_buildid_table(&session->machines.host, fd);
370 for (nd = rb_first_cached(&session->machines.guests); nd;
372 struct machine *pos = rb_entry(nd, struct machine, rb_node);
373 err = machine__write_buildid_table(pos, fd);
380 static int __dsos__hit_all(struct list_head *head)
384 list_for_each_entry(pos, head, node)
390 static int machine__hit_all_dsos(struct machine *machine)
392 return __dsos__hit_all(&machine->dsos.head);
395 int dsos__hit_all(struct perf_session *session)
400 err = machine__hit_all_dsos(&session->machines.host);
404 for (nd = rb_first_cached(&session->machines.guests); nd;
406 struct machine *pos = rb_entry(nd, struct machine, rb_node);
408 err = machine__hit_all_dsos(pos);
416 void disable_buildid_cache(void)
418 no_buildid_cache = true;
421 static bool lsdir_bid_head_filter(const char *name __maybe_unused,
424 return (strlen(d->d_name) == 2) &&
425 isxdigit(d->d_name[0]) && isxdigit(d->d_name[1]);
428 static bool lsdir_bid_tail_filter(const char *name __maybe_unused,
432 while (isxdigit(d->d_name[i]) && i < SBUILD_ID_SIZE - 3)
434 return (i == SBUILD_ID_SIZE - 3) && (d->d_name[i] == '\0');
437 struct strlist *build_id_cache__list_all(bool validonly)
439 struct strlist *toplist, *linklist = NULL, *bidlist;
440 struct str_node *nd, *nd2;
441 char *topdir, *linkdir = NULL;
442 char sbuild_id[SBUILD_ID_SIZE];
444 /* for filename__ functions */
448 /* Open the top-level directory */
449 if (asprintf(&topdir, "%s/.build-id/", buildid_dir) < 0)
452 bidlist = strlist__new(NULL, NULL);
456 toplist = lsdir(topdir, lsdir_bid_head_filter);
458 pr_debug("Error in lsdir(%s): %d\n", topdir, errno);
459 /* If there is no buildid cache, return an empty list */
465 strlist__for_each_entry(nd, toplist) {
466 if (asprintf(&linkdir, "%s/%s", topdir, nd->s) < 0)
468 /* Open the lower-level directory */
469 linklist = lsdir(linkdir, lsdir_bid_tail_filter);
471 pr_debug("Error in lsdir(%s): %d\n", linkdir, errno);
474 strlist__for_each_entry(nd2, linklist) {
475 if (snprintf(sbuild_id, SBUILD_ID_SIZE, "%s%s",
476 nd->s, nd2->s) != SBUILD_ID_SIZE - 1)
478 if (validonly && !build_id_cache__valid_id(sbuild_id))
480 if (strlist__add(bidlist, sbuild_id) < 0)
483 strlist__delete(linklist);
488 strlist__delete(toplist);
495 strlist__delete(linklist);
497 strlist__delete(bidlist);
502 static bool str_is_build_id(const char *maybe_sbuild_id, size_t len)
506 for (i = 0; i < len; i++) {
507 if (!isxdigit(maybe_sbuild_id[i]))
513 /* Return the valid complete build-id */
514 char *build_id_cache__complement(const char *incomplete_sbuild_id)
516 struct strlist *bidlist;
517 struct str_node *nd, *cand = NULL;
518 char *sbuild_id = NULL;
519 size_t len = strlen(incomplete_sbuild_id);
521 if (len >= SBUILD_ID_SIZE ||
522 !str_is_build_id(incomplete_sbuild_id, len))
525 bidlist = build_id_cache__list_all(true);
529 strlist__for_each_entry(nd, bidlist) {
530 if (strncmp(nd->s, incomplete_sbuild_id, len) != 0)
532 if (cand) { /* Error: There are more than 2 candidates. */
539 sbuild_id = strdup(cand->s);
540 strlist__delete(bidlist);
545 char *build_id_cache__cachedir(const char *sbuild_id, const char *name,
546 struct nsinfo *nsi, bool is_kallsyms,
549 char *realname = (char *)name, *filename;
550 bool slash = is_kallsyms || is_vdso;
553 realname = nsinfo__realpath(name, nsi);
558 if (asprintf(&filename, "%s%s%s%s%s", buildid_dir, slash ? "/" : "",
559 is_vdso ? DSO__NAME_VDSO : realname,
560 sbuild_id ? "/" : "", sbuild_id ?: "") < 0)
569 int build_id_cache__list_build_ids(const char *pathname, struct nsinfo *nsi,
570 struct strlist **result)
575 dir_name = build_id_cache__cachedir(NULL, pathname, nsi, false, false);
579 *result = lsdir(dir_name, lsdir_no_dot_filter);
587 #if defined(HAVE_LIBELF_SUPPORT) && defined(HAVE_GELF_GETNOTE_SUPPORT)
588 static int build_id_cache__add_sdt_cache(const char *sbuild_id,
589 const char *realname,
592 struct probe_cache *cache;
596 cache = probe_cache__new(sbuild_id, nsi);
600 nsinfo__mountns_enter(nsi, &nsc);
601 ret = probe_cache__scan_sdt(cache, realname);
602 nsinfo__mountns_exit(&nsc);
604 pr_debug4("Found %d SDTs in %s\n", ret, realname);
605 if (probe_cache__commit(cache) < 0)
608 probe_cache__delete(cache);
612 #define build_id_cache__add_sdt_cache(sbuild_id, realname, nsi) (0)
615 static char *build_id_cache__find_debug(const char *sbuild_id,
618 char *realname = NULL;
623 debugfile = calloc(1, PATH_MAX);
627 len = __symbol__join_symfs(debugfile, PATH_MAX,
628 "/usr/lib/debug/.build-id/");
629 snprintf(debugfile + len, PATH_MAX - len, "%.2s/%s.debug", sbuild_id,
632 nsinfo__mountns_enter(nsi, &nsc);
633 realname = realpath(debugfile, NULL);
634 if (realname && access(realname, R_OK))
636 nsinfo__mountns_exit(&nsc);
642 int build_id_cache__add_s(const char *sbuild_id, const char *name,
643 struct nsinfo *nsi, bool is_kallsyms, bool is_vdso)
645 const size_t size = PATH_MAX;
646 char *realname = NULL, *filename = NULL, *dir_name = NULL,
647 *linkname = zalloc(size), *tmp;
648 char *debugfile = NULL;
653 realname = nsinfo__realpath(name, nsi);
655 realname = realpath(name, NULL);
660 dir_name = build_id_cache__cachedir(sbuild_id, name, nsi, is_kallsyms,
665 /* Remove old style build-id cache */
666 if (is_regular_file(dir_name))
667 if (unlink(dir_name))
670 if (mkdir_p(dir_name, 0755))
673 /* Save the allocated buildid dirname */
674 if (asprintf(&filename, "%s/%s", dir_name,
675 build_id_cache__basename(is_kallsyms, is_vdso,
681 if (access(filename, F_OK)) {
683 if (copyfile("/proc/kallsyms", filename))
685 } else if (nsi && nsi->need_setns) {
686 if (copyfile_ns(name, filename, nsi))
688 } else if (link(realname, filename) && errno != EEXIST &&
689 copyfile(name, filename))
693 /* Some binaries are stripped, but have .debug files with their symbol
694 * table. Check to see if we can locate one of those, since the elf
695 * file itself may not be very useful to users of our tools without a
698 if (!is_kallsyms && !is_vdso &&
699 strncmp(".ko", name + strlen(name) - 3, 3)) {
700 debugfile = build_id_cache__find_debug(sbuild_id, nsi);
703 if (asprintf(&filename, "%s/%s", dir_name,
704 build_id_cache__basename(false, false, true)) < 0) {
708 if (access(filename, F_OK)) {
709 if (nsi && nsi->need_setns) {
710 if (copyfile_ns(debugfile, filename,
713 } else if (link(debugfile, filename) &&
715 copyfile(debugfile, filename))
721 if (!build_id_cache__linkname(sbuild_id, linkname, size))
723 tmp = strrchr(linkname, '/');
726 if (access(linkname, X_OK) && mkdir_p(linkname, 0755))
730 tmp = dir_name + strlen(buildid_dir) - 5;
731 memcpy(tmp, "../..", 5);
733 if (symlink(tmp, linkname) == 0)
736 /* Update SDT cache : error is just warned */
738 build_id_cache__add_sdt_cache(sbuild_id, realname, nsi) < 0)
739 pr_debug4("Failed to update/scan SDT cache for %s\n", realname);
751 static int build_id_cache__add_b(const u8 *build_id, size_t build_id_size,
752 const char *name, struct nsinfo *nsi,
753 bool is_kallsyms, bool is_vdso)
755 char sbuild_id[SBUILD_ID_SIZE];
757 build_id__sprintf(build_id, build_id_size, sbuild_id);
759 return build_id_cache__add_s(sbuild_id, name, nsi, is_kallsyms,
763 bool build_id_cache__cached(const char *sbuild_id)
766 char *filename = build_id_cache__linkname(sbuild_id, NULL, 0);
768 if (filename && !access(filename, F_OK))
775 int build_id_cache__remove_s(const char *sbuild_id)
777 const size_t size = PATH_MAX;
778 char *filename = zalloc(size),
779 *linkname = zalloc(size), *tmp;
782 if (filename == NULL || linkname == NULL)
785 if (!build_id_cache__linkname(sbuild_id, linkname, size))
788 if (access(linkname, F_OK))
791 if (readlink(linkname, filename, size - 1) < 0)
794 if (unlink(linkname))
798 * Since the link is relative, we must make it absolute:
800 tmp = strrchr(linkname, '/') + 1;
801 snprintf(tmp, size - (tmp - linkname), "%s", filename);
813 static int dso__cache_build_id(struct dso *dso, struct machine *machine)
815 bool is_kallsyms = dso__is_kallsyms(dso);
816 bool is_vdso = dso__is_vdso(dso);
817 const char *name = dso->long_name;
819 if (dso__is_kcore(dso)) {
821 name = machine->mmap_name;
823 return build_id_cache__add_b(dso->build_id, sizeof(dso->build_id), name,
824 dso->nsinfo, is_kallsyms, is_vdso);
827 static int __dsos__cache_build_ids(struct list_head *head,
828 struct machine *machine)
833 dsos__for_each_with_build_id(pos, head)
834 if (dso__cache_build_id(pos, machine))
840 static int machine__cache_build_ids(struct machine *machine)
842 return __dsos__cache_build_ids(&machine->dsos.head, machine);
845 int perf_session__cache_build_ids(struct perf_session *session)
850 if (no_buildid_cache)
853 if (mkdir(buildid_dir, 0755) != 0 && errno != EEXIST)
856 ret = machine__cache_build_ids(&session->machines.host);
858 for (nd = rb_first_cached(&session->machines.guests); nd;
860 struct machine *pos = rb_entry(nd, struct machine, rb_node);
861 ret |= machine__cache_build_ids(pos);
866 static bool machine__read_build_ids(struct machine *machine, bool with_hits)
868 return __dsos__read_build_ids(&machine->dsos.head, with_hits);
871 bool perf_session__read_build_ids(struct perf_session *session, bool with_hits)
874 bool ret = machine__read_build_ids(&session->machines.host, with_hits);
876 for (nd = rb_first_cached(&session->machines.guests); nd;
878 struct machine *pos = rb_entry(nd, struct machine, rb_node);
879 ret |= machine__read_build_ids(pos, with_hits);