23 #include <symbol/kallsyms.h>
24 #include <sys/utsname.h>
26 static int dso__load_kernel_sym(struct dso *dso, struct map *map,
27 symbol_filter_t filter);
28 static int dso__load_guest_kernel_sym(struct dso *dso, struct map *map,
29 symbol_filter_t filter);
30 int vmlinux_path__nr_entries;
33 struct symbol_conf symbol_conf = {
35 .try_vmlinux_path = true,
38 .demangle_kernel = false,
39 .cumulate_callchain = true,
40 .show_hist_headers = true,
44 static enum dso_binary_type binary_type_symtab[] = {
45 DSO_BINARY_TYPE__KALLSYMS,
46 DSO_BINARY_TYPE__GUEST_KALLSYMS,
47 DSO_BINARY_TYPE__JAVA_JIT,
48 DSO_BINARY_TYPE__DEBUGLINK,
49 DSO_BINARY_TYPE__BUILD_ID_CACHE,
50 DSO_BINARY_TYPE__FEDORA_DEBUGINFO,
51 DSO_BINARY_TYPE__UBUNTU_DEBUGINFO,
52 DSO_BINARY_TYPE__BUILDID_DEBUGINFO,
53 DSO_BINARY_TYPE__SYSTEM_PATH_DSO,
54 DSO_BINARY_TYPE__GUEST_KMODULE,
55 DSO_BINARY_TYPE__GUEST_KMODULE_COMP,
56 DSO_BINARY_TYPE__SYSTEM_PATH_KMODULE,
57 DSO_BINARY_TYPE__SYSTEM_PATH_KMODULE_COMP,
58 DSO_BINARY_TYPE__OPENEMBEDDED_DEBUGINFO,
59 DSO_BINARY_TYPE__NOT_FOUND,
62 #define DSO_BINARY_TYPE__SYMTAB_CNT ARRAY_SIZE(binary_type_symtab)
64 bool symbol_type__is_a(char symbol_type, enum map_type map_type)
66 symbol_type = toupper(symbol_type);
70 return symbol_type == 'T' || symbol_type == 'W';
72 return symbol_type == 'D';
78 static int prefix_underscores_count(const char *str)
80 const char *tail = str;
91 static int choose_best_symbol(struct symbol *syma, struct symbol *symb)
97 /* Prefer a symbol with non zero length */
98 a = syma->end - syma->start;
99 b = symb->end - symb->start;
100 if ((b == 0) && (a > 0))
102 else if ((a == 0) && (b > 0))
105 /* Prefer a non weak symbol over a weak one */
106 a = syma->binding == STB_WEAK;
107 b = symb->binding == STB_WEAK;
113 /* Prefer a global symbol over a non global one */
114 a = syma->binding == STB_GLOBAL;
115 b = symb->binding == STB_GLOBAL;
121 /* Prefer a symbol with less underscores */
122 a = prefix_underscores_count(syma->name);
123 b = prefix_underscores_count(symb->name);
129 /* Choose the symbol with the longest name */
130 na = strlen(syma->name);
131 nb = strlen(symb->name);
137 /* Avoid "SyS" kernel syscall aliases */
138 if (na >= 3 && !strncmp(syma->name, "SyS", 3))
140 if (na >= 10 && !strncmp(syma->name, "compat_SyS", 10))
146 void symbols__fixup_duplicate(struct rb_root *symbols)
149 struct symbol *curr, *next;
151 nd = rb_first(symbols);
154 curr = rb_entry(nd, struct symbol, rb_node);
156 nd = rb_next(&curr->rb_node);
157 next = rb_entry(nd, struct symbol, rb_node);
162 if (curr->start != next->start)
165 if (choose_best_symbol(curr, next) == SYMBOL_A) {
166 rb_erase(&next->rb_node, symbols);
167 symbol__delete(next);
170 nd = rb_next(&curr->rb_node);
171 rb_erase(&curr->rb_node, symbols);
172 symbol__delete(curr);
177 void symbols__fixup_end(struct rb_root *symbols)
179 struct rb_node *nd, *prevnd = rb_first(symbols);
180 struct symbol *curr, *prev;
185 curr = rb_entry(prevnd, struct symbol, rb_node);
187 for (nd = rb_next(prevnd); nd; nd = rb_next(nd)) {
189 curr = rb_entry(nd, struct symbol, rb_node);
191 if (prev->end == prev->start && prev->end != curr->start)
192 prev->end = curr->start;
196 if (curr->end == curr->start)
197 curr->end = roundup(curr->start, 4096);
200 void __map_groups__fixup_end(struct map_groups *mg, enum map_type type)
202 struct map *prev, *curr;
203 struct rb_node *nd, *prevnd = rb_first(&mg->maps[type]);
208 curr = rb_entry(prevnd, struct map, rb_node);
210 for (nd = rb_next(prevnd); nd; nd = rb_next(nd)) {
212 curr = rb_entry(nd, struct map, rb_node);
213 prev->end = curr->start;
217 * We still haven't the actual symbols, so guess the
218 * last map final address.
223 struct symbol *symbol__new(u64 start, u64 len, u8 binding, const char *name)
225 size_t namelen = strlen(name) + 1;
226 struct symbol *sym = calloc(1, (symbol_conf.priv_size +
227 sizeof(*sym) + namelen));
231 if (symbol_conf.priv_size)
232 sym = ((void *)sym) + symbol_conf.priv_size;
235 sym->end = len ? start + len : start;
236 sym->binding = binding;
237 sym->namelen = namelen - 1;
239 pr_debug4("%s: %s %#" PRIx64 "-%#" PRIx64 "\n",
240 __func__, name, start, sym->end);
241 memcpy(sym->name, name, namelen);
246 void symbol__delete(struct symbol *sym)
248 free(((void *)sym) - symbol_conf.priv_size);
251 size_t symbol__fprintf(struct symbol *sym, FILE *fp)
253 return fprintf(fp, " %" PRIx64 "-%" PRIx64 " %c %s\n",
254 sym->start, sym->end,
255 sym->binding == STB_GLOBAL ? 'g' :
256 sym->binding == STB_LOCAL ? 'l' : 'w',
260 size_t symbol__fprintf_symname_offs(const struct symbol *sym,
261 const struct addr_location *al, FILE *fp)
263 unsigned long offset;
266 if (sym && sym->name) {
267 length = fprintf(fp, "%s", sym->name);
269 if (al->addr < sym->end)
270 offset = al->addr - sym->start;
272 offset = al->addr - al->map->start - sym->start;
273 length += fprintf(fp, "+0x%lx", offset);
277 return fprintf(fp, "[unknown]");
280 size_t symbol__fprintf_symname(const struct symbol *sym, FILE *fp)
282 return symbol__fprintf_symname_offs(sym, NULL, fp);
285 void symbols__delete(struct rb_root *symbols)
288 struct rb_node *next = rb_first(symbols);
291 pos = rb_entry(next, struct symbol, rb_node);
292 next = rb_next(&pos->rb_node);
293 rb_erase(&pos->rb_node, symbols);
298 void symbols__insert(struct rb_root *symbols, struct symbol *sym)
300 struct rb_node **p = &symbols->rb_node;
301 struct rb_node *parent = NULL;
302 const u64 ip = sym->start;
307 s = rb_entry(parent, struct symbol, rb_node);
313 rb_link_node(&sym->rb_node, parent, p);
314 rb_insert_color(&sym->rb_node, symbols);
317 static struct symbol *symbols__find(struct rb_root *symbols, u64 ip)
324 n = symbols->rb_node;
327 struct symbol *s = rb_entry(n, struct symbol, rb_node);
331 else if (ip >= s->end)
340 static struct symbol *symbols__first(struct rb_root *symbols)
342 struct rb_node *n = rb_first(symbols);
345 return rb_entry(n, struct symbol, rb_node);
350 static struct symbol *symbols__next(struct symbol *sym)
352 struct rb_node *n = rb_next(&sym->rb_node);
355 return rb_entry(n, struct symbol, rb_node);
360 struct symbol_name_rb_node {
361 struct rb_node rb_node;
365 static void symbols__insert_by_name(struct rb_root *symbols, struct symbol *sym)
367 struct rb_node **p = &symbols->rb_node;
368 struct rb_node *parent = NULL;
369 struct symbol_name_rb_node *symn, *s;
371 symn = container_of(sym, struct symbol_name_rb_node, sym);
375 s = rb_entry(parent, struct symbol_name_rb_node, rb_node);
376 if (strcmp(sym->name, s->sym.name) < 0)
381 rb_link_node(&symn->rb_node, parent, p);
382 rb_insert_color(&symn->rb_node, symbols);
385 static void symbols__sort_by_name(struct rb_root *symbols,
386 struct rb_root *source)
390 for (nd = rb_first(source); nd; nd = rb_next(nd)) {
391 struct symbol *pos = rb_entry(nd, struct symbol, rb_node);
392 symbols__insert_by_name(symbols, pos);
396 static struct symbol *symbols__find_by_name(struct rb_root *symbols,
400 struct symbol_name_rb_node *s;
405 n = symbols->rb_node;
410 s = rb_entry(n, struct symbol_name_rb_node, rb_node);
411 cmp = strcmp(name, s->sym.name);
424 /* return first symbol that has same name (if any) */
425 for (n = rb_prev(n); n; n = rb_prev(n)) {
426 struct symbol_name_rb_node *tmp;
428 tmp = rb_entry(n, struct symbol_name_rb_node, rb_node);
429 if (strcmp(tmp->sym.name, s->sym.name))
438 struct symbol *dso__find_symbol(struct dso *dso,
439 enum map_type type, u64 addr)
441 return symbols__find(&dso->symbols[type], addr);
444 struct symbol *dso__first_symbol(struct dso *dso, enum map_type type)
446 return symbols__first(&dso->symbols[type]);
449 struct symbol *dso__next_symbol(struct symbol *sym)
451 return symbols__next(sym);
454 struct symbol *symbol__next_by_name(struct symbol *sym)
456 struct symbol_name_rb_node *s = container_of(sym, struct symbol_name_rb_node, sym);
457 struct rb_node *n = rb_next(&s->rb_node);
459 return n ? &rb_entry(n, struct symbol_name_rb_node, rb_node)->sym : NULL;
463 * Teturns first symbol that matched with @name.
465 struct symbol *dso__find_symbol_by_name(struct dso *dso, enum map_type type,
468 return symbols__find_by_name(&dso->symbol_names[type], name);
471 void dso__sort_by_name(struct dso *dso, enum map_type type)
473 dso__set_sorted_by_name(dso, type);
474 return symbols__sort_by_name(&dso->symbol_names[type],
475 &dso->symbols[type]);
478 size_t dso__fprintf_symbols_by_name(struct dso *dso,
479 enum map_type type, FILE *fp)
483 struct symbol_name_rb_node *pos;
485 for (nd = rb_first(&dso->symbol_names[type]); nd; nd = rb_next(nd)) {
486 pos = rb_entry(nd, struct symbol_name_rb_node, rb_node);
487 fprintf(fp, "%s\n", pos->sym.name);
493 int modules__parse(const char *filename, void *arg,
494 int (*process_module)(void *arg, const char *name,
502 file = fopen(filename, "r");
512 line_len = getline(&line, &n, file);
525 line[--line_len] = '\0'; /* \n */
527 sep = strrchr(line, 'x');
531 hex2u64(sep + 1, &start);
533 sep = strchr(line, ' ');
539 scnprintf(name, sizeof(name), "[%s]", line);
541 err = process_module(arg, name, start);
551 struct process_kallsyms_args {
557 * These are symbols in the kernel image, so make sure that
558 * sym is from a kernel DSO.
560 bool symbol__is_idle(struct symbol *sym)
562 const char * const idle_symbols[] = {
571 "mwait_idle_with_hints",
573 "ppc64_runlatch_off",
574 "pseries_dedicated_idle_sleep",
583 for (i = 0; idle_symbols[i]; i++) {
584 if (!strcmp(idle_symbols[i], sym->name))
591 static int map__process_kallsym_symbol(void *arg, const char *name,
592 char type, u64 start)
595 struct process_kallsyms_args *a = arg;
596 struct rb_root *root = &a->dso->symbols[a->map->type];
598 if (!symbol_type__is_a(type, a->map->type))
602 * module symbols are not sorted so we add all
603 * symbols, setting length to 0, and rely on
604 * symbols__fixup_end() to fix it up.
606 sym = symbol__new(start, 0, kallsyms2elf_type(type), name);
610 * We will pass the symbols to the filter later, in
611 * map__split_kallsyms, when we have split the maps per module
613 symbols__insert(root, sym);
619 * Loads the function entries in /proc/kallsyms into kernel_map->dso,
620 * so that we can in the next step set the symbol ->end address and then
621 * call kernel_maps__split_kallsyms.
623 static int dso__load_all_kallsyms(struct dso *dso, const char *filename,
626 struct process_kallsyms_args args = { .map = map, .dso = dso, };
627 return kallsyms__parse(filename, &args, map__process_kallsym_symbol);
630 static int dso__split_kallsyms_for_kcore(struct dso *dso, struct map *map,
631 symbol_filter_t filter)
633 struct map_groups *kmaps = map__kmaps(map);
634 struct map *curr_map;
636 int count = 0, moved = 0;
637 struct rb_root *root = &dso->symbols[map->type];
638 struct rb_node *next = rb_first(root);
646 pos = rb_entry(next, struct symbol, rb_node);
647 next = rb_next(&pos->rb_node);
649 module = strchr(pos->name, '\t');
653 curr_map = map_groups__find(kmaps, map->type, pos->start);
655 if (!curr_map || (filter && filter(curr_map, pos))) {
656 rb_erase(&pos->rb_node, root);
659 pos->start -= curr_map->start - curr_map->pgoff;
661 pos->end -= curr_map->start - curr_map->pgoff;
662 if (curr_map != map) {
663 rb_erase(&pos->rb_node, root);
665 &curr_map->dso->symbols[curr_map->type],
674 /* Symbols have been adjusted */
675 dso->adjust_symbols = 1;
677 return count + moved;
681 * Split the symbols into maps, making sure there are no overlaps, i.e. the
682 * kernel range is broken in several maps, named [kernel].N, as we don't have
683 * the original ELF section names vmlinux have.
685 static int dso__split_kallsyms(struct dso *dso, struct map *map, u64 delta,
686 symbol_filter_t filter)
688 struct map_groups *kmaps = map__kmaps(map);
689 struct machine *machine;
690 struct map *curr_map = map;
692 int count = 0, moved = 0;
693 struct rb_root *root = &dso->symbols[map->type];
694 struct rb_node *next = rb_first(root);
695 int kernel_range = 0;
700 machine = kmaps->machine;
705 pos = rb_entry(next, struct symbol, rb_node);
706 next = rb_next(&pos->rb_node);
708 module = strchr(pos->name, '\t');
710 if (!symbol_conf.use_modules)
715 if (strcmp(curr_map->dso->short_name, module)) {
716 if (curr_map != map &&
717 dso->kernel == DSO_TYPE_GUEST_KERNEL &&
718 machine__is_default_guest(machine)) {
720 * We assume all symbols of a module are
721 * continuous in * kallsyms, so curr_map
722 * points to a module and all its
723 * symbols are in its kmap. Mark it as
726 dso__set_loaded(curr_map->dso,
730 curr_map = map_groups__find_by_name(kmaps,
732 if (curr_map == NULL) {
733 pr_debug("%s/proc/{kallsyms,modules} "
734 "inconsistency while looking "
735 "for \"%s\" module!\n",
736 machine->root_dir, module);
741 if (curr_map->dso->loaded &&
742 !machine__is_default_guest(machine))
746 * So that we look just like we get from .ko files,
747 * i.e. not prelinked, relative to map->start.
749 pos->start = curr_map->map_ip(curr_map, pos->start);
750 pos->end = curr_map->map_ip(curr_map, pos->end);
751 } else if (curr_map != map) {
752 char dso_name[PATH_MAX];
756 /* Kernel was relocated at boot time */
766 if (dso->kernel == DSO_TYPE_GUEST_KERNEL)
767 snprintf(dso_name, sizeof(dso_name),
771 snprintf(dso_name, sizeof(dso_name),
775 ndso = dso__new(dso_name);
779 ndso->kernel = dso->kernel;
781 curr_map = map__new2(pos->start, ndso, map->type);
782 if (curr_map == NULL) {
787 curr_map->map_ip = curr_map->unmap_ip = identity__map_ip;
788 map_groups__insert(kmaps, curr_map);
791 /* Kernel was relocated at boot time */
796 if (filter && filter(curr_map, pos)) {
797 discard_symbol: rb_erase(&pos->rb_node, root);
800 if (curr_map != map) {
801 rb_erase(&pos->rb_node, root);
802 symbols__insert(&curr_map->dso->symbols[curr_map->type], pos);
809 if (curr_map != map &&
810 dso->kernel == DSO_TYPE_GUEST_KERNEL &&
811 machine__is_default_guest(kmaps->machine)) {
812 dso__set_loaded(curr_map->dso, curr_map->type);
815 return count + moved;
818 bool symbol__restricted_filename(const char *filename,
819 const char *restricted_filename)
821 bool restricted = false;
823 if (symbol_conf.kptr_restrict) {
824 char *r = realpath(filename, NULL);
827 restricted = strcmp(r, restricted_filename) == 0;
837 struct rb_node rb_node;
842 static void add_module(struct module_info *mi, struct rb_root *modules)
844 struct rb_node **p = &modules->rb_node;
845 struct rb_node *parent = NULL;
846 struct module_info *m;
850 m = rb_entry(parent, struct module_info, rb_node);
851 if (strcmp(mi->name, m->name) < 0)
856 rb_link_node(&mi->rb_node, parent, p);
857 rb_insert_color(&mi->rb_node, modules);
860 static void delete_modules(struct rb_root *modules)
862 struct module_info *mi;
863 struct rb_node *next = rb_first(modules);
866 mi = rb_entry(next, struct module_info, rb_node);
867 next = rb_next(&mi->rb_node);
868 rb_erase(&mi->rb_node, modules);
874 static struct module_info *find_module(const char *name,
875 struct rb_root *modules)
877 struct rb_node *n = modules->rb_node;
880 struct module_info *m;
883 m = rb_entry(n, struct module_info, rb_node);
884 cmp = strcmp(name, m->name);
896 static int __read_proc_modules(void *arg, const char *name, u64 start)
898 struct rb_root *modules = arg;
899 struct module_info *mi;
901 mi = zalloc(sizeof(struct module_info));
905 mi->name = strdup(name);
913 add_module(mi, modules);
918 static int read_proc_modules(const char *filename, struct rb_root *modules)
920 if (symbol__restricted_filename(filename, "/proc/modules"))
923 if (modules__parse(filename, modules, __read_proc_modules)) {
924 delete_modules(modules);
931 int compare_proc_modules(const char *from, const char *to)
933 struct rb_root from_modules = RB_ROOT;
934 struct rb_root to_modules = RB_ROOT;
935 struct rb_node *from_node, *to_node;
936 struct module_info *from_m, *to_m;
939 if (read_proc_modules(from, &from_modules))
942 if (read_proc_modules(to, &to_modules))
943 goto out_delete_from;
945 from_node = rb_first(&from_modules);
946 to_node = rb_first(&to_modules);
951 from_m = rb_entry(from_node, struct module_info, rb_node);
952 to_m = rb_entry(to_node, struct module_info, rb_node);
954 if (from_m->start != to_m->start ||
955 strcmp(from_m->name, to_m->name))
958 from_node = rb_next(from_node);
959 to_node = rb_next(to_node);
962 if (!from_node && !to_node)
965 delete_modules(&to_modules);
967 delete_modules(&from_modules);
972 static int do_validate_kcore_modules(const char *filename, struct map *map,
973 struct map_groups *kmaps)
975 struct rb_root modules = RB_ROOT;
979 err = read_proc_modules(filename, &modules);
983 old_map = map_groups__first(kmaps, map->type);
985 struct map *next = map_groups__next(old_map);
986 struct module_info *mi;
988 if (old_map == map || old_map->start == map->start) {
994 /* Module must be in memory at the same address */
995 mi = find_module(old_map->dso->short_name, &modules);
996 if (!mi || mi->start != old_map->start) {
1004 delete_modules(&modules);
1009 * If kallsyms is referenced by name then we look for filename in the same
1012 static bool filename_from_kallsyms_filename(char *filename,
1013 const char *base_name,
1014 const char *kallsyms_filename)
1018 strcpy(filename, kallsyms_filename);
1019 name = strrchr(filename, '/');
1025 if (!strcmp(name, "kallsyms")) {
1026 strcpy(name, base_name);
1033 static int validate_kcore_modules(const char *kallsyms_filename,
1036 struct map_groups *kmaps = map__kmaps(map);
1037 char modules_filename[PATH_MAX];
1042 if (!filename_from_kallsyms_filename(modules_filename, "modules",
1046 if (do_validate_kcore_modules(modules_filename, map, kmaps))
1052 static int validate_kcore_addresses(const char *kallsyms_filename,
1055 struct kmap *kmap = map__kmap(map);
1060 if (kmap->ref_reloc_sym && kmap->ref_reloc_sym->name) {
1063 start = kallsyms__get_function_start(kallsyms_filename,
1064 kmap->ref_reloc_sym->name);
1065 if (start != kmap->ref_reloc_sym->addr)
1069 return validate_kcore_modules(kallsyms_filename, map);
1072 struct kcore_mapfn_data {
1075 struct list_head maps;
1078 static int kcore_mapfn(u64 start, u64 len, u64 pgoff, void *data)
1080 struct kcore_mapfn_data *md = data;
1083 map = map__new2(start, md->dso, md->type);
1087 map->end = map->start + len;
1090 list_add(&map->node, &md->maps);
1095 static int dso__load_kcore(struct dso *dso, struct map *map,
1096 const char *kallsyms_filename)
1098 struct map_groups *kmaps = map__kmaps(map);
1099 struct machine *machine;
1100 struct kcore_mapfn_data md;
1101 struct map *old_map, *new_map, *replacement_map = NULL;
1104 char kcore_filename[PATH_MAX];
1110 machine = kmaps->machine;
1112 /* This function requires that the map is the kernel map */
1113 if (map != machine->vmlinux_maps[map->type])
1116 if (!filename_from_kallsyms_filename(kcore_filename, "kcore",
1120 /* Modules and kernel must be present at their original addresses */
1121 if (validate_kcore_addresses(kallsyms_filename, map))
1125 md.type = map->type;
1126 INIT_LIST_HEAD(&md.maps);
1128 fd = open(kcore_filename, O_RDONLY);
1132 /* Read new maps into temporary lists */
1133 err = file__read_maps(fd, md.type == MAP__FUNCTION, kcore_mapfn, &md,
1137 dso->is_64_bit = is_64_bit;
1139 if (list_empty(&md.maps)) {
1144 /* Remove old maps */
1145 old_map = map_groups__first(kmaps, map->type);
1147 struct map *next = map_groups__next(old_map);
1150 map_groups__remove(kmaps, old_map);
1154 /* Find the kernel map using the first symbol */
1155 sym = dso__first_symbol(dso, map->type);
1156 list_for_each_entry(new_map, &md.maps, node) {
1157 if (sym && sym->start >= new_map->start &&
1158 sym->start < new_map->end) {
1159 replacement_map = new_map;
1164 if (!replacement_map)
1165 replacement_map = list_entry(md.maps.next, struct map, node);
1168 while (!list_empty(&md.maps)) {
1169 new_map = list_entry(md.maps.next, struct map, node);
1170 list_del(&new_map->node);
1171 if (new_map == replacement_map) {
1172 map->start = new_map->start;
1173 map->end = new_map->end;
1174 map->pgoff = new_map->pgoff;
1175 map->map_ip = new_map->map_ip;
1176 map->unmap_ip = new_map->unmap_ip;
1177 map__delete(new_map);
1178 /* Ensure maps are correctly ordered */
1179 map_groups__remove(kmaps, map);
1180 map_groups__insert(kmaps, map);
1182 map_groups__insert(kmaps, new_map);
1187 * Set the data type and long name so that kcore can be read via
1188 * dso__data_read_addr().
1190 if (dso->kernel == DSO_TYPE_GUEST_KERNEL)
1191 dso->binary_type = DSO_BINARY_TYPE__GUEST_KCORE;
1193 dso->binary_type = DSO_BINARY_TYPE__KCORE;
1194 dso__set_long_name(dso, strdup(kcore_filename), true);
1198 if (map->type == MAP__FUNCTION)
1199 pr_debug("Using %s for kernel object code\n", kcore_filename);
1201 pr_debug("Using %s for kernel data\n", kcore_filename);
1206 while (!list_empty(&md.maps)) {
1207 map = list_entry(md.maps.next, struct map, node);
1208 list_del(&map->node);
1216 * If the kernel is relocated at boot time, kallsyms won't match. Compute the
1217 * delta based on the relocation reference symbol.
1219 static int kallsyms__delta(struct map *map, const char *filename, u64 *delta)
1221 struct kmap *kmap = map__kmap(map);
1227 if (!kmap->ref_reloc_sym || !kmap->ref_reloc_sym->name)
1230 addr = kallsyms__get_function_start(filename,
1231 kmap->ref_reloc_sym->name);
1235 *delta = addr - kmap->ref_reloc_sym->addr;
1239 int dso__load_kallsyms(struct dso *dso, const char *filename,
1240 struct map *map, symbol_filter_t filter)
1244 if (symbol__restricted_filename(filename, "/proc/kallsyms"))
1247 if (dso__load_all_kallsyms(dso, filename, map) < 0)
1250 if (kallsyms__delta(map, filename, &delta))
1253 symbols__fixup_duplicate(&dso->symbols[map->type]);
1254 symbols__fixup_end(&dso->symbols[map->type]);
1256 if (dso->kernel == DSO_TYPE_GUEST_KERNEL)
1257 dso->symtab_type = DSO_BINARY_TYPE__GUEST_KALLSYMS;
1259 dso->symtab_type = DSO_BINARY_TYPE__KALLSYMS;
1261 if (!dso__load_kcore(dso, map, filename))
1262 return dso__split_kallsyms_for_kcore(dso, map, filter);
1264 return dso__split_kallsyms(dso, map, delta, filter);
1267 static int dso__load_perf_map(struct dso *dso, struct map *map,
1268 symbol_filter_t filter)
1275 file = fopen(dso->long_name, "r");
1279 while (!feof(file)) {
1284 line_len = getline(&line, &n, file);
1291 line[--line_len] = '\0'; /* \n */
1293 len = hex2u64(line, &start);
1296 if (len + 2 >= line_len)
1299 len += hex2u64(line + len, &size);
1302 if (len + 2 >= line_len)
1305 sym = symbol__new(start, size, STB_GLOBAL, line + len);
1308 goto out_delete_line;
1310 if (filter && filter(map, sym))
1311 symbol__delete(sym);
1313 symbols__insert(&dso->symbols[map->type], sym);
1329 static bool dso__is_compatible_symtab_type(struct dso *dso, bool kmod,
1330 enum dso_binary_type type)
1333 case DSO_BINARY_TYPE__JAVA_JIT:
1334 case DSO_BINARY_TYPE__DEBUGLINK:
1335 case DSO_BINARY_TYPE__SYSTEM_PATH_DSO:
1336 case DSO_BINARY_TYPE__FEDORA_DEBUGINFO:
1337 case DSO_BINARY_TYPE__UBUNTU_DEBUGINFO:
1338 case DSO_BINARY_TYPE__BUILDID_DEBUGINFO:
1339 case DSO_BINARY_TYPE__OPENEMBEDDED_DEBUGINFO:
1340 return !kmod && dso->kernel == DSO_TYPE_USER;
1342 case DSO_BINARY_TYPE__KALLSYMS:
1343 case DSO_BINARY_TYPE__VMLINUX:
1344 case DSO_BINARY_TYPE__KCORE:
1345 return dso->kernel == DSO_TYPE_KERNEL;
1347 case DSO_BINARY_TYPE__GUEST_KALLSYMS:
1348 case DSO_BINARY_TYPE__GUEST_VMLINUX:
1349 case DSO_BINARY_TYPE__GUEST_KCORE:
1350 return dso->kernel == DSO_TYPE_GUEST_KERNEL;
1352 case DSO_BINARY_TYPE__GUEST_KMODULE:
1353 case DSO_BINARY_TYPE__GUEST_KMODULE_COMP:
1354 case DSO_BINARY_TYPE__SYSTEM_PATH_KMODULE:
1355 case DSO_BINARY_TYPE__SYSTEM_PATH_KMODULE_COMP:
1357 * kernel modules know their symtab type - it's set when
1358 * creating a module dso in machine__new_module().
1360 return kmod && dso->symtab_type == type;
1362 case DSO_BINARY_TYPE__BUILD_ID_CACHE:
1365 case DSO_BINARY_TYPE__NOT_FOUND:
1371 int dso__load(struct dso *dso, struct map *map, symbol_filter_t filter)
1376 struct machine *machine;
1377 char *root_dir = (char *) "";
1379 struct symsrc ss_[2];
1380 struct symsrc *syms_ss = NULL, *runtime_ss = NULL;
1383 dso__set_loaded(dso, map->type);
1385 if (dso->kernel == DSO_TYPE_KERNEL)
1386 return dso__load_kernel_sym(dso, map, filter);
1387 else if (dso->kernel == DSO_TYPE_GUEST_KERNEL)
1388 return dso__load_guest_kernel_sym(dso, map, filter);
1390 if (map->groups && map->groups->machine)
1391 machine = map->groups->machine;
1395 dso->adjust_symbols = 0;
1397 if (strncmp(dso->name, "/tmp/perf-", 10) == 0) {
1400 if (lstat(dso->name, &st) < 0)
1403 if (st.st_uid && (st.st_uid != geteuid())) {
1404 pr_warning("File %s not owned by current user or root, "
1405 "ignoring it.\n", dso->name);
1409 ret = dso__load_perf_map(dso, map, filter);
1410 dso->symtab_type = ret > 0 ? DSO_BINARY_TYPE__JAVA_JIT :
1411 DSO_BINARY_TYPE__NOT_FOUND;
1416 root_dir = machine->root_dir;
1418 name = malloc(PATH_MAX);
1422 kmod = dso->symtab_type == DSO_BINARY_TYPE__SYSTEM_PATH_KMODULE ||
1423 dso->symtab_type == DSO_BINARY_TYPE__SYSTEM_PATH_KMODULE_COMP ||
1424 dso->symtab_type == DSO_BINARY_TYPE__GUEST_KMODULE ||
1425 dso->symtab_type == DSO_BINARY_TYPE__GUEST_KMODULE_COMP;
1428 * Iterate over candidate debug images.
1429 * Keep track of "interesting" ones (those which have a symtab, dynsym,
1430 * and/or opd section) for processing.
1432 for (i = 0; i < DSO_BINARY_TYPE__SYMTAB_CNT; i++) {
1433 struct symsrc *ss = &ss_[ss_pos];
1434 bool next_slot = false;
1436 enum dso_binary_type symtab_type = binary_type_symtab[i];
1438 if (!dso__is_compatible_symtab_type(dso, kmod, symtab_type))
1441 if (dso__read_binary_type_filename(dso, symtab_type,
1442 root_dir, name, PATH_MAX))
1445 /* Name is now the name of the next image to try */
1446 if (symsrc__init(ss, dso, name, symtab_type) < 0)
1449 if (!syms_ss && symsrc__has_symtab(ss)) {
1452 if (!dso->symsrc_filename)
1453 dso->symsrc_filename = strdup(name);
1456 if (!runtime_ss && symsrc__possibly_runtime(ss)) {
1464 if (syms_ss && runtime_ss)
1467 symsrc__destroy(ss);
1472 if (!runtime_ss && !syms_ss)
1475 if (runtime_ss && !syms_ss) {
1476 syms_ss = runtime_ss;
1479 /* We'll have to hope for the best */
1480 if (!runtime_ss && syms_ss)
1481 runtime_ss = syms_ss;
1484 ret = dso__load_sym(dso, map, syms_ss, runtime_ss, filter, kmod);
1491 nr_plt = dso__synthesize_plt_symbols(dso, runtime_ss, map, filter);
1496 for (; ss_pos > 0; ss_pos--)
1497 symsrc__destroy(&ss_[ss_pos - 1]);
1500 if (ret < 0 && strstr(dso->name, " (deleted)") != NULL)
1505 struct map *map_groups__find_by_name(struct map_groups *mg,
1506 enum map_type type, const char *name)
1510 for (nd = rb_first(&mg->maps[type]); nd; nd = rb_next(nd)) {
1511 struct map *map = rb_entry(nd, struct map, rb_node);
1513 if (map->dso && strcmp(map->dso->short_name, name) == 0)
1520 int dso__load_vmlinux(struct dso *dso, struct map *map,
1521 const char *vmlinux, bool vmlinux_allocated,
1522 symbol_filter_t filter)
1526 char symfs_vmlinux[PATH_MAX];
1527 enum dso_binary_type symtab_type;
1529 if (vmlinux[0] == '/')
1530 snprintf(symfs_vmlinux, sizeof(symfs_vmlinux), "%s", vmlinux);
1532 symbol__join_symfs(symfs_vmlinux, vmlinux);
1534 if (dso->kernel == DSO_TYPE_GUEST_KERNEL)
1535 symtab_type = DSO_BINARY_TYPE__GUEST_VMLINUX;
1537 symtab_type = DSO_BINARY_TYPE__VMLINUX;
1539 if (symsrc__init(&ss, dso, symfs_vmlinux, symtab_type))
1542 err = dso__load_sym(dso, map, &ss, &ss, filter, 0);
1543 symsrc__destroy(&ss);
1546 if (dso->kernel == DSO_TYPE_GUEST_KERNEL)
1547 dso->binary_type = DSO_BINARY_TYPE__GUEST_VMLINUX;
1549 dso->binary_type = DSO_BINARY_TYPE__VMLINUX;
1550 dso__set_long_name(dso, vmlinux, vmlinux_allocated);
1551 dso__set_loaded(dso, map->type);
1552 pr_debug("Using %s for symbols\n", symfs_vmlinux);
1558 int dso__load_vmlinux_path(struct dso *dso, struct map *map,
1559 symbol_filter_t filter)
1562 char *filename = NULL;
1564 if (!symbol_conf.ignore_vmlinux_buildid)
1565 filename = dso__build_id_filename(dso, NULL, 0);
1566 if (filename != NULL) {
1567 err = dso__load_vmlinux(dso, map, filename, true, filter);
1573 pr_debug("Looking at the vmlinux_path (%d entries long)\n",
1574 vmlinux_path__nr_entries + 1);
1576 for (i = 0; i < vmlinux_path__nr_entries; ++i) {
1577 err = dso__load_vmlinux(dso, map, vmlinux_path[i], false, filter);
1585 static int find_matching_kcore(struct map *map, char *dir, size_t dir_sz)
1587 char kallsyms_filename[PATH_MAX];
1588 struct dirent *dent;
1600 if (dent->d_type != DT_DIR)
1602 scnprintf(kallsyms_filename, sizeof(kallsyms_filename),
1603 "%s/%s/kallsyms", dir, dent->d_name);
1604 if (!validate_kcore_addresses(kallsyms_filename, map)) {
1605 strlcpy(dir, kallsyms_filename, dir_sz);
1616 static char *dso__find_kallsyms(struct dso *dso, struct map *map)
1618 u8 host_build_id[BUILD_ID_SIZE];
1619 char sbuild_id[BUILD_ID_SIZE * 2 + 1];
1620 bool is_host = false;
1621 char path[PATH_MAX];
1623 if (!dso->has_build_id) {
1625 * Last resort, if we don't have a build-id and couldn't find
1626 * any vmlinux file, try the running kernel kallsyms table.
1631 if (sysfs__read_build_id("/sys/kernel/notes", host_build_id,
1632 sizeof(host_build_id)) == 0)
1633 is_host = dso__build_id_equal(dso, host_build_id);
1635 build_id__sprintf(dso->build_id, sizeof(dso->build_id), sbuild_id);
1637 scnprintf(path, sizeof(path), "%s/[kernel.kcore]/%s", buildid_dir,
1640 /* Use /proc/kallsyms if possible */
1645 /* If no cached kcore go with /proc/kallsyms */
1652 * Do not check the build-id cache, until we know we cannot use
1655 fd = open("/proc/kcore", O_RDONLY);
1658 /* If module maps match go with /proc/kallsyms */
1659 if (!validate_kcore_addresses("/proc/kallsyms", map))
1663 /* Find kallsyms in build-id cache with kcore */
1664 if (!find_matching_kcore(map, path, sizeof(path)))
1665 return strdup(path);
1670 /* Find kallsyms in build-id cache with kcore */
1671 if (!find_matching_kcore(map, path, sizeof(path)))
1672 return strdup(path);
1674 scnprintf(path, sizeof(path), "%s/[kernel.kallsyms]/%s",
1675 buildid_dir, sbuild_id);
1677 if (access(path, F_OK)) {
1678 pr_err("No kallsyms or vmlinux with build-id %s was found\n",
1683 return strdup(path);
1686 return strdup("/proc/kallsyms");
1689 static int dso__load_kernel_sym(struct dso *dso, struct map *map,
1690 symbol_filter_t filter)
1693 const char *kallsyms_filename = NULL;
1694 char *kallsyms_allocated_filename = NULL;
1696 * Step 1: if the user specified a kallsyms or vmlinux filename, use
1697 * it and only it, reporting errors to the user if it cannot be used.
1699 * For instance, try to analyse an ARM perf.data file _without_ a
1700 * build-id, or if the user specifies the wrong path to the right
1701 * vmlinux file, obviously we can't fallback to another vmlinux (a
1702 * x86_86 one, on the machine where analysis is being performed, say),
1703 * or worse, /proc/kallsyms.
1705 * If the specified file _has_ a build-id and there is a build-id
1706 * section in the perf.data file, we will still do the expected
1707 * validation in dso__load_vmlinux and will bail out if they don't
1710 if (symbol_conf.kallsyms_name != NULL) {
1711 kallsyms_filename = symbol_conf.kallsyms_name;
1715 if (!symbol_conf.ignore_vmlinux && symbol_conf.vmlinux_name != NULL) {
1716 return dso__load_vmlinux(dso, map, symbol_conf.vmlinux_name,
1720 if (!symbol_conf.ignore_vmlinux && vmlinux_path != NULL) {
1721 err = dso__load_vmlinux_path(dso, map, filter);
1726 /* do not try local files if a symfs was given */
1727 if (symbol_conf.symfs[0] != 0)
1730 kallsyms_allocated_filename = dso__find_kallsyms(dso, map);
1731 if (!kallsyms_allocated_filename)
1734 kallsyms_filename = kallsyms_allocated_filename;
1737 err = dso__load_kallsyms(dso, kallsyms_filename, map, filter);
1739 pr_debug("Using %s for symbols\n", kallsyms_filename);
1740 free(kallsyms_allocated_filename);
1742 if (err > 0 && !dso__is_kcore(dso)) {
1743 dso->binary_type = DSO_BINARY_TYPE__KALLSYMS;
1744 dso__set_long_name(dso, "[kernel.kallsyms]", false);
1745 map__fixup_start(map);
1746 map__fixup_end(map);
1752 static int dso__load_guest_kernel_sym(struct dso *dso, struct map *map,
1753 symbol_filter_t filter)
1756 const char *kallsyms_filename = NULL;
1757 struct machine *machine;
1758 char path[PATH_MAX];
1761 pr_debug("Guest kernel map hasn't the point to groups\n");
1764 machine = map->groups->machine;
1766 if (machine__is_default_guest(machine)) {
1768 * if the user specified a vmlinux filename, use it and only
1769 * it, reporting errors to the user if it cannot be used.
1770 * Or use file guest_kallsyms inputted by user on commandline
1772 if (symbol_conf.default_guest_vmlinux_name != NULL) {
1773 err = dso__load_vmlinux(dso, map,
1774 symbol_conf.default_guest_vmlinux_name,
1779 kallsyms_filename = symbol_conf.default_guest_kallsyms;
1780 if (!kallsyms_filename)
1783 sprintf(path, "%s/proc/kallsyms", machine->root_dir);
1784 kallsyms_filename = path;
1787 err = dso__load_kallsyms(dso, kallsyms_filename, map, filter);
1789 pr_debug("Using %s for symbols\n", kallsyms_filename);
1790 if (err > 0 && !dso__is_kcore(dso)) {
1791 dso->binary_type = DSO_BINARY_TYPE__GUEST_KALLSYMS;
1792 machine__mmap_name(machine, path, sizeof(path));
1793 dso__set_long_name(dso, strdup(path), true);
1794 map__fixup_start(map);
1795 map__fixup_end(map);
1801 static void vmlinux_path__exit(void)
1803 while (--vmlinux_path__nr_entries >= 0)
1804 zfree(&vmlinux_path[vmlinux_path__nr_entries]);
1806 zfree(&vmlinux_path);
1809 static int vmlinux_path__init(struct perf_session_env *env)
1813 char *kernel_version;
1815 vmlinux_path = malloc(sizeof(char *) * 6);
1816 if (vmlinux_path == NULL)
1819 vmlinux_path[vmlinux_path__nr_entries] = strdup("vmlinux");
1820 if (vmlinux_path[vmlinux_path__nr_entries] == NULL)
1822 ++vmlinux_path__nr_entries;
1823 vmlinux_path[vmlinux_path__nr_entries] = strdup("/boot/vmlinux");
1824 if (vmlinux_path[vmlinux_path__nr_entries] == NULL)
1826 ++vmlinux_path__nr_entries;
1828 /* only try kernel version if no symfs was given */
1829 if (symbol_conf.symfs[0] != 0)
1833 kernel_version = env->os_release;
1835 if (uname(&uts) < 0)
1838 kernel_version = uts.release;
1841 snprintf(bf, sizeof(bf), "/boot/vmlinux-%s", kernel_version);
1842 vmlinux_path[vmlinux_path__nr_entries] = strdup(bf);
1843 if (vmlinux_path[vmlinux_path__nr_entries] == NULL)
1845 ++vmlinux_path__nr_entries;
1846 snprintf(bf, sizeof(bf), "/usr/lib/debug/boot/vmlinux-%s",
1848 vmlinux_path[vmlinux_path__nr_entries] = strdup(bf);
1849 if (vmlinux_path[vmlinux_path__nr_entries] == NULL)
1851 ++vmlinux_path__nr_entries;
1852 snprintf(bf, sizeof(bf), "/lib/modules/%s/build/vmlinux", kernel_version);
1853 vmlinux_path[vmlinux_path__nr_entries] = strdup(bf);
1854 if (vmlinux_path[vmlinux_path__nr_entries] == NULL)
1856 ++vmlinux_path__nr_entries;
1857 snprintf(bf, sizeof(bf), "/usr/lib/debug/lib/modules/%s/vmlinux",
1859 vmlinux_path[vmlinux_path__nr_entries] = strdup(bf);
1860 if (vmlinux_path[vmlinux_path__nr_entries] == NULL)
1862 ++vmlinux_path__nr_entries;
1867 vmlinux_path__exit();
1871 int setup_list(struct strlist **list, const char *list_str,
1872 const char *list_name)
1874 if (list_str == NULL)
1877 *list = strlist__new(true, list_str);
1879 pr_err("problems parsing %s list\n", list_name);
1885 int setup_intlist(struct intlist **list, const char *list_str,
1886 const char *list_name)
1888 if (list_str == NULL)
1891 *list = intlist__new(list_str);
1893 pr_err("problems parsing %s list\n", list_name);
1899 static bool symbol__read_kptr_restrict(void)
1903 if (geteuid() != 0) {
1904 FILE *fp = fopen("/proc/sys/kernel/kptr_restrict", "r");
1908 if (fgets(line, sizeof(line), fp) != NULL)
1909 value = atoi(line) != 0;
1918 int symbol__init(struct perf_session_env *env)
1922 if (symbol_conf.initialized)
1925 symbol_conf.priv_size = PERF_ALIGN(symbol_conf.priv_size, sizeof(u64));
1929 if (symbol_conf.sort_by_name)
1930 symbol_conf.priv_size += (sizeof(struct symbol_name_rb_node) -
1931 sizeof(struct symbol));
1933 if (symbol_conf.try_vmlinux_path && vmlinux_path__init(env) < 0)
1936 if (symbol_conf.field_sep && *symbol_conf.field_sep == '.') {
1937 pr_err("'.' is the only non valid --field-separator argument\n");
1941 if (setup_list(&symbol_conf.dso_list,
1942 symbol_conf.dso_list_str, "dso") < 0)
1945 if (setup_list(&symbol_conf.comm_list,
1946 symbol_conf.comm_list_str, "comm") < 0)
1947 goto out_free_dso_list;
1949 if (setup_intlist(&symbol_conf.pid_list,
1950 symbol_conf.pid_list_str, "pid") < 0)
1951 goto out_free_comm_list;
1953 if (setup_intlist(&symbol_conf.tid_list,
1954 symbol_conf.tid_list_str, "tid") < 0)
1955 goto out_free_pid_list;
1957 if (setup_list(&symbol_conf.sym_list,
1958 symbol_conf.sym_list_str, "symbol") < 0)
1959 goto out_free_tid_list;
1962 * A path to symbols of "/" is identical to ""
1963 * reset here for simplicity.
1965 symfs = realpath(symbol_conf.symfs, NULL);
1967 symfs = symbol_conf.symfs;
1968 if (strcmp(symfs, "/") == 0)
1969 symbol_conf.symfs = "";
1970 if (symfs != symbol_conf.symfs)
1971 free((void *)symfs);
1973 symbol_conf.kptr_restrict = symbol__read_kptr_restrict();
1975 symbol_conf.initialized = true;
1979 intlist__delete(symbol_conf.tid_list);
1981 intlist__delete(symbol_conf.pid_list);
1983 strlist__delete(symbol_conf.comm_list);
1985 strlist__delete(symbol_conf.dso_list);
1989 void symbol__exit(void)
1991 if (!symbol_conf.initialized)
1993 strlist__delete(symbol_conf.sym_list);
1994 strlist__delete(symbol_conf.dso_list);
1995 strlist__delete(symbol_conf.comm_list);
1996 intlist__delete(symbol_conf.tid_list);
1997 intlist__delete(symbol_conf.pid_list);
1998 vmlinux_path__exit();
1999 symbol_conf.sym_list = symbol_conf.dso_list = symbol_conf.comm_list = NULL;
2000 symbol_conf.initialized = false;