treewide: remove redundant IS_ERR() before error code check
[linux/fpc-iii.git] / tools / perf / util / symbol.c
blob3b379b1296f1077beb2e1242823eb15cbe4a6729
1 // SPDX-License-Identifier: GPL-2.0
2 #include <dirent.h>
3 #include <errno.h>
4 #include <stdlib.h>
5 #include <stdio.h>
6 #include <string.h>
7 #include <linux/capability.h>
8 #include <linux/kernel.h>
9 #include <linux/mman.h>
10 #include <linux/string.h>
11 #include <linux/time64.h>
12 #include <sys/types.h>
13 #include <sys/stat.h>
14 #include <sys/param.h>
15 #include <fcntl.h>
16 #include <unistd.h>
17 #include <inttypes.h>
18 #include "annotate.h"
19 #include "build-id.h"
20 #include "cap.h"
21 #include "dso.h"
22 #include "util.h" // lsdir()
23 #include "debug.h"
24 #include "event.h"
25 #include "machine.h"
26 #include "map.h"
27 #include "symbol.h"
28 #include "map_symbol.h"
29 #include "mem-events.h"
30 #include "symsrc.h"
31 #include "strlist.h"
32 #include "intlist.h"
33 #include "namespaces.h"
34 #include "header.h"
35 #include "path.h"
36 #include <linux/ctype.h>
37 #include <linux/zalloc.h>
39 #include <elf.h>
40 #include <limits.h>
41 #include <symbol/kallsyms.h>
42 #include <sys/utsname.h>
44 static int dso__load_kernel_sym(struct dso *dso, struct map *map);
45 static int dso__load_guest_kernel_sym(struct dso *dso, struct map *map);
46 static bool symbol__is_idle(const char *name);
48 int vmlinux_path__nr_entries;
49 char **vmlinux_path;
51 struct symbol_conf symbol_conf = {
52 .nanosecs = false,
53 .use_modules = true,
54 .try_vmlinux_path = true,
55 .demangle = true,
56 .demangle_kernel = false,
57 .cumulate_callchain = true,
58 .time_quantum = 100 * NSEC_PER_MSEC, /* 100ms */
59 .show_hist_headers = true,
60 .symfs = "",
61 .event_group = true,
62 .inline_name = true,
63 .res_sample = 0,
66 static enum dso_binary_type binary_type_symtab[] = {
67 DSO_BINARY_TYPE__KALLSYMS,
68 DSO_BINARY_TYPE__GUEST_KALLSYMS,
69 DSO_BINARY_TYPE__JAVA_JIT,
70 DSO_BINARY_TYPE__DEBUGLINK,
71 DSO_BINARY_TYPE__BUILD_ID_CACHE,
72 DSO_BINARY_TYPE__BUILD_ID_CACHE_DEBUGINFO,
73 DSO_BINARY_TYPE__FEDORA_DEBUGINFO,
74 DSO_BINARY_TYPE__UBUNTU_DEBUGINFO,
75 DSO_BINARY_TYPE__BUILDID_DEBUGINFO,
76 DSO_BINARY_TYPE__SYSTEM_PATH_DSO,
77 DSO_BINARY_TYPE__GUEST_KMODULE,
78 DSO_BINARY_TYPE__GUEST_KMODULE_COMP,
79 DSO_BINARY_TYPE__SYSTEM_PATH_KMODULE,
80 DSO_BINARY_TYPE__SYSTEM_PATH_KMODULE_COMP,
81 DSO_BINARY_TYPE__OPENEMBEDDED_DEBUGINFO,
82 DSO_BINARY_TYPE__NOT_FOUND,
85 #define DSO_BINARY_TYPE__SYMTAB_CNT ARRAY_SIZE(binary_type_symtab)
87 static bool symbol_type__filter(char symbol_type)
89 symbol_type = toupper(symbol_type);
90 return symbol_type == 'T' || symbol_type == 'W' || symbol_type == 'D' || symbol_type == 'B';
93 static int prefix_underscores_count(const char *str)
95 const char *tail = str;
97 while (*tail == '_')
98 tail++;
100 return tail - str;
103 void __weak arch__symbols__fixup_end(struct symbol *p, struct symbol *c)
105 p->end = c->start;
108 const char * __weak arch__normalize_symbol_name(const char *name)
110 return name;
113 int __weak arch__compare_symbol_names(const char *namea, const char *nameb)
115 return strcmp(namea, nameb);
118 int __weak arch__compare_symbol_names_n(const char *namea, const char *nameb,
119 unsigned int n)
121 return strncmp(namea, nameb, n);
124 int __weak arch__choose_best_symbol(struct symbol *syma,
125 struct symbol *symb __maybe_unused)
127 /* Avoid "SyS" kernel syscall aliases */
128 if (strlen(syma->name) >= 3 && !strncmp(syma->name, "SyS", 3))
129 return SYMBOL_B;
130 if (strlen(syma->name) >= 10 && !strncmp(syma->name, "compat_SyS", 10))
131 return SYMBOL_B;
133 return SYMBOL_A;
136 static int choose_best_symbol(struct symbol *syma, struct symbol *symb)
138 s64 a;
139 s64 b;
140 size_t na, nb;
142 /* Prefer a symbol with non zero length */
143 a = syma->end - syma->start;
144 b = symb->end - symb->start;
145 if ((b == 0) && (a > 0))
146 return SYMBOL_A;
147 else if ((a == 0) && (b > 0))
148 return SYMBOL_B;
150 /* Prefer a non weak symbol over a weak one */
151 a = syma->binding == STB_WEAK;
152 b = symb->binding == STB_WEAK;
153 if (b && !a)
154 return SYMBOL_A;
155 if (a && !b)
156 return SYMBOL_B;
158 /* Prefer a global symbol over a non global one */
159 a = syma->binding == STB_GLOBAL;
160 b = symb->binding == STB_GLOBAL;
161 if (a && !b)
162 return SYMBOL_A;
163 if (b && !a)
164 return SYMBOL_B;
166 /* Prefer a symbol with less underscores */
167 a = prefix_underscores_count(syma->name);
168 b = prefix_underscores_count(symb->name);
169 if (b > a)
170 return SYMBOL_A;
171 else if (a > b)
172 return SYMBOL_B;
174 /* Choose the symbol with the longest name */
175 na = strlen(syma->name);
176 nb = strlen(symb->name);
177 if (na > nb)
178 return SYMBOL_A;
179 else if (na < nb)
180 return SYMBOL_B;
182 return arch__choose_best_symbol(syma, symb);
185 void symbols__fixup_duplicate(struct rb_root_cached *symbols)
187 struct rb_node *nd;
188 struct symbol *curr, *next;
190 if (symbol_conf.allow_aliases)
191 return;
193 nd = rb_first_cached(symbols);
195 while (nd) {
196 curr = rb_entry(nd, struct symbol, rb_node);
197 again:
198 nd = rb_next(&curr->rb_node);
199 next = rb_entry(nd, struct symbol, rb_node);
201 if (!nd)
202 break;
204 if (curr->start != next->start)
205 continue;
207 if (choose_best_symbol(curr, next) == SYMBOL_A) {
208 rb_erase_cached(&next->rb_node, symbols);
209 symbol__delete(next);
210 goto again;
211 } else {
212 nd = rb_next(&curr->rb_node);
213 rb_erase_cached(&curr->rb_node, symbols);
214 symbol__delete(curr);
219 void symbols__fixup_end(struct rb_root_cached *symbols)
221 struct rb_node *nd, *prevnd = rb_first_cached(symbols);
222 struct symbol *curr, *prev;
224 if (prevnd == NULL)
225 return;
227 curr = rb_entry(prevnd, struct symbol, rb_node);
229 for (nd = rb_next(prevnd); nd; nd = rb_next(nd)) {
230 prev = curr;
231 curr = rb_entry(nd, struct symbol, rb_node);
233 if (prev->end == prev->start && prev->end != curr->start)
234 arch__symbols__fixup_end(prev, curr);
237 /* Last entry */
238 if (curr->end == curr->start)
239 curr->end = roundup(curr->start, 4096) + 4096;
242 void maps__fixup_end(struct maps *maps)
244 struct map *prev = NULL, *curr;
246 down_write(&maps->lock);
248 maps__for_each_entry(maps, curr) {
249 if (prev != NULL && !prev->end)
250 prev->end = curr->start;
252 prev = curr;
256 * We still haven't the actual symbols, so guess the
257 * last map final address.
259 if (curr && !curr->end)
260 curr->end = ~0ULL;
262 up_write(&maps->lock);
265 struct symbol *symbol__new(u64 start, u64 len, u8 binding, u8 type, const char *name)
267 size_t namelen = strlen(name) + 1;
268 struct symbol *sym = calloc(1, (symbol_conf.priv_size +
269 sizeof(*sym) + namelen));
270 if (sym == NULL)
271 return NULL;
273 if (symbol_conf.priv_size) {
274 if (symbol_conf.init_annotation) {
275 struct annotation *notes = (void *)sym;
276 pthread_mutex_init(&notes->lock, NULL);
278 sym = ((void *)sym) + symbol_conf.priv_size;
281 sym->start = start;
282 sym->end = len ? start + len : start;
283 sym->type = type;
284 sym->binding = binding;
285 sym->namelen = namelen - 1;
287 pr_debug4("%s: %s %#" PRIx64 "-%#" PRIx64 "\n",
288 __func__, name, start, sym->end);
289 memcpy(sym->name, name, namelen);
291 return sym;
294 void symbol__delete(struct symbol *sym)
296 free(((void *)sym) - symbol_conf.priv_size);
299 void symbols__delete(struct rb_root_cached *symbols)
301 struct symbol *pos;
302 struct rb_node *next = rb_first_cached(symbols);
304 while (next) {
305 pos = rb_entry(next, struct symbol, rb_node);
306 next = rb_next(&pos->rb_node);
307 rb_erase_cached(&pos->rb_node, symbols);
308 symbol__delete(pos);
312 void __symbols__insert(struct rb_root_cached *symbols,
313 struct symbol *sym, bool kernel)
315 struct rb_node **p = &symbols->rb_root.rb_node;
316 struct rb_node *parent = NULL;
317 const u64 ip = sym->start;
318 struct symbol *s;
319 bool leftmost = true;
321 if (kernel) {
322 const char *name = sym->name;
324 * ppc64 uses function descriptors and appends a '.' to the
325 * start of every instruction address. Remove it.
327 if (name[0] == '.')
328 name++;
329 sym->idle = symbol__is_idle(name);
332 while (*p != NULL) {
333 parent = *p;
334 s = rb_entry(parent, struct symbol, rb_node);
335 if (ip < s->start)
336 p = &(*p)->rb_left;
337 else {
338 p = &(*p)->rb_right;
339 leftmost = false;
342 rb_link_node(&sym->rb_node, parent, p);
343 rb_insert_color_cached(&sym->rb_node, symbols, leftmost);
346 void symbols__insert(struct rb_root_cached *symbols, struct symbol *sym)
348 __symbols__insert(symbols, sym, false);
351 static struct symbol *symbols__find(struct rb_root_cached *symbols, u64 ip)
353 struct rb_node *n;
355 if (symbols == NULL)
356 return NULL;
358 n = symbols->rb_root.rb_node;
360 while (n) {
361 struct symbol *s = rb_entry(n, struct symbol, rb_node);
363 if (ip < s->start)
364 n = n->rb_left;
365 else if (ip > s->end || (ip == s->end && ip != s->start))
366 n = n->rb_right;
367 else
368 return s;
371 return NULL;
374 static struct symbol *symbols__first(struct rb_root_cached *symbols)
376 struct rb_node *n = rb_first_cached(symbols);
378 if (n)
379 return rb_entry(n, struct symbol, rb_node);
381 return NULL;
384 static struct symbol *symbols__last(struct rb_root_cached *symbols)
386 struct rb_node *n = rb_last(&symbols->rb_root);
388 if (n)
389 return rb_entry(n, struct symbol, rb_node);
391 return NULL;
394 static struct symbol *symbols__next(struct symbol *sym)
396 struct rb_node *n = rb_next(&sym->rb_node);
398 if (n)
399 return rb_entry(n, struct symbol, rb_node);
401 return NULL;
404 static void symbols__insert_by_name(struct rb_root_cached *symbols, struct symbol *sym)
406 struct rb_node **p = &symbols->rb_root.rb_node;
407 struct rb_node *parent = NULL;
408 struct symbol_name_rb_node *symn, *s;
409 bool leftmost = true;
411 symn = container_of(sym, struct symbol_name_rb_node, sym);
413 while (*p != NULL) {
414 parent = *p;
415 s = rb_entry(parent, struct symbol_name_rb_node, rb_node);
416 if (strcmp(sym->name, s->sym.name) < 0)
417 p = &(*p)->rb_left;
418 else {
419 p = &(*p)->rb_right;
420 leftmost = false;
423 rb_link_node(&symn->rb_node, parent, p);
424 rb_insert_color_cached(&symn->rb_node, symbols, leftmost);
427 static void symbols__sort_by_name(struct rb_root_cached *symbols,
428 struct rb_root_cached *source)
430 struct rb_node *nd;
432 for (nd = rb_first_cached(source); nd; nd = rb_next(nd)) {
433 struct symbol *pos = rb_entry(nd, struct symbol, rb_node);
434 symbols__insert_by_name(symbols, pos);
438 int symbol__match_symbol_name(const char *name, const char *str,
439 enum symbol_tag_include includes)
441 const char *versioning;
443 if (includes == SYMBOL_TAG_INCLUDE__DEFAULT_ONLY &&
444 (versioning = strstr(name, "@@"))) {
445 int len = strlen(str);
447 if (len < versioning - name)
448 len = versioning - name;
450 return arch__compare_symbol_names_n(name, str, len);
451 } else
452 return arch__compare_symbol_names(name, str);
455 static struct symbol *symbols__find_by_name(struct rb_root_cached *symbols,
456 const char *name,
457 enum symbol_tag_include includes)
459 struct rb_node *n;
460 struct symbol_name_rb_node *s = NULL;
462 if (symbols == NULL)
463 return NULL;
465 n = symbols->rb_root.rb_node;
467 while (n) {
468 int cmp;
470 s = rb_entry(n, struct symbol_name_rb_node, rb_node);
471 cmp = symbol__match_symbol_name(s->sym.name, name, includes);
473 if (cmp > 0)
474 n = n->rb_left;
475 else if (cmp < 0)
476 n = n->rb_right;
477 else
478 break;
481 if (n == NULL)
482 return NULL;
484 if (includes != SYMBOL_TAG_INCLUDE__DEFAULT_ONLY)
485 /* return first symbol that has same name (if any) */
486 for (n = rb_prev(n); n; n = rb_prev(n)) {
487 struct symbol_name_rb_node *tmp;
489 tmp = rb_entry(n, struct symbol_name_rb_node, rb_node);
490 if (arch__compare_symbol_names(tmp->sym.name, s->sym.name))
491 break;
493 s = tmp;
496 return &s->sym;
499 void dso__reset_find_symbol_cache(struct dso *dso)
501 dso->last_find_result.addr = 0;
502 dso->last_find_result.symbol = NULL;
505 void dso__insert_symbol(struct dso *dso, struct symbol *sym)
507 __symbols__insert(&dso->symbols, sym, dso->kernel);
509 /* update the symbol cache if necessary */
510 if (dso->last_find_result.addr >= sym->start &&
511 (dso->last_find_result.addr < sym->end ||
512 sym->start == sym->end)) {
513 dso->last_find_result.symbol = sym;
517 struct symbol *dso__find_symbol(struct dso *dso, u64 addr)
519 if (dso->last_find_result.addr != addr || dso->last_find_result.symbol == NULL) {
520 dso->last_find_result.addr = addr;
521 dso->last_find_result.symbol = symbols__find(&dso->symbols, addr);
524 return dso->last_find_result.symbol;
527 struct symbol *dso__first_symbol(struct dso *dso)
529 return symbols__first(&dso->symbols);
532 struct symbol *dso__last_symbol(struct dso *dso)
534 return symbols__last(&dso->symbols);
537 struct symbol *dso__next_symbol(struct symbol *sym)
539 return symbols__next(sym);
542 struct symbol *symbol__next_by_name(struct symbol *sym)
544 struct symbol_name_rb_node *s = container_of(sym, struct symbol_name_rb_node, sym);
545 struct rb_node *n = rb_next(&s->rb_node);
547 return n ? &rb_entry(n, struct symbol_name_rb_node, rb_node)->sym : NULL;
551 * Returns first symbol that matched with @name.
553 struct symbol *dso__find_symbol_by_name(struct dso *dso, const char *name)
555 struct symbol *s = symbols__find_by_name(&dso->symbol_names, name,
556 SYMBOL_TAG_INCLUDE__NONE);
557 if (!s)
558 s = symbols__find_by_name(&dso->symbol_names, name,
559 SYMBOL_TAG_INCLUDE__DEFAULT_ONLY);
560 return s;
563 void dso__sort_by_name(struct dso *dso)
565 dso__set_sorted_by_name(dso);
566 return symbols__sort_by_name(&dso->symbol_names, &dso->symbols);
569 int modules__parse(const char *filename, void *arg,
570 int (*process_module)(void *arg, const char *name,
571 u64 start, u64 size))
573 char *line = NULL;
574 size_t n;
575 FILE *file;
576 int err = 0;
578 file = fopen(filename, "r");
579 if (file == NULL)
580 return -1;
582 while (1) {
583 char name[PATH_MAX];
584 u64 start, size;
585 char *sep, *endptr;
586 ssize_t line_len;
588 line_len = getline(&line, &n, file);
589 if (line_len < 0) {
590 if (feof(file))
591 break;
592 err = -1;
593 goto out;
596 if (!line) {
597 err = -1;
598 goto out;
601 line[--line_len] = '\0'; /* \n */
603 sep = strrchr(line, 'x');
604 if (sep == NULL)
605 continue;
607 hex2u64(sep + 1, &start);
609 sep = strchr(line, ' ');
610 if (sep == NULL)
611 continue;
613 *sep = '\0';
615 scnprintf(name, sizeof(name), "[%s]", line);
617 size = strtoul(sep + 1, &endptr, 0);
618 if (*endptr != ' ' && *endptr != '\t')
619 continue;
621 err = process_module(arg, name, start, size);
622 if (err)
623 break;
625 out:
626 free(line);
627 fclose(file);
628 return err;
632 * These are symbols in the kernel image, so make sure that
633 * sym is from a kernel DSO.
635 static bool symbol__is_idle(const char *name)
637 const char * const idle_symbols[] = {
638 "arch_cpu_idle",
639 "cpu_idle",
640 "cpu_startup_entry",
641 "intel_idle",
642 "default_idle",
643 "native_safe_halt",
644 "enter_idle",
645 "exit_idle",
646 "mwait_idle",
647 "mwait_idle_with_hints",
648 "poll_idle",
649 "ppc64_runlatch_off",
650 "pseries_dedicated_idle_sleep",
651 NULL
653 int i;
655 for (i = 0; idle_symbols[i]; i++) {
656 if (!strcmp(idle_symbols[i], name))
657 return true;
660 return false;
663 static int map__process_kallsym_symbol(void *arg, const char *name,
664 char type, u64 start)
666 struct symbol *sym;
667 struct dso *dso = arg;
668 struct rb_root_cached *root = &dso->symbols;
670 if (!symbol_type__filter(type))
671 return 0;
674 * module symbols are not sorted so we add all
675 * symbols, setting length to 0, and rely on
676 * symbols__fixup_end() to fix it up.
678 sym = symbol__new(start, 0, kallsyms2elf_binding(type), kallsyms2elf_type(type), name);
679 if (sym == NULL)
680 return -ENOMEM;
682 * We will pass the symbols to the filter later, in
683 * map__split_kallsyms, when we have split the maps per module
685 __symbols__insert(root, sym, !strchr(name, '['));
687 return 0;
691 * Loads the function entries in /proc/kallsyms into kernel_map->dso,
692 * so that we can in the next step set the symbol ->end address and then
693 * call kernel_maps__split_kallsyms.
695 static int dso__load_all_kallsyms(struct dso *dso, const char *filename)
697 return kallsyms__parse(filename, dso, map__process_kallsym_symbol);
700 static int maps__split_kallsyms_for_kcore(struct maps *kmaps, struct dso *dso)
702 struct map *curr_map;
703 struct symbol *pos;
704 int count = 0;
705 struct rb_root_cached old_root = dso->symbols;
706 struct rb_root_cached *root = &dso->symbols;
707 struct rb_node *next = rb_first_cached(root);
709 if (!kmaps)
710 return -1;
712 *root = RB_ROOT_CACHED;
714 while (next) {
715 char *module;
717 pos = rb_entry(next, struct symbol, rb_node);
718 next = rb_next(&pos->rb_node);
720 rb_erase_cached(&pos->rb_node, &old_root);
721 RB_CLEAR_NODE(&pos->rb_node);
722 module = strchr(pos->name, '\t');
723 if (module)
724 *module = '\0';
726 curr_map = maps__find(kmaps, pos->start);
728 if (!curr_map) {
729 symbol__delete(pos);
730 continue;
733 pos->start -= curr_map->start - curr_map->pgoff;
734 if (pos->end > curr_map->end)
735 pos->end = curr_map->end;
736 if (pos->end)
737 pos->end -= curr_map->start - curr_map->pgoff;
738 symbols__insert(&curr_map->dso->symbols, pos);
739 ++count;
742 /* Symbols have been adjusted */
743 dso->adjust_symbols = 1;
745 return count;
749 * Split the symbols into maps, making sure there are no overlaps, i.e. the
750 * kernel range is broken in several maps, named [kernel].N, as we don't have
751 * the original ELF section names vmlinux have.
753 static int maps__split_kallsyms(struct maps *kmaps, struct dso *dso, u64 delta,
754 struct map *initial_map)
756 struct machine *machine;
757 struct map *curr_map = initial_map;
758 struct symbol *pos;
759 int count = 0, moved = 0;
760 struct rb_root_cached *root = &dso->symbols;
761 struct rb_node *next = rb_first_cached(root);
762 int kernel_range = 0;
763 bool x86_64;
765 if (!kmaps)
766 return -1;
768 machine = kmaps->machine;
770 x86_64 = machine__is(machine, "x86_64");
772 while (next) {
773 char *module;
775 pos = rb_entry(next, struct symbol, rb_node);
776 next = rb_next(&pos->rb_node);
778 module = strchr(pos->name, '\t');
779 if (module) {
780 if (!symbol_conf.use_modules)
781 goto discard_symbol;
783 *module++ = '\0';
785 if (strcmp(curr_map->dso->short_name, module)) {
786 if (curr_map != initial_map &&
787 dso->kernel == DSO_TYPE_GUEST_KERNEL &&
788 machine__is_default_guest(machine)) {
790 * We assume all symbols of a module are
791 * continuous in * kallsyms, so curr_map
792 * points to a module and all its
793 * symbols are in its kmap. Mark it as
794 * loaded.
796 dso__set_loaded(curr_map->dso);
799 curr_map = maps__find_by_name(kmaps, module);
800 if (curr_map == NULL) {
801 pr_debug("%s/proc/{kallsyms,modules} "
802 "inconsistency while looking "
803 "for \"%s\" module!\n",
804 machine->root_dir, module);
805 curr_map = initial_map;
806 goto discard_symbol;
809 if (curr_map->dso->loaded &&
810 !machine__is_default_guest(machine))
811 goto discard_symbol;
814 * So that we look just like we get from .ko files,
815 * i.e. not prelinked, relative to initial_map->start.
817 pos->start = curr_map->map_ip(curr_map, pos->start);
818 pos->end = curr_map->map_ip(curr_map, pos->end);
819 } else if (x86_64 && is_entry_trampoline(pos->name)) {
821 * These symbols are not needed anymore since the
822 * trampoline maps refer to the text section and it's
823 * symbols instead. Avoid having to deal with
824 * relocations, and the assumption that the first symbol
825 * is the start of kernel text, by simply removing the
826 * symbols at this point.
828 goto discard_symbol;
829 } else if (curr_map != initial_map) {
830 char dso_name[PATH_MAX];
831 struct dso *ndso;
833 if (delta) {
834 /* Kernel was relocated at boot time */
835 pos->start -= delta;
836 pos->end -= delta;
839 if (count == 0) {
840 curr_map = initial_map;
841 goto add_symbol;
844 if (dso->kernel == DSO_TYPE_GUEST_KERNEL)
845 snprintf(dso_name, sizeof(dso_name),
846 "[guest.kernel].%d",
847 kernel_range++);
848 else
849 snprintf(dso_name, sizeof(dso_name),
850 "[kernel].%d",
851 kernel_range++);
853 ndso = dso__new(dso_name);
854 if (ndso == NULL)
855 return -1;
857 ndso->kernel = dso->kernel;
859 curr_map = map__new2(pos->start, ndso);
860 if (curr_map == NULL) {
861 dso__put(ndso);
862 return -1;
865 curr_map->map_ip = curr_map->unmap_ip = identity__map_ip;
866 maps__insert(kmaps, curr_map);
867 ++kernel_range;
868 } else if (delta) {
869 /* Kernel was relocated at boot time */
870 pos->start -= delta;
871 pos->end -= delta;
873 add_symbol:
874 if (curr_map != initial_map) {
875 rb_erase_cached(&pos->rb_node, root);
876 symbols__insert(&curr_map->dso->symbols, pos);
877 ++moved;
878 } else
879 ++count;
881 continue;
882 discard_symbol:
883 rb_erase_cached(&pos->rb_node, root);
884 symbol__delete(pos);
887 if (curr_map != initial_map &&
888 dso->kernel == DSO_TYPE_GUEST_KERNEL &&
889 machine__is_default_guest(kmaps->machine)) {
890 dso__set_loaded(curr_map->dso);
893 return count + moved;
896 bool symbol__restricted_filename(const char *filename,
897 const char *restricted_filename)
899 bool restricted = false;
901 if (symbol_conf.kptr_restrict) {
902 char *r = realpath(filename, NULL);
904 if (r != NULL) {
905 restricted = strcmp(r, restricted_filename) == 0;
906 free(r);
907 return restricted;
911 return restricted;
914 struct module_info {
915 struct rb_node rb_node;
916 char *name;
917 u64 start;
920 static void add_module(struct module_info *mi, struct rb_root *modules)
922 struct rb_node **p = &modules->rb_node;
923 struct rb_node *parent = NULL;
924 struct module_info *m;
926 while (*p != NULL) {
927 parent = *p;
928 m = rb_entry(parent, struct module_info, rb_node);
929 if (strcmp(mi->name, m->name) < 0)
930 p = &(*p)->rb_left;
931 else
932 p = &(*p)->rb_right;
934 rb_link_node(&mi->rb_node, parent, p);
935 rb_insert_color(&mi->rb_node, modules);
938 static void delete_modules(struct rb_root *modules)
940 struct module_info *mi;
941 struct rb_node *next = rb_first(modules);
943 while (next) {
944 mi = rb_entry(next, struct module_info, rb_node);
945 next = rb_next(&mi->rb_node);
946 rb_erase(&mi->rb_node, modules);
947 zfree(&mi->name);
948 free(mi);
952 static struct module_info *find_module(const char *name,
953 struct rb_root *modules)
955 struct rb_node *n = modules->rb_node;
957 while (n) {
958 struct module_info *m;
959 int cmp;
961 m = rb_entry(n, struct module_info, rb_node);
962 cmp = strcmp(name, m->name);
963 if (cmp < 0)
964 n = n->rb_left;
965 else if (cmp > 0)
966 n = n->rb_right;
967 else
968 return m;
971 return NULL;
974 static int __read_proc_modules(void *arg, const char *name, u64 start,
975 u64 size __maybe_unused)
977 struct rb_root *modules = arg;
978 struct module_info *mi;
980 mi = zalloc(sizeof(struct module_info));
981 if (!mi)
982 return -ENOMEM;
984 mi->name = strdup(name);
985 mi->start = start;
987 if (!mi->name) {
988 free(mi);
989 return -ENOMEM;
992 add_module(mi, modules);
994 return 0;
997 static int read_proc_modules(const char *filename, struct rb_root *modules)
999 if (symbol__restricted_filename(filename, "/proc/modules"))
1000 return -1;
1002 if (modules__parse(filename, modules, __read_proc_modules)) {
1003 delete_modules(modules);
1004 return -1;
1007 return 0;
1010 int compare_proc_modules(const char *from, const char *to)
1012 struct rb_root from_modules = RB_ROOT;
1013 struct rb_root to_modules = RB_ROOT;
1014 struct rb_node *from_node, *to_node;
1015 struct module_info *from_m, *to_m;
1016 int ret = -1;
1018 if (read_proc_modules(from, &from_modules))
1019 return -1;
1021 if (read_proc_modules(to, &to_modules))
1022 goto out_delete_from;
1024 from_node = rb_first(&from_modules);
1025 to_node = rb_first(&to_modules);
1026 while (from_node) {
1027 if (!to_node)
1028 break;
1030 from_m = rb_entry(from_node, struct module_info, rb_node);
1031 to_m = rb_entry(to_node, struct module_info, rb_node);
1033 if (from_m->start != to_m->start ||
1034 strcmp(from_m->name, to_m->name))
1035 break;
1037 from_node = rb_next(from_node);
1038 to_node = rb_next(to_node);
1041 if (!from_node && !to_node)
1042 ret = 0;
1044 delete_modules(&to_modules);
1045 out_delete_from:
1046 delete_modules(&from_modules);
1048 return ret;
1051 static int do_validate_kcore_modules(const char *filename, struct maps *kmaps)
1053 struct rb_root modules = RB_ROOT;
1054 struct map *old_map;
1055 int err;
1057 err = read_proc_modules(filename, &modules);
1058 if (err)
1059 return err;
1061 maps__for_each_entry(kmaps, old_map) {
1062 struct module_info *mi;
1064 if (!__map__is_kmodule(old_map)) {
1065 continue;
1068 /* Module must be in memory at the same address */
1069 mi = find_module(old_map->dso->short_name, &modules);
1070 if (!mi || mi->start != old_map->start) {
1071 err = -EINVAL;
1072 goto out;
1075 out:
1076 delete_modules(&modules);
1077 return err;
1081 * If kallsyms is referenced by name then we look for filename in the same
1082 * directory.
1084 static bool filename_from_kallsyms_filename(char *filename,
1085 const char *base_name,
1086 const char *kallsyms_filename)
1088 char *name;
1090 strcpy(filename, kallsyms_filename);
1091 name = strrchr(filename, '/');
1092 if (!name)
1093 return false;
1095 name += 1;
1097 if (!strcmp(name, "kallsyms")) {
1098 strcpy(name, base_name);
1099 return true;
1102 return false;
1105 static int validate_kcore_modules(const char *kallsyms_filename,
1106 struct map *map)
1108 struct maps *kmaps = map__kmaps(map);
1109 char modules_filename[PATH_MAX];
1111 if (!kmaps)
1112 return -EINVAL;
1114 if (!filename_from_kallsyms_filename(modules_filename, "modules",
1115 kallsyms_filename))
1116 return -EINVAL;
1118 if (do_validate_kcore_modules(modules_filename, kmaps))
1119 return -EINVAL;
1121 return 0;
1124 static int validate_kcore_addresses(const char *kallsyms_filename,
1125 struct map *map)
1127 struct kmap *kmap = map__kmap(map);
1129 if (!kmap)
1130 return -EINVAL;
1132 if (kmap->ref_reloc_sym && kmap->ref_reloc_sym->name) {
1133 u64 start;
1135 if (kallsyms__get_function_start(kallsyms_filename,
1136 kmap->ref_reloc_sym->name, &start))
1137 return -ENOENT;
1138 if (start != kmap->ref_reloc_sym->addr)
1139 return -EINVAL;
1142 return validate_kcore_modules(kallsyms_filename, map);
1145 struct kcore_mapfn_data {
1146 struct dso *dso;
1147 struct list_head maps;
1150 static int kcore_mapfn(u64 start, u64 len, u64 pgoff, void *data)
1152 struct kcore_mapfn_data *md = data;
1153 struct map *map;
1155 map = map__new2(start, md->dso);
1156 if (map == NULL)
1157 return -ENOMEM;
1159 map->end = map->start + len;
1160 map->pgoff = pgoff;
1162 list_add(&map->node, &md->maps);
1164 return 0;
1168 * Merges map into maps by splitting the new map within the existing map
1169 * regions.
1171 int maps__merge_in(struct maps *kmaps, struct map *new_map)
1173 struct map *old_map;
1174 LIST_HEAD(merged);
1176 maps__for_each_entry(kmaps, old_map) {
1177 /* no overload with this one */
1178 if (new_map->end < old_map->start ||
1179 new_map->start >= old_map->end)
1180 continue;
1182 if (new_map->start < old_map->start) {
1184 * |new......
1185 * |old....
1187 if (new_map->end < old_map->end) {
1189 * |new......| -> |new..|
1190 * |old....| -> |old....|
1192 new_map->end = old_map->start;
1193 } else {
1195 * |new.............| -> |new..| |new..|
1196 * |old....| -> |old....|
1198 struct map *m = map__clone(new_map);
1200 if (!m)
1201 return -ENOMEM;
1203 m->end = old_map->start;
1204 list_add_tail(&m->node, &merged);
1205 new_map->start = old_map->end;
1207 } else {
1209 * |new......
1210 * |old....
1212 if (new_map->end < old_map->end) {
1214 * |new..| -> x
1215 * |old.........| -> |old.........|
1217 map__put(new_map);
1218 new_map = NULL;
1219 break;
1220 } else {
1222 * |new......| -> |new...|
1223 * |old....| -> |old....|
1225 new_map->start = old_map->end;
1230 while (!list_empty(&merged)) {
1231 old_map = list_entry(merged.next, struct map, node);
1232 list_del_init(&old_map->node);
1233 maps__insert(kmaps, old_map);
1234 map__put(old_map);
1237 if (new_map) {
1238 maps__insert(kmaps, new_map);
1239 map__put(new_map);
1241 return 0;
1244 static int dso__load_kcore(struct dso *dso, struct map *map,
1245 const char *kallsyms_filename)
1247 struct maps *kmaps = map__kmaps(map);
1248 struct kcore_mapfn_data md;
1249 struct map *old_map, *new_map, *replacement_map = NULL, *next;
1250 struct machine *machine;
1251 bool is_64_bit;
1252 int err, fd;
1253 char kcore_filename[PATH_MAX];
1254 u64 stext;
1256 if (!kmaps)
1257 return -EINVAL;
1259 machine = kmaps->machine;
1261 /* This function requires that the map is the kernel map */
1262 if (!__map__is_kernel(map))
1263 return -EINVAL;
1265 if (!filename_from_kallsyms_filename(kcore_filename, "kcore",
1266 kallsyms_filename))
1267 return -EINVAL;
1269 /* Modules and kernel must be present at their original addresses */
1270 if (validate_kcore_addresses(kallsyms_filename, map))
1271 return -EINVAL;
1273 md.dso = dso;
1274 INIT_LIST_HEAD(&md.maps);
1276 fd = open(kcore_filename, O_RDONLY);
1277 if (fd < 0) {
1278 pr_debug("Failed to open %s. Note /proc/kcore requires CAP_SYS_RAWIO capability to access.\n",
1279 kcore_filename);
1280 return -EINVAL;
1283 /* Read new maps into temporary lists */
1284 err = file__read_maps(fd, map->prot & PROT_EXEC, kcore_mapfn, &md,
1285 &is_64_bit);
1286 if (err)
1287 goto out_err;
1288 dso->is_64_bit = is_64_bit;
1290 if (list_empty(&md.maps)) {
1291 err = -EINVAL;
1292 goto out_err;
1295 /* Remove old maps */
1296 maps__for_each_entry_safe(kmaps, old_map, next) {
1298 * We need to preserve eBPF maps even if they are
1299 * covered by kcore, because we need to access
1300 * eBPF dso for source data.
1302 if (old_map != map && !__map__is_bpf_prog(old_map))
1303 maps__remove(kmaps, old_map);
1305 machine->trampolines_mapped = false;
1307 /* Find the kernel map using the '_stext' symbol */
1308 if (!kallsyms__get_function_start(kallsyms_filename, "_stext", &stext)) {
1309 list_for_each_entry(new_map, &md.maps, node) {
1310 if (stext >= new_map->start && stext < new_map->end) {
1311 replacement_map = new_map;
1312 break;
1317 if (!replacement_map)
1318 replacement_map = list_entry(md.maps.next, struct map, node);
1320 /* Add new maps */
1321 while (!list_empty(&md.maps)) {
1322 new_map = list_entry(md.maps.next, struct map, node);
1323 list_del_init(&new_map->node);
1324 if (new_map == replacement_map) {
1325 map->start = new_map->start;
1326 map->end = new_map->end;
1327 map->pgoff = new_map->pgoff;
1328 map->map_ip = new_map->map_ip;
1329 map->unmap_ip = new_map->unmap_ip;
1330 /* Ensure maps are correctly ordered */
1331 map__get(map);
1332 maps__remove(kmaps, map);
1333 maps__insert(kmaps, map);
1334 map__put(map);
1335 map__put(new_map);
1336 } else {
1338 * Merge kcore map into existing maps,
1339 * and ensure that current maps (eBPF)
1340 * stay intact.
1342 if (maps__merge_in(kmaps, new_map))
1343 goto out_err;
1347 if (machine__is(machine, "x86_64")) {
1348 u64 addr;
1351 * If one of the corresponding symbols is there, assume the
1352 * entry trampoline maps are too.
1354 if (!kallsyms__get_function_start(kallsyms_filename,
1355 ENTRY_TRAMPOLINE_NAME,
1356 &addr))
1357 machine->trampolines_mapped = true;
1361 * Set the data type and long name so that kcore can be read via
1362 * dso__data_read_addr().
1364 if (dso->kernel == DSO_TYPE_GUEST_KERNEL)
1365 dso->binary_type = DSO_BINARY_TYPE__GUEST_KCORE;
1366 else
1367 dso->binary_type = DSO_BINARY_TYPE__KCORE;
1368 dso__set_long_name(dso, strdup(kcore_filename), true);
1370 close(fd);
1372 if (map->prot & PROT_EXEC)
1373 pr_debug("Using %s for kernel object code\n", kcore_filename);
1374 else
1375 pr_debug("Using %s for kernel data\n", kcore_filename);
1377 return 0;
1379 out_err:
1380 while (!list_empty(&md.maps)) {
1381 map = list_entry(md.maps.next, struct map, node);
1382 list_del_init(&map->node);
1383 map__put(map);
1385 close(fd);
1386 return -EINVAL;
1390 * If the kernel is relocated at boot time, kallsyms won't match. Compute the
1391 * delta based on the relocation reference symbol.
1393 static int kallsyms__delta(struct kmap *kmap, const char *filename, u64 *delta)
1395 u64 addr;
1397 if (!kmap->ref_reloc_sym || !kmap->ref_reloc_sym->name)
1398 return 0;
1400 if (kallsyms__get_function_start(filename, kmap->ref_reloc_sym->name, &addr))
1401 return -1;
1403 *delta = addr - kmap->ref_reloc_sym->addr;
1404 return 0;
1407 int __dso__load_kallsyms(struct dso *dso, const char *filename,
1408 struct map *map, bool no_kcore)
1410 struct kmap *kmap = map__kmap(map);
1411 u64 delta = 0;
1413 if (symbol__restricted_filename(filename, "/proc/kallsyms"))
1414 return -1;
1416 if (!kmap || !kmap->kmaps)
1417 return -1;
1419 if (dso__load_all_kallsyms(dso, filename) < 0)
1420 return -1;
1422 if (kallsyms__delta(kmap, filename, &delta))
1423 return -1;
1425 symbols__fixup_end(&dso->symbols);
1426 symbols__fixup_duplicate(&dso->symbols);
1428 if (dso->kernel == DSO_TYPE_GUEST_KERNEL)
1429 dso->symtab_type = DSO_BINARY_TYPE__GUEST_KALLSYMS;
1430 else
1431 dso->symtab_type = DSO_BINARY_TYPE__KALLSYMS;
1433 if (!no_kcore && !dso__load_kcore(dso, map, filename))
1434 return maps__split_kallsyms_for_kcore(kmap->kmaps, dso);
1435 else
1436 return maps__split_kallsyms(kmap->kmaps, dso, delta, map);
1439 int dso__load_kallsyms(struct dso *dso, const char *filename,
1440 struct map *map)
1442 return __dso__load_kallsyms(dso, filename, map, false);
1445 static int dso__load_perf_map(const char *map_path, struct dso *dso)
1447 char *line = NULL;
1448 size_t n;
1449 FILE *file;
1450 int nr_syms = 0;
1452 file = fopen(map_path, "r");
1453 if (file == NULL)
1454 goto out_failure;
1456 while (!feof(file)) {
1457 u64 start, size;
1458 struct symbol *sym;
1459 int line_len, len;
1461 line_len = getline(&line, &n, file);
1462 if (line_len < 0)
1463 break;
1465 if (!line)
1466 goto out_failure;
1468 line[--line_len] = '\0'; /* \n */
1470 len = hex2u64(line, &start);
1472 len++;
1473 if (len + 2 >= line_len)
1474 continue;
1476 len += hex2u64(line + len, &size);
1478 len++;
1479 if (len + 2 >= line_len)
1480 continue;
1482 sym = symbol__new(start, size, STB_GLOBAL, STT_FUNC, line + len);
1484 if (sym == NULL)
1485 goto out_delete_line;
1487 symbols__insert(&dso->symbols, sym);
1488 nr_syms++;
1491 free(line);
1492 fclose(file);
1494 return nr_syms;
1496 out_delete_line:
1497 free(line);
1498 out_failure:
1499 return -1;
1502 static bool dso__is_compatible_symtab_type(struct dso *dso, bool kmod,
1503 enum dso_binary_type type)
1505 switch (type) {
1506 case DSO_BINARY_TYPE__JAVA_JIT:
1507 case DSO_BINARY_TYPE__DEBUGLINK:
1508 case DSO_BINARY_TYPE__SYSTEM_PATH_DSO:
1509 case DSO_BINARY_TYPE__FEDORA_DEBUGINFO:
1510 case DSO_BINARY_TYPE__UBUNTU_DEBUGINFO:
1511 case DSO_BINARY_TYPE__BUILDID_DEBUGINFO:
1512 case DSO_BINARY_TYPE__OPENEMBEDDED_DEBUGINFO:
1513 return !kmod && dso->kernel == DSO_TYPE_USER;
1515 case DSO_BINARY_TYPE__KALLSYMS:
1516 case DSO_BINARY_TYPE__VMLINUX:
1517 case DSO_BINARY_TYPE__KCORE:
1518 return dso->kernel == DSO_TYPE_KERNEL;
1520 case DSO_BINARY_TYPE__GUEST_KALLSYMS:
1521 case DSO_BINARY_TYPE__GUEST_VMLINUX:
1522 case DSO_BINARY_TYPE__GUEST_KCORE:
1523 return dso->kernel == DSO_TYPE_GUEST_KERNEL;
1525 case DSO_BINARY_TYPE__GUEST_KMODULE:
1526 case DSO_BINARY_TYPE__GUEST_KMODULE_COMP:
1527 case DSO_BINARY_TYPE__SYSTEM_PATH_KMODULE:
1528 case DSO_BINARY_TYPE__SYSTEM_PATH_KMODULE_COMP:
1530 * kernel modules know their symtab type - it's set when
1531 * creating a module dso in machine__addnew_module_map().
1533 return kmod && dso->symtab_type == type;
1535 case DSO_BINARY_TYPE__BUILD_ID_CACHE:
1536 case DSO_BINARY_TYPE__BUILD_ID_CACHE_DEBUGINFO:
1537 return true;
1539 case DSO_BINARY_TYPE__BPF_PROG_INFO:
1540 case DSO_BINARY_TYPE__NOT_FOUND:
1541 default:
1542 return false;
1546 /* Checks for the existence of the perf-<pid>.map file in two different
1547 * locations. First, if the process is a separate mount namespace, check in
1548 * that namespace using the pid of the innermost pid namespace. If's not in a
1549 * namespace, or the file can't be found there, try in the mount namespace of
1550 * the tracing process using our view of its pid.
1552 static int dso__find_perf_map(char *filebuf, size_t bufsz,
1553 struct nsinfo **nsip)
1555 struct nscookie nsc;
1556 struct nsinfo *nsi;
1557 struct nsinfo *nnsi;
1558 int rc = -1;
1560 nsi = *nsip;
1562 if (nsi->need_setns) {
1563 snprintf(filebuf, bufsz, "/tmp/perf-%d.map", nsi->nstgid);
1564 nsinfo__mountns_enter(nsi, &nsc);
1565 rc = access(filebuf, R_OK);
1566 nsinfo__mountns_exit(&nsc);
1567 if (rc == 0)
1568 return rc;
1571 nnsi = nsinfo__copy(nsi);
1572 if (nnsi) {
1573 nsinfo__put(nsi);
1575 nnsi->need_setns = false;
1576 snprintf(filebuf, bufsz, "/tmp/perf-%d.map", nnsi->tgid);
1577 *nsip = nnsi;
1578 rc = 0;
1581 return rc;
1584 int dso__load(struct dso *dso, struct map *map)
1586 char *name;
1587 int ret = -1;
1588 u_int i;
1589 struct machine *machine = NULL;
1590 char *root_dir = (char *) "";
1591 int ss_pos = 0;
1592 struct symsrc ss_[2];
1593 struct symsrc *syms_ss = NULL, *runtime_ss = NULL;
1594 bool kmod;
1595 bool perfmap;
1596 unsigned char build_id[BUILD_ID_SIZE];
1597 struct nscookie nsc;
1598 char newmapname[PATH_MAX];
1599 const char *map_path = dso->long_name;
1601 perfmap = strncmp(dso->name, "/tmp/perf-", 10) == 0;
1602 if (perfmap) {
1603 if (dso->nsinfo && (dso__find_perf_map(newmapname,
1604 sizeof(newmapname), &dso->nsinfo) == 0)) {
1605 map_path = newmapname;
1609 nsinfo__mountns_enter(dso->nsinfo, &nsc);
1610 pthread_mutex_lock(&dso->lock);
1612 /* check again under the dso->lock */
1613 if (dso__loaded(dso)) {
1614 ret = 1;
1615 goto out;
1618 if (dso->kernel) {
1619 if (dso->kernel == DSO_TYPE_KERNEL)
1620 ret = dso__load_kernel_sym(dso, map);
1621 else if (dso->kernel == DSO_TYPE_GUEST_KERNEL)
1622 ret = dso__load_guest_kernel_sym(dso, map);
1624 machine = map__kmaps(map)->machine;
1625 if (machine__is(machine, "x86_64"))
1626 machine__map_x86_64_entry_trampolines(machine, dso);
1627 goto out;
1630 dso->adjust_symbols = 0;
1632 if (perfmap) {
1633 ret = dso__load_perf_map(map_path, dso);
1634 dso->symtab_type = ret > 0 ? DSO_BINARY_TYPE__JAVA_JIT :
1635 DSO_BINARY_TYPE__NOT_FOUND;
1636 goto out;
1639 if (machine)
1640 root_dir = machine->root_dir;
1642 name = malloc(PATH_MAX);
1643 if (!name)
1644 goto out;
1646 kmod = dso->symtab_type == DSO_BINARY_TYPE__SYSTEM_PATH_KMODULE ||
1647 dso->symtab_type == DSO_BINARY_TYPE__SYSTEM_PATH_KMODULE_COMP ||
1648 dso->symtab_type == DSO_BINARY_TYPE__GUEST_KMODULE ||
1649 dso->symtab_type == DSO_BINARY_TYPE__GUEST_KMODULE_COMP;
1653 * Read the build id if possible. This is required for
1654 * DSO_BINARY_TYPE__BUILDID_DEBUGINFO to work
1656 if (!dso->has_build_id &&
1657 is_regular_file(dso->long_name)) {
1658 __symbol__join_symfs(name, PATH_MAX, dso->long_name);
1659 if (filename__read_build_id(name, build_id, BUILD_ID_SIZE) > 0)
1660 dso__set_build_id(dso, build_id);
1664 * Iterate over candidate debug images.
1665 * Keep track of "interesting" ones (those which have a symtab, dynsym,
1666 * and/or opd section) for processing.
1668 for (i = 0; i < DSO_BINARY_TYPE__SYMTAB_CNT; i++) {
1669 struct symsrc *ss = &ss_[ss_pos];
1670 bool next_slot = false;
1671 bool is_reg;
1672 bool nsexit;
1673 int sirc = -1;
1675 enum dso_binary_type symtab_type = binary_type_symtab[i];
1677 nsexit = (symtab_type == DSO_BINARY_TYPE__BUILD_ID_CACHE ||
1678 symtab_type == DSO_BINARY_TYPE__BUILD_ID_CACHE_DEBUGINFO);
1680 if (!dso__is_compatible_symtab_type(dso, kmod, symtab_type))
1681 continue;
1683 if (dso__read_binary_type_filename(dso, symtab_type,
1684 root_dir, name, PATH_MAX))
1685 continue;
1687 if (nsexit)
1688 nsinfo__mountns_exit(&nsc);
1690 is_reg = is_regular_file(name);
1691 if (is_reg)
1692 sirc = symsrc__init(ss, dso, name, symtab_type);
1694 if (nsexit)
1695 nsinfo__mountns_enter(dso->nsinfo, &nsc);
1697 if (!is_reg || sirc < 0)
1698 continue;
1700 if (!syms_ss && symsrc__has_symtab(ss)) {
1701 syms_ss = ss;
1702 next_slot = true;
1703 if (!dso->symsrc_filename)
1704 dso->symsrc_filename = strdup(name);
1707 if (!runtime_ss && symsrc__possibly_runtime(ss)) {
1708 runtime_ss = ss;
1709 next_slot = true;
1712 if (next_slot) {
1713 ss_pos++;
1715 if (syms_ss && runtime_ss)
1716 break;
1717 } else {
1718 symsrc__destroy(ss);
1723 if (!runtime_ss && !syms_ss)
1724 goto out_free;
1726 if (runtime_ss && !syms_ss) {
1727 syms_ss = runtime_ss;
1730 /* We'll have to hope for the best */
1731 if (!runtime_ss && syms_ss)
1732 runtime_ss = syms_ss;
1734 if (syms_ss)
1735 ret = dso__load_sym(dso, map, syms_ss, runtime_ss, kmod);
1736 else
1737 ret = -1;
1739 if (ret > 0) {
1740 int nr_plt;
1742 nr_plt = dso__synthesize_plt_symbols(dso, runtime_ss);
1743 if (nr_plt > 0)
1744 ret += nr_plt;
1747 for (; ss_pos > 0; ss_pos--)
1748 symsrc__destroy(&ss_[ss_pos - 1]);
1749 out_free:
1750 free(name);
1751 if (ret < 0 && strstr(dso->name, " (deleted)") != NULL)
1752 ret = 0;
1753 out:
1754 dso__set_loaded(dso);
1755 pthread_mutex_unlock(&dso->lock);
1756 nsinfo__mountns_exit(&nsc);
1758 return ret;
1761 static int map__strcmp(const void *a, const void *b)
1763 const struct map *ma = *(const struct map **)a, *mb = *(const struct map **)b;
1764 return strcmp(ma->dso->short_name, mb->dso->short_name);
1767 static int map__strcmp_name(const void *name, const void *b)
1769 const struct map *map = *(const struct map **)b;
1770 return strcmp(name, map->dso->short_name);
1773 void __maps__sort_by_name(struct maps *maps)
1775 qsort(maps->maps_by_name, maps->nr_maps, sizeof(struct map *), map__strcmp);
1778 static int map__groups__sort_by_name_from_rbtree(struct maps *maps)
1780 struct map *map;
1781 struct map **maps_by_name = realloc(maps->maps_by_name, maps->nr_maps * sizeof(map));
1782 int i = 0;
1784 if (maps_by_name == NULL)
1785 return -1;
1787 maps->maps_by_name = maps_by_name;
1788 maps->nr_maps_allocated = maps->nr_maps;
1790 maps__for_each_entry(maps, map)
1791 maps_by_name[i++] = map;
1793 __maps__sort_by_name(maps);
1794 return 0;
1797 static struct map *__maps__find_by_name(struct maps *maps, const char *name)
1799 struct map **mapp;
1801 if (maps->maps_by_name == NULL &&
1802 map__groups__sort_by_name_from_rbtree(maps))
1803 return NULL;
1805 mapp = bsearch(name, maps->maps_by_name, maps->nr_maps, sizeof(*mapp), map__strcmp_name);
1806 if (mapp)
1807 return *mapp;
1808 return NULL;
1811 struct map *maps__find_by_name(struct maps *maps, const char *name)
1813 struct map *map;
1815 down_read(&maps->lock);
1817 if (maps->last_search_by_name && strcmp(maps->last_search_by_name->dso->short_name, name) == 0) {
1818 map = maps->last_search_by_name;
1819 goto out_unlock;
1822 * If we have maps->maps_by_name, then the name isn't in the rbtree,
1823 * as maps->maps_by_name mirrors the rbtree when lookups by name are
1824 * made.
1826 map = __maps__find_by_name(maps, name);
1827 if (map || maps->maps_by_name != NULL)
1828 goto out_unlock;
1830 /* Fallback to traversing the rbtree... */
1831 maps__for_each_entry(maps, map)
1832 if (strcmp(map->dso->short_name, name) == 0) {
1833 maps->last_search_by_name = map;
1834 goto out_unlock;
1837 map = NULL;
1839 out_unlock:
1840 up_read(&maps->lock);
1841 return map;
1844 int dso__load_vmlinux(struct dso *dso, struct map *map,
1845 const char *vmlinux, bool vmlinux_allocated)
1847 int err = -1;
1848 struct symsrc ss;
1849 char symfs_vmlinux[PATH_MAX];
1850 enum dso_binary_type symtab_type;
1852 if (vmlinux[0] == '/')
1853 snprintf(symfs_vmlinux, sizeof(symfs_vmlinux), "%s", vmlinux);
1854 else
1855 symbol__join_symfs(symfs_vmlinux, vmlinux);
1857 if (dso->kernel == DSO_TYPE_GUEST_KERNEL)
1858 symtab_type = DSO_BINARY_TYPE__GUEST_VMLINUX;
1859 else
1860 symtab_type = DSO_BINARY_TYPE__VMLINUX;
1862 if (symsrc__init(&ss, dso, symfs_vmlinux, symtab_type))
1863 return -1;
1865 err = dso__load_sym(dso, map, &ss, &ss, 0);
1866 symsrc__destroy(&ss);
1868 if (err > 0) {
1869 if (dso->kernel == DSO_TYPE_GUEST_KERNEL)
1870 dso->binary_type = DSO_BINARY_TYPE__GUEST_VMLINUX;
1871 else
1872 dso->binary_type = DSO_BINARY_TYPE__VMLINUX;
1873 dso__set_long_name(dso, vmlinux, vmlinux_allocated);
1874 dso__set_loaded(dso);
1875 pr_debug("Using %s for symbols\n", symfs_vmlinux);
1878 return err;
1881 int dso__load_vmlinux_path(struct dso *dso, struct map *map)
1883 int i, err = 0;
1884 char *filename = NULL;
1886 pr_debug("Looking at the vmlinux_path (%d entries long)\n",
1887 vmlinux_path__nr_entries + 1);
1889 for (i = 0; i < vmlinux_path__nr_entries; ++i) {
1890 err = dso__load_vmlinux(dso, map, vmlinux_path[i], false);
1891 if (err > 0)
1892 goto out;
1895 if (!symbol_conf.ignore_vmlinux_buildid)
1896 filename = dso__build_id_filename(dso, NULL, 0, false);
1897 if (filename != NULL) {
1898 err = dso__load_vmlinux(dso, map, filename, true);
1899 if (err > 0)
1900 goto out;
1901 free(filename);
1903 out:
1904 return err;
1907 static bool visible_dir_filter(const char *name, struct dirent *d)
1909 if (d->d_type != DT_DIR)
1910 return false;
1911 return lsdir_no_dot_filter(name, d);
1914 static int find_matching_kcore(struct map *map, char *dir, size_t dir_sz)
1916 char kallsyms_filename[PATH_MAX];
1917 int ret = -1;
1918 struct strlist *dirs;
1919 struct str_node *nd;
1921 dirs = lsdir(dir, visible_dir_filter);
1922 if (!dirs)
1923 return -1;
1925 strlist__for_each_entry(nd, dirs) {
1926 scnprintf(kallsyms_filename, sizeof(kallsyms_filename),
1927 "%s/%s/kallsyms", dir, nd->s);
1928 if (!validate_kcore_addresses(kallsyms_filename, map)) {
1929 strlcpy(dir, kallsyms_filename, dir_sz);
1930 ret = 0;
1931 break;
1935 strlist__delete(dirs);
1937 return ret;
1941 * Use open(O_RDONLY) to check readability directly instead of access(R_OK)
1942 * since access(R_OK) only checks with real UID/GID but open() use effective
1943 * UID/GID and actual capabilities (e.g. /proc/kcore requires CAP_SYS_RAWIO).
1945 static bool filename__readable(const char *file)
1947 int fd = open(file, O_RDONLY);
1948 if (fd < 0)
1949 return false;
1950 close(fd);
1951 return true;
1954 static char *dso__find_kallsyms(struct dso *dso, struct map *map)
1956 u8 host_build_id[BUILD_ID_SIZE];
1957 char sbuild_id[SBUILD_ID_SIZE];
1958 bool is_host = false;
1959 char path[PATH_MAX];
1961 if (!dso->has_build_id) {
1963 * Last resort, if we don't have a build-id and couldn't find
1964 * any vmlinux file, try the running kernel kallsyms table.
1966 goto proc_kallsyms;
1969 if (sysfs__read_build_id("/sys/kernel/notes", host_build_id,
1970 sizeof(host_build_id)) == 0)
1971 is_host = dso__build_id_equal(dso, host_build_id);
1973 /* Try a fast path for /proc/kallsyms if possible */
1974 if (is_host) {
1976 * Do not check the build-id cache, unless we know we cannot use
1977 * /proc/kcore or module maps don't match to /proc/kallsyms.
1978 * To check readability of /proc/kcore, do not use access(R_OK)
1979 * since /proc/kcore requires CAP_SYS_RAWIO to read and access
1980 * can't check it.
1982 if (filename__readable("/proc/kcore") &&
1983 !validate_kcore_addresses("/proc/kallsyms", map))
1984 goto proc_kallsyms;
1987 build_id__sprintf(dso->build_id, sizeof(dso->build_id), sbuild_id);
1989 /* Find kallsyms in build-id cache with kcore */
1990 scnprintf(path, sizeof(path), "%s/%s/%s",
1991 buildid_dir, DSO__NAME_KCORE, sbuild_id);
1993 if (!find_matching_kcore(map, path, sizeof(path)))
1994 return strdup(path);
1996 /* Use current /proc/kallsyms if possible */
1997 if (is_host) {
1998 proc_kallsyms:
1999 return strdup("/proc/kallsyms");
2002 /* Finally, find a cache of kallsyms */
2003 if (!build_id_cache__kallsyms_path(sbuild_id, path, sizeof(path))) {
2004 pr_err("No kallsyms or vmlinux with build-id %s was found\n",
2005 sbuild_id);
2006 return NULL;
2009 return strdup(path);
2012 static int dso__load_kernel_sym(struct dso *dso, struct map *map)
2014 int err;
2015 const char *kallsyms_filename = NULL;
2016 char *kallsyms_allocated_filename = NULL;
2018 * Step 1: if the user specified a kallsyms or vmlinux filename, use
2019 * it and only it, reporting errors to the user if it cannot be used.
2021 * For instance, try to analyse an ARM perf.data file _without_ a
2022 * build-id, or if the user specifies the wrong path to the right
2023 * vmlinux file, obviously we can't fallback to another vmlinux (a
2024 * x86_86 one, on the machine where analysis is being performed, say),
2025 * or worse, /proc/kallsyms.
2027 * If the specified file _has_ a build-id and there is a build-id
2028 * section in the perf.data file, we will still do the expected
2029 * validation in dso__load_vmlinux and will bail out if they don't
2030 * match.
2032 if (symbol_conf.kallsyms_name != NULL) {
2033 kallsyms_filename = symbol_conf.kallsyms_name;
2034 goto do_kallsyms;
2037 if (!symbol_conf.ignore_vmlinux && symbol_conf.vmlinux_name != NULL) {
2038 return dso__load_vmlinux(dso, map, symbol_conf.vmlinux_name, false);
2041 if (!symbol_conf.ignore_vmlinux && vmlinux_path != NULL) {
2042 err = dso__load_vmlinux_path(dso, map);
2043 if (err > 0)
2044 return err;
2047 /* do not try local files if a symfs was given */
2048 if (symbol_conf.symfs[0] != 0)
2049 return -1;
2051 kallsyms_allocated_filename = dso__find_kallsyms(dso, map);
2052 if (!kallsyms_allocated_filename)
2053 return -1;
2055 kallsyms_filename = kallsyms_allocated_filename;
2057 do_kallsyms:
2058 err = dso__load_kallsyms(dso, kallsyms_filename, map);
2059 if (err > 0)
2060 pr_debug("Using %s for symbols\n", kallsyms_filename);
2061 free(kallsyms_allocated_filename);
2063 if (err > 0 && !dso__is_kcore(dso)) {
2064 dso->binary_type = DSO_BINARY_TYPE__KALLSYMS;
2065 dso__set_long_name(dso, DSO__NAME_KALLSYMS, false);
2066 map__fixup_start(map);
2067 map__fixup_end(map);
2070 return err;
2073 static int dso__load_guest_kernel_sym(struct dso *dso, struct map *map)
2075 int err;
2076 const char *kallsyms_filename = NULL;
2077 struct machine *machine = map__kmaps(map)->machine;
2078 char path[PATH_MAX];
2080 if (machine__is_default_guest(machine)) {
2082 * if the user specified a vmlinux filename, use it and only
2083 * it, reporting errors to the user if it cannot be used.
2084 * Or use file guest_kallsyms inputted by user on commandline
2086 if (symbol_conf.default_guest_vmlinux_name != NULL) {
2087 err = dso__load_vmlinux(dso, map,
2088 symbol_conf.default_guest_vmlinux_name,
2089 false);
2090 return err;
2093 kallsyms_filename = symbol_conf.default_guest_kallsyms;
2094 if (!kallsyms_filename)
2095 return -1;
2096 } else {
2097 sprintf(path, "%s/proc/kallsyms", machine->root_dir);
2098 kallsyms_filename = path;
2101 err = dso__load_kallsyms(dso, kallsyms_filename, map);
2102 if (err > 0)
2103 pr_debug("Using %s for symbols\n", kallsyms_filename);
2104 if (err > 0 && !dso__is_kcore(dso)) {
2105 dso->binary_type = DSO_BINARY_TYPE__GUEST_KALLSYMS;
2106 dso__set_long_name(dso, machine->mmap_name, false);
2107 map__fixup_start(map);
2108 map__fixup_end(map);
2111 return err;
2114 static void vmlinux_path__exit(void)
2116 while (--vmlinux_path__nr_entries >= 0)
2117 zfree(&vmlinux_path[vmlinux_path__nr_entries]);
2118 vmlinux_path__nr_entries = 0;
2120 zfree(&vmlinux_path);
2123 static const char * const vmlinux_paths[] = {
2124 "vmlinux",
2125 "/boot/vmlinux"
2128 static const char * const vmlinux_paths_upd[] = {
2129 "/boot/vmlinux-%s",
2130 "/usr/lib/debug/boot/vmlinux-%s",
2131 "/lib/modules/%s/build/vmlinux",
2132 "/usr/lib/debug/lib/modules/%s/vmlinux",
2133 "/usr/lib/debug/boot/vmlinux-%s.debug"
2136 static int vmlinux_path__add(const char *new_entry)
2138 vmlinux_path[vmlinux_path__nr_entries] = strdup(new_entry);
2139 if (vmlinux_path[vmlinux_path__nr_entries] == NULL)
2140 return -1;
2141 ++vmlinux_path__nr_entries;
2143 return 0;
2146 static int vmlinux_path__init(struct perf_env *env)
2148 struct utsname uts;
2149 char bf[PATH_MAX];
2150 char *kernel_version;
2151 unsigned int i;
2153 vmlinux_path = malloc(sizeof(char *) * (ARRAY_SIZE(vmlinux_paths) +
2154 ARRAY_SIZE(vmlinux_paths_upd)));
2155 if (vmlinux_path == NULL)
2156 return -1;
2158 for (i = 0; i < ARRAY_SIZE(vmlinux_paths); i++)
2159 if (vmlinux_path__add(vmlinux_paths[i]) < 0)
2160 goto out_fail;
2162 /* only try kernel version if no symfs was given */
2163 if (symbol_conf.symfs[0] != 0)
2164 return 0;
2166 if (env) {
2167 kernel_version = env->os_release;
2168 } else {
2169 if (uname(&uts) < 0)
2170 goto out_fail;
2172 kernel_version = uts.release;
2175 for (i = 0; i < ARRAY_SIZE(vmlinux_paths_upd); i++) {
2176 snprintf(bf, sizeof(bf), vmlinux_paths_upd[i], kernel_version);
2177 if (vmlinux_path__add(bf) < 0)
2178 goto out_fail;
2181 return 0;
2183 out_fail:
2184 vmlinux_path__exit();
2185 return -1;
2188 int setup_list(struct strlist **list, const char *list_str,
2189 const char *list_name)
2191 if (list_str == NULL)
2192 return 0;
2194 *list = strlist__new(list_str, NULL);
2195 if (!*list) {
2196 pr_err("problems parsing %s list\n", list_name);
2197 return -1;
2200 symbol_conf.has_filter = true;
2201 return 0;
2204 int setup_intlist(struct intlist **list, const char *list_str,
2205 const char *list_name)
2207 if (list_str == NULL)
2208 return 0;
2210 *list = intlist__new(list_str);
2211 if (!*list) {
2212 pr_err("problems parsing %s list\n", list_name);
2213 return -1;
2215 return 0;
2218 static bool symbol__read_kptr_restrict(void)
2220 bool value = false;
2221 FILE *fp = fopen("/proc/sys/kernel/kptr_restrict", "r");
2223 if (fp != NULL) {
2224 char line[8];
2226 if (fgets(line, sizeof(line), fp) != NULL)
2227 value = perf_cap__capable(CAP_SYSLOG) ?
2228 (atoi(line) >= 2) :
2229 (atoi(line) != 0);
2231 fclose(fp);
2234 /* Per kernel/kallsyms.c:
2235 * we also restrict when perf_event_paranoid > 1 w/o CAP_SYSLOG
2237 if (perf_event_paranoid() > 1 && !perf_cap__capable(CAP_SYSLOG))
2238 value = true;
2240 return value;
2243 int symbol__annotation_init(void)
2245 if (symbol_conf.init_annotation)
2246 return 0;
2248 if (symbol_conf.initialized) {
2249 pr_err("Annotation needs to be init before symbol__init()\n");
2250 return -1;
2253 symbol_conf.priv_size += sizeof(struct annotation);
2254 symbol_conf.init_annotation = true;
2255 return 0;
2258 int symbol__init(struct perf_env *env)
2260 const char *symfs;
2262 if (symbol_conf.initialized)
2263 return 0;
2265 symbol_conf.priv_size = PERF_ALIGN(symbol_conf.priv_size, sizeof(u64));
2267 symbol__elf_init();
2269 if (symbol_conf.sort_by_name)
2270 symbol_conf.priv_size += (sizeof(struct symbol_name_rb_node) -
2271 sizeof(struct symbol));
2273 if (symbol_conf.try_vmlinux_path && vmlinux_path__init(env) < 0)
2274 return -1;
2276 if (symbol_conf.field_sep && *symbol_conf.field_sep == '.') {
2277 pr_err("'.' is the only non valid --field-separator argument\n");
2278 return -1;
2281 if (setup_list(&symbol_conf.dso_list,
2282 symbol_conf.dso_list_str, "dso") < 0)
2283 return -1;
2285 if (setup_list(&symbol_conf.comm_list,
2286 symbol_conf.comm_list_str, "comm") < 0)
2287 goto out_free_dso_list;
2289 if (setup_intlist(&symbol_conf.pid_list,
2290 symbol_conf.pid_list_str, "pid") < 0)
2291 goto out_free_comm_list;
2293 if (setup_intlist(&symbol_conf.tid_list,
2294 symbol_conf.tid_list_str, "tid") < 0)
2295 goto out_free_pid_list;
2297 if (setup_list(&symbol_conf.sym_list,
2298 symbol_conf.sym_list_str, "symbol") < 0)
2299 goto out_free_tid_list;
2301 if (setup_list(&symbol_conf.bt_stop_list,
2302 symbol_conf.bt_stop_list_str, "symbol") < 0)
2303 goto out_free_sym_list;
2306 * A path to symbols of "/" is identical to ""
2307 * reset here for simplicity.
2309 symfs = realpath(symbol_conf.symfs, NULL);
2310 if (symfs == NULL)
2311 symfs = symbol_conf.symfs;
2312 if (strcmp(symfs, "/") == 0)
2313 symbol_conf.symfs = "";
2314 if (symfs != symbol_conf.symfs)
2315 free((void *)symfs);
2317 symbol_conf.kptr_restrict = symbol__read_kptr_restrict();
2319 symbol_conf.initialized = true;
2320 return 0;
2322 out_free_sym_list:
2323 strlist__delete(symbol_conf.sym_list);
2324 out_free_tid_list:
2325 intlist__delete(symbol_conf.tid_list);
2326 out_free_pid_list:
2327 intlist__delete(symbol_conf.pid_list);
2328 out_free_comm_list:
2329 strlist__delete(symbol_conf.comm_list);
2330 out_free_dso_list:
2331 strlist__delete(symbol_conf.dso_list);
2332 return -1;
2335 void symbol__exit(void)
2337 if (!symbol_conf.initialized)
2338 return;
2339 strlist__delete(symbol_conf.bt_stop_list);
2340 strlist__delete(symbol_conf.sym_list);
2341 strlist__delete(symbol_conf.dso_list);
2342 strlist__delete(symbol_conf.comm_list);
2343 intlist__delete(symbol_conf.tid_list);
2344 intlist__delete(symbol_conf.pid_list);
2345 vmlinux_path__exit();
2346 symbol_conf.sym_list = symbol_conf.dso_list = symbol_conf.comm_list = NULL;
2347 symbol_conf.bt_stop_list = NULL;
2348 symbol_conf.initialized = false;
2351 int symbol__config_symfs(const struct option *opt __maybe_unused,
2352 const char *dir, int unset __maybe_unused)
2354 char *bf = NULL;
2355 int ret;
2357 symbol_conf.symfs = strdup(dir);
2358 if (symbol_conf.symfs == NULL)
2359 return -ENOMEM;
2361 /* skip the locally configured cache if a symfs is given, and
2362 * config buildid dir to symfs/.debug
2364 ret = asprintf(&bf, "%s/%s", dir, ".debug");
2365 if (ret < 0)
2366 return -ENOMEM;
2368 set_buildid_dir(bf);
2370 free(bf);
2371 return 0;
2374 struct mem_info *mem_info__get(struct mem_info *mi)
2376 if (mi)
2377 refcount_inc(&mi->refcnt);
2378 return mi;
2381 void mem_info__put(struct mem_info *mi)
2383 if (mi && refcount_dec_and_test(&mi->refcnt))
2384 free(mi);
2387 struct mem_info *mem_info__new(void)
2389 struct mem_info *mi = zalloc(sizeof(*mi));
2391 if (mi)
2392 refcount_set(&mi->refcnt, 1);
2393 return mi;