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>
40 #include <linux/string.h>
43 static bool no_buildid_cache
;
45 int build_id__mark_dso_hit(struct perf_tool
*tool __maybe_unused
,
46 union perf_event
*event
,
47 struct perf_sample
*sample
,
48 struct evsel
*evsel __maybe_unused
,
49 struct machine
*machine
)
51 struct addr_location al
;
52 struct thread
*thread
= machine__findnew_thread(machine
, sample
->pid
,
56 pr_err("problem processing %d event, skipping it.\n",
61 if (thread__find_map(thread
, sample
->cpumode
, sample
->ip
, &al
))
68 static int perf_event__exit_del_thread(struct perf_tool
*tool __maybe_unused
,
69 union perf_event
*event
,
70 struct perf_sample
*sample
72 struct machine
*machine
)
74 struct thread
*thread
= machine__findnew_thread(machine
,
78 dump_printf("(%d:%d):(%d:%d)\n", event
->fork
.pid
, event
->fork
.tid
,
79 event
->fork
.ppid
, event
->fork
.ptid
);
82 machine__remove_thread(machine
, thread
);
89 struct perf_tool build_id__mark_dso_hit_ops
= {
90 .sample
= build_id__mark_dso_hit
,
91 .mmap
= perf_event__process_mmap
,
92 .mmap2
= perf_event__process_mmap2
,
93 .fork
= perf_event__process_fork
,
94 .exit
= perf_event__exit_del_thread
,
95 .attr
= perf_event__process_attr
,
96 .build_id
= perf_event__process_build_id
,
97 .ordered_events
= true,
100 int build_id__sprintf(const struct build_id
*build_id
, char *bf
)
103 const u8
*raw
= build_id
->data
;
108 for (i
= 0; i
< build_id
->size
; ++i
) {
109 sprintf(bid
, "%02x", *raw
);
114 return (bid
- bf
) + 1;
117 int sysfs__sprintf_build_id(const char *root_dir
, char *sbuild_id
)
119 char notes
[PATH_MAX
];
126 scnprintf(notes
, sizeof(notes
), "%s/sys/kernel/notes", root_dir
);
128 ret
= sysfs__read_build_id(notes
, &bid
);
132 return build_id__sprintf(&bid
, sbuild_id
);
135 int filename__sprintf_build_id(const char *pathname
, char *sbuild_id
)
140 ret
= filename__read_build_id(pathname
, &bid
);
144 return build_id__sprintf(&bid
, sbuild_id
);
147 /* asnprintf consolidates asprintf and snprintf */
148 static int asnprintf(char **strp
, size_t size
, const char *fmt
, ...)
158 ret
= vsnprintf(*strp
, size
, fmt
, ap
);
160 ret
= vasprintf(strp
, fmt
, ap
);
166 char *build_id_cache__kallsyms_path(const char *sbuild_id
, char *bf
,
169 bool retry_old
= true;
171 snprintf(bf
, size
, "%s/%s/%s/kallsyms",
172 buildid_dir
, DSO__NAME_KALLSYMS
, sbuild_id
);
174 if (!access(bf
, F_OK
))
177 /* Try old style kallsyms cache */
178 snprintf(bf
, size
, "%s/%s/%s",
179 buildid_dir
, DSO__NAME_KALLSYMS
, sbuild_id
);
187 char *build_id_cache__linkname(const char *sbuild_id
, char *bf
, size_t size
)
190 int ret
= asnprintf(&bf
, size
, "%s/.build-id/%.2s/%s", buildid_dir
,
191 sbuild_id
, sbuild_id
+ 2);
192 if (ret
< 0 || (tmp
&& size
< (unsigned int)ret
))
197 /* The caller is responsible to free the returned buffer. */
198 char *build_id_cache__origname(const char *sbuild_id
)
202 char *ret
= NULL
, *p
;
203 size_t offs
= 5; /* == strlen("../..") */
206 linkname
= build_id_cache__linkname(sbuild_id
, NULL
, 0);
210 len
= readlink(linkname
, buf
, sizeof(buf
) - 1);
215 /* The link should be "../..<origpath>/<sbuild_id>" */
216 p
= strrchr(buf
, '/'); /* Cut off the "/<sbuild_id>" */
217 if (p
&& (p
> buf
+ offs
)) {
219 if (buf
[offs
+ 1] == '[')
221 * This is a DSO name, like [kernel.kallsyms].
222 * Skip the first '/', since this is not the
223 * cache of a regular file.
225 ret
= strdup(buf
+ offs
); /* Skip "../..[/]" */
232 /* Check if the given build_id cache is valid on current running system */
233 static bool build_id_cache__valid_id(char *sbuild_id
)
235 char real_sbuild_id
[SBUILD_ID_SIZE
] = "";
240 pathname
= build_id_cache__origname(sbuild_id
);
244 if (!strcmp(pathname
, DSO__NAME_KALLSYMS
))
245 ret
= sysfs__sprintf_build_id("/", real_sbuild_id
);
246 else if (pathname
[0] == '/')
247 ret
= filename__sprintf_build_id(pathname
, real_sbuild_id
);
249 ret
= -EINVAL
; /* Should we support other special DSO cache? */
251 result
= (strcmp(sbuild_id
, real_sbuild_id
) == 0);
257 static const char *build_id_cache__basename(bool is_kallsyms
, bool is_vdso
,
260 return is_kallsyms
? "kallsyms" : (is_vdso
? "vdso" : (is_debug
?
264 char *__dso__build_id_filename(const struct dso
*dso
, char *bf
, size_t size
,
265 bool is_debug
, bool is_kallsyms
)
267 bool is_vdso
= dso__is_vdso((struct dso
*)dso
);
268 char sbuild_id
[SBUILD_ID_SIZE
];
270 bool alloc
= (bf
== NULL
);
273 if (!dso
->has_build_id
)
276 build_id__sprintf(&dso
->bid
, sbuild_id
);
277 linkname
= build_id_cache__linkname(sbuild_id
, NULL
, 0);
281 /* Check if old style build_id cache */
282 if (is_regular_file(linkname
))
283 ret
= asnprintf(&bf
, size
, "%s", linkname
);
285 ret
= asnprintf(&bf
, size
, "%s/%s", linkname
,
286 build_id_cache__basename(is_kallsyms
, is_vdso
,
288 if (ret
< 0 || (!alloc
&& size
< (unsigned int)ret
))
295 char *dso__build_id_filename(const struct dso
*dso
, char *bf
, size_t size
,
298 bool is_kallsyms
= dso__is_kallsyms((struct dso
*)dso
);
300 return __dso__build_id_filename(dso
, bf
, size
, is_debug
, is_kallsyms
);
303 #define dsos__for_each_with_build_id(pos, head) \
304 list_for_each_entry(pos, head, node) \
305 if (!pos->has_build_id) \
309 static int write_buildid(const char *name
, size_t name_len
, struct build_id
*bid
,
310 pid_t pid
, u16 misc
, struct feat_fd
*fd
)
313 struct perf_record_header_build_id b
;
317 len
= PERF_ALIGN(len
, NAME_ALIGN
);
319 memset(&b
, 0, sizeof(b
));
320 memcpy(&b
.data
, bid
->data
, bid
->size
);
321 b
.size
= (u8
) bid
->size
;
322 misc
|= PERF_RECORD_MISC_BUILD_ID_SIZE
;
324 b
.header
.misc
= misc
;
325 b
.header
.size
= sizeof(b
) + len
;
327 err
= do_write(fd
, &b
, sizeof(b
));
331 return write_padded(fd
, name
, name_len
+ 1, len
);
334 static int machine__write_buildid_table(struct machine
*machine
,
339 u16 kmisc
= PERF_RECORD_MISC_KERNEL
,
340 umisc
= PERF_RECORD_MISC_USER
;
342 if (!machine__is_host(machine
)) {
343 kmisc
= PERF_RECORD_MISC_GUEST_KERNEL
;
344 umisc
= PERF_RECORD_MISC_GUEST_USER
;
347 dsos__for_each_with_build_id(pos
, &machine
->dsos
.head
) {
350 bool in_kernel
= false;
352 if (!pos
->hit
&& !dso__is_vdso(pos
))
355 if (dso__is_vdso(pos
)) {
356 name
= pos
->short_name
;
357 name_len
= pos
->short_name_len
;
358 } else if (dso__is_kcore(pos
)) {
359 name
= machine
->mmap_name
;
360 name_len
= strlen(name
);
362 name
= pos
->long_name
;
363 name_len
= pos
->long_name_len
;
366 in_kernel
= pos
->kernel
||
367 is_kernel_module(name
,
368 PERF_RECORD_MISC_CPUMODE_UNKNOWN
);
369 err
= write_buildid(name
, name_len
, &pos
->bid
, machine
->pid
,
370 in_kernel
? kmisc
: umisc
, fd
);
378 int perf_session__write_buildid_table(struct perf_session
*session
,
382 int err
= machine__write_buildid_table(&session
->machines
.host
, fd
);
387 for (nd
= rb_first_cached(&session
->machines
.guests
); nd
;
389 struct machine
*pos
= rb_entry(nd
, struct machine
, rb_node
);
390 err
= machine__write_buildid_table(pos
, fd
);
397 static int __dsos__hit_all(struct list_head
*head
)
401 list_for_each_entry(pos
, head
, node
)
407 static int machine__hit_all_dsos(struct machine
*machine
)
409 return __dsos__hit_all(&machine
->dsos
.head
);
412 int dsos__hit_all(struct perf_session
*session
)
417 err
= machine__hit_all_dsos(&session
->machines
.host
);
421 for (nd
= rb_first_cached(&session
->machines
.guests
); nd
;
423 struct machine
*pos
= rb_entry(nd
, struct machine
, rb_node
);
425 err
= machine__hit_all_dsos(pos
);
433 void disable_buildid_cache(void)
435 no_buildid_cache
= true;
438 static bool lsdir_bid_head_filter(const char *name __maybe_unused
,
441 return (strlen(d
->d_name
) == 2) &&
442 isxdigit(d
->d_name
[0]) && isxdigit(d
->d_name
[1]);
445 static bool lsdir_bid_tail_filter(const char *name __maybe_unused
,
449 while (isxdigit(d
->d_name
[i
]) && i
< SBUILD_ID_SIZE
- 3)
451 return (i
== SBUILD_ID_SIZE
- 3) && (d
->d_name
[i
] == '\0');
454 struct strlist
*build_id_cache__list_all(bool validonly
)
456 struct strlist
*toplist
, *linklist
= NULL
, *bidlist
;
457 struct str_node
*nd
, *nd2
;
458 char *topdir
, *linkdir
= NULL
;
459 char sbuild_id
[SBUILD_ID_SIZE
];
461 /* for filename__ functions */
465 /* Open the top-level directory */
466 if (asprintf(&topdir
, "%s/.build-id/", buildid_dir
) < 0)
469 bidlist
= strlist__new(NULL
, NULL
);
473 toplist
= lsdir(topdir
, lsdir_bid_head_filter
);
475 pr_debug("Error in lsdir(%s): %d\n", topdir
, errno
);
476 /* If there is no buildid cache, return an empty list */
482 strlist__for_each_entry(nd
, toplist
) {
483 if (asprintf(&linkdir
, "%s/%s", topdir
, nd
->s
) < 0)
485 /* Open the lower-level directory */
486 linklist
= lsdir(linkdir
, lsdir_bid_tail_filter
);
488 pr_debug("Error in lsdir(%s): %d\n", linkdir
, errno
);
491 strlist__for_each_entry(nd2
, linklist
) {
492 if (snprintf(sbuild_id
, SBUILD_ID_SIZE
, "%s%s",
493 nd
->s
, nd2
->s
) != SBUILD_ID_SIZE
- 1)
495 if (validonly
&& !build_id_cache__valid_id(sbuild_id
))
497 if (strlist__add(bidlist
, sbuild_id
) < 0)
500 strlist__delete(linklist
);
505 strlist__delete(toplist
);
512 strlist__delete(linklist
);
514 strlist__delete(bidlist
);
519 static bool str_is_build_id(const char *maybe_sbuild_id
, size_t len
)
523 for (i
= 0; i
< len
; i
++) {
524 if (!isxdigit(maybe_sbuild_id
[i
]))
530 /* Return the valid complete build-id */
531 char *build_id_cache__complement(const char *incomplete_sbuild_id
)
533 struct strlist
*bidlist
;
534 struct str_node
*nd
, *cand
= NULL
;
535 char *sbuild_id
= NULL
;
536 size_t len
= strlen(incomplete_sbuild_id
);
538 if (len
>= SBUILD_ID_SIZE
||
539 !str_is_build_id(incomplete_sbuild_id
, len
))
542 bidlist
= build_id_cache__list_all(true);
546 strlist__for_each_entry(nd
, bidlist
) {
547 if (strncmp(nd
->s
, incomplete_sbuild_id
, len
) != 0)
549 if (cand
) { /* Error: There are more than 2 candidates. */
556 sbuild_id
= strdup(cand
->s
);
557 strlist__delete(bidlist
);
562 char *build_id_cache__cachedir(const char *sbuild_id
, const char *name
,
563 struct nsinfo
*nsi
, bool is_kallsyms
,
566 char *realname
= (char *)name
, *filename
;
567 bool slash
= is_kallsyms
|| is_vdso
;
570 realname
= nsinfo__realpath(name
, nsi
);
575 if (asprintf(&filename
, "%s%s%s%s%s", buildid_dir
, slash
? "/" : "",
576 is_vdso
? DSO__NAME_VDSO
: realname
,
577 sbuild_id
? "/" : "", sbuild_id
?: "") < 0)
586 int build_id_cache__list_build_ids(const char *pathname
, struct nsinfo
*nsi
,
587 struct strlist
**result
)
592 dir_name
= build_id_cache__cachedir(NULL
, pathname
, nsi
, false, false);
596 *result
= lsdir(dir_name
, lsdir_no_dot_filter
);
604 #if defined(HAVE_LIBELF_SUPPORT) && defined(HAVE_GELF_GETNOTE_SUPPORT)
605 static int build_id_cache__add_sdt_cache(const char *sbuild_id
,
606 const char *realname
,
609 struct probe_cache
*cache
;
613 cache
= probe_cache__new(sbuild_id
, nsi
);
617 nsinfo__mountns_enter(nsi
, &nsc
);
618 ret
= probe_cache__scan_sdt(cache
, realname
);
619 nsinfo__mountns_exit(&nsc
);
621 pr_debug4("Found %d SDTs in %s\n", ret
, realname
);
622 if (probe_cache__commit(cache
) < 0)
625 probe_cache__delete(cache
);
629 #define build_id_cache__add_sdt_cache(sbuild_id, realname, nsi) (0)
632 static char *build_id_cache__find_debug(const char *sbuild_id
,
635 char *realname
= NULL
;
640 debugfile
= calloc(1, PATH_MAX
);
644 len
= __symbol__join_symfs(debugfile
, PATH_MAX
,
645 "/usr/lib/debug/.build-id/");
646 snprintf(debugfile
+ len
, PATH_MAX
- len
, "%.2s/%s.debug", sbuild_id
,
649 nsinfo__mountns_enter(nsi
, &nsc
);
650 realname
= realpath(debugfile
, NULL
);
651 if (realname
&& access(realname
, R_OK
))
653 nsinfo__mountns_exit(&nsc
);
655 #ifdef HAVE_DEBUGINFOD_SUPPORT
656 if (realname
== NULL
) {
657 debuginfod_client
* c
= debuginfod_begin();
659 int fd
= debuginfod_find_debuginfo(c
,
660 (const unsigned char*)sbuild_id
, 0,
663 close(fd
); /* retaining reference by realname */
675 build_id_cache__add(const char *sbuild_id
, const char *name
, const char *realname
,
676 struct nsinfo
*nsi
, bool is_kallsyms
, bool is_vdso
)
678 const size_t size
= PATH_MAX
;
679 char *filename
= NULL
, *dir_name
= NULL
, *linkname
= zalloc(size
), *tmp
;
680 char *debugfile
= NULL
;
683 dir_name
= build_id_cache__cachedir(sbuild_id
, name
, nsi
, is_kallsyms
,
688 /* Remove old style build-id cache */
689 if (is_regular_file(dir_name
))
690 if (unlink(dir_name
))
693 if (mkdir_p(dir_name
, 0755))
696 /* Save the allocated buildid dirname */
697 if (asprintf(&filename
, "%s/%s", dir_name
,
698 build_id_cache__basename(is_kallsyms
, is_vdso
,
704 if (access(filename
, F_OK
)) {
706 if (copyfile("/proc/kallsyms", filename
))
708 } else if (nsi
&& nsi
->need_setns
) {
709 if (copyfile_ns(name
, filename
, nsi
))
711 } else if (link(realname
, filename
) && errno
!= EEXIST
&&
712 copyfile(name
, filename
))
716 /* Some binaries are stripped, but have .debug files with their symbol
717 * table. Check to see if we can locate one of those, since the elf
718 * file itself may not be very useful to users of our tools without a
721 if (!is_kallsyms
&& !is_vdso
&&
722 strncmp(".ko", name
+ strlen(name
) - 3, 3)) {
723 debugfile
= build_id_cache__find_debug(sbuild_id
, nsi
);
726 if (asprintf(&filename
, "%s/%s", dir_name
,
727 build_id_cache__basename(false, false, true)) < 0) {
731 if (access(filename
, F_OK
)) {
732 if (nsi
&& nsi
->need_setns
) {
733 if (copyfile_ns(debugfile
, filename
,
736 } else if (link(debugfile
, filename
) &&
738 copyfile(debugfile
, filename
))
744 if (!build_id_cache__linkname(sbuild_id
, linkname
, size
))
746 tmp
= strrchr(linkname
, '/');
749 if (access(linkname
, X_OK
) && mkdir_p(linkname
, 0755))
753 tmp
= dir_name
+ strlen(buildid_dir
) - 5;
754 memcpy(tmp
, "../..", 5);
756 if (symlink(tmp
, linkname
) == 0) {
758 } else if (errno
== EEXIST
) {
762 len
= readlink(linkname
, path
, sizeof(path
) - 1);
764 pr_err("Cant read link: %s\n", linkname
);
769 if (strcmp(tmp
, path
)) {
770 pr_debug("build <%s> already linked to %s\n",
771 sbuild_id
, linkname
);
776 /* Update SDT cache : error is just warned */
778 build_id_cache__add_sdt_cache(sbuild_id
, realname
, nsi
) < 0)
779 pr_debug4("Failed to update/scan SDT cache for %s\n", realname
);
789 int build_id_cache__add_s(const char *sbuild_id
, const char *name
,
790 struct nsinfo
*nsi
, bool is_kallsyms
, bool is_vdso
)
792 char *realname
= NULL
;
797 realname
= nsinfo__realpath(name
, nsi
);
799 realname
= realpath(name
, NULL
);
804 err
= build_id_cache__add(sbuild_id
, name
, realname
, nsi
, is_kallsyms
, is_vdso
);
812 static int build_id_cache__add_b(const struct build_id
*bid
,
813 const char *name
, struct nsinfo
*nsi
,
814 bool is_kallsyms
, bool is_vdso
)
816 char sbuild_id
[SBUILD_ID_SIZE
];
818 build_id__sprintf(bid
, sbuild_id
);
820 return build_id_cache__add_s(sbuild_id
, name
, nsi
, is_kallsyms
,
824 bool build_id_cache__cached(const char *sbuild_id
)
827 char *filename
= build_id_cache__linkname(sbuild_id
, NULL
, 0);
829 if (filename
&& !access(filename
, F_OK
))
836 int build_id_cache__remove_s(const char *sbuild_id
)
838 const size_t size
= PATH_MAX
;
839 char *filename
= zalloc(size
),
840 *linkname
= zalloc(size
), *tmp
;
843 if (filename
== NULL
|| linkname
== NULL
)
846 if (!build_id_cache__linkname(sbuild_id
, linkname
, size
))
849 if (access(linkname
, F_OK
))
852 if (readlink(linkname
, filename
, size
- 1) < 0)
855 if (unlink(linkname
))
859 * Since the link is relative, we must make it absolute:
861 tmp
= strrchr(linkname
, '/') + 1;
862 snprintf(tmp
, size
- (tmp
- linkname
), "%s", filename
);
874 static int dso__cache_build_id(struct dso
*dso
, struct machine
*machine
,
875 void *priv __maybe_unused
)
877 bool is_kallsyms
= dso__is_kallsyms(dso
);
878 bool is_vdso
= dso__is_vdso(dso
);
879 const char *name
= dso
->long_name
;
881 if (!dso
->has_build_id
)
884 if (dso__is_kcore(dso
)) {
886 name
= machine
->mmap_name
;
888 return build_id_cache__add_b(&dso
->bid
, name
, dso
->nsinfo
,
889 is_kallsyms
, is_vdso
);
893 machines__for_each_dso(struct machines
*machines
, machine__dso_t fn
, void *priv
)
895 int ret
= machine__for_each_dso(&machines
->host
, fn
, priv
);
898 for (nd
= rb_first_cached(&machines
->guests
); nd
;
900 struct machine
*pos
= rb_entry(nd
, struct machine
, rb_node
);
902 ret
|= machine__for_each_dso(pos
, fn
, priv
);
907 int __perf_session__cache_build_ids(struct perf_session
*session
,
908 machine__dso_t fn
, void *priv
)
910 if (no_buildid_cache
)
913 if (mkdir(buildid_dir
, 0755) != 0 && errno
!= EEXIST
)
916 return machines__for_each_dso(&session
->machines
, fn
, priv
) ? -1 : 0;
919 int perf_session__cache_build_ids(struct perf_session
*session
)
921 return __perf_session__cache_build_ids(session
, dso__cache_build_id
, NULL
);
924 static bool machine__read_build_ids(struct machine
*machine
, bool with_hits
)
926 return __dsos__read_build_ids(&machine
->dsos
.head
, with_hits
);
929 bool perf_session__read_build_ids(struct perf_session
*session
, bool with_hits
)
932 bool ret
= machine__read_build_ids(&session
->machines
.host
, with_hits
);
934 for (nd
= rb_first_cached(&session
->machines
.guests
); nd
;
936 struct machine
*pos
= rb_entry(nd
, struct machine
, rb_node
);
937 ret
|= machine__read_build_ids(pos
, with_hits
);
943 void build_id__init(struct build_id
*bid
, const u8
*data
, size_t size
)
945 WARN_ON(size
> BUILD_ID_SIZE
);
946 memcpy(bid
->data
, data
, size
);
950 bool build_id__is_defined(const struct build_id
*bid
)
952 return bid
&& bid
->size
? !!memchr_inv(bid
->data
, 0, bid
->size
) : false;