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__MIXEDUP_UBUNTU_DEBUGINFO,
60 DSO_BINARY_TYPE__NOT_FOUND,
63 #define DSO_BINARY_TYPE__SYMTAB_CNT ARRAY_SIZE(binary_type_symtab)
65 bool symbol_type__is_a(char symbol_type, enum map_type map_type)
67 symbol_type = toupper(symbol_type);
71 return symbol_type == 'T' || symbol_type == 'W';
73 return symbol_type == 'D';
79 static int prefix_underscores_count(const char *str)
81 const char *tail = str;
89 int __weak arch__choose_best_symbol(struct symbol *syma,
90 struct symbol *symb __maybe_unused)
92 /* Avoid "SyS" kernel syscall aliases */
93 if (strlen(syma->name) >= 3 && !strncmp(syma->name, "SyS", 3))
95 if (strlen(syma->name) >= 10 && !strncmp(syma->name, "compat_SyS", 10))
101 static int choose_best_symbol(struct symbol *syma, struct symbol *symb)
107 /* Prefer a symbol with non zero length */
108 a = syma->end - syma->start;
109 b = symb->end - symb->start;
110 if ((b == 0) && (a > 0))
112 else if ((a == 0) && (b > 0))
115 /* Prefer a non weak symbol over a weak one */
116 a = syma->binding == STB_WEAK;
117 b = symb->binding == STB_WEAK;
123 /* Prefer a global symbol over a non global one */
124 a = syma->binding == STB_GLOBAL;
125 b = symb->binding == STB_GLOBAL;
131 /* Prefer a symbol with less underscores */
132 a = prefix_underscores_count(syma->name);
133 b = prefix_underscores_count(symb->name);
139 /* Choose the symbol with the longest name */
140 na = strlen(syma->name);
141 nb = strlen(symb->name);
147 return arch__choose_best_symbol(syma, symb);
150 void symbols__fixup_duplicate(struct rb_root *symbols)
153 struct symbol *curr, *next;
155 if (symbol_conf.allow_aliases)
158 nd = rb_first(symbols);
161 curr = rb_entry(nd, struct symbol, rb_node);
163 nd = rb_next(&curr->rb_node);
164 next = rb_entry(nd, struct symbol, rb_node);
169 if (curr->start != next->start)
172 if (choose_best_symbol(curr, next) == SYMBOL_A) {
173 rb_erase(&next->rb_node, symbols);
174 symbol__delete(next);
177 nd = rb_next(&curr->rb_node);
178 rb_erase(&curr->rb_node, symbols);
179 symbol__delete(curr);
184 void symbols__fixup_end(struct rb_root *symbols)
186 struct rb_node *nd, *prevnd = rb_first(symbols);
187 struct symbol *curr, *prev;
192 curr = rb_entry(prevnd, struct symbol, rb_node);
194 for (nd = rb_next(prevnd); nd; nd = rb_next(nd)) {
196 curr = rb_entry(nd, struct symbol, rb_node);
198 if (prev->end == prev->start && prev->end != curr->start)
199 prev->end = curr->start;
203 if (curr->end == curr->start)
204 curr->end = roundup(curr->start, 4096) + 4096;
207 void __map_groups__fixup_end(struct map_groups *mg, enum map_type type)
209 struct maps *maps = &mg->maps[type];
210 struct map *next, *curr;
212 pthread_rwlock_wrlock(&maps->lock);
214 curr = maps__first(maps);
218 for (next = map__next(curr); next; next = map__next(curr)) {
219 curr->end = next->start;
224 * We still haven't the actual symbols, so guess the
225 * last map final address.
230 pthread_rwlock_unlock(&maps->lock);
233 struct symbol *symbol__new(u64 start, u64 len, u8 binding, const char *name)
235 size_t namelen = strlen(name) + 1;
236 struct symbol *sym = calloc(1, (symbol_conf.priv_size +
237 sizeof(*sym) + namelen));
241 if (symbol_conf.priv_size)
242 sym = ((void *)sym) + symbol_conf.priv_size;
245 sym->end = len ? start + len : start;
246 sym->binding = binding;
247 sym->namelen = namelen - 1;
249 pr_debug4("%s: %s %#" PRIx64 "-%#" PRIx64 "\n",
250 __func__, name, start, sym->end);
251 memcpy(sym->name, name, namelen);
256 void symbol__delete(struct symbol *sym)
258 free(((void *)sym) - symbol_conf.priv_size);
261 size_t symbol__fprintf(struct symbol *sym, FILE *fp)
263 return fprintf(fp, " %" PRIx64 "-%" PRIx64 " %c %s\n",
264 sym->start, sym->end,
265 sym->binding == STB_GLOBAL ? 'g' :
266 sym->binding == STB_LOCAL ? 'l' : 'w',
270 size_t symbol__fprintf_symname_offs(const struct symbol *sym,
271 const struct addr_location *al, FILE *fp)
273 unsigned long offset;
276 if (sym && sym->name) {
277 length = fprintf(fp, "%s", sym->name);
279 if (al->addr < sym->end)
280 offset = al->addr - sym->start;
282 offset = al->addr - al->map->start - sym->start;
283 length += fprintf(fp, "+0x%lx", offset);
287 return fprintf(fp, "[unknown]");
290 size_t symbol__fprintf_symname(const struct symbol *sym, FILE *fp)
292 return symbol__fprintf_symname_offs(sym, NULL, fp);
295 void symbols__delete(struct rb_root *symbols)
298 struct rb_node *next = rb_first(symbols);
301 pos = rb_entry(next, struct symbol, rb_node);
302 next = rb_next(&pos->rb_node);
303 rb_erase(&pos->rb_node, symbols);
308 void symbols__insert(struct rb_root *symbols, struct symbol *sym)
310 struct rb_node **p = &symbols->rb_node;
311 struct rb_node *parent = NULL;
312 const u64 ip = sym->start;
317 s = rb_entry(parent, struct symbol, rb_node);
323 rb_link_node(&sym->rb_node, parent, p);
324 rb_insert_color(&sym->rb_node, symbols);
327 static struct symbol *symbols__find(struct rb_root *symbols, u64 ip)
334 n = symbols->rb_node;
337 struct symbol *s = rb_entry(n, struct symbol, rb_node);
341 else if (ip >= s->end)
350 static struct symbol *symbols__first(struct rb_root *symbols)
352 struct rb_node *n = rb_first(symbols);
355 return rb_entry(n, struct symbol, rb_node);
360 static struct symbol *symbols__next(struct symbol *sym)
362 struct rb_node *n = rb_next(&sym->rb_node);
365 return rb_entry(n, struct symbol, rb_node);
370 struct symbol_name_rb_node {
371 struct rb_node rb_node;
375 static void symbols__insert_by_name(struct rb_root *symbols, struct symbol *sym)
377 struct rb_node **p = &symbols->rb_node;
378 struct rb_node *parent = NULL;
379 struct symbol_name_rb_node *symn, *s;
381 symn = container_of(sym, struct symbol_name_rb_node, sym);
385 s = rb_entry(parent, struct symbol_name_rb_node, rb_node);
386 if (strcmp(sym->name, s->sym.name) < 0)
391 rb_link_node(&symn->rb_node, parent, p);
392 rb_insert_color(&symn->rb_node, symbols);
395 static void symbols__sort_by_name(struct rb_root *symbols,
396 struct rb_root *source)
400 for (nd = rb_first(source); nd; nd = rb_next(nd)) {
401 struct symbol *pos = rb_entry(nd, struct symbol, rb_node);
402 symbols__insert_by_name(symbols, pos);
406 static struct symbol *symbols__find_by_name(struct rb_root *symbols,
410 struct symbol_name_rb_node *s = NULL;
415 n = symbols->rb_node;
420 s = rb_entry(n, struct symbol_name_rb_node, rb_node);
421 cmp = arch__compare_symbol_names(name, s->sym.name);
434 /* return first symbol that has same name (if any) */
435 for (n = rb_prev(n); n; n = rb_prev(n)) {
436 struct symbol_name_rb_node *tmp;
438 tmp = rb_entry(n, struct symbol_name_rb_node, rb_node);
439 if (arch__compare_symbol_names(tmp->sym.name, s->sym.name))
448 void dso__reset_find_symbol_cache(struct dso *dso)
452 for (type = MAP__FUNCTION; type <= MAP__VARIABLE; ++type) {
453 dso->last_find_result[type].addr = 0;
454 dso->last_find_result[type].symbol = NULL;
458 struct symbol *dso__find_symbol(struct dso *dso,
459 enum map_type type, u64 addr)
461 if (dso->last_find_result[type].addr != addr) {
462 dso->last_find_result[type].addr = addr;
463 dso->last_find_result[type].symbol = symbols__find(&dso->symbols[type], addr);
466 return dso->last_find_result[type].symbol;
469 struct symbol *dso__first_symbol(struct dso *dso, enum map_type type)
471 return symbols__first(&dso->symbols[type]);
474 struct symbol *dso__next_symbol(struct symbol *sym)
476 return symbols__next(sym);
479 struct symbol *symbol__next_by_name(struct symbol *sym)
481 struct symbol_name_rb_node *s = container_of(sym, struct symbol_name_rb_node, sym);
482 struct rb_node *n = rb_next(&s->rb_node);
484 return n ? &rb_entry(n, struct symbol_name_rb_node, rb_node)->sym : NULL;
488 * Teturns first symbol that matched with @name.
490 struct symbol *dso__find_symbol_by_name(struct dso *dso, enum map_type type,
493 return symbols__find_by_name(&dso->symbol_names[type], name);
496 void dso__sort_by_name(struct dso *dso, enum map_type type)
498 dso__set_sorted_by_name(dso, type);
499 return symbols__sort_by_name(&dso->symbol_names[type],
500 &dso->symbols[type]);
503 size_t dso__fprintf_symbols_by_name(struct dso *dso,
504 enum map_type type, FILE *fp)
508 struct symbol_name_rb_node *pos;
510 for (nd = rb_first(&dso->symbol_names[type]); nd; nd = rb_next(nd)) {
511 pos = rb_entry(nd, struct symbol_name_rb_node, rb_node);
512 fprintf(fp, "%s\n", pos->sym.name);
518 int modules__parse(const char *filename, void *arg,
519 int (*process_module)(void *arg, const char *name,
527 file = fopen(filename, "r");
537 line_len = getline(&line, &n, file);
550 line[--line_len] = '\0'; /* \n */
552 sep = strrchr(line, 'x');
556 hex2u64(sep + 1, &start);
558 sep = strchr(line, ' ');
564 scnprintf(name, sizeof(name), "[%s]", line);
566 err = process_module(arg, name, start);
576 struct process_kallsyms_args {
582 * These are symbols in the kernel image, so make sure that
583 * sym is from a kernel DSO.
585 bool symbol__is_idle(struct symbol *sym)
587 const char * const idle_symbols[] = {
596 "mwait_idle_with_hints",
598 "ppc64_runlatch_off",
599 "pseries_dedicated_idle_sleep",
608 for (i = 0; idle_symbols[i]; i++) {
609 if (!strcmp(idle_symbols[i], sym->name))
616 static int map__process_kallsym_symbol(void *arg, const char *name,
617 char type, u64 start)
620 struct process_kallsyms_args *a = arg;
621 struct rb_root *root = &a->dso->symbols[a->map->type];
623 if (!symbol_type__is_a(type, a->map->type))
627 * module symbols are not sorted so we add all
628 * symbols, setting length to 0, and rely on
629 * symbols__fixup_end() to fix it up.
631 sym = symbol__new(start, 0, kallsyms2elf_binding(type), name);
635 * We will pass the symbols to the filter later, in
636 * map__split_kallsyms, when we have split the maps per module
638 symbols__insert(root, sym);
644 * Loads the function entries in /proc/kallsyms into kernel_map->dso,
645 * so that we can in the next step set the symbol ->end address and then
646 * call kernel_maps__split_kallsyms.
648 static int dso__load_all_kallsyms(struct dso *dso, const char *filename,
651 struct process_kallsyms_args args = { .map = map, .dso = dso, };
652 return kallsyms__parse(filename, &args, map__process_kallsym_symbol);
655 static int dso__split_kallsyms_for_kcore(struct dso *dso, struct map *map,
656 symbol_filter_t filter)
658 struct map_groups *kmaps = map__kmaps(map);
659 struct map *curr_map;
662 struct rb_root old_root = dso->symbols[map->type];
663 struct rb_root *root = &dso->symbols[map->type];
664 struct rb_node *next = rb_first(root);
674 pos = rb_entry(next, struct symbol, rb_node);
675 next = rb_next(&pos->rb_node);
677 rb_erase_init(&pos->rb_node, &old_root);
679 module = strchr(pos->name, '\t');
683 curr_map = map_groups__find(kmaps, map->type, pos->start);
685 if (!curr_map || (filter && filter(curr_map, pos))) {
690 pos->start -= curr_map->start - curr_map->pgoff;
692 pos->end -= curr_map->start - curr_map->pgoff;
693 symbols__insert(&curr_map->dso->symbols[curr_map->type], pos);
697 /* Symbols have been adjusted */
698 dso->adjust_symbols = 1;
704 * Split the symbols into maps, making sure there are no overlaps, i.e. the
705 * kernel range is broken in several maps, named [kernel].N, as we don't have
706 * the original ELF section names vmlinux have.
708 static int dso__split_kallsyms(struct dso *dso, struct map *map, u64 delta,
709 symbol_filter_t filter)
711 struct map_groups *kmaps = map__kmaps(map);
712 struct machine *machine;
713 struct map *curr_map = map;
715 int count = 0, moved = 0;
716 struct rb_root *root = &dso->symbols[map->type];
717 struct rb_node *next = rb_first(root);
718 int kernel_range = 0;
723 machine = kmaps->machine;
728 pos = rb_entry(next, struct symbol, rb_node);
729 next = rb_next(&pos->rb_node);
731 module = strchr(pos->name, '\t');
733 if (!symbol_conf.use_modules)
738 if (strcmp(curr_map->dso->short_name, module)) {
739 if (curr_map != map &&
740 dso->kernel == DSO_TYPE_GUEST_KERNEL &&
741 machine__is_default_guest(machine)) {
743 * We assume all symbols of a module are
744 * continuous in * kallsyms, so curr_map
745 * points to a module and all its
746 * symbols are in its kmap. Mark it as
749 dso__set_loaded(curr_map->dso,
753 curr_map = map_groups__find_by_name(kmaps,
755 if (curr_map == NULL) {
756 pr_debug("%s/proc/{kallsyms,modules} "
757 "inconsistency while looking "
758 "for \"%s\" module!\n",
759 machine->root_dir, module);
764 if (curr_map->dso->loaded &&
765 !machine__is_default_guest(machine))
769 * So that we look just like we get from .ko files,
770 * i.e. not prelinked, relative to map->start.
772 pos->start = curr_map->map_ip(curr_map, pos->start);
773 pos->end = curr_map->map_ip(curr_map, pos->end);
774 } else if (curr_map != map) {
775 char dso_name[PATH_MAX];
779 /* Kernel was relocated at boot time */
789 if (dso->kernel == DSO_TYPE_GUEST_KERNEL)
790 snprintf(dso_name, sizeof(dso_name),
794 snprintf(dso_name, sizeof(dso_name),
798 ndso = dso__new(dso_name);
802 ndso->kernel = dso->kernel;
804 curr_map = map__new2(pos->start, ndso, map->type);
805 if (curr_map == NULL) {
810 curr_map->map_ip = curr_map->unmap_ip = identity__map_ip;
811 map_groups__insert(kmaps, curr_map);
814 /* Kernel was relocated at boot time */
819 if (filter && filter(curr_map, pos)) {
820 discard_symbol: rb_erase(&pos->rb_node, root);
823 if (curr_map != map) {
824 rb_erase(&pos->rb_node, root);
825 symbols__insert(&curr_map->dso->symbols[curr_map->type], pos);
832 if (curr_map != map &&
833 dso->kernel == DSO_TYPE_GUEST_KERNEL &&
834 machine__is_default_guest(kmaps->machine)) {
835 dso__set_loaded(curr_map->dso, curr_map->type);
838 return count + moved;
841 bool symbol__restricted_filename(const char *filename,
842 const char *restricted_filename)
844 bool restricted = false;
846 if (symbol_conf.kptr_restrict) {
847 char *r = realpath(filename, NULL);
850 restricted = strcmp(r, restricted_filename) == 0;
860 struct rb_node rb_node;
865 static void add_module(struct module_info *mi, struct rb_root *modules)
867 struct rb_node **p = &modules->rb_node;
868 struct rb_node *parent = NULL;
869 struct module_info *m;
873 m = rb_entry(parent, struct module_info, rb_node);
874 if (strcmp(mi->name, m->name) < 0)
879 rb_link_node(&mi->rb_node, parent, p);
880 rb_insert_color(&mi->rb_node, modules);
883 static void delete_modules(struct rb_root *modules)
885 struct module_info *mi;
886 struct rb_node *next = rb_first(modules);
889 mi = rb_entry(next, struct module_info, rb_node);
890 next = rb_next(&mi->rb_node);
891 rb_erase(&mi->rb_node, modules);
897 static struct module_info *find_module(const char *name,
898 struct rb_root *modules)
900 struct rb_node *n = modules->rb_node;
903 struct module_info *m;
906 m = rb_entry(n, struct module_info, rb_node);
907 cmp = strcmp(name, m->name);
919 static int __read_proc_modules(void *arg, const char *name, u64 start)
921 struct rb_root *modules = arg;
922 struct module_info *mi;
924 mi = zalloc(sizeof(struct module_info));
928 mi->name = strdup(name);
936 add_module(mi, modules);
941 static int read_proc_modules(const char *filename, struct rb_root *modules)
943 if (symbol__restricted_filename(filename, "/proc/modules"))
946 if (modules__parse(filename, modules, __read_proc_modules)) {
947 delete_modules(modules);
954 int compare_proc_modules(const char *from, const char *to)
956 struct rb_root from_modules = RB_ROOT;
957 struct rb_root to_modules = RB_ROOT;
958 struct rb_node *from_node, *to_node;
959 struct module_info *from_m, *to_m;
962 if (read_proc_modules(from, &from_modules))
965 if (read_proc_modules(to, &to_modules))
966 goto out_delete_from;
968 from_node = rb_first(&from_modules);
969 to_node = rb_first(&to_modules);
974 from_m = rb_entry(from_node, struct module_info, rb_node);
975 to_m = rb_entry(to_node, struct module_info, rb_node);
977 if (from_m->start != to_m->start ||
978 strcmp(from_m->name, to_m->name))
981 from_node = rb_next(from_node);
982 to_node = rb_next(to_node);
985 if (!from_node && !to_node)
988 delete_modules(&to_modules);
990 delete_modules(&from_modules);
995 static int do_validate_kcore_modules(const char *filename, struct map *map,
996 struct map_groups *kmaps)
998 struct rb_root modules = RB_ROOT;
1002 err = read_proc_modules(filename, &modules);
1006 old_map = map_groups__first(kmaps, map->type);
1008 struct map *next = map_groups__next(old_map);
1009 struct module_info *mi;
1011 if (old_map == map || old_map->start == map->start) {
1012 /* The kernel map */
1017 /* Module must be in memory at the same address */
1018 mi = find_module(old_map->dso->short_name, &modules);
1019 if (!mi || mi->start != old_map->start) {
1027 delete_modules(&modules);
1032 * If kallsyms is referenced by name then we look for filename in the same
1035 static bool filename_from_kallsyms_filename(char *filename,
1036 const char *base_name,
1037 const char *kallsyms_filename)
1041 strcpy(filename, kallsyms_filename);
1042 name = strrchr(filename, '/');
1048 if (!strcmp(name, "kallsyms")) {
1049 strcpy(name, base_name);
1056 static int validate_kcore_modules(const char *kallsyms_filename,
1059 struct map_groups *kmaps = map__kmaps(map);
1060 char modules_filename[PATH_MAX];
1065 if (!filename_from_kallsyms_filename(modules_filename, "modules",
1069 if (do_validate_kcore_modules(modules_filename, map, kmaps))
1075 static int validate_kcore_addresses(const char *kallsyms_filename,
1078 struct kmap *kmap = map__kmap(map);
1083 if (kmap->ref_reloc_sym && kmap->ref_reloc_sym->name) {
1086 start = kallsyms__get_function_start(kallsyms_filename,
1087 kmap->ref_reloc_sym->name);
1088 if (start != kmap->ref_reloc_sym->addr)
1092 return validate_kcore_modules(kallsyms_filename, map);
1095 struct kcore_mapfn_data {
1098 struct list_head maps;
1101 static int kcore_mapfn(u64 start, u64 len, u64 pgoff, void *data)
1103 struct kcore_mapfn_data *md = data;
1106 map = map__new2(start, md->dso, md->type);
1110 map->end = map->start + len;
1113 list_add(&map->node, &md->maps);
1118 static int dso__load_kcore(struct dso *dso, struct map *map,
1119 const char *kallsyms_filename)
1121 struct map_groups *kmaps = map__kmaps(map);
1122 struct machine *machine;
1123 struct kcore_mapfn_data md;
1124 struct map *old_map, *new_map, *replacement_map = NULL;
1127 char kcore_filename[PATH_MAX];
1133 machine = kmaps->machine;
1135 /* This function requires that the map is the kernel map */
1136 if (map != machine->vmlinux_maps[map->type])
1139 if (!filename_from_kallsyms_filename(kcore_filename, "kcore",
1143 /* Modules and kernel must be present at their original addresses */
1144 if (validate_kcore_addresses(kallsyms_filename, map))
1148 md.type = map->type;
1149 INIT_LIST_HEAD(&md.maps);
1151 fd = open(kcore_filename, O_RDONLY);
1153 pr_debug("Failed to open %s. Note /proc/kcore requires CAP_SYS_RAWIO capability to access.\n",
1158 /* Read new maps into temporary lists */
1159 err = file__read_maps(fd, md.type == MAP__FUNCTION, kcore_mapfn, &md,
1163 dso->is_64_bit = is_64_bit;
1165 if (list_empty(&md.maps)) {
1170 /* Remove old maps */
1171 old_map = map_groups__first(kmaps, map->type);
1173 struct map *next = map_groups__next(old_map);
1176 map_groups__remove(kmaps, old_map);
1180 /* Find the kernel map using the first symbol */
1181 sym = dso__first_symbol(dso, map->type);
1182 list_for_each_entry(new_map, &md.maps, node) {
1183 if (sym && sym->start >= new_map->start &&
1184 sym->start < new_map->end) {
1185 replacement_map = new_map;
1190 if (!replacement_map)
1191 replacement_map = list_entry(md.maps.next, struct map, node);
1194 while (!list_empty(&md.maps)) {
1195 new_map = list_entry(md.maps.next, struct map, node);
1196 list_del_init(&new_map->node);
1197 if (new_map == replacement_map) {
1198 map->start = new_map->start;
1199 map->end = new_map->end;
1200 map->pgoff = new_map->pgoff;
1201 map->map_ip = new_map->map_ip;
1202 map->unmap_ip = new_map->unmap_ip;
1203 /* Ensure maps are correctly ordered */
1205 map_groups__remove(kmaps, map);
1206 map_groups__insert(kmaps, map);
1209 map_groups__insert(kmaps, new_map);
1216 * Set the data type and long name so that kcore can be read via
1217 * dso__data_read_addr().
1219 if (dso->kernel == DSO_TYPE_GUEST_KERNEL)
1220 dso->binary_type = DSO_BINARY_TYPE__GUEST_KCORE;
1222 dso->binary_type = DSO_BINARY_TYPE__KCORE;
1223 dso__set_long_name(dso, strdup(kcore_filename), true);
1227 if (map->type == MAP__FUNCTION)
1228 pr_debug("Using %s for kernel object code\n", kcore_filename);
1230 pr_debug("Using %s for kernel data\n", kcore_filename);
1235 while (!list_empty(&md.maps)) {
1236 map = list_entry(md.maps.next, struct map, node);
1237 list_del_init(&map->node);
1245 * If the kernel is relocated at boot time, kallsyms won't match. Compute the
1246 * delta based on the relocation reference symbol.
1248 static int kallsyms__delta(struct map *map, const char *filename, u64 *delta)
1250 struct kmap *kmap = map__kmap(map);
1256 if (!kmap->ref_reloc_sym || !kmap->ref_reloc_sym->name)
1259 addr = kallsyms__get_function_start(filename,
1260 kmap->ref_reloc_sym->name);
1264 *delta = addr - kmap->ref_reloc_sym->addr;
1268 int dso__load_kallsyms(struct dso *dso, const char *filename,
1269 struct map *map, symbol_filter_t filter)
1273 if (symbol__restricted_filename(filename, "/proc/kallsyms"))
1276 if (dso__load_all_kallsyms(dso, filename, map) < 0)
1279 if (kallsyms__delta(map, filename, &delta))
1282 symbols__fixup_end(&dso->symbols[map->type]);
1283 symbols__fixup_duplicate(&dso->symbols[map->type]);
1285 if (dso->kernel == DSO_TYPE_GUEST_KERNEL)
1286 dso->symtab_type = DSO_BINARY_TYPE__GUEST_KALLSYMS;
1288 dso->symtab_type = DSO_BINARY_TYPE__KALLSYMS;
1290 if (!dso__load_kcore(dso, map, filename))
1291 return dso__split_kallsyms_for_kcore(dso, map, filter);
1293 return dso__split_kallsyms(dso, map, delta, filter);
1296 static int dso__load_perf_map(struct dso *dso, struct map *map,
1297 symbol_filter_t filter)
1304 file = fopen(dso->long_name, "r");
1308 while (!feof(file)) {
1313 line_len = getline(&line, &n, file);
1320 line[--line_len] = '\0'; /* \n */
1322 len = hex2u64(line, &start);
1325 if (len + 2 >= line_len)
1328 len += hex2u64(line + len, &size);
1331 if (len + 2 >= line_len)
1334 sym = symbol__new(start, size, STB_GLOBAL, line + len);
1337 goto out_delete_line;
1339 if (filter && filter(map, sym))
1340 symbol__delete(sym);
1342 symbols__insert(&dso->symbols[map->type], sym);
1358 static bool dso__is_compatible_symtab_type(struct dso *dso, bool kmod,
1359 enum dso_binary_type type)
1362 case DSO_BINARY_TYPE__JAVA_JIT:
1363 case DSO_BINARY_TYPE__DEBUGLINK:
1364 case DSO_BINARY_TYPE__SYSTEM_PATH_DSO:
1365 case DSO_BINARY_TYPE__FEDORA_DEBUGINFO:
1366 case DSO_BINARY_TYPE__UBUNTU_DEBUGINFO:
1367 case DSO_BINARY_TYPE__MIXEDUP_UBUNTU_DEBUGINFO:
1368 case DSO_BINARY_TYPE__BUILDID_DEBUGINFO:
1369 case DSO_BINARY_TYPE__OPENEMBEDDED_DEBUGINFO:
1370 return !kmod && dso->kernel == DSO_TYPE_USER;
1372 case DSO_BINARY_TYPE__KALLSYMS:
1373 case DSO_BINARY_TYPE__VMLINUX:
1374 case DSO_BINARY_TYPE__KCORE:
1375 return dso->kernel == DSO_TYPE_KERNEL;
1377 case DSO_BINARY_TYPE__GUEST_KALLSYMS:
1378 case DSO_BINARY_TYPE__GUEST_VMLINUX:
1379 case DSO_BINARY_TYPE__GUEST_KCORE:
1380 return dso->kernel == DSO_TYPE_GUEST_KERNEL;
1382 case DSO_BINARY_TYPE__GUEST_KMODULE:
1383 case DSO_BINARY_TYPE__GUEST_KMODULE_COMP:
1384 case DSO_BINARY_TYPE__SYSTEM_PATH_KMODULE:
1385 case DSO_BINARY_TYPE__SYSTEM_PATH_KMODULE_COMP:
1387 * kernel modules know their symtab type - it's set when
1388 * creating a module dso in machine__findnew_module_map().
1390 return kmod && dso->symtab_type == type;
1392 case DSO_BINARY_TYPE__BUILD_ID_CACHE:
1395 case DSO_BINARY_TYPE__NOT_FOUND:
1401 int dso__load(struct dso *dso, struct map *map, symbol_filter_t filter)
1406 struct machine *machine;
1407 char *root_dir = (char *) "";
1409 struct symsrc ss_[2];
1410 struct symsrc *syms_ss = NULL, *runtime_ss = NULL;
1412 unsigned char build_id[BUILD_ID_SIZE];
1414 pthread_mutex_lock(&dso->lock);
1416 /* check again under the dso->lock */
1417 if (dso__loaded(dso, map->type)) {
1423 if (dso->kernel == DSO_TYPE_KERNEL)
1424 ret = dso__load_kernel_sym(dso, map, filter);
1425 else if (dso->kernel == DSO_TYPE_GUEST_KERNEL)
1426 ret = dso__load_guest_kernel_sym(dso, map, filter);
1431 if (map->groups && map->groups->machine)
1432 machine = map->groups->machine;
1436 dso->adjust_symbols = 0;
1438 if (strncmp(dso->name, "/tmp/perf-", 10) == 0) {
1441 if (lstat(dso->name, &st) < 0)
1444 if (!symbol_conf.force && st.st_uid && (st.st_uid != geteuid())) {
1445 pr_warning("File %s not owned by current user or root, "
1446 "ignoring it (use -f to override).\n", dso->name);
1450 ret = dso__load_perf_map(dso, map, filter);
1451 dso->symtab_type = ret > 0 ? DSO_BINARY_TYPE__JAVA_JIT :
1452 DSO_BINARY_TYPE__NOT_FOUND;
1457 root_dir = machine->root_dir;
1459 name = malloc(PATH_MAX);
1463 kmod = dso->symtab_type == DSO_BINARY_TYPE__SYSTEM_PATH_KMODULE ||
1464 dso->symtab_type == DSO_BINARY_TYPE__SYSTEM_PATH_KMODULE_COMP ||
1465 dso->symtab_type == DSO_BINARY_TYPE__GUEST_KMODULE ||
1466 dso->symtab_type == DSO_BINARY_TYPE__GUEST_KMODULE_COMP;
1470 * Read the build id if possible. This is required for
1471 * DSO_BINARY_TYPE__BUILDID_DEBUGINFO to work
1473 if (filename__read_build_id(dso->name, build_id, BUILD_ID_SIZE) > 0)
1474 dso__set_build_id(dso, build_id);
1477 * Iterate over candidate debug images.
1478 * Keep track of "interesting" ones (those which have a symtab, dynsym,
1479 * and/or opd section) for processing.
1481 for (i = 0; i < DSO_BINARY_TYPE__SYMTAB_CNT; i++) {
1482 struct symsrc *ss = &ss_[ss_pos];
1483 bool next_slot = false;
1485 enum dso_binary_type symtab_type = binary_type_symtab[i];
1487 if (!dso__is_compatible_symtab_type(dso, kmod, symtab_type))
1490 if (dso__read_binary_type_filename(dso, symtab_type,
1491 root_dir, name, PATH_MAX))
1494 /* Name is now the name of the next image to try */
1495 if (symsrc__init(ss, dso, name, symtab_type) < 0)
1498 if (!syms_ss && symsrc__has_symtab(ss)) {
1501 if (!dso->symsrc_filename)
1502 dso->symsrc_filename = strdup(name);
1505 if (!runtime_ss && symsrc__possibly_runtime(ss)) {
1513 if (syms_ss && runtime_ss)
1516 symsrc__destroy(ss);
1521 if (!runtime_ss && !syms_ss)
1524 if (runtime_ss && !syms_ss) {
1525 syms_ss = runtime_ss;
1528 /* We'll have to hope for the best */
1529 if (!runtime_ss && syms_ss)
1530 runtime_ss = syms_ss;
1533 ret = dso__load_sym(dso, map, syms_ss, runtime_ss, filter, kmod);
1540 nr_plt = dso__synthesize_plt_symbols(dso, runtime_ss, map, filter);
1545 for (; ss_pos > 0; ss_pos--)
1546 symsrc__destroy(&ss_[ss_pos - 1]);
1549 if (ret < 0 && strstr(dso->name, " (deleted)") != NULL)
1552 dso__set_loaded(dso, map->type);
1553 pthread_mutex_unlock(&dso->lock);
1558 struct map *map_groups__find_by_name(struct map_groups *mg,
1559 enum map_type type, const char *name)
1561 struct maps *maps = &mg->maps[type];
1564 pthread_rwlock_rdlock(&maps->lock);
1566 for (map = maps__first(maps); map; map = map__next(map)) {
1567 if (map->dso && strcmp(map->dso->short_name, name) == 0)
1574 pthread_rwlock_unlock(&maps->lock);
1578 int dso__load_vmlinux(struct dso *dso, struct map *map,
1579 const char *vmlinux, bool vmlinux_allocated,
1580 symbol_filter_t filter)
1584 char symfs_vmlinux[PATH_MAX];
1585 enum dso_binary_type symtab_type;
1587 if (vmlinux[0] == '/')
1588 snprintf(symfs_vmlinux, sizeof(symfs_vmlinux), "%s", vmlinux);
1590 symbol__join_symfs(symfs_vmlinux, vmlinux);
1592 if (dso->kernel == DSO_TYPE_GUEST_KERNEL)
1593 symtab_type = DSO_BINARY_TYPE__GUEST_VMLINUX;
1595 symtab_type = DSO_BINARY_TYPE__VMLINUX;
1597 if (symsrc__init(&ss, dso, symfs_vmlinux, symtab_type))
1600 err = dso__load_sym(dso, map, &ss, &ss, filter, 0);
1601 symsrc__destroy(&ss);
1604 if (dso->kernel == DSO_TYPE_GUEST_KERNEL)
1605 dso->binary_type = DSO_BINARY_TYPE__GUEST_VMLINUX;
1607 dso->binary_type = DSO_BINARY_TYPE__VMLINUX;
1608 dso__set_long_name(dso, vmlinux, vmlinux_allocated);
1609 dso__set_loaded(dso, map->type);
1610 pr_debug("Using %s for symbols\n", symfs_vmlinux);
1616 int dso__load_vmlinux_path(struct dso *dso, struct map *map,
1617 symbol_filter_t filter)
1620 char *filename = NULL;
1622 pr_debug("Looking at the vmlinux_path (%d entries long)\n",
1623 vmlinux_path__nr_entries + 1);
1625 for (i = 0; i < vmlinux_path__nr_entries; ++i) {
1626 err = dso__load_vmlinux(dso, map, vmlinux_path[i], false, filter);
1631 if (!symbol_conf.ignore_vmlinux_buildid)
1632 filename = dso__build_id_filename(dso, NULL, 0);
1633 if (filename != NULL) {
1634 err = dso__load_vmlinux(dso, map, filename, true, filter);
1643 static int find_matching_kcore(struct map *map, char *dir, size_t dir_sz)
1645 char kallsyms_filename[PATH_MAX];
1646 struct dirent *dent;
1658 if (dent->d_type != DT_DIR)
1660 scnprintf(kallsyms_filename, sizeof(kallsyms_filename),
1661 "%s/%s/kallsyms", dir, dent->d_name);
1662 if (!validate_kcore_addresses(kallsyms_filename, map)) {
1663 strlcpy(dir, kallsyms_filename, dir_sz);
1674 static char *dso__find_kallsyms(struct dso *dso, struct map *map)
1676 u8 host_build_id[BUILD_ID_SIZE];
1677 char sbuild_id[BUILD_ID_SIZE * 2 + 1];
1678 bool is_host = false;
1679 char path[PATH_MAX];
1681 if (!dso->has_build_id) {
1683 * Last resort, if we don't have a build-id and couldn't find
1684 * any vmlinux file, try the running kernel kallsyms table.
1689 if (sysfs__read_build_id("/sys/kernel/notes", host_build_id,
1690 sizeof(host_build_id)) == 0)
1691 is_host = dso__build_id_equal(dso, host_build_id);
1693 build_id__sprintf(dso->build_id, sizeof(dso->build_id), sbuild_id);
1695 scnprintf(path, sizeof(path), "%s/[kernel.kcore]/%s", buildid_dir,
1698 /* Use /proc/kallsyms if possible */
1703 /* If no cached kcore go with /proc/kallsyms */
1710 * Do not check the build-id cache, until we know we cannot use
1713 fd = open("/proc/kcore", O_RDONLY);
1716 /* If module maps match go with /proc/kallsyms */
1717 if (!validate_kcore_addresses("/proc/kallsyms", map))
1721 /* Find kallsyms in build-id cache with kcore */
1722 if (!find_matching_kcore(map, path, sizeof(path)))
1723 return strdup(path);
1728 /* Find kallsyms in build-id cache with kcore */
1729 if (!find_matching_kcore(map, path, sizeof(path)))
1730 return strdup(path);
1732 scnprintf(path, sizeof(path), "%s/[kernel.kallsyms]/%s",
1733 buildid_dir, sbuild_id);
1735 if (access(path, F_OK)) {
1736 pr_err("No kallsyms or vmlinux with build-id %s was found\n",
1741 return strdup(path);
1744 return strdup("/proc/kallsyms");
1747 static int dso__load_kernel_sym(struct dso *dso, struct map *map,
1748 symbol_filter_t filter)
1751 const char *kallsyms_filename = NULL;
1752 char *kallsyms_allocated_filename = NULL;
1754 * Step 1: if the user specified a kallsyms or vmlinux filename, use
1755 * it and only it, reporting errors to the user if it cannot be used.
1757 * For instance, try to analyse an ARM perf.data file _without_ a
1758 * build-id, or if the user specifies the wrong path to the right
1759 * vmlinux file, obviously we can't fallback to another vmlinux (a
1760 * x86_86 one, on the machine where analysis is being performed, say),
1761 * or worse, /proc/kallsyms.
1763 * If the specified file _has_ a build-id and there is a build-id
1764 * section in the perf.data file, we will still do the expected
1765 * validation in dso__load_vmlinux and will bail out if they don't
1768 if (symbol_conf.kallsyms_name != NULL) {
1769 kallsyms_filename = symbol_conf.kallsyms_name;
1773 if (!symbol_conf.ignore_vmlinux && symbol_conf.vmlinux_name != NULL) {
1774 return dso__load_vmlinux(dso, map, symbol_conf.vmlinux_name,
1778 if (!symbol_conf.ignore_vmlinux && vmlinux_path != NULL) {
1779 err = dso__load_vmlinux_path(dso, map, filter);
1784 /* do not try local files if a symfs was given */
1785 if (symbol_conf.symfs[0] != 0)
1788 kallsyms_allocated_filename = dso__find_kallsyms(dso, map);
1789 if (!kallsyms_allocated_filename)
1792 kallsyms_filename = kallsyms_allocated_filename;
1795 err = dso__load_kallsyms(dso, kallsyms_filename, map, filter);
1797 pr_debug("Using %s for symbols\n", kallsyms_filename);
1798 free(kallsyms_allocated_filename);
1800 if (err > 0 && !dso__is_kcore(dso)) {
1801 dso->binary_type = DSO_BINARY_TYPE__KALLSYMS;
1802 dso__set_long_name(dso, "[kernel.kallsyms]", false);
1803 map__fixup_start(map);
1804 map__fixup_end(map);
1810 static int dso__load_guest_kernel_sym(struct dso *dso, struct map *map,
1811 symbol_filter_t filter)
1814 const char *kallsyms_filename = NULL;
1815 struct machine *machine;
1816 char path[PATH_MAX];
1819 pr_debug("Guest kernel map hasn't the point to groups\n");
1822 machine = map->groups->machine;
1824 if (machine__is_default_guest(machine)) {
1826 * if the user specified a vmlinux filename, use it and only
1827 * it, reporting errors to the user if it cannot be used.
1828 * Or use file guest_kallsyms inputted by user on commandline
1830 if (symbol_conf.default_guest_vmlinux_name != NULL) {
1831 err = dso__load_vmlinux(dso, map,
1832 symbol_conf.default_guest_vmlinux_name,
1837 kallsyms_filename = symbol_conf.default_guest_kallsyms;
1838 if (!kallsyms_filename)
1841 sprintf(path, "%s/proc/kallsyms", machine->root_dir);
1842 kallsyms_filename = path;
1845 err = dso__load_kallsyms(dso, kallsyms_filename, map, filter);
1847 pr_debug("Using %s for symbols\n", kallsyms_filename);
1848 if (err > 0 && !dso__is_kcore(dso)) {
1849 dso->binary_type = DSO_BINARY_TYPE__GUEST_KALLSYMS;
1850 machine__mmap_name(machine, path, sizeof(path));
1851 dso__set_long_name(dso, strdup(path), true);
1852 map__fixup_start(map);
1853 map__fixup_end(map);
1859 static void vmlinux_path__exit(void)
1861 while (--vmlinux_path__nr_entries >= 0)
1862 zfree(&vmlinux_path[vmlinux_path__nr_entries]);
1863 vmlinux_path__nr_entries = 0;
1865 zfree(&vmlinux_path);
1868 static int vmlinux_path__init(struct perf_env *env)
1872 char *kernel_version;
1874 vmlinux_path = malloc(sizeof(char *) * 6);
1875 if (vmlinux_path == NULL)
1878 vmlinux_path[vmlinux_path__nr_entries] = strdup("vmlinux");
1879 if (vmlinux_path[vmlinux_path__nr_entries] == NULL)
1881 ++vmlinux_path__nr_entries;
1882 vmlinux_path[vmlinux_path__nr_entries] = strdup("/boot/vmlinux");
1883 if (vmlinux_path[vmlinux_path__nr_entries] == NULL)
1885 ++vmlinux_path__nr_entries;
1887 /* only try kernel version if no symfs was given */
1888 if (symbol_conf.symfs[0] != 0)
1892 kernel_version = env->os_release;
1894 if (uname(&uts) < 0)
1897 kernel_version = uts.release;
1900 snprintf(bf, sizeof(bf), "/boot/vmlinux-%s", kernel_version);
1901 vmlinux_path[vmlinux_path__nr_entries] = strdup(bf);
1902 if (vmlinux_path[vmlinux_path__nr_entries] == NULL)
1904 ++vmlinux_path__nr_entries;
1905 snprintf(bf, sizeof(bf), "/usr/lib/debug/boot/vmlinux-%s",
1907 vmlinux_path[vmlinux_path__nr_entries] = strdup(bf);
1908 if (vmlinux_path[vmlinux_path__nr_entries] == NULL)
1910 ++vmlinux_path__nr_entries;
1911 snprintf(bf, sizeof(bf), "/lib/modules/%s/build/vmlinux", kernel_version);
1912 vmlinux_path[vmlinux_path__nr_entries] = strdup(bf);
1913 if (vmlinux_path[vmlinux_path__nr_entries] == NULL)
1915 ++vmlinux_path__nr_entries;
1916 snprintf(bf, sizeof(bf), "/usr/lib/debug/lib/modules/%s/vmlinux",
1918 vmlinux_path[vmlinux_path__nr_entries] = strdup(bf);
1919 if (vmlinux_path[vmlinux_path__nr_entries] == NULL)
1921 ++vmlinux_path__nr_entries;
1926 vmlinux_path__exit();
1930 int setup_list(struct strlist **list, const char *list_str,
1931 const char *list_name)
1933 if (list_str == NULL)
1936 *list = strlist__new(list_str, NULL);
1938 pr_err("problems parsing %s list\n", list_name);
1942 symbol_conf.has_filter = true;
1946 int setup_intlist(struct intlist **list, const char *list_str,
1947 const char *list_name)
1949 if (list_str == NULL)
1952 *list = intlist__new(list_str);
1954 pr_err("problems parsing %s list\n", list_name);
1960 static bool symbol__read_kptr_restrict(void)
1964 if (geteuid() != 0) {
1965 FILE *fp = fopen("/proc/sys/kernel/kptr_restrict", "r");
1969 if (fgets(line, sizeof(line), fp) != NULL)
1970 value = atoi(line) != 0;
1979 int symbol__init(struct perf_env *env)
1983 if (symbol_conf.initialized)
1986 symbol_conf.priv_size = PERF_ALIGN(symbol_conf.priv_size, sizeof(u64));
1990 if (symbol_conf.sort_by_name)
1991 symbol_conf.priv_size += (sizeof(struct symbol_name_rb_node) -
1992 sizeof(struct symbol));
1994 if (symbol_conf.try_vmlinux_path && vmlinux_path__init(env) < 0)
1997 if (symbol_conf.field_sep && *symbol_conf.field_sep == '.') {
1998 pr_err("'.' is the only non valid --field-separator argument\n");
2002 if (setup_list(&symbol_conf.dso_list,
2003 symbol_conf.dso_list_str, "dso") < 0)
2006 if (setup_list(&symbol_conf.comm_list,
2007 symbol_conf.comm_list_str, "comm") < 0)
2008 goto out_free_dso_list;
2010 if (setup_intlist(&symbol_conf.pid_list,
2011 symbol_conf.pid_list_str, "pid") < 0)
2012 goto out_free_comm_list;
2014 if (setup_intlist(&symbol_conf.tid_list,
2015 symbol_conf.tid_list_str, "tid") < 0)
2016 goto out_free_pid_list;
2018 if (setup_list(&symbol_conf.sym_list,
2019 symbol_conf.sym_list_str, "symbol") < 0)
2020 goto out_free_tid_list;
2023 * A path to symbols of "/" is identical to ""
2024 * reset here for simplicity.
2026 symfs = realpath(symbol_conf.symfs, NULL);
2028 symfs = symbol_conf.symfs;
2029 if (strcmp(symfs, "/") == 0)
2030 symbol_conf.symfs = "";
2031 if (symfs != symbol_conf.symfs)
2032 free((void *)symfs);
2034 symbol_conf.kptr_restrict = symbol__read_kptr_restrict();
2036 symbol_conf.initialized = true;
2040 intlist__delete(symbol_conf.tid_list);
2042 intlist__delete(symbol_conf.pid_list);
2044 strlist__delete(symbol_conf.comm_list);
2046 strlist__delete(symbol_conf.dso_list);
2050 void symbol__exit(void)
2052 if (!symbol_conf.initialized)
2054 strlist__delete(symbol_conf.sym_list);
2055 strlist__delete(symbol_conf.dso_list);
2056 strlist__delete(symbol_conf.comm_list);
2057 intlist__delete(symbol_conf.tid_list);
2058 intlist__delete(symbol_conf.pid_list);
2059 vmlinux_path__exit();
2060 symbol_conf.sym_list = symbol_conf.dso_list = symbol_conf.comm_list = NULL;
2061 symbol_conf.initialized = false;