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 #include <bpf/libbpf.h>
15 #include "bpf-event.h"
18 #include "namespaces.h"
27 #include "util.h" /* O_CLOEXEC for older systems */
32 static const char * const debuglink_paths[] = {
39 char dso__symtab_origin(const struct dso *dso)
41 static const char origin[] = {
42 [DSO_BINARY_TYPE__KALLSYMS] = 'k',
43 [DSO_BINARY_TYPE__VMLINUX] = 'v',
44 [DSO_BINARY_TYPE__JAVA_JIT] = 'j',
45 [DSO_BINARY_TYPE__DEBUGLINK] = 'l',
46 [DSO_BINARY_TYPE__BUILD_ID_CACHE] = 'B',
47 [DSO_BINARY_TYPE__BUILD_ID_CACHE_DEBUGINFO] = 'D',
48 [DSO_BINARY_TYPE__FEDORA_DEBUGINFO] = 'f',
49 [DSO_BINARY_TYPE__UBUNTU_DEBUGINFO] = 'u',
50 [DSO_BINARY_TYPE__MIXEDUP_UBUNTU_DEBUGINFO] = 'x',
51 [DSO_BINARY_TYPE__OPENEMBEDDED_DEBUGINFO] = 'o',
52 [DSO_BINARY_TYPE__BUILDID_DEBUGINFO] = 'b',
53 [DSO_BINARY_TYPE__SYSTEM_PATH_DSO] = 'd',
54 [DSO_BINARY_TYPE__SYSTEM_PATH_KMODULE] = 'K',
55 [DSO_BINARY_TYPE__SYSTEM_PATH_KMODULE_COMP] = 'm',
56 [DSO_BINARY_TYPE__GUEST_KALLSYMS] = 'g',
57 [DSO_BINARY_TYPE__GUEST_KMODULE] = 'G',
58 [DSO_BINARY_TYPE__GUEST_KMODULE_COMP] = 'M',
59 [DSO_BINARY_TYPE__GUEST_VMLINUX] = 'V',
62 if (dso == NULL || dso->symtab_type == DSO_BINARY_TYPE__NOT_FOUND)
64 return origin[dso->symtab_type];
67 int dso__read_binary_type_filename(const struct dso *dso,
68 enum dso_binary_type type,
69 char *root_dir, char *filename, size_t size)
71 char build_id_hex[SBUILD_ID_SIZE];
76 case DSO_BINARY_TYPE__DEBUGLINK:
78 const char *last_slash;
79 char dso_dir[PATH_MAX];
80 char symfile[PATH_MAX];
83 len = __symbol__join_symfs(filename, size, dso->long_name);
84 last_slash = filename + len;
85 while (last_slash != filename && *last_slash != '/')
88 strncpy(dso_dir, filename, last_slash - filename);
89 dso_dir[last_slash-filename] = '\0';
91 if (!is_regular_file(filename)) {
96 ret = filename__read_debuglink(filename, symfile, PATH_MAX);
100 /* Check predefined locations where debug file might reside */
102 for (i = 0; i < ARRAY_SIZE(debuglink_paths); i++) {
103 snprintf(filename, size,
104 debuglink_paths[i], dso_dir, symfile);
105 if (is_regular_file(filename)) {
113 case DSO_BINARY_TYPE__BUILD_ID_CACHE:
114 if (dso__build_id_filename(dso, filename, size, false) == NULL)
118 case DSO_BINARY_TYPE__BUILD_ID_CACHE_DEBUGINFO:
119 if (dso__build_id_filename(dso, filename, size, true) == NULL)
123 case DSO_BINARY_TYPE__FEDORA_DEBUGINFO:
124 len = __symbol__join_symfs(filename, size, "/usr/lib/debug");
125 snprintf(filename + len, size - len, "%s.debug", dso->long_name);
128 case DSO_BINARY_TYPE__UBUNTU_DEBUGINFO:
129 len = __symbol__join_symfs(filename, size, "/usr/lib/debug");
130 snprintf(filename + len, size - len, "%s", dso->long_name);
133 case DSO_BINARY_TYPE__MIXEDUP_UBUNTU_DEBUGINFO:
135 * Ubuntu can mixup /usr/lib with /lib, putting debuginfo in
136 * /usr/lib/debug/lib when it is expected to be in
137 * /usr/lib/debug/usr/lib
139 if (strlen(dso->long_name) < 9 ||
140 strncmp(dso->long_name, "/usr/lib/", 9)) {
144 len = __symbol__join_symfs(filename, size, "/usr/lib/debug");
145 snprintf(filename + len, size - len, "%s", dso->long_name + 4);
148 case DSO_BINARY_TYPE__OPENEMBEDDED_DEBUGINFO:
150 const char *last_slash;
153 last_slash = dso->long_name + dso->long_name_len;
154 while (last_slash != dso->long_name && *last_slash != '/')
157 len = __symbol__join_symfs(filename, size, "");
158 dir_size = last_slash - dso->long_name + 2;
159 if (dir_size > (size - len)) {
163 len += scnprintf(filename + len, dir_size, "%s", dso->long_name);
164 len += scnprintf(filename + len , size - len, ".debug%s",
169 case DSO_BINARY_TYPE__BUILDID_DEBUGINFO:
170 if (!dso->has_build_id) {
175 build_id__sprintf(dso->build_id,
176 sizeof(dso->build_id),
178 len = __symbol__join_symfs(filename, size, "/usr/lib/debug/.build-id/");
179 snprintf(filename + len, size - len, "%.2s/%s.debug",
180 build_id_hex, build_id_hex + 2);
183 case DSO_BINARY_TYPE__VMLINUX:
184 case DSO_BINARY_TYPE__GUEST_VMLINUX:
185 case DSO_BINARY_TYPE__SYSTEM_PATH_DSO:
186 __symbol__join_symfs(filename, size, dso->long_name);
189 case DSO_BINARY_TYPE__GUEST_KMODULE:
190 case DSO_BINARY_TYPE__GUEST_KMODULE_COMP:
191 path__join3(filename, size, symbol_conf.symfs,
192 root_dir, dso->long_name);
195 case DSO_BINARY_TYPE__SYSTEM_PATH_KMODULE:
196 case DSO_BINARY_TYPE__SYSTEM_PATH_KMODULE_COMP:
197 __symbol__join_symfs(filename, size, dso->long_name);
200 case DSO_BINARY_TYPE__KCORE:
201 case DSO_BINARY_TYPE__GUEST_KCORE:
202 snprintf(filename, size, "%s", dso->long_name);
206 case DSO_BINARY_TYPE__KALLSYMS:
207 case DSO_BINARY_TYPE__GUEST_KALLSYMS:
208 case DSO_BINARY_TYPE__JAVA_JIT:
209 case DSO_BINARY_TYPE__BPF_PROG_INFO:
210 case DSO_BINARY_TYPE__BPF_IMAGE:
211 case DSO_BINARY_TYPE__NOT_FOUND:
223 static const struct {
225 int (*decompress)(const char *input, int output);
226 bool (*is_compressed)(const char *input);
228 [COMP_ID__NONE] = { .fmt = NULL, },
229 #ifdef HAVE_ZLIB_SUPPORT
230 { "gz", gzip_decompress_to_file, gzip_is_compressed },
232 #ifdef HAVE_LZMA_SUPPORT
233 { "xz", lzma_decompress_to_file, lzma_is_compressed },
235 { NULL, NULL, NULL },
238 static int is_supported_compression(const char *ext)
242 for (i = 1; compressions[i].fmt; i++) {
243 if (!strcmp(ext, compressions[i].fmt))
246 return COMP_ID__NONE;
249 bool is_kernel_module(const char *pathname, int cpumode)
252 int mode = cpumode & PERF_RECORD_MISC_CPUMODE_MASK;
254 WARN_ONCE(mode != cpumode,
255 "Internal error: passing unmasked cpumode (%x) to is_kernel_module",
259 case PERF_RECORD_MISC_USER:
260 case PERF_RECORD_MISC_HYPERVISOR:
261 case PERF_RECORD_MISC_GUEST_USER:
263 /* Treat PERF_RECORD_MISC_CPUMODE_UNKNOWN as kernel */
265 if (kmod_path__parse(&m, pathname)) {
266 pr_err("Failed to check whether %s is a kernel module or not. Assume it is.",
275 bool dso__needs_decompress(struct dso *dso)
277 return dso->symtab_type == DSO_BINARY_TYPE__SYSTEM_PATH_KMODULE_COMP ||
278 dso->symtab_type == DSO_BINARY_TYPE__GUEST_KMODULE_COMP;
281 static int decompress_kmodule(struct dso *dso, const char *name,
282 char *pathname, size_t len)
284 char tmpbuf[] = KMOD_DECOMP_NAME;
287 if (!dso__needs_decompress(dso))
290 if (dso->comp == COMP_ID__NONE)
294 * We have proper compression id for DSO and yet the file
295 * behind the 'name' can still be plain uncompressed object.
297 * The reason is behind the logic we open the DSO object files,
298 * when we try all possible 'debug' objects until we find the
299 * data. So even if the DSO is represented by 'krava.xz' module,
300 * we can end up here opening ~/.debug/....23432432/debug' file
301 * which is not compressed.
303 * To keep this transparent, we detect this and return the file
304 * descriptor to the uncompressed file.
306 if (!compressions[dso->comp].is_compressed(name))
307 return open(name, O_RDONLY);
309 fd = mkstemp(tmpbuf);
311 dso->load_errno = errno;
315 if (compressions[dso->comp].decompress(name, fd)) {
316 dso->load_errno = DSO_LOAD_ERRNO__DECOMPRESSION_FAILURE;
321 if (!pathname || (fd < 0))
324 if (pathname && (fd >= 0))
325 strlcpy(pathname, tmpbuf, len);
330 int dso__decompress_kmodule_fd(struct dso *dso, const char *name)
332 return decompress_kmodule(dso, name, NULL, 0);
335 int dso__decompress_kmodule_path(struct dso *dso, const char *name,
336 char *pathname, size_t len)
338 int fd = decompress_kmodule(dso, name, pathname, len);
341 return fd >= 0 ? 0 : -1;
345 * Parses kernel module specified in @path and updates
348 * @comp - true if @path contains supported compression suffix,
350 * @kmod - true if @path contains '.ko' suffix in right position,
352 * @name - if (@alloc_name && @kmod) is true, it contains strdup-ed base name
353 * of the kernel module without suffixes, otherwise strudup-ed
355 * @ext - if (@alloc_ext && @comp) is true, it contains strdup-ed string
356 * the compression suffix
358 * Returns 0 if there's no strdup error, -ENOMEM otherwise.
360 int __kmod_path__parse(struct kmod_path *m, const char *path,
363 const char *name = strrchr(path, '/');
364 const char *ext = strrchr(path, '.');
365 bool is_simple_name = false;
367 memset(m, 0x0, sizeof(*m));
368 name = name ? name + 1 : path;
371 * '.' is also a valid character for module name. For example:
372 * [aaa.bbb] is a valid module name. '[' should have higher
373 * priority than '.ko' suffix.
375 * The kernel names are from machine__mmap_name. Such
376 * name should belong to kernel itself, not kernel module.
378 if (name[0] == '[') {
379 is_simple_name = true;
380 if ((strncmp(name, "[kernel.kallsyms]", 17) == 0) ||
381 (strncmp(name, "[guest.kernel.kallsyms", 22) == 0) ||
382 (strncmp(name, "[vdso]", 6) == 0) ||
383 (strncmp(name, "[vdso32]", 8) == 0) ||
384 (strncmp(name, "[vdsox32]", 9) == 0) ||
385 (strncmp(name, "[vsyscall]", 10) == 0)) {
392 /* No extension, just return name. */
393 if ((ext == NULL) || is_simple_name) {
395 m->name = strdup(name);
396 return m->name ? 0 : -ENOMEM;
401 m->comp = is_supported_compression(ext + 1);
402 if (m->comp > COMP_ID__NONE)
405 /* Check .ko extension only if there's enough name left. */
407 m->kmod = !strncmp(ext, ".ko", 3);
411 if (asprintf(&m->name, "[%.*s]", (int) (ext - name), name) == -1)
414 if (asprintf(&m->name, "%s", name) == -1)
418 strreplace(m->name, '-', '_');
424 void dso__set_module_info(struct dso *dso, struct kmod_path *m,
425 struct machine *machine)
427 if (machine__is_host(machine))
428 dso->symtab_type = DSO_BINARY_TYPE__SYSTEM_PATH_KMODULE;
430 dso->symtab_type = DSO_BINARY_TYPE__GUEST_KMODULE;
432 /* _KMODULE_COMP should be next to _KMODULE */
433 if (m->kmod && m->comp) {
438 dso__set_short_name(dso, strdup(m->name), true);
442 * Global list of open DSOs and the counter.
444 static LIST_HEAD(dso__data_open);
445 static long dso__data_open_cnt;
446 static pthread_mutex_t dso__data_open_lock = PTHREAD_MUTEX_INITIALIZER;
448 static void dso__list_add(struct dso *dso)
450 list_add_tail(&dso->data.open_entry, &dso__data_open);
451 dso__data_open_cnt++;
454 static void dso__list_del(struct dso *dso)
456 list_del_init(&dso->data.open_entry);
457 WARN_ONCE(dso__data_open_cnt <= 0,
458 "DSO data fd counter out of bounds.");
459 dso__data_open_cnt--;
462 static void close_first_dso(void);
464 static int do_open(char *name)
467 char sbuf[STRERR_BUFSIZE];
470 fd = open(name, O_RDONLY|O_CLOEXEC);
474 pr_debug("dso open failed: %s\n",
475 str_error_r(errno, sbuf, sizeof(sbuf)));
476 if (!dso__data_open_cnt || errno != EMFILE)
485 static int __open_dso(struct dso *dso, struct machine *machine)
488 char *root_dir = (char *)"";
489 char *name = malloc(PATH_MAX);
496 root_dir = machine->root_dir;
498 if (dso__read_binary_type_filename(dso, dso->binary_type,
499 root_dir, name, PATH_MAX))
502 if (!is_regular_file(name))
505 if (dso__needs_decompress(dso)) {
506 char newpath[KMOD_DECOMP_LEN];
507 size_t len = sizeof(newpath);
509 if (dso__decompress_kmodule_path(dso, name, newpath, len) < 0) {
510 fd = -dso->load_errno;
515 strcpy(name, newpath);
528 static void check_data_close(void);
531 * dso_close - Open DSO data file
534 * Open @dso's data file descriptor and updates
535 * list/count of open DSO objects.
537 static int open_dso(struct dso *dso, struct machine *machine)
542 if (dso->binary_type != DSO_BINARY_TYPE__BUILD_ID_CACHE)
543 nsinfo__mountns_enter(dso->nsinfo, &nsc);
544 fd = __open_dso(dso, machine);
545 if (dso->binary_type != DSO_BINARY_TYPE__BUILD_ID_CACHE)
546 nsinfo__mountns_exit(&nsc);
551 * Check if we crossed the allowed number
552 * of opened DSOs and close one if needed.
560 static void close_data_fd(struct dso *dso)
562 if (dso->data.fd >= 0) {
565 dso->data.file_size = 0;
571 * dso_close - Close DSO data file
574 * Close @dso's data file descriptor and updates
575 * list/count of open DSO objects.
577 static void close_dso(struct dso *dso)
582 static void close_first_dso(void)
586 dso = list_first_entry(&dso__data_open, struct dso, data.open_entry);
590 static rlim_t get_fd_limit(void)
595 /* Allow half of the current open fd limit. */
596 if (getrlimit(RLIMIT_NOFILE, &l) == 0) {
597 if (l.rlim_cur == RLIM_INFINITY)
600 limit = l.rlim_cur / 2;
602 pr_err("failed to get fd limit\n");
609 static rlim_t fd_limit;
612 * Used only by tests/dso-data.c to reset the environment
613 * for tests. I dont expect we should change this during
616 void reset_fd_limit(void)
621 static bool may_cache_fd(void)
624 fd_limit = get_fd_limit();
626 if (fd_limit == RLIM_INFINITY)
629 return fd_limit > (rlim_t) dso__data_open_cnt;
633 * Check and close LRU dso if we crossed allowed limit
634 * for opened dso file descriptors. The limit is half
635 * of the RLIMIT_NOFILE files opened.
637 static void check_data_close(void)
639 bool cache_fd = may_cache_fd();
646 * dso__data_close - Close DSO data file
649 * External interface to close @dso's data file descriptor.
651 void dso__data_close(struct dso *dso)
653 pthread_mutex_lock(&dso__data_open_lock);
655 pthread_mutex_unlock(&dso__data_open_lock);
658 static void try_to_open_dso(struct dso *dso, struct machine *machine)
660 enum dso_binary_type binary_type_data[] = {
661 DSO_BINARY_TYPE__BUILD_ID_CACHE,
662 DSO_BINARY_TYPE__SYSTEM_PATH_DSO,
663 DSO_BINARY_TYPE__NOT_FOUND,
667 if (dso->data.fd >= 0)
670 if (dso->binary_type != DSO_BINARY_TYPE__NOT_FOUND) {
671 dso->data.fd = open_dso(dso, machine);
676 dso->binary_type = binary_type_data[i++];
678 dso->data.fd = open_dso(dso, machine);
679 if (dso->data.fd >= 0)
682 } while (dso->binary_type != DSO_BINARY_TYPE__NOT_FOUND);
684 if (dso->data.fd >= 0)
685 dso->data.status = DSO_DATA_STATUS_OK;
687 dso->data.status = DSO_DATA_STATUS_ERROR;
691 * dso__data_get_fd - Get dso's data file descriptor
693 * @machine: machine object
695 * External interface to find dso's file, open it and
696 * returns file descriptor. It should be paired with
697 * dso__data_put_fd() if it returns non-negative value.
699 int dso__data_get_fd(struct dso *dso, struct machine *machine)
701 if (dso->data.status == DSO_DATA_STATUS_ERROR)
704 if (pthread_mutex_lock(&dso__data_open_lock) < 0)
707 try_to_open_dso(dso, machine);
709 if (dso->data.fd < 0)
710 pthread_mutex_unlock(&dso__data_open_lock);
715 void dso__data_put_fd(struct dso *dso __maybe_unused)
717 pthread_mutex_unlock(&dso__data_open_lock);
720 bool dso__data_status_seen(struct dso *dso, enum dso_data_status_seen by)
724 if (dso->data.status_seen & flag)
727 dso->data.status_seen |= flag;
732 static ssize_t bpf_read(struct dso *dso, u64 offset, char *data)
734 struct bpf_prog_info_node *node;
735 ssize_t size = DSO__DATA_CACHE_SIZE;
739 node = perf_env__find_bpf_prog_info(dso->bpf_prog.env, dso->bpf_prog.id);
740 if (!node || !node->info_linear) {
741 dso->data.status = DSO_DATA_STATUS_ERROR;
745 len = node->info_linear->info.jited_prog_len;
746 buf = (u8 *)(uintptr_t)node->info_linear->info.jited_prog_insns;
751 size = (ssize_t)min(len - offset, (u64)size);
752 memcpy(data, buf + offset, size);
756 static int bpf_size(struct dso *dso)
758 struct bpf_prog_info_node *node;
760 node = perf_env__find_bpf_prog_info(dso->bpf_prog.env, dso->bpf_prog.id);
761 if (!node || !node->info_linear) {
762 dso->data.status = DSO_DATA_STATUS_ERROR;
766 dso->data.file_size = node->info_linear->info.jited_prog_len;
771 dso_cache__free(struct dso *dso)
773 struct rb_root *root = &dso->data.cache;
774 struct rb_node *next = rb_first(root);
776 pthread_mutex_lock(&dso->lock);
778 struct dso_cache *cache;
780 cache = rb_entry(next, struct dso_cache, rb_node);
781 next = rb_next(&cache->rb_node);
782 rb_erase(&cache->rb_node, root);
785 pthread_mutex_unlock(&dso->lock);
788 static struct dso_cache *__dso_cache__find(struct dso *dso, u64 offset)
790 const struct rb_root *root = &dso->data.cache;
791 struct rb_node * const *p = &root->rb_node;
792 const struct rb_node *parent = NULL;
793 struct dso_cache *cache;
799 cache = rb_entry(parent, struct dso_cache, rb_node);
800 end = cache->offset + DSO__DATA_CACHE_SIZE;
802 if (offset < cache->offset)
804 else if (offset >= end)
813 static struct dso_cache *
814 dso_cache__insert(struct dso *dso, struct dso_cache *new)
816 struct rb_root *root = &dso->data.cache;
817 struct rb_node **p = &root->rb_node;
818 struct rb_node *parent = NULL;
819 struct dso_cache *cache;
820 u64 offset = new->offset;
822 pthread_mutex_lock(&dso->lock);
827 cache = rb_entry(parent, struct dso_cache, rb_node);
828 end = cache->offset + DSO__DATA_CACHE_SIZE;
830 if (offset < cache->offset)
832 else if (offset >= end)
838 rb_link_node(&new->rb_node, parent, p);
839 rb_insert_color(&new->rb_node, root);
843 pthread_mutex_unlock(&dso->lock);
847 static ssize_t dso_cache__memcpy(struct dso_cache *cache, u64 offset, u8 *data,
850 u64 cache_offset = offset - cache->offset;
851 u64 cache_size = min(cache->size - cache_offset, size);
854 memcpy(data, cache->data + cache_offset, cache_size);
856 memcpy(cache->data + cache_offset, data, cache_size);
860 static ssize_t file_read(struct dso *dso, struct machine *machine,
861 u64 offset, char *data)
865 pthread_mutex_lock(&dso__data_open_lock);
868 * dso->data.fd might be closed if other thread opened another
869 * file (dso) due to open file limit (RLIMIT_NOFILE).
871 try_to_open_dso(dso, machine);
873 if (dso->data.fd < 0) {
874 dso->data.status = DSO_DATA_STATUS_ERROR;
879 ret = pread(dso->data.fd, data, DSO__DATA_CACHE_SIZE, offset);
881 pthread_mutex_unlock(&dso__data_open_lock);
885 static struct dso_cache *dso_cache__populate(struct dso *dso,
886 struct machine *machine,
887 u64 offset, ssize_t *ret)
889 u64 cache_offset = offset & DSO__DATA_CACHE_MASK;
890 struct dso_cache *cache;
891 struct dso_cache *old;
893 cache = zalloc(sizeof(*cache) + DSO__DATA_CACHE_SIZE);
899 if (dso->binary_type == DSO_BINARY_TYPE__BPF_PROG_INFO)
900 *ret = bpf_read(dso, cache_offset, cache->data);
902 *ret = file_read(dso, machine, cache_offset, cache->data);
909 cache->offset = cache_offset;
912 old = dso_cache__insert(dso, cache);
914 /* we lose the race */
922 static struct dso_cache *dso_cache__find(struct dso *dso,
923 struct machine *machine,
927 struct dso_cache *cache = __dso_cache__find(dso, offset);
929 return cache ? cache : dso_cache__populate(dso, machine, offset, ret);
932 static ssize_t dso_cache_io(struct dso *dso, struct machine *machine,
933 u64 offset, u8 *data, ssize_t size, bool out)
935 struct dso_cache *cache;
938 cache = dso_cache__find(dso, machine, offset, &ret);
942 return dso_cache__memcpy(cache, offset, data, size, out);
946 * Reads and caches dso data DSO__DATA_CACHE_SIZE size chunks
947 * in the rb_tree. Any read to already cached data is served
948 * by cached data. Writes update the cache only, not the backing file.
950 static ssize_t cached_io(struct dso *dso, struct machine *machine,
951 u64 offset, u8 *data, ssize_t size, bool out)
959 ret = dso_cache_io(dso, machine, offset, p, size, out);
963 /* Reached EOF, return what we have. */
979 static int file_size(struct dso *dso, struct machine *machine)
983 char sbuf[STRERR_BUFSIZE];
985 pthread_mutex_lock(&dso__data_open_lock);
988 * dso->data.fd might be closed if other thread opened another
989 * file (dso) due to open file limit (RLIMIT_NOFILE).
991 try_to_open_dso(dso, machine);
993 if (dso->data.fd < 0) {
995 dso->data.status = DSO_DATA_STATUS_ERROR;
999 if (fstat(dso->data.fd, &st) < 0) {
1001 pr_err("dso cache fstat failed: %s\n",
1002 str_error_r(errno, sbuf, sizeof(sbuf)));
1003 dso->data.status = DSO_DATA_STATUS_ERROR;
1006 dso->data.file_size = st.st_size;
1009 pthread_mutex_unlock(&dso__data_open_lock);
1013 int dso__data_file_size(struct dso *dso, struct machine *machine)
1015 if (dso->data.file_size)
1018 if (dso->data.status == DSO_DATA_STATUS_ERROR)
1021 if (dso->binary_type == DSO_BINARY_TYPE__BPF_PROG_INFO)
1022 return bpf_size(dso);
1024 return file_size(dso, machine);
1028 * dso__data_size - Return dso data size
1030 * @machine: machine object
1032 * Return: dso data size
1034 off_t dso__data_size(struct dso *dso, struct machine *machine)
1036 if (dso__data_file_size(dso, machine))
1039 /* For now just estimate dso data size is close to file size */
1040 return dso->data.file_size;
1043 static ssize_t data_read_write_offset(struct dso *dso, struct machine *machine,
1044 u64 offset, u8 *data, ssize_t size,
1047 if (dso__data_file_size(dso, machine))
1050 /* Check the offset sanity. */
1051 if (offset > dso->data.file_size)
1054 if (offset + size < offset)
1057 return cached_io(dso, machine, offset, data, size, out);
1061 * dso__data_read_offset - Read data from dso file offset
1063 * @machine: machine object
1064 * @offset: file offset
1065 * @data: buffer to store data
1066 * @size: size of the @data buffer
1068 * External interface to read data from dso file offset. Open
1069 * dso data file and use cached_read to get the data.
1071 ssize_t dso__data_read_offset(struct dso *dso, struct machine *machine,
1072 u64 offset, u8 *data, ssize_t size)
1074 if (dso->data.status == DSO_DATA_STATUS_ERROR)
1077 return data_read_write_offset(dso, machine, offset, data, size, true);
1081 * dso__data_read_addr - Read data from dso address
1083 * @machine: machine object
1084 * @add: virtual memory address
1085 * @data: buffer to store data
1086 * @size: size of the @data buffer
1088 * External interface to read data from dso address.
1090 ssize_t dso__data_read_addr(struct dso *dso, struct map *map,
1091 struct machine *machine, u64 addr,
1092 u8 *data, ssize_t size)
1094 u64 offset = map->map_ip(map, addr);
1095 return dso__data_read_offset(dso, machine, offset, data, size);
1099 * dso__data_write_cache_offs - Write data to dso data cache at file offset
1101 * @machine: machine object
1102 * @offset: file offset
1103 * @data: buffer to write
1104 * @size: size of the @data buffer
1106 * Write into the dso file data cache, but do not change the file itself.
1108 ssize_t dso__data_write_cache_offs(struct dso *dso, struct machine *machine,
1109 u64 offset, const u8 *data_in, ssize_t size)
1111 u8 *data = (u8 *)data_in; /* cast away const to use same fns for r/w */
1113 if (dso->data.status == DSO_DATA_STATUS_ERROR)
1116 return data_read_write_offset(dso, machine, offset, data, size, false);
1120 * dso__data_write_cache_addr - Write data to dso data cache at dso address
1122 * @machine: machine object
1123 * @add: virtual memory address
1124 * @data: buffer to write
1125 * @size: size of the @data buffer
1127 * External interface to write into the dso file data cache, but do not change
1130 ssize_t dso__data_write_cache_addr(struct dso *dso, struct map *map,
1131 struct machine *machine, u64 addr,
1132 const u8 *data, ssize_t size)
1134 u64 offset = map->map_ip(map, addr);
1135 return dso__data_write_cache_offs(dso, machine, offset, data, size);
1138 struct map *dso__new_map(const char *name)
1140 struct map *map = NULL;
1141 struct dso *dso = dso__new(name);
1144 map = map__new2(0, dso);
1149 struct dso *machine__findnew_kernel(struct machine *machine, const char *name,
1150 const char *short_name, int dso_type)
1153 * The kernel dso could be created by build_id processing.
1155 struct dso *dso = machine__findnew_dso(machine, name);
1158 * We need to run this in all cases, since during the build_id
1159 * processing we had no idea this was the kernel dso.
1162 dso__set_short_name(dso, short_name, false);
1163 dso->kernel = dso_type;
1169 static void dso__set_long_name_id(struct dso *dso, const char *name, struct dso_id *id, bool name_allocated)
1171 struct rb_root *root = dso->root;
1176 if (dso->long_name_allocated)
1177 free((char *)dso->long_name);
1180 rb_erase(&dso->rb_node, root);
1182 * __dsos__findnew_link_by_longname_id() isn't guaranteed to
1183 * add it back, so a clean removal is required here.
1185 RB_CLEAR_NODE(&dso->rb_node);
1189 dso->long_name = name;
1190 dso->long_name_len = strlen(name);
1191 dso->long_name_allocated = name_allocated;
1194 __dsos__findnew_link_by_longname_id(root, dso, NULL, id);
1197 void dso__set_long_name(struct dso *dso, const char *name, bool name_allocated)
1199 dso__set_long_name_id(dso, name, NULL, name_allocated);
1202 void dso__set_short_name(struct dso *dso, const char *name, bool name_allocated)
1207 if (dso->short_name_allocated)
1208 free((char *)dso->short_name);
1210 dso->short_name = name;
1211 dso->short_name_len = strlen(name);
1212 dso->short_name_allocated = name_allocated;
1215 int dso__name_len(const struct dso *dso)
1218 return strlen("[unknown]");
1220 return dso->long_name_len;
1222 return dso->short_name_len;
1225 bool dso__loaded(const struct dso *dso)
1230 bool dso__sorted_by_name(const struct dso *dso)
1232 return dso->sorted_by_name;
1235 void dso__set_sorted_by_name(struct dso *dso)
1237 dso->sorted_by_name = true;
1240 struct dso *dso__new_id(const char *name, struct dso_id *id)
1242 struct dso *dso = calloc(1, sizeof(*dso) + strlen(name) + 1);
1245 strcpy(dso->name, name);
1248 dso__set_long_name_id(dso, dso->name, id, false);
1249 dso__set_short_name(dso, dso->name, false);
1250 dso->symbols = dso->symbol_names = RB_ROOT_CACHED;
1251 dso->data.cache = RB_ROOT;
1252 dso->inlined_nodes = RB_ROOT_CACHED;
1253 dso->srclines = RB_ROOT_CACHED;
1255 dso->data.status = DSO_DATA_STATUS_UNKNOWN;
1256 dso->symtab_type = DSO_BINARY_TYPE__NOT_FOUND;
1257 dso->binary_type = DSO_BINARY_TYPE__NOT_FOUND;
1258 dso->is_64_bit = (sizeof(void *) == 8);
1261 dso->sorted_by_name = 0;
1262 dso->has_build_id = 0;
1263 dso->has_srcline = 1;
1265 dso->kernel = DSO_TYPE_USER;
1266 dso->needs_swap = DSO_SWAP__UNSET;
1267 dso->comp = COMP_ID__NONE;
1268 RB_CLEAR_NODE(&dso->rb_node);
1270 INIT_LIST_HEAD(&dso->node);
1271 INIT_LIST_HEAD(&dso->data.open_entry);
1272 pthread_mutex_init(&dso->lock, NULL);
1273 refcount_set(&dso->refcnt, 1);
1279 struct dso *dso__new(const char *name)
1281 return dso__new_id(name, NULL);
1284 void dso__delete(struct dso *dso)
1286 if (!RB_EMPTY_NODE(&dso->rb_node))
1287 pr_err("DSO %s is still in rbtree when being deleted!\n",
1290 /* free inlines first, as they reference symbols */
1291 inlines__tree_delete(&dso->inlined_nodes);
1292 srcline__tree_delete(&dso->srclines);
1293 symbols__delete(&dso->symbols);
1295 if (dso->short_name_allocated) {
1296 zfree((char **)&dso->short_name);
1297 dso->short_name_allocated = false;
1300 if (dso->long_name_allocated) {
1301 zfree((char **)&dso->long_name);
1302 dso->long_name_allocated = false;
1305 dso__data_close(dso);
1306 auxtrace_cache__free(dso->auxtrace_cache);
1307 dso_cache__free(dso);
1309 zfree(&dso->symsrc_filename);
1310 nsinfo__zput(dso->nsinfo);
1311 pthread_mutex_destroy(&dso->lock);
1315 struct dso *dso__get(struct dso *dso)
1318 refcount_inc(&dso->refcnt);
1322 void dso__put(struct dso *dso)
1324 if (dso && refcount_dec_and_test(&dso->refcnt))
1328 void dso__set_build_id(struct dso *dso, void *build_id)
1330 memcpy(dso->build_id, build_id, sizeof(dso->build_id));
1331 dso->has_build_id = 1;
1334 bool dso__build_id_equal(const struct dso *dso, u8 *build_id)
1336 return memcmp(dso->build_id, build_id, sizeof(dso->build_id)) == 0;
1339 void dso__read_running_kernel_build_id(struct dso *dso, struct machine *machine)
1341 char path[PATH_MAX];
1343 if (machine__is_default_guest(machine))
1345 sprintf(path, "%s/sys/kernel/notes", machine->root_dir);
1346 if (sysfs__read_build_id(path, dso->build_id,
1347 sizeof(dso->build_id)) == 0)
1348 dso->has_build_id = true;
1351 int dso__kernel_module_get_build_id(struct dso *dso,
1352 const char *root_dir)
1354 char filename[PATH_MAX];
1356 * kernel module short names are of the form "[module]" and
1357 * we need just "module" here.
1359 const char *name = dso->short_name + 1;
1361 snprintf(filename, sizeof(filename),
1362 "%s/sys/module/%.*s/notes/.note.gnu.build-id",
1363 root_dir, (int)strlen(name) - 1, name);
1365 if (sysfs__read_build_id(filename, dso->build_id,
1366 sizeof(dso->build_id)) == 0)
1367 dso->has_build_id = true;
1372 size_t dso__fprintf_buildid(struct dso *dso, FILE *fp)
1374 char sbuild_id[SBUILD_ID_SIZE];
1376 build_id__sprintf(dso->build_id, sizeof(dso->build_id), sbuild_id);
1377 return fprintf(fp, "%s", sbuild_id);
1380 size_t dso__fprintf(struct dso *dso, FILE *fp)
1383 size_t ret = fprintf(fp, "dso: %s (", dso->short_name);
1385 if (dso->short_name != dso->long_name)
1386 ret += fprintf(fp, "%s, ", dso->long_name);
1387 ret += fprintf(fp, "%sloaded, ", dso__loaded(dso) ? "" : "NOT ");
1388 ret += dso__fprintf_buildid(dso, fp);
1389 ret += fprintf(fp, ")\n");
1390 for (nd = rb_first_cached(&dso->symbols); nd; nd = rb_next(nd)) {
1391 struct symbol *pos = rb_entry(nd, struct symbol, rb_node);
1392 ret += symbol__fprintf(pos, fp);
1398 enum dso_type dso__type(struct dso *dso, struct machine *machine)
1401 enum dso_type type = DSO__TYPE_UNKNOWN;
1403 fd = dso__data_get_fd(dso, machine);
1405 type = dso__type_fd(fd);
1406 dso__data_put_fd(dso);
1412 int dso__strerror_load(struct dso *dso, char *buf, size_t buflen)
1414 int idx, errnum = dso->load_errno;
1416 * This must have a same ordering as the enum dso_load_errno.
1418 static const char *dso_load__error_str[] = {
1419 "Internal tools/perf/ library error",
1421 "Can not read build id",
1422 "Mismatching build id",
1423 "Decompression failure",
1426 BUG_ON(buflen == 0);
1429 const char *err = str_error_r(errnum, buf, buflen);
1432 scnprintf(buf, buflen, "%s", err);
1437 if (errnum < __DSO_LOAD_ERRNO__START || errnum >= __DSO_LOAD_ERRNO__END)
1440 idx = errnum - __DSO_LOAD_ERRNO__START;
1441 scnprintf(buf, buflen, "%s", dso_load__error_str[idx]);