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;
88 int __weak arch__choose_best_symbol(struct symbol *syma,
89 struct symbol *symb __maybe_unused)
91 /* Avoid "SyS" kernel syscall aliases */
92 if (strlen(syma->name) >= 3 && !strncmp(syma->name, "SyS", 3))
94 if (strlen(syma->name) >= 10 && !strncmp(syma->name, "compat_SyS", 10))
100 static int choose_best_symbol(struct symbol *syma, struct symbol *symb)
106 /* Prefer a symbol with non zero length */
107 a = syma->end - syma->start;
108 b = symb->end - symb->start;
109 if ((b == 0) && (a > 0))
111 else if ((a == 0) && (b > 0))
114 /* Prefer a non weak symbol over a weak one */
115 a = syma->binding == STB_WEAK;
116 b = symb->binding == STB_WEAK;
122 /* Prefer a global symbol over a non global one */
123 a = syma->binding == STB_GLOBAL;
124 b = symb->binding == STB_GLOBAL;
130 /* Prefer a symbol with less underscores */
131 a = prefix_underscores_count(syma->name);
132 b = prefix_underscores_count(symb->name);
138 /* Choose the symbol with the longest name */
139 na = strlen(syma->name);
140 nb = strlen(symb->name);
146 return arch__choose_best_symbol(syma, symb);
149 void symbols__fixup_duplicate(struct rb_root *symbols)
152 struct symbol *curr, *next;
154 nd = rb_first(symbols);
157 curr = rb_entry(nd, struct symbol, rb_node);
159 nd = rb_next(&curr->rb_node);
160 next = rb_entry(nd, struct symbol, rb_node);
165 if (curr->start != next->start)
168 if (choose_best_symbol(curr, next) == SYMBOL_A) {
169 rb_erase(&next->rb_node, symbols);
170 symbol__delete(next);
173 nd = rb_next(&curr->rb_node);
174 rb_erase(&curr->rb_node, symbols);
175 symbol__delete(curr);
180 void symbols__fixup_end(struct rb_root *symbols)
182 struct rb_node *nd, *prevnd = rb_first(symbols);
183 struct symbol *curr, *prev;
188 curr = rb_entry(prevnd, struct symbol, rb_node);
190 for (nd = rb_next(prevnd); nd; nd = rb_next(nd)) {
192 curr = rb_entry(nd, struct symbol, rb_node);
194 if (prev->end == prev->start && prev->end != curr->start)
195 prev->end = curr->start;
199 if (curr->end == curr->start)
200 curr->end = roundup(curr->start, 4096);
203 void __map_groups__fixup_end(struct map_groups *mg, enum map_type type)
205 struct rb_root *maps = &mg->maps[type];
206 struct map *next, *curr;
208 curr = maps__first(maps);
212 for (next = map__next(curr); next; next = map__next(curr)) {
213 curr->end = next->start;
218 * We still haven't the actual symbols, so guess the
219 * last map final address.
224 struct symbol *symbol__new(u64 start, u64 len, u8 binding, const char *name)
226 size_t namelen = strlen(name) + 1;
227 struct symbol *sym = calloc(1, (symbol_conf.priv_size +
228 sizeof(*sym) + namelen));
232 if (symbol_conf.priv_size)
233 sym = ((void *)sym) + symbol_conf.priv_size;
236 sym->end = len ? start + len : start;
237 sym->binding = binding;
238 sym->namelen = namelen - 1;
240 pr_debug4("%s: %s %#" PRIx64 "-%#" PRIx64 "\n",
241 __func__, name, start, sym->end);
242 memcpy(sym->name, name, namelen);
247 void symbol__delete(struct symbol *sym)
249 free(((void *)sym) - symbol_conf.priv_size);
252 size_t symbol__fprintf(struct symbol *sym, FILE *fp)
254 return fprintf(fp, " %" PRIx64 "-%" PRIx64 " %c %s\n",
255 sym->start, sym->end,
256 sym->binding == STB_GLOBAL ? 'g' :
257 sym->binding == STB_LOCAL ? 'l' : 'w',
261 size_t symbol__fprintf_symname_offs(const struct symbol *sym,
262 const struct addr_location *al, FILE *fp)
264 unsigned long offset;
267 if (sym && sym->name) {
268 length = fprintf(fp, "%s", sym->name);
270 if (al->addr < sym->end)
271 offset = al->addr - sym->start;
273 offset = al->addr - al->map->start - sym->start;
274 length += fprintf(fp, "+0x%lx", offset);
278 return fprintf(fp, "[unknown]");
281 size_t symbol__fprintf_symname(const struct symbol *sym, FILE *fp)
283 return symbol__fprintf_symname_offs(sym, NULL, fp);
286 void symbols__delete(struct rb_root *symbols)
289 struct rb_node *next = rb_first(symbols);
292 pos = rb_entry(next, struct symbol, rb_node);
293 next = rb_next(&pos->rb_node);
294 rb_erase(&pos->rb_node, symbols);
299 void symbols__insert(struct rb_root *symbols, struct symbol *sym)
301 struct rb_node **p = &symbols->rb_node;
302 struct rb_node *parent = NULL;
303 const u64 ip = sym->start;
308 s = rb_entry(parent, struct symbol, rb_node);
314 rb_link_node(&sym->rb_node, parent, p);
315 rb_insert_color(&sym->rb_node, symbols);
318 static struct symbol *symbols__find(struct rb_root *symbols, u64 ip)
325 n = symbols->rb_node;
328 struct symbol *s = rb_entry(n, struct symbol, rb_node);
332 else if (ip >= s->end)
341 static struct symbol *symbols__first(struct rb_root *symbols)
343 struct rb_node *n = rb_first(symbols);
346 return rb_entry(n, struct symbol, rb_node);
351 static struct symbol *symbols__next(struct symbol *sym)
353 struct rb_node *n = rb_next(&sym->rb_node);
356 return rb_entry(n, struct symbol, rb_node);
361 struct symbol_name_rb_node {
362 struct rb_node rb_node;
366 static void symbols__insert_by_name(struct rb_root *symbols, struct symbol *sym)
368 struct rb_node **p = &symbols->rb_node;
369 struct rb_node *parent = NULL;
370 struct symbol_name_rb_node *symn, *s;
372 symn = container_of(sym, struct symbol_name_rb_node, sym);
376 s = rb_entry(parent, struct symbol_name_rb_node, rb_node);
377 if (strcmp(sym->name, s->sym.name) < 0)
382 rb_link_node(&symn->rb_node, parent, p);
383 rb_insert_color(&symn->rb_node, symbols);
386 static void symbols__sort_by_name(struct rb_root *symbols,
387 struct rb_root *source)
391 for (nd = rb_first(source); nd; nd = rb_next(nd)) {
392 struct symbol *pos = rb_entry(nd, struct symbol, rb_node);
393 symbols__insert_by_name(symbols, pos);
397 static struct symbol *symbols__find_by_name(struct rb_root *symbols,
401 struct symbol_name_rb_node *s;
406 n = symbols->rb_node;
411 s = rb_entry(n, struct symbol_name_rb_node, rb_node);
412 cmp = arch__compare_symbol_names(name, s->sym.name);
425 /* return first symbol that has same name (if any) */
426 for (n = rb_prev(n); n; n = rb_prev(n)) {
427 struct symbol_name_rb_node *tmp;
429 tmp = rb_entry(n, struct symbol_name_rb_node, rb_node);
430 if (arch__compare_symbol_names(tmp->sym.name, s->sym.name))
439 struct symbol *dso__find_symbol(struct dso *dso,
440 enum map_type type, u64 addr)
442 return symbols__find(&dso->symbols[type], addr);
445 struct symbol *dso__first_symbol(struct dso *dso, enum map_type type)
447 return symbols__first(&dso->symbols[type]);
450 struct symbol *dso__next_symbol(struct symbol *sym)
452 return symbols__next(sym);
455 struct symbol *symbol__next_by_name(struct symbol *sym)
457 struct symbol_name_rb_node *s = container_of(sym, struct symbol_name_rb_node, sym);
458 struct rb_node *n = rb_next(&s->rb_node);
460 return n ? &rb_entry(n, struct symbol_name_rb_node, rb_node)->sym : NULL;
464 * Teturns first symbol that matched with @name.
466 struct symbol *dso__find_symbol_by_name(struct dso *dso, enum map_type type,
469 return symbols__find_by_name(&dso->symbol_names[type], name);
472 void dso__sort_by_name(struct dso *dso, enum map_type type)
474 dso__set_sorted_by_name(dso, type);
475 return symbols__sort_by_name(&dso->symbol_names[type],
476 &dso->symbols[type]);
479 size_t dso__fprintf_symbols_by_name(struct dso *dso,
480 enum map_type type, FILE *fp)
484 struct symbol_name_rb_node *pos;
486 for (nd = rb_first(&dso->symbol_names[type]); nd; nd = rb_next(nd)) {
487 pos = rb_entry(nd, struct symbol_name_rb_node, rb_node);
488 fprintf(fp, "%s\n", pos->sym.name);
494 int modules__parse(const char *filename, void *arg,
495 int (*process_module)(void *arg, const char *name,
503 file = fopen(filename, "r");
513 line_len = getline(&line, &n, file);
526 line[--line_len] = '\0'; /* \n */
528 sep = strrchr(line, 'x');
532 hex2u64(sep + 1, &start);
534 sep = strchr(line, ' ');
540 scnprintf(name, sizeof(name), "[%s]", line);
542 err = process_module(arg, name, start);
552 struct process_kallsyms_args {
558 * These are symbols in the kernel image, so make sure that
559 * sym is from a kernel DSO.
561 bool symbol__is_idle(struct symbol *sym)
563 const char * const idle_symbols[] = {
572 "mwait_idle_with_hints",
574 "ppc64_runlatch_off",
575 "pseries_dedicated_idle_sleep",
584 for (i = 0; idle_symbols[i]; i++) {
585 if (!strcmp(idle_symbols[i], sym->name))
592 static int map__process_kallsym_symbol(void *arg, const char *name,
593 char type, u64 start)
596 struct process_kallsyms_args *a = arg;
597 struct rb_root *root = &a->dso->symbols[a->map->type];
599 if (!symbol_type__is_a(type, a->map->type))
603 * module symbols are not sorted so we add all
604 * symbols, setting length to 0, and rely on
605 * symbols__fixup_end() to fix it up.
607 sym = symbol__new(start, 0, kallsyms2elf_type(type), name);
611 * We will pass the symbols to the filter later, in
612 * map__split_kallsyms, when we have split the maps per module
614 symbols__insert(root, sym);
620 * Loads the function entries in /proc/kallsyms into kernel_map->dso,
621 * so that we can in the next step set the symbol ->end address and then
622 * call kernel_maps__split_kallsyms.
624 static int dso__load_all_kallsyms(struct dso *dso, const char *filename,
627 struct process_kallsyms_args args = { .map = map, .dso = dso, };
628 return kallsyms__parse(filename, &args, map__process_kallsym_symbol);
631 static int dso__split_kallsyms_for_kcore(struct dso *dso, struct map *map,
632 symbol_filter_t filter)
634 struct map_groups *kmaps = map__kmaps(map);
635 struct map *curr_map;
637 int count = 0, moved = 0;
638 struct rb_root *root = &dso->symbols[map->type];
639 struct rb_node *next = rb_first(root);
647 pos = rb_entry(next, struct symbol, rb_node);
648 next = rb_next(&pos->rb_node);
650 module = strchr(pos->name, '\t');
654 curr_map = map_groups__find(kmaps, map->type, pos->start);
656 if (!curr_map || (filter && filter(curr_map, pos))) {
657 rb_erase(&pos->rb_node, root);
660 pos->start -= curr_map->start - curr_map->pgoff;
662 pos->end -= curr_map->start - curr_map->pgoff;
663 if (curr_map != map) {
664 rb_erase(&pos->rb_node, root);
666 &curr_map->dso->symbols[curr_map->type],
675 /* Symbols have been adjusted */
676 dso->adjust_symbols = 1;
678 return count + moved;
682 * Split the symbols into maps, making sure there are no overlaps, i.e. the
683 * kernel range is broken in several maps, named [kernel].N, as we don't have
684 * the original ELF section names vmlinux have.
686 static int dso__split_kallsyms(struct dso *dso, struct map *map, u64 delta,
687 symbol_filter_t filter)
689 struct map_groups *kmaps = map__kmaps(map);
690 struct machine *machine;
691 struct map *curr_map = map;
693 int count = 0, moved = 0;
694 struct rb_root *root = &dso->symbols[map->type];
695 struct rb_node *next = rb_first(root);
696 int kernel_range = 0;
701 machine = kmaps->machine;
706 pos = rb_entry(next, struct symbol, rb_node);
707 next = rb_next(&pos->rb_node);
709 module = strchr(pos->name, '\t');
711 if (!symbol_conf.use_modules)
716 if (strcmp(curr_map->dso->short_name, module)) {
717 if (curr_map != map &&
718 dso->kernel == DSO_TYPE_GUEST_KERNEL &&
719 machine__is_default_guest(machine)) {
721 * We assume all symbols of a module are
722 * continuous in * kallsyms, so curr_map
723 * points to a module and all its
724 * symbols are in its kmap. Mark it as
727 dso__set_loaded(curr_map->dso,
731 curr_map = map_groups__find_by_name(kmaps,
733 if (curr_map == NULL) {
734 pr_debug("%s/proc/{kallsyms,modules} "
735 "inconsistency while looking "
736 "for \"%s\" module!\n",
737 machine->root_dir, module);
742 if (curr_map->dso->loaded &&
743 !machine__is_default_guest(machine))
747 * So that we look just like we get from .ko files,
748 * i.e. not prelinked, relative to map->start.
750 pos->start = curr_map->map_ip(curr_map, pos->start);
751 pos->end = curr_map->map_ip(curr_map, pos->end);
752 } else if (curr_map != map) {
753 char dso_name[PATH_MAX];
757 /* Kernel was relocated at boot time */
767 if (dso->kernel == DSO_TYPE_GUEST_KERNEL)
768 snprintf(dso_name, sizeof(dso_name),
772 snprintf(dso_name, sizeof(dso_name),
776 ndso = dso__new(dso_name);
780 ndso->kernel = dso->kernel;
782 curr_map = map__new2(pos->start, ndso, map->type);
783 if (curr_map == NULL) {
788 curr_map->map_ip = curr_map->unmap_ip = identity__map_ip;
789 map_groups__insert(kmaps, curr_map);
792 /* Kernel was relocated at boot time */
797 if (filter && filter(curr_map, pos)) {
798 discard_symbol: rb_erase(&pos->rb_node, root);
801 if (curr_map != map) {
802 rb_erase(&pos->rb_node, root);
803 symbols__insert(&curr_map->dso->symbols[curr_map->type], pos);
810 if (curr_map != map &&
811 dso->kernel == DSO_TYPE_GUEST_KERNEL &&
812 machine__is_default_guest(kmaps->machine)) {
813 dso__set_loaded(curr_map->dso, curr_map->type);
816 return count + moved;
819 bool symbol__restricted_filename(const char *filename,
820 const char *restricted_filename)
822 bool restricted = false;
824 if (symbol_conf.kptr_restrict) {
825 char *r = realpath(filename, NULL);
828 restricted = strcmp(r, restricted_filename) == 0;
838 struct rb_node rb_node;
843 static void add_module(struct module_info *mi, struct rb_root *modules)
845 struct rb_node **p = &modules->rb_node;
846 struct rb_node *parent = NULL;
847 struct module_info *m;
851 m = rb_entry(parent, struct module_info, rb_node);
852 if (strcmp(mi->name, m->name) < 0)
857 rb_link_node(&mi->rb_node, parent, p);
858 rb_insert_color(&mi->rb_node, modules);
861 static void delete_modules(struct rb_root *modules)
863 struct module_info *mi;
864 struct rb_node *next = rb_first(modules);
867 mi = rb_entry(next, struct module_info, rb_node);
868 next = rb_next(&mi->rb_node);
869 rb_erase(&mi->rb_node, modules);
875 static struct module_info *find_module(const char *name,
876 struct rb_root *modules)
878 struct rb_node *n = modules->rb_node;
881 struct module_info *m;
884 m = rb_entry(n, struct module_info, rb_node);
885 cmp = strcmp(name, m->name);
897 static int __read_proc_modules(void *arg, const char *name, u64 start)
899 struct rb_root *modules = arg;
900 struct module_info *mi;
902 mi = zalloc(sizeof(struct module_info));
906 mi->name = strdup(name);
914 add_module(mi, modules);
919 static int read_proc_modules(const char *filename, struct rb_root *modules)
921 if (symbol__restricted_filename(filename, "/proc/modules"))
924 if (modules__parse(filename, modules, __read_proc_modules)) {
925 delete_modules(modules);
932 int compare_proc_modules(const char *from, const char *to)
934 struct rb_root from_modules = RB_ROOT;
935 struct rb_root to_modules = RB_ROOT;
936 struct rb_node *from_node, *to_node;
937 struct module_info *from_m, *to_m;
940 if (read_proc_modules(from, &from_modules))
943 if (read_proc_modules(to, &to_modules))
944 goto out_delete_from;
946 from_node = rb_first(&from_modules);
947 to_node = rb_first(&to_modules);
952 from_m = rb_entry(from_node, struct module_info, rb_node);
953 to_m = rb_entry(to_node, struct module_info, rb_node);
955 if (from_m->start != to_m->start ||
956 strcmp(from_m->name, to_m->name))
959 from_node = rb_next(from_node);
960 to_node = rb_next(to_node);
963 if (!from_node && !to_node)
966 delete_modules(&to_modules);
968 delete_modules(&from_modules);
973 static int do_validate_kcore_modules(const char *filename, struct map *map,
974 struct map_groups *kmaps)
976 struct rb_root modules = RB_ROOT;
980 err = read_proc_modules(filename, &modules);
984 old_map = map_groups__first(kmaps, map->type);
986 struct map *next = map_groups__next(old_map);
987 struct module_info *mi;
989 if (old_map == map || old_map->start == map->start) {
995 /* Module must be in memory at the same address */
996 mi = find_module(old_map->dso->short_name, &modules);
997 if (!mi || mi->start != old_map->start) {
1005 delete_modules(&modules);
1010 * If kallsyms is referenced by name then we look for filename in the same
1013 static bool filename_from_kallsyms_filename(char *filename,
1014 const char *base_name,
1015 const char *kallsyms_filename)
1019 strcpy(filename, kallsyms_filename);
1020 name = strrchr(filename, '/');
1026 if (!strcmp(name, "kallsyms")) {
1027 strcpy(name, base_name);
1034 static int validate_kcore_modules(const char *kallsyms_filename,
1037 struct map_groups *kmaps = map__kmaps(map);
1038 char modules_filename[PATH_MAX];
1043 if (!filename_from_kallsyms_filename(modules_filename, "modules",
1047 if (do_validate_kcore_modules(modules_filename, map, kmaps))
1053 static int validate_kcore_addresses(const char *kallsyms_filename,
1056 struct kmap *kmap = map__kmap(map);
1061 if (kmap->ref_reloc_sym && kmap->ref_reloc_sym->name) {
1064 start = kallsyms__get_function_start(kallsyms_filename,
1065 kmap->ref_reloc_sym->name);
1066 if (start != kmap->ref_reloc_sym->addr)
1070 return validate_kcore_modules(kallsyms_filename, map);
1073 struct kcore_mapfn_data {
1076 struct list_head maps;
1079 static int kcore_mapfn(u64 start, u64 len, u64 pgoff, void *data)
1081 struct kcore_mapfn_data *md = data;
1084 map = map__new2(start, md->dso, md->type);
1088 map->end = map->start + len;
1091 list_add(&map->node, &md->maps);
1096 static int dso__load_kcore(struct dso *dso, struct map *map,
1097 const char *kallsyms_filename)
1099 struct map_groups *kmaps = map__kmaps(map);
1100 struct machine *machine;
1101 struct kcore_mapfn_data md;
1102 struct map *old_map, *new_map, *replacement_map = NULL;
1105 char kcore_filename[PATH_MAX];
1111 machine = kmaps->machine;
1113 /* This function requires that the map is the kernel map */
1114 if (map != machine->vmlinux_maps[map->type])
1117 if (!filename_from_kallsyms_filename(kcore_filename, "kcore",
1121 /* Modules and kernel must be present at their original addresses */
1122 if (validate_kcore_addresses(kallsyms_filename, map))
1126 md.type = map->type;
1127 INIT_LIST_HEAD(&md.maps);
1129 fd = open(kcore_filename, O_RDONLY);
1133 /* Read new maps into temporary lists */
1134 err = file__read_maps(fd, md.type == MAP__FUNCTION, kcore_mapfn, &md,
1138 dso->is_64_bit = is_64_bit;
1140 if (list_empty(&md.maps)) {
1145 /* Remove old maps */
1146 old_map = map_groups__first(kmaps, map->type);
1148 struct map *next = map_groups__next(old_map);
1151 map_groups__remove(kmaps, old_map);
1155 /* Find the kernel map using the first symbol */
1156 sym = dso__first_symbol(dso, map->type);
1157 list_for_each_entry(new_map, &md.maps, node) {
1158 if (sym && sym->start >= new_map->start &&
1159 sym->start < new_map->end) {
1160 replacement_map = new_map;
1165 if (!replacement_map)
1166 replacement_map = list_entry(md.maps.next, struct map, node);
1169 while (!list_empty(&md.maps)) {
1170 new_map = list_entry(md.maps.next, struct map, node);
1171 list_del(&new_map->node);
1172 if (new_map == replacement_map) {
1173 map->start = new_map->start;
1174 map->end = new_map->end;
1175 map->pgoff = new_map->pgoff;
1176 map->map_ip = new_map->map_ip;
1177 map->unmap_ip = new_map->unmap_ip;
1178 map__delete(new_map);
1179 /* Ensure maps are correctly ordered */
1180 map_groups__remove(kmaps, map);
1181 map_groups__insert(kmaps, map);
1183 map_groups__insert(kmaps, new_map);
1188 * Set the data type and long name so that kcore can be read via
1189 * dso__data_read_addr().
1191 if (dso->kernel == DSO_TYPE_GUEST_KERNEL)
1192 dso->binary_type = DSO_BINARY_TYPE__GUEST_KCORE;
1194 dso->binary_type = DSO_BINARY_TYPE__KCORE;
1195 dso__set_long_name(dso, strdup(kcore_filename), true);
1199 if (map->type == MAP__FUNCTION)
1200 pr_debug("Using %s for kernel object code\n", kcore_filename);
1202 pr_debug("Using %s for kernel data\n", kcore_filename);
1207 while (!list_empty(&md.maps)) {
1208 map = list_entry(md.maps.next, struct map, node);
1209 list_del(&map->node);
1217 * If the kernel is relocated at boot time, kallsyms won't match. Compute the
1218 * delta based on the relocation reference symbol.
1220 static int kallsyms__delta(struct map *map, const char *filename, u64 *delta)
1222 struct kmap *kmap = map__kmap(map);
1228 if (!kmap->ref_reloc_sym || !kmap->ref_reloc_sym->name)
1231 addr = kallsyms__get_function_start(filename,
1232 kmap->ref_reloc_sym->name);
1236 *delta = addr - kmap->ref_reloc_sym->addr;
1240 int dso__load_kallsyms(struct dso *dso, const char *filename,
1241 struct map *map, symbol_filter_t filter)
1245 if (symbol__restricted_filename(filename, "/proc/kallsyms"))
1248 if (dso__load_all_kallsyms(dso, filename, map) < 0)
1251 if (kallsyms__delta(map, filename, &delta))
1254 symbols__fixup_duplicate(&dso->symbols[map->type]);
1255 symbols__fixup_end(&dso->symbols[map->type]);
1257 if (dso->kernel == DSO_TYPE_GUEST_KERNEL)
1258 dso->symtab_type = DSO_BINARY_TYPE__GUEST_KALLSYMS;
1260 dso->symtab_type = DSO_BINARY_TYPE__KALLSYMS;
1262 if (!dso__load_kcore(dso, map, filename))
1263 return dso__split_kallsyms_for_kcore(dso, map, filter);
1265 return dso__split_kallsyms(dso, map, delta, filter);
1268 static int dso__load_perf_map(struct dso *dso, struct map *map,
1269 symbol_filter_t filter)
1276 file = fopen(dso->long_name, "r");
1280 while (!feof(file)) {
1285 line_len = getline(&line, &n, file);
1292 line[--line_len] = '\0'; /* \n */
1294 len = hex2u64(line, &start);
1297 if (len + 2 >= line_len)
1300 len += hex2u64(line + len, &size);
1303 if (len + 2 >= line_len)
1306 sym = symbol__new(start, size, STB_GLOBAL, line + len);
1309 goto out_delete_line;
1311 if (filter && filter(map, sym))
1312 symbol__delete(sym);
1314 symbols__insert(&dso->symbols[map->type], sym);
1330 static bool dso__is_compatible_symtab_type(struct dso *dso, bool kmod,
1331 enum dso_binary_type type)
1334 case DSO_BINARY_TYPE__JAVA_JIT:
1335 case DSO_BINARY_TYPE__DEBUGLINK:
1336 case DSO_BINARY_TYPE__SYSTEM_PATH_DSO:
1337 case DSO_BINARY_TYPE__FEDORA_DEBUGINFO:
1338 case DSO_BINARY_TYPE__UBUNTU_DEBUGINFO:
1339 case DSO_BINARY_TYPE__BUILDID_DEBUGINFO:
1340 case DSO_BINARY_TYPE__OPENEMBEDDED_DEBUGINFO:
1341 return !kmod && dso->kernel == DSO_TYPE_USER;
1343 case DSO_BINARY_TYPE__KALLSYMS:
1344 case DSO_BINARY_TYPE__VMLINUX:
1345 case DSO_BINARY_TYPE__KCORE:
1346 return dso->kernel == DSO_TYPE_KERNEL;
1348 case DSO_BINARY_TYPE__GUEST_KALLSYMS:
1349 case DSO_BINARY_TYPE__GUEST_VMLINUX:
1350 case DSO_BINARY_TYPE__GUEST_KCORE:
1351 return dso->kernel == DSO_TYPE_GUEST_KERNEL;
1353 case DSO_BINARY_TYPE__GUEST_KMODULE:
1354 case DSO_BINARY_TYPE__GUEST_KMODULE_COMP:
1355 case DSO_BINARY_TYPE__SYSTEM_PATH_KMODULE:
1356 case DSO_BINARY_TYPE__SYSTEM_PATH_KMODULE_COMP:
1358 * kernel modules know their symtab type - it's set when
1359 * creating a module dso in machine__new_module().
1361 return kmod && dso->symtab_type == type;
1363 case DSO_BINARY_TYPE__BUILD_ID_CACHE:
1366 case DSO_BINARY_TYPE__NOT_FOUND:
1372 int dso__load(struct dso *dso, struct map *map, symbol_filter_t filter)
1377 struct machine *machine;
1378 char *root_dir = (char *) "";
1380 struct symsrc ss_[2];
1381 struct symsrc *syms_ss = NULL, *runtime_ss = NULL;
1384 pthread_mutex_lock(&dso->lock);
1386 /* check again under the dso->lock */
1387 if (dso__loaded(dso, map->type)) {
1393 if (dso->kernel == DSO_TYPE_KERNEL)
1394 ret = dso__load_kernel_sym(dso, map, filter);
1395 else if (dso->kernel == DSO_TYPE_GUEST_KERNEL)
1396 ret = dso__load_guest_kernel_sym(dso, map, filter);
1401 if (map->groups && map->groups->machine)
1402 machine = map->groups->machine;
1406 dso->adjust_symbols = 0;
1408 if (strncmp(dso->name, "/tmp/perf-", 10) == 0) {
1411 if (lstat(dso->name, &st) < 0)
1414 if (st.st_uid && (st.st_uid != geteuid())) {
1415 pr_warning("File %s not owned by current user or root, "
1416 "ignoring it.\n", dso->name);
1420 ret = dso__load_perf_map(dso, map, filter);
1421 dso->symtab_type = ret > 0 ? DSO_BINARY_TYPE__JAVA_JIT :
1422 DSO_BINARY_TYPE__NOT_FOUND;
1427 root_dir = machine->root_dir;
1429 name = malloc(PATH_MAX);
1433 kmod = dso->symtab_type == DSO_BINARY_TYPE__SYSTEM_PATH_KMODULE ||
1434 dso->symtab_type == DSO_BINARY_TYPE__SYSTEM_PATH_KMODULE_COMP ||
1435 dso->symtab_type == DSO_BINARY_TYPE__GUEST_KMODULE ||
1436 dso->symtab_type == DSO_BINARY_TYPE__GUEST_KMODULE_COMP;
1439 * Iterate over candidate debug images.
1440 * Keep track of "interesting" ones (those which have a symtab, dynsym,
1441 * and/or opd section) for processing.
1443 for (i = 0; i < DSO_BINARY_TYPE__SYMTAB_CNT; i++) {
1444 struct symsrc *ss = &ss_[ss_pos];
1445 bool next_slot = false;
1447 enum dso_binary_type symtab_type = binary_type_symtab[i];
1449 if (!dso__is_compatible_symtab_type(dso, kmod, symtab_type))
1452 if (dso__read_binary_type_filename(dso, symtab_type,
1453 root_dir, name, PATH_MAX))
1456 /* Name is now the name of the next image to try */
1457 if (symsrc__init(ss, dso, name, symtab_type) < 0)
1460 if (!syms_ss && symsrc__has_symtab(ss)) {
1463 if (!dso->symsrc_filename)
1464 dso->symsrc_filename = strdup(name);
1467 if (!runtime_ss && symsrc__possibly_runtime(ss)) {
1475 if (syms_ss && runtime_ss)
1478 symsrc__destroy(ss);
1483 if (!runtime_ss && !syms_ss)
1486 if (runtime_ss && !syms_ss) {
1487 syms_ss = runtime_ss;
1490 /* We'll have to hope for the best */
1491 if (!runtime_ss && syms_ss)
1492 runtime_ss = syms_ss;
1495 ret = dso__load_sym(dso, map, syms_ss, runtime_ss, filter, kmod);
1502 nr_plt = dso__synthesize_plt_symbols(dso, runtime_ss, map, filter);
1507 for (; ss_pos > 0; ss_pos--)
1508 symsrc__destroy(&ss_[ss_pos - 1]);
1511 if (ret < 0 && strstr(dso->name, " (deleted)") != NULL)
1514 dso__set_loaded(dso, map->type);
1515 pthread_mutex_unlock(&dso->lock);
1520 struct map *map_groups__find_by_name(struct map_groups *mg,
1521 enum map_type type, const char *name)
1523 struct rb_root *maps = &mg->maps[type];
1526 for (map = maps__first(maps); map; map = map__next(map)) {
1527 if (map->dso && strcmp(map->dso->short_name, name) == 0)
1534 int dso__load_vmlinux(struct dso *dso, struct map *map,
1535 const char *vmlinux, bool vmlinux_allocated,
1536 symbol_filter_t filter)
1540 char symfs_vmlinux[PATH_MAX];
1541 enum dso_binary_type symtab_type;
1543 if (vmlinux[0] == '/')
1544 snprintf(symfs_vmlinux, sizeof(symfs_vmlinux), "%s", vmlinux);
1546 symbol__join_symfs(symfs_vmlinux, vmlinux);
1548 if (dso->kernel == DSO_TYPE_GUEST_KERNEL)
1549 symtab_type = DSO_BINARY_TYPE__GUEST_VMLINUX;
1551 symtab_type = DSO_BINARY_TYPE__VMLINUX;
1553 if (symsrc__init(&ss, dso, symfs_vmlinux, symtab_type))
1556 err = dso__load_sym(dso, map, &ss, &ss, filter, 0);
1557 symsrc__destroy(&ss);
1560 if (dso->kernel == DSO_TYPE_GUEST_KERNEL)
1561 dso->binary_type = DSO_BINARY_TYPE__GUEST_VMLINUX;
1563 dso->binary_type = DSO_BINARY_TYPE__VMLINUX;
1564 dso__set_long_name(dso, vmlinux, vmlinux_allocated);
1565 dso__set_loaded(dso, map->type);
1566 pr_debug("Using %s for symbols\n", symfs_vmlinux);
1572 int dso__load_vmlinux_path(struct dso *dso, struct map *map,
1573 symbol_filter_t filter)
1576 char *filename = NULL;
1578 if (!symbol_conf.ignore_vmlinux_buildid)
1579 filename = dso__build_id_filename(dso, NULL, 0);
1580 if (filename != NULL) {
1581 err = dso__load_vmlinux(dso, map, filename, true, filter);
1587 pr_debug("Looking at the vmlinux_path (%d entries long)\n",
1588 vmlinux_path__nr_entries + 1);
1590 for (i = 0; i < vmlinux_path__nr_entries; ++i) {
1591 err = dso__load_vmlinux(dso, map, vmlinux_path[i], false, filter);
1599 static int find_matching_kcore(struct map *map, char *dir, size_t dir_sz)
1601 char kallsyms_filename[PATH_MAX];
1602 struct dirent *dent;
1614 if (dent->d_type != DT_DIR)
1616 scnprintf(kallsyms_filename, sizeof(kallsyms_filename),
1617 "%s/%s/kallsyms", dir, dent->d_name);
1618 if (!validate_kcore_addresses(kallsyms_filename, map)) {
1619 strlcpy(dir, kallsyms_filename, dir_sz);
1630 static char *dso__find_kallsyms(struct dso *dso, struct map *map)
1632 u8 host_build_id[BUILD_ID_SIZE];
1633 char sbuild_id[BUILD_ID_SIZE * 2 + 1];
1634 bool is_host = false;
1635 char path[PATH_MAX];
1637 if (!dso->has_build_id) {
1639 * Last resort, if we don't have a build-id and couldn't find
1640 * any vmlinux file, try the running kernel kallsyms table.
1645 if (sysfs__read_build_id("/sys/kernel/notes", host_build_id,
1646 sizeof(host_build_id)) == 0)
1647 is_host = dso__build_id_equal(dso, host_build_id);
1649 build_id__sprintf(dso->build_id, sizeof(dso->build_id), sbuild_id);
1651 scnprintf(path, sizeof(path), "%s/[kernel.kcore]/%s", buildid_dir,
1654 /* Use /proc/kallsyms if possible */
1659 /* If no cached kcore go with /proc/kallsyms */
1666 * Do not check the build-id cache, until we know we cannot use
1669 fd = open("/proc/kcore", O_RDONLY);
1672 /* If module maps match go with /proc/kallsyms */
1673 if (!validate_kcore_addresses("/proc/kallsyms", map))
1677 /* Find kallsyms in build-id cache with kcore */
1678 if (!find_matching_kcore(map, path, sizeof(path)))
1679 return strdup(path);
1684 /* Find kallsyms in build-id cache with kcore */
1685 if (!find_matching_kcore(map, path, sizeof(path)))
1686 return strdup(path);
1688 scnprintf(path, sizeof(path), "%s/[kernel.kallsyms]/%s",
1689 buildid_dir, sbuild_id);
1691 if (access(path, F_OK)) {
1692 pr_err("No kallsyms or vmlinux with build-id %s was found\n",
1697 return strdup(path);
1700 return strdup("/proc/kallsyms");
1703 static int dso__load_kernel_sym(struct dso *dso, struct map *map,
1704 symbol_filter_t filter)
1707 const char *kallsyms_filename = NULL;
1708 char *kallsyms_allocated_filename = NULL;
1710 * Step 1: if the user specified a kallsyms or vmlinux filename, use
1711 * it and only it, reporting errors to the user if it cannot be used.
1713 * For instance, try to analyse an ARM perf.data file _without_ a
1714 * build-id, or if the user specifies the wrong path to the right
1715 * vmlinux file, obviously we can't fallback to another vmlinux (a
1716 * x86_86 one, on the machine where analysis is being performed, say),
1717 * or worse, /proc/kallsyms.
1719 * If the specified file _has_ a build-id and there is a build-id
1720 * section in the perf.data file, we will still do the expected
1721 * validation in dso__load_vmlinux and will bail out if they don't
1724 if (symbol_conf.kallsyms_name != NULL) {
1725 kallsyms_filename = symbol_conf.kallsyms_name;
1729 if (!symbol_conf.ignore_vmlinux && symbol_conf.vmlinux_name != NULL) {
1730 return dso__load_vmlinux(dso, map, symbol_conf.vmlinux_name,
1734 if (!symbol_conf.ignore_vmlinux && vmlinux_path != NULL) {
1735 err = dso__load_vmlinux_path(dso, map, filter);
1740 /* do not try local files if a symfs was given */
1741 if (symbol_conf.symfs[0] != 0)
1744 kallsyms_allocated_filename = dso__find_kallsyms(dso, map);
1745 if (!kallsyms_allocated_filename)
1748 kallsyms_filename = kallsyms_allocated_filename;
1751 err = dso__load_kallsyms(dso, kallsyms_filename, map, filter);
1753 pr_debug("Using %s for symbols\n", kallsyms_filename);
1754 free(kallsyms_allocated_filename);
1756 if (err > 0 && !dso__is_kcore(dso)) {
1757 dso->binary_type = DSO_BINARY_TYPE__KALLSYMS;
1758 dso__set_long_name(dso, "[kernel.kallsyms]", false);
1759 map__fixup_start(map);
1760 map__fixup_end(map);
1766 static int dso__load_guest_kernel_sym(struct dso *dso, struct map *map,
1767 symbol_filter_t filter)
1770 const char *kallsyms_filename = NULL;
1771 struct machine *machine;
1772 char path[PATH_MAX];
1775 pr_debug("Guest kernel map hasn't the point to groups\n");
1778 machine = map->groups->machine;
1780 if (machine__is_default_guest(machine)) {
1782 * if the user specified a vmlinux filename, use it and only
1783 * it, reporting errors to the user if it cannot be used.
1784 * Or use file guest_kallsyms inputted by user on commandline
1786 if (symbol_conf.default_guest_vmlinux_name != NULL) {
1787 err = dso__load_vmlinux(dso, map,
1788 symbol_conf.default_guest_vmlinux_name,
1793 kallsyms_filename = symbol_conf.default_guest_kallsyms;
1794 if (!kallsyms_filename)
1797 sprintf(path, "%s/proc/kallsyms", machine->root_dir);
1798 kallsyms_filename = path;
1801 err = dso__load_kallsyms(dso, kallsyms_filename, map, filter);
1803 pr_debug("Using %s for symbols\n", kallsyms_filename);
1804 if (err > 0 && !dso__is_kcore(dso)) {
1805 dso->binary_type = DSO_BINARY_TYPE__GUEST_KALLSYMS;
1806 machine__mmap_name(machine, path, sizeof(path));
1807 dso__set_long_name(dso, strdup(path), true);
1808 map__fixup_start(map);
1809 map__fixup_end(map);
1815 static void vmlinux_path__exit(void)
1817 while (--vmlinux_path__nr_entries >= 0)
1818 zfree(&vmlinux_path[vmlinux_path__nr_entries]);
1819 vmlinux_path__nr_entries = 0;
1821 zfree(&vmlinux_path);
1824 static int vmlinux_path__init(struct perf_session_env *env)
1828 char *kernel_version;
1830 vmlinux_path = malloc(sizeof(char *) * 6);
1831 if (vmlinux_path == NULL)
1834 vmlinux_path[vmlinux_path__nr_entries] = strdup("vmlinux");
1835 if (vmlinux_path[vmlinux_path__nr_entries] == NULL)
1837 ++vmlinux_path__nr_entries;
1838 vmlinux_path[vmlinux_path__nr_entries] = strdup("/boot/vmlinux");
1839 if (vmlinux_path[vmlinux_path__nr_entries] == NULL)
1841 ++vmlinux_path__nr_entries;
1843 /* only try kernel version if no symfs was given */
1844 if (symbol_conf.symfs[0] != 0)
1848 kernel_version = env->os_release;
1850 if (uname(&uts) < 0)
1853 kernel_version = uts.release;
1856 snprintf(bf, sizeof(bf), "/boot/vmlinux-%s", kernel_version);
1857 vmlinux_path[vmlinux_path__nr_entries] = strdup(bf);
1858 if (vmlinux_path[vmlinux_path__nr_entries] == NULL)
1860 ++vmlinux_path__nr_entries;
1861 snprintf(bf, sizeof(bf), "/usr/lib/debug/boot/vmlinux-%s",
1863 vmlinux_path[vmlinux_path__nr_entries] = strdup(bf);
1864 if (vmlinux_path[vmlinux_path__nr_entries] == NULL)
1866 ++vmlinux_path__nr_entries;
1867 snprintf(bf, sizeof(bf), "/lib/modules/%s/build/vmlinux", kernel_version);
1868 vmlinux_path[vmlinux_path__nr_entries] = strdup(bf);
1869 if (vmlinux_path[vmlinux_path__nr_entries] == NULL)
1871 ++vmlinux_path__nr_entries;
1872 snprintf(bf, sizeof(bf), "/usr/lib/debug/lib/modules/%s/vmlinux",
1874 vmlinux_path[vmlinux_path__nr_entries] = strdup(bf);
1875 if (vmlinux_path[vmlinux_path__nr_entries] == NULL)
1877 ++vmlinux_path__nr_entries;
1882 vmlinux_path__exit();
1886 int setup_list(struct strlist **list, const char *list_str,
1887 const char *list_name)
1889 if (list_str == NULL)
1892 *list = strlist__new(true, list_str);
1894 pr_err("problems parsing %s list\n", list_name);
1900 int setup_intlist(struct intlist **list, const char *list_str,
1901 const char *list_name)
1903 if (list_str == NULL)
1906 *list = intlist__new(list_str);
1908 pr_err("problems parsing %s list\n", list_name);
1914 static bool symbol__read_kptr_restrict(void)
1918 if (geteuid() != 0) {
1919 FILE *fp = fopen("/proc/sys/kernel/kptr_restrict", "r");
1923 if (fgets(line, sizeof(line), fp) != NULL)
1924 value = atoi(line) != 0;
1933 int symbol__init(struct perf_session_env *env)
1937 if (symbol_conf.initialized)
1940 symbol_conf.priv_size = PERF_ALIGN(symbol_conf.priv_size, sizeof(u64));
1944 if (symbol_conf.sort_by_name)
1945 symbol_conf.priv_size += (sizeof(struct symbol_name_rb_node) -
1946 sizeof(struct symbol));
1948 if (symbol_conf.try_vmlinux_path && vmlinux_path__init(env) < 0)
1951 if (symbol_conf.field_sep && *symbol_conf.field_sep == '.') {
1952 pr_err("'.' is the only non valid --field-separator argument\n");
1956 if (setup_list(&symbol_conf.dso_list,
1957 symbol_conf.dso_list_str, "dso") < 0)
1960 if (setup_list(&symbol_conf.comm_list,
1961 symbol_conf.comm_list_str, "comm") < 0)
1962 goto out_free_dso_list;
1964 if (setup_intlist(&symbol_conf.pid_list,
1965 symbol_conf.pid_list_str, "pid") < 0)
1966 goto out_free_comm_list;
1968 if (setup_intlist(&symbol_conf.tid_list,
1969 symbol_conf.tid_list_str, "tid") < 0)
1970 goto out_free_pid_list;
1972 if (setup_list(&symbol_conf.sym_list,
1973 symbol_conf.sym_list_str, "symbol") < 0)
1974 goto out_free_tid_list;
1977 * A path to symbols of "/" is identical to ""
1978 * reset here for simplicity.
1980 symfs = realpath(symbol_conf.symfs, NULL);
1982 symfs = symbol_conf.symfs;
1983 if (strcmp(symfs, "/") == 0)
1984 symbol_conf.symfs = "";
1985 if (symfs != symbol_conf.symfs)
1986 free((void *)symfs);
1988 symbol_conf.kptr_restrict = symbol__read_kptr_restrict();
1990 symbol_conf.initialized = true;
1994 intlist__delete(symbol_conf.tid_list);
1996 intlist__delete(symbol_conf.pid_list);
1998 strlist__delete(symbol_conf.comm_list);
2000 strlist__delete(symbol_conf.dso_list);
2004 void symbol__exit(void)
2006 if (!symbol_conf.initialized)
2008 strlist__delete(symbol_conf.sym_list);
2009 strlist__delete(symbol_conf.dso_list);
2010 strlist__delete(symbol_conf.comm_list);
2011 intlist__delete(symbol_conf.tid_list);
2012 intlist__delete(symbol_conf.pid_list);
2013 vmlinux_path__exit();
2014 symbol_conf.sym_list = symbol_conf.dso_list = symbol_conf.comm_list = NULL;
2015 symbol_conf.initialized = false;