// SPDX-License-Identifier: GPL-2.0 /* * build-id.c * * build-id support * * Copyright (C) 2009, 2010 Red Hat Inc. * Copyright (C) 2009, 2010 Arnaldo Carvalho de Melo */ #include "util.h" // lsdir(), mkdir_p(), rm_rf() #include #include #include #include #include #include "util/copyfile.h" #include "dso.h" #include "build-id.h" #include "event.h" #include "namespaces.h" #include "map.h" #include "symbol.h" #include "thread.h" #include #include "debug.h" #include "session.h" #include "tool.h" #include "header.h" #include "vdso.h" #include "path.h" #include "probe-file.h" #include "strlist.h" #ifdef HAVE_DEBUGINFOD_SUPPORT #include #endif #include #include #include #include static bool no_buildid_cache; int build_id__mark_dso_hit(const struct perf_tool *tool __maybe_unused, union perf_event *event, struct perf_sample *sample, struct evsel *evsel __maybe_unused, struct machine *machine) { struct addr_location al; struct thread *thread = machine__findnew_thread(machine, sample->pid, sample->tid); if (thread == NULL) { pr_err("problem processing %d event, skipping it.\n", event->header.type); return -1; } addr_location__init(&al); if (thread__find_map(thread, sample->cpumode, sample->ip, &al)) dso__set_hit(map__dso(al.map)); addr_location__exit(&al); thread__put(thread); return 0; } int build_id__sprintf(const struct build_id *build_id, char *bf) { char *bid = bf; const u8 *raw = build_id->data; size_t i; bf[0] = 0x0; for (i = 0; i < build_id->size; ++i) { sprintf(bid, "%02x", *raw); ++raw; bid += 2; } return (bid - bf) + 1; } int sysfs__sprintf_build_id(const char *root_dir, char *sbuild_id) { char notes[PATH_MAX]; struct build_id bid; int ret; if (!root_dir) root_dir = ""; scnprintf(notes, sizeof(notes), "%s/sys/kernel/notes", root_dir); ret = sysfs__read_build_id(notes, &bid); if (ret < 0) return ret; return build_id__sprintf(&bid, sbuild_id); } int filename__sprintf_build_id(const char *pathname, char *sbuild_id) { struct build_id bid; int ret; ret = filename__read_build_id(pathname, &bid); if (ret < 0) return ret; return build_id__sprintf(&bid, sbuild_id); } /* asnprintf consolidates asprintf and snprintf */ static int asnprintf(char **strp, size_t size, const char *fmt, ...) { va_list ap; int ret; if (!strp) return -EINVAL; va_start(ap, fmt); if (*strp) ret = vsnprintf(*strp, size, fmt, ap); else ret = vasprintf(strp, fmt, ap); va_end(ap); return ret; } char *build_id_cache__kallsyms_path(const char *sbuild_id, char *bf, size_t size) { bool retry_old = true; snprintf(bf, size, "%s/%s/%s/kallsyms", buildid_dir, DSO__NAME_KALLSYMS, sbuild_id); retry: if (!access(bf, F_OK)) return bf; if (retry_old) { /* Try old style kallsyms cache */ snprintf(bf, size, "%s/%s/%s", buildid_dir, DSO__NAME_KALLSYMS, sbuild_id); retry_old = false; goto retry; } return NULL; } char *build_id_cache__linkname(const char *sbuild_id, char *bf, size_t size) { char *tmp = bf; int ret = asnprintf(&bf, size, "%s/.build-id/%.2s/%s", buildid_dir, sbuild_id, sbuild_id + 2); if (ret < 0 || (tmp && size < (unsigned int)ret)) return NULL; return bf; } /* The caller is responsible to free the returned buffer. */ char *build_id_cache__origname(const char *sbuild_id) { char *linkname; char buf[PATH_MAX]; char *ret = NULL, *p; size_t offs = 5; /* == strlen("../..") */ ssize_t len; linkname = build_id_cache__linkname(sbuild_id, NULL, 0); if (!linkname) return NULL; len = readlink(linkname, buf, sizeof(buf) - 1); if (len <= 0) goto out; buf[len] = '\0'; /* The link should be "../../" */ p = strrchr(buf, '/'); /* Cut off the "/" */ if (p && (p > buf + offs)) { *p = '\0'; if (buf[offs + 1] == '[') offs++; /* * This is a DSO name, like [kernel.kallsyms]. * Skip the first '/', since this is not the * cache of a regular file. */ ret = strdup(buf + offs); /* Skip "../..[/]" */ } out: free(linkname); return ret; } /* Check if the given build_id cache is valid on current running system */ static bool build_id_cache__valid_id(char *sbuild_id) { char real_sbuild_id[SBUILD_ID_SIZE] = ""; char *pathname; int ret = 0; bool result = false; pathname = build_id_cache__origname(sbuild_id); if (!pathname) return false; if (!strcmp(pathname, DSO__NAME_KALLSYMS)) ret = sysfs__sprintf_build_id("/", real_sbuild_id); else if (pathname[0] == '/') ret = filename__sprintf_build_id(pathname, real_sbuild_id); else ret = -EINVAL; /* Should we support other special DSO cache? */ if (ret >= 0) result = (strcmp(sbuild_id, real_sbuild_id) == 0); free(pathname); return result; } static const char *build_id_cache__basename(bool is_kallsyms, bool is_vdso, bool is_debug) { return is_kallsyms ? "kallsyms" : (is_vdso ? "vdso" : (is_debug ? "debug" : "elf")); } char *__dso__build_id_filename(const struct dso *dso, char *bf, size_t size, bool is_debug, bool is_kallsyms) { bool is_vdso = dso__is_vdso((struct dso *)dso); char sbuild_id[SBUILD_ID_SIZE]; char *linkname; bool alloc = (bf == NULL); int ret; if (!dso__has_build_id(dso)) return NULL; build_id__sprintf(dso__bid_const(dso), sbuild_id); linkname = build_id_cache__linkname(sbuild_id, NULL, 0); if (!linkname) return NULL; /* Check if old style build_id cache */ if (is_regular_file(linkname)) ret = asnprintf(&bf, size, "%s", linkname); else ret = asnprintf(&bf, size, "%s/%s", linkname, build_id_cache__basename(is_kallsyms, is_vdso, is_debug)); if (ret < 0 || (!alloc && size < (unsigned int)ret)) bf = NULL; free(linkname); return bf; } char *dso__build_id_filename(const struct dso *dso, char *bf, size_t size, bool is_debug) { bool is_kallsyms = dso__is_kallsyms((struct dso *)dso); return __dso__build_id_filename(dso, bf, size, is_debug, is_kallsyms); } static int write_buildid(const char *name, size_t name_len, struct build_id *bid, pid_t pid, u16 misc, struct feat_fd *fd) { int err; struct perf_record_header_build_id b; size_t len; len = sizeof(b) + name_len + 1; len = PERF_ALIGN(len, sizeof(u64)); memset(&b, 0, sizeof(b)); memcpy(&b.data, bid->data, bid->size); b.size = (u8) bid->size; misc |= PERF_RECORD_MISC_BUILD_ID_SIZE; b.pid = pid; b.header.misc = misc; b.header.size = len; err = do_write(fd, &b, sizeof(b)); if (err < 0) return err; return write_padded(fd, name, name_len + 1, len); } struct machine__write_buildid_table_cb_args { struct machine *machine; struct feat_fd *fd; u16 kmisc, umisc; }; static int machine__write_buildid_table_cb(struct dso *dso, void *data) { struct machine__write_buildid_table_cb_args *args = data; const char *name; size_t name_len; bool in_kernel = false; if (!dso__has_build_id(dso)) return 0; if (!dso__hit(dso) && !dso__is_vdso(dso)) return 0; if (dso__is_vdso(dso)) { name = dso__short_name(dso); name_len = dso__short_name_len(dso); } else if (dso__is_kcore(dso)) { name = args->machine->mmap_name; name_len = strlen(name); } else { name = dso__long_name(dso); name_len = dso__long_name_len(dso); } in_kernel = dso__kernel(dso) || is_kernel_module(name, PERF_RECORD_MISC_CPUMODE_UNKNOWN); return write_buildid(name, name_len, dso__bid(dso), args->machine->pid, in_kernel ? args->kmisc : args->umisc, args->fd); } static int machine__write_buildid_table(struct machine *machine, struct feat_fd *fd) { struct machine__write_buildid_table_cb_args args = { .machine = machine, .fd = fd, .kmisc = PERF_RECORD_MISC_KERNEL, .umisc = PERF_RECORD_MISC_USER, }; if (!machine__is_host(machine)) { args.kmisc = PERF_RECORD_MISC_GUEST_KERNEL; args.umisc = PERF_RECORD_MISC_GUEST_USER; } return dsos__for_each_dso(&machine->dsos, machine__write_buildid_table_cb, &args); } int perf_session__write_buildid_table(struct perf_session *session, struct feat_fd *fd) { struct rb_node *nd; int err = machine__write_buildid_table(&session->machines.host, fd); if (err) return err; for (nd = rb_first_cached(&session->machines.guests); nd; nd = rb_next(nd)) { struct machine *pos = rb_entry(nd, struct machine, rb_node); err = machine__write_buildid_table(pos, fd); if (err) break; } return err; } void disable_buildid_cache(void) { no_buildid_cache = true; } static bool lsdir_bid_head_filter(const char *name __maybe_unused, struct dirent *d) { return (strlen(d->d_name) == 2) && isxdigit(d->d_name[0]) && isxdigit(d->d_name[1]); } static bool lsdir_bid_tail_filter(const char *name __maybe_unused, struct dirent *d) { int i = 0; while (isxdigit(d->d_name[i]) && i < SBUILD_ID_SIZE - 3) i++; return (i >= SBUILD_ID_MIN_SIZE - 3) && (i <= SBUILD_ID_SIZE - 3) && (d->d_name[i] == '\0'); } struct strlist *build_id_cache__list_all(bool validonly) { struct strlist *toplist, *linklist = NULL, *bidlist; struct str_node *nd, *nd2; char *topdir, *linkdir = NULL; char sbuild_id[SBUILD_ID_SIZE]; /* for filename__ functions */ if (validonly) symbol__init(NULL); /* Open the top-level directory */ if (asprintf(&topdir, "%s/.build-id/", buildid_dir) < 0) return NULL; bidlist = strlist__new(NULL, NULL); if (!bidlist) goto out; toplist = lsdir(topdir, lsdir_bid_head_filter); if (!toplist) { pr_debug("Error in lsdir(%s): %d\n", topdir, errno); /* If there is no buildid cache, return an empty list */ if (errno == ENOENT) goto out; goto err_out; } strlist__for_each_entry(nd, toplist) { if (asprintf(&linkdir, "%s/%s", topdir, nd->s) < 0) goto err_out; /* Open the lower-level directory */ linklist = lsdir(linkdir, lsdir_bid_tail_filter); if (!linklist) { pr_debug("Error in lsdir(%s): %d\n", linkdir, errno); goto err_out; } strlist__for_each_entry(nd2, linklist) { if (snprintf(sbuild_id, SBUILD_ID_SIZE, "%s%s", nd->s, nd2->s) > SBUILD_ID_SIZE - 1) goto err_out; if (validonly && !build_id_cache__valid_id(sbuild_id)) continue; if (strlist__add(bidlist, sbuild_id) < 0) goto err_out; } strlist__delete(linklist); zfree(&linkdir); } out_free: strlist__delete(toplist); out: free(topdir); return bidlist; err_out: strlist__delete(linklist); zfree(&linkdir); strlist__delete(bidlist); bidlist = NULL; goto out_free; } static bool str_is_build_id(const char *maybe_sbuild_id, size_t len) { size_t i; for (i = 0; i < len; i++) { if (!isxdigit(maybe_sbuild_id[i])) return false; } return true; } /* Return the valid complete build-id */ char *build_id_cache__complement(const char *incomplete_sbuild_id) { struct strlist *bidlist; struct str_node *nd, *cand = NULL; char *sbuild_id = NULL; size_t len = strlen(incomplete_sbuild_id); if (len >= SBUILD_ID_SIZE || !str_is_build_id(incomplete_sbuild_id, len)) return NULL; bidlist = build_id_cache__list_all(true); if (!bidlist) return NULL; strlist__for_each_entry(nd, bidlist) { if (strncmp(nd->s, incomplete_sbuild_id, len) != 0) continue; if (cand) { /* Error: There are more than 2 candidates. */ cand = NULL; break; } cand = nd; } if (cand) sbuild_id = strdup(cand->s); strlist__delete(bidlist); return sbuild_id; } char *build_id_cache__cachedir(const char *sbuild_id, const char *name, struct nsinfo *nsi, bool is_kallsyms, bool is_vdso) { char *realname = NULL, *filename; bool slash = is_kallsyms || is_vdso; if (!slash) realname = nsinfo__realpath(name, nsi); if (asprintf(&filename, "%s%s%s%s%s", buildid_dir, slash ? "/" : "", is_vdso ? DSO__NAME_VDSO : (realname ? realname : name), sbuild_id ? "/" : "", sbuild_id ?: "") < 0) filename = NULL; free(realname); return filename; } int build_id_cache__list_build_ids(const char *pathname, struct nsinfo *nsi, struct strlist **result) { char *dir_name; int ret = 0; dir_name = build_id_cache__cachedir(NULL, pathname, nsi, false, false); if (!dir_name) return -ENOMEM; *result = lsdir(dir_name, lsdir_no_dot_filter); if (!*result) ret = -errno; free(dir_name); return ret; } #if defined(HAVE_LIBELF_SUPPORT) && defined(HAVE_GELF_GETNOTE_SUPPORT) static int build_id_cache__add_sdt_cache(const char *sbuild_id, const char *realname, struct nsinfo *nsi) { struct probe_cache *cache; int ret; struct nscookie nsc; cache = probe_cache__new(sbuild_id, nsi); if (!cache) return -1; nsinfo__mountns_enter(nsi, &nsc); ret = probe_cache__scan_sdt(cache, realname); nsinfo__mountns_exit(&nsc); if (ret >= 0) { pr_debug4("Found %d SDTs in %s\n", ret, realname); if (probe_cache__commit(cache) < 0) ret = -1; } probe_cache__delete(cache); return ret; } #else #define build_id_cache__add_sdt_cache(sbuild_id, realname, nsi) (0) #endif static char *build_id_cache__find_debug(const char *sbuild_id, struct nsinfo *nsi, const char *root_dir) { const char *dirname = "/usr/lib/debug/.build-id/"; char *realname = NULL; char dirbuf[PATH_MAX]; char *debugfile; struct nscookie nsc; size_t len = 0; debugfile = calloc(1, PATH_MAX); if (!debugfile) goto out; if (root_dir) { path__join(dirbuf, PATH_MAX, root_dir, dirname); dirname = dirbuf; } len = __symbol__join_symfs(debugfile, PATH_MAX, dirname); snprintf(debugfile + len, PATH_MAX - len, "%.2s/%s.debug", sbuild_id, sbuild_id + 2); nsinfo__mountns_enter(nsi, &nsc); realname = realpath(debugfile, NULL); if (realname && access(realname, R_OK)) zfree(&realname); nsinfo__mountns_exit(&nsc); #ifdef HAVE_DEBUGINFOD_SUPPORT if (realname == NULL) { debuginfod_client* c; pr_debug("Downloading debug info with build id %s\n", sbuild_id); c = debuginfod_begin(); if (c != NULL) { int fd = debuginfod_find_debuginfo(c, (const unsigned char*)sbuild_id, 0, &realname); if (fd >= 0) close(fd); /* retaining reference by realname */ debuginfod_end(c); } } #endif out: free(debugfile); return realname; } int build_id_cache__add(const char *sbuild_id, const char *name, const char *realname, struct nsinfo *nsi, bool is_kallsyms, bool is_vdso, const char *proper_name, const char *root_dir) { const size_t size = PATH_MAX; char *filename = NULL, *dir_name = NULL, *linkname = zalloc(size), *tmp; char *debugfile = NULL; int err = -1; if (!proper_name) proper_name = name; dir_name = build_id_cache__cachedir(sbuild_id, proper_name, nsi, is_kallsyms, is_vdso); if (!dir_name) goto out_free; /* Remove old style build-id cache */ if (is_regular_file(dir_name)) if (unlink(dir_name)) goto out_free; if (mkdir_p(dir_name, 0755)) goto out_free; /* Save the allocated buildid dirname */ if (asprintf(&filename, "%s/%s", dir_name, build_id_cache__basename(is_kallsyms, is_vdso, false)) < 0) { filename = NULL; goto out_free; } if (access(filename, F_OK)) { if (is_kallsyms) { if (copyfile("/proc/kallsyms", filename)) goto out_free; } else if (nsi && nsinfo__need_setns(nsi)) { if (copyfile_ns(name, filename, nsi)) goto out_free; } else if (link(realname, filename) && errno != EEXIST) { struct stat f_stat; if (!(stat(name, &f_stat) < 0) && copyfile_mode(name, filename, f_stat.st_mode)) goto out_free; } } /* Some binaries are stripped, but have .debug files with their symbol * table. Check to see if we can locate one of those, since the elf * file itself may not be very useful to users of our tools without a * symtab. */ if (!is_kallsyms && !is_vdso && strncmp(".ko", name + strlen(name) - 3, 3)) { debugfile = build_id_cache__find_debug(sbuild_id, nsi, root_dir); if (debugfile) { zfree(&filename); if (asprintf(&filename, "%s/%s", dir_name, build_id_cache__basename(false, false, true)) < 0) { filename = NULL; goto out_free; } if (access(filename, F_OK)) { if (nsi && nsinfo__need_setns(nsi)) { if (copyfile_ns(debugfile, filename, nsi)) goto out_free; } else if (link(debugfile, filename) && errno != EEXIST && copyfile(debugfile, filename)) goto out_free; } } } if (!build_id_cache__linkname(sbuild_id, linkname, size)) goto out_free; tmp = strrchr(linkname, '/'); *tmp = '\0'; if (access(linkname, X_OK) && mkdir_p(linkname, 0755)) goto out_free; *tmp = '/'; tmp = dir_name + strlen(buildid_dir) - 5; memcpy(tmp, "../..", 5); if (symlink(tmp, linkname) == 0) { err = 0; } else if (errno == EEXIST) { char path[PATH_MAX]; ssize_t len; len = readlink(linkname, path, sizeof(path) - 1); if (len <= 0) { pr_err("Can't read link: %s\n", linkname); goto out_free; } path[len] = '\0'; if (strcmp(tmp, path)) { pr_debug("build <%s> already linked to %s\n", sbuild_id, linkname); } err = 0; } /* Update SDT cache : error is just warned */ if (realname && build_id_cache__add_sdt_cache(sbuild_id, realname, nsi) < 0) pr_debug4("Failed to update/scan SDT cache for %s\n", realname); out_free: free(filename); free(debugfile); free(dir_name); free(linkname); return err; } int __build_id_cache__add_s(const char *sbuild_id, const char *name, struct nsinfo *nsi, bool is_kallsyms, bool is_vdso, const char *proper_name, const char *root_dir) { char *realname = NULL; int err = -1; if (!is_kallsyms) { if (!is_vdso) realname = nsinfo__realpath(name, nsi); else realname = realpath(name, NULL); if (!realname) goto out_free; } err = build_id_cache__add(sbuild_id, name, realname, nsi, is_kallsyms, is_vdso, proper_name, root_dir); out_free: if (!is_kallsyms) free(realname); return err; } static int build_id_cache__add_b(const struct build_id *bid, const char *name, struct nsinfo *nsi, bool is_kallsyms, bool is_vdso, const char *proper_name, const char *root_dir) { char sbuild_id[SBUILD_ID_SIZE]; build_id__sprintf(bid, sbuild_id); return __build_id_cache__add_s(sbuild_id, name, nsi, is_kallsyms, is_vdso, proper_name, root_dir); } bool build_id_cache__cached(const char *sbuild_id) { bool ret = false; char *filename = build_id_cache__linkname(sbuild_id, NULL, 0); if (filename && !access(filename, F_OK)) ret = true; free(filename); return ret; } int build_id_cache__remove_s(const char *sbuild_id) { const size_t size = PATH_MAX; char *filename = zalloc(size), *linkname = zalloc(size), *tmp; int err = -1; if (filename == NULL || linkname == NULL) goto out_free; if (!build_id_cache__linkname(sbuild_id, linkname, size)) goto out_free; if (access(linkname, F_OK)) goto out_free; if (readlink(linkname, filename, size - 1) < 0) goto out_free; if (unlink(linkname)) goto out_free; /* * Since the link is relative, we must make it absolute: */ tmp = strrchr(linkname, '/') + 1; snprintf(tmp, size - (tmp - linkname), "%s", filename); if (rm_rf(linkname)) goto out_free; err = 0; out_free: free(filename); free(linkname); return err; } static int filename__read_build_id_ns(const char *filename, struct build_id *bid, struct nsinfo *nsi) { struct nscookie nsc; int ret; nsinfo__mountns_enter(nsi, &nsc); ret = filename__read_build_id(filename, bid); nsinfo__mountns_exit(&nsc); return ret; } static bool dso__build_id_mismatch(struct dso *dso, const char *name) { struct build_id bid; bool ret = false; mutex_lock(dso__lock(dso)); if (filename__read_build_id_ns(name, &bid, dso__nsinfo(dso)) >= 0) ret = !dso__build_id_equal(dso, &bid); mutex_unlock(dso__lock(dso)); return ret; } static int dso__cache_build_id(struct dso *dso, struct machine *machine, void *priv __maybe_unused) { bool is_kallsyms = dso__is_kallsyms(dso); bool is_vdso = dso__is_vdso(dso); const char *name = dso__long_name(dso); const char *proper_name = NULL; const char *root_dir = NULL; char *allocated_name = NULL; int ret = 0; if (!dso__has_build_id(dso)) return 0; if (dso__is_kcore(dso)) { is_kallsyms = true; name = machine->mmap_name; } if (!machine__is_host(machine)) { if (*machine->root_dir) { root_dir = machine->root_dir; ret = asprintf(&allocated_name, "%s/%s", root_dir, name); if (ret < 0) return ret; proper_name = name; name = allocated_name; } else if (is_kallsyms) { /* Cannot get guest kallsyms */ return 0; } } if (!is_kallsyms && dso__build_id_mismatch(dso, name)) goto out_free; mutex_lock(dso__lock(dso)); ret = build_id_cache__add_b(dso__bid(dso), name, dso__nsinfo(dso), is_kallsyms, is_vdso, proper_name, root_dir); mutex_unlock(dso__lock(dso)); out_free: free(allocated_name); return ret; } static int machines__for_each_dso(struct machines *machines, machine__dso_t fn, void *priv) { int ret = machine__for_each_dso(&machines->host, fn, priv); struct rb_node *nd; for (nd = rb_first_cached(&machines->guests); nd; nd = rb_next(nd)) { struct machine *pos = rb_entry(nd, struct machine, rb_node); ret |= machine__for_each_dso(pos, fn, priv); } return ret ? -1 : 0; } int __perf_session__cache_build_ids(struct perf_session *session, machine__dso_t fn, void *priv) { if (no_buildid_cache) return 0; if (mkdir(buildid_dir, 0755) != 0 && errno != EEXIST) return -1; return machines__for_each_dso(&session->machines, fn, priv) ? -1 : 0; } int perf_session__cache_build_ids(struct perf_session *session) { return __perf_session__cache_build_ids(session, dso__cache_build_id, NULL); } static bool machine__read_build_ids(struct machine *machine, bool with_hits) { return dsos__read_build_ids(&machine->dsos, with_hits); } bool perf_session__read_build_ids(struct perf_session *session, bool with_hits) { struct rb_node *nd; bool ret = machine__read_build_ids(&session->machines.host, with_hits); for (nd = rb_first_cached(&session->machines.guests); nd; nd = rb_next(nd)) { struct machine *pos = rb_entry(nd, struct machine, rb_node); ret |= machine__read_build_ids(pos, with_hits); } return ret; } void build_id__init(struct build_id *bid, const u8 *data, size_t size) { WARN_ON(size > BUILD_ID_SIZE); memcpy(bid->data, data, size); bid->size = size; } bool build_id__is_defined(const struct build_id *bid) { return bid && bid->size ? !!memchr_inv(bid->data, 0, bid->size) : false; }