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 thread__find_addr_map(thread, sample->cpumode, MAP__FUNCTION, sample->ip, &al);
59 static int perf_event__exit_del_thread(struct perf_tool *tool __maybe_unused,
60 union perf_event *event,
61 struct perf_sample *sample
63 struct machine *machine)
65 struct thread *thread = machine__findnew_thread(machine,
69 dump_printf("(%d:%d):(%d:%d)\n", event->fork.pid, event->fork.tid,
70 event->fork.ppid, event->fork.ptid);
73 machine__remove_thread(machine, thread);
80 struct perf_tool build_id__mark_dso_hit_ops = {
81 .sample = build_id__mark_dso_hit,
82 .mmap = perf_event__process_mmap,
83 .mmap2 = perf_event__process_mmap2,
84 .fork = perf_event__process_fork,
85 .exit = perf_event__exit_del_thread,
86 .attr = perf_event__process_attr,
87 .build_id = perf_event__process_build_id,
88 .ordered_events = true,
91 int build_id__sprintf(const u8 *build_id, int len, char *bf)
94 const u8 *raw = build_id;
97 for (i = 0; i < len; ++i) {
98 sprintf(bid, "%02x", *raw);
103 return (bid - bf) + 1;
106 int sysfs__sprintf_build_id(const char *root_dir, char *sbuild_id)
108 char notes[PATH_MAX];
109 u8 build_id[BUILD_ID_SIZE];
115 scnprintf(notes, sizeof(notes), "%s/sys/kernel/notes", root_dir);
117 ret = sysfs__read_build_id(notes, build_id, sizeof(build_id));
121 return build_id__sprintf(build_id, sizeof(build_id), sbuild_id);
124 int filename__sprintf_build_id(const char *pathname, char *sbuild_id)
126 u8 build_id[BUILD_ID_SIZE];
129 ret = filename__read_build_id(pathname, build_id, sizeof(build_id));
132 else if (ret != sizeof(build_id))
135 return build_id__sprintf(build_id, sizeof(build_id), sbuild_id);
138 /* asnprintf consolidates asprintf and snprintf */
139 static int asnprintf(char **strp, size_t size, const char *fmt, ...)
149 ret = vsnprintf(*strp, size, fmt, ap);
151 ret = vasprintf(strp, fmt, ap);
157 char *build_id_cache__kallsyms_path(const char *sbuild_id, char *bf,
160 bool retry_old = true;
162 snprintf(bf, size, "%s/%s/%s/kallsyms",
163 buildid_dir, DSO__NAME_KALLSYMS, sbuild_id);
165 if (!access(bf, F_OK))
168 /* Try old style kallsyms cache */
169 snprintf(bf, size, "%s/%s/%s",
170 buildid_dir, DSO__NAME_KALLSYMS, sbuild_id);
178 char *build_id_cache__linkname(const char *sbuild_id, char *bf, size_t size)
181 int ret = asnprintf(&bf, size, "%s/.build-id/%.2s/%s", buildid_dir,
182 sbuild_id, sbuild_id + 2);
183 if (ret < 0 || (tmp && size < (unsigned int)ret))
188 char *build_id_cache__origname(const char *sbuild_id)
192 char *ret = NULL, *p;
193 size_t offs = 5; /* == strlen("../..") */
196 linkname = build_id_cache__linkname(sbuild_id, NULL, 0);
200 len = readlink(linkname, buf, sizeof(buf) - 1);
205 /* The link should be "../..<origpath>/<sbuild_id>" */
206 p = strrchr(buf, '/'); /* Cut off the "/<sbuild_id>" */
207 if (p && (p > buf + offs)) {
209 if (buf[offs + 1] == '[')
211 * This is a DSO name, like [kernel.kallsyms].
212 * Skip the first '/', since this is not the
213 * cache of a regular file.
215 ret = strdup(buf + offs); /* Skip "../..[/]" */
222 /* Check if the given build_id cache is valid on current running system */
223 static bool build_id_cache__valid_id(char *sbuild_id)
225 char real_sbuild_id[SBUILD_ID_SIZE] = "";
230 pathname = build_id_cache__origname(sbuild_id);
234 if (!strcmp(pathname, DSO__NAME_KALLSYMS))
235 ret = sysfs__sprintf_build_id("/", real_sbuild_id);
236 else if (pathname[0] == '/')
237 ret = filename__sprintf_build_id(pathname, real_sbuild_id);
239 ret = -EINVAL; /* Should we support other special DSO cache? */
241 result = (strcmp(sbuild_id, real_sbuild_id) == 0);
247 static const char *build_id_cache__basename(bool is_kallsyms, bool is_vdso,
250 return is_kallsyms ? "kallsyms" : (is_vdso ? "vdso" : (is_debug ?
254 char *dso__build_id_filename(const struct dso *dso, char *bf, size_t size,
257 bool is_kallsyms = dso__is_kallsyms((struct dso *)dso);
258 bool is_vdso = dso__is_vdso((struct dso *)dso);
259 char sbuild_id[SBUILD_ID_SIZE];
261 bool alloc = (bf == NULL);
264 if (!dso->has_build_id)
267 build_id__sprintf(dso->build_id, sizeof(dso->build_id), sbuild_id);
268 linkname = build_id_cache__linkname(sbuild_id, NULL, 0);
272 /* Check if old style build_id cache */
273 if (is_regular_file(linkname))
274 ret = asnprintf(&bf, size, "%s", linkname);
276 ret = asnprintf(&bf, size, "%s/%s", linkname,
277 build_id_cache__basename(is_kallsyms, is_vdso,
279 if (ret < 0 || (!alloc && size < (unsigned int)ret))
286 #define dsos__for_each_with_build_id(pos, head) \
287 list_for_each_entry(pos, head, node) \
288 if (!pos->has_build_id) \
292 static int write_buildid(const char *name, size_t name_len, u8 *build_id,
293 pid_t pid, u16 misc, struct feat_fd *fd)
296 struct build_id_event b;
300 len = PERF_ALIGN(len, NAME_ALIGN);
302 memset(&b, 0, sizeof(b));
303 memcpy(&b.build_id, build_id, BUILD_ID_SIZE);
305 b.header.misc = misc;
306 b.header.size = sizeof(b) + len;
308 err = do_write(fd, &b, sizeof(b));
312 return write_padded(fd, name, name_len + 1, len);
315 static int machine__write_buildid_table(struct machine *machine,
321 u16 kmisc = PERF_RECORD_MISC_KERNEL,
322 umisc = PERF_RECORD_MISC_USER;
324 if (!machine__is_host(machine)) {
325 kmisc = PERF_RECORD_MISC_GUEST_KERNEL;
326 umisc = PERF_RECORD_MISC_GUEST_USER;
329 dsos__for_each_with_build_id(pos, &machine->dsos.head) {
332 bool in_kernel = false;
334 if (!pos->hit && !dso__is_vdso(pos))
337 if (dso__is_vdso(pos)) {
338 name = pos->short_name;
339 name_len = pos->short_name_len;
340 } else if (dso__is_kcore(pos)) {
341 machine__mmap_name(machine, nm, sizeof(nm));
343 name_len = strlen(nm);
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(&session->machines.guests); nd; nd = rb_next(nd)) {
371 struct machine *pos = rb_entry(nd, struct machine, rb_node);
372 err = machine__write_buildid_table(pos, fd);
379 static int __dsos__hit_all(struct list_head *head)
383 list_for_each_entry(pos, head, node)
389 static int machine__hit_all_dsos(struct machine *machine)
391 return __dsos__hit_all(&machine->dsos.head);
394 int dsos__hit_all(struct perf_session *session)
399 err = machine__hit_all_dsos(&session->machines.host);
403 for (nd = rb_first(&session->machines.guests); nd; nd = rb_next(nd)) {
404 struct machine *pos = rb_entry(nd, struct machine, rb_node);
406 err = machine__hit_all_dsos(pos);
414 void disable_buildid_cache(void)
416 no_buildid_cache = true;
419 static bool lsdir_bid_head_filter(const char *name __maybe_unused,
422 return (strlen(d->d_name) == 2) &&
423 isxdigit(d->d_name[0]) && isxdigit(d->d_name[1]);
426 static bool lsdir_bid_tail_filter(const char *name __maybe_unused,
430 while (isxdigit(d->d_name[i]) && i < SBUILD_ID_SIZE - 3)
432 return (i == SBUILD_ID_SIZE - 3) && (d->d_name[i] == '\0');
435 struct strlist *build_id_cache__list_all(bool validonly)
437 struct strlist *toplist, *linklist = NULL, *bidlist;
438 struct str_node *nd, *nd2;
439 char *topdir, *linkdir = NULL;
440 char sbuild_id[SBUILD_ID_SIZE];
442 /* for filename__ functions */
446 /* Open the top-level directory */
447 if (asprintf(&topdir, "%s/.build-id/", buildid_dir) < 0)
450 bidlist = strlist__new(NULL, NULL);
454 toplist = lsdir(topdir, lsdir_bid_head_filter);
456 pr_debug("Error in lsdir(%s): %d\n", topdir, errno);
457 /* If there is no buildid cache, return an empty list */
463 strlist__for_each_entry(nd, toplist) {
464 if (asprintf(&linkdir, "%s/%s", topdir, nd->s) < 0)
466 /* Open the lower-level directory */
467 linklist = lsdir(linkdir, lsdir_bid_tail_filter);
469 pr_debug("Error in lsdir(%s): %d\n", linkdir, errno);
472 strlist__for_each_entry(nd2, linklist) {
473 if (snprintf(sbuild_id, SBUILD_ID_SIZE, "%s%s",
474 nd->s, nd2->s) != SBUILD_ID_SIZE - 1)
476 if (validonly && !build_id_cache__valid_id(sbuild_id))
478 if (strlist__add(bidlist, sbuild_id) < 0)
481 strlist__delete(linklist);
486 strlist__delete(toplist);
493 strlist__delete(linklist);
495 strlist__delete(bidlist);
500 static bool str_is_build_id(const char *maybe_sbuild_id, size_t len)
504 for (i = 0; i < len; i++) {
505 if (!isxdigit(maybe_sbuild_id[i]))
511 /* Return the valid complete build-id */
512 char *build_id_cache__complement(const char *incomplete_sbuild_id)
514 struct strlist *bidlist;
515 struct str_node *nd, *cand = NULL;
516 char *sbuild_id = NULL;
517 size_t len = strlen(incomplete_sbuild_id);
519 if (len >= SBUILD_ID_SIZE ||
520 !str_is_build_id(incomplete_sbuild_id, len))
523 bidlist = build_id_cache__list_all(true);
527 strlist__for_each_entry(nd, bidlist) {
528 if (strncmp(nd->s, incomplete_sbuild_id, len) != 0)
530 if (cand) { /* Error: There are more than 2 candidates. */
537 sbuild_id = strdup(cand->s);
538 strlist__delete(bidlist);
543 char *build_id_cache__cachedir(const char *sbuild_id, const char *name,
544 struct nsinfo *nsi, bool is_kallsyms,
547 char *realname = (char *)name, *filename;
548 bool slash = is_kallsyms || is_vdso;
551 realname = nsinfo__realpath(name, nsi);
556 if (asprintf(&filename, "%s%s%s%s%s", buildid_dir, slash ? "/" : "",
557 is_vdso ? DSO__NAME_VDSO : realname,
558 sbuild_id ? "/" : "", sbuild_id ?: "") < 0)
567 int build_id_cache__list_build_ids(const char *pathname, struct nsinfo *nsi,
568 struct strlist **result)
573 dir_name = build_id_cache__cachedir(NULL, pathname, nsi, false, false);
577 *result = lsdir(dir_name, lsdir_no_dot_filter);
585 #if defined(HAVE_LIBELF_SUPPORT) && defined(HAVE_GELF_GETNOTE_SUPPORT)
586 static int build_id_cache__add_sdt_cache(const char *sbuild_id,
587 const char *realname,
590 struct probe_cache *cache;
594 cache = probe_cache__new(sbuild_id, nsi);
598 nsinfo__mountns_enter(nsi, &nsc);
599 ret = probe_cache__scan_sdt(cache, realname);
600 nsinfo__mountns_exit(&nsc);
602 pr_debug4("Found %d SDTs in %s\n", ret, realname);
603 if (probe_cache__commit(cache) < 0)
606 probe_cache__delete(cache);
610 #define build_id_cache__add_sdt_cache(sbuild_id, realname, nsi) (0)
613 static char *build_id_cache__find_debug(const char *sbuild_id,
616 char *realname = NULL;
621 debugfile = calloc(1, PATH_MAX);
625 len = __symbol__join_symfs(debugfile, PATH_MAX,
626 "/usr/lib/debug/.build-id/");
627 snprintf(debugfile + len, PATH_MAX - len, "%.2s/%s.debug", sbuild_id,
630 nsinfo__mountns_enter(nsi, &nsc);
631 realname = realpath(debugfile, NULL);
632 if (realname && access(realname, R_OK))
634 nsinfo__mountns_exit(&nsc);
640 int build_id_cache__add_s(const char *sbuild_id, const char *name,
641 struct nsinfo *nsi, bool is_kallsyms, bool is_vdso)
643 const size_t size = PATH_MAX;
644 char *realname = NULL, *filename = NULL, *dir_name = NULL,
645 *linkname = zalloc(size), *tmp;
646 char *debugfile = NULL;
651 realname = nsinfo__realpath(name, nsi);
653 realname = realpath(name, NULL);
658 dir_name = build_id_cache__cachedir(sbuild_id, name, nsi, is_kallsyms,
663 /* Remove old style build-id cache */
664 if (is_regular_file(dir_name))
665 if (unlink(dir_name))
668 if (mkdir_p(dir_name, 0755))
671 /* Save the allocated buildid dirname */
672 if (asprintf(&filename, "%s/%s", dir_name,
673 build_id_cache__basename(is_kallsyms, is_vdso,
679 if (access(filename, F_OK)) {
681 if (copyfile("/proc/kallsyms", filename))
683 } else if (nsi && nsi->need_setns) {
684 if (copyfile_ns(name, filename, nsi))
686 } else if (link(realname, filename) && errno != EEXIST &&
687 copyfile(name, filename))
691 /* Some binaries are stripped, but have .debug files with their symbol
692 * table. Check to see if we can locate one of those, since the elf
693 * file itself may not be very useful to users of our tools without a
696 if (!is_kallsyms && !is_vdso &&
697 strncmp(".ko", name + strlen(name) - 3, 3)) {
698 debugfile = build_id_cache__find_debug(sbuild_id, nsi);
701 if (asprintf(&filename, "%s/%s", dir_name,
702 build_id_cache__basename(false, false, true)) < 0) {
706 if (access(filename, F_OK)) {
707 if (nsi && nsi->need_setns) {
708 if (copyfile_ns(debugfile, filename,
711 } else if (link(debugfile, filename) &&
713 copyfile(debugfile, filename))
719 if (!build_id_cache__linkname(sbuild_id, linkname, size))
721 tmp = strrchr(linkname, '/');
724 if (access(linkname, X_OK) && mkdir_p(linkname, 0755))
728 tmp = dir_name + strlen(buildid_dir) - 5;
729 memcpy(tmp, "../..", 5);
731 if (symlink(tmp, linkname) == 0)
734 /* Update SDT cache : error is just warned */
736 build_id_cache__add_sdt_cache(sbuild_id, realname, nsi) < 0)
737 pr_debug4("Failed to update/scan SDT cache for %s\n", realname);
749 static int build_id_cache__add_b(const u8 *build_id, size_t build_id_size,
750 const char *name, struct nsinfo *nsi,
751 bool is_kallsyms, bool is_vdso)
753 char sbuild_id[SBUILD_ID_SIZE];
755 build_id__sprintf(build_id, build_id_size, sbuild_id);
757 return build_id_cache__add_s(sbuild_id, name, nsi, is_kallsyms,
761 bool build_id_cache__cached(const char *sbuild_id)
764 char *filename = build_id_cache__linkname(sbuild_id, NULL, 0);
766 if (filename && !access(filename, F_OK))
773 int build_id_cache__remove_s(const char *sbuild_id)
775 const size_t size = PATH_MAX;
776 char *filename = zalloc(size),
777 *linkname = zalloc(size), *tmp;
780 if (filename == NULL || linkname == NULL)
783 if (!build_id_cache__linkname(sbuild_id, linkname, size))
786 if (access(linkname, F_OK))
789 if (readlink(linkname, filename, size - 1) < 0)
792 if (unlink(linkname))
796 * Since the link is relative, we must make it absolute:
798 tmp = strrchr(linkname, '/') + 1;
799 snprintf(tmp, size - (tmp - linkname), "%s", filename);
811 static int dso__cache_build_id(struct dso *dso, struct machine *machine)
813 bool is_kallsyms = dso__is_kallsyms(dso);
814 bool is_vdso = dso__is_vdso(dso);
815 const char *name = dso->long_name;
818 if (dso__is_kcore(dso)) {
820 machine__mmap_name(machine, nm, sizeof(nm));
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(&session->machines.guests); nd; nd = rb_next(nd)) {
859 struct machine *pos = rb_entry(nd, struct machine, rb_node);
860 ret |= machine__cache_build_ids(pos);
865 static bool machine__read_build_ids(struct machine *machine, bool with_hits)
867 return __dsos__read_build_ids(&machine->dsos.head, with_hits);
870 bool perf_session__read_build_ids(struct perf_session *session, bool with_hits)
873 bool ret = machine__read_build_ids(&session->machines.host, with_hits);
875 for (nd = rb_first(&session->machines.guests); nd; nd = rb_next(nd)) {
876 struct machine *pos = rb_entry(nd, struct machine, rb_node);
877 ret |= machine__read_build_ids(pos, with_hits);