1 // SPDX-License-Identifier: GPL-2.0
3 #include <linux/kernel.h>
4 #include <linux/string.h>
5 #include <linux/zalloc.h>
7 #include <sys/resource.h>
14 #ifdef HAVE_LIBBPF_SUPPORT
15 #include <bpf/libbpf.h>
16 #include "bpf-event.h"
17 #include "bpf-utils.h"
21 #include "namespaces.h"
30 #include "util.h" /* O_CLOEXEC for older systems */
35 static const char * const debuglink_paths[] = {
42 char dso__symtab_origin(const struct dso *dso)
44 static const char origin[] = {
45 [DSO_BINARY_TYPE__KALLSYMS] = 'k',
46 [DSO_BINARY_TYPE__VMLINUX] = 'v',
47 [DSO_BINARY_TYPE__JAVA_JIT] = 'j',
48 [DSO_BINARY_TYPE__DEBUGLINK] = 'l',
49 [DSO_BINARY_TYPE__BUILD_ID_CACHE] = 'B',
50 [DSO_BINARY_TYPE__BUILD_ID_CACHE_DEBUGINFO] = 'D',
51 [DSO_BINARY_TYPE__FEDORA_DEBUGINFO] = 'f',
52 [DSO_BINARY_TYPE__UBUNTU_DEBUGINFO] = 'u',
53 [DSO_BINARY_TYPE__MIXEDUP_UBUNTU_DEBUGINFO] = 'x',
54 [DSO_BINARY_TYPE__OPENEMBEDDED_DEBUGINFO] = 'o',
55 [DSO_BINARY_TYPE__BUILDID_DEBUGINFO] = 'b',
56 [DSO_BINARY_TYPE__SYSTEM_PATH_DSO] = 'd',
57 [DSO_BINARY_TYPE__SYSTEM_PATH_KMODULE] = 'K',
58 [DSO_BINARY_TYPE__SYSTEM_PATH_KMODULE_COMP] = 'm',
59 [DSO_BINARY_TYPE__GUEST_KALLSYMS] = 'g',
60 [DSO_BINARY_TYPE__GUEST_KMODULE] = 'G',
61 [DSO_BINARY_TYPE__GUEST_KMODULE_COMP] = 'M',
62 [DSO_BINARY_TYPE__GUEST_VMLINUX] = 'V',
65 if (dso == NULL || dso->symtab_type == DSO_BINARY_TYPE__NOT_FOUND)
67 return origin[dso->symtab_type];
70 int dso__read_binary_type_filename(const struct dso *dso,
71 enum dso_binary_type type,
72 char *root_dir, char *filename, size_t size)
74 char build_id_hex[SBUILD_ID_SIZE];
79 case DSO_BINARY_TYPE__DEBUGLINK:
81 const char *last_slash;
82 char dso_dir[PATH_MAX];
83 char symfile[PATH_MAX];
86 len = __symbol__join_symfs(filename, size, dso->long_name);
87 last_slash = filename + len;
88 while (last_slash != filename && *last_slash != '/')
91 strncpy(dso_dir, filename, last_slash - filename);
92 dso_dir[last_slash-filename] = '\0';
94 if (!is_regular_file(filename)) {
99 ret = filename__read_debuglink(filename, symfile, PATH_MAX);
103 /* Check predefined locations where debug file might reside */
105 for (i = 0; i < ARRAY_SIZE(debuglink_paths); i++) {
106 snprintf(filename, size,
107 debuglink_paths[i], dso_dir, symfile);
108 if (is_regular_file(filename)) {
116 case DSO_BINARY_TYPE__BUILD_ID_CACHE:
117 if (dso__build_id_filename(dso, filename, size, false) == NULL)
121 case DSO_BINARY_TYPE__BUILD_ID_CACHE_DEBUGINFO:
122 if (dso__build_id_filename(dso, filename, size, true) == NULL)
126 case DSO_BINARY_TYPE__FEDORA_DEBUGINFO:
127 len = __symbol__join_symfs(filename, size, "/usr/lib/debug");
128 snprintf(filename + len, size - len, "%s.debug", dso->long_name);
131 case DSO_BINARY_TYPE__UBUNTU_DEBUGINFO:
132 len = __symbol__join_symfs(filename, size, "/usr/lib/debug");
133 snprintf(filename + len, size - len, "%s", dso->long_name);
136 case DSO_BINARY_TYPE__MIXEDUP_UBUNTU_DEBUGINFO:
138 * Ubuntu can mixup /usr/lib with /lib, putting debuginfo in
139 * /usr/lib/debug/lib when it is expected to be in
140 * /usr/lib/debug/usr/lib
142 if (strlen(dso->long_name) < 9 ||
143 strncmp(dso->long_name, "/usr/lib/", 9)) {
147 len = __symbol__join_symfs(filename, size, "/usr/lib/debug");
148 snprintf(filename + len, size - len, "%s", dso->long_name + 4);
151 case DSO_BINARY_TYPE__OPENEMBEDDED_DEBUGINFO:
153 const char *last_slash;
156 last_slash = dso->long_name + dso->long_name_len;
157 while (last_slash != dso->long_name && *last_slash != '/')
160 len = __symbol__join_symfs(filename, size, "");
161 dir_size = last_slash - dso->long_name + 2;
162 if (dir_size > (size - len)) {
166 len += scnprintf(filename + len, dir_size, "%s", dso->long_name);
167 len += scnprintf(filename + len , size - len, ".debug%s",
172 case DSO_BINARY_TYPE__BUILDID_DEBUGINFO:
173 if (!dso->has_build_id) {
178 build_id__sprintf(&dso->bid, build_id_hex);
179 len = __symbol__join_symfs(filename, size, "/usr/lib/debug/.build-id/");
180 snprintf(filename + len, size - len, "%.2s/%s.debug",
181 build_id_hex, build_id_hex + 2);
184 case DSO_BINARY_TYPE__VMLINUX:
185 case DSO_BINARY_TYPE__GUEST_VMLINUX:
186 case DSO_BINARY_TYPE__SYSTEM_PATH_DSO:
187 __symbol__join_symfs(filename, size, dso->long_name);
190 case DSO_BINARY_TYPE__GUEST_KMODULE:
191 case DSO_BINARY_TYPE__GUEST_KMODULE_COMP:
192 path__join3(filename, size, symbol_conf.symfs,
193 root_dir, dso->long_name);
196 case DSO_BINARY_TYPE__SYSTEM_PATH_KMODULE:
197 case DSO_BINARY_TYPE__SYSTEM_PATH_KMODULE_COMP:
198 __symbol__join_symfs(filename, size, dso->long_name);
201 case DSO_BINARY_TYPE__KCORE:
202 case DSO_BINARY_TYPE__GUEST_KCORE:
203 snprintf(filename, size, "%s", dso->long_name);
207 case DSO_BINARY_TYPE__KALLSYMS:
208 case DSO_BINARY_TYPE__GUEST_KALLSYMS:
209 case DSO_BINARY_TYPE__JAVA_JIT:
210 case DSO_BINARY_TYPE__BPF_PROG_INFO:
211 case DSO_BINARY_TYPE__BPF_IMAGE:
212 case DSO_BINARY_TYPE__OOL:
213 case DSO_BINARY_TYPE__NOT_FOUND:
225 static const struct {
227 int (*decompress)(const char *input, int output);
228 bool (*is_compressed)(const char *input);
230 [COMP_ID__NONE] = { .fmt = NULL, },
231 #ifdef HAVE_ZLIB_SUPPORT
232 { "gz", gzip_decompress_to_file, gzip_is_compressed },
234 #ifdef HAVE_LZMA_SUPPORT
235 { "xz", lzma_decompress_to_file, lzma_is_compressed },
237 { NULL, NULL, NULL },
240 static int is_supported_compression(const char *ext)
244 for (i = 1; compressions[i].fmt; i++) {
245 if (!strcmp(ext, compressions[i].fmt))
248 return COMP_ID__NONE;
251 bool is_kernel_module(const char *pathname, int cpumode)
254 int mode = cpumode & PERF_RECORD_MISC_CPUMODE_MASK;
256 WARN_ONCE(mode != cpumode,
257 "Internal error: passing unmasked cpumode (%x) to is_kernel_module",
261 case PERF_RECORD_MISC_USER:
262 case PERF_RECORD_MISC_HYPERVISOR:
263 case PERF_RECORD_MISC_GUEST_USER:
265 /* Treat PERF_RECORD_MISC_CPUMODE_UNKNOWN as kernel */
267 if (kmod_path__parse(&m, pathname)) {
268 pr_err("Failed to check whether %s is a kernel module or not. Assume it is.",
277 bool dso__needs_decompress(struct dso *dso)
279 return dso->symtab_type == DSO_BINARY_TYPE__SYSTEM_PATH_KMODULE_COMP ||
280 dso->symtab_type == DSO_BINARY_TYPE__GUEST_KMODULE_COMP;
283 int filename__decompress(const char *name, char *pathname,
284 size_t len, int comp, int *err)
286 char tmpbuf[] = KMOD_DECOMP_NAME;
290 * We have proper compression id for DSO and yet the file
291 * behind the 'name' can still be plain uncompressed object.
293 * The reason is behind the logic we open the DSO object files,
294 * when we try all possible 'debug' objects until we find the
295 * data. So even if the DSO is represented by 'krava.xz' module,
296 * we can end up here opening ~/.debug/....23432432/debug' file
297 * which is not compressed.
299 * To keep this transparent, we detect this and return the file
300 * descriptor to the uncompressed file.
302 if (!compressions[comp].is_compressed(name))
303 return open(name, O_RDONLY);
305 fd = mkstemp(tmpbuf);
311 if (compressions[comp].decompress(name, fd)) {
312 *err = DSO_LOAD_ERRNO__DECOMPRESSION_FAILURE;
317 if (!pathname || (fd < 0))
320 if (pathname && (fd >= 0))
321 strlcpy(pathname, tmpbuf, len);
326 static int decompress_kmodule(struct dso *dso, const char *name,
327 char *pathname, size_t len)
329 if (!dso__needs_decompress(dso))
332 if (dso->comp == COMP_ID__NONE)
335 return filename__decompress(name, pathname, len, dso->comp,
339 int dso__decompress_kmodule_fd(struct dso *dso, const char *name)
341 return decompress_kmodule(dso, name, NULL, 0);
344 int dso__decompress_kmodule_path(struct dso *dso, const char *name,
345 char *pathname, size_t len)
347 int fd = decompress_kmodule(dso, name, pathname, len);
350 return fd >= 0 ? 0 : -1;
354 * Parses kernel module specified in @path and updates
357 * @comp - true if @path contains supported compression suffix,
359 * @kmod - true if @path contains '.ko' suffix in right position,
361 * @name - if (@alloc_name && @kmod) is true, it contains strdup-ed base name
362 * of the kernel module without suffixes, otherwise strudup-ed
364 * @ext - if (@alloc_ext && @comp) is true, it contains strdup-ed string
365 * the compression suffix
367 * Returns 0 if there's no strdup error, -ENOMEM otherwise.
369 int __kmod_path__parse(struct kmod_path *m, const char *path,
372 const char *name = strrchr(path, '/');
373 const char *ext = strrchr(path, '.');
374 bool is_simple_name = false;
376 memset(m, 0x0, sizeof(*m));
377 name = name ? name + 1 : path;
380 * '.' is also a valid character for module name. For example:
381 * [aaa.bbb] is a valid module name. '[' should have higher
382 * priority than '.ko' suffix.
384 * The kernel names are from machine__mmap_name. Such
385 * name should belong to kernel itself, not kernel module.
387 if (name[0] == '[') {
388 is_simple_name = true;
389 if ((strncmp(name, "[kernel.kallsyms]", 17) == 0) ||
390 (strncmp(name, "[guest.kernel.kallsyms", 22) == 0) ||
391 (strncmp(name, "[vdso]", 6) == 0) ||
392 (strncmp(name, "[vdso32]", 8) == 0) ||
393 (strncmp(name, "[vdsox32]", 9) == 0) ||
394 (strncmp(name, "[vsyscall]", 10) == 0)) {
401 /* No extension, just return name. */
402 if ((ext == NULL) || is_simple_name) {
404 m->name = strdup(name);
405 return m->name ? 0 : -ENOMEM;
410 m->comp = is_supported_compression(ext + 1);
411 if (m->comp > COMP_ID__NONE)
414 /* Check .ko extension only if there's enough name left. */
416 m->kmod = !strncmp(ext, ".ko", 3);
420 if (asprintf(&m->name, "[%.*s]", (int) (ext - name), name) == -1)
423 if (asprintf(&m->name, "%s", name) == -1)
427 strreplace(m->name, '-', '_');
433 void dso__set_module_info(struct dso *dso, struct kmod_path *m,
434 struct machine *machine)
436 if (machine__is_host(machine))
437 dso->symtab_type = DSO_BINARY_TYPE__SYSTEM_PATH_KMODULE;
439 dso->symtab_type = DSO_BINARY_TYPE__GUEST_KMODULE;
441 /* _KMODULE_COMP should be next to _KMODULE */
442 if (m->kmod && m->comp) {
447 dso__set_short_name(dso, strdup(m->name), true);
451 * Global list of open DSOs and the counter.
453 static LIST_HEAD(dso__data_open);
454 static long dso__data_open_cnt;
455 static pthread_mutex_t dso__data_open_lock = PTHREAD_MUTEX_INITIALIZER;
457 static void dso__list_add(struct dso *dso)
459 list_add_tail(&dso->data.open_entry, &dso__data_open);
460 dso__data_open_cnt++;
463 static void dso__list_del(struct dso *dso)
465 list_del_init(&dso->data.open_entry);
466 WARN_ONCE(dso__data_open_cnt <= 0,
467 "DSO data fd counter out of bounds.");
468 dso__data_open_cnt--;
471 static void close_first_dso(void);
473 static int do_open(char *name)
476 char sbuf[STRERR_BUFSIZE];
479 fd = open(name, O_RDONLY|O_CLOEXEC);
483 pr_debug("dso open failed: %s\n",
484 str_error_r(errno, sbuf, sizeof(sbuf)));
485 if (!dso__data_open_cnt || errno != EMFILE)
494 static int __open_dso(struct dso *dso, struct machine *machine)
497 char *root_dir = (char *)"";
498 char *name = malloc(PATH_MAX);
505 root_dir = machine->root_dir;
507 if (dso__read_binary_type_filename(dso, dso->binary_type,
508 root_dir, name, PATH_MAX))
511 if (!is_regular_file(name))
514 if (dso__needs_decompress(dso)) {
515 char newpath[KMOD_DECOMP_LEN];
516 size_t len = sizeof(newpath);
518 if (dso__decompress_kmodule_path(dso, name, newpath, len) < 0) {
519 fd = -dso->load_errno;
524 strcpy(name, newpath);
537 static void check_data_close(void);
540 * dso_close - Open DSO data file
543 * Open @dso's data file descriptor and updates
544 * list/count of open DSO objects.
546 static int open_dso(struct dso *dso, struct machine *machine)
551 if (dso->binary_type != DSO_BINARY_TYPE__BUILD_ID_CACHE)
552 nsinfo__mountns_enter(dso->nsinfo, &nsc);
553 fd = __open_dso(dso, machine);
554 if (dso->binary_type != DSO_BINARY_TYPE__BUILD_ID_CACHE)
555 nsinfo__mountns_exit(&nsc);
560 * Check if we crossed the allowed number
561 * of opened DSOs and close one if needed.
569 static void close_data_fd(struct dso *dso)
571 if (dso->data.fd >= 0) {
574 dso->data.file_size = 0;
580 * dso_close - Close DSO data file
583 * Close @dso's data file descriptor and updates
584 * list/count of open DSO objects.
586 static void close_dso(struct dso *dso)
591 static void close_first_dso(void)
595 dso = list_first_entry(&dso__data_open, struct dso, data.open_entry);
599 static rlim_t get_fd_limit(void)
604 /* Allow half of the current open fd limit. */
605 if (getrlimit(RLIMIT_NOFILE, &l) == 0) {
606 if (l.rlim_cur == RLIM_INFINITY)
609 limit = l.rlim_cur / 2;
611 pr_err("failed to get fd limit\n");
618 static rlim_t fd_limit;
621 * Used only by tests/dso-data.c to reset the environment
622 * for tests. I dont expect we should change this during
625 void reset_fd_limit(void)
630 static bool may_cache_fd(void)
633 fd_limit = get_fd_limit();
635 if (fd_limit == RLIM_INFINITY)
638 return fd_limit > (rlim_t) dso__data_open_cnt;
642 * Check and close LRU dso if we crossed allowed limit
643 * for opened dso file descriptors. The limit is half
644 * of the RLIMIT_NOFILE files opened.
646 static void check_data_close(void)
648 bool cache_fd = may_cache_fd();
655 * dso__data_close - Close DSO data file
658 * External interface to close @dso's data file descriptor.
660 void dso__data_close(struct dso *dso)
662 pthread_mutex_lock(&dso__data_open_lock);
664 pthread_mutex_unlock(&dso__data_open_lock);
667 static void try_to_open_dso(struct dso *dso, struct machine *machine)
669 enum dso_binary_type binary_type_data[] = {
670 DSO_BINARY_TYPE__BUILD_ID_CACHE,
671 DSO_BINARY_TYPE__SYSTEM_PATH_DSO,
672 DSO_BINARY_TYPE__NOT_FOUND,
676 if (dso->data.fd >= 0)
679 if (dso->binary_type != DSO_BINARY_TYPE__NOT_FOUND) {
680 dso->data.fd = open_dso(dso, machine);
685 dso->binary_type = binary_type_data[i++];
687 dso->data.fd = open_dso(dso, machine);
688 if (dso->data.fd >= 0)
691 } while (dso->binary_type != DSO_BINARY_TYPE__NOT_FOUND);
693 if (dso->data.fd >= 0)
694 dso->data.status = DSO_DATA_STATUS_OK;
696 dso->data.status = DSO_DATA_STATUS_ERROR;
700 * dso__data_get_fd - Get dso's data file descriptor
702 * @machine: machine object
704 * External interface to find dso's file, open it and
705 * returns file descriptor. It should be paired with
706 * dso__data_put_fd() if it returns non-negative value.
708 int dso__data_get_fd(struct dso *dso, struct machine *machine)
710 if (dso->data.status == DSO_DATA_STATUS_ERROR)
713 if (pthread_mutex_lock(&dso__data_open_lock) < 0)
716 try_to_open_dso(dso, machine);
718 if (dso->data.fd < 0)
719 pthread_mutex_unlock(&dso__data_open_lock);
724 void dso__data_put_fd(struct dso *dso __maybe_unused)
726 pthread_mutex_unlock(&dso__data_open_lock);
729 bool dso__data_status_seen(struct dso *dso, enum dso_data_status_seen by)
733 if (dso->data.status_seen & flag)
736 dso->data.status_seen |= flag;
741 #ifdef HAVE_LIBBPF_SUPPORT
742 static ssize_t bpf_read(struct dso *dso, u64 offset, char *data)
744 struct bpf_prog_info_node *node;
745 ssize_t size = DSO__DATA_CACHE_SIZE;
749 node = perf_env__find_bpf_prog_info(dso->bpf_prog.env, dso->bpf_prog.id);
750 if (!node || !node->info_linear) {
751 dso->data.status = DSO_DATA_STATUS_ERROR;
755 len = node->info_linear->info.jited_prog_len;
756 buf = (u8 *)(uintptr_t)node->info_linear->info.jited_prog_insns;
761 size = (ssize_t)min(len - offset, (u64)size);
762 memcpy(data, buf + offset, size);
766 static int bpf_size(struct dso *dso)
768 struct bpf_prog_info_node *node;
770 node = perf_env__find_bpf_prog_info(dso->bpf_prog.env, dso->bpf_prog.id);
771 if (!node || !node->info_linear) {
772 dso->data.status = DSO_DATA_STATUS_ERROR;
776 dso->data.file_size = node->info_linear->info.jited_prog_len;
779 #endif // HAVE_LIBBPF_SUPPORT
782 dso_cache__free(struct dso *dso)
784 struct rb_root *root = &dso->data.cache;
785 struct rb_node *next = rb_first(root);
787 pthread_mutex_lock(&dso->lock);
789 struct dso_cache *cache;
791 cache = rb_entry(next, struct dso_cache, rb_node);
792 next = rb_next(&cache->rb_node);
793 rb_erase(&cache->rb_node, root);
796 pthread_mutex_unlock(&dso->lock);
799 static struct dso_cache *__dso_cache__find(struct dso *dso, u64 offset)
801 const struct rb_root *root = &dso->data.cache;
802 struct rb_node * const *p = &root->rb_node;
803 const struct rb_node *parent = NULL;
804 struct dso_cache *cache;
810 cache = rb_entry(parent, struct dso_cache, rb_node);
811 end = cache->offset + DSO__DATA_CACHE_SIZE;
813 if (offset < cache->offset)
815 else if (offset >= end)
824 static struct dso_cache *
825 dso_cache__insert(struct dso *dso, struct dso_cache *new)
827 struct rb_root *root = &dso->data.cache;
828 struct rb_node **p = &root->rb_node;
829 struct rb_node *parent = NULL;
830 struct dso_cache *cache;
831 u64 offset = new->offset;
833 pthread_mutex_lock(&dso->lock);
838 cache = rb_entry(parent, struct dso_cache, rb_node);
839 end = cache->offset + DSO__DATA_CACHE_SIZE;
841 if (offset < cache->offset)
843 else if (offset >= end)
849 rb_link_node(&new->rb_node, parent, p);
850 rb_insert_color(&new->rb_node, root);
854 pthread_mutex_unlock(&dso->lock);
858 static ssize_t dso_cache__memcpy(struct dso_cache *cache, u64 offset, u8 *data,
861 u64 cache_offset = offset - cache->offset;
862 u64 cache_size = min(cache->size - cache_offset, size);
865 memcpy(data, cache->data + cache_offset, cache_size);
867 memcpy(cache->data + cache_offset, data, cache_size);
871 static ssize_t file_read(struct dso *dso, struct machine *machine,
872 u64 offset, char *data)
876 pthread_mutex_lock(&dso__data_open_lock);
879 * dso->data.fd might be closed if other thread opened another
880 * file (dso) due to open file limit (RLIMIT_NOFILE).
882 try_to_open_dso(dso, machine);
884 if (dso->data.fd < 0) {
885 dso->data.status = DSO_DATA_STATUS_ERROR;
890 ret = pread(dso->data.fd, data, DSO__DATA_CACHE_SIZE, offset);
892 pthread_mutex_unlock(&dso__data_open_lock);
896 static struct dso_cache *dso_cache__populate(struct dso *dso,
897 struct machine *machine,
898 u64 offset, ssize_t *ret)
900 u64 cache_offset = offset & DSO__DATA_CACHE_MASK;
901 struct dso_cache *cache;
902 struct dso_cache *old;
904 cache = zalloc(sizeof(*cache) + DSO__DATA_CACHE_SIZE);
909 #ifdef HAVE_LIBBPF_SUPPORT
910 if (dso->binary_type == DSO_BINARY_TYPE__BPF_PROG_INFO)
911 *ret = bpf_read(dso, cache_offset, cache->data);
914 if (dso->binary_type == DSO_BINARY_TYPE__OOL)
915 *ret = DSO__DATA_CACHE_SIZE;
917 *ret = file_read(dso, machine, cache_offset, cache->data);
924 cache->offset = cache_offset;
927 old = dso_cache__insert(dso, cache);
929 /* we lose the race */
937 static struct dso_cache *dso_cache__find(struct dso *dso,
938 struct machine *machine,
942 struct dso_cache *cache = __dso_cache__find(dso, offset);
944 return cache ? cache : dso_cache__populate(dso, machine, offset, ret);
947 static ssize_t dso_cache_io(struct dso *dso, struct machine *machine,
948 u64 offset, u8 *data, ssize_t size, bool out)
950 struct dso_cache *cache;
953 cache = dso_cache__find(dso, machine, offset, &ret);
957 return dso_cache__memcpy(cache, offset, data, size, out);
961 * Reads and caches dso data DSO__DATA_CACHE_SIZE size chunks
962 * in the rb_tree. Any read to already cached data is served
963 * by cached data. Writes update the cache only, not the backing file.
965 static ssize_t cached_io(struct dso *dso, struct machine *machine,
966 u64 offset, u8 *data, ssize_t size, bool out)
974 ret = dso_cache_io(dso, machine, offset, p, size, out);
978 /* Reached EOF, return what we have. */
994 static int file_size(struct dso *dso, struct machine *machine)
998 char sbuf[STRERR_BUFSIZE];
1000 pthread_mutex_lock(&dso__data_open_lock);
1003 * dso->data.fd might be closed if other thread opened another
1004 * file (dso) due to open file limit (RLIMIT_NOFILE).
1006 try_to_open_dso(dso, machine);
1008 if (dso->data.fd < 0) {
1010 dso->data.status = DSO_DATA_STATUS_ERROR;
1014 if (fstat(dso->data.fd, &st) < 0) {
1016 pr_err("dso cache fstat failed: %s\n",
1017 str_error_r(errno, sbuf, sizeof(sbuf)));
1018 dso->data.status = DSO_DATA_STATUS_ERROR;
1021 dso->data.file_size = st.st_size;
1024 pthread_mutex_unlock(&dso__data_open_lock);
1028 int dso__data_file_size(struct dso *dso, struct machine *machine)
1030 if (dso->data.file_size)
1033 if (dso->data.status == DSO_DATA_STATUS_ERROR)
1035 #ifdef HAVE_LIBBPF_SUPPORT
1036 if (dso->binary_type == DSO_BINARY_TYPE__BPF_PROG_INFO)
1037 return bpf_size(dso);
1039 return file_size(dso, machine);
1043 * dso__data_size - Return dso data size
1045 * @machine: machine object
1047 * Return: dso data size
1049 off_t dso__data_size(struct dso *dso, struct machine *machine)
1051 if (dso__data_file_size(dso, machine))
1054 /* For now just estimate dso data size is close to file size */
1055 return dso->data.file_size;
1058 static ssize_t data_read_write_offset(struct dso *dso, struct machine *machine,
1059 u64 offset, u8 *data, ssize_t size,
1062 if (dso__data_file_size(dso, machine))
1065 /* Check the offset sanity. */
1066 if (offset > dso->data.file_size)
1069 if (offset + size < offset)
1072 return cached_io(dso, machine, offset, data, size, out);
1076 * dso__data_read_offset - Read data from dso file offset
1078 * @machine: machine object
1079 * @offset: file offset
1080 * @data: buffer to store data
1081 * @size: size of the @data buffer
1083 * External interface to read data from dso file offset. Open
1084 * dso data file and use cached_read to get the data.
1086 ssize_t dso__data_read_offset(struct dso *dso, struct machine *machine,
1087 u64 offset, u8 *data, ssize_t size)
1089 if (dso->data.status == DSO_DATA_STATUS_ERROR)
1092 return data_read_write_offset(dso, machine, offset, data, size, true);
1096 * dso__data_read_addr - Read data from dso address
1098 * @machine: machine object
1099 * @add: virtual memory address
1100 * @data: buffer to store data
1101 * @size: size of the @data buffer
1103 * External interface to read data from dso address.
1105 ssize_t dso__data_read_addr(struct dso *dso, struct map *map,
1106 struct machine *machine, u64 addr,
1107 u8 *data, ssize_t size)
1109 u64 offset = map->map_ip(map, addr);
1110 return dso__data_read_offset(dso, machine, offset, data, size);
1114 * dso__data_write_cache_offs - Write data to dso data cache at file offset
1116 * @machine: machine object
1117 * @offset: file offset
1118 * @data: buffer to write
1119 * @size: size of the @data buffer
1121 * Write into the dso file data cache, but do not change the file itself.
1123 ssize_t dso__data_write_cache_offs(struct dso *dso, struct machine *machine,
1124 u64 offset, const u8 *data_in, ssize_t size)
1126 u8 *data = (u8 *)data_in; /* cast away const to use same fns for r/w */
1128 if (dso->data.status == DSO_DATA_STATUS_ERROR)
1131 return data_read_write_offset(dso, machine, offset, data, size, false);
1135 * dso__data_write_cache_addr - Write data to dso data cache at dso address
1137 * @machine: machine object
1138 * @add: virtual memory address
1139 * @data: buffer to write
1140 * @size: size of the @data buffer
1142 * External interface to write into the dso file data cache, but do not change
1145 ssize_t dso__data_write_cache_addr(struct dso *dso, struct map *map,
1146 struct machine *machine, u64 addr,
1147 const u8 *data, ssize_t size)
1149 u64 offset = map->map_ip(map, addr);
1150 return dso__data_write_cache_offs(dso, machine, offset, data, size);
1153 struct map *dso__new_map(const char *name)
1155 struct map *map = NULL;
1156 struct dso *dso = dso__new(name);
1159 map = map__new2(0, dso);
1166 struct dso *machine__findnew_kernel(struct machine *machine, const char *name,
1167 const char *short_name, int dso_type)
1170 * The kernel dso could be created by build_id processing.
1172 struct dso *dso = machine__findnew_dso(machine, name);
1175 * We need to run this in all cases, since during the build_id
1176 * processing we had no idea this was the kernel dso.
1179 dso__set_short_name(dso, short_name, false);
1180 dso->kernel = dso_type;
1186 static void dso__set_long_name_id(struct dso *dso, const char *name, struct dso_id *id, bool name_allocated)
1188 struct rb_root *root = dso->root;
1193 if (dso->long_name_allocated)
1194 free((char *)dso->long_name);
1197 rb_erase(&dso->rb_node, root);
1199 * __dsos__findnew_link_by_longname_id() isn't guaranteed to
1200 * add it back, so a clean removal is required here.
1202 RB_CLEAR_NODE(&dso->rb_node);
1206 dso->long_name = name;
1207 dso->long_name_len = strlen(name);
1208 dso->long_name_allocated = name_allocated;
1211 __dsos__findnew_link_by_longname_id(root, dso, NULL, id);
1214 void dso__set_long_name(struct dso *dso, const char *name, bool name_allocated)
1216 dso__set_long_name_id(dso, name, NULL, name_allocated);
1219 void dso__set_short_name(struct dso *dso, const char *name, bool name_allocated)
1224 if (dso->short_name_allocated)
1225 free((char *)dso->short_name);
1227 dso->short_name = name;
1228 dso->short_name_len = strlen(name);
1229 dso->short_name_allocated = name_allocated;
1232 int dso__name_len(const struct dso *dso)
1235 return strlen("[unknown]");
1237 return dso->long_name_len;
1239 return dso->short_name_len;
1242 bool dso__loaded(const struct dso *dso)
1247 bool dso__sorted_by_name(const struct dso *dso)
1249 return dso->sorted_by_name;
1252 void dso__set_sorted_by_name(struct dso *dso)
1254 dso->sorted_by_name = true;
1257 struct dso *dso__new_id(const char *name, struct dso_id *id)
1259 struct dso *dso = calloc(1, sizeof(*dso) + strlen(name) + 1);
1262 strcpy(dso->name, name);
1265 dso__set_long_name_id(dso, dso->name, id, false);
1266 dso__set_short_name(dso, dso->name, false);
1267 dso->symbols = dso->symbol_names = RB_ROOT_CACHED;
1268 dso->data.cache = RB_ROOT;
1269 dso->inlined_nodes = RB_ROOT_CACHED;
1270 dso->srclines = RB_ROOT_CACHED;
1272 dso->data.status = DSO_DATA_STATUS_UNKNOWN;
1273 dso->symtab_type = DSO_BINARY_TYPE__NOT_FOUND;
1274 dso->binary_type = DSO_BINARY_TYPE__NOT_FOUND;
1275 dso->is_64_bit = (sizeof(void *) == 8);
1278 dso->sorted_by_name = 0;
1279 dso->has_build_id = 0;
1280 dso->has_srcline = 1;
1282 dso->kernel = DSO_SPACE__USER;
1283 dso->needs_swap = DSO_SWAP__UNSET;
1284 dso->comp = COMP_ID__NONE;
1285 RB_CLEAR_NODE(&dso->rb_node);
1287 INIT_LIST_HEAD(&dso->node);
1288 INIT_LIST_HEAD(&dso->data.open_entry);
1289 pthread_mutex_init(&dso->lock, NULL);
1290 refcount_set(&dso->refcnt, 1);
1296 struct dso *dso__new(const char *name)
1298 return dso__new_id(name, NULL);
1301 void dso__delete(struct dso *dso)
1303 if (!RB_EMPTY_NODE(&dso->rb_node))
1304 pr_err("DSO %s is still in rbtree when being deleted!\n",
1307 /* free inlines first, as they reference symbols */
1308 inlines__tree_delete(&dso->inlined_nodes);
1309 srcline__tree_delete(&dso->srclines);
1310 symbols__delete(&dso->symbols);
1312 if (dso->short_name_allocated) {
1313 zfree((char **)&dso->short_name);
1314 dso->short_name_allocated = false;
1317 if (dso->long_name_allocated) {
1318 zfree((char **)&dso->long_name);
1319 dso->long_name_allocated = false;
1322 dso__data_close(dso);
1323 auxtrace_cache__free(dso->auxtrace_cache);
1324 dso_cache__free(dso);
1326 zfree(&dso->symsrc_filename);
1327 nsinfo__zput(dso->nsinfo);
1328 pthread_mutex_destroy(&dso->lock);
1332 struct dso *dso__get(struct dso *dso)
1335 refcount_inc(&dso->refcnt);
1339 void dso__put(struct dso *dso)
1341 if (dso && refcount_dec_and_test(&dso->refcnt))
1345 void dso__set_build_id(struct dso *dso, struct build_id *bid)
1348 dso->has_build_id = 1;
1351 bool dso__build_id_equal(const struct dso *dso, struct build_id *bid)
1353 if (dso->bid.size > bid->size && dso->bid.size == BUILD_ID_SIZE) {
1355 * For the backward compatibility, it allows a build-id has
1358 return !memcmp(dso->bid.data, bid->data, bid->size) &&
1359 !memchr_inv(&dso->bid.data[bid->size], 0,
1360 dso->bid.size - bid->size);
1363 return dso->bid.size == bid->size &&
1364 memcmp(dso->bid.data, bid->data, dso->bid.size) == 0;
1367 void dso__read_running_kernel_build_id(struct dso *dso, struct machine *machine)
1369 char path[PATH_MAX];
1371 if (machine__is_default_guest(machine))
1373 sprintf(path, "%s/sys/kernel/notes", machine->root_dir);
1374 if (sysfs__read_build_id(path, &dso->bid) == 0)
1375 dso->has_build_id = true;
1378 int dso__kernel_module_get_build_id(struct dso *dso,
1379 const char *root_dir)
1381 char filename[PATH_MAX];
1383 * kernel module short names are of the form "[module]" and
1384 * we need just "module" here.
1386 const char *name = dso->short_name + 1;
1388 snprintf(filename, sizeof(filename),
1389 "%s/sys/module/%.*s/notes/.note.gnu.build-id",
1390 root_dir, (int)strlen(name) - 1, name);
1392 if (sysfs__read_build_id(filename, &dso->bid) == 0)
1393 dso->has_build_id = true;
1398 static size_t dso__fprintf_buildid(struct dso *dso, FILE *fp)
1400 char sbuild_id[SBUILD_ID_SIZE];
1402 build_id__sprintf(&dso->bid, sbuild_id);
1403 return fprintf(fp, "%s", sbuild_id);
1406 size_t dso__fprintf(struct dso *dso, FILE *fp)
1409 size_t ret = fprintf(fp, "dso: %s (", dso->short_name);
1411 if (dso->short_name != dso->long_name)
1412 ret += fprintf(fp, "%s, ", dso->long_name);
1413 ret += fprintf(fp, "%sloaded, ", dso__loaded(dso) ? "" : "NOT ");
1414 ret += dso__fprintf_buildid(dso, fp);
1415 ret += fprintf(fp, ")\n");
1416 for (nd = rb_first_cached(&dso->symbols); nd; nd = rb_next(nd)) {
1417 struct symbol *pos = rb_entry(nd, struct symbol, rb_node);
1418 ret += symbol__fprintf(pos, fp);
1424 enum dso_type dso__type(struct dso *dso, struct machine *machine)
1427 enum dso_type type = DSO__TYPE_UNKNOWN;
1429 fd = dso__data_get_fd(dso, machine);
1431 type = dso__type_fd(fd);
1432 dso__data_put_fd(dso);
1438 int dso__strerror_load(struct dso *dso, char *buf, size_t buflen)
1440 int idx, errnum = dso->load_errno;
1442 * This must have a same ordering as the enum dso_load_errno.
1444 static const char *dso_load__error_str[] = {
1445 "Internal tools/perf/ library error",
1447 "Can not read build id",
1448 "Mismatching build id",
1449 "Decompression failure",
1452 BUG_ON(buflen == 0);
1455 const char *err = str_error_r(errnum, buf, buflen);
1458 scnprintf(buf, buflen, "%s", err);
1463 if (errnum < __DSO_LOAD_ERRNO__START || errnum >= __DSO_LOAD_ERRNO__END)
1466 idx = errnum - __DSO_LOAD_ERRNO__START;
1467 scnprintf(buf, buflen, "%s", dso_load__error_str[idx]);