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);
504 mutex_lock(&dso->lock);
506 root_dir = machine->root_dir;
508 if (dso__read_binary_type_filename(dso, dso->binary_type,
509 root_dir, name, PATH_MAX))
512 if (!is_regular_file(name)) {
515 if (errno != ENOENT || dso->nsinfo == NULL)
518 new_name = filename_with_chroot(dso->nsinfo->pid, name);
526 if (dso__needs_decompress(dso)) {
527 char newpath[KMOD_DECOMP_LEN];
528 size_t len = sizeof(newpath);
530 if (dso__decompress_kmodule_path(dso, name, newpath, len) < 0) {
531 fd = -dso->load_errno;
536 strcpy(name, newpath);
545 mutex_unlock(&dso->lock);
550 static void check_data_close(void);
553 * dso_close - Open DSO data file
556 * Open @dso's data file descriptor and updates
557 * list/count of open DSO objects.
559 static int open_dso(struct dso *dso, struct machine *machine)
564 if (dso->binary_type != DSO_BINARY_TYPE__BUILD_ID_CACHE) {
565 mutex_lock(&dso->lock);
566 nsinfo__mountns_enter(dso->nsinfo, &nsc);
567 mutex_unlock(&dso->lock);
569 fd = __open_dso(dso, machine);
570 if (dso->binary_type != DSO_BINARY_TYPE__BUILD_ID_CACHE)
571 nsinfo__mountns_exit(&nsc);
576 * Check if we crossed the allowed number
577 * of opened DSOs and close one if needed.
585 static void close_data_fd(struct dso *dso)
587 if (dso->data.fd >= 0) {
590 dso->data.file_size = 0;
596 * dso_close - Close DSO data file
599 * Close @dso's data file descriptor and updates
600 * list/count of open DSO objects.
602 static void close_dso(struct dso *dso)
607 static void close_first_dso(void)
611 dso = list_first_entry(&dso__data_open, struct dso, data.open_entry);
615 static rlim_t get_fd_limit(void)
620 /* Allow half of the current open fd limit. */
621 if (getrlimit(RLIMIT_NOFILE, &l) == 0) {
622 if (l.rlim_cur == RLIM_INFINITY)
625 limit = l.rlim_cur / 2;
627 pr_err("failed to get fd limit\n");
634 static rlim_t fd_limit;
637 * Used only by tests/dso-data.c to reset the environment
638 * for tests. I dont expect we should change this during
641 void reset_fd_limit(void)
646 static bool may_cache_fd(void)
649 fd_limit = get_fd_limit();
651 if (fd_limit == RLIM_INFINITY)
654 return fd_limit > (rlim_t) dso__data_open_cnt;
658 * Check and close LRU dso if we crossed allowed limit
659 * for opened dso file descriptors. The limit is half
660 * of the RLIMIT_NOFILE files opened.
662 static void check_data_close(void)
664 bool cache_fd = may_cache_fd();
671 * dso__data_close - Close DSO data file
674 * External interface to close @dso's data file descriptor.
676 void dso__data_close(struct dso *dso)
678 pthread_mutex_lock(&dso__data_open_lock);
680 pthread_mutex_unlock(&dso__data_open_lock);
683 static void try_to_open_dso(struct dso *dso, struct machine *machine)
685 enum dso_binary_type binary_type_data[] = {
686 DSO_BINARY_TYPE__BUILD_ID_CACHE,
687 DSO_BINARY_TYPE__SYSTEM_PATH_DSO,
688 DSO_BINARY_TYPE__NOT_FOUND,
692 if (dso->data.fd >= 0)
695 if (dso->binary_type != DSO_BINARY_TYPE__NOT_FOUND) {
696 dso->data.fd = open_dso(dso, machine);
701 dso->binary_type = binary_type_data[i++];
703 dso->data.fd = open_dso(dso, machine);
704 if (dso->data.fd >= 0)
707 } while (dso->binary_type != DSO_BINARY_TYPE__NOT_FOUND);
709 if (dso->data.fd >= 0)
710 dso->data.status = DSO_DATA_STATUS_OK;
712 dso->data.status = DSO_DATA_STATUS_ERROR;
716 * dso__data_get_fd - Get dso's data file descriptor
718 * @machine: machine object
720 * External interface to find dso's file, open it and
721 * returns file descriptor. It should be paired with
722 * dso__data_put_fd() if it returns non-negative value.
724 int dso__data_get_fd(struct dso *dso, struct machine *machine)
726 if (dso->data.status == DSO_DATA_STATUS_ERROR)
729 if (pthread_mutex_lock(&dso__data_open_lock) < 0)
732 try_to_open_dso(dso, machine);
734 if (dso->data.fd < 0)
735 pthread_mutex_unlock(&dso__data_open_lock);
740 void dso__data_put_fd(struct dso *dso __maybe_unused)
742 pthread_mutex_unlock(&dso__data_open_lock);
745 bool dso__data_status_seen(struct dso *dso, enum dso_data_status_seen by)
749 if (dso->data.status_seen & flag)
752 dso->data.status_seen |= flag;
757 #ifdef HAVE_LIBBPF_SUPPORT
758 static ssize_t bpf_read(struct dso *dso, u64 offset, char *data)
760 struct bpf_prog_info_node *node;
761 ssize_t size = DSO__DATA_CACHE_SIZE;
765 node = perf_env__find_bpf_prog_info(dso->bpf_prog.env, dso->bpf_prog.id);
766 if (!node || !node->info_linear) {
767 dso->data.status = DSO_DATA_STATUS_ERROR;
771 len = node->info_linear->info.jited_prog_len;
772 buf = (u8 *)(uintptr_t)node->info_linear->info.jited_prog_insns;
777 size = (ssize_t)min(len - offset, (u64)size);
778 memcpy(data, buf + offset, size);
782 static int bpf_size(struct dso *dso)
784 struct bpf_prog_info_node *node;
786 node = perf_env__find_bpf_prog_info(dso->bpf_prog.env, dso->bpf_prog.id);
787 if (!node || !node->info_linear) {
788 dso->data.status = DSO_DATA_STATUS_ERROR;
792 dso->data.file_size = node->info_linear->info.jited_prog_len;
795 #endif // HAVE_LIBBPF_SUPPORT
798 dso_cache__free(struct dso *dso)
800 struct rb_root *root = &dso->data.cache;
801 struct rb_node *next = rb_first(root);
803 mutex_lock(&dso->lock);
805 struct dso_cache *cache;
807 cache = rb_entry(next, struct dso_cache, rb_node);
808 next = rb_next(&cache->rb_node);
809 rb_erase(&cache->rb_node, root);
812 mutex_unlock(&dso->lock);
815 static struct dso_cache *__dso_cache__find(struct dso *dso, u64 offset)
817 const struct rb_root *root = &dso->data.cache;
818 struct rb_node * const *p = &root->rb_node;
819 const struct rb_node *parent = NULL;
820 struct dso_cache *cache;
826 cache = rb_entry(parent, struct dso_cache, rb_node);
827 end = cache->offset + DSO__DATA_CACHE_SIZE;
829 if (offset < cache->offset)
831 else if (offset >= end)
840 static struct dso_cache *
841 dso_cache__insert(struct dso *dso, struct dso_cache *new)
843 struct rb_root *root = &dso->data.cache;
844 struct rb_node **p = &root->rb_node;
845 struct rb_node *parent = NULL;
846 struct dso_cache *cache;
847 u64 offset = new->offset;
849 mutex_lock(&dso->lock);
854 cache = rb_entry(parent, struct dso_cache, rb_node);
855 end = cache->offset + DSO__DATA_CACHE_SIZE;
857 if (offset < cache->offset)
859 else if (offset >= end)
865 rb_link_node(&new->rb_node, parent, p);
866 rb_insert_color(&new->rb_node, root);
870 mutex_unlock(&dso->lock);
874 static ssize_t dso_cache__memcpy(struct dso_cache *cache, u64 offset, u8 *data,
877 u64 cache_offset = offset - cache->offset;
878 u64 cache_size = min(cache->size - cache_offset, size);
881 memcpy(data, cache->data + cache_offset, cache_size);
883 memcpy(cache->data + cache_offset, data, cache_size);
887 static ssize_t file_read(struct dso *dso, struct machine *machine,
888 u64 offset, char *data)
892 pthread_mutex_lock(&dso__data_open_lock);
895 * dso->data.fd might be closed if other thread opened another
896 * file (dso) due to open file limit (RLIMIT_NOFILE).
898 try_to_open_dso(dso, machine);
900 if (dso->data.fd < 0) {
901 dso->data.status = DSO_DATA_STATUS_ERROR;
906 ret = pread(dso->data.fd, data, DSO__DATA_CACHE_SIZE, offset);
908 pthread_mutex_unlock(&dso__data_open_lock);
912 static struct dso_cache *dso_cache__populate(struct dso *dso,
913 struct machine *machine,
914 u64 offset, ssize_t *ret)
916 u64 cache_offset = offset & DSO__DATA_CACHE_MASK;
917 struct dso_cache *cache;
918 struct dso_cache *old;
920 cache = zalloc(sizeof(*cache) + DSO__DATA_CACHE_SIZE);
925 #ifdef HAVE_LIBBPF_SUPPORT
926 if (dso->binary_type == DSO_BINARY_TYPE__BPF_PROG_INFO)
927 *ret = bpf_read(dso, cache_offset, cache->data);
930 if (dso->binary_type == DSO_BINARY_TYPE__OOL)
931 *ret = DSO__DATA_CACHE_SIZE;
933 *ret = file_read(dso, machine, cache_offset, cache->data);
940 cache->offset = cache_offset;
943 old = dso_cache__insert(dso, cache);
945 /* we lose the race */
953 static struct dso_cache *dso_cache__find(struct dso *dso,
954 struct machine *machine,
958 struct dso_cache *cache = __dso_cache__find(dso, offset);
960 return cache ? cache : dso_cache__populate(dso, machine, offset, ret);
963 static ssize_t dso_cache_io(struct dso *dso, struct machine *machine,
964 u64 offset, u8 *data, ssize_t size, bool out)
966 struct dso_cache *cache;
969 cache = dso_cache__find(dso, machine, offset, &ret);
973 return dso_cache__memcpy(cache, offset, data, size, out);
977 * Reads and caches dso data DSO__DATA_CACHE_SIZE size chunks
978 * in the rb_tree. Any read to already cached data is served
979 * by cached data. Writes update the cache only, not the backing file.
981 static ssize_t cached_io(struct dso *dso, struct machine *machine,
982 u64 offset, u8 *data, ssize_t size, bool out)
990 ret = dso_cache_io(dso, machine, offset, p, size, out);
994 /* Reached EOF, return what we have. */
1010 static int file_size(struct dso *dso, struct machine *machine)
1014 char sbuf[STRERR_BUFSIZE];
1016 pthread_mutex_lock(&dso__data_open_lock);
1019 * dso->data.fd might be closed if other thread opened another
1020 * file (dso) due to open file limit (RLIMIT_NOFILE).
1022 try_to_open_dso(dso, machine);
1024 if (dso->data.fd < 0) {
1026 dso->data.status = DSO_DATA_STATUS_ERROR;
1030 if (fstat(dso->data.fd, &st) < 0) {
1032 pr_err("dso cache fstat failed: %s\n",
1033 str_error_r(errno, sbuf, sizeof(sbuf)));
1034 dso->data.status = DSO_DATA_STATUS_ERROR;
1037 dso->data.file_size = st.st_size;
1040 pthread_mutex_unlock(&dso__data_open_lock);
1044 int dso__data_file_size(struct dso *dso, struct machine *machine)
1046 if (dso->data.file_size)
1049 if (dso->data.status == DSO_DATA_STATUS_ERROR)
1051 #ifdef HAVE_LIBBPF_SUPPORT
1052 if (dso->binary_type == DSO_BINARY_TYPE__BPF_PROG_INFO)
1053 return bpf_size(dso);
1055 return file_size(dso, machine);
1059 * dso__data_size - Return dso data size
1061 * @machine: machine object
1063 * Return: dso data size
1065 off_t dso__data_size(struct dso *dso, struct machine *machine)
1067 if (dso__data_file_size(dso, machine))
1070 /* For now just estimate dso data size is close to file size */
1071 return dso->data.file_size;
1074 static ssize_t data_read_write_offset(struct dso *dso, struct machine *machine,
1075 u64 offset, u8 *data, ssize_t size,
1078 if (dso__data_file_size(dso, machine))
1081 /* Check the offset sanity. */
1082 if (offset > dso->data.file_size)
1085 if (offset + size < offset)
1088 return cached_io(dso, machine, offset, data, size, out);
1092 * dso__data_read_offset - Read data from dso file offset
1094 * @machine: machine object
1095 * @offset: file offset
1096 * @data: buffer to store data
1097 * @size: size of the @data buffer
1099 * External interface to read data from dso file offset. Open
1100 * dso data file and use cached_read to get the data.
1102 ssize_t dso__data_read_offset(struct dso *dso, struct machine *machine,
1103 u64 offset, u8 *data, ssize_t size)
1105 if (dso->data.status == DSO_DATA_STATUS_ERROR)
1108 return data_read_write_offset(dso, machine, offset, data, size, true);
1112 * dso__data_read_addr - Read data from dso address
1114 * @machine: machine object
1115 * @add: virtual memory address
1116 * @data: buffer to store data
1117 * @size: size of the @data buffer
1119 * External interface to read data from dso address.
1121 ssize_t dso__data_read_addr(struct dso *dso, struct map *map,
1122 struct machine *machine, u64 addr,
1123 u8 *data, ssize_t size)
1125 u64 offset = map->map_ip(map, addr);
1126 return dso__data_read_offset(dso, machine, offset, data, size);
1130 * dso__data_write_cache_offs - Write data to dso data cache at file offset
1132 * @machine: machine object
1133 * @offset: file offset
1134 * @data: buffer to write
1135 * @size: size of the @data buffer
1137 * Write into the dso file data cache, but do not change the file itself.
1139 ssize_t dso__data_write_cache_offs(struct dso *dso, struct machine *machine,
1140 u64 offset, const u8 *data_in, ssize_t size)
1142 u8 *data = (u8 *)data_in; /* cast away const to use same fns for r/w */
1144 if (dso->data.status == DSO_DATA_STATUS_ERROR)
1147 return data_read_write_offset(dso, machine, offset, data, size, false);
1151 * dso__data_write_cache_addr - Write data to dso data cache at dso address
1153 * @machine: machine object
1154 * @add: virtual memory address
1155 * @data: buffer to write
1156 * @size: size of the @data buffer
1158 * External interface to write into the dso file data cache, but do not change
1161 ssize_t dso__data_write_cache_addr(struct dso *dso, struct map *map,
1162 struct machine *machine, u64 addr,
1163 const u8 *data, ssize_t size)
1165 u64 offset = map->map_ip(map, addr);
1166 return dso__data_write_cache_offs(dso, machine, offset, data, size);
1169 struct map *dso__new_map(const char *name)
1171 struct map *map = NULL;
1172 struct dso *dso = dso__new(name);
1175 map = map__new2(0, dso);
1182 struct dso *machine__findnew_kernel(struct machine *machine, const char *name,
1183 const char *short_name, int dso_type)
1186 * The kernel dso could be created by build_id processing.
1188 struct dso *dso = machine__findnew_dso(machine, name);
1191 * We need to run this in all cases, since during the build_id
1192 * processing we had no idea this was the kernel dso.
1195 dso__set_short_name(dso, short_name, false);
1196 dso->kernel = dso_type;
1202 static void dso__set_long_name_id(struct dso *dso, const char *name, struct dso_id *id, bool name_allocated)
1204 struct rb_root *root = dso->root;
1209 if (dso->long_name_allocated)
1210 free((char *)dso->long_name);
1213 rb_erase(&dso->rb_node, root);
1215 * __dsos__findnew_link_by_longname_id() isn't guaranteed to
1216 * add it back, so a clean removal is required here.
1218 RB_CLEAR_NODE(&dso->rb_node);
1222 dso->long_name = name;
1223 dso->long_name_len = strlen(name);
1224 dso->long_name_allocated = name_allocated;
1227 __dsos__findnew_link_by_longname_id(root, dso, NULL, id);
1230 void dso__set_long_name(struct dso *dso, const char *name, bool name_allocated)
1232 dso__set_long_name_id(dso, name, NULL, name_allocated);
1235 void dso__set_short_name(struct dso *dso, const char *name, bool name_allocated)
1240 if (dso->short_name_allocated)
1241 free((char *)dso->short_name);
1243 dso->short_name = name;
1244 dso->short_name_len = strlen(name);
1245 dso->short_name_allocated = name_allocated;
1248 int dso__name_len(const struct dso *dso)
1251 return strlen("[unknown]");
1253 return dso->long_name_len;
1255 return dso->short_name_len;
1258 bool dso__loaded(const struct dso *dso)
1263 bool dso__sorted_by_name(const struct dso *dso)
1265 return dso->sorted_by_name;
1268 void dso__set_sorted_by_name(struct dso *dso)
1270 dso->sorted_by_name = true;
1273 struct dso *dso__new_id(const char *name, struct dso_id *id)
1275 struct dso *dso = calloc(1, sizeof(*dso) + strlen(name) + 1);
1278 strcpy(dso->name, name);
1281 dso__set_long_name_id(dso, dso->name, id, false);
1282 dso__set_short_name(dso, dso->name, false);
1283 dso->symbols = dso->symbol_names = RB_ROOT_CACHED;
1284 dso->data.cache = RB_ROOT;
1285 dso->inlined_nodes = RB_ROOT_CACHED;
1286 dso->srclines = RB_ROOT_CACHED;
1288 dso->data.status = DSO_DATA_STATUS_UNKNOWN;
1289 dso->symtab_type = DSO_BINARY_TYPE__NOT_FOUND;
1290 dso->binary_type = DSO_BINARY_TYPE__NOT_FOUND;
1291 dso->is_64_bit = (sizeof(void *) == 8);
1294 dso->sorted_by_name = 0;
1295 dso->has_build_id = 0;
1296 dso->has_srcline = 1;
1298 dso->kernel = DSO_SPACE__USER;
1299 dso->needs_swap = DSO_SWAP__UNSET;
1300 dso->comp = COMP_ID__NONE;
1301 RB_CLEAR_NODE(&dso->rb_node);
1303 INIT_LIST_HEAD(&dso->node);
1304 INIT_LIST_HEAD(&dso->data.open_entry);
1305 mutex_init(&dso->lock);
1306 refcount_set(&dso->refcnt, 1);
1312 struct dso *dso__new(const char *name)
1314 return dso__new_id(name, NULL);
1317 void dso__delete(struct dso *dso)
1319 if (!RB_EMPTY_NODE(&dso->rb_node))
1320 pr_err("DSO %s is still in rbtree when being deleted!\n",
1323 /* free inlines first, as they reference symbols */
1324 inlines__tree_delete(&dso->inlined_nodes);
1325 srcline__tree_delete(&dso->srclines);
1326 symbols__delete(&dso->symbols);
1328 if (dso->short_name_allocated) {
1329 zfree((char **)&dso->short_name);
1330 dso->short_name_allocated = false;
1333 if (dso->long_name_allocated) {
1334 zfree((char **)&dso->long_name);
1335 dso->long_name_allocated = false;
1338 dso__data_close(dso);
1339 auxtrace_cache__free(dso->auxtrace_cache);
1340 dso_cache__free(dso);
1342 zfree(&dso->symsrc_filename);
1343 nsinfo__zput(dso->nsinfo);
1344 mutex_destroy(&dso->lock);
1348 struct dso *dso__get(struct dso *dso)
1351 refcount_inc(&dso->refcnt);
1355 void dso__put(struct dso *dso)
1357 if (dso && refcount_dec_and_test(&dso->refcnt))
1361 void dso__set_build_id(struct dso *dso, struct build_id *bid)
1364 dso->has_build_id = 1;
1367 bool dso__build_id_equal(const struct dso *dso, struct build_id *bid)
1369 if (dso->bid.size > bid->size && dso->bid.size == BUILD_ID_SIZE) {
1371 * For the backward compatibility, it allows a build-id has
1374 return !memcmp(dso->bid.data, bid->data, bid->size) &&
1375 !memchr_inv(&dso->bid.data[bid->size], 0,
1376 dso->bid.size - bid->size);
1379 return dso->bid.size == bid->size &&
1380 memcmp(dso->bid.data, bid->data, dso->bid.size) == 0;
1383 void dso__read_running_kernel_build_id(struct dso *dso, struct machine *machine)
1385 char path[PATH_MAX];
1387 if (machine__is_default_guest(machine))
1389 sprintf(path, "%s/sys/kernel/notes", machine->root_dir);
1390 if (sysfs__read_build_id(path, &dso->bid) == 0)
1391 dso->has_build_id = true;
1394 int dso__kernel_module_get_build_id(struct dso *dso,
1395 const char *root_dir)
1397 char filename[PATH_MAX];
1399 * kernel module short names are of the form "[module]" and
1400 * we need just "module" here.
1402 const char *name = dso->short_name + 1;
1404 snprintf(filename, sizeof(filename),
1405 "%s/sys/module/%.*s/notes/.note.gnu.build-id",
1406 root_dir, (int)strlen(name) - 1, name);
1408 if (sysfs__read_build_id(filename, &dso->bid) == 0)
1409 dso->has_build_id = true;
1414 static size_t dso__fprintf_buildid(struct dso *dso, FILE *fp)
1416 char sbuild_id[SBUILD_ID_SIZE];
1418 build_id__sprintf(&dso->bid, sbuild_id);
1419 return fprintf(fp, "%s", sbuild_id);
1422 size_t dso__fprintf(struct dso *dso, FILE *fp)
1425 size_t ret = fprintf(fp, "dso: %s (", dso->short_name);
1427 if (dso->short_name != dso->long_name)
1428 ret += fprintf(fp, "%s, ", dso->long_name);
1429 ret += fprintf(fp, "%sloaded, ", dso__loaded(dso) ? "" : "NOT ");
1430 ret += dso__fprintf_buildid(dso, fp);
1431 ret += fprintf(fp, ")\n");
1432 for (nd = rb_first_cached(&dso->symbols); nd; nd = rb_next(nd)) {
1433 struct symbol *pos = rb_entry(nd, struct symbol, rb_node);
1434 ret += symbol__fprintf(pos, fp);
1440 enum dso_type dso__type(struct dso *dso, struct machine *machine)
1443 enum dso_type type = DSO__TYPE_UNKNOWN;
1445 fd = dso__data_get_fd(dso, machine);
1447 type = dso__type_fd(fd);
1448 dso__data_put_fd(dso);
1454 int dso__strerror_load(struct dso *dso, char *buf, size_t buflen)
1456 int idx, errnum = dso->load_errno;
1458 * This must have a same ordering as the enum dso_load_errno.
1460 static const char *dso_load__error_str[] = {
1461 "Internal tools/perf/ library error",
1463 "Can not read build id",
1464 "Mismatching build id",
1465 "Decompression failure",
1468 BUG_ON(buflen == 0);
1471 const char *err = str_error_r(errnum, buf, buflen);
1474 scnprintf(buf, buflen, "%s", err);
1479 if (errnum < __DSO_LOAD_ERRNO__START || errnum >= __DSO_LOAD_ERRNO__END)
1482 idx = errnum - __DSO_LOAD_ERRNO__START;
1483 scnprintf(buf, buflen, "%s", dso_load__error_str[idx]);