1 // SPDX-License-Identifier: GPL-2.0
3 #include <linux/kernel.h>
5 #include <sys/resource.h>
23 static const char * const debuglink_paths
[] = {
30 char dso__symtab_origin(const struct dso
*dso
)
32 static const char origin
[] = {
33 [DSO_BINARY_TYPE__KALLSYMS
] = 'k',
34 [DSO_BINARY_TYPE__VMLINUX
] = 'v',
35 [DSO_BINARY_TYPE__JAVA_JIT
] = 'j',
36 [DSO_BINARY_TYPE__DEBUGLINK
] = 'l',
37 [DSO_BINARY_TYPE__BUILD_ID_CACHE
] = 'B',
38 [DSO_BINARY_TYPE__BUILD_ID_CACHE_DEBUGINFO
] = 'D',
39 [DSO_BINARY_TYPE__FEDORA_DEBUGINFO
] = 'f',
40 [DSO_BINARY_TYPE__UBUNTU_DEBUGINFO
] = 'u',
41 [DSO_BINARY_TYPE__OPENEMBEDDED_DEBUGINFO
] = 'o',
42 [DSO_BINARY_TYPE__BUILDID_DEBUGINFO
] = 'b',
43 [DSO_BINARY_TYPE__SYSTEM_PATH_DSO
] = 'd',
44 [DSO_BINARY_TYPE__SYSTEM_PATH_KMODULE
] = 'K',
45 [DSO_BINARY_TYPE__SYSTEM_PATH_KMODULE_COMP
] = 'm',
46 [DSO_BINARY_TYPE__GUEST_KALLSYMS
] = 'g',
47 [DSO_BINARY_TYPE__GUEST_KMODULE
] = 'G',
48 [DSO_BINARY_TYPE__GUEST_KMODULE_COMP
] = 'M',
49 [DSO_BINARY_TYPE__GUEST_VMLINUX
] = 'V',
52 if (dso
== NULL
|| dso
->symtab_type
== DSO_BINARY_TYPE__NOT_FOUND
)
54 return origin
[dso
->symtab_type
];
57 int dso__read_binary_type_filename(const struct dso
*dso
,
58 enum dso_binary_type type
,
59 char *root_dir
, char *filename
, size_t size
)
61 char build_id_hex
[SBUILD_ID_SIZE
];
66 case DSO_BINARY_TYPE__DEBUGLINK
:
68 const char *last_slash
;
69 char dso_dir
[PATH_MAX
];
70 char symfile
[PATH_MAX
];
73 len
= __symbol__join_symfs(filename
, size
, dso
->long_name
);
74 last_slash
= filename
+ len
;
75 while (last_slash
!= filename
&& *last_slash
!= '/')
78 strncpy(dso_dir
, filename
, last_slash
- filename
);
79 dso_dir
[last_slash
-filename
] = '\0';
81 if (!is_regular_file(filename
)) {
86 ret
= filename__read_debuglink(filename
, symfile
, PATH_MAX
);
90 /* Check predefined locations where debug file might reside */
92 for (i
= 0; i
< ARRAY_SIZE(debuglink_paths
); i
++) {
93 snprintf(filename
, size
,
94 debuglink_paths
[i
], dso_dir
, symfile
);
95 if (is_regular_file(filename
)) {
103 case DSO_BINARY_TYPE__BUILD_ID_CACHE
:
104 if (dso__build_id_filename(dso
, filename
, size
, false) == NULL
)
108 case DSO_BINARY_TYPE__BUILD_ID_CACHE_DEBUGINFO
:
109 if (dso__build_id_filename(dso
, filename
, size
, true) == NULL
)
113 case DSO_BINARY_TYPE__FEDORA_DEBUGINFO
:
114 len
= __symbol__join_symfs(filename
, size
, "/usr/lib/debug");
115 snprintf(filename
+ len
, size
- len
, "%s.debug", dso
->long_name
);
118 case DSO_BINARY_TYPE__UBUNTU_DEBUGINFO
:
119 len
= __symbol__join_symfs(filename
, size
, "/usr/lib/debug");
120 snprintf(filename
+ len
, size
- len
, "%s", dso
->long_name
);
123 case DSO_BINARY_TYPE__OPENEMBEDDED_DEBUGINFO
:
125 const char *last_slash
;
128 last_slash
= dso
->long_name
+ dso
->long_name_len
;
129 while (last_slash
!= dso
->long_name
&& *last_slash
!= '/')
132 len
= __symbol__join_symfs(filename
, size
, "");
133 dir_size
= last_slash
- dso
->long_name
+ 2;
134 if (dir_size
> (size
- len
)) {
138 len
+= scnprintf(filename
+ len
, dir_size
, "%s", dso
->long_name
);
139 len
+= scnprintf(filename
+ len
, size
- len
, ".debug%s",
144 case DSO_BINARY_TYPE__BUILDID_DEBUGINFO
:
145 if (!dso
->has_build_id
) {
150 build_id__sprintf(dso
->build_id
,
151 sizeof(dso
->build_id
),
153 len
= __symbol__join_symfs(filename
, size
, "/usr/lib/debug/.build-id/");
154 snprintf(filename
+ len
, size
- len
, "%.2s/%s.debug",
155 build_id_hex
, build_id_hex
+ 2);
158 case DSO_BINARY_TYPE__VMLINUX
:
159 case DSO_BINARY_TYPE__GUEST_VMLINUX
:
160 case DSO_BINARY_TYPE__SYSTEM_PATH_DSO
:
161 __symbol__join_symfs(filename
, size
, dso
->long_name
);
164 case DSO_BINARY_TYPE__GUEST_KMODULE
:
165 case DSO_BINARY_TYPE__GUEST_KMODULE_COMP
:
166 path__join3(filename
, size
, symbol_conf
.symfs
,
167 root_dir
, dso
->long_name
);
170 case DSO_BINARY_TYPE__SYSTEM_PATH_KMODULE
:
171 case DSO_BINARY_TYPE__SYSTEM_PATH_KMODULE_COMP
:
172 __symbol__join_symfs(filename
, size
, dso
->long_name
);
175 case DSO_BINARY_TYPE__KCORE
:
176 case DSO_BINARY_TYPE__GUEST_KCORE
:
177 snprintf(filename
, size
, "%s", dso
->long_name
);
181 case DSO_BINARY_TYPE__KALLSYMS
:
182 case DSO_BINARY_TYPE__GUEST_KALLSYMS
:
183 case DSO_BINARY_TYPE__JAVA_JIT
:
184 case DSO_BINARY_TYPE__NOT_FOUND
:
192 static const struct {
194 int (*decompress
)(const char *input
, int output
);
196 #ifdef HAVE_ZLIB_SUPPORT
197 { "gz", gzip_decompress_to_file
},
199 #ifdef HAVE_LZMA_SUPPORT
200 { "xz", lzma_decompress_to_file
},
205 bool is_supported_compression(const char *ext
)
209 for (i
= 0; compressions
[i
].fmt
; i
++) {
210 if (!strcmp(ext
, compressions
[i
].fmt
))
216 bool is_kernel_module(const char *pathname
, int cpumode
)
219 int mode
= cpumode
& PERF_RECORD_MISC_CPUMODE_MASK
;
221 WARN_ONCE(mode
!= cpumode
,
222 "Internal error: passing unmasked cpumode (%x) to is_kernel_module",
226 case PERF_RECORD_MISC_USER
:
227 case PERF_RECORD_MISC_HYPERVISOR
:
228 case PERF_RECORD_MISC_GUEST_USER
:
230 /* Treat PERF_RECORD_MISC_CPUMODE_UNKNOWN as kernel */
232 if (kmod_path__parse(&m
, pathname
)) {
233 pr_err("Failed to check whether %s is a kernel module or not. Assume it is.",
242 bool decompress_to_file(const char *ext
, const char *filename
, int output_fd
)
246 for (i
= 0; compressions
[i
].fmt
; i
++) {
247 if (!strcmp(ext
, compressions
[i
].fmt
))
248 return !compressions
[i
].decompress(filename
,
254 bool dso__needs_decompress(struct dso
*dso
)
256 return dso
->symtab_type
== DSO_BINARY_TYPE__SYSTEM_PATH_KMODULE_COMP
||
257 dso
->symtab_type
== DSO_BINARY_TYPE__GUEST_KMODULE_COMP
;
260 static int decompress_kmodule(struct dso
*dso
, const char *name
, char *tmpbuf
)
265 if (!dso__needs_decompress(dso
))
268 if (kmod_path__parse_ext(&m
, dso
->long_name
))
274 fd
= mkstemp(tmpbuf
);
276 dso
->load_errno
= errno
;
280 if (!decompress_to_file(m
.ext
, name
, fd
)) {
281 dso
->load_errno
= DSO_LOAD_ERRNO__DECOMPRESSION_FAILURE
;
291 int dso__decompress_kmodule_fd(struct dso
*dso
, const char *name
)
293 char tmpbuf
[] = KMOD_DECOMP_NAME
;
296 fd
= decompress_kmodule(dso
, name
, tmpbuf
);
301 int dso__decompress_kmodule_path(struct dso
*dso
, const char *name
,
302 char *pathname
, size_t len
)
304 char tmpbuf
[] = KMOD_DECOMP_NAME
;
307 fd
= decompress_kmodule(dso
, name
, tmpbuf
);
313 strncpy(pathname
, tmpbuf
, len
);
319 * Parses kernel module specified in @path and updates
322 * @comp - true if @path contains supported compression suffix,
324 * @kmod - true if @path contains '.ko' suffix in right position,
326 * @name - if (@alloc_name && @kmod) is true, it contains strdup-ed base name
327 * of the kernel module without suffixes, otherwise strudup-ed
329 * @ext - if (@alloc_ext && @comp) is true, it contains strdup-ed string
330 * the compression suffix
332 * Returns 0 if there's no strdup error, -ENOMEM otherwise.
334 int __kmod_path__parse(struct kmod_path
*m
, const char *path
,
335 bool alloc_name
, bool alloc_ext
)
337 const char *name
= strrchr(path
, '/');
338 const char *ext
= strrchr(path
, '.');
339 bool is_simple_name
= false;
341 memset(m
, 0x0, sizeof(*m
));
342 name
= name
? name
+ 1 : path
;
345 * '.' is also a valid character for module name. For example:
346 * [aaa.bbb] is a valid module name. '[' should have higher
347 * priority than '.ko' suffix.
349 * The kernel names are from machine__mmap_name. Such
350 * name should belong to kernel itself, not kernel module.
352 if (name
[0] == '[') {
353 is_simple_name
= true;
354 if ((strncmp(name
, "[kernel.kallsyms]", 17) == 0) ||
355 (strncmp(name
, "[guest.kernel.kallsyms", 22) == 0) ||
356 (strncmp(name
, "[vdso]", 6) == 0) ||
357 (strncmp(name
, "[vsyscall]", 10) == 0)) {
364 /* No extension, just return name. */
365 if ((ext
== NULL
) || is_simple_name
) {
367 m
->name
= strdup(name
);
368 return m
->name
? 0 : -ENOMEM
;
373 if (is_supported_compression(ext
+ 1)) {
378 /* Check .ko extension only if there's enough name left. */
380 m
->kmod
= !strncmp(ext
, ".ko", 3);
384 if (asprintf(&m
->name
, "[%.*s]", (int) (ext
- name
), name
) == -1)
387 if (asprintf(&m
->name
, "%s", name
) == -1)
391 strxfrchar(m
->name
, '-', '_');
394 if (alloc_ext
&& m
->comp
) {
395 m
->ext
= strdup(ext
+ 4);
397 free((void *) m
->name
);
405 void dso__set_module_info(struct dso
*dso
, struct kmod_path
*m
,
406 struct machine
*machine
)
408 if (machine__is_host(machine
))
409 dso
->symtab_type
= DSO_BINARY_TYPE__SYSTEM_PATH_KMODULE
;
411 dso
->symtab_type
= DSO_BINARY_TYPE__GUEST_KMODULE
;
413 /* _KMODULE_COMP should be next to _KMODULE */
414 if (m
->kmod
&& m
->comp
)
417 dso__set_short_name(dso
, strdup(m
->name
), true);
421 * Global list of open DSOs and the counter.
423 static LIST_HEAD(dso__data_open
);
424 static long dso__data_open_cnt
;
425 static pthread_mutex_t dso__data_open_lock
= PTHREAD_MUTEX_INITIALIZER
;
427 static void dso__list_add(struct dso
*dso
)
429 list_add_tail(&dso
->data
.open_entry
, &dso__data_open
);
430 dso__data_open_cnt
++;
433 static void dso__list_del(struct dso
*dso
)
435 list_del(&dso
->data
.open_entry
);
436 WARN_ONCE(dso__data_open_cnt
<= 0,
437 "DSO data fd counter out of bounds.");
438 dso__data_open_cnt
--;
441 static void close_first_dso(void);
443 static int do_open(char *name
)
446 char sbuf
[STRERR_BUFSIZE
];
449 fd
= open(name
, O_RDONLY
|O_CLOEXEC
);
453 pr_debug("dso open failed: %s\n",
454 str_error_r(errno
, sbuf
, sizeof(sbuf
)));
455 if (!dso__data_open_cnt
|| errno
!= EMFILE
)
464 static int __open_dso(struct dso
*dso
, struct machine
*machine
)
467 char *root_dir
= (char *)"";
468 char *name
= malloc(PATH_MAX
);
474 root_dir
= machine
->root_dir
;
476 if (dso__read_binary_type_filename(dso
, dso
->binary_type
,
477 root_dir
, name
, PATH_MAX
))
480 if (!is_regular_file(name
))
483 if (dso__needs_decompress(dso
)) {
484 char newpath
[KMOD_DECOMP_LEN
];
485 size_t len
= sizeof(newpath
);
487 if (dso__decompress_kmodule_path(dso
, name
, newpath
, len
) < 0) {
488 fd
= -dso
->load_errno
;
492 strcpy(name
, newpath
);
497 if (dso__needs_decompress(dso
))
505 static void check_data_close(void);
508 * dso_close - Open DSO data file
511 * Open @dso's data file descriptor and updates
512 * list/count of open DSO objects.
514 static int open_dso(struct dso
*dso
, struct machine
*machine
)
519 if (dso
->binary_type
!= DSO_BINARY_TYPE__BUILD_ID_CACHE
)
520 nsinfo__mountns_enter(dso
->nsinfo
, &nsc
);
521 fd
= __open_dso(dso
, machine
);
522 if (dso
->binary_type
!= DSO_BINARY_TYPE__BUILD_ID_CACHE
)
523 nsinfo__mountns_exit(&nsc
);
528 * Check if we crossed the allowed number
529 * of opened DSOs and close one if needed.
537 static void close_data_fd(struct dso
*dso
)
539 if (dso
->data
.fd
>= 0) {
542 dso
->data
.file_size
= 0;
548 * dso_close - Close DSO data file
551 * Close @dso's data file descriptor and updates
552 * list/count of open DSO objects.
554 static void close_dso(struct dso
*dso
)
559 static void close_first_dso(void)
563 dso
= list_first_entry(&dso__data_open
, struct dso
, data
.open_entry
);
567 static rlim_t
get_fd_limit(void)
572 /* Allow half of the current open fd limit. */
573 if (getrlimit(RLIMIT_NOFILE
, &l
) == 0) {
574 if (l
.rlim_cur
== RLIM_INFINITY
)
577 limit
= l
.rlim_cur
/ 2;
579 pr_err("failed to get fd limit\n");
586 static rlim_t fd_limit
;
589 * Used only by tests/dso-data.c to reset the environment
590 * for tests. I dont expect we should change this during
593 void reset_fd_limit(void)
598 static bool may_cache_fd(void)
601 fd_limit
= get_fd_limit();
603 if (fd_limit
== RLIM_INFINITY
)
606 return fd_limit
> (rlim_t
) dso__data_open_cnt
;
610 * Check and close LRU dso if we crossed allowed limit
611 * for opened dso file descriptors. The limit is half
612 * of the RLIMIT_NOFILE files opened.
614 static void check_data_close(void)
616 bool cache_fd
= may_cache_fd();
623 * dso__data_close - Close DSO data file
626 * External interface to close @dso's data file descriptor.
628 void dso__data_close(struct dso
*dso
)
630 pthread_mutex_lock(&dso__data_open_lock
);
632 pthread_mutex_unlock(&dso__data_open_lock
);
635 static void try_to_open_dso(struct dso
*dso
, struct machine
*machine
)
637 enum dso_binary_type binary_type_data
[] = {
638 DSO_BINARY_TYPE__BUILD_ID_CACHE
,
639 DSO_BINARY_TYPE__SYSTEM_PATH_DSO
,
640 DSO_BINARY_TYPE__NOT_FOUND
,
644 if (dso
->data
.fd
>= 0)
647 if (dso
->binary_type
!= DSO_BINARY_TYPE__NOT_FOUND
) {
648 dso
->data
.fd
= open_dso(dso
, machine
);
653 dso
->binary_type
= binary_type_data
[i
++];
655 dso
->data
.fd
= open_dso(dso
, machine
);
656 if (dso
->data
.fd
>= 0)
659 } while (dso
->binary_type
!= DSO_BINARY_TYPE__NOT_FOUND
);
661 if (dso
->data
.fd
>= 0)
662 dso
->data
.status
= DSO_DATA_STATUS_OK
;
664 dso
->data
.status
= DSO_DATA_STATUS_ERROR
;
668 * dso__data_get_fd - Get dso's data file descriptor
670 * @machine: machine object
672 * External interface to find dso's file, open it and
673 * returns file descriptor. It should be paired with
674 * dso__data_put_fd() if it returns non-negative value.
676 int dso__data_get_fd(struct dso
*dso
, struct machine
*machine
)
678 if (dso
->data
.status
== DSO_DATA_STATUS_ERROR
)
681 if (pthread_mutex_lock(&dso__data_open_lock
) < 0)
684 try_to_open_dso(dso
, machine
);
686 if (dso
->data
.fd
< 0)
687 pthread_mutex_unlock(&dso__data_open_lock
);
692 void dso__data_put_fd(struct dso
*dso __maybe_unused
)
694 pthread_mutex_unlock(&dso__data_open_lock
);
697 bool dso__data_status_seen(struct dso
*dso
, enum dso_data_status_seen by
)
701 if (dso
->data
.status_seen
& flag
)
704 dso
->data
.status_seen
|= flag
;
710 dso_cache__free(struct dso
*dso
)
712 struct rb_root
*root
= &dso
->data
.cache
;
713 struct rb_node
*next
= rb_first(root
);
715 pthread_mutex_lock(&dso
->lock
);
717 struct dso_cache
*cache
;
719 cache
= rb_entry(next
, struct dso_cache
, rb_node
);
720 next
= rb_next(&cache
->rb_node
);
721 rb_erase(&cache
->rb_node
, root
);
724 pthread_mutex_unlock(&dso
->lock
);
727 static struct dso_cache
*dso_cache__find(struct dso
*dso
, u64 offset
)
729 const struct rb_root
*root
= &dso
->data
.cache
;
730 struct rb_node
* const *p
= &root
->rb_node
;
731 const struct rb_node
*parent
= NULL
;
732 struct dso_cache
*cache
;
738 cache
= rb_entry(parent
, struct dso_cache
, rb_node
);
739 end
= cache
->offset
+ DSO__DATA_CACHE_SIZE
;
741 if (offset
< cache
->offset
)
743 else if (offset
>= end
)
752 static struct dso_cache
*
753 dso_cache__insert(struct dso
*dso
, struct dso_cache
*new)
755 struct rb_root
*root
= &dso
->data
.cache
;
756 struct rb_node
**p
= &root
->rb_node
;
757 struct rb_node
*parent
= NULL
;
758 struct dso_cache
*cache
;
759 u64 offset
= new->offset
;
761 pthread_mutex_lock(&dso
->lock
);
766 cache
= rb_entry(parent
, struct dso_cache
, rb_node
);
767 end
= cache
->offset
+ DSO__DATA_CACHE_SIZE
;
769 if (offset
< cache
->offset
)
771 else if (offset
>= end
)
777 rb_link_node(&new->rb_node
, parent
, p
);
778 rb_insert_color(&new->rb_node
, root
);
782 pthread_mutex_unlock(&dso
->lock
);
787 dso_cache__memcpy(struct dso_cache
*cache
, u64 offset
,
790 u64 cache_offset
= offset
- cache
->offset
;
791 u64 cache_size
= min(cache
->size
- cache_offset
, size
);
793 memcpy(data
, cache
->data
+ cache_offset
, cache_size
);
798 dso_cache__read(struct dso
*dso
, struct machine
*machine
,
799 u64 offset
, u8
*data
, ssize_t size
)
801 struct dso_cache
*cache
;
802 struct dso_cache
*old
;
808 cache
= zalloc(sizeof(*cache
) + DSO__DATA_CACHE_SIZE
);
812 pthread_mutex_lock(&dso__data_open_lock
);
815 * dso->data.fd might be closed if other thread opened another
816 * file (dso) due to open file limit (RLIMIT_NOFILE).
818 try_to_open_dso(dso
, machine
);
820 if (dso
->data
.fd
< 0) {
822 dso
->data
.status
= DSO_DATA_STATUS_ERROR
;
826 cache_offset
= offset
& DSO__DATA_CACHE_MASK
;
828 ret
= pread(dso
->data
.fd
, cache
->data
, DSO__DATA_CACHE_SIZE
, cache_offset
);
832 cache
->offset
= cache_offset
;
836 pthread_mutex_unlock(&dso__data_open_lock
);
839 old
= dso_cache__insert(dso
, cache
);
841 /* we lose the race */
846 ret
= dso_cache__memcpy(cache
, offset
, data
, size
);
855 static ssize_t
dso_cache_read(struct dso
*dso
, struct machine
*machine
,
856 u64 offset
, u8
*data
, ssize_t size
)
858 struct dso_cache
*cache
;
860 cache
= dso_cache__find(dso
, offset
);
862 return dso_cache__memcpy(cache
, offset
, data
, size
);
864 return dso_cache__read(dso
, machine
, offset
, data
, size
);
868 * Reads and caches dso data DSO__DATA_CACHE_SIZE size chunks
869 * in the rb_tree. Any read to already cached data is served
872 static ssize_t
cached_read(struct dso
*dso
, struct machine
*machine
,
873 u64 offset
, u8
*data
, ssize_t size
)
881 ret
= dso_cache_read(dso
, machine
, offset
, p
, size
);
885 /* Reached EOF, return what we have. */
901 static int data_file_size(struct dso
*dso
, struct machine
*machine
)
905 char sbuf
[STRERR_BUFSIZE
];
907 if (dso
->data
.file_size
)
910 if (dso
->data
.status
== DSO_DATA_STATUS_ERROR
)
913 pthread_mutex_lock(&dso__data_open_lock
);
916 * dso->data.fd might be closed if other thread opened another
917 * file (dso) due to open file limit (RLIMIT_NOFILE).
919 try_to_open_dso(dso
, machine
);
921 if (dso
->data
.fd
< 0) {
923 dso
->data
.status
= DSO_DATA_STATUS_ERROR
;
927 if (fstat(dso
->data
.fd
, &st
) < 0) {
929 pr_err("dso cache fstat failed: %s\n",
930 str_error_r(errno
, sbuf
, sizeof(sbuf
)));
931 dso
->data
.status
= DSO_DATA_STATUS_ERROR
;
934 dso
->data
.file_size
= st
.st_size
;
937 pthread_mutex_unlock(&dso__data_open_lock
);
942 * dso__data_size - Return dso data size
944 * @machine: machine object
946 * Return: dso data size
948 off_t
dso__data_size(struct dso
*dso
, struct machine
*machine
)
950 if (data_file_size(dso
, machine
))
953 /* For now just estimate dso data size is close to file size */
954 return dso
->data
.file_size
;
957 static ssize_t
data_read_offset(struct dso
*dso
, struct machine
*machine
,
958 u64 offset
, u8
*data
, ssize_t size
)
960 if (data_file_size(dso
, machine
))
963 /* Check the offset sanity. */
964 if (offset
> dso
->data
.file_size
)
967 if (offset
+ size
< offset
)
970 return cached_read(dso
, machine
, offset
, data
, size
);
974 * dso__data_read_offset - Read data from dso file offset
976 * @machine: machine object
977 * @offset: file offset
978 * @data: buffer to store data
979 * @size: size of the @data buffer
981 * External interface to read data from dso file offset. Open
982 * dso data file and use cached_read to get the data.
984 ssize_t
dso__data_read_offset(struct dso
*dso
, struct machine
*machine
,
985 u64 offset
, u8
*data
, ssize_t size
)
987 if (dso
->data
.status
== DSO_DATA_STATUS_ERROR
)
990 return data_read_offset(dso
, machine
, offset
, data
, size
);
994 * dso__data_read_addr - Read data from dso address
996 * @machine: machine object
997 * @add: virtual memory address
998 * @data: buffer to store data
999 * @size: size of the @data buffer
1001 * External interface to read data from dso address.
1003 ssize_t
dso__data_read_addr(struct dso
*dso
, struct map
*map
,
1004 struct machine
*machine
, u64 addr
,
1005 u8
*data
, ssize_t size
)
1007 u64 offset
= map
->map_ip(map
, addr
);
1008 return dso__data_read_offset(dso
, machine
, offset
, data
, size
);
1011 struct map
*dso__new_map(const char *name
)
1013 struct map
*map
= NULL
;
1014 struct dso
*dso
= dso__new(name
);
1017 map
= map__new2(0, dso
, MAP__FUNCTION
);
1022 struct dso
*machine__findnew_kernel(struct machine
*machine
, const char *name
,
1023 const char *short_name
, int dso_type
)
1026 * The kernel dso could be created by build_id processing.
1028 struct dso
*dso
= machine__findnew_dso(machine
, name
);
1031 * We need to run this in all cases, since during the build_id
1032 * processing we had no idea this was the kernel dso.
1035 dso__set_short_name(dso
, short_name
, false);
1036 dso
->kernel
= dso_type
;
1043 * Find a matching entry and/or link current entry to RB tree.
1044 * Either one of the dso or name parameter must be non-NULL or the
1045 * function will not work.
1047 static struct dso
*__dso__findlink_by_longname(struct rb_root
*root
,
1048 struct dso
*dso
, const char *name
)
1050 struct rb_node
**p
= &root
->rb_node
;
1051 struct rb_node
*parent
= NULL
;
1054 name
= dso
->long_name
;
1056 * Find node with the matching name
1059 struct dso
*this = rb_entry(*p
, struct dso
, rb_node
);
1060 int rc
= strcmp(name
, this->long_name
);
1065 * In case the new DSO is a duplicate of an existing
1066 * one, print a one-time warning & put the new entry
1067 * at the end of the list of duplicates.
1069 if (!dso
|| (dso
== this))
1070 return this; /* Find matching dso */
1072 * The core kernel DSOs may have duplicated long name.
1073 * In this case, the short name should be different.
1074 * Comparing the short names to differentiate the DSOs.
1076 rc
= strcmp(dso
->short_name
, this->short_name
);
1078 pr_err("Duplicated dso name: %s\n", name
);
1083 p
= &parent
->rb_left
;
1085 p
= &parent
->rb_right
;
1088 /* Add new node and rebalance tree */
1089 rb_link_node(&dso
->rb_node
, parent
, p
);
1090 rb_insert_color(&dso
->rb_node
, root
);
1096 static inline struct dso
*__dso__find_by_longname(struct rb_root
*root
,
1099 return __dso__findlink_by_longname(root
, NULL
, name
);
1102 void dso__set_long_name(struct dso
*dso
, const char *name
, bool name_allocated
)
1104 struct rb_root
*root
= dso
->root
;
1109 if (dso
->long_name_allocated
)
1110 free((char *)dso
->long_name
);
1113 rb_erase(&dso
->rb_node
, root
);
1115 * __dso__findlink_by_longname() isn't guaranteed to add it
1116 * back, so a clean removal is required here.
1118 RB_CLEAR_NODE(&dso
->rb_node
);
1122 dso
->long_name
= name
;
1123 dso
->long_name_len
= strlen(name
);
1124 dso
->long_name_allocated
= name_allocated
;
1127 __dso__findlink_by_longname(root
, dso
, NULL
);
1130 void dso__set_short_name(struct dso
*dso
, const char *name
, bool name_allocated
)
1135 if (dso
->short_name_allocated
)
1136 free((char *)dso
->short_name
);
1138 dso
->short_name
= name
;
1139 dso
->short_name_len
= strlen(name
);
1140 dso
->short_name_allocated
= name_allocated
;
1143 static void dso__set_basename(struct dso
*dso
)
1146 * basename() may modify path buffer, so we must pass
1149 char *base
, *lname
= strdup(dso
->long_name
);
1155 * basename() may return a pointer to internal
1156 * storage which is reused in subsequent calls
1157 * so copy the result.
1159 base
= strdup(basename(lname
));
1166 dso__set_short_name(dso
, base
, true);
1169 int dso__name_len(const struct dso
*dso
)
1172 return strlen("[unknown]");
1174 return dso
->long_name_len
;
1176 return dso
->short_name_len
;
1179 bool dso__loaded(const struct dso
*dso
, enum map_type type
)
1181 return dso
->loaded
& (1 << type
);
1184 bool dso__sorted_by_name(const struct dso
*dso
, enum map_type type
)
1186 return dso
->sorted_by_name
& (1 << type
);
1189 void dso__set_sorted_by_name(struct dso
*dso
, enum map_type type
)
1191 dso
->sorted_by_name
|= (1 << type
);
1194 struct dso
*dso__new(const char *name
)
1196 struct dso
*dso
= calloc(1, sizeof(*dso
) + strlen(name
) + 1);
1200 strcpy(dso
->name
, name
);
1201 dso__set_long_name(dso
, dso
->name
, false);
1202 dso__set_short_name(dso
, dso
->name
, false);
1203 for (i
= 0; i
< MAP__NR_TYPES
; ++i
)
1204 dso
->symbols
[i
] = dso
->symbol_names
[i
] = RB_ROOT
;
1205 dso
->data
.cache
= RB_ROOT
;
1206 dso
->inlined_nodes
= RB_ROOT
;
1207 dso
->srclines
= RB_ROOT
;
1209 dso
->data
.status
= DSO_DATA_STATUS_UNKNOWN
;
1210 dso
->symtab_type
= DSO_BINARY_TYPE__NOT_FOUND
;
1211 dso
->binary_type
= DSO_BINARY_TYPE__NOT_FOUND
;
1212 dso
->is_64_bit
= (sizeof(void *) == 8);
1215 dso
->sorted_by_name
= 0;
1216 dso
->has_build_id
= 0;
1217 dso
->has_srcline
= 1;
1219 dso
->kernel
= DSO_TYPE_USER
;
1220 dso
->needs_swap
= DSO_SWAP__UNSET
;
1221 RB_CLEAR_NODE(&dso
->rb_node
);
1223 INIT_LIST_HEAD(&dso
->node
);
1224 INIT_LIST_HEAD(&dso
->data
.open_entry
);
1225 pthread_mutex_init(&dso
->lock
, NULL
);
1226 refcount_set(&dso
->refcnt
, 1);
1232 void dso__delete(struct dso
*dso
)
1236 if (!RB_EMPTY_NODE(&dso
->rb_node
))
1237 pr_err("DSO %s is still in rbtree when being deleted!\n",
1240 /* free inlines first, as they reference symbols */
1241 inlines__tree_delete(&dso
->inlined_nodes
);
1242 srcline__tree_delete(&dso
->srclines
);
1243 for (i
= 0; i
< MAP__NR_TYPES
; ++i
)
1244 symbols__delete(&dso
->symbols
[i
]);
1246 if (dso
->short_name_allocated
) {
1247 zfree((char **)&dso
->short_name
);
1248 dso
->short_name_allocated
= false;
1251 if (dso
->long_name_allocated
) {
1252 zfree((char **)&dso
->long_name
);
1253 dso
->long_name_allocated
= false;
1256 dso__data_close(dso
);
1257 auxtrace_cache__free(dso
->auxtrace_cache
);
1258 dso_cache__free(dso
);
1260 zfree(&dso
->symsrc_filename
);
1261 nsinfo__zput(dso
->nsinfo
);
1262 pthread_mutex_destroy(&dso
->lock
);
1266 struct dso
*dso__get(struct dso
*dso
)
1269 refcount_inc(&dso
->refcnt
);
1273 void dso__put(struct dso
*dso
)
1275 if (dso
&& refcount_dec_and_test(&dso
->refcnt
))
1279 void dso__set_build_id(struct dso
*dso
, void *build_id
)
1281 memcpy(dso
->build_id
, build_id
, sizeof(dso
->build_id
));
1282 dso
->has_build_id
= 1;
1285 bool dso__build_id_equal(const struct dso
*dso
, u8
*build_id
)
1287 return memcmp(dso
->build_id
, build_id
, sizeof(dso
->build_id
)) == 0;
1290 void dso__read_running_kernel_build_id(struct dso
*dso
, struct machine
*machine
)
1292 char path
[PATH_MAX
];
1294 if (machine__is_default_guest(machine
))
1296 sprintf(path
, "%s/sys/kernel/notes", machine
->root_dir
);
1297 if (sysfs__read_build_id(path
, dso
->build_id
,
1298 sizeof(dso
->build_id
)) == 0)
1299 dso
->has_build_id
= true;
1302 int dso__kernel_module_get_build_id(struct dso
*dso
,
1303 const char *root_dir
)
1305 char filename
[PATH_MAX
];
1307 * kernel module short names are of the form "[module]" and
1308 * we need just "module" here.
1310 const char *name
= dso
->short_name
+ 1;
1312 snprintf(filename
, sizeof(filename
),
1313 "%s/sys/module/%.*s/notes/.note.gnu.build-id",
1314 root_dir
, (int)strlen(name
) - 1, name
);
1316 if (sysfs__read_build_id(filename
, dso
->build_id
,
1317 sizeof(dso
->build_id
)) == 0)
1318 dso
->has_build_id
= true;
1323 bool __dsos__read_build_ids(struct list_head
*head
, bool with_hits
)
1325 bool have_build_id
= false;
1327 struct nscookie nsc
;
1329 list_for_each_entry(pos
, head
, node
) {
1330 if (with_hits
&& !pos
->hit
&& !dso__is_vdso(pos
))
1332 if (pos
->has_build_id
) {
1333 have_build_id
= true;
1336 nsinfo__mountns_enter(pos
->nsinfo
, &nsc
);
1337 if (filename__read_build_id(pos
->long_name
, pos
->build_id
,
1338 sizeof(pos
->build_id
)) > 0) {
1339 have_build_id
= true;
1340 pos
->has_build_id
= true;
1342 nsinfo__mountns_exit(&nsc
);
1345 return have_build_id
;
1348 void __dsos__add(struct dsos
*dsos
, struct dso
*dso
)
1350 list_add_tail(&dso
->node
, &dsos
->head
);
1351 __dso__findlink_by_longname(&dsos
->root
, dso
, NULL
);
1353 * It is now in the linked list, grab a reference, then garbage collect
1354 * this when needing memory, by looking at LRU dso instances in the
1355 * list with atomic_read(&dso->refcnt) == 1, i.e. no references
1356 * anywhere besides the one for the list, do, under a lock for the
1357 * list: remove it from the list, then a dso__put(), that probably will
1358 * be the last and will then call dso__delete(), end of life.
1360 * That, or at the end of the 'struct machine' lifetime, when all
1361 * 'struct dso' instances will be removed from the list, in
1362 * dsos__exit(), if they have no other reference from some other data
1365 * E.g.: after processing a 'perf.data' file and storing references
1366 * to objects instantiated while processing events, we will have
1367 * references to the 'thread', 'map', 'dso' structs all from 'struct
1368 * hist_entry' instances, but we may not need anything not referenced,
1369 * so we might as well call machines__exit()/machines__delete() and
1370 * garbage collect it.
1375 void dsos__add(struct dsos
*dsos
, struct dso
*dso
)
1377 down_write(&dsos
->lock
);
1378 __dsos__add(dsos
, dso
);
1379 up_write(&dsos
->lock
);
1382 struct dso
*__dsos__find(struct dsos
*dsos
, const char *name
, bool cmp_short
)
1387 list_for_each_entry(pos
, &dsos
->head
, node
)
1388 if (strcmp(pos
->short_name
, name
) == 0)
1392 return __dso__find_by_longname(&dsos
->root
, name
);
1395 struct dso
*dsos__find(struct dsos
*dsos
, const char *name
, bool cmp_short
)
1398 down_read(&dsos
->lock
);
1399 dso
= __dsos__find(dsos
, name
, cmp_short
);
1400 up_read(&dsos
->lock
);
1404 struct dso
*__dsos__addnew(struct dsos
*dsos
, const char *name
)
1406 struct dso
*dso
= dso__new(name
);
1409 __dsos__add(dsos
, dso
);
1410 dso__set_basename(dso
);
1411 /* Put dso here because __dsos_add already got it */
1417 struct dso
*__dsos__findnew(struct dsos
*dsos
, const char *name
)
1419 struct dso
*dso
= __dsos__find(dsos
, name
, false);
1421 return dso
? dso
: __dsos__addnew(dsos
, name
);
1424 struct dso
*dsos__findnew(struct dsos
*dsos
, const char *name
)
1427 down_write(&dsos
->lock
);
1428 dso
= dso__get(__dsos__findnew(dsos
, name
));
1429 up_write(&dsos
->lock
);
1433 size_t __dsos__fprintf_buildid(struct list_head
*head
, FILE *fp
,
1434 bool (skip
)(struct dso
*dso
, int parm
), int parm
)
1439 list_for_each_entry(pos
, head
, node
) {
1440 if (skip
&& skip(pos
, parm
))
1442 ret
+= dso__fprintf_buildid(pos
, fp
);
1443 ret
+= fprintf(fp
, " %s\n", pos
->long_name
);
1448 size_t __dsos__fprintf(struct list_head
*head
, FILE *fp
)
1453 list_for_each_entry(pos
, head
, node
) {
1455 for (i
= 0; i
< MAP__NR_TYPES
; ++i
)
1456 ret
+= dso__fprintf(pos
, i
, fp
);
1462 size_t dso__fprintf_buildid(struct dso
*dso
, FILE *fp
)
1464 char sbuild_id
[SBUILD_ID_SIZE
];
1466 build_id__sprintf(dso
->build_id
, sizeof(dso
->build_id
), sbuild_id
);
1467 return fprintf(fp
, "%s", sbuild_id
);
1470 size_t dso__fprintf(struct dso
*dso
, enum map_type type
, FILE *fp
)
1473 size_t ret
= fprintf(fp
, "dso: %s (", dso
->short_name
);
1475 if (dso
->short_name
!= dso
->long_name
)
1476 ret
+= fprintf(fp
, "%s, ", dso
->long_name
);
1477 ret
+= fprintf(fp
, "%s, %sloaded, ", map_type__name
[type
],
1478 dso__loaded(dso
, type
) ? "" : "NOT ");
1479 ret
+= dso__fprintf_buildid(dso
, fp
);
1480 ret
+= fprintf(fp
, ")\n");
1481 for (nd
= rb_first(&dso
->symbols
[type
]); nd
; nd
= rb_next(nd
)) {
1482 struct symbol
*pos
= rb_entry(nd
, struct symbol
, rb_node
);
1483 ret
+= symbol__fprintf(pos
, fp
);
1489 enum dso_type
dso__type(struct dso
*dso
, struct machine
*machine
)
1492 enum dso_type type
= DSO__TYPE_UNKNOWN
;
1494 fd
= dso__data_get_fd(dso
, machine
);
1496 type
= dso__type_fd(fd
);
1497 dso__data_put_fd(dso
);
1503 int dso__strerror_load(struct dso
*dso
, char *buf
, size_t buflen
)
1505 int idx
, errnum
= dso
->load_errno
;
1507 * This must have a same ordering as the enum dso_load_errno.
1509 static const char *dso_load__error_str
[] = {
1510 "Internal tools/perf/ library error",
1512 "Can not read build id",
1513 "Mismatching build id",
1514 "Decompression failure",
1517 BUG_ON(buflen
== 0);
1520 const char *err
= str_error_r(errnum
, buf
, buflen
);
1523 scnprintf(buf
, buflen
, "%s", err
);
1528 if (errnum
< __DSO_LOAD_ERRNO__START
|| errnum
>= __DSO_LOAD_ERRNO__END
)
1531 idx
= errnum
- __DSO_LOAD_ERRNO__START
;
1532 scnprintf(buf
, buflen
, "%s", dso_load__error_str
[idx
]);