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 const char * __weak arch__normalize_symbol_name(const char *name)
109 int __weak arch__compare_symbol_names(const char *namea, const char *nameb)
111 return strcmp(namea, nameb);
114 int __weak arch__compare_symbol_names_n(const char *namea, const char *nameb,
117 return strncmp(namea, nameb, n);
120 int __weak arch__choose_best_symbol(struct symbol *syma,
121 struct symbol *symb __maybe_unused)
123 /* Avoid "SyS" kernel syscall aliases */
124 if (strlen(syma->name) >= 3 && !strncmp(syma->name, "SyS", 3))
126 if (strlen(syma->name) >= 10 && !strncmp(syma->name, "compat_SyS", 10))
132 static int choose_best_symbol(struct symbol *syma, struct symbol *symb)
138 /* Prefer a symbol with non zero length */
139 a = syma->end - syma->start;
140 b = symb->end - symb->start;
141 if ((b == 0) && (a > 0))
143 else if ((a == 0) && (b > 0))
146 /* Prefer a non weak symbol over a weak one */
147 a = syma->binding == STB_WEAK;
148 b = symb->binding == STB_WEAK;
154 /* Prefer a global symbol over a non global one */
155 a = syma->binding == STB_GLOBAL;
156 b = symb->binding == STB_GLOBAL;
162 /* Prefer a symbol with less underscores */
163 a = prefix_underscores_count(syma->name);
164 b = prefix_underscores_count(symb->name);
170 /* Choose the symbol with the longest name */
171 na = strlen(syma->name);
172 nb = strlen(symb->name);
178 return arch__choose_best_symbol(syma, symb);
181 void symbols__fixup_duplicate(struct rb_root_cached *symbols)
184 struct symbol *curr, *next;
186 if (symbol_conf.allow_aliases)
189 nd = rb_first_cached(symbols);
192 curr = rb_entry(nd, struct symbol, rb_node);
194 nd = rb_next(&curr->rb_node);
195 next = rb_entry(nd, struct symbol, rb_node);
200 if (curr->start != next->start)
203 if (choose_best_symbol(curr, next) == SYMBOL_A) {
204 rb_erase_cached(&next->rb_node, symbols);
205 symbol__delete(next);
208 nd = rb_next(&curr->rb_node);
209 rb_erase_cached(&curr->rb_node, symbols);
210 symbol__delete(curr);
215 /* Update zero-sized symbols using the address of the next symbol */
216 void symbols__fixup_end(struct rb_root_cached *symbols, bool is_kallsyms)
218 struct rb_node *nd, *prevnd = rb_first_cached(symbols);
219 struct symbol *curr, *prev;
224 curr = rb_entry(prevnd, struct symbol, rb_node);
226 for (nd = rb_next(prevnd); nd; nd = rb_next(nd)) {
228 curr = rb_entry(nd, struct symbol, rb_node);
231 * On some architecture kernel text segment start is located at
232 * some low memory address, while modules are located at high
233 * memory addresses (or vice versa). The gap between end of
234 * kernel text segment and beginning of first module's text
235 * segment is very big. Therefore do not fill this gap and do
236 * not assign it to the kernel dso map (kallsyms).
238 * In kallsyms, it determines module symbols using '[' character
240 * ffffffffc1937000 T hdmi_driver_init [snd_hda_codec_hdmi]
242 if (prev->end == prev->start) {
243 /* Last kernel/module symbol mapped to end of page */
244 if (is_kallsyms && (!strchr(prev->name, '[') !=
245 !strchr(curr->name, '[')))
246 prev->end = roundup(prev->end + 4096, 4096);
248 prev->end = curr->start;
250 pr_debug4("%s sym:%s end:%#" PRIx64 "\n",
251 __func__, prev->name, prev->end);
256 if (curr->end == curr->start)
257 curr->end = roundup(curr->start, 4096) + 4096;
260 void maps__fixup_end(struct maps *maps)
262 struct map *prev = NULL, *curr;
264 down_write(&maps->lock);
266 maps__for_each_entry(maps, curr) {
267 if (prev != NULL && !prev->end)
268 prev->end = curr->start;
274 * We still haven't the actual symbols, so guess the
275 * last map final address.
277 if (curr && !curr->end)
280 up_write(&maps->lock);
283 struct symbol *symbol__new(u64 start, u64 len, u8 binding, u8 type, const char *name)
285 size_t namelen = strlen(name) + 1;
286 struct symbol *sym = calloc(1, (symbol_conf.priv_size +
287 sizeof(*sym) + namelen));
291 if (symbol_conf.priv_size) {
292 if (symbol_conf.init_annotation) {
293 struct annotation *notes = (void *)sym;
294 annotation__init(notes);
296 sym = ((void *)sym) + symbol_conf.priv_size;
300 sym->end = len ? start + len : start;
302 sym->binding = binding;
303 sym->namelen = namelen - 1;
305 pr_debug4("%s: %s %#" PRIx64 "-%#" PRIx64 "\n",
306 __func__, name, start, sym->end);
307 memcpy(sym->name, name, namelen);
312 void symbol__delete(struct symbol *sym)
314 if (symbol_conf.priv_size) {
315 if (symbol_conf.init_annotation) {
316 struct annotation *notes = symbol__annotation(sym);
318 annotation__exit(notes);
321 free(((void *)sym) - symbol_conf.priv_size);
324 void symbols__delete(struct rb_root_cached *symbols)
327 struct rb_node *next = rb_first_cached(symbols);
330 pos = rb_entry(next, struct symbol, rb_node);
331 next = rb_next(&pos->rb_node);
332 rb_erase_cached(&pos->rb_node, symbols);
337 void __symbols__insert(struct rb_root_cached *symbols,
338 struct symbol *sym, bool kernel)
340 struct rb_node **p = &symbols->rb_root.rb_node;
341 struct rb_node *parent = NULL;
342 const u64 ip = sym->start;
344 bool leftmost = true;
347 const char *name = sym->name;
349 * ppc64 uses function descriptors and appends a '.' to the
350 * start of every instruction address. Remove it.
354 sym->idle = symbol__is_idle(name);
359 s = rb_entry(parent, struct symbol, rb_node);
367 rb_link_node(&sym->rb_node, parent, p);
368 rb_insert_color_cached(&sym->rb_node, symbols, leftmost);
371 void symbols__insert(struct rb_root_cached *symbols, struct symbol *sym)
373 __symbols__insert(symbols, sym, false);
376 static struct symbol *symbols__find(struct rb_root_cached *symbols, u64 ip)
383 n = symbols->rb_root.rb_node;
386 struct symbol *s = rb_entry(n, struct symbol, rb_node);
390 else if (ip > s->end || (ip == s->end && ip != s->start))
399 static struct symbol *symbols__first(struct rb_root_cached *symbols)
401 struct rb_node *n = rb_first_cached(symbols);
404 return rb_entry(n, struct symbol, rb_node);
409 static struct symbol *symbols__last(struct rb_root_cached *symbols)
411 struct rb_node *n = rb_last(&symbols->rb_root);
414 return rb_entry(n, struct symbol, rb_node);
419 static struct symbol *symbols__next(struct symbol *sym)
421 struct rb_node *n = rb_next(&sym->rb_node);
424 return rb_entry(n, struct symbol, rb_node);
429 static void symbols__insert_by_name(struct rb_root_cached *symbols, struct symbol *sym)
431 struct rb_node **p = &symbols->rb_root.rb_node;
432 struct rb_node *parent = NULL;
433 struct symbol_name_rb_node *symn, *s;
434 bool leftmost = true;
436 symn = container_of(sym, struct symbol_name_rb_node, sym);
440 s = rb_entry(parent, struct symbol_name_rb_node, rb_node);
441 if (strcmp(sym->name, s->sym.name) < 0)
448 rb_link_node(&symn->rb_node, parent, p);
449 rb_insert_color_cached(&symn->rb_node, symbols, leftmost);
452 static void symbols__sort_by_name(struct rb_root_cached *symbols,
453 struct rb_root_cached *source)
457 for (nd = rb_first_cached(source); nd; nd = rb_next(nd)) {
458 struct symbol *pos = rb_entry(nd, struct symbol, rb_node);
459 symbols__insert_by_name(symbols, pos);
463 int symbol__match_symbol_name(const char *name, const char *str,
464 enum symbol_tag_include includes)
466 const char *versioning;
468 if (includes == SYMBOL_TAG_INCLUDE__DEFAULT_ONLY &&
469 (versioning = strstr(name, "@@"))) {
470 int len = strlen(str);
472 if (len < versioning - name)
473 len = versioning - name;
475 return arch__compare_symbol_names_n(name, str, len);
477 return arch__compare_symbol_names(name, str);
480 static struct symbol *symbols__find_by_name(struct rb_root_cached *symbols,
482 enum symbol_tag_include includes)
485 struct symbol_name_rb_node *s = NULL;
490 n = symbols->rb_root.rb_node;
495 s = rb_entry(n, struct symbol_name_rb_node, rb_node);
496 cmp = symbol__match_symbol_name(s->sym.name, name, includes);
509 if (includes != SYMBOL_TAG_INCLUDE__DEFAULT_ONLY)
510 /* return first symbol that has same name (if any) */
511 for (n = rb_prev(n); n; n = rb_prev(n)) {
512 struct symbol_name_rb_node *tmp;
514 tmp = rb_entry(n, struct symbol_name_rb_node, rb_node);
515 if (arch__compare_symbol_names(tmp->sym.name, s->sym.name))
524 void dso__reset_find_symbol_cache(struct dso *dso)
526 dso->last_find_result.addr = 0;
527 dso->last_find_result.symbol = NULL;
530 void dso__insert_symbol(struct dso *dso, struct symbol *sym)
532 __symbols__insert(&dso->symbols, sym, dso->kernel);
534 /* update the symbol cache if necessary */
535 if (dso->last_find_result.addr >= sym->start &&
536 (dso->last_find_result.addr < sym->end ||
537 sym->start == sym->end)) {
538 dso->last_find_result.symbol = sym;
542 void dso__delete_symbol(struct dso *dso, struct symbol *sym)
544 rb_erase_cached(&sym->rb_node, &dso->symbols);
546 dso__reset_find_symbol_cache(dso);
549 struct symbol *dso__find_symbol(struct dso *dso, u64 addr)
551 if (dso->last_find_result.addr != addr || dso->last_find_result.symbol == NULL) {
552 dso->last_find_result.addr = addr;
553 dso->last_find_result.symbol = symbols__find(&dso->symbols, addr);
556 return dso->last_find_result.symbol;
559 struct symbol *dso__first_symbol(struct dso *dso)
561 return symbols__first(&dso->symbols);
564 struct symbol *dso__last_symbol(struct dso *dso)
566 return symbols__last(&dso->symbols);
569 struct symbol *dso__next_symbol(struct symbol *sym)
571 return symbols__next(sym);
574 struct symbol *symbol__next_by_name(struct symbol *sym)
576 struct symbol_name_rb_node *s = container_of(sym, struct symbol_name_rb_node, sym);
577 struct rb_node *n = rb_next(&s->rb_node);
579 return n ? &rb_entry(n, struct symbol_name_rb_node, rb_node)->sym : NULL;
583 * Returns first symbol that matched with @name.
585 struct symbol *dso__find_symbol_by_name(struct dso *dso, const char *name)
587 struct symbol *s = symbols__find_by_name(&dso->symbol_names, name,
588 SYMBOL_TAG_INCLUDE__NONE);
590 s = symbols__find_by_name(&dso->symbol_names, name,
591 SYMBOL_TAG_INCLUDE__DEFAULT_ONLY);
595 void dso__sort_by_name(struct dso *dso)
597 dso__set_sorted_by_name(dso);
598 return symbols__sort_by_name(&dso->symbol_names, &dso->symbols);
602 * While we find nice hex chars, build a long_val.
603 * Return number of chars processed.
605 static int hex2u64(const char *ptr, u64 *long_val)
609 *long_val = strtoull(ptr, &p, 16);
615 int modules__parse(const char *filename, void *arg,
616 int (*process_module)(void *arg, const char *name,
617 u64 start, u64 size))
624 file = fopen(filename, "r");
634 line_len = getline(&line, &n, file);
647 line[--line_len] = '\0'; /* \n */
649 sep = strrchr(line, 'x');
653 hex2u64(sep + 1, &start);
655 sep = strchr(line, ' ');
661 scnprintf(name, sizeof(name), "[%s]", line);
663 size = strtoul(sep + 1, &endptr, 0);
664 if (*endptr != ' ' && *endptr != '\t')
667 err = process_module(arg, name, start, size);
678 * These are symbols in the kernel image, so make sure that
679 * sym is from a kernel DSO.
681 static bool symbol__is_idle(const char *name)
683 const char * const idle_symbols[] = {
684 "acpi_idle_do_entry",
685 "acpi_processor_ffh_cstate_enter",
696 "mwait_idle_with_hints",
697 "mwait_idle_with_hints.constprop.0",
699 "ppc64_runlatch_off",
700 "pseries_dedicated_idle_sleep",
706 static struct strlist *idle_symbols_list;
708 if (idle_symbols_list)
709 return strlist__has_entry(idle_symbols_list, name);
711 idle_symbols_list = strlist__new(NULL, NULL);
713 for (i = 0; idle_symbols[i]; i++)
714 strlist__add(idle_symbols_list, idle_symbols[i]);
716 return strlist__has_entry(idle_symbols_list, name);
719 static int map__process_kallsym_symbol(void *arg, const char *name,
720 char type, u64 start)
723 struct dso *dso = arg;
724 struct rb_root_cached *root = &dso->symbols;
726 if (!symbol_type__filter(type))
729 /* Ignore local symbols for ARM modules */
734 * module symbols are not sorted so we add all
735 * symbols, setting length to 0, and rely on
736 * symbols__fixup_end() to fix it up.
738 sym = symbol__new(start, 0, kallsyms2elf_binding(type), kallsyms2elf_type(type), name);
742 * We will pass the symbols to the filter later, in
743 * map__split_kallsyms, when we have split the maps per module
745 __symbols__insert(root, sym, !strchr(name, '['));
751 * Loads the function entries in /proc/kallsyms into kernel_map->dso,
752 * so that we can in the next step set the symbol ->end address and then
753 * call kernel_maps__split_kallsyms.
755 static int dso__load_all_kallsyms(struct dso *dso, const char *filename)
757 return kallsyms__parse(filename, dso, map__process_kallsym_symbol);
760 static int maps__split_kallsyms_for_kcore(struct maps *kmaps, struct dso *dso)
762 struct map *curr_map;
765 struct rb_root_cached old_root = dso->symbols;
766 struct rb_root_cached *root = &dso->symbols;
767 struct rb_node *next = rb_first_cached(root);
772 *root = RB_ROOT_CACHED;
777 pos = rb_entry(next, struct symbol, rb_node);
778 next = rb_next(&pos->rb_node);
780 rb_erase_cached(&pos->rb_node, &old_root);
781 RB_CLEAR_NODE(&pos->rb_node);
782 module = strchr(pos->name, '\t');
786 curr_map = maps__find(kmaps, pos->start);
793 pos->start -= curr_map->start - curr_map->pgoff;
794 if (pos->end > curr_map->end)
795 pos->end = curr_map->end;
797 pos->end -= curr_map->start - curr_map->pgoff;
798 symbols__insert(&curr_map->dso->symbols, pos);
802 /* Symbols have been adjusted */
803 dso->adjust_symbols = 1;
809 * Split the symbols into maps, making sure there are no overlaps, i.e. the
810 * kernel range is broken in several maps, named [kernel].N, as we don't have
811 * the original ELF section names vmlinux have.
813 static int maps__split_kallsyms(struct maps *kmaps, struct dso *dso, u64 delta,
814 struct map *initial_map)
816 struct machine *machine;
817 struct map *curr_map = initial_map;
819 int count = 0, moved = 0;
820 struct rb_root_cached *root = &dso->symbols;
821 struct rb_node *next = rb_first_cached(root);
822 int kernel_range = 0;
828 machine = kmaps->machine;
830 x86_64 = machine__is(machine, "x86_64");
835 pos = rb_entry(next, struct symbol, rb_node);
836 next = rb_next(&pos->rb_node);
838 module = strchr(pos->name, '\t');
840 if (!symbol_conf.use_modules)
845 if (strcmp(curr_map->dso->short_name, module)) {
846 if (curr_map != initial_map &&
847 dso->kernel == DSO_SPACE__KERNEL_GUEST &&
848 machine__is_default_guest(machine)) {
850 * We assume all symbols of a module are
851 * continuous in * kallsyms, so curr_map
852 * points to a module and all its
853 * symbols are in its kmap. Mark it as
856 dso__set_loaded(curr_map->dso);
859 curr_map = maps__find_by_name(kmaps, module);
860 if (curr_map == NULL) {
861 pr_debug("%s/proc/{kallsyms,modules} "
862 "inconsistency while looking "
863 "for \"%s\" module!\n",
864 machine->root_dir, module);
865 curr_map = initial_map;
869 if (curr_map->dso->loaded &&
870 !machine__is_default_guest(machine))
874 * So that we look just like we get from .ko files,
875 * i.e. not prelinked, relative to initial_map->start.
877 pos->start = curr_map->map_ip(curr_map, pos->start);
878 pos->end = curr_map->map_ip(curr_map, pos->end);
879 } else if (x86_64 && is_entry_trampoline(pos->name)) {
881 * These symbols are not needed anymore since the
882 * trampoline maps refer to the text section and it's
883 * symbols instead. Avoid having to deal with
884 * relocations, and the assumption that the first symbol
885 * is the start of kernel text, by simply removing the
886 * symbols at this point.
889 } else if (curr_map != initial_map) {
890 char dso_name[PATH_MAX];
894 /* Kernel was relocated at boot time */
900 curr_map = initial_map;
904 if (dso->kernel == DSO_SPACE__KERNEL_GUEST)
905 snprintf(dso_name, sizeof(dso_name),
909 snprintf(dso_name, sizeof(dso_name),
913 ndso = dso__new(dso_name);
917 ndso->kernel = dso->kernel;
919 curr_map = map__new2(pos->start, ndso);
920 if (curr_map == NULL) {
925 curr_map->map_ip = curr_map->unmap_ip = identity__map_ip;
926 maps__insert(kmaps, curr_map);
929 /* Kernel was relocated at boot time */
934 if (curr_map != initial_map) {
935 rb_erase_cached(&pos->rb_node, root);
936 symbols__insert(&curr_map->dso->symbols, pos);
943 rb_erase_cached(&pos->rb_node, root);
947 if (curr_map != initial_map &&
948 dso->kernel == DSO_SPACE__KERNEL_GUEST &&
949 machine__is_default_guest(kmaps->machine)) {
950 dso__set_loaded(curr_map->dso);
953 return count + moved;
956 bool symbol__restricted_filename(const char *filename,
957 const char *restricted_filename)
959 bool restricted = false;
961 if (symbol_conf.kptr_restrict) {
962 char *r = realpath(filename, NULL);
965 restricted = strcmp(r, restricted_filename) == 0;
975 struct rb_node rb_node;
980 static void add_module(struct module_info *mi, struct rb_root *modules)
982 struct rb_node **p = &modules->rb_node;
983 struct rb_node *parent = NULL;
984 struct module_info *m;
988 m = rb_entry(parent, struct module_info, rb_node);
989 if (strcmp(mi->name, m->name) < 0)
994 rb_link_node(&mi->rb_node, parent, p);
995 rb_insert_color(&mi->rb_node, modules);
998 static void delete_modules(struct rb_root *modules)
1000 struct module_info *mi;
1001 struct rb_node *next = rb_first(modules);
1004 mi = rb_entry(next, struct module_info, rb_node);
1005 next = rb_next(&mi->rb_node);
1006 rb_erase(&mi->rb_node, modules);
1012 static struct module_info *find_module(const char *name,
1013 struct rb_root *modules)
1015 struct rb_node *n = modules->rb_node;
1018 struct module_info *m;
1021 m = rb_entry(n, struct module_info, rb_node);
1022 cmp = strcmp(name, m->name);
1034 static int __read_proc_modules(void *arg, const char *name, u64 start,
1035 u64 size __maybe_unused)
1037 struct rb_root *modules = arg;
1038 struct module_info *mi;
1040 mi = zalloc(sizeof(struct module_info));
1044 mi->name = strdup(name);
1052 add_module(mi, modules);
1057 static int read_proc_modules(const char *filename, struct rb_root *modules)
1059 if (symbol__restricted_filename(filename, "/proc/modules"))
1062 if (modules__parse(filename, modules, __read_proc_modules)) {
1063 delete_modules(modules);
1070 int compare_proc_modules(const char *from, const char *to)
1072 struct rb_root from_modules = RB_ROOT;
1073 struct rb_root to_modules = RB_ROOT;
1074 struct rb_node *from_node, *to_node;
1075 struct module_info *from_m, *to_m;
1078 if (read_proc_modules(from, &from_modules))
1081 if (read_proc_modules(to, &to_modules))
1082 goto out_delete_from;
1084 from_node = rb_first(&from_modules);
1085 to_node = rb_first(&to_modules);
1090 from_m = rb_entry(from_node, struct module_info, rb_node);
1091 to_m = rb_entry(to_node, struct module_info, rb_node);
1093 if (from_m->start != to_m->start ||
1094 strcmp(from_m->name, to_m->name))
1097 from_node = rb_next(from_node);
1098 to_node = rb_next(to_node);
1101 if (!from_node && !to_node)
1104 delete_modules(&to_modules);
1106 delete_modules(&from_modules);
1111 static int do_validate_kcore_modules(const char *filename, struct maps *kmaps)
1113 struct rb_root modules = RB_ROOT;
1114 struct map *old_map;
1117 err = read_proc_modules(filename, &modules);
1121 maps__for_each_entry(kmaps, old_map) {
1122 struct module_info *mi;
1124 if (!__map__is_kmodule(old_map)) {
1128 /* Module must be in memory at the same address */
1129 mi = find_module(old_map->dso->short_name, &modules);
1130 if (!mi || mi->start != old_map->start) {
1136 delete_modules(&modules);
1141 * If kallsyms is referenced by name then we look for filename in the same
1144 static bool filename_from_kallsyms_filename(char *filename,
1145 const char *base_name,
1146 const char *kallsyms_filename)
1150 strcpy(filename, kallsyms_filename);
1151 name = strrchr(filename, '/');
1157 if (!strcmp(name, "kallsyms")) {
1158 strcpy(name, base_name);
1165 static int validate_kcore_modules(const char *kallsyms_filename,
1168 struct maps *kmaps = map__kmaps(map);
1169 char modules_filename[PATH_MAX];
1174 if (!filename_from_kallsyms_filename(modules_filename, "modules",
1178 if (do_validate_kcore_modules(modules_filename, kmaps))
1184 static int validate_kcore_addresses(const char *kallsyms_filename,
1187 struct kmap *kmap = map__kmap(map);
1192 if (kmap->ref_reloc_sym && kmap->ref_reloc_sym->name) {
1195 if (kallsyms__get_function_start(kallsyms_filename,
1196 kmap->ref_reloc_sym->name, &start))
1198 if (start != kmap->ref_reloc_sym->addr)
1202 return validate_kcore_modules(kallsyms_filename, map);
1205 struct kcore_mapfn_data {
1207 struct list_head maps;
1210 static int kcore_mapfn(u64 start, u64 len, u64 pgoff, void *data)
1212 struct kcore_mapfn_data *md = data;
1215 map = map__new2(start, md->dso);
1219 map->end = map->start + len;
1222 list_add(&map->node, &md->maps);
1228 * Merges map into maps by splitting the new map within the existing map
1231 int maps__merge_in(struct maps *kmaps, struct map *new_map)
1233 struct map *old_map;
1236 maps__for_each_entry(kmaps, old_map) {
1237 /* no overload with this one */
1238 if (new_map->end < old_map->start ||
1239 new_map->start >= old_map->end)
1242 if (new_map->start < old_map->start) {
1247 if (new_map->end < old_map->end) {
1249 * |new......| -> |new..|
1250 * |old....| -> |old....|
1252 new_map->end = old_map->start;
1255 * |new.............| -> |new..| |new..|
1256 * |old....| -> |old....|
1258 struct map *m = map__clone(new_map);
1263 m->end = old_map->start;
1264 list_add_tail(&m->node, &merged);
1265 new_map->pgoff += old_map->end - new_map->start;
1266 new_map->start = old_map->end;
1273 if (new_map->end < old_map->end) {
1276 * |old.........| -> |old.........|
1283 * |new......| -> |new...|
1284 * |old....| -> |old....|
1286 new_map->pgoff += old_map->end - new_map->start;
1287 new_map->start = old_map->end;
1292 while (!list_empty(&merged)) {
1293 old_map = list_entry(merged.next, struct map, node);
1294 list_del_init(&old_map->node);
1295 maps__insert(kmaps, old_map);
1300 maps__insert(kmaps, new_map);
1306 static int dso__load_kcore(struct dso *dso, struct map *map,
1307 const char *kallsyms_filename)
1309 struct maps *kmaps = map__kmaps(map);
1310 struct kcore_mapfn_data md;
1311 struct map *old_map, *new_map, *replacement_map = NULL, *next;
1312 struct machine *machine;
1315 char kcore_filename[PATH_MAX];
1321 machine = kmaps->machine;
1323 /* This function requires that the map is the kernel map */
1324 if (!__map__is_kernel(map))
1327 if (!filename_from_kallsyms_filename(kcore_filename, "kcore",
1331 /* Modules and kernel must be present at their original addresses */
1332 if (validate_kcore_addresses(kallsyms_filename, map))
1336 INIT_LIST_HEAD(&md.maps);
1338 fd = open(kcore_filename, O_RDONLY);
1340 pr_debug("Failed to open %s. Note /proc/kcore requires CAP_SYS_RAWIO capability to access.\n",
1345 /* Read new maps into temporary lists */
1346 err = file__read_maps(fd, map->prot & PROT_EXEC, kcore_mapfn, &md,
1350 dso->is_64_bit = is_64_bit;
1352 if (list_empty(&md.maps)) {
1357 /* Remove old maps */
1358 maps__for_each_entry_safe(kmaps, old_map, next) {
1360 * We need to preserve eBPF maps even if they are
1361 * covered by kcore, because we need to access
1362 * eBPF dso for source data.
1364 if (old_map != map && !__map__is_bpf_prog(old_map))
1365 maps__remove(kmaps, old_map);
1367 machine->trampolines_mapped = false;
1369 /* Find the kernel map using the '_stext' symbol */
1370 if (!kallsyms__get_function_start(kallsyms_filename, "_stext", &stext)) {
1371 list_for_each_entry(new_map, &md.maps, node) {
1372 if (stext >= new_map->start && stext < new_map->end) {
1373 replacement_map = new_map;
1379 if (!replacement_map)
1380 replacement_map = list_entry(md.maps.next, struct map, node);
1383 while (!list_empty(&md.maps)) {
1384 new_map = list_entry(md.maps.next, struct map, node);
1385 list_del_init(&new_map->node);
1386 if (new_map == replacement_map) {
1387 map->start = new_map->start;
1388 map->end = new_map->end;
1389 map->pgoff = new_map->pgoff;
1390 map->map_ip = new_map->map_ip;
1391 map->unmap_ip = new_map->unmap_ip;
1392 /* Ensure maps are correctly ordered */
1394 maps__remove(kmaps, map);
1395 maps__insert(kmaps, map);
1400 * Merge kcore map into existing maps,
1401 * and ensure that current maps (eBPF)
1404 if (maps__merge_in(kmaps, new_map))
1409 if (machine__is(machine, "x86_64")) {
1413 * If one of the corresponding symbols is there, assume the
1414 * entry trampoline maps are too.
1416 if (!kallsyms__get_function_start(kallsyms_filename,
1417 ENTRY_TRAMPOLINE_NAME,
1419 machine->trampolines_mapped = true;
1423 * Set the data type and long name so that kcore can be read via
1424 * dso__data_read_addr().
1426 if (dso->kernel == DSO_SPACE__KERNEL_GUEST)
1427 dso->binary_type = DSO_BINARY_TYPE__GUEST_KCORE;
1429 dso->binary_type = DSO_BINARY_TYPE__KCORE;
1430 dso__set_long_name(dso, strdup(kcore_filename), true);
1434 if (map->prot & PROT_EXEC)
1435 pr_debug("Using %s for kernel object code\n", kcore_filename);
1437 pr_debug("Using %s for kernel data\n", kcore_filename);
1442 while (!list_empty(&md.maps)) {
1443 map = list_entry(md.maps.next, struct map, node);
1444 list_del_init(&map->node);
1452 * If the kernel is relocated at boot time, kallsyms won't match. Compute the
1453 * delta based on the relocation reference symbol.
1455 static int kallsyms__delta(struct kmap *kmap, const char *filename, u64 *delta)
1459 if (!kmap->ref_reloc_sym || !kmap->ref_reloc_sym->name)
1462 if (kallsyms__get_function_start(filename, kmap->ref_reloc_sym->name, &addr))
1465 *delta = addr - kmap->ref_reloc_sym->addr;
1469 int __dso__load_kallsyms(struct dso *dso, const char *filename,
1470 struct map *map, bool no_kcore)
1472 struct kmap *kmap = map__kmap(map);
1475 if (symbol__restricted_filename(filename, "/proc/kallsyms"))
1478 if (!kmap || !kmap->kmaps)
1481 if (dso__load_all_kallsyms(dso, filename) < 0)
1484 if (kallsyms__delta(kmap, filename, &delta))
1487 symbols__fixup_end(&dso->symbols, true);
1488 symbols__fixup_duplicate(&dso->symbols);
1490 if (dso->kernel == DSO_SPACE__KERNEL_GUEST)
1491 dso->symtab_type = DSO_BINARY_TYPE__GUEST_KALLSYMS;
1493 dso->symtab_type = DSO_BINARY_TYPE__KALLSYMS;
1495 if (!no_kcore && !dso__load_kcore(dso, map, filename))
1496 return maps__split_kallsyms_for_kcore(kmap->kmaps, dso);
1498 return maps__split_kallsyms(kmap->kmaps, dso, delta, map);
1501 int dso__load_kallsyms(struct dso *dso, const char *filename,
1504 return __dso__load_kallsyms(dso, filename, map, false);
1507 static int dso__load_perf_map(const char *map_path, struct dso *dso)
1514 file = fopen(map_path, "r");
1518 while (!feof(file)) {
1523 line_len = getline(&line, &n, file);
1530 line[--line_len] = '\0'; /* \n */
1532 len = hex2u64(line, &start);
1535 if (len + 2 >= line_len)
1538 len += hex2u64(line + len, &size);
1541 if (len + 2 >= line_len)
1544 sym = symbol__new(start, size, STB_GLOBAL, STT_FUNC, line + len);
1547 goto out_delete_line;
1549 symbols__insert(&dso->symbols, sym);
1564 #ifdef HAVE_LIBBFD_SUPPORT
1565 #define PACKAGE 'perf'
1568 static int bfd_symbols__cmpvalue(const void *a, const void *b)
1570 const asymbol *as = *(const asymbol **)a, *bs = *(const asymbol **)b;
1572 if (bfd_asymbol_value(as) != bfd_asymbol_value(bs))
1573 return bfd_asymbol_value(as) - bfd_asymbol_value(bs);
1575 return bfd_asymbol_name(as)[0] - bfd_asymbol_name(bs)[0];
1578 static int bfd2elf_binding(asymbol *symbol)
1580 if (symbol->flags & BSF_WEAK)
1582 if (symbol->flags & BSF_GLOBAL)
1584 if (symbol->flags & BSF_LOCAL)
1589 int dso__load_bfd_symbols(struct dso *dso, const char *debugfile)
1592 long symbols_size, symbols_count, i;
1594 asymbol **symbols, *sym;
1595 struct symbol *symbol;
1599 abfd = bfd_openr(debugfile, NULL);
1603 if (!bfd_check_format(abfd, bfd_object)) {
1604 pr_debug2("%s: cannot read %s bfd file.\n", __func__,
1609 if (bfd_get_flavour(abfd) == bfd_target_elf_flavour)
1612 symbols_size = bfd_get_symtab_upper_bound(abfd);
1613 if (symbols_size == 0) {
1618 if (symbols_size < 0)
1621 symbols = malloc(symbols_size);
1625 symbols_count = bfd_canonicalize_symtab(abfd, symbols);
1626 if (symbols_count < 0)
1629 section = bfd_get_section_by_name(abfd, ".text");
1631 for (i = 0; i < symbols_count; ++i) {
1632 if (!strcmp(bfd_asymbol_name(symbols[i]), "__ImageBase") ||
1633 !strcmp(bfd_asymbol_name(symbols[i]), "__image_base__"))
1636 if (i < symbols_count) {
1637 /* PE symbols can only have 4 bytes, so use .text high bits */
1638 dso->text_offset = section->vma - (u32)section->vma;
1639 dso->text_offset += (u32)bfd_asymbol_value(symbols[i]);
1641 dso->text_offset = section->vma - section->filepos;
1645 qsort(symbols, symbols_count, sizeof(asymbol *), bfd_symbols__cmpvalue);
1647 #ifdef bfd_get_section
1648 #define bfd_asymbol_section bfd_get_section
1650 for (i = 0; i < symbols_count; ++i) {
1652 section = bfd_asymbol_section(sym);
1653 if (bfd2elf_binding(sym) < 0)
1656 while (i + 1 < symbols_count &&
1657 bfd_asymbol_section(symbols[i + 1]) == section &&
1658 bfd2elf_binding(symbols[i + 1]) < 0)
1661 if (i + 1 < symbols_count &&
1662 bfd_asymbol_section(symbols[i + 1]) == section)
1663 len = symbols[i + 1]->value - sym->value;
1665 len = section->size - sym->value;
1667 start = bfd_asymbol_value(sym) - dso->text_offset;
1668 symbol = symbol__new(start, len, bfd2elf_binding(sym), STT_FUNC,
1669 bfd_asymbol_name(sym));
1673 symbols__insert(&dso->symbols, symbol);
1675 #ifdef bfd_get_section
1676 #undef bfd_asymbol_section
1679 symbols__fixup_end(&dso->symbols, false);
1680 symbols__fixup_duplicate(&dso->symbols);
1681 dso->adjust_symbols = 1;
1692 static bool dso__is_compatible_symtab_type(struct dso *dso, bool kmod,
1693 enum dso_binary_type type)
1696 case DSO_BINARY_TYPE__JAVA_JIT:
1697 case DSO_BINARY_TYPE__DEBUGLINK:
1698 case DSO_BINARY_TYPE__SYSTEM_PATH_DSO:
1699 case DSO_BINARY_TYPE__FEDORA_DEBUGINFO:
1700 case DSO_BINARY_TYPE__UBUNTU_DEBUGINFO:
1701 case DSO_BINARY_TYPE__MIXEDUP_UBUNTU_DEBUGINFO:
1702 case DSO_BINARY_TYPE__BUILDID_DEBUGINFO:
1703 case DSO_BINARY_TYPE__OPENEMBEDDED_DEBUGINFO:
1704 return !kmod && dso->kernel == DSO_SPACE__USER;
1706 case DSO_BINARY_TYPE__KALLSYMS:
1707 case DSO_BINARY_TYPE__VMLINUX:
1708 case DSO_BINARY_TYPE__KCORE:
1709 return dso->kernel == DSO_SPACE__KERNEL;
1711 case DSO_BINARY_TYPE__GUEST_KALLSYMS:
1712 case DSO_BINARY_TYPE__GUEST_VMLINUX:
1713 case DSO_BINARY_TYPE__GUEST_KCORE:
1714 return dso->kernel == DSO_SPACE__KERNEL_GUEST;
1716 case DSO_BINARY_TYPE__GUEST_KMODULE:
1717 case DSO_BINARY_TYPE__GUEST_KMODULE_COMP:
1718 case DSO_BINARY_TYPE__SYSTEM_PATH_KMODULE:
1719 case DSO_BINARY_TYPE__SYSTEM_PATH_KMODULE_COMP:
1721 * kernel modules know their symtab type - it's set when
1722 * creating a module dso in machine__addnew_module_map().
1724 return kmod && dso->symtab_type == type;
1726 case DSO_BINARY_TYPE__BUILD_ID_CACHE:
1727 case DSO_BINARY_TYPE__BUILD_ID_CACHE_DEBUGINFO:
1730 case DSO_BINARY_TYPE__BPF_PROG_INFO:
1731 case DSO_BINARY_TYPE__BPF_IMAGE:
1732 case DSO_BINARY_TYPE__OOL:
1733 case DSO_BINARY_TYPE__NOT_FOUND:
1739 /* Checks for the existence of the perf-<pid>.map file in two different
1740 * locations. First, if the process is a separate mount namespace, check in
1741 * that namespace using the pid of the innermost pid namespace. If's not in a
1742 * namespace, or the file can't be found there, try in the mount namespace of
1743 * the tracing process using our view of its pid.
1745 static int dso__find_perf_map(char *filebuf, size_t bufsz,
1746 struct nsinfo **nsip)
1748 struct nscookie nsc;
1750 struct nsinfo *nnsi;
1755 if (nsinfo__need_setns(nsi)) {
1756 snprintf(filebuf, bufsz, "/tmp/perf-%d.map", nsinfo__nstgid(nsi));
1757 nsinfo__mountns_enter(nsi, &nsc);
1758 rc = access(filebuf, R_OK);
1759 nsinfo__mountns_exit(&nsc);
1764 nnsi = nsinfo__copy(nsi);
1768 nsinfo__clear_need_setns(nnsi);
1769 snprintf(filebuf, bufsz, "/tmp/perf-%d.map", nsinfo__tgid(nnsi));
1777 int dso__load(struct dso *dso, struct map *map)
1782 struct machine *machine = NULL;
1783 char *root_dir = (char *) "";
1785 struct symsrc ss_[2];
1786 struct symsrc *syms_ss = NULL, *runtime_ss = NULL;
1789 struct build_id bid;
1790 struct nscookie nsc;
1791 char newmapname[PATH_MAX];
1792 const char *map_path = dso->long_name;
1794 perfmap = strncmp(dso->name, "/tmp/perf-", 10) == 0;
1796 if (dso->nsinfo && (dso__find_perf_map(newmapname,
1797 sizeof(newmapname), &dso->nsinfo) == 0)) {
1798 map_path = newmapname;
1802 nsinfo__mountns_enter(dso->nsinfo, &nsc);
1803 pthread_mutex_lock(&dso->lock);
1805 /* check again under the dso->lock */
1806 if (dso__loaded(dso)) {
1811 kmod = dso->symtab_type == DSO_BINARY_TYPE__SYSTEM_PATH_KMODULE ||
1812 dso->symtab_type == DSO_BINARY_TYPE__SYSTEM_PATH_KMODULE_COMP ||
1813 dso->symtab_type == DSO_BINARY_TYPE__GUEST_KMODULE ||
1814 dso->symtab_type == DSO_BINARY_TYPE__GUEST_KMODULE_COMP;
1816 if (dso->kernel && !kmod) {
1817 if (dso->kernel == DSO_SPACE__KERNEL)
1818 ret = dso__load_kernel_sym(dso, map);
1819 else if (dso->kernel == DSO_SPACE__KERNEL_GUEST)
1820 ret = dso__load_guest_kernel_sym(dso, map);
1822 machine = map__kmaps(map)->machine;
1823 if (machine__is(machine, "x86_64"))
1824 machine__map_x86_64_entry_trampolines(machine, dso);
1828 dso->adjust_symbols = 0;
1831 ret = dso__load_perf_map(map_path, dso);
1832 dso->symtab_type = ret > 0 ? DSO_BINARY_TYPE__JAVA_JIT :
1833 DSO_BINARY_TYPE__NOT_FOUND;
1838 root_dir = machine->root_dir;
1840 name = malloc(PATH_MAX);
1845 * Read the build id if possible. This is required for
1846 * DSO_BINARY_TYPE__BUILDID_DEBUGINFO to work
1848 if (!dso->has_build_id &&
1849 is_regular_file(dso->long_name)) {
1850 __symbol__join_symfs(name, PATH_MAX, dso->long_name);
1851 if (filename__read_build_id(name, &bid) > 0)
1852 dso__set_build_id(dso, &bid);
1856 * Iterate over candidate debug images.
1857 * Keep track of "interesting" ones (those which have a symtab, dynsym,
1858 * and/or opd section) for processing.
1860 for (i = 0; i < DSO_BINARY_TYPE__SYMTAB_CNT; i++) {
1861 struct symsrc *ss = &ss_[ss_pos];
1862 bool next_slot = false;
1868 enum dso_binary_type symtab_type = binary_type_symtab[i];
1870 nsexit = (symtab_type == DSO_BINARY_TYPE__BUILD_ID_CACHE ||
1871 symtab_type == DSO_BINARY_TYPE__BUILD_ID_CACHE_DEBUGINFO);
1873 if (!dso__is_compatible_symtab_type(dso, kmod, symtab_type))
1876 if (dso__read_binary_type_filename(dso, symtab_type,
1877 root_dir, name, PATH_MAX))
1881 nsinfo__mountns_exit(&nsc);
1883 is_reg = is_regular_file(name);
1884 if (!is_reg && errno == ENOENT && dso->nsinfo) {
1885 char *new_name = filename_with_chroot(dso->nsinfo->pid,
1888 is_reg = is_regular_file(new_name);
1889 strlcpy(name, new_name, PATH_MAX);
1894 #ifdef HAVE_LIBBFD_SUPPORT
1896 bfdrc = dso__load_bfd_symbols(dso, name);
1898 if (is_reg && bfdrc < 0)
1899 sirc = symsrc__init(ss, dso, name, symtab_type);
1902 nsinfo__mountns_enter(dso->nsinfo, &nsc);
1909 if (!is_reg || sirc < 0)
1912 if (!syms_ss && symsrc__has_symtab(ss)) {
1915 if (!dso->symsrc_filename)
1916 dso->symsrc_filename = strdup(name);
1919 if (!runtime_ss && symsrc__possibly_runtime(ss)) {
1927 if (syms_ss && runtime_ss)
1930 symsrc__destroy(ss);
1935 if (!runtime_ss && !syms_ss)
1938 if (runtime_ss && !syms_ss) {
1939 syms_ss = runtime_ss;
1942 /* We'll have to hope for the best */
1943 if (!runtime_ss && syms_ss)
1944 runtime_ss = syms_ss;
1947 ret = dso__load_sym(dso, map, syms_ss, runtime_ss, kmod);
1954 nr_plt = dso__synthesize_plt_symbols(dso, runtime_ss);
1959 for (; ss_pos > 0; ss_pos--)
1960 symsrc__destroy(&ss_[ss_pos - 1]);
1963 if (ret < 0 && strstr(dso->name, " (deleted)") != NULL)
1966 dso__set_loaded(dso);
1967 pthread_mutex_unlock(&dso->lock);
1968 nsinfo__mountns_exit(&nsc);
1973 static int map__strcmp(const void *a, const void *b)
1975 const struct map *ma = *(const struct map **)a, *mb = *(const struct map **)b;
1976 return strcmp(ma->dso->short_name, mb->dso->short_name);
1979 static int map__strcmp_name(const void *name, const void *b)
1981 const struct map *map = *(const struct map **)b;
1982 return strcmp(name, map->dso->short_name);
1985 void __maps__sort_by_name(struct maps *maps)
1987 qsort(maps->maps_by_name, maps->nr_maps, sizeof(struct map *), map__strcmp);
1990 static int map__groups__sort_by_name_from_rbtree(struct maps *maps)
1993 struct map **maps_by_name = realloc(maps->maps_by_name, maps->nr_maps * sizeof(map));
1996 if (maps_by_name == NULL)
1999 maps->maps_by_name = maps_by_name;
2000 maps->nr_maps_allocated = maps->nr_maps;
2002 maps__for_each_entry(maps, map)
2003 maps_by_name[i++] = map;
2005 __maps__sort_by_name(maps);
2009 static struct map *__maps__find_by_name(struct maps *maps, const char *name)
2013 if (maps->maps_by_name == NULL &&
2014 map__groups__sort_by_name_from_rbtree(maps))
2017 mapp = bsearch(name, maps->maps_by_name, maps->nr_maps, sizeof(*mapp), map__strcmp_name);
2023 struct map *maps__find_by_name(struct maps *maps, const char *name)
2027 down_read(&maps->lock);
2029 if (maps->last_search_by_name && strcmp(maps->last_search_by_name->dso->short_name, name) == 0) {
2030 map = maps->last_search_by_name;
2034 * If we have maps->maps_by_name, then the name isn't in the rbtree,
2035 * as maps->maps_by_name mirrors the rbtree when lookups by name are
2038 map = __maps__find_by_name(maps, name);
2039 if (map || maps->maps_by_name != NULL)
2042 /* Fallback to traversing the rbtree... */
2043 maps__for_each_entry(maps, map)
2044 if (strcmp(map->dso->short_name, name) == 0) {
2045 maps->last_search_by_name = map;
2052 up_read(&maps->lock);
2056 int dso__load_vmlinux(struct dso *dso, struct map *map,
2057 const char *vmlinux, bool vmlinux_allocated)
2061 char symfs_vmlinux[PATH_MAX];
2062 enum dso_binary_type symtab_type;
2064 if (vmlinux[0] == '/')
2065 snprintf(symfs_vmlinux, sizeof(symfs_vmlinux), "%s", vmlinux);
2067 symbol__join_symfs(symfs_vmlinux, vmlinux);
2069 if (dso->kernel == DSO_SPACE__KERNEL_GUEST)
2070 symtab_type = DSO_BINARY_TYPE__GUEST_VMLINUX;
2072 symtab_type = DSO_BINARY_TYPE__VMLINUX;
2074 if (symsrc__init(&ss, dso, symfs_vmlinux, symtab_type))
2077 err = dso__load_sym(dso, map, &ss, &ss, 0);
2078 symsrc__destroy(&ss);
2081 if (dso->kernel == DSO_SPACE__KERNEL_GUEST)
2082 dso->binary_type = DSO_BINARY_TYPE__GUEST_VMLINUX;
2084 dso->binary_type = DSO_BINARY_TYPE__VMLINUX;
2085 dso__set_long_name(dso, vmlinux, vmlinux_allocated);
2086 dso__set_loaded(dso);
2087 pr_debug("Using %s for symbols\n", symfs_vmlinux);
2093 int dso__load_vmlinux_path(struct dso *dso, struct map *map)
2096 char *filename = NULL;
2098 pr_debug("Looking at the vmlinux_path (%d entries long)\n",
2099 vmlinux_path__nr_entries + 1);
2101 for (i = 0; i < vmlinux_path__nr_entries; ++i) {
2102 err = dso__load_vmlinux(dso, map, vmlinux_path[i], false);
2107 if (!symbol_conf.ignore_vmlinux_buildid)
2108 filename = dso__build_id_filename(dso, NULL, 0, false);
2109 if (filename != NULL) {
2110 err = dso__load_vmlinux(dso, map, filename, true);
2119 static bool visible_dir_filter(const char *name, struct dirent *d)
2121 if (d->d_type != DT_DIR)
2123 return lsdir_no_dot_filter(name, d);
2126 static int find_matching_kcore(struct map *map, char *dir, size_t dir_sz)
2128 char kallsyms_filename[PATH_MAX];
2130 struct strlist *dirs;
2131 struct str_node *nd;
2133 dirs = lsdir(dir, visible_dir_filter);
2137 strlist__for_each_entry(nd, dirs) {
2138 scnprintf(kallsyms_filename, sizeof(kallsyms_filename),
2139 "%s/%s/kallsyms", dir, nd->s);
2140 if (!validate_kcore_addresses(kallsyms_filename, map)) {
2141 strlcpy(dir, kallsyms_filename, dir_sz);
2147 strlist__delete(dirs);
2153 * Use open(O_RDONLY) to check readability directly instead of access(R_OK)
2154 * since access(R_OK) only checks with real UID/GID but open() use effective
2155 * UID/GID and actual capabilities (e.g. /proc/kcore requires CAP_SYS_RAWIO).
2157 static bool filename__readable(const char *file)
2159 int fd = open(file, O_RDONLY);
2166 static char *dso__find_kallsyms(struct dso *dso, struct map *map)
2168 struct build_id bid;
2169 char sbuild_id[SBUILD_ID_SIZE];
2170 bool is_host = false;
2171 char path[PATH_MAX];
2173 if (!dso->has_build_id) {
2175 * Last resort, if we don't have a build-id and couldn't find
2176 * any vmlinux file, try the running kernel kallsyms table.
2181 if (sysfs__read_build_id("/sys/kernel/notes", &bid) == 0)
2182 is_host = dso__build_id_equal(dso, &bid);
2184 /* Try a fast path for /proc/kallsyms if possible */
2187 * Do not check the build-id cache, unless we know we cannot use
2188 * /proc/kcore or module maps don't match to /proc/kallsyms.
2189 * To check readability of /proc/kcore, do not use access(R_OK)
2190 * since /proc/kcore requires CAP_SYS_RAWIO to read and access
2193 if (filename__readable("/proc/kcore") &&
2194 !validate_kcore_addresses("/proc/kallsyms", map))
2198 build_id__sprintf(&dso->bid, sbuild_id);
2200 /* Find kallsyms in build-id cache with kcore */
2201 scnprintf(path, sizeof(path), "%s/%s/%s",
2202 buildid_dir, DSO__NAME_KCORE, sbuild_id);
2204 if (!find_matching_kcore(map, path, sizeof(path)))
2205 return strdup(path);
2207 /* Use current /proc/kallsyms if possible */
2210 return strdup("/proc/kallsyms");
2213 /* Finally, find a cache of kallsyms */
2214 if (!build_id_cache__kallsyms_path(sbuild_id, path, sizeof(path))) {
2215 pr_err("No kallsyms or vmlinux with build-id %s was found\n",
2220 return strdup(path);
2223 static int dso__load_kernel_sym(struct dso *dso, struct map *map)
2226 const char *kallsyms_filename = NULL;
2227 char *kallsyms_allocated_filename = NULL;
2228 char *filename = NULL;
2231 * Step 1: if the user specified a kallsyms or vmlinux filename, use
2232 * it and only it, reporting errors to the user if it cannot be used.
2234 * For instance, try to analyse an ARM perf.data file _without_ a
2235 * build-id, or if the user specifies the wrong path to the right
2236 * vmlinux file, obviously we can't fallback to another vmlinux (a
2237 * x86_86 one, on the machine where analysis is being performed, say),
2238 * or worse, /proc/kallsyms.
2240 * If the specified file _has_ a build-id and there is a build-id
2241 * section in the perf.data file, we will still do the expected
2242 * validation in dso__load_vmlinux and will bail out if they don't
2245 if (symbol_conf.kallsyms_name != NULL) {
2246 kallsyms_filename = symbol_conf.kallsyms_name;
2250 if (!symbol_conf.ignore_vmlinux && symbol_conf.vmlinux_name != NULL) {
2251 return dso__load_vmlinux(dso, map, symbol_conf.vmlinux_name, false);
2255 * Before checking on common vmlinux locations, check if it's
2256 * stored as standard build id binary (not kallsyms) under
2259 if (!symbol_conf.ignore_vmlinux_buildid)
2260 filename = __dso__build_id_filename(dso, NULL, 0, false, false);
2261 if (filename != NULL) {
2262 err = dso__load_vmlinux(dso, map, filename, true);
2268 if (!symbol_conf.ignore_vmlinux && vmlinux_path != NULL) {
2269 err = dso__load_vmlinux_path(dso, map);
2274 /* do not try local files if a symfs was given */
2275 if (symbol_conf.symfs[0] != 0)
2278 kallsyms_allocated_filename = dso__find_kallsyms(dso, map);
2279 if (!kallsyms_allocated_filename)
2282 kallsyms_filename = kallsyms_allocated_filename;
2285 err = dso__load_kallsyms(dso, kallsyms_filename, map);
2287 pr_debug("Using %s for symbols\n", kallsyms_filename);
2288 free(kallsyms_allocated_filename);
2290 if (err > 0 && !dso__is_kcore(dso)) {
2291 dso->binary_type = DSO_BINARY_TYPE__KALLSYMS;
2292 dso__set_long_name(dso, DSO__NAME_KALLSYMS, false);
2293 map__fixup_start(map);
2294 map__fixup_end(map);
2300 static int dso__load_guest_kernel_sym(struct dso *dso, struct map *map)
2303 const char *kallsyms_filename = NULL;
2304 struct machine *machine = map__kmaps(map)->machine;
2305 char path[PATH_MAX];
2307 if (machine__is_default_guest(machine)) {
2309 * if the user specified a vmlinux filename, use it and only
2310 * it, reporting errors to the user if it cannot be used.
2311 * Or use file guest_kallsyms inputted by user on commandline
2313 if (symbol_conf.default_guest_vmlinux_name != NULL) {
2314 err = dso__load_vmlinux(dso, map,
2315 symbol_conf.default_guest_vmlinux_name,
2320 kallsyms_filename = symbol_conf.default_guest_kallsyms;
2321 if (!kallsyms_filename)
2324 sprintf(path, "%s/proc/kallsyms", machine->root_dir);
2325 kallsyms_filename = path;
2328 err = dso__load_kallsyms(dso, kallsyms_filename, map);
2330 pr_debug("Using %s for symbols\n", kallsyms_filename);
2331 if (err > 0 && !dso__is_kcore(dso)) {
2332 dso->binary_type = DSO_BINARY_TYPE__GUEST_KALLSYMS;
2333 dso__set_long_name(dso, machine->mmap_name, false);
2334 map__fixup_start(map);
2335 map__fixup_end(map);
2341 static void vmlinux_path__exit(void)
2343 while (--vmlinux_path__nr_entries >= 0)
2344 zfree(&vmlinux_path[vmlinux_path__nr_entries]);
2345 vmlinux_path__nr_entries = 0;
2347 zfree(&vmlinux_path);
2350 static const char * const vmlinux_paths[] = {
2355 static const char * const vmlinux_paths_upd[] = {
2357 "/usr/lib/debug/boot/vmlinux-%s",
2358 "/lib/modules/%s/build/vmlinux",
2359 "/usr/lib/debug/lib/modules/%s/vmlinux",
2360 "/usr/lib/debug/boot/vmlinux-%s.debug"
2363 static int vmlinux_path__add(const char *new_entry)
2365 vmlinux_path[vmlinux_path__nr_entries] = strdup(new_entry);
2366 if (vmlinux_path[vmlinux_path__nr_entries] == NULL)
2368 ++vmlinux_path__nr_entries;
2373 static int vmlinux_path__init(struct perf_env *env)
2377 char *kernel_version;
2380 vmlinux_path = malloc(sizeof(char *) * (ARRAY_SIZE(vmlinux_paths) +
2381 ARRAY_SIZE(vmlinux_paths_upd)));
2382 if (vmlinux_path == NULL)
2385 for (i = 0; i < ARRAY_SIZE(vmlinux_paths); i++)
2386 if (vmlinux_path__add(vmlinux_paths[i]) < 0)
2389 /* only try kernel version if no symfs was given */
2390 if (symbol_conf.symfs[0] != 0)
2394 kernel_version = env->os_release;
2396 if (uname(&uts) < 0)
2399 kernel_version = uts.release;
2402 for (i = 0; i < ARRAY_SIZE(vmlinux_paths_upd); i++) {
2403 snprintf(bf, sizeof(bf), vmlinux_paths_upd[i], kernel_version);
2404 if (vmlinux_path__add(bf) < 0)
2411 vmlinux_path__exit();
2415 int setup_list(struct strlist **list, const char *list_str,
2416 const char *list_name)
2418 if (list_str == NULL)
2421 *list = strlist__new(list_str, NULL);
2423 pr_err("problems parsing %s list\n", list_name);
2427 symbol_conf.has_filter = true;
2431 int setup_intlist(struct intlist **list, const char *list_str,
2432 const char *list_name)
2434 if (list_str == NULL)
2437 *list = intlist__new(list_str);
2439 pr_err("problems parsing %s list\n", list_name);
2445 static int setup_addrlist(struct intlist **addr_list, struct strlist *sym_list)
2447 struct str_node *pos, *tmp;
2453 *addr_list = intlist__new(NULL);
2457 strlist__for_each_entry_safe(pos, tmp, sym_list) {
2459 val = strtoul(pos->s, &sep, 16);
2460 if (errno || (sep == pos->s))
2464 end = pos->s + strlen(pos->s) - 1;
2465 while (end >= sep && isspace(*end))
2472 err = intlist__add(*addr_list, val);
2476 strlist__remove(sym_list, pos);
2481 intlist__delete(*addr_list);
2488 static bool symbol__read_kptr_restrict(void)
2491 FILE *fp = fopen("/proc/sys/kernel/kptr_restrict", "r");
2496 if (fgets(line, sizeof(line), fp) != NULL)
2497 value = perf_cap__capable(CAP_SYSLOG) ?
2504 /* Per kernel/kallsyms.c:
2505 * we also restrict when perf_event_paranoid > 1 w/o CAP_SYSLOG
2507 if (perf_event_paranoid() > 1 && !perf_cap__capable(CAP_SYSLOG))
2513 int symbol__annotation_init(void)
2515 if (symbol_conf.init_annotation)
2518 if (symbol_conf.initialized) {
2519 pr_err("Annotation needs to be init before symbol__init()\n");
2523 symbol_conf.priv_size += sizeof(struct annotation);
2524 symbol_conf.init_annotation = true;
2528 int symbol__init(struct perf_env *env)
2532 if (symbol_conf.initialized)
2535 symbol_conf.priv_size = PERF_ALIGN(symbol_conf.priv_size, sizeof(u64));
2539 if (symbol_conf.sort_by_name)
2540 symbol_conf.priv_size += (sizeof(struct symbol_name_rb_node) -
2541 sizeof(struct symbol));
2543 if (symbol_conf.try_vmlinux_path && vmlinux_path__init(env) < 0)
2546 if (symbol_conf.field_sep && *symbol_conf.field_sep == '.') {
2547 pr_err("'.' is the only non valid --field-separator argument\n");
2551 if (setup_list(&symbol_conf.dso_list,
2552 symbol_conf.dso_list_str, "dso") < 0)
2555 if (setup_list(&symbol_conf.comm_list,
2556 symbol_conf.comm_list_str, "comm") < 0)
2557 goto out_free_dso_list;
2559 if (setup_intlist(&symbol_conf.pid_list,
2560 symbol_conf.pid_list_str, "pid") < 0)
2561 goto out_free_comm_list;
2563 if (setup_intlist(&symbol_conf.tid_list,
2564 symbol_conf.tid_list_str, "tid") < 0)
2565 goto out_free_pid_list;
2567 if (setup_list(&symbol_conf.sym_list,
2568 symbol_conf.sym_list_str, "symbol") < 0)
2569 goto out_free_tid_list;
2571 if (symbol_conf.sym_list &&
2572 setup_addrlist(&symbol_conf.addr_list, symbol_conf.sym_list) < 0)
2573 goto out_free_sym_list;
2575 if (setup_list(&symbol_conf.bt_stop_list,
2576 symbol_conf.bt_stop_list_str, "symbol") < 0)
2577 goto out_free_sym_list;
2580 * A path to symbols of "/" is identical to ""
2581 * reset here for simplicity.
2583 symfs = realpath(symbol_conf.symfs, NULL);
2585 symfs = symbol_conf.symfs;
2586 if (strcmp(symfs, "/") == 0)
2587 symbol_conf.symfs = "";
2588 if (symfs != symbol_conf.symfs)
2589 free((void *)symfs);
2591 symbol_conf.kptr_restrict = symbol__read_kptr_restrict();
2593 symbol_conf.initialized = true;
2597 strlist__delete(symbol_conf.sym_list);
2598 intlist__delete(symbol_conf.addr_list);
2600 intlist__delete(symbol_conf.tid_list);
2602 intlist__delete(symbol_conf.pid_list);
2604 strlist__delete(symbol_conf.comm_list);
2606 strlist__delete(symbol_conf.dso_list);
2610 void symbol__exit(void)
2612 if (!symbol_conf.initialized)
2614 strlist__delete(symbol_conf.bt_stop_list);
2615 strlist__delete(symbol_conf.sym_list);
2616 strlist__delete(symbol_conf.dso_list);
2617 strlist__delete(symbol_conf.comm_list);
2618 intlist__delete(symbol_conf.tid_list);
2619 intlist__delete(symbol_conf.pid_list);
2620 intlist__delete(symbol_conf.addr_list);
2621 vmlinux_path__exit();
2622 symbol_conf.sym_list = symbol_conf.dso_list = symbol_conf.comm_list = NULL;
2623 symbol_conf.bt_stop_list = NULL;
2624 symbol_conf.initialized = false;
2627 int symbol__config_symfs(const struct option *opt __maybe_unused,
2628 const char *dir, int unset __maybe_unused)
2633 symbol_conf.symfs = strdup(dir);
2634 if (symbol_conf.symfs == NULL)
2637 /* skip the locally configured cache if a symfs is given, and
2638 * config buildid dir to symfs/.debug
2640 ret = asprintf(&bf, "%s/%s", dir, ".debug");
2644 set_buildid_dir(bf);
2650 struct mem_info *mem_info__get(struct mem_info *mi)
2653 refcount_inc(&mi->refcnt);
2657 void mem_info__put(struct mem_info *mi)
2659 if (mi && refcount_dec_and_test(&mi->refcnt))
2663 struct mem_info *mem_info__new(void)
2665 struct mem_info *mi = zalloc(sizeof(*mi));
2668 refcount_set(&mi->refcnt, 1);
2673 * Checks that user supplied symbol kernel files are accessible because
2674 * the default mechanism for accessing elf files fails silently. i.e. if
2675 * debug syms for a build ID aren't found perf carries on normally. When
2676 * they are user supplied we should assume that the user doesn't want to
2679 int symbol__validate_sym_arguments(void)
2681 if (symbol_conf.vmlinux_name &&
2682 access(symbol_conf.vmlinux_name, R_OK)) {
2683 pr_err("Invalid file: %s\n", symbol_conf.vmlinux_name);
2686 if (symbol_conf.kallsyms_name &&
2687 access(symbol_conf.kallsyms_name, R_OK)) {
2688 pr_err("Invalid file: %s\n", symbol_conf.kallsyms_name);