Loading...
1// SPDX-License-Identifier: GPL-2.0
2#include <asm/bug.h>
3#include <linux/kernel.h>
4#include <linux/string.h>
5#include <linux/zalloc.h>
6#include <sys/time.h>
7#include <sys/resource.h>
8#include <sys/types.h>
9#include <sys/stat.h>
10#include <unistd.h>
11#include <errno.h>
12#include <fcntl.h>
13#include <stdlib.h>
14#ifdef HAVE_LIBBPF_SUPPORT
15#include <bpf/libbpf.h>
16#include "bpf-event.h"
17#include "bpf-utils.h"
18#endif
19#include "compress.h"
20#include "env.h"
21#include "namespaces.h"
22#include "path.h"
23#include "map.h"
24#include "symbol.h"
25#include "srcline.h"
26#include "dso.h"
27#include "dsos.h"
28#include "machine.h"
29#include "auxtrace.h"
30#include "util.h" /* O_CLOEXEC for older systems */
31#include "debug.h"
32#include "string2.h"
33#include "vdso.h"
34#include "annotate-data.h"
35
36static const char * const debuglink_paths[] = {
37 "%.0s%s",
38 "%s/%s",
39 "%s/.debug/%s",
40 "/usr/lib/debug%s/%s"
41};
42
43void dso__set_nsinfo(struct dso *dso, struct nsinfo *nsi)
44{
45 nsinfo__put(RC_CHK_ACCESS(dso)->nsinfo);
46 RC_CHK_ACCESS(dso)->nsinfo = nsi;
47}
48
49char dso__symtab_origin(const struct dso *dso)
50{
51 static const char origin[] = {
52 [DSO_BINARY_TYPE__KALLSYMS] = 'k',
53 [DSO_BINARY_TYPE__VMLINUX] = 'v',
54 [DSO_BINARY_TYPE__JAVA_JIT] = 'j',
55 [DSO_BINARY_TYPE__DEBUGLINK] = 'l',
56 [DSO_BINARY_TYPE__BUILD_ID_CACHE] = 'B',
57 [DSO_BINARY_TYPE__BUILD_ID_CACHE_DEBUGINFO] = 'D',
58 [DSO_BINARY_TYPE__FEDORA_DEBUGINFO] = 'f',
59 [DSO_BINARY_TYPE__UBUNTU_DEBUGINFO] = 'u',
60 [DSO_BINARY_TYPE__MIXEDUP_UBUNTU_DEBUGINFO] = 'x',
61 [DSO_BINARY_TYPE__OPENEMBEDDED_DEBUGINFO] = 'o',
62 [DSO_BINARY_TYPE__BUILDID_DEBUGINFO] = 'b',
63 [DSO_BINARY_TYPE__SYSTEM_PATH_DSO] = 'd',
64 [DSO_BINARY_TYPE__SYSTEM_PATH_KMODULE] = 'K',
65 [DSO_BINARY_TYPE__SYSTEM_PATH_KMODULE_COMP] = 'm',
66 [DSO_BINARY_TYPE__GUEST_KALLSYMS] = 'g',
67 [DSO_BINARY_TYPE__GUEST_KMODULE] = 'G',
68 [DSO_BINARY_TYPE__GUEST_KMODULE_COMP] = 'M',
69 [DSO_BINARY_TYPE__GUEST_VMLINUX] = 'V',
70 };
71
72 if (dso == NULL || dso__symtab_type(dso) == DSO_BINARY_TYPE__NOT_FOUND)
73 return '!';
74 return origin[dso__symtab_type(dso)];
75}
76
77bool dso__is_object_file(const struct dso *dso)
78{
79 switch (dso__binary_type(dso)) {
80 case DSO_BINARY_TYPE__KALLSYMS:
81 case DSO_BINARY_TYPE__GUEST_KALLSYMS:
82 case DSO_BINARY_TYPE__JAVA_JIT:
83 case DSO_BINARY_TYPE__BPF_PROG_INFO:
84 case DSO_BINARY_TYPE__BPF_IMAGE:
85 case DSO_BINARY_TYPE__OOL:
86 return false;
87 case DSO_BINARY_TYPE__VMLINUX:
88 case DSO_BINARY_TYPE__GUEST_VMLINUX:
89 case DSO_BINARY_TYPE__DEBUGLINK:
90 case DSO_BINARY_TYPE__BUILD_ID_CACHE:
91 case DSO_BINARY_TYPE__BUILD_ID_CACHE_DEBUGINFO:
92 case DSO_BINARY_TYPE__FEDORA_DEBUGINFO:
93 case DSO_BINARY_TYPE__UBUNTU_DEBUGINFO:
94 case DSO_BINARY_TYPE__MIXEDUP_UBUNTU_DEBUGINFO:
95 case DSO_BINARY_TYPE__BUILDID_DEBUGINFO:
96 case DSO_BINARY_TYPE__SYSTEM_PATH_DSO:
97 case DSO_BINARY_TYPE__GUEST_KMODULE:
98 case DSO_BINARY_TYPE__GUEST_KMODULE_COMP:
99 case DSO_BINARY_TYPE__SYSTEM_PATH_KMODULE:
100 case DSO_BINARY_TYPE__SYSTEM_PATH_KMODULE_COMP:
101 case DSO_BINARY_TYPE__KCORE:
102 case DSO_BINARY_TYPE__GUEST_KCORE:
103 case DSO_BINARY_TYPE__OPENEMBEDDED_DEBUGINFO:
104 case DSO_BINARY_TYPE__NOT_FOUND:
105 default:
106 return true;
107 }
108}
109
110int dso__read_binary_type_filename(const struct dso *dso,
111 enum dso_binary_type type,
112 char *root_dir, char *filename, size_t size)
113{
114 char build_id_hex[SBUILD_ID_SIZE];
115 int ret = 0;
116 size_t len;
117
118 switch (type) {
119 case DSO_BINARY_TYPE__DEBUGLINK:
120 {
121 const char *last_slash;
122 char dso_dir[PATH_MAX];
123 char symfile[PATH_MAX];
124 unsigned int i;
125
126 len = __symbol__join_symfs(filename, size, dso__long_name(dso));
127 last_slash = filename + len;
128 while (last_slash != filename && *last_slash != '/')
129 last_slash--;
130
131 strncpy(dso_dir, filename, last_slash - filename);
132 dso_dir[last_slash-filename] = '\0';
133
134 if (!is_regular_file(filename)) {
135 ret = -1;
136 break;
137 }
138
139 ret = filename__read_debuglink(filename, symfile, PATH_MAX);
140 if (ret)
141 break;
142
143 /* Check predefined locations where debug file might reside */
144 ret = -1;
145 for (i = 0; i < ARRAY_SIZE(debuglink_paths); i++) {
146 snprintf(filename, size,
147 debuglink_paths[i], dso_dir, symfile);
148 if (is_regular_file(filename)) {
149 ret = 0;
150 break;
151 }
152 }
153
154 break;
155 }
156 case DSO_BINARY_TYPE__BUILD_ID_CACHE:
157 if (dso__build_id_filename(dso, filename, size, false) == NULL)
158 ret = -1;
159 break;
160
161 case DSO_BINARY_TYPE__BUILD_ID_CACHE_DEBUGINFO:
162 if (dso__build_id_filename(dso, filename, size, true) == NULL)
163 ret = -1;
164 break;
165
166 case DSO_BINARY_TYPE__FEDORA_DEBUGINFO:
167 len = __symbol__join_symfs(filename, size, "/usr/lib/debug");
168 snprintf(filename + len, size - len, "%s.debug", dso__long_name(dso));
169 break;
170
171 case DSO_BINARY_TYPE__UBUNTU_DEBUGINFO:
172 len = __symbol__join_symfs(filename, size, "/usr/lib/debug");
173 snprintf(filename + len, size - len, "%s", dso__long_name(dso));
174 break;
175
176 case DSO_BINARY_TYPE__MIXEDUP_UBUNTU_DEBUGINFO:
177 /*
178 * Ubuntu can mixup /usr/lib with /lib, putting debuginfo in
179 * /usr/lib/debug/lib when it is expected to be in
180 * /usr/lib/debug/usr/lib
181 */
182 if (strlen(dso__long_name(dso)) < 9 ||
183 strncmp(dso__long_name(dso), "/usr/lib/", 9)) {
184 ret = -1;
185 break;
186 }
187 len = __symbol__join_symfs(filename, size, "/usr/lib/debug");
188 snprintf(filename + len, size - len, "%s", dso__long_name(dso) + 4);
189 break;
190
191 case DSO_BINARY_TYPE__OPENEMBEDDED_DEBUGINFO:
192 {
193 const char *last_slash;
194 size_t dir_size;
195
196 last_slash = dso__long_name(dso) + dso__long_name_len(dso);
197 while (last_slash != dso__long_name(dso) && *last_slash != '/')
198 last_slash--;
199
200 len = __symbol__join_symfs(filename, size, "");
201 dir_size = last_slash - dso__long_name(dso) + 2;
202 if (dir_size > (size - len)) {
203 ret = -1;
204 break;
205 }
206 len += scnprintf(filename + len, dir_size, "%s", dso__long_name(dso));
207 len += scnprintf(filename + len , size - len, ".debug%s",
208 last_slash);
209 break;
210 }
211
212 case DSO_BINARY_TYPE__BUILDID_DEBUGINFO:
213 if (!dso__has_build_id(dso)) {
214 ret = -1;
215 break;
216 }
217
218 build_id__sprintf(dso__bid_const(dso), build_id_hex);
219 len = __symbol__join_symfs(filename, size, "/usr/lib/debug/.build-id/");
220 snprintf(filename + len, size - len, "%.2s/%s.debug",
221 build_id_hex, build_id_hex + 2);
222 break;
223
224 case DSO_BINARY_TYPE__VMLINUX:
225 case DSO_BINARY_TYPE__GUEST_VMLINUX:
226 case DSO_BINARY_TYPE__SYSTEM_PATH_DSO:
227 __symbol__join_symfs(filename, size, dso__long_name(dso));
228 break;
229
230 case DSO_BINARY_TYPE__GUEST_KMODULE:
231 case DSO_BINARY_TYPE__GUEST_KMODULE_COMP:
232 path__join3(filename, size, symbol_conf.symfs,
233 root_dir, dso__long_name(dso));
234 break;
235
236 case DSO_BINARY_TYPE__SYSTEM_PATH_KMODULE:
237 case DSO_BINARY_TYPE__SYSTEM_PATH_KMODULE_COMP:
238 __symbol__join_symfs(filename, size, dso__long_name(dso));
239 break;
240
241 case DSO_BINARY_TYPE__KCORE:
242 case DSO_BINARY_TYPE__GUEST_KCORE:
243 snprintf(filename, size, "%s", dso__long_name(dso));
244 break;
245
246 default:
247 case DSO_BINARY_TYPE__KALLSYMS:
248 case DSO_BINARY_TYPE__GUEST_KALLSYMS:
249 case DSO_BINARY_TYPE__JAVA_JIT:
250 case DSO_BINARY_TYPE__BPF_PROG_INFO:
251 case DSO_BINARY_TYPE__BPF_IMAGE:
252 case DSO_BINARY_TYPE__OOL:
253 case DSO_BINARY_TYPE__NOT_FOUND:
254 ret = -1;
255 break;
256 }
257
258 return ret;
259}
260
261enum {
262 COMP_ID__NONE = 0,
263};
264
265static const struct {
266 const char *fmt;
267 int (*decompress)(const char *input, int output);
268 bool (*is_compressed)(const char *input);
269} compressions[] = {
270 [COMP_ID__NONE] = { .fmt = NULL, },
271#ifdef HAVE_ZLIB_SUPPORT
272 { "gz", gzip_decompress_to_file, gzip_is_compressed },
273#endif
274#ifdef HAVE_LZMA_SUPPORT
275 { "xz", lzma_decompress_to_file, lzma_is_compressed },
276#endif
277 { NULL, NULL, NULL },
278};
279
280static int is_supported_compression(const char *ext)
281{
282 unsigned i;
283
284 for (i = 1; compressions[i].fmt; i++) {
285 if (!strcmp(ext, compressions[i].fmt))
286 return i;
287 }
288 return COMP_ID__NONE;
289}
290
291bool is_kernel_module(const char *pathname, int cpumode)
292{
293 struct kmod_path m;
294 int mode = cpumode & PERF_RECORD_MISC_CPUMODE_MASK;
295
296 WARN_ONCE(mode != cpumode,
297 "Internal error: passing unmasked cpumode (%x) to is_kernel_module",
298 cpumode);
299
300 switch (mode) {
301 case PERF_RECORD_MISC_USER:
302 case PERF_RECORD_MISC_HYPERVISOR:
303 case PERF_RECORD_MISC_GUEST_USER:
304 return false;
305 /* Treat PERF_RECORD_MISC_CPUMODE_UNKNOWN as kernel */
306 default:
307 if (kmod_path__parse(&m, pathname)) {
308 pr_err("Failed to check whether %s is a kernel module or not. Assume it is.",
309 pathname);
310 return true;
311 }
312 }
313
314 return m.kmod;
315}
316
317bool dso__needs_decompress(struct dso *dso)
318{
319 return dso__symtab_type(dso) == DSO_BINARY_TYPE__SYSTEM_PATH_KMODULE_COMP ||
320 dso__symtab_type(dso) == DSO_BINARY_TYPE__GUEST_KMODULE_COMP;
321}
322
323int filename__decompress(const char *name, char *pathname,
324 size_t len, int comp, int *err)
325{
326 char tmpbuf[] = KMOD_DECOMP_NAME;
327 int fd = -1;
328
329 /*
330 * We have proper compression id for DSO and yet the file
331 * behind the 'name' can still be plain uncompressed object.
332 *
333 * The reason is behind the logic we open the DSO object files,
334 * when we try all possible 'debug' objects until we find the
335 * data. So even if the DSO is represented by 'krava.xz' module,
336 * we can end up here opening ~/.debug/....23432432/debug' file
337 * which is not compressed.
338 *
339 * To keep this transparent, we detect this and return the file
340 * descriptor to the uncompressed file.
341 */
342 if (!compressions[comp].is_compressed(name))
343 return open(name, O_RDONLY);
344
345 fd = mkstemp(tmpbuf);
346 if (fd < 0) {
347 *err = errno;
348 return -1;
349 }
350
351 if (compressions[comp].decompress(name, fd)) {
352 *err = DSO_LOAD_ERRNO__DECOMPRESSION_FAILURE;
353 close(fd);
354 fd = -1;
355 }
356
357 if (!pathname || (fd < 0))
358 unlink(tmpbuf);
359
360 if (pathname && (fd >= 0))
361 strlcpy(pathname, tmpbuf, len);
362
363 return fd;
364}
365
366static int decompress_kmodule(struct dso *dso, const char *name,
367 char *pathname, size_t len)
368{
369 if (!dso__needs_decompress(dso))
370 return -1;
371
372 if (dso__comp(dso) == COMP_ID__NONE)
373 return -1;
374
375 return filename__decompress(name, pathname, len, dso__comp(dso), dso__load_errno(dso));
376}
377
378int dso__decompress_kmodule_fd(struct dso *dso, const char *name)
379{
380 return decompress_kmodule(dso, name, NULL, 0);
381}
382
383int dso__decompress_kmodule_path(struct dso *dso, const char *name,
384 char *pathname, size_t len)
385{
386 int fd = decompress_kmodule(dso, name, pathname, len);
387
388 close(fd);
389 return fd >= 0 ? 0 : -1;
390}
391
392/*
393 * Parses kernel module specified in @path and updates
394 * @m argument like:
395 *
396 * @comp - true if @path contains supported compression suffix,
397 * false otherwise
398 * @kmod - true if @path contains '.ko' suffix in right position,
399 * false otherwise
400 * @name - if (@alloc_name && @kmod) is true, it contains strdup-ed base name
401 * of the kernel module without suffixes, otherwise strudup-ed
402 * base name of @path
403 * @ext - if (@alloc_ext && @comp) is true, it contains strdup-ed string
404 * the compression suffix
405 *
406 * Returns 0 if there's no strdup error, -ENOMEM otherwise.
407 */
408int __kmod_path__parse(struct kmod_path *m, const char *path,
409 bool alloc_name)
410{
411 const char *name = strrchr(path, '/');
412 const char *ext = strrchr(path, '.');
413 bool is_simple_name = false;
414
415 memset(m, 0x0, sizeof(*m));
416 name = name ? name + 1 : path;
417
418 /*
419 * '.' is also a valid character for module name. For example:
420 * [aaa.bbb] is a valid module name. '[' should have higher
421 * priority than '.ko' suffix.
422 *
423 * The kernel names are from machine__mmap_name. Such
424 * name should belong to kernel itself, not kernel module.
425 */
426 if (name[0] == '[') {
427 is_simple_name = true;
428 if ((strncmp(name, "[kernel.kallsyms]", 17) == 0) ||
429 (strncmp(name, "[guest.kernel.kallsyms", 22) == 0) ||
430 (strncmp(name, "[vdso]", 6) == 0) ||
431 (strncmp(name, "[vdso32]", 8) == 0) ||
432 (strncmp(name, "[vdsox32]", 9) == 0) ||
433 (strncmp(name, "[vsyscall]", 10) == 0)) {
434 m->kmod = false;
435
436 } else
437 m->kmod = true;
438 }
439
440 /* No extension, just return name. */
441 if ((ext == NULL) || is_simple_name) {
442 if (alloc_name) {
443 m->name = strdup(name);
444 return m->name ? 0 : -ENOMEM;
445 }
446 return 0;
447 }
448
449 m->comp = is_supported_compression(ext + 1);
450 if (m->comp > COMP_ID__NONE)
451 ext -= 3;
452
453 /* Check .ko extension only if there's enough name left. */
454 if (ext > name)
455 m->kmod = !strncmp(ext, ".ko", 3);
456
457 if (alloc_name) {
458 if (m->kmod) {
459 if (asprintf(&m->name, "[%.*s]", (int) (ext - name), name) == -1)
460 return -ENOMEM;
461 } else {
462 if (asprintf(&m->name, "%s", name) == -1)
463 return -ENOMEM;
464 }
465
466 strreplace(m->name, '-', '_');
467 }
468
469 return 0;
470}
471
472void dso__set_module_info(struct dso *dso, struct kmod_path *m,
473 struct machine *machine)
474{
475 if (machine__is_host(machine))
476 dso__set_symtab_type(dso, DSO_BINARY_TYPE__SYSTEM_PATH_KMODULE);
477 else
478 dso__set_symtab_type(dso, DSO_BINARY_TYPE__GUEST_KMODULE);
479
480 /* _KMODULE_COMP should be next to _KMODULE */
481 if (m->kmod && m->comp) {
482 dso__set_symtab_type(dso, dso__symtab_type(dso) + 1);
483 dso__set_comp(dso, m->comp);
484 }
485
486 dso__set_is_kmod(dso);
487 dso__set_short_name(dso, strdup(m->name), true);
488}
489
490/*
491 * Global list of open DSOs and the counter.
492 */
493static LIST_HEAD(dso__data_open);
494static long dso__data_open_cnt;
495static pthread_mutex_t dso__data_open_lock = PTHREAD_MUTEX_INITIALIZER;
496
497static void dso__list_add(struct dso *dso)
498{
499 list_add_tail(&dso__data(dso)->open_entry, &dso__data_open);
500#ifdef REFCNT_CHECKING
501 dso__data(dso)->dso = dso__get(dso);
502#endif
503 /* Assume the dso is part of dsos, hence the optional reference count above. */
504 assert(dso__dsos(dso));
505 dso__data_open_cnt++;
506}
507
508static void dso__list_del(struct dso *dso)
509{
510 list_del_init(&dso__data(dso)->open_entry);
511#ifdef REFCNT_CHECKING
512 dso__put(dso__data(dso)->dso);
513#endif
514 WARN_ONCE(dso__data_open_cnt <= 0,
515 "DSO data fd counter out of bounds.");
516 dso__data_open_cnt--;
517}
518
519static void close_first_dso(void);
520
521static int do_open(char *name)
522{
523 int fd;
524 char sbuf[STRERR_BUFSIZE];
525
526 do {
527 fd = open(name, O_RDONLY|O_CLOEXEC);
528 if (fd >= 0)
529 return fd;
530
531 pr_debug("dso open failed: %s\n",
532 str_error_r(errno, sbuf, sizeof(sbuf)));
533 if (!dso__data_open_cnt || errno != EMFILE)
534 break;
535
536 close_first_dso();
537 } while (1);
538
539 return -1;
540}
541
542char *dso__filename_with_chroot(const struct dso *dso, const char *filename)
543{
544 return filename_with_chroot(nsinfo__pid(dso__nsinfo_const(dso)), filename);
545}
546
547static int __open_dso(struct dso *dso, struct machine *machine)
548{
549 int fd = -EINVAL;
550 char *root_dir = (char *)"";
551 char *name = malloc(PATH_MAX);
552 bool decomp = false;
553
554 if (!name)
555 return -ENOMEM;
556
557 mutex_lock(dso__lock(dso));
558 if (machine)
559 root_dir = machine->root_dir;
560
561 if (dso__read_binary_type_filename(dso, dso__binary_type(dso),
562 root_dir, name, PATH_MAX))
563 goto out;
564
565 if (!is_regular_file(name)) {
566 char *new_name;
567
568 if (errno != ENOENT || dso__nsinfo(dso) == NULL)
569 goto out;
570
571 new_name = dso__filename_with_chroot(dso, name);
572 if (!new_name)
573 goto out;
574
575 free(name);
576 name = new_name;
577 }
578
579 if (dso__needs_decompress(dso)) {
580 char newpath[KMOD_DECOMP_LEN];
581 size_t len = sizeof(newpath);
582
583 if (dso__decompress_kmodule_path(dso, name, newpath, len) < 0) {
584 fd = -(*dso__load_errno(dso));
585 goto out;
586 }
587
588 decomp = true;
589 strcpy(name, newpath);
590 }
591
592 fd = do_open(name);
593
594 if (decomp)
595 unlink(name);
596
597out:
598 mutex_unlock(dso__lock(dso));
599 free(name);
600 return fd;
601}
602
603static void check_data_close(void);
604
605/**
606 * dso_close - Open DSO data file
607 * @dso: dso object
608 *
609 * Open @dso's data file descriptor and updates
610 * list/count of open DSO objects.
611 */
612static int open_dso(struct dso *dso, struct machine *machine)
613{
614 int fd;
615 struct nscookie nsc;
616
617 if (dso__binary_type(dso) != DSO_BINARY_TYPE__BUILD_ID_CACHE) {
618 mutex_lock(dso__lock(dso));
619 nsinfo__mountns_enter(dso__nsinfo(dso), &nsc);
620 mutex_unlock(dso__lock(dso));
621 }
622 fd = __open_dso(dso, machine);
623 if (dso__binary_type(dso) != DSO_BINARY_TYPE__BUILD_ID_CACHE)
624 nsinfo__mountns_exit(&nsc);
625
626 if (fd >= 0) {
627 dso__list_add(dso);
628 /*
629 * Check if we crossed the allowed number
630 * of opened DSOs and close one if needed.
631 */
632 check_data_close();
633 }
634
635 return fd;
636}
637
638static void close_data_fd(struct dso *dso)
639{
640 if (dso__data(dso)->fd >= 0) {
641 close(dso__data(dso)->fd);
642 dso__data(dso)->fd = -1;
643 dso__data(dso)->file_size = 0;
644 dso__list_del(dso);
645 }
646}
647
648/**
649 * dso_close - Close DSO data file
650 * @dso: dso object
651 *
652 * Close @dso's data file descriptor and updates
653 * list/count of open DSO objects.
654 */
655static void close_dso(struct dso *dso)
656{
657 close_data_fd(dso);
658}
659
660static void close_first_dso(void)
661{
662 struct dso_data *dso_data;
663 struct dso *dso;
664
665 dso_data = list_first_entry(&dso__data_open, struct dso_data, open_entry);
666#ifdef REFCNT_CHECKING
667 dso = dso_data->dso;
668#else
669 dso = container_of(dso_data, struct dso, data);
670#endif
671 close_dso(dso);
672}
673
674static rlim_t get_fd_limit(void)
675{
676 struct rlimit l;
677 rlim_t limit = 0;
678
679 /* Allow half of the current open fd limit. */
680 if (getrlimit(RLIMIT_NOFILE, &l) == 0) {
681 if (l.rlim_cur == RLIM_INFINITY)
682 limit = l.rlim_cur;
683 else
684 limit = l.rlim_cur / 2;
685 } else {
686 pr_err("failed to get fd limit\n");
687 limit = 1;
688 }
689
690 return limit;
691}
692
693static rlim_t fd_limit;
694
695/*
696 * Used only by tests/dso-data.c to reset the environment
697 * for tests. I dont expect we should change this during
698 * standard runtime.
699 */
700void reset_fd_limit(void)
701{
702 fd_limit = 0;
703}
704
705static bool may_cache_fd(void)
706{
707 if (!fd_limit)
708 fd_limit = get_fd_limit();
709
710 if (fd_limit == RLIM_INFINITY)
711 return true;
712
713 return fd_limit > (rlim_t) dso__data_open_cnt;
714}
715
716/*
717 * Check and close LRU dso if we crossed allowed limit
718 * for opened dso file descriptors. The limit is half
719 * of the RLIMIT_NOFILE files opened.
720*/
721static void check_data_close(void)
722{
723 bool cache_fd = may_cache_fd();
724
725 if (!cache_fd)
726 close_first_dso();
727}
728
729/**
730 * dso__data_close - Close DSO data file
731 * @dso: dso object
732 *
733 * External interface to close @dso's data file descriptor.
734 */
735void dso__data_close(struct dso *dso)
736{
737 pthread_mutex_lock(&dso__data_open_lock);
738 close_dso(dso);
739 pthread_mutex_unlock(&dso__data_open_lock);
740}
741
742static void try_to_open_dso(struct dso *dso, struct machine *machine)
743{
744 enum dso_binary_type binary_type_data[] = {
745 DSO_BINARY_TYPE__BUILD_ID_CACHE,
746 DSO_BINARY_TYPE__SYSTEM_PATH_DSO,
747 DSO_BINARY_TYPE__NOT_FOUND,
748 };
749 int i = 0;
750 struct dso_data *dso_data = dso__data(dso);
751
752 if (dso_data->fd >= 0)
753 return;
754
755 if (dso__binary_type(dso) != DSO_BINARY_TYPE__NOT_FOUND) {
756 dso_data->fd = open_dso(dso, machine);
757 goto out;
758 }
759
760 do {
761 dso__set_binary_type(dso, binary_type_data[i++]);
762
763 dso_data->fd = open_dso(dso, machine);
764 if (dso_data->fd >= 0)
765 goto out;
766
767 } while (dso__binary_type(dso) != DSO_BINARY_TYPE__NOT_FOUND);
768out:
769 if (dso_data->fd >= 0)
770 dso_data->status = DSO_DATA_STATUS_OK;
771 else
772 dso_data->status = DSO_DATA_STATUS_ERROR;
773}
774
775/**
776 * dso__data_get_fd - Get dso's data file descriptor
777 * @dso: dso object
778 * @machine: machine object
779 *
780 * External interface to find dso's file, open it and
781 * returns file descriptor. It should be paired with
782 * dso__data_put_fd() if it returns non-negative value.
783 */
784int dso__data_get_fd(struct dso *dso, struct machine *machine)
785{
786 if (dso__data(dso)->status == DSO_DATA_STATUS_ERROR)
787 return -1;
788
789 if (pthread_mutex_lock(&dso__data_open_lock) < 0)
790 return -1;
791
792 try_to_open_dso(dso, machine);
793
794 if (dso__data(dso)->fd < 0)
795 pthread_mutex_unlock(&dso__data_open_lock);
796
797 return dso__data(dso)->fd;
798}
799
800void dso__data_put_fd(struct dso *dso __maybe_unused)
801{
802 pthread_mutex_unlock(&dso__data_open_lock);
803}
804
805bool dso__data_status_seen(struct dso *dso, enum dso_data_status_seen by)
806{
807 u32 flag = 1 << by;
808
809 if (dso__data(dso)->status_seen & flag)
810 return true;
811
812 dso__data(dso)->status_seen |= flag;
813
814 return false;
815}
816
817#ifdef HAVE_LIBBPF_SUPPORT
818static ssize_t bpf_read(struct dso *dso, u64 offset, char *data)
819{
820 struct bpf_prog_info_node *node;
821 ssize_t size = DSO__DATA_CACHE_SIZE;
822 struct dso_bpf_prog *dso_bpf_prog = dso__bpf_prog(dso);
823 u64 len;
824 u8 *buf;
825
826 node = perf_env__find_bpf_prog_info(dso_bpf_prog->env, dso_bpf_prog->id);
827 if (!node || !node->info_linear) {
828 dso__data(dso)->status = DSO_DATA_STATUS_ERROR;
829 return -1;
830 }
831
832 len = node->info_linear->info.jited_prog_len;
833 buf = (u8 *)(uintptr_t)node->info_linear->info.jited_prog_insns;
834
835 if (offset >= len)
836 return -1;
837
838 size = (ssize_t)min(len - offset, (u64)size);
839 memcpy(data, buf + offset, size);
840 return size;
841}
842
843static int bpf_size(struct dso *dso)
844{
845 struct bpf_prog_info_node *node;
846 struct dso_bpf_prog *dso_bpf_prog = dso__bpf_prog(dso);
847
848 node = perf_env__find_bpf_prog_info(dso_bpf_prog->env, dso_bpf_prog->id);
849 if (!node || !node->info_linear) {
850 dso__data(dso)->status = DSO_DATA_STATUS_ERROR;
851 return -1;
852 }
853
854 dso__data(dso)->file_size = node->info_linear->info.jited_prog_len;
855 return 0;
856}
857#endif // HAVE_LIBBPF_SUPPORT
858
859static void
860dso_cache__free(struct dso *dso)
861{
862 struct rb_root *root = &dso__data(dso)->cache;
863 struct rb_node *next = rb_first(root);
864
865 mutex_lock(dso__lock(dso));
866 while (next) {
867 struct dso_cache *cache;
868
869 cache = rb_entry(next, struct dso_cache, rb_node);
870 next = rb_next(&cache->rb_node);
871 rb_erase(&cache->rb_node, root);
872 free(cache);
873 }
874 mutex_unlock(dso__lock(dso));
875}
876
877static struct dso_cache *__dso_cache__find(struct dso *dso, u64 offset)
878{
879 const struct rb_root *root = &dso__data(dso)->cache;
880 struct rb_node * const *p = &root->rb_node;
881 const struct rb_node *parent = NULL;
882 struct dso_cache *cache;
883
884 while (*p != NULL) {
885 u64 end;
886
887 parent = *p;
888 cache = rb_entry(parent, struct dso_cache, rb_node);
889 end = cache->offset + DSO__DATA_CACHE_SIZE;
890
891 if (offset < cache->offset)
892 p = &(*p)->rb_left;
893 else if (offset >= end)
894 p = &(*p)->rb_right;
895 else
896 return cache;
897 }
898
899 return NULL;
900}
901
902static struct dso_cache *
903dso_cache__insert(struct dso *dso, struct dso_cache *new)
904{
905 struct rb_root *root = &dso__data(dso)->cache;
906 struct rb_node **p = &root->rb_node;
907 struct rb_node *parent = NULL;
908 struct dso_cache *cache;
909 u64 offset = new->offset;
910
911 mutex_lock(dso__lock(dso));
912 while (*p != NULL) {
913 u64 end;
914
915 parent = *p;
916 cache = rb_entry(parent, struct dso_cache, rb_node);
917 end = cache->offset + DSO__DATA_CACHE_SIZE;
918
919 if (offset < cache->offset)
920 p = &(*p)->rb_left;
921 else if (offset >= end)
922 p = &(*p)->rb_right;
923 else
924 goto out;
925 }
926
927 rb_link_node(&new->rb_node, parent, p);
928 rb_insert_color(&new->rb_node, root);
929
930 cache = NULL;
931out:
932 mutex_unlock(dso__lock(dso));
933 return cache;
934}
935
936static ssize_t dso_cache__memcpy(struct dso_cache *cache, u64 offset, u8 *data,
937 u64 size, bool out)
938{
939 u64 cache_offset = offset - cache->offset;
940 u64 cache_size = min(cache->size - cache_offset, size);
941
942 if (out)
943 memcpy(data, cache->data + cache_offset, cache_size);
944 else
945 memcpy(cache->data + cache_offset, data, cache_size);
946 return cache_size;
947}
948
949static ssize_t file_read(struct dso *dso, struct machine *machine,
950 u64 offset, char *data)
951{
952 ssize_t ret;
953
954 pthread_mutex_lock(&dso__data_open_lock);
955
956 /*
957 * dso__data(dso)->fd might be closed if other thread opened another
958 * file (dso) due to open file limit (RLIMIT_NOFILE).
959 */
960 try_to_open_dso(dso, machine);
961
962 if (dso__data(dso)->fd < 0) {
963 dso__data(dso)->status = DSO_DATA_STATUS_ERROR;
964 ret = -errno;
965 goto out;
966 }
967
968 ret = pread(dso__data(dso)->fd, data, DSO__DATA_CACHE_SIZE, offset);
969out:
970 pthread_mutex_unlock(&dso__data_open_lock);
971 return ret;
972}
973
974static struct dso_cache *dso_cache__populate(struct dso *dso,
975 struct machine *machine,
976 u64 offset, ssize_t *ret)
977{
978 u64 cache_offset = offset & DSO__DATA_CACHE_MASK;
979 struct dso_cache *cache;
980 struct dso_cache *old;
981
982 cache = zalloc(sizeof(*cache) + DSO__DATA_CACHE_SIZE);
983 if (!cache) {
984 *ret = -ENOMEM;
985 return NULL;
986 }
987#ifdef HAVE_LIBBPF_SUPPORT
988 if (dso__binary_type(dso) == DSO_BINARY_TYPE__BPF_PROG_INFO)
989 *ret = bpf_read(dso, cache_offset, cache->data);
990 else
991#endif
992 if (dso__binary_type(dso) == DSO_BINARY_TYPE__OOL)
993 *ret = DSO__DATA_CACHE_SIZE;
994 else
995 *ret = file_read(dso, machine, cache_offset, cache->data);
996
997 if (*ret <= 0) {
998 free(cache);
999 return NULL;
1000 }
1001
1002 cache->offset = cache_offset;
1003 cache->size = *ret;
1004
1005 old = dso_cache__insert(dso, cache);
1006 if (old) {
1007 /* we lose the race */
1008 free(cache);
1009 cache = old;
1010 }
1011
1012 return cache;
1013}
1014
1015static struct dso_cache *dso_cache__find(struct dso *dso,
1016 struct machine *machine,
1017 u64 offset,
1018 ssize_t *ret)
1019{
1020 struct dso_cache *cache = __dso_cache__find(dso, offset);
1021
1022 return cache ? cache : dso_cache__populate(dso, machine, offset, ret);
1023}
1024
1025static ssize_t dso_cache_io(struct dso *dso, struct machine *machine,
1026 u64 offset, u8 *data, ssize_t size, bool out)
1027{
1028 struct dso_cache *cache;
1029 ssize_t ret = 0;
1030
1031 cache = dso_cache__find(dso, machine, offset, &ret);
1032 if (!cache)
1033 return ret;
1034
1035 return dso_cache__memcpy(cache, offset, data, size, out);
1036}
1037
1038/*
1039 * Reads and caches dso data DSO__DATA_CACHE_SIZE size chunks
1040 * in the rb_tree. Any read to already cached data is served
1041 * by cached data. Writes update the cache only, not the backing file.
1042 */
1043static ssize_t cached_io(struct dso *dso, struct machine *machine,
1044 u64 offset, u8 *data, ssize_t size, bool out)
1045{
1046 ssize_t r = 0;
1047 u8 *p = data;
1048
1049 do {
1050 ssize_t ret;
1051
1052 ret = dso_cache_io(dso, machine, offset, p, size, out);
1053 if (ret < 0)
1054 return ret;
1055
1056 /* Reached EOF, return what we have. */
1057 if (!ret)
1058 break;
1059
1060 BUG_ON(ret > size);
1061
1062 r += ret;
1063 p += ret;
1064 offset += ret;
1065 size -= ret;
1066
1067 } while (size);
1068
1069 return r;
1070}
1071
1072static int file_size(struct dso *dso, struct machine *machine)
1073{
1074 int ret = 0;
1075 struct stat st;
1076 char sbuf[STRERR_BUFSIZE];
1077
1078 pthread_mutex_lock(&dso__data_open_lock);
1079
1080 /*
1081 * dso__data(dso)->fd might be closed if other thread opened another
1082 * file (dso) due to open file limit (RLIMIT_NOFILE).
1083 */
1084 try_to_open_dso(dso, machine);
1085
1086 if (dso__data(dso)->fd < 0) {
1087 ret = -errno;
1088 dso__data(dso)->status = DSO_DATA_STATUS_ERROR;
1089 goto out;
1090 }
1091
1092 if (fstat(dso__data(dso)->fd, &st) < 0) {
1093 ret = -errno;
1094 pr_err("dso cache fstat failed: %s\n",
1095 str_error_r(errno, sbuf, sizeof(sbuf)));
1096 dso__data(dso)->status = DSO_DATA_STATUS_ERROR;
1097 goto out;
1098 }
1099 dso__data(dso)->file_size = st.st_size;
1100
1101out:
1102 pthread_mutex_unlock(&dso__data_open_lock);
1103 return ret;
1104}
1105
1106int dso__data_file_size(struct dso *dso, struct machine *machine)
1107{
1108 if (dso__data(dso)->file_size)
1109 return 0;
1110
1111 if (dso__data(dso)->status == DSO_DATA_STATUS_ERROR)
1112 return -1;
1113#ifdef HAVE_LIBBPF_SUPPORT
1114 if (dso__binary_type(dso) == DSO_BINARY_TYPE__BPF_PROG_INFO)
1115 return bpf_size(dso);
1116#endif
1117 return file_size(dso, machine);
1118}
1119
1120/**
1121 * dso__data_size - Return dso data size
1122 * @dso: dso object
1123 * @machine: machine object
1124 *
1125 * Return: dso data size
1126 */
1127off_t dso__data_size(struct dso *dso, struct machine *machine)
1128{
1129 if (dso__data_file_size(dso, machine))
1130 return -1;
1131
1132 /* For now just estimate dso data size is close to file size */
1133 return dso__data(dso)->file_size;
1134}
1135
1136static ssize_t data_read_write_offset(struct dso *dso, struct machine *machine,
1137 u64 offset, u8 *data, ssize_t size,
1138 bool out)
1139{
1140 if (dso__data_file_size(dso, machine))
1141 return -1;
1142
1143 /* Check the offset sanity. */
1144 if (offset > dso__data(dso)->file_size)
1145 return -1;
1146
1147 if (offset + size < offset)
1148 return -1;
1149
1150 return cached_io(dso, machine, offset, data, size, out);
1151}
1152
1153/**
1154 * dso__data_read_offset - Read data from dso file offset
1155 * @dso: dso object
1156 * @machine: machine object
1157 * @offset: file offset
1158 * @data: buffer to store data
1159 * @size: size of the @data buffer
1160 *
1161 * External interface to read data from dso file offset. Open
1162 * dso data file and use cached_read to get the data.
1163 */
1164ssize_t dso__data_read_offset(struct dso *dso, struct machine *machine,
1165 u64 offset, u8 *data, ssize_t size)
1166{
1167 if (dso__data(dso)->status == DSO_DATA_STATUS_ERROR)
1168 return -1;
1169
1170 return data_read_write_offset(dso, machine, offset, data, size, true);
1171}
1172
1173/**
1174 * dso__data_read_addr - Read data from dso address
1175 * @dso: dso object
1176 * @machine: machine object
1177 * @add: virtual memory address
1178 * @data: buffer to store data
1179 * @size: size of the @data buffer
1180 *
1181 * External interface to read data from dso address.
1182 */
1183ssize_t dso__data_read_addr(struct dso *dso, struct map *map,
1184 struct machine *machine, u64 addr,
1185 u8 *data, ssize_t size)
1186{
1187 u64 offset = map__map_ip(map, addr);
1188
1189 return dso__data_read_offset(dso, machine, offset, data, size);
1190}
1191
1192/**
1193 * dso__data_write_cache_offs - Write data to dso data cache at file offset
1194 * @dso: dso object
1195 * @machine: machine object
1196 * @offset: file offset
1197 * @data: buffer to write
1198 * @size: size of the @data buffer
1199 *
1200 * Write into the dso file data cache, but do not change the file itself.
1201 */
1202ssize_t dso__data_write_cache_offs(struct dso *dso, struct machine *machine,
1203 u64 offset, const u8 *data_in, ssize_t size)
1204{
1205 u8 *data = (u8 *)data_in; /* cast away const to use same fns for r/w */
1206
1207 if (dso__data(dso)->status == DSO_DATA_STATUS_ERROR)
1208 return -1;
1209
1210 return data_read_write_offset(dso, machine, offset, data, size, false);
1211}
1212
1213/**
1214 * dso__data_write_cache_addr - Write data to dso data cache at dso address
1215 * @dso: dso object
1216 * @machine: machine object
1217 * @add: virtual memory address
1218 * @data: buffer to write
1219 * @size: size of the @data buffer
1220 *
1221 * External interface to write into the dso file data cache, but do not change
1222 * the file itself.
1223 */
1224ssize_t dso__data_write_cache_addr(struct dso *dso, struct map *map,
1225 struct machine *machine, u64 addr,
1226 const u8 *data, ssize_t size)
1227{
1228 u64 offset = map__map_ip(map, addr);
1229
1230 return dso__data_write_cache_offs(dso, machine, offset, data, size);
1231}
1232
1233struct map *dso__new_map(const char *name)
1234{
1235 struct map *map = NULL;
1236 struct dso *dso = dso__new(name);
1237
1238 if (dso) {
1239 map = map__new2(0, dso);
1240 dso__put(dso);
1241 }
1242
1243 return map;
1244}
1245
1246struct dso *machine__findnew_kernel(struct machine *machine, const char *name,
1247 const char *short_name, int dso_type)
1248{
1249 /*
1250 * The kernel dso could be created by build_id processing.
1251 */
1252 struct dso *dso = machine__findnew_dso(machine, name);
1253
1254 /*
1255 * We need to run this in all cases, since during the build_id
1256 * processing we had no idea this was the kernel dso.
1257 */
1258 if (dso != NULL) {
1259 dso__set_short_name(dso, short_name, false);
1260 dso__set_kernel(dso, dso_type);
1261 }
1262
1263 return dso;
1264}
1265
1266static void dso__set_long_name_id(struct dso *dso, const char *name, bool name_allocated)
1267{
1268 struct dsos *dsos = dso__dsos(dso);
1269
1270 if (name == NULL)
1271 return;
1272
1273 if (dsos) {
1274 /*
1275 * Need to avoid re-sorting the dsos breaking by non-atomically
1276 * renaming the dso.
1277 */
1278 down_write(&dsos->lock);
1279 }
1280
1281 if (dso__long_name_allocated(dso))
1282 free((char *)dso__long_name(dso));
1283
1284 RC_CHK_ACCESS(dso)->long_name = name;
1285 RC_CHK_ACCESS(dso)->long_name_len = strlen(name);
1286 dso__set_long_name_allocated(dso, name_allocated);
1287
1288 if (dsos) {
1289 dsos->sorted = false;
1290 up_write(&dsos->lock);
1291 }
1292}
1293
1294static int __dso_id__cmp(const struct dso_id *a, const struct dso_id *b)
1295{
1296 if (a->maj > b->maj) return -1;
1297 if (a->maj < b->maj) return 1;
1298
1299 if (a->min > b->min) return -1;
1300 if (a->min < b->min) return 1;
1301
1302 if (a->ino > b->ino) return -1;
1303 if (a->ino < b->ino) return 1;
1304
1305 /*
1306 * Synthesized MMAP events have zero ino_generation, avoid comparing
1307 * them with MMAP events with actual ino_generation.
1308 *
1309 * I found it harmful because the mismatch resulted in a new
1310 * dso that did not have a build ID whereas the original dso did have a
1311 * build ID. The build ID was essential because the object was not found
1312 * otherwise. - Adrian
1313 */
1314 if (a->ino_generation && b->ino_generation) {
1315 if (a->ino_generation > b->ino_generation) return -1;
1316 if (a->ino_generation < b->ino_generation) return 1;
1317 }
1318
1319 return 0;
1320}
1321
1322bool dso_id__empty(const struct dso_id *id)
1323{
1324 if (!id)
1325 return true;
1326
1327 return !id->maj && !id->min && !id->ino && !id->ino_generation;
1328}
1329
1330void __dso__inject_id(struct dso *dso, const struct dso_id *id)
1331{
1332 struct dsos *dsos = dso__dsos(dso);
1333 struct dso_id *dso_id = dso__id(dso);
1334
1335 /* dsos write lock held by caller. */
1336
1337 dso_id->maj = id->maj;
1338 dso_id->min = id->min;
1339 dso_id->ino = id->ino;
1340 dso_id->ino_generation = id->ino_generation;
1341
1342 if (dsos)
1343 dsos->sorted = false;
1344}
1345
1346int dso_id__cmp(const struct dso_id *a, const struct dso_id *b)
1347{
1348 /*
1349 * The second is always dso->id, so zeroes if not set, assume passing
1350 * NULL for a means a zeroed id
1351 */
1352 if (dso_id__empty(a) || dso_id__empty(b))
1353 return 0;
1354
1355 return __dso_id__cmp(a, b);
1356}
1357
1358int dso__cmp_id(struct dso *a, struct dso *b)
1359{
1360 return __dso_id__cmp(dso__id(a), dso__id(b));
1361}
1362
1363void dso__set_long_name(struct dso *dso, const char *name, bool name_allocated)
1364{
1365 dso__set_long_name_id(dso, name, name_allocated);
1366}
1367
1368void dso__set_short_name(struct dso *dso, const char *name, bool name_allocated)
1369{
1370 struct dsos *dsos = dso__dsos(dso);
1371
1372 if (name == NULL)
1373 return;
1374
1375 if (dsos) {
1376 /*
1377 * Need to avoid re-sorting the dsos breaking by non-atomically
1378 * renaming the dso.
1379 */
1380 down_write(&dsos->lock);
1381 }
1382 if (dso__short_name_allocated(dso))
1383 free((char *)dso__short_name(dso));
1384
1385 RC_CHK_ACCESS(dso)->short_name = name;
1386 RC_CHK_ACCESS(dso)->short_name_len = strlen(name);
1387 dso__set_short_name_allocated(dso, name_allocated);
1388
1389 if (dsos) {
1390 dsos->sorted = false;
1391 up_write(&dsos->lock);
1392 }
1393}
1394
1395int dso__name_len(const struct dso *dso)
1396{
1397 if (!dso)
1398 return strlen("[unknown]");
1399 if (verbose > 0)
1400 return dso__long_name_len(dso);
1401
1402 return dso__short_name_len(dso);
1403}
1404
1405bool dso__loaded(const struct dso *dso)
1406{
1407 return RC_CHK_ACCESS(dso)->loaded;
1408}
1409
1410bool dso__sorted_by_name(const struct dso *dso)
1411{
1412 return RC_CHK_ACCESS(dso)->sorted_by_name;
1413}
1414
1415void dso__set_sorted_by_name(struct dso *dso)
1416{
1417 RC_CHK_ACCESS(dso)->sorted_by_name = true;
1418}
1419
1420struct dso *dso__new_id(const char *name, const struct dso_id *id)
1421{
1422 RC_STRUCT(dso) *dso = zalloc(sizeof(*dso) + strlen(name) + 1);
1423 struct dso *res;
1424 struct dso_data *data;
1425
1426 if (!dso)
1427 return NULL;
1428
1429 if (ADD_RC_CHK(res, dso)) {
1430 strcpy(dso->name, name);
1431 if (id)
1432 dso->id = *id;
1433 dso__set_long_name_id(res, dso->name, false);
1434 dso__set_short_name(res, dso->name, false);
1435 dso->symbols = RB_ROOT_CACHED;
1436 dso->symbol_names = NULL;
1437 dso->symbol_names_len = 0;
1438 dso->inlined_nodes = RB_ROOT_CACHED;
1439 dso->srclines = RB_ROOT_CACHED;
1440 dso->data_types = RB_ROOT;
1441 dso->global_vars = RB_ROOT;
1442 dso->data.fd = -1;
1443 dso->data.status = DSO_DATA_STATUS_UNKNOWN;
1444 dso->symtab_type = DSO_BINARY_TYPE__NOT_FOUND;
1445 dso->binary_type = DSO_BINARY_TYPE__NOT_FOUND;
1446 dso->is_64_bit = (sizeof(void *) == 8);
1447 dso->loaded = 0;
1448 dso->rel = 0;
1449 dso->sorted_by_name = 0;
1450 dso->has_build_id = 0;
1451 dso->has_srcline = 1;
1452 dso->a2l_fails = 1;
1453 dso->kernel = DSO_SPACE__USER;
1454 dso->is_kmod = 0;
1455 dso->needs_swap = DSO_SWAP__UNSET;
1456 dso->comp = COMP_ID__NONE;
1457 mutex_init(&dso->lock);
1458 refcount_set(&dso->refcnt, 1);
1459 data = &dso->data;
1460 data->cache = RB_ROOT;
1461 data->fd = -1;
1462 data->status = DSO_DATA_STATUS_UNKNOWN;
1463 INIT_LIST_HEAD(&data->open_entry);
1464#ifdef REFCNT_CHECKING
1465 data->dso = NULL; /* Set when on the open_entry list. */
1466#endif
1467 }
1468 return res;
1469}
1470
1471struct dso *dso__new(const char *name)
1472{
1473 return dso__new_id(name, NULL);
1474}
1475
1476void dso__delete(struct dso *dso)
1477{
1478 if (dso__dsos(dso))
1479 pr_err("DSO %s is still in rbtree when being deleted!\n", dso__long_name(dso));
1480
1481 /* free inlines first, as they reference symbols */
1482 inlines__tree_delete(&RC_CHK_ACCESS(dso)->inlined_nodes);
1483 srcline__tree_delete(&RC_CHK_ACCESS(dso)->srclines);
1484 symbols__delete(&RC_CHK_ACCESS(dso)->symbols);
1485 RC_CHK_ACCESS(dso)->symbol_names_len = 0;
1486 zfree(&RC_CHK_ACCESS(dso)->symbol_names);
1487 annotated_data_type__tree_delete(dso__data_types(dso));
1488 global_var_type__tree_delete(dso__global_vars(dso));
1489
1490 if (RC_CHK_ACCESS(dso)->short_name_allocated) {
1491 zfree((char **)&RC_CHK_ACCESS(dso)->short_name);
1492 RC_CHK_ACCESS(dso)->short_name_allocated = false;
1493 }
1494
1495 if (RC_CHK_ACCESS(dso)->long_name_allocated) {
1496 zfree((char **)&RC_CHK_ACCESS(dso)->long_name);
1497 RC_CHK_ACCESS(dso)->long_name_allocated = false;
1498 }
1499
1500 dso__data_close(dso);
1501 auxtrace_cache__free(RC_CHK_ACCESS(dso)->auxtrace_cache);
1502 dso_cache__free(dso);
1503 dso__free_a2l(dso);
1504 dso__free_symsrc_filename(dso);
1505 nsinfo__zput(RC_CHK_ACCESS(dso)->nsinfo);
1506 mutex_destroy(dso__lock(dso));
1507 RC_CHK_FREE(dso);
1508}
1509
1510struct dso *dso__get(struct dso *dso)
1511{
1512 struct dso *result;
1513
1514 if (RC_CHK_GET(result, dso))
1515 refcount_inc(&RC_CHK_ACCESS(dso)->refcnt);
1516
1517 return result;
1518}
1519
1520void dso__put(struct dso *dso)
1521{
1522 if (dso && refcount_dec_and_test(&RC_CHK_ACCESS(dso)->refcnt))
1523 dso__delete(dso);
1524 else
1525 RC_CHK_PUT(dso);
1526}
1527
1528void dso__set_build_id(struct dso *dso, struct build_id *bid)
1529{
1530 RC_CHK_ACCESS(dso)->bid = *bid;
1531 RC_CHK_ACCESS(dso)->has_build_id = 1;
1532}
1533
1534bool dso__build_id_equal(const struct dso *dso, struct build_id *bid)
1535{
1536 const struct build_id *dso_bid = dso__bid_const(dso);
1537
1538 if (dso_bid->size > bid->size && dso_bid->size == BUILD_ID_SIZE) {
1539 /*
1540 * For the backward compatibility, it allows a build-id has
1541 * trailing zeros.
1542 */
1543 return !memcmp(dso_bid->data, bid->data, bid->size) &&
1544 !memchr_inv(&dso_bid->data[bid->size], 0,
1545 dso_bid->size - bid->size);
1546 }
1547
1548 return dso_bid->size == bid->size &&
1549 memcmp(dso_bid->data, bid->data, dso_bid->size) == 0;
1550}
1551
1552void dso__read_running_kernel_build_id(struct dso *dso, struct machine *machine)
1553{
1554 char path[PATH_MAX];
1555
1556 if (machine__is_default_guest(machine))
1557 return;
1558 sprintf(path, "%s/sys/kernel/notes", machine->root_dir);
1559 if (sysfs__read_build_id(path, dso__bid(dso)) == 0)
1560 dso__set_has_build_id(dso);
1561}
1562
1563int dso__kernel_module_get_build_id(struct dso *dso,
1564 const char *root_dir)
1565{
1566 char filename[PATH_MAX];
1567 /*
1568 * kernel module short names are of the form "[module]" and
1569 * we need just "module" here.
1570 */
1571 const char *name = dso__short_name(dso) + 1;
1572
1573 snprintf(filename, sizeof(filename),
1574 "%s/sys/module/%.*s/notes/.note.gnu.build-id",
1575 root_dir, (int)strlen(name) - 1, name);
1576
1577 if (sysfs__read_build_id(filename, dso__bid(dso)) == 0)
1578 dso__set_has_build_id(dso);
1579
1580 return 0;
1581}
1582
1583static size_t dso__fprintf_buildid(struct dso *dso, FILE *fp)
1584{
1585 char sbuild_id[SBUILD_ID_SIZE];
1586
1587 build_id__sprintf(dso__bid(dso), sbuild_id);
1588 return fprintf(fp, "%s", sbuild_id);
1589}
1590
1591size_t dso__fprintf(struct dso *dso, FILE *fp)
1592{
1593 struct rb_node *nd;
1594 size_t ret = fprintf(fp, "dso: %s (", dso__short_name(dso));
1595
1596 if (dso__short_name(dso) != dso__long_name(dso))
1597 ret += fprintf(fp, "%s, ", dso__long_name(dso));
1598 ret += fprintf(fp, "%sloaded, ", dso__loaded(dso) ? "" : "NOT ");
1599 ret += dso__fprintf_buildid(dso, fp);
1600 ret += fprintf(fp, ")\n");
1601 for (nd = rb_first_cached(dso__symbols(dso)); nd; nd = rb_next(nd)) {
1602 struct symbol *pos = rb_entry(nd, struct symbol, rb_node);
1603 ret += symbol__fprintf(pos, fp);
1604 }
1605
1606 return ret;
1607}
1608
1609enum dso_type dso__type(struct dso *dso, struct machine *machine)
1610{
1611 int fd;
1612 enum dso_type type = DSO__TYPE_UNKNOWN;
1613
1614 fd = dso__data_get_fd(dso, machine);
1615 if (fd >= 0) {
1616 type = dso__type_fd(fd);
1617 dso__data_put_fd(dso);
1618 }
1619
1620 return type;
1621}
1622
1623int dso__strerror_load(struct dso *dso, char *buf, size_t buflen)
1624{
1625 int idx, errnum = *dso__load_errno(dso);
1626 /*
1627 * This must have a same ordering as the enum dso_load_errno.
1628 */
1629 static const char *dso_load__error_str[] = {
1630 "Internal tools/perf/ library error",
1631 "Invalid ELF file",
1632 "Can not read build id",
1633 "Mismatching build id",
1634 "Decompression failure",
1635 };
1636
1637 BUG_ON(buflen == 0);
1638
1639 if (errnum >= 0) {
1640 const char *err = str_error_r(errnum, buf, buflen);
1641
1642 if (err != buf)
1643 scnprintf(buf, buflen, "%s", err);
1644
1645 return 0;
1646 }
1647
1648 if (errnum < __DSO_LOAD_ERRNO__START || errnum >= __DSO_LOAD_ERRNO__END)
1649 return -1;
1650
1651 idx = errnum - __DSO_LOAD_ERRNO__START;
1652 scnprintf(buf, buflen, "%s", dso_load__error_str[idx]);
1653 return 0;
1654}
1655
1656bool perf_pid_map_tid(const char *dso_name, int *tid)
1657{
1658 return sscanf(dso_name, "/tmp/perf-%d.map", tid) == 1;
1659}
1660
1661bool is_perf_pid_map_name(const char *dso_name)
1662{
1663 int tid;
1664
1665 return perf_pid_map_tid(dso_name, &tid);
1666}
1// SPDX-License-Identifier: GPL-2.0
2#include <asm/bug.h>
3#include <linux/kernel.h>
4#include <linux/string.h>
5#include <linux/zalloc.h>
6#include <sys/time.h>
7#include <sys/resource.h>
8#include <sys/types.h>
9#include <sys/stat.h>
10#include <unistd.h>
11#include <errno.h>
12#include <fcntl.h>
13#include <stdlib.h>
14#include <bpf/libbpf.h>
15#include "bpf-event.h"
16#include "compress.h"
17#include "env.h"
18#include "namespaces.h"
19#include "path.h"
20#include "map.h"
21#include "symbol.h"
22#include "srcline.h"
23#include "dso.h"
24#include "dsos.h"
25#include "machine.h"
26#include "auxtrace.h"
27#include "util.h" /* O_CLOEXEC for older systems */
28#include "debug.h"
29#include "string2.h"
30#include "vdso.h"
31
32static const char * const debuglink_paths[] = {
33 "%.0s%s",
34 "%s/%s",
35 "%s/.debug/%s",
36 "/usr/lib/debug%s/%s"
37};
38
39char dso__symtab_origin(const struct dso *dso)
40{
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',
60 };
61
62 if (dso == NULL || dso->symtab_type == DSO_BINARY_TYPE__NOT_FOUND)
63 return '!';
64 return origin[dso->symtab_type];
65}
66
67int dso__read_binary_type_filename(const struct dso *dso,
68 enum dso_binary_type type,
69 char *root_dir, char *filename, size_t size)
70{
71 char build_id_hex[SBUILD_ID_SIZE];
72 int ret = 0;
73 size_t len;
74
75 switch (type) {
76 case DSO_BINARY_TYPE__DEBUGLINK:
77 {
78 const char *last_slash;
79 char dso_dir[PATH_MAX];
80 char symfile[PATH_MAX];
81 unsigned int i;
82
83 len = __symbol__join_symfs(filename, size, dso->long_name);
84 last_slash = filename + len;
85 while (last_slash != filename && *last_slash != '/')
86 last_slash--;
87
88 strncpy(dso_dir, filename, last_slash - filename);
89 dso_dir[last_slash-filename] = '\0';
90
91 if (!is_regular_file(filename)) {
92 ret = -1;
93 break;
94 }
95
96 ret = filename__read_debuglink(filename, symfile, PATH_MAX);
97 if (ret)
98 break;
99
100 /* Check predefined locations where debug file might reside */
101 ret = -1;
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)) {
106 ret = 0;
107 break;
108 }
109 }
110
111 break;
112 }
113 case DSO_BINARY_TYPE__BUILD_ID_CACHE:
114 if (dso__build_id_filename(dso, filename, size, false) == NULL)
115 ret = -1;
116 break;
117
118 case DSO_BINARY_TYPE__BUILD_ID_CACHE_DEBUGINFO:
119 if (dso__build_id_filename(dso, filename, size, true) == NULL)
120 ret = -1;
121 break;
122
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);
126 break;
127
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);
131 break;
132
133 case DSO_BINARY_TYPE__MIXEDUP_UBUNTU_DEBUGINFO:
134 /*
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
138 */
139 if (strlen(dso->long_name) < 9 ||
140 strncmp(dso->long_name, "/usr/lib/", 9)) {
141 ret = -1;
142 break;
143 }
144 len = __symbol__join_symfs(filename, size, "/usr/lib/debug");
145 snprintf(filename + len, size - len, "%s", dso->long_name + 4);
146 break;
147
148 case DSO_BINARY_TYPE__OPENEMBEDDED_DEBUGINFO:
149 {
150 const char *last_slash;
151 size_t dir_size;
152
153 last_slash = dso->long_name + dso->long_name_len;
154 while (last_slash != dso->long_name && *last_slash != '/')
155 last_slash--;
156
157 len = __symbol__join_symfs(filename, size, "");
158 dir_size = last_slash - dso->long_name + 2;
159 if (dir_size > (size - len)) {
160 ret = -1;
161 break;
162 }
163 len += scnprintf(filename + len, dir_size, "%s", dso->long_name);
164 len += scnprintf(filename + len , size - len, ".debug%s",
165 last_slash);
166 break;
167 }
168
169 case DSO_BINARY_TYPE__BUILDID_DEBUGINFO:
170 if (!dso->has_build_id) {
171 ret = -1;
172 break;
173 }
174
175 build_id__sprintf(dso->build_id,
176 sizeof(dso->build_id),
177 build_id_hex);
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);
181 break;
182
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);
187 break;
188
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);
193 break;
194
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);
198 break;
199
200 case DSO_BINARY_TYPE__KCORE:
201 case DSO_BINARY_TYPE__GUEST_KCORE:
202 snprintf(filename, size, "%s", dso->long_name);
203 break;
204
205 default:
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__OOL:
212 case DSO_BINARY_TYPE__NOT_FOUND:
213 ret = -1;
214 break;
215 }
216
217 return ret;
218}
219
220enum {
221 COMP_ID__NONE = 0,
222};
223
224static const struct {
225 const char *fmt;
226 int (*decompress)(const char *input, int output);
227 bool (*is_compressed)(const char *input);
228} compressions[] = {
229 [COMP_ID__NONE] = { .fmt = NULL, },
230#ifdef HAVE_ZLIB_SUPPORT
231 { "gz", gzip_decompress_to_file, gzip_is_compressed },
232#endif
233#ifdef HAVE_LZMA_SUPPORT
234 { "xz", lzma_decompress_to_file, lzma_is_compressed },
235#endif
236 { NULL, NULL, NULL },
237};
238
239static int is_supported_compression(const char *ext)
240{
241 unsigned i;
242
243 for (i = 1; compressions[i].fmt; i++) {
244 if (!strcmp(ext, compressions[i].fmt))
245 return i;
246 }
247 return COMP_ID__NONE;
248}
249
250bool is_kernel_module(const char *pathname, int cpumode)
251{
252 struct kmod_path m;
253 int mode = cpumode & PERF_RECORD_MISC_CPUMODE_MASK;
254
255 WARN_ONCE(mode != cpumode,
256 "Internal error: passing unmasked cpumode (%x) to is_kernel_module",
257 cpumode);
258
259 switch (mode) {
260 case PERF_RECORD_MISC_USER:
261 case PERF_RECORD_MISC_HYPERVISOR:
262 case PERF_RECORD_MISC_GUEST_USER:
263 return false;
264 /* Treat PERF_RECORD_MISC_CPUMODE_UNKNOWN as kernel */
265 default:
266 if (kmod_path__parse(&m, pathname)) {
267 pr_err("Failed to check whether %s is a kernel module or not. Assume it is.",
268 pathname);
269 return true;
270 }
271 }
272
273 return m.kmod;
274}
275
276bool dso__needs_decompress(struct dso *dso)
277{
278 return dso->symtab_type == DSO_BINARY_TYPE__SYSTEM_PATH_KMODULE_COMP ||
279 dso->symtab_type == DSO_BINARY_TYPE__GUEST_KMODULE_COMP;
280}
281
282static int decompress_kmodule(struct dso *dso, const char *name,
283 char *pathname, size_t len)
284{
285 char tmpbuf[] = KMOD_DECOMP_NAME;
286 int fd = -1;
287
288 if (!dso__needs_decompress(dso))
289 return -1;
290
291 if (dso->comp == COMP_ID__NONE)
292 return -1;
293
294 /*
295 * We have proper compression id for DSO and yet the file
296 * behind the 'name' can still be plain uncompressed object.
297 *
298 * The reason is behind the logic we open the DSO object files,
299 * when we try all possible 'debug' objects until we find the
300 * data. So even if the DSO is represented by 'krava.xz' module,
301 * we can end up here opening ~/.debug/....23432432/debug' file
302 * which is not compressed.
303 *
304 * To keep this transparent, we detect this and return the file
305 * descriptor to the uncompressed file.
306 */
307 if (!compressions[dso->comp].is_compressed(name))
308 return open(name, O_RDONLY);
309
310 fd = mkstemp(tmpbuf);
311 if (fd < 0) {
312 dso->load_errno = errno;
313 return -1;
314 }
315
316 if (compressions[dso->comp].decompress(name, fd)) {
317 dso->load_errno = DSO_LOAD_ERRNO__DECOMPRESSION_FAILURE;
318 close(fd);
319 fd = -1;
320 }
321
322 if (!pathname || (fd < 0))
323 unlink(tmpbuf);
324
325 if (pathname && (fd >= 0))
326 strlcpy(pathname, tmpbuf, len);
327
328 return fd;
329}
330
331int dso__decompress_kmodule_fd(struct dso *dso, const char *name)
332{
333 return decompress_kmodule(dso, name, NULL, 0);
334}
335
336int dso__decompress_kmodule_path(struct dso *dso, const char *name,
337 char *pathname, size_t len)
338{
339 int fd = decompress_kmodule(dso, name, pathname, len);
340
341 close(fd);
342 return fd >= 0 ? 0 : -1;
343}
344
345/*
346 * Parses kernel module specified in @path and updates
347 * @m argument like:
348 *
349 * @comp - true if @path contains supported compression suffix,
350 * false otherwise
351 * @kmod - true if @path contains '.ko' suffix in right position,
352 * false otherwise
353 * @name - if (@alloc_name && @kmod) is true, it contains strdup-ed base name
354 * of the kernel module without suffixes, otherwise strudup-ed
355 * base name of @path
356 * @ext - if (@alloc_ext && @comp) is true, it contains strdup-ed string
357 * the compression suffix
358 *
359 * Returns 0 if there's no strdup error, -ENOMEM otherwise.
360 */
361int __kmod_path__parse(struct kmod_path *m, const char *path,
362 bool alloc_name)
363{
364 const char *name = strrchr(path, '/');
365 const char *ext = strrchr(path, '.');
366 bool is_simple_name = false;
367
368 memset(m, 0x0, sizeof(*m));
369 name = name ? name + 1 : path;
370
371 /*
372 * '.' is also a valid character for module name. For example:
373 * [aaa.bbb] is a valid module name. '[' should have higher
374 * priority than '.ko' suffix.
375 *
376 * The kernel names are from machine__mmap_name. Such
377 * name should belong to kernel itself, not kernel module.
378 */
379 if (name[0] == '[') {
380 is_simple_name = true;
381 if ((strncmp(name, "[kernel.kallsyms]", 17) == 0) ||
382 (strncmp(name, "[guest.kernel.kallsyms", 22) == 0) ||
383 (strncmp(name, "[vdso]", 6) == 0) ||
384 (strncmp(name, "[vdso32]", 8) == 0) ||
385 (strncmp(name, "[vdsox32]", 9) == 0) ||
386 (strncmp(name, "[vsyscall]", 10) == 0)) {
387 m->kmod = false;
388
389 } else
390 m->kmod = true;
391 }
392
393 /* No extension, just return name. */
394 if ((ext == NULL) || is_simple_name) {
395 if (alloc_name) {
396 m->name = strdup(name);
397 return m->name ? 0 : -ENOMEM;
398 }
399 return 0;
400 }
401
402 m->comp = is_supported_compression(ext + 1);
403 if (m->comp > COMP_ID__NONE)
404 ext -= 3;
405
406 /* Check .ko extension only if there's enough name left. */
407 if (ext > name)
408 m->kmod = !strncmp(ext, ".ko", 3);
409
410 if (alloc_name) {
411 if (m->kmod) {
412 if (asprintf(&m->name, "[%.*s]", (int) (ext - name), name) == -1)
413 return -ENOMEM;
414 } else {
415 if (asprintf(&m->name, "%s", name) == -1)
416 return -ENOMEM;
417 }
418
419 strreplace(m->name, '-', '_');
420 }
421
422 return 0;
423}
424
425void dso__set_module_info(struct dso *dso, struct kmod_path *m,
426 struct machine *machine)
427{
428 if (machine__is_host(machine))
429 dso->symtab_type = DSO_BINARY_TYPE__SYSTEM_PATH_KMODULE;
430 else
431 dso->symtab_type = DSO_BINARY_TYPE__GUEST_KMODULE;
432
433 /* _KMODULE_COMP should be next to _KMODULE */
434 if (m->kmod && m->comp) {
435 dso->symtab_type++;
436 dso->comp = m->comp;
437 }
438
439 dso__set_short_name(dso, strdup(m->name), true);
440}
441
442/*
443 * Global list of open DSOs and the counter.
444 */
445static LIST_HEAD(dso__data_open);
446static long dso__data_open_cnt;
447static pthread_mutex_t dso__data_open_lock = PTHREAD_MUTEX_INITIALIZER;
448
449static void dso__list_add(struct dso *dso)
450{
451 list_add_tail(&dso->data.open_entry, &dso__data_open);
452 dso__data_open_cnt++;
453}
454
455static void dso__list_del(struct dso *dso)
456{
457 list_del_init(&dso->data.open_entry);
458 WARN_ONCE(dso__data_open_cnt <= 0,
459 "DSO data fd counter out of bounds.");
460 dso__data_open_cnt--;
461}
462
463static void close_first_dso(void);
464
465static int do_open(char *name)
466{
467 int fd;
468 char sbuf[STRERR_BUFSIZE];
469
470 do {
471 fd = open(name, O_RDONLY|O_CLOEXEC);
472 if (fd >= 0)
473 return fd;
474
475 pr_debug("dso open failed: %s\n",
476 str_error_r(errno, sbuf, sizeof(sbuf)));
477 if (!dso__data_open_cnt || errno != EMFILE)
478 break;
479
480 close_first_dso();
481 } while (1);
482
483 return -1;
484}
485
486static int __open_dso(struct dso *dso, struct machine *machine)
487{
488 int fd = -EINVAL;
489 char *root_dir = (char *)"";
490 char *name = malloc(PATH_MAX);
491 bool decomp = false;
492
493 if (!name)
494 return -ENOMEM;
495
496 if (machine)
497 root_dir = machine->root_dir;
498
499 if (dso__read_binary_type_filename(dso, dso->binary_type,
500 root_dir, name, PATH_MAX))
501 goto out;
502
503 if (!is_regular_file(name))
504 goto out;
505
506 if (dso__needs_decompress(dso)) {
507 char newpath[KMOD_DECOMP_LEN];
508 size_t len = sizeof(newpath);
509
510 if (dso__decompress_kmodule_path(dso, name, newpath, len) < 0) {
511 fd = -dso->load_errno;
512 goto out;
513 }
514
515 decomp = true;
516 strcpy(name, newpath);
517 }
518
519 fd = do_open(name);
520
521 if (decomp)
522 unlink(name);
523
524out:
525 free(name);
526 return fd;
527}
528
529static void check_data_close(void);
530
531/**
532 * dso_close - Open DSO data file
533 * @dso: dso object
534 *
535 * Open @dso's data file descriptor and updates
536 * list/count of open DSO objects.
537 */
538static int open_dso(struct dso *dso, struct machine *machine)
539{
540 int fd;
541 struct nscookie nsc;
542
543 if (dso->binary_type != DSO_BINARY_TYPE__BUILD_ID_CACHE)
544 nsinfo__mountns_enter(dso->nsinfo, &nsc);
545 fd = __open_dso(dso, machine);
546 if (dso->binary_type != DSO_BINARY_TYPE__BUILD_ID_CACHE)
547 nsinfo__mountns_exit(&nsc);
548
549 if (fd >= 0) {
550 dso__list_add(dso);
551 /*
552 * Check if we crossed the allowed number
553 * of opened DSOs and close one if needed.
554 */
555 check_data_close();
556 }
557
558 return fd;
559}
560
561static void close_data_fd(struct dso *dso)
562{
563 if (dso->data.fd >= 0) {
564 close(dso->data.fd);
565 dso->data.fd = -1;
566 dso->data.file_size = 0;
567 dso__list_del(dso);
568 }
569}
570
571/**
572 * dso_close - Close DSO data file
573 * @dso: dso object
574 *
575 * Close @dso's data file descriptor and updates
576 * list/count of open DSO objects.
577 */
578static void close_dso(struct dso *dso)
579{
580 close_data_fd(dso);
581}
582
583static void close_first_dso(void)
584{
585 struct dso *dso;
586
587 dso = list_first_entry(&dso__data_open, struct dso, data.open_entry);
588 close_dso(dso);
589}
590
591static rlim_t get_fd_limit(void)
592{
593 struct rlimit l;
594 rlim_t limit = 0;
595
596 /* Allow half of the current open fd limit. */
597 if (getrlimit(RLIMIT_NOFILE, &l) == 0) {
598 if (l.rlim_cur == RLIM_INFINITY)
599 limit = l.rlim_cur;
600 else
601 limit = l.rlim_cur / 2;
602 } else {
603 pr_err("failed to get fd limit\n");
604 limit = 1;
605 }
606
607 return limit;
608}
609
610static rlim_t fd_limit;
611
612/*
613 * Used only by tests/dso-data.c to reset the environment
614 * for tests. I dont expect we should change this during
615 * standard runtime.
616 */
617void reset_fd_limit(void)
618{
619 fd_limit = 0;
620}
621
622static bool may_cache_fd(void)
623{
624 if (!fd_limit)
625 fd_limit = get_fd_limit();
626
627 if (fd_limit == RLIM_INFINITY)
628 return true;
629
630 return fd_limit > (rlim_t) dso__data_open_cnt;
631}
632
633/*
634 * Check and close LRU dso if we crossed allowed limit
635 * for opened dso file descriptors. The limit is half
636 * of the RLIMIT_NOFILE files opened.
637*/
638static void check_data_close(void)
639{
640 bool cache_fd = may_cache_fd();
641
642 if (!cache_fd)
643 close_first_dso();
644}
645
646/**
647 * dso__data_close - Close DSO data file
648 * @dso: dso object
649 *
650 * External interface to close @dso's data file descriptor.
651 */
652void dso__data_close(struct dso *dso)
653{
654 pthread_mutex_lock(&dso__data_open_lock);
655 close_dso(dso);
656 pthread_mutex_unlock(&dso__data_open_lock);
657}
658
659static void try_to_open_dso(struct dso *dso, struct machine *machine)
660{
661 enum dso_binary_type binary_type_data[] = {
662 DSO_BINARY_TYPE__BUILD_ID_CACHE,
663 DSO_BINARY_TYPE__SYSTEM_PATH_DSO,
664 DSO_BINARY_TYPE__NOT_FOUND,
665 };
666 int i = 0;
667
668 if (dso->data.fd >= 0)
669 return;
670
671 if (dso->binary_type != DSO_BINARY_TYPE__NOT_FOUND) {
672 dso->data.fd = open_dso(dso, machine);
673 goto out;
674 }
675
676 do {
677 dso->binary_type = binary_type_data[i++];
678
679 dso->data.fd = open_dso(dso, machine);
680 if (dso->data.fd >= 0)
681 goto out;
682
683 } while (dso->binary_type != DSO_BINARY_TYPE__NOT_FOUND);
684out:
685 if (dso->data.fd >= 0)
686 dso->data.status = DSO_DATA_STATUS_OK;
687 else
688 dso->data.status = DSO_DATA_STATUS_ERROR;
689}
690
691/**
692 * dso__data_get_fd - Get dso's data file descriptor
693 * @dso: dso object
694 * @machine: machine object
695 *
696 * External interface to find dso's file, open it and
697 * returns file descriptor. It should be paired with
698 * dso__data_put_fd() if it returns non-negative value.
699 */
700int dso__data_get_fd(struct dso *dso, struct machine *machine)
701{
702 if (dso->data.status == DSO_DATA_STATUS_ERROR)
703 return -1;
704
705 if (pthread_mutex_lock(&dso__data_open_lock) < 0)
706 return -1;
707
708 try_to_open_dso(dso, machine);
709
710 if (dso->data.fd < 0)
711 pthread_mutex_unlock(&dso__data_open_lock);
712
713 return dso->data.fd;
714}
715
716void dso__data_put_fd(struct dso *dso __maybe_unused)
717{
718 pthread_mutex_unlock(&dso__data_open_lock);
719}
720
721bool dso__data_status_seen(struct dso *dso, enum dso_data_status_seen by)
722{
723 u32 flag = 1 << by;
724
725 if (dso->data.status_seen & flag)
726 return true;
727
728 dso->data.status_seen |= flag;
729
730 return false;
731}
732
733static ssize_t bpf_read(struct dso *dso, u64 offset, char *data)
734{
735 struct bpf_prog_info_node *node;
736 ssize_t size = DSO__DATA_CACHE_SIZE;
737 u64 len;
738 u8 *buf;
739
740 node = perf_env__find_bpf_prog_info(dso->bpf_prog.env, dso->bpf_prog.id);
741 if (!node || !node->info_linear) {
742 dso->data.status = DSO_DATA_STATUS_ERROR;
743 return -1;
744 }
745
746 len = node->info_linear->info.jited_prog_len;
747 buf = (u8 *)(uintptr_t)node->info_linear->info.jited_prog_insns;
748
749 if (offset >= len)
750 return -1;
751
752 size = (ssize_t)min(len - offset, (u64)size);
753 memcpy(data, buf + offset, size);
754 return size;
755}
756
757static int bpf_size(struct dso *dso)
758{
759 struct bpf_prog_info_node *node;
760
761 node = perf_env__find_bpf_prog_info(dso->bpf_prog.env, dso->bpf_prog.id);
762 if (!node || !node->info_linear) {
763 dso->data.status = DSO_DATA_STATUS_ERROR;
764 return -1;
765 }
766
767 dso->data.file_size = node->info_linear->info.jited_prog_len;
768 return 0;
769}
770
771static void
772dso_cache__free(struct dso *dso)
773{
774 struct rb_root *root = &dso->data.cache;
775 struct rb_node *next = rb_first(root);
776
777 pthread_mutex_lock(&dso->lock);
778 while (next) {
779 struct dso_cache *cache;
780
781 cache = rb_entry(next, struct dso_cache, rb_node);
782 next = rb_next(&cache->rb_node);
783 rb_erase(&cache->rb_node, root);
784 free(cache);
785 }
786 pthread_mutex_unlock(&dso->lock);
787}
788
789static struct dso_cache *__dso_cache__find(struct dso *dso, u64 offset)
790{
791 const struct rb_root *root = &dso->data.cache;
792 struct rb_node * const *p = &root->rb_node;
793 const struct rb_node *parent = NULL;
794 struct dso_cache *cache;
795
796 while (*p != NULL) {
797 u64 end;
798
799 parent = *p;
800 cache = rb_entry(parent, struct dso_cache, rb_node);
801 end = cache->offset + DSO__DATA_CACHE_SIZE;
802
803 if (offset < cache->offset)
804 p = &(*p)->rb_left;
805 else if (offset >= end)
806 p = &(*p)->rb_right;
807 else
808 return cache;
809 }
810
811 return NULL;
812}
813
814static struct dso_cache *
815dso_cache__insert(struct dso *dso, struct dso_cache *new)
816{
817 struct rb_root *root = &dso->data.cache;
818 struct rb_node **p = &root->rb_node;
819 struct rb_node *parent = NULL;
820 struct dso_cache *cache;
821 u64 offset = new->offset;
822
823 pthread_mutex_lock(&dso->lock);
824 while (*p != NULL) {
825 u64 end;
826
827 parent = *p;
828 cache = rb_entry(parent, struct dso_cache, rb_node);
829 end = cache->offset + DSO__DATA_CACHE_SIZE;
830
831 if (offset < cache->offset)
832 p = &(*p)->rb_left;
833 else if (offset >= end)
834 p = &(*p)->rb_right;
835 else
836 goto out;
837 }
838
839 rb_link_node(&new->rb_node, parent, p);
840 rb_insert_color(&new->rb_node, root);
841
842 cache = NULL;
843out:
844 pthread_mutex_unlock(&dso->lock);
845 return cache;
846}
847
848static ssize_t dso_cache__memcpy(struct dso_cache *cache, u64 offset, u8 *data,
849 u64 size, bool out)
850{
851 u64 cache_offset = offset - cache->offset;
852 u64 cache_size = min(cache->size - cache_offset, size);
853
854 if (out)
855 memcpy(data, cache->data + cache_offset, cache_size);
856 else
857 memcpy(cache->data + cache_offset, data, cache_size);
858 return cache_size;
859}
860
861static ssize_t file_read(struct dso *dso, struct machine *machine,
862 u64 offset, char *data)
863{
864 ssize_t ret;
865
866 pthread_mutex_lock(&dso__data_open_lock);
867
868 /*
869 * dso->data.fd might be closed if other thread opened another
870 * file (dso) due to open file limit (RLIMIT_NOFILE).
871 */
872 try_to_open_dso(dso, machine);
873
874 if (dso->data.fd < 0) {
875 dso->data.status = DSO_DATA_STATUS_ERROR;
876 ret = -errno;
877 goto out;
878 }
879
880 ret = pread(dso->data.fd, data, DSO__DATA_CACHE_SIZE, offset);
881out:
882 pthread_mutex_unlock(&dso__data_open_lock);
883 return ret;
884}
885
886static struct dso_cache *dso_cache__populate(struct dso *dso,
887 struct machine *machine,
888 u64 offset, ssize_t *ret)
889{
890 u64 cache_offset = offset & DSO__DATA_CACHE_MASK;
891 struct dso_cache *cache;
892 struct dso_cache *old;
893
894 cache = zalloc(sizeof(*cache) + DSO__DATA_CACHE_SIZE);
895 if (!cache) {
896 *ret = -ENOMEM;
897 return NULL;
898 }
899
900 if (dso->binary_type == DSO_BINARY_TYPE__BPF_PROG_INFO)
901 *ret = bpf_read(dso, cache_offset, cache->data);
902 else if (dso->binary_type == DSO_BINARY_TYPE__OOL)
903 *ret = DSO__DATA_CACHE_SIZE;
904 else
905 *ret = file_read(dso, machine, cache_offset, cache->data);
906
907 if (*ret <= 0) {
908 free(cache);
909 return NULL;
910 }
911
912 cache->offset = cache_offset;
913 cache->size = *ret;
914
915 old = dso_cache__insert(dso, cache);
916 if (old) {
917 /* we lose the race */
918 free(cache);
919 cache = old;
920 }
921
922 return cache;
923}
924
925static struct dso_cache *dso_cache__find(struct dso *dso,
926 struct machine *machine,
927 u64 offset,
928 ssize_t *ret)
929{
930 struct dso_cache *cache = __dso_cache__find(dso, offset);
931
932 return cache ? cache : dso_cache__populate(dso, machine, offset, ret);
933}
934
935static ssize_t dso_cache_io(struct dso *dso, struct machine *machine,
936 u64 offset, u8 *data, ssize_t size, bool out)
937{
938 struct dso_cache *cache;
939 ssize_t ret = 0;
940
941 cache = dso_cache__find(dso, machine, offset, &ret);
942 if (!cache)
943 return ret;
944
945 return dso_cache__memcpy(cache, offset, data, size, out);
946}
947
948/*
949 * Reads and caches dso data DSO__DATA_CACHE_SIZE size chunks
950 * in the rb_tree. Any read to already cached data is served
951 * by cached data. Writes update the cache only, not the backing file.
952 */
953static ssize_t cached_io(struct dso *dso, struct machine *machine,
954 u64 offset, u8 *data, ssize_t size, bool out)
955{
956 ssize_t r = 0;
957 u8 *p = data;
958
959 do {
960 ssize_t ret;
961
962 ret = dso_cache_io(dso, machine, offset, p, size, out);
963 if (ret < 0)
964 return ret;
965
966 /* Reached EOF, return what we have. */
967 if (!ret)
968 break;
969
970 BUG_ON(ret > size);
971
972 r += ret;
973 p += ret;
974 offset += ret;
975 size -= ret;
976
977 } while (size);
978
979 return r;
980}
981
982static int file_size(struct dso *dso, struct machine *machine)
983{
984 int ret = 0;
985 struct stat st;
986 char sbuf[STRERR_BUFSIZE];
987
988 pthread_mutex_lock(&dso__data_open_lock);
989
990 /*
991 * dso->data.fd might be closed if other thread opened another
992 * file (dso) due to open file limit (RLIMIT_NOFILE).
993 */
994 try_to_open_dso(dso, machine);
995
996 if (dso->data.fd < 0) {
997 ret = -errno;
998 dso->data.status = DSO_DATA_STATUS_ERROR;
999 goto out;
1000 }
1001
1002 if (fstat(dso->data.fd, &st) < 0) {
1003 ret = -errno;
1004 pr_err("dso cache fstat failed: %s\n",
1005 str_error_r(errno, sbuf, sizeof(sbuf)));
1006 dso->data.status = DSO_DATA_STATUS_ERROR;
1007 goto out;
1008 }
1009 dso->data.file_size = st.st_size;
1010
1011out:
1012 pthread_mutex_unlock(&dso__data_open_lock);
1013 return ret;
1014}
1015
1016int dso__data_file_size(struct dso *dso, struct machine *machine)
1017{
1018 if (dso->data.file_size)
1019 return 0;
1020
1021 if (dso->data.status == DSO_DATA_STATUS_ERROR)
1022 return -1;
1023
1024 if (dso->binary_type == DSO_BINARY_TYPE__BPF_PROG_INFO)
1025 return bpf_size(dso);
1026
1027 return file_size(dso, machine);
1028}
1029
1030/**
1031 * dso__data_size - Return dso data size
1032 * @dso: dso object
1033 * @machine: machine object
1034 *
1035 * Return: dso data size
1036 */
1037off_t dso__data_size(struct dso *dso, struct machine *machine)
1038{
1039 if (dso__data_file_size(dso, machine))
1040 return -1;
1041
1042 /* For now just estimate dso data size is close to file size */
1043 return dso->data.file_size;
1044}
1045
1046static ssize_t data_read_write_offset(struct dso *dso, struct machine *machine,
1047 u64 offset, u8 *data, ssize_t size,
1048 bool out)
1049{
1050 if (dso__data_file_size(dso, machine))
1051 return -1;
1052
1053 /* Check the offset sanity. */
1054 if (offset > dso->data.file_size)
1055 return -1;
1056
1057 if (offset + size < offset)
1058 return -1;
1059
1060 return cached_io(dso, machine, offset, data, size, out);
1061}
1062
1063/**
1064 * dso__data_read_offset - Read data from dso file offset
1065 * @dso: dso object
1066 * @machine: machine object
1067 * @offset: file offset
1068 * @data: buffer to store data
1069 * @size: size of the @data buffer
1070 *
1071 * External interface to read data from dso file offset. Open
1072 * dso data file and use cached_read to get the data.
1073 */
1074ssize_t dso__data_read_offset(struct dso *dso, struct machine *machine,
1075 u64 offset, u8 *data, ssize_t size)
1076{
1077 if (dso->data.status == DSO_DATA_STATUS_ERROR)
1078 return -1;
1079
1080 return data_read_write_offset(dso, machine, offset, data, size, true);
1081}
1082
1083/**
1084 * dso__data_read_addr - Read data from dso address
1085 * @dso: dso object
1086 * @machine: machine object
1087 * @add: virtual memory address
1088 * @data: buffer to store data
1089 * @size: size of the @data buffer
1090 *
1091 * External interface to read data from dso address.
1092 */
1093ssize_t dso__data_read_addr(struct dso *dso, struct map *map,
1094 struct machine *machine, u64 addr,
1095 u8 *data, ssize_t size)
1096{
1097 u64 offset = map->map_ip(map, addr);
1098 return dso__data_read_offset(dso, machine, offset, data, size);
1099}
1100
1101/**
1102 * dso__data_write_cache_offs - Write data to dso data cache at file offset
1103 * @dso: dso object
1104 * @machine: machine object
1105 * @offset: file offset
1106 * @data: buffer to write
1107 * @size: size of the @data buffer
1108 *
1109 * Write into the dso file data cache, but do not change the file itself.
1110 */
1111ssize_t dso__data_write_cache_offs(struct dso *dso, struct machine *machine,
1112 u64 offset, const u8 *data_in, ssize_t size)
1113{
1114 u8 *data = (u8 *)data_in; /* cast away const to use same fns for r/w */
1115
1116 if (dso->data.status == DSO_DATA_STATUS_ERROR)
1117 return -1;
1118
1119 return data_read_write_offset(dso, machine, offset, data, size, false);
1120}
1121
1122/**
1123 * dso__data_write_cache_addr - Write data to dso data cache at dso address
1124 * @dso: dso object
1125 * @machine: machine object
1126 * @add: virtual memory address
1127 * @data: buffer to write
1128 * @size: size of the @data buffer
1129 *
1130 * External interface to write into the dso file data cache, but do not change
1131 * the file itself.
1132 */
1133ssize_t dso__data_write_cache_addr(struct dso *dso, struct map *map,
1134 struct machine *machine, u64 addr,
1135 const u8 *data, ssize_t size)
1136{
1137 u64 offset = map->map_ip(map, addr);
1138 return dso__data_write_cache_offs(dso, machine, offset, data, size);
1139}
1140
1141struct map *dso__new_map(const char *name)
1142{
1143 struct map *map = NULL;
1144 struct dso *dso = dso__new(name);
1145
1146 if (dso)
1147 map = map__new2(0, dso);
1148
1149 return map;
1150}
1151
1152struct dso *machine__findnew_kernel(struct machine *machine, const char *name,
1153 const char *short_name, int dso_type)
1154{
1155 /*
1156 * The kernel dso could be created by build_id processing.
1157 */
1158 struct dso *dso = machine__findnew_dso(machine, name);
1159
1160 /*
1161 * We need to run this in all cases, since during the build_id
1162 * processing we had no idea this was the kernel dso.
1163 */
1164 if (dso != NULL) {
1165 dso__set_short_name(dso, short_name, false);
1166 dso->kernel = dso_type;
1167 }
1168
1169 return dso;
1170}
1171
1172static void dso__set_long_name_id(struct dso *dso, const char *name, struct dso_id *id, bool name_allocated)
1173{
1174 struct rb_root *root = dso->root;
1175
1176 if (name == NULL)
1177 return;
1178
1179 if (dso->long_name_allocated)
1180 free((char *)dso->long_name);
1181
1182 if (root) {
1183 rb_erase(&dso->rb_node, root);
1184 /*
1185 * __dsos__findnew_link_by_longname_id() isn't guaranteed to
1186 * add it back, so a clean removal is required here.
1187 */
1188 RB_CLEAR_NODE(&dso->rb_node);
1189 dso->root = NULL;
1190 }
1191
1192 dso->long_name = name;
1193 dso->long_name_len = strlen(name);
1194 dso->long_name_allocated = name_allocated;
1195
1196 if (root)
1197 __dsos__findnew_link_by_longname_id(root, dso, NULL, id);
1198}
1199
1200void dso__set_long_name(struct dso *dso, const char *name, bool name_allocated)
1201{
1202 dso__set_long_name_id(dso, name, NULL, name_allocated);
1203}
1204
1205void dso__set_short_name(struct dso *dso, const char *name, bool name_allocated)
1206{
1207 if (name == NULL)
1208 return;
1209
1210 if (dso->short_name_allocated)
1211 free((char *)dso->short_name);
1212
1213 dso->short_name = name;
1214 dso->short_name_len = strlen(name);
1215 dso->short_name_allocated = name_allocated;
1216}
1217
1218int dso__name_len(const struct dso *dso)
1219{
1220 if (!dso)
1221 return strlen("[unknown]");
1222 if (verbose > 0)
1223 return dso->long_name_len;
1224
1225 return dso->short_name_len;
1226}
1227
1228bool dso__loaded(const struct dso *dso)
1229{
1230 return dso->loaded;
1231}
1232
1233bool dso__sorted_by_name(const struct dso *dso)
1234{
1235 return dso->sorted_by_name;
1236}
1237
1238void dso__set_sorted_by_name(struct dso *dso)
1239{
1240 dso->sorted_by_name = true;
1241}
1242
1243struct dso *dso__new_id(const char *name, struct dso_id *id)
1244{
1245 struct dso *dso = calloc(1, sizeof(*dso) + strlen(name) + 1);
1246
1247 if (dso != NULL) {
1248 strcpy(dso->name, name);
1249 if (id)
1250 dso->id = *id;
1251 dso__set_long_name_id(dso, dso->name, id, false);
1252 dso__set_short_name(dso, dso->name, false);
1253 dso->symbols = dso->symbol_names = RB_ROOT_CACHED;
1254 dso->data.cache = RB_ROOT;
1255 dso->inlined_nodes = RB_ROOT_CACHED;
1256 dso->srclines = RB_ROOT_CACHED;
1257 dso->data.fd = -1;
1258 dso->data.status = DSO_DATA_STATUS_UNKNOWN;
1259 dso->symtab_type = DSO_BINARY_TYPE__NOT_FOUND;
1260 dso->binary_type = DSO_BINARY_TYPE__NOT_FOUND;
1261 dso->is_64_bit = (sizeof(void *) == 8);
1262 dso->loaded = 0;
1263 dso->rel = 0;
1264 dso->sorted_by_name = 0;
1265 dso->has_build_id = 0;
1266 dso->has_srcline = 1;
1267 dso->a2l_fails = 1;
1268 dso->kernel = DSO_SPACE__USER;
1269 dso->needs_swap = DSO_SWAP__UNSET;
1270 dso->comp = COMP_ID__NONE;
1271 RB_CLEAR_NODE(&dso->rb_node);
1272 dso->root = NULL;
1273 INIT_LIST_HEAD(&dso->node);
1274 INIT_LIST_HEAD(&dso->data.open_entry);
1275 pthread_mutex_init(&dso->lock, NULL);
1276 refcount_set(&dso->refcnt, 1);
1277 }
1278
1279 return dso;
1280}
1281
1282struct dso *dso__new(const char *name)
1283{
1284 return dso__new_id(name, NULL);
1285}
1286
1287void dso__delete(struct dso *dso)
1288{
1289 if (!RB_EMPTY_NODE(&dso->rb_node))
1290 pr_err("DSO %s is still in rbtree when being deleted!\n",
1291 dso->long_name);
1292
1293 /* free inlines first, as they reference symbols */
1294 inlines__tree_delete(&dso->inlined_nodes);
1295 srcline__tree_delete(&dso->srclines);
1296 symbols__delete(&dso->symbols);
1297
1298 if (dso->short_name_allocated) {
1299 zfree((char **)&dso->short_name);
1300 dso->short_name_allocated = false;
1301 }
1302
1303 if (dso->long_name_allocated) {
1304 zfree((char **)&dso->long_name);
1305 dso->long_name_allocated = false;
1306 }
1307
1308 dso__data_close(dso);
1309 auxtrace_cache__free(dso->auxtrace_cache);
1310 dso_cache__free(dso);
1311 dso__free_a2l(dso);
1312 zfree(&dso->symsrc_filename);
1313 nsinfo__zput(dso->nsinfo);
1314 pthread_mutex_destroy(&dso->lock);
1315 free(dso);
1316}
1317
1318struct dso *dso__get(struct dso *dso)
1319{
1320 if (dso)
1321 refcount_inc(&dso->refcnt);
1322 return dso;
1323}
1324
1325void dso__put(struct dso *dso)
1326{
1327 if (dso && refcount_dec_and_test(&dso->refcnt))
1328 dso__delete(dso);
1329}
1330
1331void dso__set_build_id(struct dso *dso, void *build_id)
1332{
1333 memcpy(dso->build_id, build_id, sizeof(dso->build_id));
1334 dso->has_build_id = 1;
1335}
1336
1337bool dso__build_id_equal(const struct dso *dso, u8 *build_id)
1338{
1339 return memcmp(dso->build_id, build_id, sizeof(dso->build_id)) == 0;
1340}
1341
1342void dso__read_running_kernel_build_id(struct dso *dso, struct machine *machine)
1343{
1344 char path[PATH_MAX];
1345
1346 if (machine__is_default_guest(machine))
1347 return;
1348 sprintf(path, "%s/sys/kernel/notes", machine->root_dir);
1349 if (sysfs__read_build_id(path, dso->build_id,
1350 sizeof(dso->build_id)) == 0)
1351 dso->has_build_id = true;
1352}
1353
1354int dso__kernel_module_get_build_id(struct dso *dso,
1355 const char *root_dir)
1356{
1357 char filename[PATH_MAX];
1358 /*
1359 * kernel module short names are of the form "[module]" and
1360 * we need just "module" here.
1361 */
1362 const char *name = dso->short_name + 1;
1363
1364 snprintf(filename, sizeof(filename),
1365 "%s/sys/module/%.*s/notes/.note.gnu.build-id",
1366 root_dir, (int)strlen(name) - 1, name);
1367
1368 if (sysfs__read_build_id(filename, dso->build_id,
1369 sizeof(dso->build_id)) == 0)
1370 dso->has_build_id = true;
1371
1372 return 0;
1373}
1374
1375size_t dso__fprintf_buildid(struct dso *dso, FILE *fp)
1376{
1377 char sbuild_id[SBUILD_ID_SIZE];
1378
1379 build_id__sprintf(dso->build_id, sizeof(dso->build_id), sbuild_id);
1380 return fprintf(fp, "%s", sbuild_id);
1381}
1382
1383size_t dso__fprintf(struct dso *dso, FILE *fp)
1384{
1385 struct rb_node *nd;
1386 size_t ret = fprintf(fp, "dso: %s (", dso->short_name);
1387
1388 if (dso->short_name != dso->long_name)
1389 ret += fprintf(fp, "%s, ", dso->long_name);
1390 ret += fprintf(fp, "%sloaded, ", dso__loaded(dso) ? "" : "NOT ");
1391 ret += dso__fprintf_buildid(dso, fp);
1392 ret += fprintf(fp, ")\n");
1393 for (nd = rb_first_cached(&dso->symbols); nd; nd = rb_next(nd)) {
1394 struct symbol *pos = rb_entry(nd, struct symbol, rb_node);
1395 ret += symbol__fprintf(pos, fp);
1396 }
1397
1398 return ret;
1399}
1400
1401enum dso_type dso__type(struct dso *dso, struct machine *machine)
1402{
1403 int fd;
1404 enum dso_type type = DSO__TYPE_UNKNOWN;
1405
1406 fd = dso__data_get_fd(dso, machine);
1407 if (fd >= 0) {
1408 type = dso__type_fd(fd);
1409 dso__data_put_fd(dso);
1410 }
1411
1412 return type;
1413}
1414
1415int dso__strerror_load(struct dso *dso, char *buf, size_t buflen)
1416{
1417 int idx, errnum = dso->load_errno;
1418 /*
1419 * This must have a same ordering as the enum dso_load_errno.
1420 */
1421 static const char *dso_load__error_str[] = {
1422 "Internal tools/perf/ library error",
1423 "Invalid ELF file",
1424 "Can not read build id",
1425 "Mismatching build id",
1426 "Decompression failure",
1427 };
1428
1429 BUG_ON(buflen == 0);
1430
1431 if (errnum >= 0) {
1432 const char *err = str_error_r(errnum, buf, buflen);
1433
1434 if (err != buf)
1435 scnprintf(buf, buflen, "%s", err);
1436
1437 return 0;
1438 }
1439
1440 if (errnum < __DSO_LOAD_ERRNO__START || errnum >= __DSO_LOAD_ERRNO__END)
1441 return -1;
1442
1443 idx = errnum - __DSO_LOAD_ERRNO__START;
1444 scnprintf(buf, buflen, "%s", dso_load__error_str[idx]);
1445 return 0;
1446}