1 // SPDX-License-Identifier: GPL-2.0
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>
14 #include <sys/param.h>
22 #include "util.h" // lsdir()
28 #include "map_symbol.h"
29 #include "mem-events.h"
34 #include "namespaces.h"
37 #include <linux/ctype.h>
38 #include <linux/zalloc.h>
42 #include <symbol/kallsyms.h>
43 #include <sys/utsname.h>
45 static int dso__load_kernel_sym(struct dso *dso, struct map *map);
46 static int dso__load_guest_kernel_sym(struct dso *dso, struct map *map);
47 static bool symbol__is_idle(const char *name);
49 int vmlinux_path__nr_entries;
52 struct symbol_conf symbol_conf = {
55 .try_vmlinux_path = true,
57 .demangle_kernel = false,
58 .cumulate_callchain = true,
59 .time_quantum = 100 * NSEC_PER_MSEC, /* 100ms */
60 .show_hist_headers = true,
67 struct map_list_node {
68 struct list_head node;
72 static struct map_list_node *map_list_node__new(void)
74 return malloc(sizeof(struct map_list_node));
77 static enum dso_binary_type binary_type_symtab[] = {
78 DSO_BINARY_TYPE__KALLSYMS,
79 DSO_BINARY_TYPE__GUEST_KALLSYMS,
80 DSO_BINARY_TYPE__JAVA_JIT,
81 DSO_BINARY_TYPE__DEBUGLINK,
82 DSO_BINARY_TYPE__BUILD_ID_CACHE,
83 DSO_BINARY_TYPE__BUILD_ID_CACHE_DEBUGINFO,
84 DSO_BINARY_TYPE__FEDORA_DEBUGINFO,
85 DSO_BINARY_TYPE__UBUNTU_DEBUGINFO,
86 DSO_BINARY_TYPE__BUILDID_DEBUGINFO,
87 DSO_BINARY_TYPE__SYSTEM_PATH_DSO,
88 DSO_BINARY_TYPE__GUEST_KMODULE,
89 DSO_BINARY_TYPE__GUEST_KMODULE_COMP,
90 DSO_BINARY_TYPE__SYSTEM_PATH_KMODULE,
91 DSO_BINARY_TYPE__SYSTEM_PATH_KMODULE_COMP,
92 DSO_BINARY_TYPE__OPENEMBEDDED_DEBUGINFO,
93 DSO_BINARY_TYPE__MIXEDUP_UBUNTU_DEBUGINFO,
94 DSO_BINARY_TYPE__NOT_FOUND,
97 #define DSO_BINARY_TYPE__SYMTAB_CNT ARRAY_SIZE(binary_type_symtab)
99 static bool symbol_type__filter(char symbol_type)
101 symbol_type = toupper(symbol_type);
102 return symbol_type == 'T' || symbol_type == 'W' || symbol_type == 'D' || symbol_type == 'B';
105 static int prefix_underscores_count(const char *str)
107 const char *tail = str;
115 const char * __weak arch__normalize_symbol_name(const char *name)
120 int __weak arch__compare_symbol_names(const char *namea, const char *nameb)
122 return strcmp(namea, nameb);
125 int __weak arch__compare_symbol_names_n(const char *namea, const char *nameb,
128 return strncmp(namea, nameb, n);
131 int __weak arch__choose_best_symbol(struct symbol *syma,
132 struct symbol *symb __maybe_unused)
134 /* Avoid "SyS" kernel syscall aliases */
135 if (strlen(syma->name) >= 3 && !strncmp(syma->name, "SyS", 3))
137 if (strlen(syma->name) >= 10 && !strncmp(syma->name, "compat_SyS", 10))
143 static int choose_best_symbol(struct symbol *syma, struct symbol *symb)
149 /* Prefer a symbol with non zero length */
150 a = syma->end - syma->start;
151 b = symb->end - symb->start;
152 if ((b == 0) && (a > 0))
154 else if ((a == 0) && (b > 0))
157 if (syma->type != symb->type) {
158 if (syma->type == STT_NOTYPE)
160 if (symb->type == STT_NOTYPE)
164 /* Prefer a non weak symbol over a weak one */
165 a = syma->binding == STB_WEAK;
166 b = symb->binding == STB_WEAK;
172 /* Prefer a global symbol over a non global one */
173 a = syma->binding == STB_GLOBAL;
174 b = symb->binding == STB_GLOBAL;
180 /* Prefer a symbol with less underscores */
181 a = prefix_underscores_count(syma->name);
182 b = prefix_underscores_count(symb->name);
188 /* Choose the symbol with the longest name */
189 na = strlen(syma->name);
190 nb = strlen(symb->name);
196 return arch__choose_best_symbol(syma, symb);
199 void symbols__fixup_duplicate(struct rb_root_cached *symbols)
202 struct symbol *curr, *next;
204 if (symbol_conf.allow_aliases)
207 nd = rb_first_cached(symbols);
210 curr = rb_entry(nd, struct symbol, rb_node);
212 nd = rb_next(&curr->rb_node);
216 next = rb_entry(nd, struct symbol, rb_node);
217 if (curr->start != next->start)
220 if (choose_best_symbol(curr, next) == SYMBOL_A) {
221 if (next->type == STT_GNU_IFUNC)
222 curr->ifunc_alias = true;
223 rb_erase_cached(&next->rb_node, symbols);
224 symbol__delete(next);
227 if (curr->type == STT_GNU_IFUNC)
228 next->ifunc_alias = true;
229 nd = rb_next(&curr->rb_node);
230 rb_erase_cached(&curr->rb_node, symbols);
231 symbol__delete(curr);
236 /* Update zero-sized symbols using the address of the next symbol */
237 void symbols__fixup_end(struct rb_root_cached *symbols, bool is_kallsyms)
239 struct rb_node *nd, *prevnd = rb_first_cached(symbols);
240 struct symbol *curr, *prev;
245 curr = rb_entry(prevnd, struct symbol, rb_node);
247 for (nd = rb_next(prevnd); nd; nd = rb_next(nd)) {
249 curr = rb_entry(nd, struct symbol, rb_node);
252 * On some architecture kernel text segment start is located at
253 * some low memory address, while modules are located at high
254 * memory addresses (or vice versa). The gap between end of
255 * kernel text segment and beginning of first module's text
256 * segment is very big. Therefore do not fill this gap and do
257 * not assign it to the kernel dso map (kallsyms).
259 * Also BPF code can be allocated separately from text segments
260 * and modules. So the last entry in a module should not fill
263 * In kallsyms, it determines module symbols using '[' character
265 * ffffffffc1937000 T hdmi_driver_init [snd_hda_codec_hdmi]
267 if (prev->end == prev->start) {
268 const char *prev_mod;
269 const char *curr_mod;
272 prev->end = curr->start;
276 prev_mod = strchr(prev->name, '[');
277 curr_mod = strchr(curr->name, '[');
279 /* Last kernel/module symbol mapped to end of page */
280 if (!prev_mod != !curr_mod)
281 prev->end = roundup(prev->end + 4096, 4096);
282 /* Last symbol in the previous module */
283 else if (prev_mod && strcmp(prev_mod, curr_mod))
284 prev->end = roundup(prev->end + 4096, 4096);
286 prev->end = curr->start;
288 pr_debug4("%s sym:%s end:%#" PRIx64 "\n",
289 __func__, prev->name, prev->end);
294 if (curr->end == curr->start)
295 curr->end = roundup(curr->start, 4096) + 4096;
298 struct symbol *symbol__new(u64 start, u64 len, u8 binding, u8 type, const char *name)
300 size_t namelen = strlen(name) + 1;
301 struct symbol *sym = calloc(1, (symbol_conf.priv_size +
302 sizeof(*sym) + namelen));
306 if (symbol_conf.priv_size) {
307 if (symbol_conf.init_annotation) {
308 struct annotation *notes = (void *)sym;
309 annotation__init(notes);
311 sym = ((void *)sym) + symbol_conf.priv_size;
315 sym->end = len ? start + len : start;
317 sym->binding = binding;
318 sym->namelen = namelen - 1;
320 pr_debug4("%s: %s %#" PRIx64 "-%#" PRIx64 "\n",
321 __func__, name, start, sym->end);
322 memcpy(sym->name, name, namelen);
327 void symbol__delete(struct symbol *sym)
329 if (symbol_conf.priv_size) {
330 if (symbol_conf.init_annotation) {
331 struct annotation *notes = symbol__annotation(sym);
333 annotation__exit(notes);
336 free(((void *)sym) - symbol_conf.priv_size);
339 void symbols__delete(struct rb_root_cached *symbols)
342 struct rb_node *next = rb_first_cached(symbols);
345 pos = rb_entry(next, struct symbol, rb_node);
346 next = rb_next(&pos->rb_node);
347 rb_erase_cached(&pos->rb_node, symbols);
352 void __symbols__insert(struct rb_root_cached *symbols,
353 struct symbol *sym, bool kernel)
355 struct rb_node **p = &symbols->rb_root.rb_node;
356 struct rb_node *parent = NULL;
357 const u64 ip = sym->start;
359 bool leftmost = true;
362 const char *name = sym->name;
364 * ppc64 uses function descriptors and appends a '.' to the
365 * start of every instruction address. Remove it.
369 sym->idle = symbol__is_idle(name);
374 s = rb_entry(parent, struct symbol, rb_node);
382 rb_link_node(&sym->rb_node, parent, p);
383 rb_insert_color_cached(&sym->rb_node, symbols, leftmost);
386 void symbols__insert(struct rb_root_cached *symbols, struct symbol *sym)
388 __symbols__insert(symbols, sym, false);
391 static struct symbol *symbols__find(struct rb_root_cached *symbols, u64 ip)
398 n = symbols->rb_root.rb_node;
401 struct symbol *s = rb_entry(n, struct symbol, rb_node);
405 else if (ip > s->end || (ip == s->end && ip != s->start))
414 static struct symbol *symbols__first(struct rb_root_cached *symbols)
416 struct rb_node *n = rb_first_cached(symbols);
419 return rb_entry(n, struct symbol, rb_node);
424 static struct symbol *symbols__last(struct rb_root_cached *symbols)
426 struct rb_node *n = rb_last(&symbols->rb_root);
429 return rb_entry(n, struct symbol, rb_node);
434 static struct symbol *symbols__next(struct symbol *sym)
436 struct rb_node *n = rb_next(&sym->rb_node);
439 return rb_entry(n, struct symbol, rb_node);
444 static int symbols__sort_name_cmp(const void *vlhs, const void *vrhs)
446 const struct symbol *lhs = *((const struct symbol **)vlhs);
447 const struct symbol *rhs = *((const struct symbol **)vrhs);
449 return strcmp(lhs->name, rhs->name);
452 static struct symbol **symbols__sort_by_name(struct rb_root_cached *source, size_t *len)
455 struct symbol **result;
456 size_t i = 0, size = 0;
458 for (nd = rb_first_cached(source); nd; nd = rb_next(nd))
461 result = malloc(sizeof(*result) * size);
465 for (nd = rb_first_cached(source); nd; nd = rb_next(nd)) {
466 struct symbol *pos = rb_entry(nd, struct symbol, rb_node);
470 qsort(result, size, sizeof(*result), symbols__sort_name_cmp);
475 int symbol__match_symbol_name(const char *name, const char *str,
476 enum symbol_tag_include includes)
478 const char *versioning;
480 if (includes == SYMBOL_TAG_INCLUDE__DEFAULT_ONLY &&
481 (versioning = strstr(name, "@@"))) {
482 int len = strlen(str);
484 if (len < versioning - name)
485 len = versioning - name;
487 return arch__compare_symbol_names_n(name, str, len);
489 return arch__compare_symbol_names(name, str);
492 static struct symbol *symbols__find_by_name(struct symbol *symbols[],
495 enum symbol_tag_include includes,
498 size_t i, lower = 0, upper = symbols_len;
499 struct symbol *s = NULL;
502 *found_idx = SIZE_MAX;
507 while (lower < upper) {
510 i = (lower + upper) / 2;
511 cmp = symbol__match_symbol_name(symbols[i]->name, name, includes);
524 if (s && includes != SYMBOL_TAG_INCLUDE__DEFAULT_ONLY) {
525 /* return first symbol that has same name (if any) */
527 struct symbol *tmp = symbols[i - 1];
529 if (!arch__compare_symbol_names(tmp->name, s->name)) {
537 assert(!found_idx || !s || s == symbols[*found_idx]);
541 void dso__reset_find_symbol_cache(struct dso *dso)
543 dso__set_last_find_result_addr(dso, 0);
544 dso__set_last_find_result_symbol(dso, NULL);
547 void dso__insert_symbol(struct dso *dso, struct symbol *sym)
549 __symbols__insert(dso__symbols(dso), sym, dso__kernel(dso));
551 /* update the symbol cache if necessary */
552 if (dso__last_find_result_addr(dso) >= sym->start &&
553 (dso__last_find_result_addr(dso) < sym->end ||
554 sym->start == sym->end)) {
555 dso__set_last_find_result_symbol(dso, sym);
559 void dso__delete_symbol(struct dso *dso, struct symbol *sym)
561 rb_erase_cached(&sym->rb_node, dso__symbols(dso));
563 dso__reset_find_symbol_cache(dso);
566 struct symbol *dso__find_symbol(struct dso *dso, u64 addr)
568 if (dso__last_find_result_addr(dso) != addr || dso__last_find_result_symbol(dso) == NULL) {
569 dso__set_last_find_result_addr(dso, addr);
570 dso__set_last_find_result_symbol(dso, symbols__find(dso__symbols(dso), addr));
573 return dso__last_find_result_symbol(dso);
576 struct symbol *dso__find_symbol_nocache(struct dso *dso, u64 addr)
578 return symbols__find(dso__symbols(dso), addr);
581 struct symbol *dso__first_symbol(struct dso *dso)
583 return symbols__first(dso__symbols(dso));
586 struct symbol *dso__last_symbol(struct dso *dso)
588 return symbols__last(dso__symbols(dso));
591 struct symbol *dso__next_symbol(struct symbol *sym)
593 return symbols__next(sym);
596 struct symbol *dso__next_symbol_by_name(struct dso *dso, size_t *idx)
598 if (*idx + 1 >= dso__symbol_names_len(dso))
602 return dso__symbol_names(dso)[*idx];
606 * Returns first symbol that matched with @name.
608 struct symbol *dso__find_symbol_by_name(struct dso *dso, const char *name, size_t *idx)
610 struct symbol *s = symbols__find_by_name(dso__symbol_names(dso),
611 dso__symbol_names_len(dso),
612 name, SYMBOL_TAG_INCLUDE__NONE, idx);
614 s = symbols__find_by_name(dso__symbol_names(dso), dso__symbol_names_len(dso),
615 name, SYMBOL_TAG_INCLUDE__DEFAULT_ONLY, idx);
620 void dso__sort_by_name(struct dso *dso)
622 mutex_lock(dso__lock(dso));
623 if (!dso__sorted_by_name(dso)) {
626 dso__set_symbol_names(dso, symbols__sort_by_name(dso__symbols(dso), &len));
627 if (dso__symbol_names(dso)) {
628 dso__set_symbol_names_len(dso, len);
629 dso__set_sorted_by_name(dso);
632 mutex_unlock(dso__lock(dso));
636 * While we find nice hex chars, build a long_val.
637 * Return number of chars processed.
639 static int hex2u64(const char *ptr, u64 *long_val)
643 *long_val = strtoull(ptr, &p, 16);
649 int modules__parse(const char *filename, void *arg,
650 int (*process_module)(void *arg, const char *name,
651 u64 start, u64 size))
658 file = fopen(filename, "r");
668 line_len = getline(&line, &n, file);
681 line[--line_len] = '\0'; /* \n */
683 sep = strrchr(line, 'x');
687 hex2u64(sep + 1, &start);
689 sep = strchr(line, ' ');
695 scnprintf(name, sizeof(name), "[%s]", line);
697 size = strtoul(sep + 1, &endptr, 0);
698 if (*endptr != ' ' && *endptr != '\t')
701 err = process_module(arg, name, start, size);
712 * These are symbols in the kernel image, so make sure that
713 * sym is from a kernel DSO.
715 static bool symbol__is_idle(const char *name)
717 const char * const idle_symbols[] = {
718 "acpi_idle_do_entry",
719 "acpi_processor_ffh_cstate_enter",
731 "mwait_idle_with_hints",
732 "mwait_idle_with_hints.constprop.0",
734 "ppc64_runlatch_off",
735 "pseries_dedicated_idle_sleep",
741 static struct strlist *idle_symbols_list;
743 if (idle_symbols_list)
744 return strlist__has_entry(idle_symbols_list, name);
746 idle_symbols_list = strlist__new(NULL, NULL);
748 for (i = 0; idle_symbols[i]; i++)
749 strlist__add(idle_symbols_list, idle_symbols[i]);
751 return strlist__has_entry(idle_symbols_list, name);
754 static int map__process_kallsym_symbol(void *arg, const char *name,
755 char type, u64 start)
758 struct dso *dso = arg;
759 struct rb_root_cached *root = dso__symbols(dso);
761 if (!symbol_type__filter(type))
764 /* Ignore local symbols for ARM modules */
769 * module symbols are not sorted so we add all
770 * symbols, setting length to 0, and rely on
771 * symbols__fixup_end() to fix it up.
773 sym = symbol__new(start, 0, kallsyms2elf_binding(type), kallsyms2elf_type(type), name);
777 * We will pass the symbols to the filter later, in
778 * map__split_kallsyms, when we have split the maps per module
780 __symbols__insert(root, sym, !strchr(name, '['));
786 * Loads the function entries in /proc/kallsyms into kernel_map->dso,
787 * so that we can in the next step set the symbol ->end address and then
788 * call kernel_maps__split_kallsyms.
790 static int dso__load_all_kallsyms(struct dso *dso, const char *filename)
792 return kallsyms__parse(filename, dso, map__process_kallsym_symbol);
795 static int maps__split_kallsyms_for_kcore(struct maps *kmaps, struct dso *dso)
799 struct rb_root_cached *root = dso__symbols(dso);
800 struct rb_root_cached old_root = *root;
801 struct rb_node *next = rb_first_cached(root);
806 *root = RB_ROOT_CACHED;
809 struct map *curr_map;
810 struct dso *curr_map_dso;
813 pos = rb_entry(next, struct symbol, rb_node);
814 next = rb_next(&pos->rb_node);
816 rb_erase_cached(&pos->rb_node, &old_root);
817 RB_CLEAR_NODE(&pos->rb_node);
818 module = strchr(pos->name, '\t');
822 curr_map = maps__find(kmaps, pos->start);
828 curr_map_dso = map__dso(curr_map);
829 pos->start -= map__start(curr_map) - map__pgoff(curr_map);
830 if (pos->end > map__end(curr_map))
831 pos->end = map__end(curr_map);
833 pos->end -= map__start(curr_map) - map__pgoff(curr_map);
834 symbols__insert(dso__symbols(curr_map_dso), pos);
839 /* Symbols have been adjusted */
840 dso__set_adjust_symbols(dso, true);
846 * Split the symbols into maps, making sure there are no overlaps, i.e. the
847 * kernel range is broken in several maps, named [kernel].N, as we don't have
848 * the original ELF section names vmlinux have.
850 static int maps__split_kallsyms(struct maps *kmaps, struct dso *dso, u64 delta,
851 struct map *initial_map)
853 struct machine *machine;
854 struct map *curr_map = map__get(initial_map);
856 int count = 0, moved = 0;
857 struct rb_root_cached *root = dso__symbols(dso);
858 struct rb_node *next = rb_first_cached(root);
859 int kernel_range = 0;
865 machine = maps__machine(kmaps);
867 x86_64 = machine__is(machine, "x86_64");
872 pos = rb_entry(next, struct symbol, rb_node);
873 next = rb_next(&pos->rb_node);
875 module = strchr(pos->name, '\t');
877 struct dso *curr_map_dso;
879 if (!symbol_conf.use_modules)
883 curr_map_dso = map__dso(curr_map);
884 if (strcmp(dso__short_name(curr_map_dso), module)) {
885 if (!RC_CHK_EQUAL(curr_map, initial_map) &&
886 dso__kernel(dso) == DSO_SPACE__KERNEL_GUEST &&
887 machine__is_default_guest(machine)) {
889 * We assume all symbols of a module are
890 * continuous in * kallsyms, so curr_map
891 * points to a module and all its
892 * symbols are in its kmap. Mark it as
895 dso__set_loaded(curr_map_dso);
899 curr_map = maps__find_by_name(kmaps, module);
900 if (curr_map == NULL) {
901 pr_debug("%s/proc/{kallsyms,modules} "
902 "inconsistency while looking "
903 "for \"%s\" module!\n",
904 machine->root_dir, module);
905 curr_map = map__get(initial_map);
908 curr_map_dso = map__dso(curr_map);
909 if (dso__loaded(curr_map_dso) &&
910 !machine__is_default_guest(machine))
914 * So that we look just like we get from .ko files,
915 * i.e. not prelinked, relative to initial_map->start.
917 pos->start = map__map_ip(curr_map, pos->start);
918 pos->end = map__map_ip(curr_map, pos->end);
919 } else if (x86_64 && is_entry_trampoline(pos->name)) {
921 * These symbols are not needed anymore since the
922 * trampoline maps refer to the text section and it's
923 * symbols instead. Avoid having to deal with
924 * relocations, and the assumption that the first symbol
925 * is the start of kernel text, by simply removing the
926 * symbols at this point.
929 } else if (!RC_CHK_EQUAL(curr_map, initial_map)) {
930 char dso_name[PATH_MAX];
934 /* Kernel was relocated at boot time */
941 curr_map = map__get(initial_map);
945 if (dso__kernel(dso) == DSO_SPACE__KERNEL_GUEST)
946 snprintf(dso_name, sizeof(dso_name),
950 snprintf(dso_name, sizeof(dso_name),
954 ndso = dso__new(dso_name);
959 dso__set_kernel(ndso, dso__kernel(dso));
961 curr_map = map__new2(pos->start, ndso);
962 if (curr_map == NULL) {
967 map__set_mapping_type(curr_map, MAPPING_TYPE__IDENTITY);
968 if (maps__insert(kmaps, curr_map)) {
975 /* Kernel was relocated at boot time */
980 if (!RC_CHK_EQUAL(curr_map, initial_map)) {
981 struct dso *curr_map_dso = map__dso(curr_map);
983 rb_erase_cached(&pos->rb_node, root);
984 symbols__insert(dso__symbols(curr_map_dso), pos);
991 rb_erase_cached(&pos->rb_node, root);
995 if (!RC_CHK_EQUAL(curr_map, initial_map) &&
996 dso__kernel(dso) == DSO_SPACE__KERNEL_GUEST &&
997 machine__is_default_guest(maps__machine(kmaps))) {
998 dso__set_loaded(map__dso(curr_map));
1001 return count + moved;
1004 bool symbol__restricted_filename(const char *filename,
1005 const char *restricted_filename)
1007 bool restricted = false;
1009 if (symbol_conf.kptr_restrict) {
1010 char *r = realpath(filename, NULL);
1013 restricted = strcmp(r, restricted_filename) == 0;
1022 struct module_info {
1023 struct rb_node rb_node;
1028 static void add_module(struct module_info *mi, struct rb_root *modules)
1030 struct rb_node **p = &modules->rb_node;
1031 struct rb_node *parent = NULL;
1032 struct module_info *m;
1034 while (*p != NULL) {
1036 m = rb_entry(parent, struct module_info, rb_node);
1037 if (strcmp(mi->name, m->name) < 0)
1040 p = &(*p)->rb_right;
1042 rb_link_node(&mi->rb_node, parent, p);
1043 rb_insert_color(&mi->rb_node, modules);
1046 static void delete_modules(struct rb_root *modules)
1048 struct module_info *mi;
1049 struct rb_node *next = rb_first(modules);
1052 mi = rb_entry(next, struct module_info, rb_node);
1053 next = rb_next(&mi->rb_node);
1054 rb_erase(&mi->rb_node, modules);
1060 static struct module_info *find_module(const char *name,
1061 struct rb_root *modules)
1063 struct rb_node *n = modules->rb_node;
1066 struct module_info *m;
1069 m = rb_entry(n, struct module_info, rb_node);
1070 cmp = strcmp(name, m->name);
1082 static int __read_proc_modules(void *arg, const char *name, u64 start,
1083 u64 size __maybe_unused)
1085 struct rb_root *modules = arg;
1086 struct module_info *mi;
1088 mi = zalloc(sizeof(struct module_info));
1092 mi->name = strdup(name);
1100 add_module(mi, modules);
1105 static int read_proc_modules(const char *filename, struct rb_root *modules)
1107 if (symbol__restricted_filename(filename, "/proc/modules"))
1110 if (modules__parse(filename, modules, __read_proc_modules)) {
1111 delete_modules(modules);
1118 int compare_proc_modules(const char *from, const char *to)
1120 struct rb_root from_modules = RB_ROOT;
1121 struct rb_root to_modules = RB_ROOT;
1122 struct rb_node *from_node, *to_node;
1123 struct module_info *from_m, *to_m;
1126 if (read_proc_modules(from, &from_modules))
1129 if (read_proc_modules(to, &to_modules))
1130 goto out_delete_from;
1132 from_node = rb_first(&from_modules);
1133 to_node = rb_first(&to_modules);
1138 from_m = rb_entry(from_node, struct module_info, rb_node);
1139 to_m = rb_entry(to_node, struct module_info, rb_node);
1141 if (from_m->start != to_m->start ||
1142 strcmp(from_m->name, to_m->name))
1145 from_node = rb_next(from_node);
1146 to_node = rb_next(to_node);
1149 if (!from_node && !to_node)
1152 delete_modules(&to_modules);
1154 delete_modules(&from_modules);
1159 static int do_validate_kcore_modules_cb(struct map *old_map, void *data)
1161 struct rb_root *modules = data;
1162 struct module_info *mi;
1165 if (!__map__is_kmodule(old_map))
1168 dso = map__dso(old_map);
1169 /* Module must be in memory at the same address */
1170 mi = find_module(dso__short_name(dso), modules);
1171 if (!mi || mi->start != map__start(old_map))
1177 static int do_validate_kcore_modules(const char *filename, struct maps *kmaps)
1179 struct rb_root modules = RB_ROOT;
1182 err = read_proc_modules(filename, &modules);
1186 err = maps__for_each_map(kmaps, do_validate_kcore_modules_cb, &modules);
1188 delete_modules(&modules);
1193 * If kallsyms is referenced by name then we look for filename in the same
1196 static bool filename_from_kallsyms_filename(char *filename,
1197 const char *base_name,
1198 const char *kallsyms_filename)
1202 strcpy(filename, kallsyms_filename);
1203 name = strrchr(filename, '/');
1209 if (!strcmp(name, "kallsyms")) {
1210 strcpy(name, base_name);
1217 static int validate_kcore_modules(const char *kallsyms_filename,
1220 struct maps *kmaps = map__kmaps(map);
1221 char modules_filename[PATH_MAX];
1226 if (!filename_from_kallsyms_filename(modules_filename, "modules",
1230 if (do_validate_kcore_modules(modules_filename, kmaps))
1236 static int validate_kcore_addresses(const char *kallsyms_filename,
1239 struct kmap *kmap = map__kmap(map);
1244 if (kmap->ref_reloc_sym && kmap->ref_reloc_sym->name) {
1247 if (kallsyms__get_function_start(kallsyms_filename,
1248 kmap->ref_reloc_sym->name, &start))
1250 if (start != kmap->ref_reloc_sym->addr)
1254 return validate_kcore_modules(kallsyms_filename, map);
1257 struct kcore_mapfn_data {
1259 struct list_head maps;
1262 static int kcore_mapfn(u64 start, u64 len, u64 pgoff, void *data)
1264 struct kcore_mapfn_data *md = data;
1265 struct map_list_node *list_node = map_list_node__new();
1270 list_node->map = map__new2(start, md->dso);
1271 if (!list_node->map) {
1276 map__set_end(list_node->map, map__start(list_node->map) + len);
1277 map__set_pgoff(list_node->map, pgoff);
1279 list_add(&list_node->node, &md->maps);
1284 static bool remove_old_maps(struct map *map, void *data)
1286 const struct map *map_to_save = data;
1289 * We need to preserve eBPF maps even if they are covered by kcore,
1290 * because we need to access eBPF dso for source data.
1292 return !RC_CHK_EQUAL(map, map_to_save) && !__map__is_bpf_prog(map);
1295 static int dso__load_kcore(struct dso *dso, struct map *map,
1296 const char *kallsyms_filename)
1298 struct maps *kmaps = map__kmaps(map);
1299 struct kcore_mapfn_data md;
1300 struct map *map_ref, *replacement_map = NULL;
1301 struct machine *machine;
1304 char kcore_filename[PATH_MAX];
1310 machine = maps__machine(kmaps);
1312 /* This function requires that the map is the kernel map */
1313 if (!__map__is_kernel(map))
1316 if (!filename_from_kallsyms_filename(kcore_filename, "kcore",
1320 /* Modules and kernel must be present at their original addresses */
1321 if (validate_kcore_addresses(kallsyms_filename, map))
1325 INIT_LIST_HEAD(&md.maps);
1327 fd = open(kcore_filename, O_RDONLY);
1329 pr_debug("Failed to open %s. Note /proc/kcore requires CAP_SYS_RAWIO capability to access.\n",
1334 /* Read new maps into temporary lists */
1335 err = file__read_maps(fd, map__prot(map) & PROT_EXEC, kcore_mapfn, &md,
1339 dso__set_is_64_bit(dso, is_64_bit);
1341 if (list_empty(&md.maps)) {
1346 /* Remove old maps */
1347 maps__remove_maps(kmaps, remove_old_maps, map);
1348 machine->trampolines_mapped = false;
1350 /* Find the kernel map using the '_stext' symbol */
1351 if (!kallsyms__get_function_start(kallsyms_filename, "_stext", &stext)) {
1352 u64 replacement_size = 0;
1353 struct map_list_node *new_node;
1355 list_for_each_entry(new_node, &md.maps, node) {
1356 struct map *new_map = new_node->map;
1357 u64 new_size = map__size(new_map);
1359 if (!(stext >= map__start(new_map) && stext < map__end(new_map)))
1363 * On some architectures, ARM64 for example, the kernel
1364 * text can get allocated inside of the vmalloc segment.
1365 * Select the smallest matching segment, in case stext
1366 * falls within more than one in the list.
1368 if (!replacement_map || new_size < replacement_size) {
1369 replacement_map = new_map;
1370 replacement_size = new_size;
1375 if (!replacement_map)
1376 replacement_map = list_entry(md.maps.next, struct map_list_node, node)->map;
1379 * Update addresses of vmlinux map. Re-insert it to ensure maps are
1380 * correctly ordered. Do this before using maps__merge_in() for the
1381 * remaining maps so vmlinux gets split if necessary.
1383 map_ref = map__get(map);
1384 maps__remove(kmaps, map_ref);
1386 map__set_start(map_ref, map__start(replacement_map));
1387 map__set_end(map_ref, map__end(replacement_map));
1388 map__set_pgoff(map_ref, map__pgoff(replacement_map));
1389 map__set_mapping_type(map_ref, map__mapping_type(replacement_map));
1391 err = maps__insert(kmaps, map_ref);
1397 while (!list_empty(&md.maps)) {
1398 struct map_list_node *new_node = list_entry(md.maps.next, struct map_list_node, node);
1399 struct map *new_map = new_node->map;
1401 list_del_init(&new_node->node);
1403 /* skip if replacement_map, already inserted above */
1404 if (!RC_CHK_EQUAL(new_map, replacement_map)) {
1406 * Merge kcore map into existing maps,
1407 * and ensure that current maps (eBPF)
1410 if (maps__merge_in(kmaps, new_map)) {
1418 if (machine__is(machine, "x86_64")) {
1422 * If one of the corresponding symbols is there, assume the
1423 * entry trampoline maps are too.
1425 if (!kallsyms__get_function_start(kallsyms_filename,
1426 ENTRY_TRAMPOLINE_NAME,
1428 machine->trampolines_mapped = true;
1432 * Set the data type and long name so that kcore can be read via
1433 * dso__data_read_addr().
1435 if (dso__kernel(dso) == DSO_SPACE__KERNEL_GUEST)
1436 dso__set_binary_type(dso, DSO_BINARY_TYPE__GUEST_KCORE);
1438 dso__set_binary_type(dso, DSO_BINARY_TYPE__KCORE);
1439 dso__set_long_name(dso, strdup(kcore_filename), true);
1443 if (map__prot(map) & PROT_EXEC)
1444 pr_debug("Using %s for kernel object code\n", kcore_filename);
1446 pr_debug("Using %s for kernel data\n", kcore_filename);
1451 while (!list_empty(&md.maps)) {
1452 struct map_list_node *list_node;
1454 list_node = list_entry(md.maps.next, struct map_list_node, node);
1455 list_del_init(&list_node->node);
1456 map__zput(list_node->map);
1464 * If the kernel is relocated at boot time, kallsyms won't match. Compute the
1465 * delta based on the relocation reference symbol.
1467 static int kallsyms__delta(struct kmap *kmap, const char *filename, u64 *delta)
1471 if (!kmap->ref_reloc_sym || !kmap->ref_reloc_sym->name)
1474 if (kallsyms__get_function_start(filename, kmap->ref_reloc_sym->name, &addr))
1477 *delta = addr - kmap->ref_reloc_sym->addr;
1481 int __dso__load_kallsyms(struct dso *dso, const char *filename,
1482 struct map *map, bool no_kcore)
1484 struct kmap *kmap = map__kmap(map);
1487 if (symbol__restricted_filename(filename, "/proc/kallsyms"))
1490 if (!kmap || !kmap->kmaps)
1493 if (dso__load_all_kallsyms(dso, filename) < 0)
1496 if (kallsyms__delta(kmap, filename, &delta))
1499 symbols__fixup_end(dso__symbols(dso), true);
1500 symbols__fixup_duplicate(dso__symbols(dso));
1502 if (dso__kernel(dso) == DSO_SPACE__KERNEL_GUEST)
1503 dso__set_symtab_type(dso, DSO_BINARY_TYPE__GUEST_KALLSYMS);
1505 dso__set_symtab_type(dso, DSO_BINARY_TYPE__KALLSYMS);
1507 if (!no_kcore && !dso__load_kcore(dso, map, filename))
1508 return maps__split_kallsyms_for_kcore(kmap->kmaps, dso);
1510 return maps__split_kallsyms(kmap->kmaps, dso, delta, map);
1513 int dso__load_kallsyms(struct dso *dso, const char *filename,
1516 return __dso__load_kallsyms(dso, filename, map, false);
1519 static int dso__load_perf_map(const char *map_path, struct dso *dso)
1526 file = fopen(map_path, "r");
1530 while (!feof(file)) {
1535 line_len = getline(&line, &n, file);
1542 line[--line_len] = '\0'; /* \n */
1544 len = hex2u64(line, &start);
1547 if (len + 2 >= line_len)
1550 len += hex2u64(line + len, &size);
1553 if (len + 2 >= line_len)
1556 sym = symbol__new(start, size, STB_GLOBAL, STT_FUNC, line + len);
1559 goto out_delete_line;
1561 symbols__insert(dso__symbols(dso), sym);
1576 #ifdef HAVE_LIBBFD_SUPPORT
1577 #define PACKAGE 'perf'
1580 static int bfd_symbols__cmpvalue(const void *a, const void *b)
1582 const asymbol *as = *(const asymbol **)a, *bs = *(const asymbol **)b;
1584 if (bfd_asymbol_value(as) != bfd_asymbol_value(bs))
1585 return bfd_asymbol_value(as) - bfd_asymbol_value(bs);
1587 return bfd_asymbol_name(as)[0] - bfd_asymbol_name(bs)[0];
1590 static int bfd2elf_binding(asymbol *symbol)
1592 if (symbol->flags & BSF_WEAK)
1594 if (symbol->flags & BSF_GLOBAL)
1596 if (symbol->flags & BSF_LOCAL)
1601 int dso__load_bfd_symbols(struct dso *dso, const char *debugfile)
1604 long symbols_size, symbols_count, i;
1606 asymbol **symbols, *sym;
1607 struct symbol *symbol;
1611 abfd = bfd_openr(debugfile, NULL);
1615 if (!bfd_check_format(abfd, bfd_object)) {
1616 pr_debug2("%s: cannot read %s bfd file.\n", __func__,
1617 dso__long_name(dso));
1621 if (bfd_get_flavour(abfd) == bfd_target_elf_flavour)
1624 symbols_size = bfd_get_symtab_upper_bound(abfd);
1625 if (symbols_size == 0) {
1630 if (symbols_size < 0)
1633 symbols = malloc(symbols_size);
1637 symbols_count = bfd_canonicalize_symtab(abfd, symbols);
1638 if (symbols_count < 0)
1641 section = bfd_get_section_by_name(abfd, ".text");
1643 for (i = 0; i < symbols_count; ++i) {
1644 if (!strcmp(bfd_asymbol_name(symbols[i]), "__ImageBase") ||
1645 !strcmp(bfd_asymbol_name(symbols[i]), "__image_base__"))
1648 if (i < symbols_count) {
1649 /* PE symbols can only have 4 bytes, so use .text high bits */
1650 u64 text_offset = (section->vma - (u32)section->vma)
1651 + (u32)bfd_asymbol_value(symbols[i]);
1652 dso__set_text_offset(dso, text_offset);
1653 dso__set_text_end(dso, (section->vma - text_offset) + section->size);
1655 dso__set_text_offset(dso, section->vma - section->filepos);
1656 dso__set_text_end(dso, section->filepos + section->size);
1660 qsort(symbols, symbols_count, sizeof(asymbol *), bfd_symbols__cmpvalue);
1662 #ifdef bfd_get_section
1663 #define bfd_asymbol_section bfd_get_section
1665 for (i = 0; i < symbols_count; ++i) {
1667 section = bfd_asymbol_section(sym);
1668 if (bfd2elf_binding(sym) < 0)
1671 while (i + 1 < symbols_count &&
1672 bfd_asymbol_section(symbols[i + 1]) == section &&
1673 bfd2elf_binding(symbols[i + 1]) < 0)
1676 if (i + 1 < symbols_count &&
1677 bfd_asymbol_section(symbols[i + 1]) == section)
1678 len = symbols[i + 1]->value - sym->value;
1680 len = section->size - sym->value;
1682 start = bfd_asymbol_value(sym) - dso__text_offset(dso);
1683 symbol = symbol__new(start, len, bfd2elf_binding(sym), STT_FUNC,
1684 bfd_asymbol_name(sym));
1688 symbols__insert(dso__symbols(dso), symbol);
1690 #ifdef bfd_get_section
1691 #undef bfd_asymbol_section
1694 symbols__fixup_end(dso__symbols(dso), false);
1695 symbols__fixup_duplicate(dso__symbols(dso));
1696 dso__set_adjust_symbols(dso, true);
1707 static bool dso__is_compatible_symtab_type(struct dso *dso, bool kmod,
1708 enum dso_binary_type type)
1711 case DSO_BINARY_TYPE__JAVA_JIT:
1712 case DSO_BINARY_TYPE__DEBUGLINK:
1713 case DSO_BINARY_TYPE__SYSTEM_PATH_DSO:
1714 case DSO_BINARY_TYPE__FEDORA_DEBUGINFO:
1715 case DSO_BINARY_TYPE__UBUNTU_DEBUGINFO:
1716 case DSO_BINARY_TYPE__MIXEDUP_UBUNTU_DEBUGINFO:
1717 case DSO_BINARY_TYPE__BUILDID_DEBUGINFO:
1718 case DSO_BINARY_TYPE__OPENEMBEDDED_DEBUGINFO:
1719 return !kmod && dso__kernel(dso) == DSO_SPACE__USER;
1721 case DSO_BINARY_TYPE__KALLSYMS:
1722 case DSO_BINARY_TYPE__VMLINUX:
1723 case DSO_BINARY_TYPE__KCORE:
1724 return dso__kernel(dso) == DSO_SPACE__KERNEL;
1726 case DSO_BINARY_TYPE__GUEST_KALLSYMS:
1727 case DSO_BINARY_TYPE__GUEST_VMLINUX:
1728 case DSO_BINARY_TYPE__GUEST_KCORE:
1729 return dso__kernel(dso) == DSO_SPACE__KERNEL_GUEST;
1731 case DSO_BINARY_TYPE__GUEST_KMODULE:
1732 case DSO_BINARY_TYPE__GUEST_KMODULE_COMP:
1733 case DSO_BINARY_TYPE__SYSTEM_PATH_KMODULE:
1734 case DSO_BINARY_TYPE__SYSTEM_PATH_KMODULE_COMP:
1736 * kernel modules know their symtab type - it's set when
1737 * creating a module dso in machine__addnew_module_map().
1739 return kmod && dso__symtab_type(dso) == type;
1741 case DSO_BINARY_TYPE__BUILD_ID_CACHE:
1742 case DSO_BINARY_TYPE__BUILD_ID_CACHE_DEBUGINFO:
1745 case DSO_BINARY_TYPE__BPF_PROG_INFO:
1746 case DSO_BINARY_TYPE__BPF_IMAGE:
1747 case DSO_BINARY_TYPE__OOL:
1748 case DSO_BINARY_TYPE__NOT_FOUND:
1754 /* Checks for the existence of the perf-<pid>.map file in two different
1755 * locations. First, if the process is a separate mount namespace, check in
1756 * that namespace using the pid of the innermost pid namespace. If's not in a
1757 * namespace, or the file can't be found there, try in the mount namespace of
1758 * the tracing process using our view of its pid.
1760 static int dso__find_perf_map(char *filebuf, size_t bufsz,
1761 struct nsinfo **nsip)
1763 struct nscookie nsc;
1765 struct nsinfo *nnsi;
1770 if (nsinfo__need_setns(nsi)) {
1771 snprintf(filebuf, bufsz, "/tmp/perf-%d.map", nsinfo__nstgid(nsi));
1772 nsinfo__mountns_enter(nsi, &nsc);
1773 rc = access(filebuf, R_OK);
1774 nsinfo__mountns_exit(&nsc);
1779 nnsi = nsinfo__copy(nsi);
1783 nsinfo__clear_need_setns(nnsi);
1784 snprintf(filebuf, bufsz, "/tmp/perf-%d.map", nsinfo__tgid(nnsi));
1792 int dso__load(struct dso *dso, struct map *map)
1797 struct machine *machine = NULL;
1798 char *root_dir = (char *) "";
1800 struct symsrc ss_[2];
1801 struct symsrc *syms_ss = NULL, *runtime_ss = NULL;
1804 struct build_id bid;
1805 struct nscookie nsc;
1806 char newmapname[PATH_MAX];
1807 const char *map_path = dso__long_name(dso);
1809 mutex_lock(dso__lock(dso));
1810 perfmap = is_perf_pid_map_name(map_path);
1813 if (dso__nsinfo(dso) &&
1814 (dso__find_perf_map(newmapname, sizeof(newmapname),
1815 dso__nsinfo_ptr(dso)) == 0)) {
1816 map_path = newmapname;
1820 nsinfo__mountns_enter(dso__nsinfo(dso), &nsc);
1822 /* check again under the dso->lock */
1823 if (dso__loaded(dso)) {
1828 kmod = dso__is_kmod(dso);
1830 if (dso__kernel(dso) && !kmod) {
1831 if (dso__kernel(dso) == DSO_SPACE__KERNEL)
1832 ret = dso__load_kernel_sym(dso, map);
1833 else if (dso__kernel(dso) == DSO_SPACE__KERNEL_GUEST)
1834 ret = dso__load_guest_kernel_sym(dso, map);
1836 machine = maps__machine(map__kmaps(map));
1837 if (machine__is(machine, "x86_64"))
1838 machine__map_x86_64_entry_trampolines(machine, dso);
1842 dso__set_adjust_symbols(dso, false);
1845 ret = dso__load_perf_map(map_path, dso);
1846 dso__set_symtab_type(dso, ret > 0
1847 ? DSO_BINARY_TYPE__JAVA_JIT
1848 : DSO_BINARY_TYPE__NOT_FOUND);
1853 root_dir = machine->root_dir;
1855 name = malloc(PATH_MAX);
1860 * Read the build id if possible. This is required for
1861 * DSO_BINARY_TYPE__BUILDID_DEBUGINFO to work
1863 if (!dso__has_build_id(dso) &&
1864 is_regular_file(dso__long_name(dso))) {
1865 __symbol__join_symfs(name, PATH_MAX, dso__long_name(dso));
1866 if (filename__read_build_id(name, &bid) > 0)
1867 dso__set_build_id(dso, &bid);
1871 * Iterate over candidate debug images.
1872 * Keep track of "interesting" ones (those which have a symtab, dynsym,
1873 * and/or opd section) for processing.
1875 for (i = 0; i < DSO_BINARY_TYPE__SYMTAB_CNT; i++) {
1876 struct symsrc *ss = &ss_[ss_pos];
1877 bool next_slot = false;
1883 enum dso_binary_type symtab_type = binary_type_symtab[i];
1885 nsexit = (symtab_type == DSO_BINARY_TYPE__BUILD_ID_CACHE ||
1886 symtab_type == DSO_BINARY_TYPE__BUILD_ID_CACHE_DEBUGINFO);
1888 if (!dso__is_compatible_symtab_type(dso, kmod, symtab_type))
1891 if (dso__read_binary_type_filename(dso, symtab_type,
1892 root_dir, name, PATH_MAX))
1896 nsinfo__mountns_exit(&nsc);
1898 is_reg = is_regular_file(name);
1899 if (!is_reg && errno == ENOENT && dso__nsinfo(dso)) {
1900 char *new_name = dso__filename_with_chroot(dso, name);
1902 is_reg = is_regular_file(new_name);
1903 strlcpy(name, new_name, PATH_MAX);
1908 #ifdef HAVE_LIBBFD_SUPPORT
1910 bfdrc = dso__load_bfd_symbols(dso, name);
1912 if (is_reg && bfdrc < 0)
1913 sirc = symsrc__init(ss, dso, name, symtab_type);
1916 nsinfo__mountns_enter(dso__nsinfo(dso), &nsc);
1923 if (!is_reg || sirc < 0)
1926 if (!syms_ss && symsrc__has_symtab(ss)) {
1929 if (!dso__symsrc_filename(dso))
1930 dso__set_symsrc_filename(dso, strdup(name));
1933 if (!runtime_ss && symsrc__possibly_runtime(ss)) {
1941 if (dso__binary_type(dso) == DSO_BINARY_TYPE__NOT_FOUND)
1942 dso__set_binary_type(dso, symtab_type);
1944 if (syms_ss && runtime_ss)
1947 symsrc__destroy(ss);
1952 if (!runtime_ss && !syms_ss)
1955 if (runtime_ss && !syms_ss) {
1956 syms_ss = runtime_ss;
1959 /* We'll have to hope for the best */
1960 if (!runtime_ss && syms_ss)
1961 runtime_ss = syms_ss;
1964 ret = dso__load_sym(dso, map, syms_ss, runtime_ss, kmod);
1971 nr_plt = dso__synthesize_plt_symbols(dso, runtime_ss);
1976 for (; ss_pos > 0; ss_pos--)
1977 symsrc__destroy(&ss_[ss_pos - 1]);
1980 if (ret < 0 && strstr(dso__name(dso), " (deleted)") != NULL)
1983 dso__set_loaded(dso);
1984 mutex_unlock(dso__lock(dso));
1985 nsinfo__mountns_exit(&nsc);
1991 * Always takes ownership of vmlinux when vmlinux_allocated == true, even if
1992 * it returns an error.
1994 int dso__load_vmlinux(struct dso *dso, struct map *map,
1995 const char *vmlinux, bool vmlinux_allocated)
1999 char symfs_vmlinux[PATH_MAX];
2000 enum dso_binary_type symtab_type;
2002 if (vmlinux[0] == '/')
2003 snprintf(symfs_vmlinux, sizeof(symfs_vmlinux), "%s", vmlinux);
2005 symbol__join_symfs(symfs_vmlinux, vmlinux);
2007 if (dso__kernel(dso) == DSO_SPACE__KERNEL_GUEST)
2008 symtab_type = DSO_BINARY_TYPE__GUEST_VMLINUX;
2010 symtab_type = DSO_BINARY_TYPE__VMLINUX;
2012 if (symsrc__init(&ss, dso, symfs_vmlinux, symtab_type)) {
2013 if (vmlinux_allocated)
2014 free((char *) vmlinux);
2019 * dso__load_sym() may copy 'dso' which will result in the copies having
2020 * an incorrect long name unless we set it here first.
2022 dso__set_long_name(dso, vmlinux, vmlinux_allocated);
2023 if (dso__kernel(dso) == DSO_SPACE__KERNEL_GUEST)
2024 dso__set_binary_type(dso, DSO_BINARY_TYPE__GUEST_VMLINUX);
2026 dso__set_binary_type(dso, DSO_BINARY_TYPE__VMLINUX);
2028 err = dso__load_sym(dso, map, &ss, &ss, 0);
2029 symsrc__destroy(&ss);
2032 dso__set_loaded(dso);
2033 pr_debug("Using %s for symbols\n", symfs_vmlinux);
2039 int dso__load_vmlinux_path(struct dso *dso, struct map *map)
2042 char *filename = NULL;
2044 pr_debug("Looking at the vmlinux_path (%d entries long)\n",
2045 vmlinux_path__nr_entries + 1);
2047 for (i = 0; i < vmlinux_path__nr_entries; ++i) {
2048 err = dso__load_vmlinux(dso, map, vmlinux_path[i], false);
2053 if (!symbol_conf.ignore_vmlinux_buildid)
2054 filename = dso__build_id_filename(dso, NULL, 0, false);
2055 if (filename != NULL) {
2056 err = dso__load_vmlinux(dso, map, filename, true);
2064 static bool visible_dir_filter(const char *name, struct dirent *d)
2066 if (d->d_type != DT_DIR)
2068 return lsdir_no_dot_filter(name, d);
2071 static int find_matching_kcore(struct map *map, char *dir, size_t dir_sz)
2073 char kallsyms_filename[PATH_MAX];
2075 struct strlist *dirs;
2076 struct str_node *nd;
2078 dirs = lsdir(dir, visible_dir_filter);
2082 strlist__for_each_entry(nd, dirs) {
2083 scnprintf(kallsyms_filename, sizeof(kallsyms_filename),
2084 "%s/%s/kallsyms", dir, nd->s);
2085 if (!validate_kcore_addresses(kallsyms_filename, map)) {
2086 strlcpy(dir, kallsyms_filename, dir_sz);
2092 strlist__delete(dirs);
2098 * Use open(O_RDONLY) to check readability directly instead of access(R_OK)
2099 * since access(R_OK) only checks with real UID/GID but open() use effective
2100 * UID/GID and actual capabilities (e.g. /proc/kcore requires CAP_SYS_RAWIO).
2102 static bool filename__readable(const char *file)
2104 int fd = open(file, O_RDONLY);
2111 static char *dso__find_kallsyms(struct dso *dso, struct map *map)
2113 struct build_id bid;
2114 char sbuild_id[SBUILD_ID_SIZE];
2115 bool is_host = false;
2116 char path[PATH_MAX];
2118 if (!dso__has_build_id(dso)) {
2120 * Last resort, if we don't have a build-id and couldn't find
2121 * any vmlinux file, try the running kernel kallsyms table.
2126 if (sysfs__read_build_id("/sys/kernel/notes", &bid) == 0)
2127 is_host = dso__build_id_equal(dso, &bid);
2129 /* Try a fast path for /proc/kallsyms if possible */
2132 * Do not check the build-id cache, unless we know we cannot use
2133 * /proc/kcore or module maps don't match to /proc/kallsyms.
2134 * To check readability of /proc/kcore, do not use access(R_OK)
2135 * since /proc/kcore requires CAP_SYS_RAWIO to read and access
2138 if (filename__readable("/proc/kcore") &&
2139 !validate_kcore_addresses("/proc/kallsyms", map))
2143 build_id__sprintf(dso__bid(dso), sbuild_id);
2145 /* Find kallsyms in build-id cache with kcore */
2146 scnprintf(path, sizeof(path), "%s/%s/%s",
2147 buildid_dir, DSO__NAME_KCORE, sbuild_id);
2149 if (!find_matching_kcore(map, path, sizeof(path)))
2150 return strdup(path);
2152 /* Use current /proc/kallsyms if possible */
2155 return strdup("/proc/kallsyms");
2158 /* Finally, find a cache of kallsyms */
2159 if (!build_id_cache__kallsyms_path(sbuild_id, path, sizeof(path))) {
2160 pr_err("No kallsyms or vmlinux with build-id %s was found\n",
2165 return strdup(path);
2168 static int dso__load_kernel_sym(struct dso *dso, struct map *map)
2171 const char *kallsyms_filename = NULL;
2172 char *kallsyms_allocated_filename = NULL;
2173 char *filename = NULL;
2176 * Step 1: if the user specified a kallsyms or vmlinux filename, use
2177 * it and only it, reporting errors to the user if it cannot be used.
2179 * For instance, try to analyse an ARM perf.data file _without_ a
2180 * build-id, or if the user specifies the wrong path to the right
2181 * vmlinux file, obviously we can't fallback to another vmlinux (a
2182 * x86_86 one, on the machine where analysis is being performed, say),
2183 * or worse, /proc/kallsyms.
2185 * If the specified file _has_ a build-id and there is a build-id
2186 * section in the perf.data file, we will still do the expected
2187 * validation in dso__load_vmlinux and will bail out if they don't
2190 if (symbol_conf.kallsyms_name != NULL) {
2191 kallsyms_filename = symbol_conf.kallsyms_name;
2195 if (!symbol_conf.ignore_vmlinux && symbol_conf.vmlinux_name != NULL) {
2196 return dso__load_vmlinux(dso, map, symbol_conf.vmlinux_name, false);
2200 * Before checking on common vmlinux locations, check if it's
2201 * stored as standard build id binary (not kallsyms) under
2204 if (!symbol_conf.ignore_vmlinux_buildid)
2205 filename = __dso__build_id_filename(dso, NULL, 0, false, false);
2206 if (filename != NULL) {
2207 err = dso__load_vmlinux(dso, map, filename, true);
2212 if (!symbol_conf.ignore_vmlinux && vmlinux_path != NULL) {
2213 err = dso__load_vmlinux_path(dso, map);
2218 /* do not try local files if a symfs was given */
2219 if (symbol_conf.symfs[0] != 0)
2222 kallsyms_allocated_filename = dso__find_kallsyms(dso, map);
2223 if (!kallsyms_allocated_filename)
2226 kallsyms_filename = kallsyms_allocated_filename;
2229 err = dso__load_kallsyms(dso, kallsyms_filename, map);
2231 pr_debug("Using %s for symbols\n", kallsyms_filename);
2232 free(kallsyms_allocated_filename);
2234 if (err > 0 && !dso__is_kcore(dso)) {
2235 dso__set_binary_type(dso, DSO_BINARY_TYPE__KALLSYMS);
2236 dso__set_long_name(dso, DSO__NAME_KALLSYMS, false);
2237 map__fixup_start(map);
2238 map__fixup_end(map);
2244 static int dso__load_guest_kernel_sym(struct dso *dso, struct map *map)
2247 const char *kallsyms_filename;
2248 struct machine *machine = maps__machine(map__kmaps(map));
2249 char path[PATH_MAX];
2251 if (machine->kallsyms_filename) {
2252 kallsyms_filename = machine->kallsyms_filename;
2253 } else if (machine__is_default_guest(machine)) {
2255 * if the user specified a vmlinux filename, use it and only
2256 * it, reporting errors to the user if it cannot be used.
2257 * Or use file guest_kallsyms inputted by user on commandline
2259 if (symbol_conf.default_guest_vmlinux_name != NULL) {
2260 err = dso__load_vmlinux(dso, map,
2261 symbol_conf.default_guest_vmlinux_name,
2266 kallsyms_filename = symbol_conf.default_guest_kallsyms;
2267 if (!kallsyms_filename)
2270 sprintf(path, "%s/proc/kallsyms", machine->root_dir);
2271 kallsyms_filename = path;
2274 err = dso__load_kallsyms(dso, kallsyms_filename, map);
2276 pr_debug("Using %s for symbols\n", kallsyms_filename);
2277 if (err > 0 && !dso__is_kcore(dso)) {
2278 dso__set_binary_type(dso, DSO_BINARY_TYPE__GUEST_KALLSYMS);
2279 dso__set_long_name(dso, machine->mmap_name, false);
2280 map__fixup_start(map);
2281 map__fixup_end(map);
2287 static void vmlinux_path__exit(void)
2289 while (--vmlinux_path__nr_entries >= 0)
2290 zfree(&vmlinux_path[vmlinux_path__nr_entries]);
2291 vmlinux_path__nr_entries = 0;
2293 zfree(&vmlinux_path);
2296 static const char * const vmlinux_paths[] = {
2301 static const char * const vmlinux_paths_upd[] = {
2303 "/usr/lib/debug/boot/vmlinux-%s",
2304 "/lib/modules/%s/build/vmlinux",
2305 "/usr/lib/debug/lib/modules/%s/vmlinux",
2306 "/usr/lib/debug/boot/vmlinux-%s.debug"
2309 static int vmlinux_path__add(const char *new_entry)
2311 vmlinux_path[vmlinux_path__nr_entries] = strdup(new_entry);
2312 if (vmlinux_path[vmlinux_path__nr_entries] == NULL)
2314 ++vmlinux_path__nr_entries;
2319 static int vmlinux_path__init(struct perf_env *env)
2323 char *kernel_version;
2326 vmlinux_path = malloc(sizeof(char *) * (ARRAY_SIZE(vmlinux_paths) +
2327 ARRAY_SIZE(vmlinux_paths_upd)));
2328 if (vmlinux_path == NULL)
2331 for (i = 0; i < ARRAY_SIZE(vmlinux_paths); i++)
2332 if (vmlinux_path__add(vmlinux_paths[i]) < 0)
2335 /* only try kernel version if no symfs was given */
2336 if (symbol_conf.symfs[0] != 0)
2340 kernel_version = env->os_release;
2342 if (uname(&uts) < 0)
2345 kernel_version = uts.release;
2348 for (i = 0; i < ARRAY_SIZE(vmlinux_paths_upd); i++) {
2349 snprintf(bf, sizeof(bf), vmlinux_paths_upd[i], kernel_version);
2350 if (vmlinux_path__add(bf) < 0)
2357 vmlinux_path__exit();
2361 int setup_list(struct strlist **list, const char *list_str,
2362 const char *list_name)
2364 if (list_str == NULL)
2367 *list = strlist__new(list_str, NULL);
2369 pr_err("problems parsing %s list\n", list_name);
2373 symbol_conf.has_filter = true;
2377 int setup_intlist(struct intlist **list, const char *list_str,
2378 const char *list_name)
2380 if (list_str == NULL)
2383 *list = intlist__new(list_str);
2385 pr_err("problems parsing %s list\n", list_name);
2391 static int setup_addrlist(struct intlist **addr_list, struct strlist *sym_list)
2393 struct str_node *pos, *tmp;
2399 *addr_list = intlist__new(NULL);
2403 strlist__for_each_entry_safe(pos, tmp, sym_list) {
2405 val = strtoul(pos->s, &sep, 16);
2406 if (errno || (sep == pos->s))
2410 end = pos->s + strlen(pos->s) - 1;
2411 while (end >= sep && isspace(*end))
2418 err = intlist__add(*addr_list, val);
2422 strlist__remove(sym_list, pos);
2427 intlist__delete(*addr_list);
2434 static bool symbol__read_kptr_restrict(void)
2437 FILE *fp = fopen("/proc/sys/kernel/kptr_restrict", "r");
2439 bool cap_syslog = perf_cap__capable(CAP_SYSLOG, &used_root);
2444 if (fgets(line, sizeof(line), fp) != NULL)
2445 value = cap_syslog ? (atoi(line) >= 2) : (atoi(line) != 0);
2450 /* Per kernel/kallsyms.c:
2451 * we also restrict when perf_event_paranoid > 1 w/o CAP_SYSLOG
2453 if (perf_event_paranoid() > 1 && !cap_syslog)
2459 int symbol__annotation_init(void)
2461 if (symbol_conf.init_annotation)
2464 if (symbol_conf.initialized) {
2465 pr_err("Annotation needs to be init before symbol__init()\n");
2469 symbol_conf.priv_size += sizeof(struct annotation);
2470 symbol_conf.init_annotation = true;
2474 int symbol__init(struct perf_env *env)
2478 if (symbol_conf.initialized)
2481 symbol_conf.priv_size = PERF_ALIGN(symbol_conf.priv_size, sizeof(u64));
2485 if (symbol_conf.try_vmlinux_path && vmlinux_path__init(env) < 0)
2488 if (symbol_conf.field_sep && *symbol_conf.field_sep == '.') {
2489 pr_err("'.' is the only non valid --field-separator argument\n");
2493 if (setup_list(&symbol_conf.dso_list,
2494 symbol_conf.dso_list_str, "dso") < 0)
2497 if (setup_list(&symbol_conf.comm_list,
2498 symbol_conf.comm_list_str, "comm") < 0)
2499 goto out_free_dso_list;
2501 if (setup_intlist(&symbol_conf.pid_list,
2502 symbol_conf.pid_list_str, "pid") < 0)
2503 goto out_free_comm_list;
2505 if (setup_intlist(&symbol_conf.tid_list,
2506 symbol_conf.tid_list_str, "tid") < 0)
2507 goto out_free_pid_list;
2509 if (setup_list(&symbol_conf.sym_list,
2510 symbol_conf.sym_list_str, "symbol") < 0)
2511 goto out_free_tid_list;
2513 if (symbol_conf.sym_list &&
2514 setup_addrlist(&symbol_conf.addr_list, symbol_conf.sym_list) < 0)
2515 goto out_free_sym_list;
2517 if (setup_list(&symbol_conf.bt_stop_list,
2518 symbol_conf.bt_stop_list_str, "symbol") < 0)
2519 goto out_free_sym_list;
2522 * A path to symbols of "/" is identical to ""
2523 * reset here for simplicity.
2525 symfs = realpath(symbol_conf.symfs, NULL);
2527 symfs = symbol_conf.symfs;
2528 if (strcmp(symfs, "/") == 0)
2529 symbol_conf.symfs = "";
2530 if (symfs != symbol_conf.symfs)
2531 free((void *)symfs);
2533 symbol_conf.kptr_restrict = symbol__read_kptr_restrict();
2535 symbol_conf.initialized = true;
2539 strlist__delete(symbol_conf.sym_list);
2540 intlist__delete(symbol_conf.addr_list);
2542 intlist__delete(symbol_conf.tid_list);
2544 intlist__delete(symbol_conf.pid_list);
2546 strlist__delete(symbol_conf.comm_list);
2548 strlist__delete(symbol_conf.dso_list);
2552 void symbol__exit(void)
2554 if (!symbol_conf.initialized)
2556 strlist__delete(symbol_conf.bt_stop_list);
2557 strlist__delete(symbol_conf.sym_list);
2558 strlist__delete(symbol_conf.dso_list);
2559 strlist__delete(symbol_conf.comm_list);
2560 intlist__delete(symbol_conf.tid_list);
2561 intlist__delete(symbol_conf.pid_list);
2562 intlist__delete(symbol_conf.addr_list);
2563 vmlinux_path__exit();
2564 symbol_conf.sym_list = symbol_conf.dso_list = symbol_conf.comm_list = NULL;
2565 symbol_conf.bt_stop_list = NULL;
2566 symbol_conf.initialized = false;
2569 int symbol__config_symfs(const struct option *opt __maybe_unused,
2570 const char *dir, int unset __maybe_unused)
2575 symbol_conf.symfs = strdup(dir);
2576 if (symbol_conf.symfs == NULL)
2579 /* skip the locally configured cache if a symfs is given, and
2580 * config buildid dir to symfs/.debug
2582 ret = asprintf(&bf, "%s/%s", dir, ".debug");
2586 set_buildid_dir(bf);
2593 * Checks that user supplied symbol kernel files are accessible because
2594 * the default mechanism for accessing elf files fails silently. i.e. if
2595 * debug syms for a build ID aren't found perf carries on normally. When
2596 * they are user supplied we should assume that the user doesn't want to
2599 int symbol__validate_sym_arguments(void)
2601 if (symbol_conf.vmlinux_name &&
2602 access(symbol_conf.vmlinux_name, R_OK)) {
2603 pr_err("Invalid file: %s\n", symbol_conf.vmlinux_name);
2606 if (symbol_conf.kallsyms_name &&
2607 access(symbol_conf.kallsyms_name, R_OK)) {
2608 pr_err("Invalid file: %s\n", symbol_conf.kallsyms_name);