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__OPENEMBEDDED_DEBUGINFO] = 'o',
51 [DSO_BINARY_TYPE__BUILDID_DEBUGINFO] = 'b',
52 [DSO_BINARY_TYPE__SYSTEM_PATH_DSO] = 'd',
53 [DSO_BINARY_TYPE__SYSTEM_PATH_KMODULE] = 'K',
54 [DSO_BINARY_TYPE__SYSTEM_PATH_KMODULE_COMP] = 'm',
55 [DSO_BINARY_TYPE__GUEST_KALLSYMS] = 'g',
56 [DSO_BINARY_TYPE__GUEST_KMODULE] = 'G',
57 [DSO_BINARY_TYPE__GUEST_KMODULE_COMP] = 'M',
58 [DSO_BINARY_TYPE__GUEST_VMLINUX] = 'V',
61 if (dso == NULL || dso->symtab_type == DSO_BINARY_TYPE__NOT_FOUND)
63 return origin[dso->symtab_type];
66 int dso__read_binary_type_filename(const struct dso *dso,
67 enum dso_binary_type type,
68 char *root_dir, char *filename, size_t size)
70 char build_id_hex[SBUILD_ID_SIZE];
75 case DSO_BINARY_TYPE__DEBUGLINK:
77 const char *last_slash;
78 char dso_dir[PATH_MAX];
79 char symfile[PATH_MAX];
82 len = __symbol__join_symfs(filename, size, dso->long_name);
83 last_slash = filename + len;
84 while (last_slash != filename && *last_slash != '/')
87 strncpy(dso_dir, filename, last_slash - filename);
88 dso_dir[last_slash-filename] = '\0';
90 if (!is_regular_file(filename)) {
95 ret = filename__read_debuglink(filename, symfile, PATH_MAX);
99 /* Check predefined locations where debug file might reside */
101 for (i = 0; i < ARRAY_SIZE(debuglink_paths); i++) {
102 snprintf(filename, size,
103 debuglink_paths[i], dso_dir, symfile);
104 if (is_regular_file(filename)) {
112 case DSO_BINARY_TYPE__BUILD_ID_CACHE:
113 if (dso__build_id_filename(dso, filename, size, false) == NULL)
117 case DSO_BINARY_TYPE__BUILD_ID_CACHE_DEBUGINFO:
118 if (dso__build_id_filename(dso, filename, size, true) == NULL)
122 case DSO_BINARY_TYPE__FEDORA_DEBUGINFO:
123 len = __symbol__join_symfs(filename, size, "/usr/lib/debug");
124 snprintf(filename + len, size - len, "%s.debug", dso->long_name);
127 case DSO_BINARY_TYPE__UBUNTU_DEBUGINFO:
128 len = __symbol__join_symfs(filename, size, "/usr/lib/debug");
129 snprintf(filename + len, size - len, "%s", dso->long_name);
132 case DSO_BINARY_TYPE__OPENEMBEDDED_DEBUGINFO:
134 const char *last_slash;
137 last_slash = dso->long_name + dso->long_name_len;
138 while (last_slash != dso->long_name && *last_slash != '/')
141 len = __symbol__join_symfs(filename, size, "");
142 dir_size = last_slash - dso->long_name + 2;
143 if (dir_size > (size - len)) {
147 len += scnprintf(filename + len, dir_size, "%s", dso->long_name);
148 len += scnprintf(filename + len , size - len, ".debug%s",
153 case DSO_BINARY_TYPE__BUILDID_DEBUGINFO:
154 if (!dso->has_build_id) {
159 build_id__sprintf(dso->build_id,
160 sizeof(dso->build_id),
162 len = __symbol__join_symfs(filename, size, "/usr/lib/debug/.build-id/");
163 snprintf(filename + len, size - len, "%.2s/%s.debug",
164 build_id_hex, build_id_hex + 2);
167 case DSO_BINARY_TYPE__VMLINUX:
168 case DSO_BINARY_TYPE__GUEST_VMLINUX:
169 case DSO_BINARY_TYPE__SYSTEM_PATH_DSO:
170 __symbol__join_symfs(filename, size, dso->long_name);
173 case DSO_BINARY_TYPE__GUEST_KMODULE:
174 case DSO_BINARY_TYPE__GUEST_KMODULE_COMP:
175 path__join3(filename, size, symbol_conf.symfs,
176 root_dir, dso->long_name);
179 case DSO_BINARY_TYPE__SYSTEM_PATH_KMODULE:
180 case DSO_BINARY_TYPE__SYSTEM_PATH_KMODULE_COMP:
181 __symbol__join_symfs(filename, size, dso->long_name);
184 case DSO_BINARY_TYPE__KCORE:
185 case DSO_BINARY_TYPE__GUEST_KCORE:
186 snprintf(filename, size, "%s", dso->long_name);
190 case DSO_BINARY_TYPE__KALLSYMS:
191 case DSO_BINARY_TYPE__GUEST_KALLSYMS:
192 case DSO_BINARY_TYPE__JAVA_JIT:
193 case DSO_BINARY_TYPE__BPF_PROG_INFO:
194 case DSO_BINARY_TYPE__NOT_FOUND:
206 static const struct {
208 int (*decompress)(const char *input, int output);
209 bool (*is_compressed)(const char *input);
211 [COMP_ID__NONE] = { .fmt = NULL, },
212 #ifdef HAVE_ZLIB_SUPPORT
213 { "gz", gzip_decompress_to_file, gzip_is_compressed },
215 #ifdef HAVE_LZMA_SUPPORT
216 { "xz", lzma_decompress_to_file, lzma_is_compressed },
218 { NULL, NULL, NULL },
221 static int is_supported_compression(const char *ext)
225 for (i = 1; compressions[i].fmt; i++) {
226 if (!strcmp(ext, compressions[i].fmt))
229 return COMP_ID__NONE;
232 bool is_kernel_module(const char *pathname, int cpumode)
235 int mode = cpumode & PERF_RECORD_MISC_CPUMODE_MASK;
237 WARN_ONCE(mode != cpumode,
238 "Internal error: passing unmasked cpumode (%x) to is_kernel_module",
242 case PERF_RECORD_MISC_USER:
243 case PERF_RECORD_MISC_HYPERVISOR:
244 case PERF_RECORD_MISC_GUEST_USER:
246 /* Treat PERF_RECORD_MISC_CPUMODE_UNKNOWN as kernel */
248 if (kmod_path__parse(&m, pathname)) {
249 pr_err("Failed to check whether %s is a kernel module or not. Assume it is.",
258 bool dso__needs_decompress(struct dso *dso)
260 return dso->symtab_type == DSO_BINARY_TYPE__SYSTEM_PATH_KMODULE_COMP ||
261 dso->symtab_type == DSO_BINARY_TYPE__GUEST_KMODULE_COMP;
264 static int decompress_kmodule(struct dso *dso, const char *name,
265 char *pathname, size_t len)
267 char tmpbuf[] = KMOD_DECOMP_NAME;
270 if (!dso__needs_decompress(dso))
273 if (dso->comp == COMP_ID__NONE)
277 * We have proper compression id for DSO and yet the file
278 * behind the 'name' can still be plain uncompressed object.
280 * The reason is behind the logic we open the DSO object files,
281 * when we try all possible 'debug' objects until we find the
282 * data. So even if the DSO is represented by 'krava.xz' module,
283 * we can end up here opening ~/.debug/....23432432/debug' file
284 * which is not compressed.
286 * To keep this transparent, we detect this and return the file
287 * descriptor to the uncompressed file.
289 if (!compressions[dso->comp].is_compressed(name))
290 return open(name, O_RDONLY);
292 fd = mkstemp(tmpbuf);
294 dso->load_errno = errno;
298 if (compressions[dso->comp].decompress(name, fd)) {
299 dso->load_errno = DSO_LOAD_ERRNO__DECOMPRESSION_FAILURE;
304 if (!pathname || (fd < 0))
307 if (pathname && (fd >= 0))
308 strlcpy(pathname, tmpbuf, len);
313 int dso__decompress_kmodule_fd(struct dso *dso, const char *name)
315 return decompress_kmodule(dso, name, NULL, 0);
318 int dso__decompress_kmodule_path(struct dso *dso, const char *name,
319 char *pathname, size_t len)
321 int fd = decompress_kmodule(dso, name, pathname, len);
324 return fd >= 0 ? 0 : -1;
328 * Parses kernel module specified in @path and updates
331 * @comp - true if @path contains supported compression suffix,
333 * @kmod - true if @path contains '.ko' suffix in right position,
335 * @name - if (@alloc_name && @kmod) is true, it contains strdup-ed base name
336 * of the kernel module without suffixes, otherwise strudup-ed
338 * @ext - if (@alloc_ext && @comp) is true, it contains strdup-ed string
339 * the compression suffix
341 * Returns 0 if there's no strdup error, -ENOMEM otherwise.
343 int __kmod_path__parse(struct kmod_path *m, const char *path,
346 const char *name = strrchr(path, '/');
347 const char *ext = strrchr(path, '.');
348 bool is_simple_name = false;
350 memset(m, 0x0, sizeof(*m));
351 name = name ? name + 1 : path;
354 * '.' is also a valid character for module name. For example:
355 * [aaa.bbb] is a valid module name. '[' should have higher
356 * priority than '.ko' suffix.
358 * The kernel names are from machine__mmap_name. Such
359 * name should belong to kernel itself, not kernel module.
361 if (name[0] == '[') {
362 is_simple_name = true;
363 if ((strncmp(name, "[kernel.kallsyms]", 17) == 0) ||
364 (strncmp(name, "[guest.kernel.kallsyms", 22) == 0) ||
365 (strncmp(name, "[vdso]", 6) == 0) ||
366 (strncmp(name, "[vdso32]", 8) == 0) ||
367 (strncmp(name, "[vdsox32]", 9) == 0) ||
368 (strncmp(name, "[vsyscall]", 10) == 0)) {
375 /* No extension, just return name. */
376 if ((ext == NULL) || is_simple_name) {
378 m->name = strdup(name);
379 return m->name ? 0 : -ENOMEM;
384 m->comp = is_supported_compression(ext + 1);
385 if (m->comp > COMP_ID__NONE)
388 /* Check .ko extension only if there's enough name left. */
390 m->kmod = !strncmp(ext, ".ko", 3);
394 if (asprintf(&m->name, "[%.*s]", (int) (ext - name), name) == -1)
397 if (asprintf(&m->name, "%s", name) == -1)
401 strreplace(m->name, '-', '_');
407 void dso__set_module_info(struct dso *dso, struct kmod_path *m,
408 struct machine *machine)
410 if (machine__is_host(machine))
411 dso->symtab_type = DSO_BINARY_TYPE__SYSTEM_PATH_KMODULE;
413 dso->symtab_type = DSO_BINARY_TYPE__GUEST_KMODULE;
415 /* _KMODULE_COMP should be next to _KMODULE */
416 if (m->kmod && m->comp) {
421 dso__set_short_name(dso, strdup(m->name), true);
425 * Global list of open DSOs and the counter.
427 static LIST_HEAD(dso__data_open);
428 static long dso__data_open_cnt;
429 static pthread_mutex_t dso__data_open_lock = PTHREAD_MUTEX_INITIALIZER;
431 static void dso__list_add(struct dso *dso)
433 list_add_tail(&dso->data.open_entry, &dso__data_open);
434 dso__data_open_cnt++;
437 static void dso__list_del(struct dso *dso)
439 list_del_init(&dso->data.open_entry);
440 WARN_ONCE(dso__data_open_cnt <= 0,
441 "DSO data fd counter out of bounds.");
442 dso__data_open_cnt--;
445 static void close_first_dso(void);
447 static int do_open(char *name)
450 char sbuf[STRERR_BUFSIZE];
453 fd = open(name, O_RDONLY|O_CLOEXEC);
457 pr_debug("dso open failed: %s\n",
458 str_error_r(errno, sbuf, sizeof(sbuf)));
459 if (!dso__data_open_cnt || errno != EMFILE)
468 static int __open_dso(struct dso *dso, struct machine *machine)
471 char *root_dir = (char *)"";
472 char *name = malloc(PATH_MAX);
479 root_dir = machine->root_dir;
481 if (dso__read_binary_type_filename(dso, dso->binary_type,
482 root_dir, name, PATH_MAX))
485 if (!is_regular_file(name))
488 if (dso__needs_decompress(dso)) {
489 char newpath[KMOD_DECOMP_LEN];
490 size_t len = sizeof(newpath);
492 if (dso__decompress_kmodule_path(dso, name, newpath, len) < 0) {
493 fd = -dso->load_errno;
498 strcpy(name, newpath);
511 static void check_data_close(void);
514 * dso_close - Open DSO data file
517 * Open @dso's data file descriptor and updates
518 * list/count of open DSO objects.
520 static int open_dso(struct dso *dso, struct machine *machine)
525 if (dso->binary_type != DSO_BINARY_TYPE__BUILD_ID_CACHE)
526 nsinfo__mountns_enter(dso->nsinfo, &nsc);
527 fd = __open_dso(dso, machine);
528 if (dso->binary_type != DSO_BINARY_TYPE__BUILD_ID_CACHE)
529 nsinfo__mountns_exit(&nsc);
534 * Check if we crossed the allowed number
535 * of opened DSOs and close one if needed.
543 static void close_data_fd(struct dso *dso)
545 if (dso->data.fd >= 0) {
548 dso->data.file_size = 0;
554 * dso_close - Close DSO data file
557 * Close @dso's data file descriptor and updates
558 * list/count of open DSO objects.
560 static void close_dso(struct dso *dso)
565 static void close_first_dso(void)
569 dso = list_first_entry(&dso__data_open, struct dso, data.open_entry);
573 static rlim_t get_fd_limit(void)
578 /* Allow half of the current open fd limit. */
579 if (getrlimit(RLIMIT_NOFILE, &l) == 0) {
580 if (l.rlim_cur == RLIM_INFINITY)
583 limit = l.rlim_cur / 2;
585 pr_err("failed to get fd limit\n");
592 static rlim_t fd_limit;
595 * Used only by tests/dso-data.c to reset the environment
596 * for tests. I dont expect we should change this during
599 void reset_fd_limit(void)
604 static bool may_cache_fd(void)
607 fd_limit = get_fd_limit();
609 if (fd_limit == RLIM_INFINITY)
612 return fd_limit > (rlim_t) dso__data_open_cnt;
616 * Check and close LRU dso if we crossed allowed limit
617 * for opened dso file descriptors. The limit is half
618 * of the RLIMIT_NOFILE files opened.
620 static void check_data_close(void)
622 bool cache_fd = may_cache_fd();
629 * dso__data_close - Close DSO data file
632 * External interface to close @dso's data file descriptor.
634 void dso__data_close(struct dso *dso)
636 pthread_mutex_lock(&dso__data_open_lock);
638 pthread_mutex_unlock(&dso__data_open_lock);
641 static void try_to_open_dso(struct dso *dso, struct machine *machine)
643 enum dso_binary_type binary_type_data[] = {
644 DSO_BINARY_TYPE__BUILD_ID_CACHE,
645 DSO_BINARY_TYPE__SYSTEM_PATH_DSO,
646 DSO_BINARY_TYPE__NOT_FOUND,
650 if (dso->data.fd >= 0)
653 if (dso->binary_type != DSO_BINARY_TYPE__NOT_FOUND) {
654 dso->data.fd = open_dso(dso, machine);
659 dso->binary_type = binary_type_data[i++];
661 dso->data.fd = open_dso(dso, machine);
662 if (dso->data.fd >= 0)
665 } while (dso->binary_type != DSO_BINARY_TYPE__NOT_FOUND);
667 if (dso->data.fd >= 0)
668 dso->data.status = DSO_DATA_STATUS_OK;
670 dso->data.status = DSO_DATA_STATUS_ERROR;
674 * dso__data_get_fd - Get dso's data file descriptor
676 * @machine: machine object
678 * External interface to find dso's file, open it and
679 * returns file descriptor. It should be paired with
680 * dso__data_put_fd() if it returns non-negative value.
682 int dso__data_get_fd(struct dso *dso, struct machine *machine)
684 if (dso->data.status == DSO_DATA_STATUS_ERROR)
687 if (pthread_mutex_lock(&dso__data_open_lock) < 0)
690 try_to_open_dso(dso, machine);
692 if (dso->data.fd < 0)
693 pthread_mutex_unlock(&dso__data_open_lock);
698 void dso__data_put_fd(struct dso *dso __maybe_unused)
700 pthread_mutex_unlock(&dso__data_open_lock);
703 bool dso__data_status_seen(struct dso *dso, enum dso_data_status_seen by)
707 if (dso->data.status_seen & flag)
710 dso->data.status_seen |= flag;
715 static ssize_t bpf_read(struct dso *dso, u64 offset, char *data)
717 struct bpf_prog_info_node *node;
718 ssize_t size = DSO__DATA_CACHE_SIZE;
722 node = perf_env__find_bpf_prog_info(dso->bpf_prog.env, dso->bpf_prog.id);
723 if (!node || !node->info_linear) {
724 dso->data.status = DSO_DATA_STATUS_ERROR;
728 len = node->info_linear->info.jited_prog_len;
729 buf = (u8 *)(uintptr_t)node->info_linear->info.jited_prog_insns;
734 size = (ssize_t)min(len - offset, (u64)size);
735 memcpy(data, buf + offset, size);
739 static int bpf_size(struct dso *dso)
741 struct bpf_prog_info_node *node;
743 node = perf_env__find_bpf_prog_info(dso->bpf_prog.env, dso->bpf_prog.id);
744 if (!node || !node->info_linear) {
745 dso->data.status = DSO_DATA_STATUS_ERROR;
749 dso->data.file_size = node->info_linear->info.jited_prog_len;
754 dso_cache__free(struct dso *dso)
756 struct rb_root *root = &dso->data.cache;
757 struct rb_node *next = rb_first(root);
759 pthread_mutex_lock(&dso->lock);
761 struct dso_cache *cache;
763 cache = rb_entry(next, struct dso_cache, rb_node);
764 next = rb_next(&cache->rb_node);
765 rb_erase(&cache->rb_node, root);
768 pthread_mutex_unlock(&dso->lock);
771 static struct dso_cache *__dso_cache__find(struct dso *dso, u64 offset)
773 const struct rb_root *root = &dso->data.cache;
774 struct rb_node * const *p = &root->rb_node;
775 const struct rb_node *parent = NULL;
776 struct dso_cache *cache;
782 cache = rb_entry(parent, struct dso_cache, rb_node);
783 end = cache->offset + DSO__DATA_CACHE_SIZE;
785 if (offset < cache->offset)
787 else if (offset >= end)
796 static struct dso_cache *
797 dso_cache__insert(struct dso *dso, struct dso_cache *new)
799 struct rb_root *root = &dso->data.cache;
800 struct rb_node **p = &root->rb_node;
801 struct rb_node *parent = NULL;
802 struct dso_cache *cache;
803 u64 offset = new->offset;
805 pthread_mutex_lock(&dso->lock);
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)
821 rb_link_node(&new->rb_node, parent, p);
822 rb_insert_color(&new->rb_node, root);
826 pthread_mutex_unlock(&dso->lock);
830 static ssize_t dso_cache__memcpy(struct dso_cache *cache, u64 offset, u8 *data,
833 u64 cache_offset = offset - cache->offset;
834 u64 cache_size = min(cache->size - cache_offset, size);
837 memcpy(data, cache->data + cache_offset, cache_size);
839 memcpy(cache->data + cache_offset, data, cache_size);
843 static ssize_t file_read(struct dso *dso, struct machine *machine,
844 u64 offset, char *data)
848 pthread_mutex_lock(&dso__data_open_lock);
851 * dso->data.fd might be closed if other thread opened another
852 * file (dso) due to open file limit (RLIMIT_NOFILE).
854 try_to_open_dso(dso, machine);
856 if (dso->data.fd < 0) {
857 dso->data.status = DSO_DATA_STATUS_ERROR;
862 ret = pread(dso->data.fd, data, DSO__DATA_CACHE_SIZE, offset);
864 pthread_mutex_unlock(&dso__data_open_lock);
868 static struct dso_cache *dso_cache__populate(struct dso *dso,
869 struct machine *machine,
870 u64 offset, ssize_t *ret)
872 u64 cache_offset = offset & DSO__DATA_CACHE_MASK;
873 struct dso_cache *cache;
874 struct dso_cache *old;
876 cache = zalloc(sizeof(*cache) + DSO__DATA_CACHE_SIZE);
882 if (dso->binary_type == DSO_BINARY_TYPE__BPF_PROG_INFO)
883 *ret = bpf_read(dso, cache_offset, cache->data);
885 *ret = file_read(dso, machine, cache_offset, cache->data);
892 cache->offset = cache_offset;
895 old = dso_cache__insert(dso, cache);
897 /* we lose the race */
905 static struct dso_cache *dso_cache__find(struct dso *dso,
906 struct machine *machine,
910 struct dso_cache *cache = __dso_cache__find(dso, offset);
912 return cache ? cache : dso_cache__populate(dso, machine, offset, ret);
915 static ssize_t dso_cache_io(struct dso *dso, struct machine *machine,
916 u64 offset, u8 *data, ssize_t size, bool out)
918 struct dso_cache *cache;
921 cache = dso_cache__find(dso, machine, offset, &ret);
925 return dso_cache__memcpy(cache, offset, data, size, out);
929 * Reads and caches dso data DSO__DATA_CACHE_SIZE size chunks
930 * in the rb_tree. Any read to already cached data is served
931 * by cached data. Writes update the cache only, not the backing file.
933 static ssize_t cached_io(struct dso *dso, struct machine *machine,
934 u64 offset, u8 *data, ssize_t size, bool out)
942 ret = dso_cache_io(dso, machine, offset, p, size, out);
946 /* Reached EOF, return what we have. */
962 static int file_size(struct dso *dso, struct machine *machine)
966 char sbuf[STRERR_BUFSIZE];
968 pthread_mutex_lock(&dso__data_open_lock);
971 * dso->data.fd might be closed if other thread opened another
972 * file (dso) due to open file limit (RLIMIT_NOFILE).
974 try_to_open_dso(dso, machine);
976 if (dso->data.fd < 0) {
978 dso->data.status = DSO_DATA_STATUS_ERROR;
982 if (fstat(dso->data.fd, &st) < 0) {
984 pr_err("dso cache fstat failed: %s\n",
985 str_error_r(errno, sbuf, sizeof(sbuf)));
986 dso->data.status = DSO_DATA_STATUS_ERROR;
989 dso->data.file_size = st.st_size;
992 pthread_mutex_unlock(&dso__data_open_lock);
996 int dso__data_file_size(struct dso *dso, struct machine *machine)
998 if (dso->data.file_size)
1001 if (dso->data.status == DSO_DATA_STATUS_ERROR)
1004 if (dso->binary_type == DSO_BINARY_TYPE__BPF_PROG_INFO)
1005 return bpf_size(dso);
1007 return file_size(dso, machine);
1011 * dso__data_size - Return dso data size
1013 * @machine: machine object
1015 * Return: dso data size
1017 off_t dso__data_size(struct dso *dso, struct machine *machine)
1019 if (dso__data_file_size(dso, machine))
1022 /* For now just estimate dso data size is close to file size */
1023 return dso->data.file_size;
1026 static ssize_t data_read_write_offset(struct dso *dso, struct machine *machine,
1027 u64 offset, u8 *data, ssize_t size,
1030 if (dso__data_file_size(dso, machine))
1033 /* Check the offset sanity. */
1034 if (offset > dso->data.file_size)
1037 if (offset + size < offset)
1040 return cached_io(dso, machine, offset, data, size, out);
1044 * dso__data_read_offset - Read data from dso file offset
1046 * @machine: machine object
1047 * @offset: file offset
1048 * @data: buffer to store data
1049 * @size: size of the @data buffer
1051 * External interface to read data from dso file offset. Open
1052 * dso data file and use cached_read to get the data.
1054 ssize_t dso__data_read_offset(struct dso *dso, struct machine *machine,
1055 u64 offset, u8 *data, ssize_t size)
1057 if (dso->data.status == DSO_DATA_STATUS_ERROR)
1060 return data_read_write_offset(dso, machine, offset, data, size, true);
1064 * dso__data_read_addr - Read data from dso address
1066 * @machine: machine object
1067 * @add: virtual memory address
1068 * @data: buffer to store data
1069 * @size: size of the @data buffer
1071 * External interface to read data from dso address.
1073 ssize_t dso__data_read_addr(struct dso *dso, struct map *map,
1074 struct machine *machine, u64 addr,
1075 u8 *data, ssize_t size)
1077 u64 offset = map->map_ip(map, addr);
1078 return dso__data_read_offset(dso, machine, offset, data, size);
1082 * dso__data_write_cache_offs - Write data to dso data cache at file offset
1084 * @machine: machine object
1085 * @offset: file offset
1086 * @data: buffer to write
1087 * @size: size of the @data buffer
1089 * Write into the dso file data cache, but do not change the file itself.
1091 ssize_t dso__data_write_cache_offs(struct dso *dso, struct machine *machine,
1092 u64 offset, const u8 *data_in, ssize_t size)
1094 u8 *data = (u8 *)data_in; /* cast away const to use same fns for r/w */
1096 if (dso->data.status == DSO_DATA_STATUS_ERROR)
1099 return data_read_write_offset(dso, machine, offset, data, size, false);
1103 * dso__data_write_cache_addr - Write data to dso data cache at dso address
1105 * @machine: machine object
1106 * @add: virtual memory address
1107 * @data: buffer to write
1108 * @size: size of the @data buffer
1110 * External interface to write into the dso file data cache, but do not change
1113 ssize_t dso__data_write_cache_addr(struct dso *dso, struct map *map,
1114 struct machine *machine, u64 addr,
1115 const u8 *data, ssize_t size)
1117 u64 offset = map->map_ip(map, addr);
1118 return dso__data_write_cache_offs(dso, machine, offset, data, size);
1121 struct map *dso__new_map(const char *name)
1123 struct map *map = NULL;
1124 struct dso *dso = dso__new(name);
1127 map = map__new2(0, dso);
1132 struct dso *machine__findnew_kernel(struct machine *machine, const char *name,
1133 const char *short_name, int dso_type)
1136 * The kernel dso could be created by build_id processing.
1138 struct dso *dso = machine__findnew_dso(machine, name);
1141 * We need to run this in all cases, since during the build_id
1142 * processing we had no idea this was the kernel dso.
1145 dso__set_short_name(dso, short_name, false);
1146 dso->kernel = dso_type;
1152 static void dso__set_long_name_id(struct dso *dso, const char *name, struct dso_id *id, bool name_allocated)
1154 struct rb_root *root = dso->root;
1159 if (dso->long_name_allocated)
1160 free((char *)dso->long_name);
1163 rb_erase(&dso->rb_node, root);
1165 * __dsos__findnew_link_by_longname_id() isn't guaranteed to
1166 * add it back, so a clean removal is required here.
1168 RB_CLEAR_NODE(&dso->rb_node);
1172 dso->long_name = name;
1173 dso->long_name_len = strlen(name);
1174 dso->long_name_allocated = name_allocated;
1177 __dsos__findnew_link_by_longname_id(root, dso, NULL, id);
1180 void dso__set_long_name(struct dso *dso, const char *name, bool name_allocated)
1182 dso__set_long_name_id(dso, name, NULL, name_allocated);
1185 void dso__set_short_name(struct dso *dso, const char *name, bool name_allocated)
1190 if (dso->short_name_allocated)
1191 free((char *)dso->short_name);
1193 dso->short_name = name;
1194 dso->short_name_len = strlen(name);
1195 dso->short_name_allocated = name_allocated;
1198 int dso__name_len(const struct dso *dso)
1201 return strlen("[unknown]");
1203 return dso->long_name_len;
1205 return dso->short_name_len;
1208 bool dso__loaded(const struct dso *dso)
1213 bool dso__sorted_by_name(const struct dso *dso)
1215 return dso->sorted_by_name;
1218 void dso__set_sorted_by_name(struct dso *dso)
1220 dso->sorted_by_name = true;
1223 struct dso *dso__new_id(const char *name, struct dso_id *id)
1225 struct dso *dso = calloc(1, sizeof(*dso) + strlen(name) + 1);
1228 strcpy(dso->name, name);
1231 dso__set_long_name_id(dso, dso->name, id, false);
1232 dso__set_short_name(dso, dso->name, false);
1233 dso->symbols = dso->symbol_names = RB_ROOT_CACHED;
1234 dso->data.cache = RB_ROOT;
1235 dso->inlined_nodes = RB_ROOT_CACHED;
1236 dso->srclines = RB_ROOT_CACHED;
1238 dso->data.status = DSO_DATA_STATUS_UNKNOWN;
1239 dso->symtab_type = DSO_BINARY_TYPE__NOT_FOUND;
1240 dso->binary_type = DSO_BINARY_TYPE__NOT_FOUND;
1241 dso->is_64_bit = (sizeof(void *) == 8);
1244 dso->sorted_by_name = 0;
1245 dso->has_build_id = 0;
1246 dso->has_srcline = 1;
1248 dso->kernel = DSO_TYPE_USER;
1249 dso->needs_swap = DSO_SWAP__UNSET;
1250 dso->comp = COMP_ID__NONE;
1251 RB_CLEAR_NODE(&dso->rb_node);
1253 INIT_LIST_HEAD(&dso->node);
1254 INIT_LIST_HEAD(&dso->data.open_entry);
1255 pthread_mutex_init(&dso->lock, NULL);
1256 refcount_set(&dso->refcnt, 1);
1262 struct dso *dso__new(const char *name)
1264 return dso__new_id(name, NULL);
1267 void dso__delete(struct dso *dso)
1269 if (!RB_EMPTY_NODE(&dso->rb_node))
1270 pr_err("DSO %s is still in rbtree when being deleted!\n",
1273 /* free inlines first, as they reference symbols */
1274 inlines__tree_delete(&dso->inlined_nodes);
1275 srcline__tree_delete(&dso->srclines);
1276 symbols__delete(&dso->symbols);
1278 if (dso->short_name_allocated) {
1279 zfree((char **)&dso->short_name);
1280 dso->short_name_allocated = false;
1283 if (dso->long_name_allocated) {
1284 zfree((char **)&dso->long_name);
1285 dso->long_name_allocated = false;
1288 dso__data_close(dso);
1289 auxtrace_cache__free(dso->auxtrace_cache);
1290 dso_cache__free(dso);
1292 zfree(&dso->symsrc_filename);
1293 nsinfo__zput(dso->nsinfo);
1294 pthread_mutex_destroy(&dso->lock);
1298 struct dso *dso__get(struct dso *dso)
1301 refcount_inc(&dso->refcnt);
1305 void dso__put(struct dso *dso)
1307 if (dso && refcount_dec_and_test(&dso->refcnt))
1311 void dso__set_build_id(struct dso *dso, void *build_id)
1313 memcpy(dso->build_id, build_id, sizeof(dso->build_id));
1314 dso->has_build_id = 1;
1317 bool dso__build_id_equal(const struct dso *dso, u8 *build_id)
1319 return memcmp(dso->build_id, build_id, sizeof(dso->build_id)) == 0;
1322 void dso__read_running_kernel_build_id(struct dso *dso, struct machine *machine)
1324 char path[PATH_MAX];
1326 if (machine__is_default_guest(machine))
1328 sprintf(path, "%s/sys/kernel/notes", machine->root_dir);
1329 if (sysfs__read_build_id(path, dso->build_id,
1330 sizeof(dso->build_id)) == 0)
1331 dso->has_build_id = true;
1334 int dso__kernel_module_get_build_id(struct dso *dso,
1335 const char *root_dir)
1337 char filename[PATH_MAX];
1339 * kernel module short names are of the form "[module]" and
1340 * we need just "module" here.
1342 const char *name = dso->short_name + 1;
1344 snprintf(filename, sizeof(filename),
1345 "%s/sys/module/%.*s/notes/.note.gnu.build-id",
1346 root_dir, (int)strlen(name) - 1, name);
1348 if (sysfs__read_build_id(filename, dso->build_id,
1349 sizeof(dso->build_id)) == 0)
1350 dso->has_build_id = true;
1355 size_t dso__fprintf_buildid(struct dso *dso, FILE *fp)
1357 char sbuild_id[SBUILD_ID_SIZE];
1359 build_id__sprintf(dso->build_id, sizeof(dso->build_id), sbuild_id);
1360 return fprintf(fp, "%s", sbuild_id);
1363 size_t dso__fprintf(struct dso *dso, FILE *fp)
1366 size_t ret = fprintf(fp, "dso: %s (", dso->short_name);
1368 if (dso->short_name != dso->long_name)
1369 ret += fprintf(fp, "%s, ", dso->long_name);
1370 ret += fprintf(fp, "%sloaded, ", dso__loaded(dso) ? "" : "NOT ");
1371 ret += dso__fprintf_buildid(dso, fp);
1372 ret += fprintf(fp, ")\n");
1373 for (nd = rb_first_cached(&dso->symbols); nd; nd = rb_next(nd)) {
1374 struct symbol *pos = rb_entry(nd, struct symbol, rb_node);
1375 ret += symbol__fprintf(pos, fp);
1381 enum dso_type dso__type(struct dso *dso, struct machine *machine)
1384 enum dso_type type = DSO__TYPE_UNKNOWN;
1386 fd = dso__data_get_fd(dso, machine);
1388 type = dso__type_fd(fd);
1389 dso__data_put_fd(dso);
1395 int dso__strerror_load(struct dso *dso, char *buf, size_t buflen)
1397 int idx, errnum = dso->load_errno;
1399 * This must have a same ordering as the enum dso_load_errno.
1401 static const char *dso_load__error_str[] = {
1402 "Internal tools/perf/ library error",
1404 "Can not read build id",
1405 "Mismatching build id",
1406 "Decompression failure",
1409 BUG_ON(buflen == 0);
1412 const char *err = str_error_r(errnum, buf, buflen);
1415 scnprintf(buf, buflen, "%s", err);
1420 if (errnum < __DSO_LOAD_ERRNO__START || errnum >= __DSO_LOAD_ERRNO__END)
1423 idx = errnum - __DSO_LOAD_ERRNO__START;
1424 scnprintf(buf, buflen, "%s", dso_load__error_str[idx]);