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>
20 #include <linux/kernel.h>
27 #include "probe-file.h"
30 #include "sane_ctype.h"
32 static bool no_buildid_cache;
34 int build_id__mark_dso_hit(struct perf_tool *tool __maybe_unused,
35 union perf_event *event,
36 struct perf_sample *sample,
37 struct perf_evsel *evsel __maybe_unused,
38 struct machine *machine)
40 struct addr_location al;
41 struct thread *thread = machine__findnew_thread(machine, sample->pid,
45 pr_err("problem processing %d event, skipping it.\n",
50 if (thread__find_map(thread, sample->cpumode, sample->ip, &al))
57 static int perf_event__exit_del_thread(struct perf_tool *tool __maybe_unused,
58 union perf_event *event,
59 struct perf_sample *sample
61 struct machine *machine)
63 struct thread *thread = machine__findnew_thread(machine,
67 dump_printf("(%d:%d):(%d:%d)\n", event->fork.pid, event->fork.tid,
68 event->fork.ppid, event->fork.ptid);
71 machine__remove_thread(machine, thread);
78 struct perf_tool build_id__mark_dso_hit_ops = {
79 .sample = build_id__mark_dso_hit,
80 .mmap = perf_event__process_mmap,
81 .mmap2 = perf_event__process_mmap2,
82 .fork = perf_event__process_fork,
83 .exit = perf_event__exit_del_thread,
84 .attr = perf_event__process_attr,
85 .build_id = perf_event__process_build_id,
86 .ordered_events = true,
89 int build_id__sprintf(const u8 *build_id, int len, char *bf)
92 const u8 *raw = build_id;
95 for (i = 0; i < len; ++i) {
96 sprintf(bid, "%02x", *raw);
101 return (bid - bf) + 1;
104 int sysfs__sprintf_build_id(const char *root_dir, char *sbuild_id)
106 char notes[PATH_MAX];
107 u8 build_id[BUILD_ID_SIZE];
113 scnprintf(notes, sizeof(notes), "%s/sys/kernel/notes", root_dir);
115 ret = sysfs__read_build_id(notes, build_id, sizeof(build_id));
119 return build_id__sprintf(build_id, sizeof(build_id), sbuild_id);
122 int filename__sprintf_build_id(const char *pathname, char *sbuild_id)
124 u8 build_id[BUILD_ID_SIZE];
127 ret = filename__read_build_id(pathname, build_id, sizeof(build_id));
130 else if (ret != sizeof(build_id))
133 return build_id__sprintf(build_id, sizeof(build_id), sbuild_id);
136 /* asnprintf consolidates asprintf and snprintf */
137 static int asnprintf(char **strp, size_t size, const char *fmt, ...)
147 ret = vsnprintf(*strp, size, fmt, ap);
149 ret = vasprintf(strp, fmt, ap);
155 char *build_id_cache__kallsyms_path(const char *sbuild_id, char *bf,
158 bool retry_old = true;
160 snprintf(bf, size, "%s/%s/%s/kallsyms",
161 buildid_dir, DSO__NAME_KALLSYMS, sbuild_id);
163 if (!access(bf, F_OK))
166 /* Try old style kallsyms cache */
167 snprintf(bf, size, "%s/%s/%s",
168 buildid_dir, DSO__NAME_KALLSYMS, sbuild_id);
176 char *build_id_cache__linkname(const char *sbuild_id, char *bf, size_t size)
179 int ret = asnprintf(&bf, size, "%s/.build-id/%.2s/%s", buildid_dir,
180 sbuild_id, sbuild_id + 2);
181 if (ret < 0 || (tmp && size < (unsigned int)ret))
186 char *build_id_cache__origname(const char *sbuild_id)
190 char *ret = NULL, *p;
191 size_t offs = 5; /* == strlen("../..") */
194 linkname = build_id_cache__linkname(sbuild_id, NULL, 0);
198 len = readlink(linkname, buf, sizeof(buf) - 1);
203 /* The link should be "../..<origpath>/<sbuild_id>" */
204 p = strrchr(buf, '/'); /* Cut off the "/<sbuild_id>" */
205 if (p && (p > buf + offs)) {
207 if (buf[offs + 1] == '[')
209 * This is a DSO name, like [kernel.kallsyms].
210 * Skip the first '/', since this is not the
211 * cache of a regular file.
213 ret = strdup(buf + offs); /* Skip "../..[/]" */
220 /* Check if the given build_id cache is valid on current running system */
221 static bool build_id_cache__valid_id(char *sbuild_id)
223 char real_sbuild_id[SBUILD_ID_SIZE] = "";
228 pathname = build_id_cache__origname(sbuild_id);
232 if (!strcmp(pathname, DSO__NAME_KALLSYMS))
233 ret = sysfs__sprintf_build_id("/", real_sbuild_id);
234 else if (pathname[0] == '/')
235 ret = filename__sprintf_build_id(pathname, real_sbuild_id);
237 ret = -EINVAL; /* Should we support other special DSO cache? */
239 result = (strcmp(sbuild_id, real_sbuild_id) == 0);
245 static const char *build_id_cache__basename(bool is_kallsyms, bool is_vdso,
248 return is_kallsyms ? "kallsyms" : (is_vdso ? "vdso" : (is_debug ?
252 char *dso__build_id_filename(const struct dso *dso, char *bf, size_t size,
255 bool is_kallsyms = dso__is_kallsyms((struct dso *)dso);
256 bool is_vdso = dso__is_vdso((struct dso *)dso);
257 char sbuild_id[SBUILD_ID_SIZE];
259 bool alloc = (bf == NULL);
262 if (!dso->has_build_id)
265 build_id__sprintf(dso->build_id, sizeof(dso->build_id), sbuild_id);
266 linkname = build_id_cache__linkname(sbuild_id, NULL, 0);
270 /* Check if old style build_id cache */
271 if (is_regular_file(linkname))
272 ret = asnprintf(&bf, size, "%s", linkname);
274 ret = asnprintf(&bf, size, "%s/%s", linkname,
275 build_id_cache__basename(is_kallsyms, is_vdso,
277 if (ret < 0 || (!alloc && size < (unsigned int)ret))
284 #define dsos__for_each_with_build_id(pos, head) \
285 list_for_each_entry(pos, head, node) \
286 if (!pos->has_build_id) \
290 static int write_buildid(const char *name, size_t name_len, u8 *build_id,
291 pid_t pid, u16 misc, struct feat_fd *fd)
294 struct build_id_event b;
298 len = PERF_ALIGN(len, NAME_ALIGN);
300 memset(&b, 0, sizeof(b));
301 memcpy(&b.build_id, build_id, BUILD_ID_SIZE);
303 b.header.misc = misc;
304 b.header.size = sizeof(b) + len;
306 err = do_write(fd, &b, sizeof(b));
310 return write_padded(fd, name, name_len + 1, len);
313 static int machine__write_buildid_table(struct machine *machine,
318 u16 kmisc = PERF_RECORD_MISC_KERNEL,
319 umisc = PERF_RECORD_MISC_USER;
321 if (!machine__is_host(machine)) {
322 kmisc = PERF_RECORD_MISC_GUEST_KERNEL;
323 umisc = PERF_RECORD_MISC_GUEST_USER;
326 dsos__for_each_with_build_id(pos, &machine->dsos.head) {
329 bool in_kernel = false;
331 if (!pos->hit && !dso__is_vdso(pos))
334 if (dso__is_vdso(pos)) {
335 name = pos->short_name;
336 name_len = pos->short_name_len;
337 } else if (dso__is_kcore(pos)) {
338 name = machine->mmap_name;
339 name_len = strlen(name);
341 name = pos->long_name;
342 name_len = pos->long_name_len;
345 in_kernel = pos->kernel ||
346 is_kernel_module(name,
347 PERF_RECORD_MISC_CPUMODE_UNKNOWN);
348 err = write_buildid(name, name_len, pos->build_id, machine->pid,
349 in_kernel ? kmisc : umisc, fd);
357 int perf_session__write_buildid_table(struct perf_session *session,
361 int err = machine__write_buildid_table(&session->machines.host, fd);
366 for (nd = rb_first(&session->machines.guests); nd; nd = rb_next(nd)) {
367 struct machine *pos = rb_entry(nd, struct machine, rb_node);
368 err = machine__write_buildid_table(pos, fd);
375 static int __dsos__hit_all(struct list_head *head)
379 list_for_each_entry(pos, head, node)
385 static int machine__hit_all_dsos(struct machine *machine)
387 return __dsos__hit_all(&machine->dsos.head);
390 int dsos__hit_all(struct perf_session *session)
395 err = machine__hit_all_dsos(&session->machines.host);
399 for (nd = rb_first(&session->machines.guests); nd; nd = rb_next(nd)) {
400 struct machine *pos = rb_entry(nd, struct machine, rb_node);
402 err = machine__hit_all_dsos(pos);
410 void disable_buildid_cache(void)
412 no_buildid_cache = true;
415 static bool lsdir_bid_head_filter(const char *name __maybe_unused,
418 return (strlen(d->d_name) == 2) &&
419 isxdigit(d->d_name[0]) && isxdigit(d->d_name[1]);
422 static bool lsdir_bid_tail_filter(const char *name __maybe_unused,
426 while (isxdigit(d->d_name[i]) && i < SBUILD_ID_SIZE - 3)
428 return (i == SBUILD_ID_SIZE - 3) && (d->d_name[i] == '\0');
431 struct strlist *build_id_cache__list_all(bool validonly)
433 struct strlist *toplist, *linklist = NULL, *bidlist;
434 struct str_node *nd, *nd2;
435 char *topdir, *linkdir = NULL;
436 char sbuild_id[SBUILD_ID_SIZE];
438 /* for filename__ functions */
442 /* Open the top-level directory */
443 if (asprintf(&topdir, "%s/.build-id/", buildid_dir) < 0)
446 bidlist = strlist__new(NULL, NULL);
450 toplist = lsdir(topdir, lsdir_bid_head_filter);
452 pr_debug("Error in lsdir(%s): %d\n", topdir, errno);
453 /* If there is no buildid cache, return an empty list */
459 strlist__for_each_entry(nd, toplist) {
460 if (asprintf(&linkdir, "%s/%s", topdir, nd->s) < 0)
462 /* Open the lower-level directory */
463 linklist = lsdir(linkdir, lsdir_bid_tail_filter);
465 pr_debug("Error in lsdir(%s): %d\n", linkdir, errno);
468 strlist__for_each_entry(nd2, linklist) {
469 if (snprintf(sbuild_id, SBUILD_ID_SIZE, "%s%s",
470 nd->s, nd2->s) != SBUILD_ID_SIZE - 1)
472 if (validonly && !build_id_cache__valid_id(sbuild_id))
474 if (strlist__add(bidlist, sbuild_id) < 0)
477 strlist__delete(linklist);
482 strlist__delete(toplist);
489 strlist__delete(linklist);
491 strlist__delete(bidlist);
496 static bool str_is_build_id(const char *maybe_sbuild_id, size_t len)
500 for (i = 0; i < len; i++) {
501 if (!isxdigit(maybe_sbuild_id[i]))
507 /* Return the valid complete build-id */
508 char *build_id_cache__complement(const char *incomplete_sbuild_id)
510 struct strlist *bidlist;
511 struct str_node *nd, *cand = NULL;
512 char *sbuild_id = NULL;
513 size_t len = strlen(incomplete_sbuild_id);
515 if (len >= SBUILD_ID_SIZE ||
516 !str_is_build_id(incomplete_sbuild_id, len))
519 bidlist = build_id_cache__list_all(true);
523 strlist__for_each_entry(nd, bidlist) {
524 if (strncmp(nd->s, incomplete_sbuild_id, len) != 0)
526 if (cand) { /* Error: There are more than 2 candidates. */
533 sbuild_id = strdup(cand->s);
534 strlist__delete(bidlist);
539 char *build_id_cache__cachedir(const char *sbuild_id, const char *name,
540 struct nsinfo *nsi, bool is_kallsyms,
543 char *realname = (char *)name, *filename;
544 bool slash = is_kallsyms || is_vdso;
547 realname = nsinfo__realpath(name, nsi);
552 if (asprintf(&filename, "%s%s%s%s%s", buildid_dir, slash ? "/" : "",
553 is_vdso ? DSO__NAME_VDSO : realname,
554 sbuild_id ? "/" : "", sbuild_id ?: "") < 0)
563 int build_id_cache__list_build_ids(const char *pathname, struct nsinfo *nsi,
564 struct strlist **result)
569 dir_name = build_id_cache__cachedir(NULL, pathname, nsi, false, false);
573 *result = lsdir(dir_name, lsdir_no_dot_filter);
581 #if defined(HAVE_LIBELF_SUPPORT) && defined(HAVE_GELF_GETNOTE_SUPPORT)
582 static int build_id_cache__add_sdt_cache(const char *sbuild_id,
583 const char *realname,
586 struct probe_cache *cache;
590 cache = probe_cache__new(sbuild_id, nsi);
594 nsinfo__mountns_enter(nsi, &nsc);
595 ret = probe_cache__scan_sdt(cache, realname);
596 nsinfo__mountns_exit(&nsc);
598 pr_debug4("Found %d SDTs in %s\n", ret, realname);
599 if (probe_cache__commit(cache) < 0)
602 probe_cache__delete(cache);
606 #define build_id_cache__add_sdt_cache(sbuild_id, realname, nsi) (0)
609 static char *build_id_cache__find_debug(const char *sbuild_id,
612 char *realname = NULL;
617 debugfile = calloc(1, PATH_MAX);
621 len = __symbol__join_symfs(debugfile, PATH_MAX,
622 "/usr/lib/debug/.build-id/");
623 snprintf(debugfile + len, PATH_MAX - len, "%.2s/%s.debug", sbuild_id,
626 nsinfo__mountns_enter(nsi, &nsc);
627 realname = realpath(debugfile, NULL);
628 if (realname && access(realname, R_OK))
630 nsinfo__mountns_exit(&nsc);
636 int build_id_cache__add_s(const char *sbuild_id, const char *name,
637 struct nsinfo *nsi, bool is_kallsyms, bool is_vdso)
639 const size_t size = PATH_MAX;
640 char *realname = NULL, *filename = NULL, *dir_name = NULL,
641 *linkname = zalloc(size), *tmp;
642 char *debugfile = NULL;
647 realname = nsinfo__realpath(name, nsi);
649 realname = realpath(name, NULL);
654 dir_name = build_id_cache__cachedir(sbuild_id, name, nsi, is_kallsyms,
659 /* Remove old style build-id cache */
660 if (is_regular_file(dir_name))
661 if (unlink(dir_name))
664 if (mkdir_p(dir_name, 0755))
667 /* Save the allocated buildid dirname */
668 if (asprintf(&filename, "%s/%s", dir_name,
669 build_id_cache__basename(is_kallsyms, is_vdso,
675 if (access(filename, F_OK)) {
677 if (copyfile("/proc/kallsyms", filename))
679 } else if (nsi && nsi->need_setns) {
680 if (copyfile_ns(name, filename, nsi))
682 } else if (link(realname, filename) && errno != EEXIST &&
683 copyfile(name, filename))
687 /* Some binaries are stripped, but have .debug files with their symbol
688 * table. Check to see if we can locate one of those, since the elf
689 * file itself may not be very useful to users of our tools without a
692 if (!is_kallsyms && !is_vdso &&
693 strncmp(".ko", name + strlen(name) - 3, 3)) {
694 debugfile = build_id_cache__find_debug(sbuild_id, nsi);
697 if (asprintf(&filename, "%s/%s", dir_name,
698 build_id_cache__basename(false, false, true)) < 0) {
702 if (access(filename, F_OK)) {
703 if (nsi && nsi->need_setns) {
704 if (copyfile_ns(debugfile, filename,
707 } else if (link(debugfile, filename) &&
709 copyfile(debugfile, filename))
715 if (!build_id_cache__linkname(sbuild_id, linkname, size))
717 tmp = strrchr(linkname, '/');
720 if (access(linkname, X_OK) && mkdir_p(linkname, 0755))
724 tmp = dir_name + strlen(buildid_dir) - 5;
725 memcpy(tmp, "../..", 5);
727 if (symlink(tmp, linkname) == 0)
730 /* Update SDT cache : error is just warned */
732 build_id_cache__add_sdt_cache(sbuild_id, realname, nsi) < 0)
733 pr_debug4("Failed to update/scan SDT cache for %s\n", realname);
745 static int build_id_cache__add_b(const u8 *build_id, size_t build_id_size,
746 const char *name, struct nsinfo *nsi,
747 bool is_kallsyms, bool is_vdso)
749 char sbuild_id[SBUILD_ID_SIZE];
751 build_id__sprintf(build_id, build_id_size, sbuild_id);
753 return build_id_cache__add_s(sbuild_id, name, nsi, is_kallsyms,
757 bool build_id_cache__cached(const char *sbuild_id)
760 char *filename = build_id_cache__linkname(sbuild_id, NULL, 0);
762 if (filename && !access(filename, F_OK))
769 int build_id_cache__remove_s(const char *sbuild_id)
771 const size_t size = PATH_MAX;
772 char *filename = zalloc(size),
773 *linkname = zalloc(size), *tmp;
776 if (filename == NULL || linkname == NULL)
779 if (!build_id_cache__linkname(sbuild_id, linkname, size))
782 if (access(linkname, F_OK))
785 if (readlink(linkname, filename, size - 1) < 0)
788 if (unlink(linkname))
792 * Since the link is relative, we must make it absolute:
794 tmp = strrchr(linkname, '/') + 1;
795 snprintf(tmp, size - (tmp - linkname), "%s", filename);
807 static int dso__cache_build_id(struct dso *dso, struct machine *machine)
809 bool is_kallsyms = dso__is_kallsyms(dso);
810 bool is_vdso = dso__is_vdso(dso);
811 const char *name = dso->long_name;
813 if (dso__is_kcore(dso)) {
815 name = machine->mmap_name;
817 return build_id_cache__add_b(dso->build_id, sizeof(dso->build_id), name,
818 dso->nsinfo, is_kallsyms, is_vdso);
821 static int __dsos__cache_build_ids(struct list_head *head,
822 struct machine *machine)
827 dsos__for_each_with_build_id(pos, head)
828 if (dso__cache_build_id(pos, machine))
834 static int machine__cache_build_ids(struct machine *machine)
836 return __dsos__cache_build_ids(&machine->dsos.head, machine);
839 int perf_session__cache_build_ids(struct perf_session *session)
844 if (no_buildid_cache)
847 if (mkdir(buildid_dir, 0755) != 0 && errno != EEXIST)
850 ret = machine__cache_build_ids(&session->machines.host);
852 for (nd = rb_first(&session->machines.guests); nd; nd = rb_next(nd)) {
853 struct machine *pos = rb_entry(nd, struct machine, rb_node);
854 ret |= machine__cache_build_ids(pos);
859 static bool machine__read_build_ids(struct machine *machine, bool with_hits)
861 return __dsos__read_build_ids(&machine->dsos.head, with_hits);
864 bool perf_session__read_build_ids(struct perf_session *session, bool with_hits)
867 bool ret = machine__read_build_ids(&session->machines.host, with_hits);
869 for (nd = rb_first(&session->machines.guests); nd; nd = rb_next(nd)) {
870 struct machine *pos = rb_entry(nd, struct machine, rb_node);
871 ret |= machine__read_build_ids(pos, with_hits);