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"
33 #include "namespaces.h"
36 #include <linux/ctype.h>
37 #include <linux/zalloc.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;
51 struct symbol_conf symbol_conf = {
54 .try_vmlinux_path = true,
56 .demangle_kernel = false,
57 .cumulate_callchain = true,
58 .time_quantum = 100 * NSEC_PER_MSEC, /* 100ms */
59 .show_hist_headers = true,
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__MIXEDUP_UBUNTU_DEBUGINFO,
83 DSO_BINARY_TYPE__NOT_FOUND,
86 #define DSO_BINARY_TYPE__SYMTAB_CNT ARRAY_SIZE(binary_type_symtab)
88 static bool symbol_type__filter(char symbol_type)
90 symbol_type = toupper(symbol_type);
91 return symbol_type == 'T' || symbol_type == 'W' || symbol_type == 'D' || symbol_type == 'B';
94 static int prefix_underscores_count(const char *str)
96 const char *tail = str;
104 void __weak arch__symbols__fixup_end(struct symbol *p, struct symbol *c)
109 const char * __weak arch__normalize_symbol_name(const char *name)
114 int __weak arch__compare_symbol_names(const char *namea, const char *nameb)
116 return strcmp(namea, nameb);
119 int __weak arch__compare_symbol_names_n(const char *namea, const char *nameb,
122 return strncmp(namea, nameb, n);
125 int __weak arch__choose_best_symbol(struct symbol *syma,
126 struct symbol *symb __maybe_unused)
128 /* Avoid "SyS" kernel syscall aliases */
129 if (strlen(syma->name) >= 3 && !strncmp(syma->name, "SyS", 3))
131 if (strlen(syma->name) >= 10 && !strncmp(syma->name, "compat_SyS", 10))
137 static int choose_best_symbol(struct symbol *syma, struct symbol *symb)
143 /* Prefer a symbol with non zero length */
144 a = syma->end - syma->start;
145 b = symb->end - symb->start;
146 if ((b == 0) && (a > 0))
148 else if ((a == 0) && (b > 0))
151 /* Prefer a non weak symbol over a weak one */
152 a = syma->binding == STB_WEAK;
153 b = symb->binding == STB_WEAK;
159 /* Prefer a global symbol over a non global one */
160 a = syma->binding == STB_GLOBAL;
161 b = symb->binding == STB_GLOBAL;
167 /* Prefer a symbol with less underscores */
168 a = prefix_underscores_count(syma->name);
169 b = prefix_underscores_count(symb->name);
175 /* Choose the symbol with the longest name */
176 na = strlen(syma->name);
177 nb = strlen(symb->name);
183 return arch__choose_best_symbol(syma, symb);
186 void symbols__fixup_duplicate(struct rb_root_cached *symbols)
189 struct symbol *curr, *next;
191 if (symbol_conf.allow_aliases)
194 nd = rb_first_cached(symbols);
197 curr = rb_entry(nd, struct symbol, rb_node);
199 nd = rb_next(&curr->rb_node);
200 next = rb_entry(nd, struct symbol, rb_node);
205 if (curr->start != next->start)
208 if (choose_best_symbol(curr, next) == SYMBOL_A) {
209 rb_erase_cached(&next->rb_node, symbols);
210 symbol__delete(next);
213 nd = rb_next(&curr->rb_node);
214 rb_erase_cached(&curr->rb_node, symbols);
215 symbol__delete(curr);
220 void symbols__fixup_end(struct rb_root_cached *symbols)
222 struct rb_node *nd, *prevnd = rb_first_cached(symbols);
223 struct symbol *curr, *prev;
228 curr = rb_entry(prevnd, struct symbol, rb_node);
230 for (nd = rb_next(prevnd); nd; nd = rb_next(nd)) {
232 curr = rb_entry(nd, struct symbol, rb_node);
234 if (prev->end == prev->start || prev->end != curr->start)
235 arch__symbols__fixup_end(prev, curr);
239 if (curr->end == curr->start)
240 curr->end = roundup(curr->start, 4096) + 4096;
243 void maps__fixup_end(struct maps *maps)
245 struct map *prev = NULL, *curr;
247 down_write(&maps->lock);
249 maps__for_each_entry(maps, curr) {
250 if (prev != NULL && !prev->end)
251 prev->end = curr->start;
257 * We still haven't the actual symbols, so guess the
258 * last map final address.
260 if (curr && !curr->end)
263 up_write(&maps->lock);
266 struct symbol *symbol__new(u64 start, u64 len, u8 binding, u8 type, const char *name)
268 size_t namelen = strlen(name) + 1;
269 struct symbol *sym = calloc(1, (symbol_conf.priv_size +
270 sizeof(*sym) + namelen));
274 if (symbol_conf.priv_size) {
275 if (symbol_conf.init_annotation) {
276 struct annotation *notes = (void *)sym;
277 annotation__init(notes);
279 sym = ((void *)sym) + symbol_conf.priv_size;
283 sym->end = len ? start + len : start;
285 sym->binding = binding;
286 sym->namelen = namelen - 1;
288 pr_debug4("%s: %s %#" PRIx64 "-%#" PRIx64 "\n",
289 __func__, name, start, sym->end);
290 memcpy(sym->name, name, namelen);
295 void symbol__delete(struct symbol *sym)
297 if (symbol_conf.priv_size) {
298 if (symbol_conf.init_annotation) {
299 struct annotation *notes = symbol__annotation(sym);
301 annotation__exit(notes);
304 free(((void *)sym) - symbol_conf.priv_size);
307 void symbols__delete(struct rb_root_cached *symbols)
310 struct rb_node *next = rb_first_cached(symbols);
313 pos = rb_entry(next, struct symbol, rb_node);
314 next = rb_next(&pos->rb_node);
315 rb_erase_cached(&pos->rb_node, symbols);
320 void __symbols__insert(struct rb_root_cached *symbols,
321 struct symbol *sym, bool kernel)
323 struct rb_node **p = &symbols->rb_root.rb_node;
324 struct rb_node *parent = NULL;
325 const u64 ip = sym->start;
327 bool leftmost = true;
330 const char *name = sym->name;
332 * ppc64 uses function descriptors and appends a '.' to the
333 * start of every instruction address. Remove it.
337 sym->idle = symbol__is_idle(name);
342 s = rb_entry(parent, struct symbol, rb_node);
350 rb_link_node(&sym->rb_node, parent, p);
351 rb_insert_color_cached(&sym->rb_node, symbols, leftmost);
354 void symbols__insert(struct rb_root_cached *symbols, struct symbol *sym)
356 __symbols__insert(symbols, sym, false);
359 static struct symbol *symbols__find(struct rb_root_cached *symbols, u64 ip)
366 n = symbols->rb_root.rb_node;
369 struct symbol *s = rb_entry(n, struct symbol, rb_node);
373 else if (ip > s->end || (ip == s->end && ip != s->start))
382 static struct symbol *symbols__first(struct rb_root_cached *symbols)
384 struct rb_node *n = rb_first_cached(symbols);
387 return rb_entry(n, struct symbol, rb_node);
392 static struct symbol *symbols__last(struct rb_root_cached *symbols)
394 struct rb_node *n = rb_last(&symbols->rb_root);
397 return rb_entry(n, struct symbol, rb_node);
402 static struct symbol *symbols__next(struct symbol *sym)
404 struct rb_node *n = rb_next(&sym->rb_node);
407 return rb_entry(n, struct symbol, rb_node);
412 static void symbols__insert_by_name(struct rb_root_cached *symbols, struct symbol *sym)
414 struct rb_node **p = &symbols->rb_root.rb_node;
415 struct rb_node *parent = NULL;
416 struct symbol_name_rb_node *symn, *s;
417 bool leftmost = true;
419 symn = container_of(sym, struct symbol_name_rb_node, sym);
423 s = rb_entry(parent, struct symbol_name_rb_node, rb_node);
424 if (strcmp(sym->name, s->sym.name) < 0)
431 rb_link_node(&symn->rb_node, parent, p);
432 rb_insert_color_cached(&symn->rb_node, symbols, leftmost);
435 static void symbols__sort_by_name(struct rb_root_cached *symbols,
436 struct rb_root_cached *source)
440 for (nd = rb_first_cached(source); nd; nd = rb_next(nd)) {
441 struct symbol *pos = rb_entry(nd, struct symbol, rb_node);
442 symbols__insert_by_name(symbols, pos);
446 int symbol__match_symbol_name(const char *name, const char *str,
447 enum symbol_tag_include includes)
449 const char *versioning;
451 if (includes == SYMBOL_TAG_INCLUDE__DEFAULT_ONLY &&
452 (versioning = strstr(name, "@@"))) {
453 int len = strlen(str);
455 if (len < versioning - name)
456 len = versioning - name;
458 return arch__compare_symbol_names_n(name, str, len);
460 return arch__compare_symbol_names(name, str);
463 static struct symbol *symbols__find_by_name(struct rb_root_cached *symbols,
465 enum symbol_tag_include includes)
468 struct symbol_name_rb_node *s = NULL;
473 n = symbols->rb_root.rb_node;
478 s = rb_entry(n, struct symbol_name_rb_node, rb_node);
479 cmp = symbol__match_symbol_name(s->sym.name, name, includes);
492 if (includes != SYMBOL_TAG_INCLUDE__DEFAULT_ONLY)
493 /* return first symbol that has same name (if any) */
494 for (n = rb_prev(n); n; n = rb_prev(n)) {
495 struct symbol_name_rb_node *tmp;
497 tmp = rb_entry(n, struct symbol_name_rb_node, rb_node);
498 if (arch__compare_symbol_names(tmp->sym.name, s->sym.name))
507 void dso__reset_find_symbol_cache(struct dso *dso)
509 dso->last_find_result.addr = 0;
510 dso->last_find_result.symbol = NULL;
513 void dso__insert_symbol(struct dso *dso, struct symbol *sym)
515 __symbols__insert(&dso->symbols, sym, dso->kernel);
517 /* update the symbol cache if necessary */
518 if (dso->last_find_result.addr >= sym->start &&
519 (dso->last_find_result.addr < sym->end ||
520 sym->start == sym->end)) {
521 dso->last_find_result.symbol = sym;
525 void dso__delete_symbol(struct dso *dso, struct symbol *sym)
527 rb_erase_cached(&sym->rb_node, &dso->symbols);
529 dso__reset_find_symbol_cache(dso);
532 struct symbol *dso__find_symbol(struct dso *dso, u64 addr)
534 if (dso->last_find_result.addr != addr || dso->last_find_result.symbol == NULL) {
535 dso->last_find_result.addr = addr;
536 dso->last_find_result.symbol = symbols__find(&dso->symbols, addr);
539 return dso->last_find_result.symbol;
542 struct symbol *dso__first_symbol(struct dso *dso)
544 return symbols__first(&dso->symbols);
547 struct symbol *dso__last_symbol(struct dso *dso)
549 return symbols__last(&dso->symbols);
552 struct symbol *dso__next_symbol(struct symbol *sym)
554 return symbols__next(sym);
557 struct symbol *symbol__next_by_name(struct symbol *sym)
559 struct symbol_name_rb_node *s = container_of(sym, struct symbol_name_rb_node, sym);
560 struct rb_node *n = rb_next(&s->rb_node);
562 return n ? &rb_entry(n, struct symbol_name_rb_node, rb_node)->sym : NULL;
566 * Returns first symbol that matched with @name.
568 struct symbol *dso__find_symbol_by_name(struct dso *dso, const char *name)
570 struct symbol *s = symbols__find_by_name(&dso->symbol_names, name,
571 SYMBOL_TAG_INCLUDE__NONE);
573 s = symbols__find_by_name(&dso->symbol_names, name,
574 SYMBOL_TAG_INCLUDE__DEFAULT_ONLY);
578 void dso__sort_by_name(struct dso *dso)
580 dso__set_sorted_by_name(dso);
581 return symbols__sort_by_name(&dso->symbol_names, &dso->symbols);
585 * While we find nice hex chars, build a long_val.
586 * Return number of chars processed.
588 static int hex2u64(const char *ptr, u64 *long_val)
592 *long_val = strtoull(ptr, &p, 16);
598 int modules__parse(const char *filename, void *arg,
599 int (*process_module)(void *arg, const char *name,
600 u64 start, u64 size))
607 file = fopen(filename, "r");
617 line_len = getline(&line, &n, file);
630 line[--line_len] = '\0'; /* \n */
632 sep = strrchr(line, 'x');
636 hex2u64(sep + 1, &start);
638 sep = strchr(line, ' ');
644 scnprintf(name, sizeof(name), "[%s]", line);
646 size = strtoul(sep + 1, &endptr, 0);
647 if (*endptr != ' ' && *endptr != '\t')
650 err = process_module(arg, name, start, size);
661 * These are symbols in the kernel image, so make sure that
662 * sym is from a kernel DSO.
664 static bool symbol__is_idle(const char *name)
666 const char * const idle_symbols[] = {
667 "acpi_idle_do_entry",
668 "acpi_processor_ffh_cstate_enter",
679 "mwait_idle_with_hints",
680 "mwait_idle_with_hints.constprop.0",
682 "ppc64_runlatch_off",
683 "pseries_dedicated_idle_sleep",
689 static struct strlist *idle_symbols_list;
691 if (idle_symbols_list)
692 return strlist__has_entry(idle_symbols_list, name);
694 idle_symbols_list = strlist__new(NULL, NULL);
696 for (i = 0; idle_symbols[i]; i++)
697 strlist__add(idle_symbols_list, idle_symbols[i]);
699 return strlist__has_entry(idle_symbols_list, name);
702 static int map__process_kallsym_symbol(void *arg, const char *name,
703 char type, u64 start)
706 struct dso *dso = arg;
707 struct rb_root_cached *root = &dso->symbols;
709 if (!symbol_type__filter(type))
712 /* Ignore local symbols for ARM modules */
717 * module symbols are not sorted so we add all
718 * symbols, setting length to 0, and rely on
719 * symbols__fixup_end() to fix it up.
721 sym = symbol__new(start, 0, kallsyms2elf_binding(type), kallsyms2elf_type(type), name);
725 * We will pass the symbols to the filter later, in
726 * map__split_kallsyms, when we have split the maps per module
728 __symbols__insert(root, sym, !strchr(name, '['));
734 * Loads the function entries in /proc/kallsyms into kernel_map->dso,
735 * so that we can in the next step set the symbol ->end address and then
736 * call kernel_maps__split_kallsyms.
738 static int dso__load_all_kallsyms(struct dso *dso, const char *filename)
740 return kallsyms__parse(filename, dso, map__process_kallsym_symbol);
743 static int maps__split_kallsyms_for_kcore(struct maps *kmaps, struct dso *dso)
745 struct map *curr_map;
748 struct rb_root_cached old_root = dso->symbols;
749 struct rb_root_cached *root = &dso->symbols;
750 struct rb_node *next = rb_first_cached(root);
755 *root = RB_ROOT_CACHED;
760 pos = rb_entry(next, struct symbol, rb_node);
761 next = rb_next(&pos->rb_node);
763 rb_erase_cached(&pos->rb_node, &old_root);
764 RB_CLEAR_NODE(&pos->rb_node);
765 module = strchr(pos->name, '\t');
769 curr_map = maps__find(kmaps, pos->start);
776 pos->start -= curr_map->start - curr_map->pgoff;
777 if (pos->end > curr_map->end)
778 pos->end = curr_map->end;
780 pos->end -= curr_map->start - curr_map->pgoff;
781 symbols__insert(&curr_map->dso->symbols, pos);
785 /* Symbols have been adjusted */
786 dso->adjust_symbols = 1;
792 * Split the symbols into maps, making sure there are no overlaps, i.e. the
793 * kernel range is broken in several maps, named [kernel].N, as we don't have
794 * the original ELF section names vmlinux have.
796 static int maps__split_kallsyms(struct maps *kmaps, struct dso *dso, u64 delta,
797 struct map *initial_map)
799 struct machine *machine;
800 struct map *curr_map = initial_map;
802 int count = 0, moved = 0;
803 struct rb_root_cached *root = &dso->symbols;
804 struct rb_node *next = rb_first_cached(root);
805 int kernel_range = 0;
811 machine = kmaps->machine;
813 x86_64 = machine__is(machine, "x86_64");
818 pos = rb_entry(next, struct symbol, rb_node);
819 next = rb_next(&pos->rb_node);
821 module = strchr(pos->name, '\t');
823 if (!symbol_conf.use_modules)
828 if (strcmp(curr_map->dso->short_name, module)) {
829 if (curr_map != initial_map &&
830 dso->kernel == DSO_SPACE__KERNEL_GUEST &&
831 machine__is_default_guest(machine)) {
833 * We assume all symbols of a module are
834 * continuous in * kallsyms, so curr_map
835 * points to a module and all its
836 * symbols are in its kmap. Mark it as
839 dso__set_loaded(curr_map->dso);
842 curr_map = maps__find_by_name(kmaps, module);
843 if (curr_map == NULL) {
844 pr_debug("%s/proc/{kallsyms,modules} "
845 "inconsistency while looking "
846 "for \"%s\" module!\n",
847 machine->root_dir, module);
848 curr_map = initial_map;
852 if (curr_map->dso->loaded &&
853 !machine__is_default_guest(machine))
857 * So that we look just like we get from .ko files,
858 * i.e. not prelinked, relative to initial_map->start.
860 pos->start = curr_map->map_ip(curr_map, pos->start);
861 pos->end = curr_map->map_ip(curr_map, pos->end);
862 } else if (x86_64 && is_entry_trampoline(pos->name)) {
864 * These symbols are not needed anymore since the
865 * trampoline maps refer to the text section and it's
866 * symbols instead. Avoid having to deal with
867 * relocations, and the assumption that the first symbol
868 * is the start of kernel text, by simply removing the
869 * symbols at this point.
872 } else if (curr_map != initial_map) {
873 char dso_name[PATH_MAX];
877 /* Kernel was relocated at boot time */
883 curr_map = initial_map;
887 if (dso->kernel == DSO_SPACE__KERNEL_GUEST)
888 snprintf(dso_name, sizeof(dso_name),
892 snprintf(dso_name, sizeof(dso_name),
896 ndso = dso__new(dso_name);
900 ndso->kernel = dso->kernel;
902 curr_map = map__new2(pos->start, ndso);
903 if (curr_map == NULL) {
908 curr_map->map_ip = curr_map->unmap_ip = identity__map_ip;
909 maps__insert(kmaps, curr_map);
912 /* Kernel was relocated at boot time */
917 if (curr_map != initial_map) {
918 rb_erase_cached(&pos->rb_node, root);
919 symbols__insert(&curr_map->dso->symbols, pos);
926 rb_erase_cached(&pos->rb_node, root);
930 if (curr_map != initial_map &&
931 dso->kernel == DSO_SPACE__KERNEL_GUEST &&
932 machine__is_default_guest(kmaps->machine)) {
933 dso__set_loaded(curr_map->dso);
936 return count + moved;
939 bool symbol__restricted_filename(const char *filename,
940 const char *restricted_filename)
942 bool restricted = false;
944 if (symbol_conf.kptr_restrict) {
945 char *r = realpath(filename, NULL);
948 restricted = strcmp(r, restricted_filename) == 0;
958 struct rb_node rb_node;
963 static void add_module(struct module_info *mi, struct rb_root *modules)
965 struct rb_node **p = &modules->rb_node;
966 struct rb_node *parent = NULL;
967 struct module_info *m;
971 m = rb_entry(parent, struct module_info, rb_node);
972 if (strcmp(mi->name, m->name) < 0)
977 rb_link_node(&mi->rb_node, parent, p);
978 rb_insert_color(&mi->rb_node, modules);
981 static void delete_modules(struct rb_root *modules)
983 struct module_info *mi;
984 struct rb_node *next = rb_first(modules);
987 mi = rb_entry(next, struct module_info, rb_node);
988 next = rb_next(&mi->rb_node);
989 rb_erase(&mi->rb_node, modules);
995 static struct module_info *find_module(const char *name,
996 struct rb_root *modules)
998 struct rb_node *n = modules->rb_node;
1001 struct module_info *m;
1004 m = rb_entry(n, struct module_info, rb_node);
1005 cmp = strcmp(name, m->name);
1017 static int __read_proc_modules(void *arg, const char *name, u64 start,
1018 u64 size __maybe_unused)
1020 struct rb_root *modules = arg;
1021 struct module_info *mi;
1023 mi = zalloc(sizeof(struct module_info));
1027 mi->name = strdup(name);
1035 add_module(mi, modules);
1040 static int read_proc_modules(const char *filename, struct rb_root *modules)
1042 if (symbol__restricted_filename(filename, "/proc/modules"))
1045 if (modules__parse(filename, modules, __read_proc_modules)) {
1046 delete_modules(modules);
1053 int compare_proc_modules(const char *from, const char *to)
1055 struct rb_root from_modules = RB_ROOT;
1056 struct rb_root to_modules = RB_ROOT;
1057 struct rb_node *from_node, *to_node;
1058 struct module_info *from_m, *to_m;
1061 if (read_proc_modules(from, &from_modules))
1064 if (read_proc_modules(to, &to_modules))
1065 goto out_delete_from;
1067 from_node = rb_first(&from_modules);
1068 to_node = rb_first(&to_modules);
1073 from_m = rb_entry(from_node, struct module_info, rb_node);
1074 to_m = rb_entry(to_node, struct module_info, rb_node);
1076 if (from_m->start != to_m->start ||
1077 strcmp(from_m->name, to_m->name))
1080 from_node = rb_next(from_node);
1081 to_node = rb_next(to_node);
1084 if (!from_node && !to_node)
1087 delete_modules(&to_modules);
1089 delete_modules(&from_modules);
1094 static int do_validate_kcore_modules(const char *filename, struct maps *kmaps)
1096 struct rb_root modules = RB_ROOT;
1097 struct map *old_map;
1100 err = read_proc_modules(filename, &modules);
1104 maps__for_each_entry(kmaps, old_map) {
1105 struct module_info *mi;
1107 if (!__map__is_kmodule(old_map)) {
1111 /* Module must be in memory at the same address */
1112 mi = find_module(old_map->dso->short_name, &modules);
1113 if (!mi || mi->start != old_map->start) {
1119 delete_modules(&modules);
1124 * If kallsyms is referenced by name then we look for filename in the same
1127 static bool filename_from_kallsyms_filename(char *filename,
1128 const char *base_name,
1129 const char *kallsyms_filename)
1133 strcpy(filename, kallsyms_filename);
1134 name = strrchr(filename, '/');
1140 if (!strcmp(name, "kallsyms")) {
1141 strcpy(name, base_name);
1148 static int validate_kcore_modules(const char *kallsyms_filename,
1151 struct maps *kmaps = map__kmaps(map);
1152 char modules_filename[PATH_MAX];
1157 if (!filename_from_kallsyms_filename(modules_filename, "modules",
1161 if (do_validate_kcore_modules(modules_filename, kmaps))
1167 static int validate_kcore_addresses(const char *kallsyms_filename,
1170 struct kmap *kmap = map__kmap(map);
1175 if (kmap->ref_reloc_sym && kmap->ref_reloc_sym->name) {
1178 if (kallsyms__get_function_start(kallsyms_filename,
1179 kmap->ref_reloc_sym->name, &start))
1181 if (start != kmap->ref_reloc_sym->addr)
1185 return validate_kcore_modules(kallsyms_filename, map);
1188 struct kcore_mapfn_data {
1190 struct list_head maps;
1193 static int kcore_mapfn(u64 start, u64 len, u64 pgoff, void *data)
1195 struct kcore_mapfn_data *md = data;
1198 map = map__new2(start, md->dso);
1202 map->end = map->start + len;
1205 list_add(&map->node, &md->maps);
1211 * Merges map into maps by splitting the new map within the existing map
1214 int maps__merge_in(struct maps *kmaps, struct map *new_map)
1216 struct map *old_map;
1219 maps__for_each_entry(kmaps, old_map) {
1220 /* no overload with this one */
1221 if (new_map->end < old_map->start ||
1222 new_map->start >= old_map->end)
1225 if (new_map->start < old_map->start) {
1230 if (new_map->end < old_map->end) {
1232 * |new......| -> |new..|
1233 * |old....| -> |old....|
1235 new_map->end = old_map->start;
1238 * |new.............| -> |new..| |new..|
1239 * |old....| -> |old....|
1241 struct map *m = map__clone(new_map);
1246 m->end = old_map->start;
1247 list_add_tail(&m->node, &merged);
1248 new_map->pgoff += old_map->end - new_map->start;
1249 new_map->start = old_map->end;
1256 if (new_map->end < old_map->end) {
1259 * |old.........| -> |old.........|
1266 * |new......| -> |new...|
1267 * |old....| -> |old....|
1269 new_map->pgoff += old_map->end - new_map->start;
1270 new_map->start = old_map->end;
1275 while (!list_empty(&merged)) {
1276 old_map = list_entry(merged.next, struct map, node);
1277 list_del_init(&old_map->node);
1278 maps__insert(kmaps, old_map);
1283 maps__insert(kmaps, new_map);
1289 static int dso__load_kcore(struct dso *dso, struct map *map,
1290 const char *kallsyms_filename)
1292 struct maps *kmaps = map__kmaps(map);
1293 struct kcore_mapfn_data md;
1294 struct map *old_map, *new_map, *replacement_map = NULL, *next;
1295 struct machine *machine;
1298 char kcore_filename[PATH_MAX];
1304 machine = kmaps->machine;
1306 /* This function requires that the map is the kernel map */
1307 if (!__map__is_kernel(map))
1310 if (!filename_from_kallsyms_filename(kcore_filename, "kcore",
1314 /* Modules and kernel must be present at their original addresses */
1315 if (validate_kcore_addresses(kallsyms_filename, map))
1319 INIT_LIST_HEAD(&md.maps);
1321 fd = open(kcore_filename, O_RDONLY);
1323 pr_debug("Failed to open %s. Note /proc/kcore requires CAP_SYS_RAWIO capability to access.\n",
1328 /* Read new maps into temporary lists */
1329 err = file__read_maps(fd, map->prot & PROT_EXEC, kcore_mapfn, &md,
1333 dso->is_64_bit = is_64_bit;
1335 if (list_empty(&md.maps)) {
1340 /* Remove old maps */
1341 maps__for_each_entry_safe(kmaps, old_map, next) {
1343 * We need to preserve eBPF maps even if they are
1344 * covered by kcore, because we need to access
1345 * eBPF dso for source data.
1347 if (old_map != map && !__map__is_bpf_prog(old_map))
1348 maps__remove(kmaps, old_map);
1350 machine->trampolines_mapped = false;
1352 /* Find the kernel map using the '_stext' symbol */
1353 if (!kallsyms__get_function_start(kallsyms_filename, "_stext", &stext)) {
1354 list_for_each_entry(new_map, &md.maps, node) {
1355 if (stext >= new_map->start && stext < new_map->end) {
1356 replacement_map = new_map;
1362 if (!replacement_map)
1363 replacement_map = list_entry(md.maps.next, struct map, node);
1366 while (!list_empty(&md.maps)) {
1367 new_map = list_entry(md.maps.next, struct map, node);
1368 list_del_init(&new_map->node);
1369 if (new_map == replacement_map) {
1370 map->start = new_map->start;
1371 map->end = new_map->end;
1372 map->pgoff = new_map->pgoff;
1373 map->map_ip = new_map->map_ip;
1374 map->unmap_ip = new_map->unmap_ip;
1375 /* Ensure maps are correctly ordered */
1377 maps__remove(kmaps, map);
1378 maps__insert(kmaps, map);
1383 * Merge kcore map into existing maps,
1384 * and ensure that current maps (eBPF)
1387 if (maps__merge_in(kmaps, new_map))
1392 if (machine__is(machine, "x86_64")) {
1396 * If one of the corresponding symbols is there, assume the
1397 * entry trampoline maps are too.
1399 if (!kallsyms__get_function_start(kallsyms_filename,
1400 ENTRY_TRAMPOLINE_NAME,
1402 machine->trampolines_mapped = true;
1406 * Set the data type and long name so that kcore can be read via
1407 * dso__data_read_addr().
1409 if (dso->kernel == DSO_SPACE__KERNEL_GUEST)
1410 dso->binary_type = DSO_BINARY_TYPE__GUEST_KCORE;
1412 dso->binary_type = DSO_BINARY_TYPE__KCORE;
1413 dso__set_long_name(dso, strdup(kcore_filename), true);
1417 if (map->prot & PROT_EXEC)
1418 pr_debug("Using %s for kernel object code\n", kcore_filename);
1420 pr_debug("Using %s for kernel data\n", kcore_filename);
1425 while (!list_empty(&md.maps)) {
1426 map = list_entry(md.maps.next, struct map, node);
1427 list_del_init(&map->node);
1435 * If the kernel is relocated at boot time, kallsyms won't match. Compute the
1436 * delta based on the relocation reference symbol.
1438 static int kallsyms__delta(struct kmap *kmap, const char *filename, u64 *delta)
1442 if (!kmap->ref_reloc_sym || !kmap->ref_reloc_sym->name)
1445 if (kallsyms__get_function_start(filename, kmap->ref_reloc_sym->name, &addr))
1448 *delta = addr - kmap->ref_reloc_sym->addr;
1452 int __dso__load_kallsyms(struct dso *dso, const char *filename,
1453 struct map *map, bool no_kcore)
1455 struct kmap *kmap = map__kmap(map);
1458 if (symbol__restricted_filename(filename, "/proc/kallsyms"))
1461 if (!kmap || !kmap->kmaps)
1464 if (dso__load_all_kallsyms(dso, filename) < 0)
1467 if (kallsyms__delta(kmap, filename, &delta))
1470 symbols__fixup_end(&dso->symbols);
1471 symbols__fixup_duplicate(&dso->symbols);
1473 if (dso->kernel == DSO_SPACE__KERNEL_GUEST)
1474 dso->symtab_type = DSO_BINARY_TYPE__GUEST_KALLSYMS;
1476 dso->symtab_type = DSO_BINARY_TYPE__KALLSYMS;
1478 if (!no_kcore && !dso__load_kcore(dso, map, filename))
1479 return maps__split_kallsyms_for_kcore(kmap->kmaps, dso);
1481 return maps__split_kallsyms(kmap->kmaps, dso, delta, map);
1484 int dso__load_kallsyms(struct dso *dso, const char *filename,
1487 return __dso__load_kallsyms(dso, filename, map, false);
1490 static int dso__load_perf_map(const char *map_path, struct dso *dso)
1497 file = fopen(map_path, "r");
1501 while (!feof(file)) {
1506 line_len = getline(&line, &n, file);
1513 line[--line_len] = '\0'; /* \n */
1515 len = hex2u64(line, &start);
1518 if (len + 2 >= line_len)
1521 len += hex2u64(line + len, &size);
1524 if (len + 2 >= line_len)
1527 sym = symbol__new(start, size, STB_GLOBAL, STT_FUNC, line + len);
1530 goto out_delete_line;
1532 symbols__insert(&dso->symbols, sym);
1547 #ifdef HAVE_LIBBFD_SUPPORT
1548 #define PACKAGE 'perf'
1551 static int bfd_symbols__cmpvalue(const void *a, const void *b)
1553 const asymbol *as = *(const asymbol **)a, *bs = *(const asymbol **)b;
1555 if (bfd_asymbol_value(as) != bfd_asymbol_value(bs))
1556 return bfd_asymbol_value(as) - bfd_asymbol_value(bs);
1558 return bfd_asymbol_name(as)[0] - bfd_asymbol_name(bs)[0];
1561 static int bfd2elf_binding(asymbol *symbol)
1563 if (symbol->flags & BSF_WEAK)
1565 if (symbol->flags & BSF_GLOBAL)
1567 if (symbol->flags & BSF_LOCAL)
1572 int dso__load_bfd_symbols(struct dso *dso, const char *debugfile)
1575 long symbols_size, symbols_count, i;
1577 asymbol **symbols, *sym;
1578 struct symbol *symbol;
1582 abfd = bfd_openr(debugfile, NULL);
1586 if (!bfd_check_format(abfd, bfd_object)) {
1587 pr_debug2("%s: cannot read %s bfd file.\n", __func__,
1592 if (bfd_get_flavour(abfd) == bfd_target_elf_flavour)
1595 symbols_size = bfd_get_symtab_upper_bound(abfd);
1596 if (symbols_size == 0) {
1601 if (symbols_size < 0)
1604 symbols = malloc(symbols_size);
1608 symbols_count = bfd_canonicalize_symtab(abfd, symbols);
1609 if (symbols_count < 0)
1612 section = bfd_get_section_by_name(abfd, ".text");
1614 for (i = 0; i < symbols_count; ++i) {
1615 if (!strcmp(bfd_asymbol_name(symbols[i]), "__ImageBase") ||
1616 !strcmp(bfd_asymbol_name(symbols[i]), "__image_base__"))
1619 if (i < symbols_count) {
1620 /* PE symbols can only have 4 bytes, so use .text high bits */
1621 dso->text_offset = section->vma - (u32)section->vma;
1622 dso->text_offset += (u32)bfd_asymbol_value(symbols[i]);
1624 dso->text_offset = section->vma - section->filepos;
1628 qsort(symbols, symbols_count, sizeof(asymbol *), bfd_symbols__cmpvalue);
1630 #ifdef bfd_get_section
1631 #define bfd_asymbol_section bfd_get_section
1633 for (i = 0; i < symbols_count; ++i) {
1635 section = bfd_asymbol_section(sym);
1636 if (bfd2elf_binding(sym) < 0)
1639 while (i + 1 < symbols_count &&
1640 bfd_asymbol_section(symbols[i + 1]) == section &&
1641 bfd2elf_binding(symbols[i + 1]) < 0)
1644 if (i + 1 < symbols_count &&
1645 bfd_asymbol_section(symbols[i + 1]) == section)
1646 len = symbols[i + 1]->value - sym->value;
1648 len = section->size - sym->value;
1650 start = bfd_asymbol_value(sym) - dso->text_offset;
1651 symbol = symbol__new(start, len, bfd2elf_binding(sym), STT_FUNC,
1652 bfd_asymbol_name(sym));
1656 symbols__insert(&dso->symbols, symbol);
1658 #ifdef bfd_get_section
1659 #undef bfd_asymbol_section
1662 symbols__fixup_end(&dso->symbols);
1663 symbols__fixup_duplicate(&dso->symbols);
1664 dso->adjust_symbols = 1;
1675 static bool dso__is_compatible_symtab_type(struct dso *dso, bool kmod,
1676 enum dso_binary_type type)
1679 case DSO_BINARY_TYPE__JAVA_JIT:
1680 case DSO_BINARY_TYPE__DEBUGLINK:
1681 case DSO_BINARY_TYPE__SYSTEM_PATH_DSO:
1682 case DSO_BINARY_TYPE__FEDORA_DEBUGINFO:
1683 case DSO_BINARY_TYPE__UBUNTU_DEBUGINFO:
1684 case DSO_BINARY_TYPE__MIXEDUP_UBUNTU_DEBUGINFO:
1685 case DSO_BINARY_TYPE__BUILDID_DEBUGINFO:
1686 case DSO_BINARY_TYPE__OPENEMBEDDED_DEBUGINFO:
1687 return !kmod && dso->kernel == DSO_SPACE__USER;
1689 case DSO_BINARY_TYPE__KALLSYMS:
1690 case DSO_BINARY_TYPE__VMLINUX:
1691 case DSO_BINARY_TYPE__KCORE:
1692 return dso->kernel == DSO_SPACE__KERNEL;
1694 case DSO_BINARY_TYPE__GUEST_KALLSYMS:
1695 case DSO_BINARY_TYPE__GUEST_VMLINUX:
1696 case DSO_BINARY_TYPE__GUEST_KCORE:
1697 return dso->kernel == DSO_SPACE__KERNEL_GUEST;
1699 case DSO_BINARY_TYPE__GUEST_KMODULE:
1700 case DSO_BINARY_TYPE__GUEST_KMODULE_COMP:
1701 case DSO_BINARY_TYPE__SYSTEM_PATH_KMODULE:
1702 case DSO_BINARY_TYPE__SYSTEM_PATH_KMODULE_COMP:
1704 * kernel modules know their symtab type - it's set when
1705 * creating a module dso in machine__addnew_module_map().
1707 return kmod && dso->symtab_type == type;
1709 case DSO_BINARY_TYPE__BUILD_ID_CACHE:
1710 case DSO_BINARY_TYPE__BUILD_ID_CACHE_DEBUGINFO:
1713 case DSO_BINARY_TYPE__BPF_PROG_INFO:
1714 case DSO_BINARY_TYPE__BPF_IMAGE:
1715 case DSO_BINARY_TYPE__OOL:
1716 case DSO_BINARY_TYPE__NOT_FOUND:
1722 /* Checks for the existence of the perf-<pid>.map file in two different
1723 * locations. First, if the process is a separate mount namespace, check in
1724 * that namespace using the pid of the innermost pid namespace. If's not in a
1725 * namespace, or the file can't be found there, try in the mount namespace of
1726 * the tracing process using our view of its pid.
1728 static int dso__find_perf_map(char *filebuf, size_t bufsz,
1729 struct nsinfo **nsip)
1731 struct nscookie nsc;
1733 struct nsinfo *nnsi;
1738 if (nsinfo__need_setns(nsi)) {
1739 snprintf(filebuf, bufsz, "/tmp/perf-%d.map", nsinfo__nstgid(nsi));
1740 nsinfo__mountns_enter(nsi, &nsc);
1741 rc = access(filebuf, R_OK);
1742 nsinfo__mountns_exit(&nsc);
1747 nnsi = nsinfo__copy(nsi);
1751 nsinfo__clear_need_setns(nnsi);
1752 snprintf(filebuf, bufsz, "/tmp/perf-%d.map", nsinfo__tgid(nnsi));
1760 int dso__load(struct dso *dso, struct map *map)
1765 struct machine *machine = NULL;
1766 char *root_dir = (char *) "";
1768 struct symsrc ss_[2];
1769 struct symsrc *syms_ss = NULL, *runtime_ss = NULL;
1772 struct build_id bid;
1773 struct nscookie nsc;
1774 char newmapname[PATH_MAX];
1775 const char *map_path = dso->long_name;
1777 perfmap = strncmp(dso->name, "/tmp/perf-", 10) == 0;
1779 if (dso->nsinfo && (dso__find_perf_map(newmapname,
1780 sizeof(newmapname), &dso->nsinfo) == 0)) {
1781 map_path = newmapname;
1785 nsinfo__mountns_enter(dso->nsinfo, &nsc);
1786 pthread_mutex_lock(&dso->lock);
1788 /* check again under the dso->lock */
1789 if (dso__loaded(dso)) {
1794 kmod = dso->symtab_type == DSO_BINARY_TYPE__SYSTEM_PATH_KMODULE ||
1795 dso->symtab_type == DSO_BINARY_TYPE__SYSTEM_PATH_KMODULE_COMP ||
1796 dso->symtab_type == DSO_BINARY_TYPE__GUEST_KMODULE ||
1797 dso->symtab_type == DSO_BINARY_TYPE__GUEST_KMODULE_COMP;
1799 if (dso->kernel && !kmod) {
1800 if (dso->kernel == DSO_SPACE__KERNEL)
1801 ret = dso__load_kernel_sym(dso, map);
1802 else if (dso->kernel == DSO_SPACE__KERNEL_GUEST)
1803 ret = dso__load_guest_kernel_sym(dso, map);
1805 machine = map__kmaps(map)->machine;
1806 if (machine__is(machine, "x86_64"))
1807 machine__map_x86_64_entry_trampolines(machine, dso);
1811 dso->adjust_symbols = 0;
1814 ret = dso__load_perf_map(map_path, dso);
1815 dso->symtab_type = ret > 0 ? DSO_BINARY_TYPE__JAVA_JIT :
1816 DSO_BINARY_TYPE__NOT_FOUND;
1821 root_dir = machine->root_dir;
1823 name = malloc(PATH_MAX);
1828 * Read the build id if possible. This is required for
1829 * DSO_BINARY_TYPE__BUILDID_DEBUGINFO to work
1831 if (!dso->has_build_id &&
1832 is_regular_file(dso->long_name)) {
1833 __symbol__join_symfs(name, PATH_MAX, dso->long_name);
1834 if (filename__read_build_id(name, &bid) > 0)
1835 dso__set_build_id(dso, &bid);
1839 * Iterate over candidate debug images.
1840 * Keep track of "interesting" ones (those which have a symtab, dynsym,
1841 * and/or opd section) for processing.
1843 for (i = 0; i < DSO_BINARY_TYPE__SYMTAB_CNT; i++) {
1844 struct symsrc *ss = &ss_[ss_pos];
1845 bool next_slot = false;
1851 enum dso_binary_type symtab_type = binary_type_symtab[i];
1853 nsexit = (symtab_type == DSO_BINARY_TYPE__BUILD_ID_CACHE ||
1854 symtab_type == DSO_BINARY_TYPE__BUILD_ID_CACHE_DEBUGINFO);
1856 if (!dso__is_compatible_symtab_type(dso, kmod, symtab_type))
1859 if (dso__read_binary_type_filename(dso, symtab_type,
1860 root_dir, name, PATH_MAX))
1864 nsinfo__mountns_exit(&nsc);
1866 is_reg = is_regular_file(name);
1867 if (!is_reg && errno == ENOENT && dso->nsinfo) {
1868 char *new_name = filename_with_chroot(dso->nsinfo->pid,
1871 is_reg = is_regular_file(new_name);
1872 strlcpy(name, new_name, PATH_MAX);
1877 #ifdef HAVE_LIBBFD_SUPPORT
1879 bfdrc = dso__load_bfd_symbols(dso, name);
1881 if (is_reg && bfdrc < 0)
1882 sirc = symsrc__init(ss, dso, name, symtab_type);
1885 nsinfo__mountns_enter(dso->nsinfo, &nsc);
1892 if (!is_reg || sirc < 0)
1895 if (!syms_ss && symsrc__has_symtab(ss)) {
1898 if (!dso->symsrc_filename)
1899 dso->symsrc_filename = strdup(name);
1902 if (!runtime_ss && symsrc__possibly_runtime(ss)) {
1910 if (syms_ss && runtime_ss)
1913 symsrc__destroy(ss);
1918 if (!runtime_ss && !syms_ss)
1921 if (runtime_ss && !syms_ss) {
1922 syms_ss = runtime_ss;
1925 /* We'll have to hope for the best */
1926 if (!runtime_ss && syms_ss)
1927 runtime_ss = syms_ss;
1930 ret = dso__load_sym(dso, map, syms_ss, runtime_ss, kmod);
1937 nr_plt = dso__synthesize_plt_symbols(dso, runtime_ss);
1942 for (; ss_pos > 0; ss_pos--)
1943 symsrc__destroy(&ss_[ss_pos - 1]);
1946 if (ret < 0 && strstr(dso->name, " (deleted)") != NULL)
1949 dso__set_loaded(dso);
1950 pthread_mutex_unlock(&dso->lock);
1951 nsinfo__mountns_exit(&nsc);
1956 static int map__strcmp(const void *a, const void *b)
1958 const struct map *ma = *(const struct map **)a, *mb = *(const struct map **)b;
1959 return strcmp(ma->dso->short_name, mb->dso->short_name);
1962 static int map__strcmp_name(const void *name, const void *b)
1964 const struct map *map = *(const struct map **)b;
1965 return strcmp(name, map->dso->short_name);
1968 void __maps__sort_by_name(struct maps *maps)
1970 qsort(maps->maps_by_name, maps->nr_maps, sizeof(struct map *), map__strcmp);
1973 static int map__groups__sort_by_name_from_rbtree(struct maps *maps)
1976 struct map **maps_by_name = realloc(maps->maps_by_name, maps->nr_maps * sizeof(map));
1979 if (maps_by_name == NULL)
1982 maps->maps_by_name = maps_by_name;
1983 maps->nr_maps_allocated = maps->nr_maps;
1985 maps__for_each_entry(maps, map)
1986 maps_by_name[i++] = map;
1988 __maps__sort_by_name(maps);
1992 static struct map *__maps__find_by_name(struct maps *maps, const char *name)
1996 if (maps->maps_by_name == NULL &&
1997 map__groups__sort_by_name_from_rbtree(maps))
2000 mapp = bsearch(name, maps->maps_by_name, maps->nr_maps, sizeof(*mapp), map__strcmp_name);
2006 struct map *maps__find_by_name(struct maps *maps, const char *name)
2010 down_read(&maps->lock);
2012 if (maps->last_search_by_name && strcmp(maps->last_search_by_name->dso->short_name, name) == 0) {
2013 map = maps->last_search_by_name;
2017 * If we have maps->maps_by_name, then the name isn't in the rbtree,
2018 * as maps->maps_by_name mirrors the rbtree when lookups by name are
2021 map = __maps__find_by_name(maps, name);
2022 if (map || maps->maps_by_name != NULL)
2025 /* Fallback to traversing the rbtree... */
2026 maps__for_each_entry(maps, map)
2027 if (strcmp(map->dso->short_name, name) == 0) {
2028 maps->last_search_by_name = map;
2035 up_read(&maps->lock);
2039 int dso__load_vmlinux(struct dso *dso, struct map *map,
2040 const char *vmlinux, bool vmlinux_allocated)
2044 char symfs_vmlinux[PATH_MAX];
2045 enum dso_binary_type symtab_type;
2047 if (vmlinux[0] == '/')
2048 snprintf(symfs_vmlinux, sizeof(symfs_vmlinux), "%s", vmlinux);
2050 symbol__join_symfs(symfs_vmlinux, vmlinux);
2052 if (dso->kernel == DSO_SPACE__KERNEL_GUEST)
2053 symtab_type = DSO_BINARY_TYPE__GUEST_VMLINUX;
2055 symtab_type = DSO_BINARY_TYPE__VMLINUX;
2057 if (symsrc__init(&ss, dso, symfs_vmlinux, symtab_type))
2060 err = dso__load_sym(dso, map, &ss, &ss, 0);
2061 symsrc__destroy(&ss);
2064 if (dso->kernel == DSO_SPACE__KERNEL_GUEST)
2065 dso->binary_type = DSO_BINARY_TYPE__GUEST_VMLINUX;
2067 dso->binary_type = DSO_BINARY_TYPE__VMLINUX;
2068 dso__set_long_name(dso, vmlinux, vmlinux_allocated);
2069 dso__set_loaded(dso);
2070 pr_debug("Using %s for symbols\n", symfs_vmlinux);
2076 int dso__load_vmlinux_path(struct dso *dso, struct map *map)
2079 char *filename = NULL;
2081 pr_debug("Looking at the vmlinux_path (%d entries long)\n",
2082 vmlinux_path__nr_entries + 1);
2084 for (i = 0; i < vmlinux_path__nr_entries; ++i) {
2085 err = dso__load_vmlinux(dso, map, vmlinux_path[i], false);
2090 if (!symbol_conf.ignore_vmlinux_buildid)
2091 filename = dso__build_id_filename(dso, NULL, 0, false);
2092 if (filename != NULL) {
2093 err = dso__load_vmlinux(dso, map, filename, true);
2102 static bool visible_dir_filter(const char *name, struct dirent *d)
2104 if (d->d_type != DT_DIR)
2106 return lsdir_no_dot_filter(name, d);
2109 static int find_matching_kcore(struct map *map, char *dir, size_t dir_sz)
2111 char kallsyms_filename[PATH_MAX];
2113 struct strlist *dirs;
2114 struct str_node *nd;
2116 dirs = lsdir(dir, visible_dir_filter);
2120 strlist__for_each_entry(nd, dirs) {
2121 scnprintf(kallsyms_filename, sizeof(kallsyms_filename),
2122 "%s/%s/kallsyms", dir, nd->s);
2123 if (!validate_kcore_addresses(kallsyms_filename, map)) {
2124 strlcpy(dir, kallsyms_filename, dir_sz);
2130 strlist__delete(dirs);
2136 * Use open(O_RDONLY) to check readability directly instead of access(R_OK)
2137 * since access(R_OK) only checks with real UID/GID but open() use effective
2138 * UID/GID and actual capabilities (e.g. /proc/kcore requires CAP_SYS_RAWIO).
2140 static bool filename__readable(const char *file)
2142 int fd = open(file, O_RDONLY);
2149 static char *dso__find_kallsyms(struct dso *dso, struct map *map)
2151 struct build_id bid;
2152 char sbuild_id[SBUILD_ID_SIZE];
2153 bool is_host = false;
2154 char path[PATH_MAX];
2156 if (!dso->has_build_id) {
2158 * Last resort, if we don't have a build-id and couldn't find
2159 * any vmlinux file, try the running kernel kallsyms table.
2164 if (sysfs__read_build_id("/sys/kernel/notes", &bid) == 0)
2165 is_host = dso__build_id_equal(dso, &bid);
2167 /* Try a fast path for /proc/kallsyms if possible */
2170 * Do not check the build-id cache, unless we know we cannot use
2171 * /proc/kcore or module maps don't match to /proc/kallsyms.
2172 * To check readability of /proc/kcore, do not use access(R_OK)
2173 * since /proc/kcore requires CAP_SYS_RAWIO to read and access
2176 if (filename__readable("/proc/kcore") &&
2177 !validate_kcore_addresses("/proc/kallsyms", map))
2181 build_id__sprintf(&dso->bid, sbuild_id);
2183 /* Find kallsyms in build-id cache with kcore */
2184 scnprintf(path, sizeof(path), "%s/%s/%s",
2185 buildid_dir, DSO__NAME_KCORE, sbuild_id);
2187 if (!find_matching_kcore(map, path, sizeof(path)))
2188 return strdup(path);
2190 /* Use current /proc/kallsyms if possible */
2193 return strdup("/proc/kallsyms");
2196 /* Finally, find a cache of kallsyms */
2197 if (!build_id_cache__kallsyms_path(sbuild_id, path, sizeof(path))) {
2198 pr_err("No kallsyms or vmlinux with build-id %s was found\n",
2203 return strdup(path);
2206 static int dso__load_kernel_sym(struct dso *dso, struct map *map)
2209 const char *kallsyms_filename = NULL;
2210 char *kallsyms_allocated_filename = NULL;
2211 char *filename = NULL;
2214 * Step 1: if the user specified a kallsyms or vmlinux filename, use
2215 * it and only it, reporting errors to the user if it cannot be used.
2217 * For instance, try to analyse an ARM perf.data file _without_ a
2218 * build-id, or if the user specifies the wrong path to the right
2219 * vmlinux file, obviously we can't fallback to another vmlinux (a
2220 * x86_86 one, on the machine where analysis is being performed, say),
2221 * or worse, /proc/kallsyms.
2223 * If the specified file _has_ a build-id and there is a build-id
2224 * section in the perf.data file, we will still do the expected
2225 * validation in dso__load_vmlinux and will bail out if they don't
2228 if (symbol_conf.kallsyms_name != NULL) {
2229 kallsyms_filename = symbol_conf.kallsyms_name;
2233 if (!symbol_conf.ignore_vmlinux && symbol_conf.vmlinux_name != NULL) {
2234 return dso__load_vmlinux(dso, map, symbol_conf.vmlinux_name, false);
2238 * Before checking on common vmlinux locations, check if it's
2239 * stored as standard build id binary (not kallsyms) under
2242 if (!symbol_conf.ignore_vmlinux_buildid)
2243 filename = __dso__build_id_filename(dso, NULL, 0, false, false);
2244 if (filename != NULL) {
2245 err = dso__load_vmlinux(dso, map, filename, true);
2251 if (!symbol_conf.ignore_vmlinux && vmlinux_path != NULL) {
2252 err = dso__load_vmlinux_path(dso, map);
2257 /* do not try local files if a symfs was given */
2258 if (symbol_conf.symfs[0] != 0)
2261 kallsyms_allocated_filename = dso__find_kallsyms(dso, map);
2262 if (!kallsyms_allocated_filename)
2265 kallsyms_filename = kallsyms_allocated_filename;
2268 err = dso__load_kallsyms(dso, kallsyms_filename, map);
2270 pr_debug("Using %s for symbols\n", kallsyms_filename);
2271 free(kallsyms_allocated_filename);
2273 if (err > 0 && !dso__is_kcore(dso)) {
2274 dso->binary_type = DSO_BINARY_TYPE__KALLSYMS;
2275 dso__set_long_name(dso, DSO__NAME_KALLSYMS, false);
2276 map__fixup_start(map);
2277 map__fixup_end(map);
2283 static int dso__load_guest_kernel_sym(struct dso *dso, struct map *map)
2286 const char *kallsyms_filename = NULL;
2287 struct machine *machine = map__kmaps(map)->machine;
2288 char path[PATH_MAX];
2290 if (machine__is_default_guest(machine)) {
2292 * if the user specified a vmlinux filename, use it and only
2293 * it, reporting errors to the user if it cannot be used.
2294 * Or use file guest_kallsyms inputted by user on commandline
2296 if (symbol_conf.default_guest_vmlinux_name != NULL) {
2297 err = dso__load_vmlinux(dso, map,
2298 symbol_conf.default_guest_vmlinux_name,
2303 kallsyms_filename = symbol_conf.default_guest_kallsyms;
2304 if (!kallsyms_filename)
2307 sprintf(path, "%s/proc/kallsyms", machine->root_dir);
2308 kallsyms_filename = path;
2311 err = dso__load_kallsyms(dso, kallsyms_filename, map);
2313 pr_debug("Using %s for symbols\n", kallsyms_filename);
2314 if (err > 0 && !dso__is_kcore(dso)) {
2315 dso->binary_type = DSO_BINARY_TYPE__GUEST_KALLSYMS;
2316 dso__set_long_name(dso, machine->mmap_name, false);
2317 map__fixup_start(map);
2318 map__fixup_end(map);
2324 static void vmlinux_path__exit(void)
2326 while (--vmlinux_path__nr_entries >= 0)
2327 zfree(&vmlinux_path[vmlinux_path__nr_entries]);
2328 vmlinux_path__nr_entries = 0;
2330 zfree(&vmlinux_path);
2333 static const char * const vmlinux_paths[] = {
2338 static const char * const vmlinux_paths_upd[] = {
2340 "/usr/lib/debug/boot/vmlinux-%s",
2341 "/lib/modules/%s/build/vmlinux",
2342 "/usr/lib/debug/lib/modules/%s/vmlinux",
2343 "/usr/lib/debug/boot/vmlinux-%s.debug"
2346 static int vmlinux_path__add(const char *new_entry)
2348 vmlinux_path[vmlinux_path__nr_entries] = strdup(new_entry);
2349 if (vmlinux_path[vmlinux_path__nr_entries] == NULL)
2351 ++vmlinux_path__nr_entries;
2356 static int vmlinux_path__init(struct perf_env *env)
2360 char *kernel_version;
2363 vmlinux_path = malloc(sizeof(char *) * (ARRAY_SIZE(vmlinux_paths) +
2364 ARRAY_SIZE(vmlinux_paths_upd)));
2365 if (vmlinux_path == NULL)
2368 for (i = 0; i < ARRAY_SIZE(vmlinux_paths); i++)
2369 if (vmlinux_path__add(vmlinux_paths[i]) < 0)
2372 /* only try kernel version if no symfs was given */
2373 if (symbol_conf.symfs[0] != 0)
2377 kernel_version = env->os_release;
2379 if (uname(&uts) < 0)
2382 kernel_version = uts.release;
2385 for (i = 0; i < ARRAY_SIZE(vmlinux_paths_upd); i++) {
2386 snprintf(bf, sizeof(bf), vmlinux_paths_upd[i], kernel_version);
2387 if (vmlinux_path__add(bf) < 0)
2394 vmlinux_path__exit();
2398 int setup_list(struct strlist **list, const char *list_str,
2399 const char *list_name)
2401 if (list_str == NULL)
2404 *list = strlist__new(list_str, NULL);
2406 pr_err("problems parsing %s list\n", list_name);
2410 symbol_conf.has_filter = true;
2414 int setup_intlist(struct intlist **list, const char *list_str,
2415 const char *list_name)
2417 if (list_str == NULL)
2420 *list = intlist__new(list_str);
2422 pr_err("problems parsing %s list\n", list_name);
2428 static int setup_addrlist(struct intlist **addr_list, struct strlist *sym_list)
2430 struct str_node *pos, *tmp;
2436 *addr_list = intlist__new(NULL);
2440 strlist__for_each_entry_safe(pos, tmp, sym_list) {
2442 val = strtoul(pos->s, &sep, 16);
2443 if (errno || (sep == pos->s))
2447 end = pos->s + strlen(pos->s) - 1;
2448 while (end >= sep && isspace(*end))
2455 err = intlist__add(*addr_list, val);
2459 strlist__remove(sym_list, pos);
2464 intlist__delete(*addr_list);
2471 static bool symbol__read_kptr_restrict(void)
2474 FILE *fp = fopen("/proc/sys/kernel/kptr_restrict", "r");
2479 if (fgets(line, sizeof(line), fp) != NULL)
2480 value = perf_cap__capable(CAP_SYSLOG) ?
2487 /* Per kernel/kallsyms.c:
2488 * we also restrict when perf_event_paranoid > 1 w/o CAP_SYSLOG
2490 if (perf_event_paranoid() > 1 && !perf_cap__capable(CAP_SYSLOG))
2496 int symbol__annotation_init(void)
2498 if (symbol_conf.init_annotation)
2501 if (symbol_conf.initialized) {
2502 pr_err("Annotation needs to be init before symbol__init()\n");
2506 symbol_conf.priv_size += sizeof(struct annotation);
2507 symbol_conf.init_annotation = true;
2511 int symbol__init(struct perf_env *env)
2515 if (symbol_conf.initialized)
2518 symbol_conf.priv_size = PERF_ALIGN(symbol_conf.priv_size, sizeof(u64));
2522 if (symbol_conf.sort_by_name)
2523 symbol_conf.priv_size += (sizeof(struct symbol_name_rb_node) -
2524 sizeof(struct symbol));
2526 if (symbol_conf.try_vmlinux_path && vmlinux_path__init(env) < 0)
2529 if (symbol_conf.field_sep && *symbol_conf.field_sep == '.') {
2530 pr_err("'.' is the only non valid --field-separator argument\n");
2534 if (setup_list(&symbol_conf.dso_list,
2535 symbol_conf.dso_list_str, "dso") < 0)
2538 if (setup_list(&symbol_conf.comm_list,
2539 symbol_conf.comm_list_str, "comm") < 0)
2540 goto out_free_dso_list;
2542 if (setup_intlist(&symbol_conf.pid_list,
2543 symbol_conf.pid_list_str, "pid") < 0)
2544 goto out_free_comm_list;
2546 if (setup_intlist(&symbol_conf.tid_list,
2547 symbol_conf.tid_list_str, "tid") < 0)
2548 goto out_free_pid_list;
2550 if (setup_list(&symbol_conf.sym_list,
2551 symbol_conf.sym_list_str, "symbol") < 0)
2552 goto out_free_tid_list;
2554 if (symbol_conf.sym_list &&
2555 setup_addrlist(&symbol_conf.addr_list, symbol_conf.sym_list) < 0)
2556 goto out_free_sym_list;
2558 if (setup_list(&symbol_conf.bt_stop_list,
2559 symbol_conf.bt_stop_list_str, "symbol") < 0)
2560 goto out_free_sym_list;
2563 * A path to symbols of "/" is identical to ""
2564 * reset here for simplicity.
2566 symfs = realpath(symbol_conf.symfs, NULL);
2568 symfs = symbol_conf.symfs;
2569 if (strcmp(symfs, "/") == 0)
2570 symbol_conf.symfs = "";
2571 if (symfs != symbol_conf.symfs)
2572 free((void *)symfs);
2574 symbol_conf.kptr_restrict = symbol__read_kptr_restrict();
2576 symbol_conf.initialized = true;
2580 strlist__delete(symbol_conf.sym_list);
2581 intlist__delete(symbol_conf.addr_list);
2583 intlist__delete(symbol_conf.tid_list);
2585 intlist__delete(symbol_conf.pid_list);
2587 strlist__delete(symbol_conf.comm_list);
2589 strlist__delete(symbol_conf.dso_list);
2593 void symbol__exit(void)
2595 if (!symbol_conf.initialized)
2597 strlist__delete(symbol_conf.bt_stop_list);
2598 strlist__delete(symbol_conf.sym_list);
2599 strlist__delete(symbol_conf.dso_list);
2600 strlist__delete(symbol_conf.comm_list);
2601 intlist__delete(symbol_conf.tid_list);
2602 intlist__delete(symbol_conf.pid_list);
2603 intlist__delete(symbol_conf.addr_list);
2604 vmlinux_path__exit();
2605 symbol_conf.sym_list = symbol_conf.dso_list = symbol_conf.comm_list = NULL;
2606 symbol_conf.bt_stop_list = NULL;
2607 symbol_conf.initialized = false;
2610 int symbol__config_symfs(const struct option *opt __maybe_unused,
2611 const char *dir, int unset __maybe_unused)
2616 symbol_conf.symfs = strdup(dir);
2617 if (symbol_conf.symfs == NULL)
2620 /* skip the locally configured cache if a symfs is given, and
2621 * config buildid dir to symfs/.debug
2623 ret = asprintf(&bf, "%s/%s", dir, ".debug");
2627 set_buildid_dir(bf);
2633 struct mem_info *mem_info__get(struct mem_info *mi)
2636 refcount_inc(&mi->refcnt);
2640 void mem_info__put(struct mem_info *mi)
2642 if (mi && refcount_dec_and_test(&mi->refcnt))
2646 struct mem_info *mem_info__new(void)
2648 struct mem_info *mi = zalloc(sizeof(*mi));
2651 refcount_set(&mi->refcnt, 1);
2656 * Checks that user supplied symbol kernel files are accessible because
2657 * the default mechanism for accessing elf files fails silently. i.e. if
2658 * debug syms for a build ID aren't found perf carries on normally. When
2659 * they are user supplied we should assume that the user doesn't want to
2662 int symbol__validate_sym_arguments(void)
2664 if (symbol_conf.vmlinux_name &&
2665 access(symbol_conf.vmlinux_name, R_OK)) {
2666 pr_err("Invalid file: %s\n", symbol_conf.vmlinux_name);
2669 if (symbol_conf.kallsyms_name &&
2670 access(symbol_conf.kallsyms_name, R_OK)) {
2671 pr_err("Invalid file: %s\n", symbol_conf.kallsyms_name);