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 #include <linux/ctype.h>
35 #include <linux/zalloc.h>
37 static bool no_buildid_cache
;
39 int build_id__mark_dso_hit(struct perf_tool
*tool __maybe_unused
,
40 union perf_event
*event
,
41 struct perf_sample
*sample
,
42 struct evsel
*evsel __maybe_unused
,
43 struct machine
*machine
)
45 struct addr_location al
;
46 struct thread
*thread
= machine__findnew_thread(machine
, sample
->pid
,
50 pr_err("problem processing %d event, skipping it.\n",
55 if (thread__find_map(thread
, sample
->cpumode
, sample
->ip
, &al
))
62 static int perf_event__exit_del_thread(struct perf_tool
*tool __maybe_unused
,
63 union perf_event
*event
,
64 struct perf_sample
*sample
66 struct machine
*machine
)
68 struct thread
*thread
= machine__findnew_thread(machine
,
72 dump_printf("(%d:%d):(%d:%d)\n", event
->fork
.pid
, event
->fork
.tid
,
73 event
->fork
.ppid
, event
->fork
.ptid
);
76 machine__remove_thread(machine
, thread
);
83 struct perf_tool build_id__mark_dso_hit_ops
= {
84 .sample
= build_id__mark_dso_hit
,
85 .mmap
= perf_event__process_mmap
,
86 .mmap2
= perf_event__process_mmap2
,
87 .fork
= perf_event__process_fork
,
88 .exit
= perf_event__exit_del_thread
,
89 .attr
= perf_event__process_attr
,
90 .build_id
= perf_event__process_build_id
,
91 .ordered_events
= true,
94 int build_id__sprintf(const u8
*build_id
, int len
, char *bf
)
97 const u8
*raw
= build_id
;
100 for (i
= 0; i
< len
; ++i
) {
101 sprintf(bid
, "%02x", *raw
);
106 return (bid
- bf
) + 1;
109 int sysfs__sprintf_build_id(const char *root_dir
, char *sbuild_id
)
111 char notes
[PATH_MAX
];
112 u8 build_id
[BUILD_ID_SIZE
];
118 scnprintf(notes
, sizeof(notes
), "%s/sys/kernel/notes", root_dir
);
120 ret
= sysfs__read_build_id(notes
, build_id
, sizeof(build_id
));
124 return build_id__sprintf(build_id
, sizeof(build_id
), sbuild_id
);
127 int filename__sprintf_build_id(const char *pathname
, char *sbuild_id
)
129 u8 build_id
[BUILD_ID_SIZE
];
132 ret
= filename__read_build_id(pathname
, build_id
, sizeof(build_id
));
135 else if (ret
!= sizeof(build_id
))
138 return build_id__sprintf(build_id
, sizeof(build_id
), sbuild_id
);
141 /* asnprintf consolidates asprintf and snprintf */
142 static int asnprintf(char **strp
, size_t size
, const char *fmt
, ...)
152 ret
= vsnprintf(*strp
, size
, fmt
, ap
);
154 ret
= vasprintf(strp
, fmt
, ap
);
160 char *build_id_cache__kallsyms_path(const char *sbuild_id
, char *bf
,
163 bool retry_old
= true;
165 snprintf(bf
, size
, "%s/%s/%s/kallsyms",
166 buildid_dir
, DSO__NAME_KALLSYMS
, sbuild_id
);
168 if (!access(bf
, F_OK
))
171 /* Try old style kallsyms cache */
172 snprintf(bf
, size
, "%s/%s/%s",
173 buildid_dir
, DSO__NAME_KALLSYMS
, sbuild_id
);
181 char *build_id_cache__linkname(const char *sbuild_id
, char *bf
, size_t size
)
184 int ret
= asnprintf(&bf
, size
, "%s/.build-id/%.2s/%s", buildid_dir
,
185 sbuild_id
, sbuild_id
+ 2);
186 if (ret
< 0 || (tmp
&& size
< (unsigned int)ret
))
191 /* The caller is responsible to free the returned buffer. */
192 char *build_id_cache__origname(const char *sbuild_id
)
196 char *ret
= NULL
, *p
;
197 size_t offs
= 5; /* == strlen("../..") */
200 linkname
= build_id_cache__linkname(sbuild_id
, NULL
, 0);
204 len
= readlink(linkname
, buf
, sizeof(buf
) - 1);
209 /* The link should be "../..<origpath>/<sbuild_id>" */
210 p
= strrchr(buf
, '/'); /* Cut off the "/<sbuild_id>" */
211 if (p
&& (p
> buf
+ offs
)) {
213 if (buf
[offs
+ 1] == '[')
215 * This is a DSO name, like [kernel.kallsyms].
216 * Skip the first '/', since this is not the
217 * cache of a regular file.
219 ret
= strdup(buf
+ offs
); /* Skip "../..[/]" */
226 /* Check if the given build_id cache is valid on current running system */
227 static bool build_id_cache__valid_id(char *sbuild_id
)
229 char real_sbuild_id
[SBUILD_ID_SIZE
] = "";
234 pathname
= build_id_cache__origname(sbuild_id
);
238 if (!strcmp(pathname
, DSO__NAME_KALLSYMS
))
239 ret
= sysfs__sprintf_build_id("/", real_sbuild_id
);
240 else if (pathname
[0] == '/')
241 ret
= filename__sprintf_build_id(pathname
, real_sbuild_id
);
243 ret
= -EINVAL
; /* Should we support other special DSO cache? */
245 result
= (strcmp(sbuild_id
, real_sbuild_id
) == 0);
251 static const char *build_id_cache__basename(bool is_kallsyms
, bool is_vdso
,
254 return is_kallsyms
? "kallsyms" : (is_vdso
? "vdso" : (is_debug
?
258 char *dso__build_id_filename(const struct dso
*dso
, char *bf
, size_t size
,
261 bool is_kallsyms
= dso__is_kallsyms((struct dso
*)dso
);
262 bool is_vdso
= dso__is_vdso((struct dso
*)dso
);
263 char sbuild_id
[SBUILD_ID_SIZE
];
265 bool alloc
= (bf
== NULL
);
268 if (!dso
->has_build_id
)
271 build_id__sprintf(dso
->build_id
, sizeof(dso
->build_id
), sbuild_id
);
272 linkname
= build_id_cache__linkname(sbuild_id
, NULL
, 0);
276 /* Check if old style build_id cache */
277 if (is_regular_file(linkname
))
278 ret
= asnprintf(&bf
, size
, "%s", linkname
);
280 ret
= asnprintf(&bf
, size
, "%s/%s", linkname
,
281 build_id_cache__basename(is_kallsyms
, is_vdso
,
283 if (ret
< 0 || (!alloc
&& size
< (unsigned int)ret
))
290 #define dsos__for_each_with_build_id(pos, head) \
291 list_for_each_entry(pos, head, node) \
292 if (!pos->has_build_id) \
296 static int write_buildid(const char *name
, size_t name_len
, u8
*build_id
,
297 pid_t pid
, u16 misc
, struct feat_fd
*fd
)
300 struct perf_record_header_build_id b
;
304 len
= PERF_ALIGN(len
, NAME_ALIGN
);
306 memset(&b
, 0, sizeof(b
));
307 memcpy(&b
.build_id
, build_id
, BUILD_ID_SIZE
);
309 b
.header
.misc
= misc
;
310 b
.header
.size
= sizeof(b
) + len
;
312 err
= do_write(fd
, &b
, sizeof(b
));
316 return write_padded(fd
, name
, name_len
+ 1, len
);
319 static int machine__write_buildid_table(struct machine
*machine
,
324 u16 kmisc
= PERF_RECORD_MISC_KERNEL
,
325 umisc
= PERF_RECORD_MISC_USER
;
327 if (!machine__is_host(machine
)) {
328 kmisc
= PERF_RECORD_MISC_GUEST_KERNEL
;
329 umisc
= PERF_RECORD_MISC_GUEST_USER
;
332 dsos__for_each_with_build_id(pos
, &machine
->dsos
.head
) {
335 bool in_kernel
= false;
337 if (!pos
->hit
&& !dso__is_vdso(pos
))
340 if (dso__is_vdso(pos
)) {
341 name
= pos
->short_name
;
342 name_len
= pos
->short_name_len
;
343 } else if (dso__is_kcore(pos
)) {
344 name
= machine
->mmap_name
;
345 name_len
= strlen(name
);
347 name
= pos
->long_name
;
348 name_len
= pos
->long_name_len
;
351 in_kernel
= pos
->kernel
||
352 is_kernel_module(name
,
353 PERF_RECORD_MISC_CPUMODE_UNKNOWN
);
354 err
= write_buildid(name
, name_len
, pos
->build_id
, machine
->pid
,
355 in_kernel
? kmisc
: umisc
, fd
);
363 int perf_session__write_buildid_table(struct perf_session
*session
,
367 int err
= machine__write_buildid_table(&session
->machines
.host
, fd
);
372 for (nd
= rb_first_cached(&session
->machines
.guests
); nd
;
374 struct machine
*pos
= rb_entry(nd
, struct machine
, rb_node
);
375 err
= machine__write_buildid_table(pos
, fd
);
382 static int __dsos__hit_all(struct list_head
*head
)
386 list_for_each_entry(pos
, head
, node
)
392 static int machine__hit_all_dsos(struct machine
*machine
)
394 return __dsos__hit_all(&machine
->dsos
.head
);
397 int dsos__hit_all(struct perf_session
*session
)
402 err
= machine__hit_all_dsos(&session
->machines
.host
);
406 for (nd
= rb_first_cached(&session
->machines
.guests
); nd
;
408 struct machine
*pos
= rb_entry(nd
, struct machine
, rb_node
);
410 err
= machine__hit_all_dsos(pos
);
418 void disable_buildid_cache(void)
420 no_buildid_cache
= true;
423 static bool lsdir_bid_head_filter(const char *name __maybe_unused
,
426 return (strlen(d
->d_name
) == 2) &&
427 isxdigit(d
->d_name
[0]) && isxdigit(d
->d_name
[1]);
430 static bool lsdir_bid_tail_filter(const char *name __maybe_unused
,
434 while (isxdigit(d
->d_name
[i
]) && i
< SBUILD_ID_SIZE
- 3)
436 return (i
== SBUILD_ID_SIZE
- 3) && (d
->d_name
[i
] == '\0');
439 struct strlist
*build_id_cache__list_all(bool validonly
)
441 struct strlist
*toplist
, *linklist
= NULL
, *bidlist
;
442 struct str_node
*nd
, *nd2
;
443 char *topdir
, *linkdir
= NULL
;
444 char sbuild_id
[SBUILD_ID_SIZE
];
446 /* for filename__ functions */
450 /* Open the top-level directory */
451 if (asprintf(&topdir
, "%s/.build-id/", buildid_dir
) < 0)
454 bidlist
= strlist__new(NULL
, NULL
);
458 toplist
= lsdir(topdir
, lsdir_bid_head_filter
);
460 pr_debug("Error in lsdir(%s): %d\n", topdir
, errno
);
461 /* If there is no buildid cache, return an empty list */
467 strlist__for_each_entry(nd
, toplist
) {
468 if (asprintf(&linkdir
, "%s/%s", topdir
, nd
->s
) < 0)
470 /* Open the lower-level directory */
471 linklist
= lsdir(linkdir
, lsdir_bid_tail_filter
);
473 pr_debug("Error in lsdir(%s): %d\n", linkdir
, errno
);
476 strlist__for_each_entry(nd2
, linklist
) {
477 if (snprintf(sbuild_id
, SBUILD_ID_SIZE
, "%s%s",
478 nd
->s
, nd2
->s
) != SBUILD_ID_SIZE
- 1)
480 if (validonly
&& !build_id_cache__valid_id(sbuild_id
))
482 if (strlist__add(bidlist
, sbuild_id
) < 0)
485 strlist__delete(linklist
);
490 strlist__delete(toplist
);
497 strlist__delete(linklist
);
499 strlist__delete(bidlist
);
504 static bool str_is_build_id(const char *maybe_sbuild_id
, size_t len
)
508 for (i
= 0; i
< len
; i
++) {
509 if (!isxdigit(maybe_sbuild_id
[i
]))
515 /* Return the valid complete build-id */
516 char *build_id_cache__complement(const char *incomplete_sbuild_id
)
518 struct strlist
*bidlist
;
519 struct str_node
*nd
, *cand
= NULL
;
520 char *sbuild_id
= NULL
;
521 size_t len
= strlen(incomplete_sbuild_id
);
523 if (len
>= SBUILD_ID_SIZE
||
524 !str_is_build_id(incomplete_sbuild_id
, len
))
527 bidlist
= build_id_cache__list_all(true);
531 strlist__for_each_entry(nd
, bidlist
) {
532 if (strncmp(nd
->s
, incomplete_sbuild_id
, len
) != 0)
534 if (cand
) { /* Error: There are more than 2 candidates. */
541 sbuild_id
= strdup(cand
->s
);
542 strlist__delete(bidlist
);
547 char *build_id_cache__cachedir(const char *sbuild_id
, const char *name
,
548 struct nsinfo
*nsi
, bool is_kallsyms
,
551 char *realname
= (char *)name
, *filename
;
552 bool slash
= is_kallsyms
|| is_vdso
;
555 realname
= nsinfo__realpath(name
, nsi
);
560 if (asprintf(&filename
, "%s%s%s%s%s", buildid_dir
, slash
? "/" : "",
561 is_vdso
? DSO__NAME_VDSO
: realname
,
562 sbuild_id
? "/" : "", sbuild_id
?: "") < 0)
571 int build_id_cache__list_build_ids(const char *pathname
, struct nsinfo
*nsi
,
572 struct strlist
**result
)
577 dir_name
= build_id_cache__cachedir(NULL
, pathname
, nsi
, false, false);
581 *result
= lsdir(dir_name
, lsdir_no_dot_filter
);
589 #if defined(HAVE_LIBELF_SUPPORT) && defined(HAVE_GELF_GETNOTE_SUPPORT)
590 static int build_id_cache__add_sdt_cache(const char *sbuild_id
,
591 const char *realname
,
594 struct probe_cache
*cache
;
598 cache
= probe_cache__new(sbuild_id
, nsi
);
602 nsinfo__mountns_enter(nsi
, &nsc
);
603 ret
= probe_cache__scan_sdt(cache
, realname
);
604 nsinfo__mountns_exit(&nsc
);
606 pr_debug4("Found %d SDTs in %s\n", ret
, realname
);
607 if (probe_cache__commit(cache
) < 0)
610 probe_cache__delete(cache
);
614 #define build_id_cache__add_sdt_cache(sbuild_id, realname, nsi) (0)
617 static char *build_id_cache__find_debug(const char *sbuild_id
,
620 char *realname
= NULL
;
625 debugfile
= calloc(1, PATH_MAX
);
629 len
= __symbol__join_symfs(debugfile
, PATH_MAX
,
630 "/usr/lib/debug/.build-id/");
631 snprintf(debugfile
+ len
, PATH_MAX
- len
, "%.2s/%s.debug", sbuild_id
,
634 nsinfo__mountns_enter(nsi
, &nsc
);
635 realname
= realpath(debugfile
, NULL
);
636 if (realname
&& access(realname
, R_OK
))
638 nsinfo__mountns_exit(&nsc
);
644 int build_id_cache__add_s(const char *sbuild_id
, const char *name
,
645 struct nsinfo
*nsi
, bool is_kallsyms
, bool is_vdso
)
647 const size_t size
= PATH_MAX
;
648 char *realname
= NULL
, *filename
= NULL
, *dir_name
= NULL
,
649 *linkname
= zalloc(size
), *tmp
;
650 char *debugfile
= NULL
;
655 realname
= nsinfo__realpath(name
, nsi
);
657 realname
= realpath(name
, NULL
);
662 dir_name
= build_id_cache__cachedir(sbuild_id
, name
, nsi
, is_kallsyms
,
667 /* Remove old style build-id cache */
668 if (is_regular_file(dir_name
))
669 if (unlink(dir_name
))
672 if (mkdir_p(dir_name
, 0755))
675 /* Save the allocated buildid dirname */
676 if (asprintf(&filename
, "%s/%s", dir_name
,
677 build_id_cache__basename(is_kallsyms
, is_vdso
,
683 if (access(filename
, F_OK
)) {
685 if (copyfile("/proc/kallsyms", filename
))
687 } else if (nsi
&& nsi
->need_setns
) {
688 if (copyfile_ns(name
, filename
, nsi
))
690 } else if (link(realname
, filename
) && errno
!= EEXIST
&&
691 copyfile(name
, filename
))
695 /* Some binaries are stripped, but have .debug files with their symbol
696 * table. Check to see if we can locate one of those, since the elf
697 * file itself may not be very useful to users of our tools without a
700 if (!is_kallsyms
&& !is_vdso
&&
701 strncmp(".ko", name
+ strlen(name
) - 3, 3)) {
702 debugfile
= build_id_cache__find_debug(sbuild_id
, nsi
);
705 if (asprintf(&filename
, "%s/%s", dir_name
,
706 build_id_cache__basename(false, false, true)) < 0) {
710 if (access(filename
, F_OK
)) {
711 if (nsi
&& nsi
->need_setns
) {
712 if (copyfile_ns(debugfile
, filename
,
715 } else if (link(debugfile
, filename
) &&
717 copyfile(debugfile
, filename
))
723 if (!build_id_cache__linkname(sbuild_id
, linkname
, size
))
725 tmp
= strrchr(linkname
, '/');
728 if (access(linkname
, X_OK
) && mkdir_p(linkname
, 0755))
732 tmp
= dir_name
+ strlen(buildid_dir
) - 5;
733 memcpy(tmp
, "../..", 5);
735 if (symlink(tmp
, linkname
) == 0)
738 /* Update SDT cache : error is just warned */
740 build_id_cache__add_sdt_cache(sbuild_id
, realname
, nsi
) < 0)
741 pr_debug4("Failed to update/scan SDT cache for %s\n", realname
);
753 static int build_id_cache__add_b(const u8
*build_id
, size_t build_id_size
,
754 const char *name
, struct nsinfo
*nsi
,
755 bool is_kallsyms
, bool is_vdso
)
757 char sbuild_id
[SBUILD_ID_SIZE
];
759 build_id__sprintf(build_id
, build_id_size
, sbuild_id
);
761 return build_id_cache__add_s(sbuild_id
, name
, nsi
, is_kallsyms
,
765 bool build_id_cache__cached(const char *sbuild_id
)
768 char *filename
= build_id_cache__linkname(sbuild_id
, NULL
, 0);
770 if (filename
&& !access(filename
, F_OK
))
777 int build_id_cache__remove_s(const char *sbuild_id
)
779 const size_t size
= PATH_MAX
;
780 char *filename
= zalloc(size
),
781 *linkname
= zalloc(size
), *tmp
;
784 if (filename
== NULL
|| linkname
== NULL
)
787 if (!build_id_cache__linkname(sbuild_id
, linkname
, size
))
790 if (access(linkname
, F_OK
))
793 if (readlink(linkname
, filename
, size
- 1) < 0)
796 if (unlink(linkname
))
800 * Since the link is relative, we must make it absolute:
802 tmp
= strrchr(linkname
, '/') + 1;
803 snprintf(tmp
, size
- (tmp
- linkname
), "%s", filename
);
815 static int dso__cache_build_id(struct dso
*dso
, struct machine
*machine
)
817 bool is_kallsyms
= dso__is_kallsyms(dso
);
818 bool is_vdso
= dso__is_vdso(dso
);
819 const char *name
= dso
->long_name
;
821 if (dso__is_kcore(dso
)) {
823 name
= machine
->mmap_name
;
825 return build_id_cache__add_b(dso
->build_id
, sizeof(dso
->build_id
), name
,
826 dso
->nsinfo
, is_kallsyms
, is_vdso
);
829 static int __dsos__cache_build_ids(struct list_head
*head
,
830 struct machine
*machine
)
835 dsos__for_each_with_build_id(pos
, head
)
836 if (dso__cache_build_id(pos
, machine
))
842 static int machine__cache_build_ids(struct machine
*machine
)
844 return __dsos__cache_build_ids(&machine
->dsos
.head
, machine
);
847 int perf_session__cache_build_ids(struct perf_session
*session
)
852 if (no_buildid_cache
)
855 if (mkdir(buildid_dir
, 0755) != 0 && errno
!= EEXIST
)
858 ret
= machine__cache_build_ids(&session
->machines
.host
);
860 for (nd
= rb_first_cached(&session
->machines
.guests
); nd
;
862 struct machine
*pos
= rb_entry(nd
, struct machine
, rb_node
);
863 ret
|= machine__cache_build_ids(pos
);
868 static bool machine__read_build_ids(struct machine
*machine
, bool with_hits
)
870 return __dsos__read_build_ids(&machine
->dsos
.head
, with_hits
);
873 bool perf_session__read_build_ids(struct perf_session
*session
, bool with_hits
)
876 bool ret
= machine__read_build_ids(&session
->machines
.host
, with_hits
);
878 for (nd
= rb_first_cached(&session
->machines
.guests
); nd
;
880 struct machine
*pos
= rb_entry(nd
, struct machine
, rb_node
);
881 ret
|= machine__read_build_ids(pos
, with_hits
);