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