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 maps *maps = &mg->maps[type];
206 struct map *next, *curr;
208 pthread_rwlock_wrlock(&maps->lock);
210 curr = maps__first(maps);
214 for (next = map__next(curr); next; next = map__next(curr)) {
215 curr->end = next->start;
220 * We still haven't the actual symbols, so guess the
221 * last map final address.
226 pthread_rwlock_unlock(&maps->lock);
229 struct symbol *symbol__new(u64 start, u64 len, u8 binding, const char *name)
231 size_t namelen = strlen(name) + 1;
232 struct symbol *sym = calloc(1, (symbol_conf.priv_size +
233 sizeof(*sym) + namelen));
237 if (symbol_conf.priv_size)
238 sym = ((void *)sym) + symbol_conf.priv_size;
241 sym->end = len ? start + len : start;
242 sym->binding = binding;
243 sym->namelen = namelen - 1;
245 pr_debug4("%s: %s %#" PRIx64 "-%#" PRIx64 "\n",
246 __func__, name, start, sym->end);
247 memcpy(sym->name, name, namelen);
252 void symbol__delete(struct symbol *sym)
254 free(((void *)sym) - symbol_conf.priv_size);
257 size_t symbol__fprintf(struct symbol *sym, FILE *fp)
259 return fprintf(fp, " %" PRIx64 "-%" PRIx64 " %c %s\n",
260 sym->start, sym->end,
261 sym->binding == STB_GLOBAL ? 'g' :
262 sym->binding == STB_LOCAL ? 'l' : 'w',
266 size_t symbol__fprintf_symname_offs(const struct symbol *sym,
267 const struct addr_location *al, FILE *fp)
269 unsigned long offset;
272 if (sym && sym->name) {
273 length = fprintf(fp, "%s", sym->name);
275 if (al->addr < sym->end)
276 offset = al->addr - sym->start;
278 offset = al->addr - al->map->start - sym->start;
279 length += fprintf(fp, "+0x%lx", offset);
283 return fprintf(fp, "[unknown]");
286 size_t symbol__fprintf_symname(const struct symbol *sym, FILE *fp)
288 return symbol__fprintf_symname_offs(sym, NULL, fp);
291 void symbols__delete(struct rb_root *symbols)
294 struct rb_node *next = rb_first(symbols);
297 pos = rb_entry(next, struct symbol, rb_node);
298 next = rb_next(&pos->rb_node);
299 rb_erase(&pos->rb_node, symbols);
304 void symbols__insert(struct rb_root *symbols, struct symbol *sym)
306 struct rb_node **p = &symbols->rb_node;
307 struct rb_node *parent = NULL;
308 const u64 ip = sym->start;
313 s = rb_entry(parent, struct symbol, rb_node);
319 rb_link_node(&sym->rb_node, parent, p);
320 rb_insert_color(&sym->rb_node, symbols);
323 static struct symbol *symbols__find(struct rb_root *symbols, u64 ip)
330 n = symbols->rb_node;
333 struct symbol *s = rb_entry(n, struct symbol, rb_node);
337 else if (ip >= s->end)
346 static struct symbol *symbols__first(struct rb_root *symbols)
348 struct rb_node *n = rb_first(symbols);
351 return rb_entry(n, struct symbol, rb_node);
356 static struct symbol *symbols__next(struct symbol *sym)
358 struct rb_node *n = rb_next(&sym->rb_node);
361 return rb_entry(n, struct symbol, rb_node);
366 struct symbol_name_rb_node {
367 struct rb_node rb_node;
371 static void symbols__insert_by_name(struct rb_root *symbols, struct symbol *sym)
373 struct rb_node **p = &symbols->rb_node;
374 struct rb_node *parent = NULL;
375 struct symbol_name_rb_node *symn, *s;
377 symn = container_of(sym, struct symbol_name_rb_node, sym);
381 s = rb_entry(parent, struct symbol_name_rb_node, rb_node);
382 if (strcmp(sym->name, s->sym.name) < 0)
387 rb_link_node(&symn->rb_node, parent, p);
388 rb_insert_color(&symn->rb_node, symbols);
391 static void symbols__sort_by_name(struct rb_root *symbols,
392 struct rb_root *source)
396 for (nd = rb_first(source); nd; nd = rb_next(nd)) {
397 struct symbol *pos = rb_entry(nd, struct symbol, rb_node);
398 symbols__insert_by_name(symbols, pos);
402 static struct symbol *symbols__find_by_name(struct rb_root *symbols,
406 struct symbol_name_rb_node *s = NULL;
411 n = symbols->rb_node;
416 s = rb_entry(n, struct symbol_name_rb_node, rb_node);
417 cmp = arch__compare_symbol_names(name, s->sym.name);
430 /* return first symbol that has same name (if any) */
431 for (n = rb_prev(n); n; n = rb_prev(n)) {
432 struct symbol_name_rb_node *tmp;
434 tmp = rb_entry(n, struct symbol_name_rb_node, rb_node);
435 if (arch__compare_symbol_names(tmp->sym.name, s->sym.name))
444 struct symbol *dso__find_symbol(struct dso *dso,
445 enum map_type type, u64 addr)
447 return symbols__find(&dso->symbols[type], addr);
450 struct symbol *dso__first_symbol(struct dso *dso, enum map_type type)
452 return symbols__first(&dso->symbols[type]);
455 struct symbol *dso__next_symbol(struct symbol *sym)
457 return symbols__next(sym);
460 struct symbol *symbol__next_by_name(struct symbol *sym)
462 struct symbol_name_rb_node *s = container_of(sym, struct symbol_name_rb_node, sym);
463 struct rb_node *n = rb_next(&s->rb_node);
465 return n ? &rb_entry(n, struct symbol_name_rb_node, rb_node)->sym : NULL;
469 * Teturns first symbol that matched with @name.
471 struct symbol *dso__find_symbol_by_name(struct dso *dso, enum map_type type,
474 return symbols__find_by_name(&dso->symbol_names[type], name);
477 void dso__sort_by_name(struct dso *dso, enum map_type type)
479 dso__set_sorted_by_name(dso, type);
480 return symbols__sort_by_name(&dso->symbol_names[type],
481 &dso->symbols[type]);
484 size_t dso__fprintf_symbols_by_name(struct dso *dso,
485 enum map_type type, FILE *fp)
489 struct symbol_name_rb_node *pos;
491 for (nd = rb_first(&dso->symbol_names[type]); nd; nd = rb_next(nd)) {
492 pos = rb_entry(nd, struct symbol_name_rb_node, rb_node);
493 fprintf(fp, "%s\n", pos->sym.name);
499 int modules__parse(const char *filename, void *arg,
500 int (*process_module)(void *arg, const char *name,
508 file = fopen(filename, "r");
518 line_len = getline(&line, &n, file);
531 line[--line_len] = '\0'; /* \n */
533 sep = strrchr(line, 'x');
537 hex2u64(sep + 1, &start);
539 sep = strchr(line, ' ');
545 scnprintf(name, sizeof(name), "[%s]", line);
547 err = process_module(arg, name, start);
557 struct process_kallsyms_args {
563 * These are symbols in the kernel image, so make sure that
564 * sym is from a kernel DSO.
566 bool symbol__is_idle(struct symbol *sym)
568 const char * const idle_symbols[] = {
577 "mwait_idle_with_hints",
579 "ppc64_runlatch_off",
580 "pseries_dedicated_idle_sleep",
589 for (i = 0; idle_symbols[i]; i++) {
590 if (!strcmp(idle_symbols[i], sym->name))
597 static int map__process_kallsym_symbol(void *arg, const char *name,
598 char type, u64 start)
601 struct process_kallsyms_args *a = arg;
602 struct rb_root *root = &a->dso->symbols[a->map->type];
604 if (!symbol_type__is_a(type, a->map->type))
608 * module symbols are not sorted so we add all
609 * symbols, setting length to 0, and rely on
610 * symbols__fixup_end() to fix it up.
612 sym = symbol__new(start, 0, kallsyms2elf_type(type), name);
616 * We will pass the symbols to the filter later, in
617 * map__split_kallsyms, when we have split the maps per module
619 symbols__insert(root, sym);
625 * Loads the function entries in /proc/kallsyms into kernel_map->dso,
626 * so that we can in the next step set the symbol ->end address and then
627 * call kernel_maps__split_kallsyms.
629 static int dso__load_all_kallsyms(struct dso *dso, const char *filename,
632 struct process_kallsyms_args args = { .map = map, .dso = dso, };
633 return kallsyms__parse(filename, &args, map__process_kallsym_symbol);
636 static int dso__split_kallsyms_for_kcore(struct dso *dso, struct map *map,
637 symbol_filter_t filter)
639 struct map_groups *kmaps = map__kmaps(map);
640 struct map *curr_map;
642 int count = 0, moved = 0;
643 struct rb_root *root = &dso->symbols[map->type];
644 struct rb_node *next = rb_first(root);
652 pos = rb_entry(next, struct symbol, rb_node);
653 next = rb_next(&pos->rb_node);
655 module = strchr(pos->name, '\t');
659 curr_map = map_groups__find(kmaps, map->type, pos->start);
661 if (!curr_map || (filter && filter(curr_map, pos))) {
662 rb_erase_init(&pos->rb_node, root);
665 pos->start -= curr_map->start - curr_map->pgoff;
667 pos->end -= curr_map->start - curr_map->pgoff;
668 if (curr_map != map) {
669 rb_erase_init(&pos->rb_node, root);
671 &curr_map->dso->symbols[curr_map->type],
680 /* Symbols have been adjusted */
681 dso->adjust_symbols = 1;
683 return count + moved;
687 * Split the symbols into maps, making sure there are no overlaps, i.e. the
688 * kernel range is broken in several maps, named [kernel].N, as we don't have
689 * the original ELF section names vmlinux have.
691 static int dso__split_kallsyms(struct dso *dso, struct map *map, u64 delta,
692 symbol_filter_t filter)
694 struct map_groups *kmaps = map__kmaps(map);
695 struct machine *machine;
696 struct map *curr_map = map;
698 int count = 0, moved = 0;
699 struct rb_root *root = &dso->symbols[map->type];
700 struct rb_node *next = rb_first(root);
701 int kernel_range = 0;
706 machine = kmaps->machine;
711 pos = rb_entry(next, struct symbol, rb_node);
712 next = rb_next(&pos->rb_node);
714 module = strchr(pos->name, '\t');
716 if (!symbol_conf.use_modules)
721 if (strcmp(curr_map->dso->short_name, module)) {
722 if (curr_map != map &&
723 dso->kernel == DSO_TYPE_GUEST_KERNEL &&
724 machine__is_default_guest(machine)) {
726 * We assume all symbols of a module are
727 * continuous in * kallsyms, so curr_map
728 * points to a module and all its
729 * symbols are in its kmap. Mark it as
732 dso__set_loaded(curr_map->dso,
736 curr_map = map_groups__find_by_name(kmaps,
738 if (curr_map == NULL) {
739 pr_debug("%s/proc/{kallsyms,modules} "
740 "inconsistency while looking "
741 "for \"%s\" module!\n",
742 machine->root_dir, module);
747 if (curr_map->dso->loaded &&
748 !machine__is_default_guest(machine))
752 * So that we look just like we get from .ko files,
753 * i.e. not prelinked, relative to map->start.
755 pos->start = curr_map->map_ip(curr_map, pos->start);
756 pos->end = curr_map->map_ip(curr_map, pos->end);
757 } else if (curr_map != map) {
758 char dso_name[PATH_MAX];
762 /* Kernel was relocated at boot time */
772 if (dso->kernel == DSO_TYPE_GUEST_KERNEL)
773 snprintf(dso_name, sizeof(dso_name),
777 snprintf(dso_name, sizeof(dso_name),
781 ndso = dso__new(dso_name);
785 ndso->kernel = dso->kernel;
787 curr_map = map__new2(pos->start, ndso, map->type);
788 if (curr_map == NULL) {
793 curr_map->map_ip = curr_map->unmap_ip = identity__map_ip;
794 map_groups__insert(kmaps, curr_map);
797 /* Kernel was relocated at boot time */
802 if (filter && filter(curr_map, pos)) {
803 discard_symbol: rb_erase(&pos->rb_node, root);
806 if (curr_map != map) {
807 rb_erase(&pos->rb_node, root);
808 symbols__insert(&curr_map->dso->symbols[curr_map->type], pos);
815 if (curr_map != map &&
816 dso->kernel == DSO_TYPE_GUEST_KERNEL &&
817 machine__is_default_guest(kmaps->machine)) {
818 dso__set_loaded(curr_map->dso, curr_map->type);
821 return count + moved;
824 bool symbol__restricted_filename(const char *filename,
825 const char *restricted_filename)
827 bool restricted = false;
829 if (symbol_conf.kptr_restrict) {
830 char *r = realpath(filename, NULL);
833 restricted = strcmp(r, restricted_filename) == 0;
843 struct rb_node rb_node;
848 static void add_module(struct module_info *mi, struct rb_root *modules)
850 struct rb_node **p = &modules->rb_node;
851 struct rb_node *parent = NULL;
852 struct module_info *m;
856 m = rb_entry(parent, struct module_info, rb_node);
857 if (strcmp(mi->name, m->name) < 0)
862 rb_link_node(&mi->rb_node, parent, p);
863 rb_insert_color(&mi->rb_node, modules);
866 static void delete_modules(struct rb_root *modules)
868 struct module_info *mi;
869 struct rb_node *next = rb_first(modules);
872 mi = rb_entry(next, struct module_info, rb_node);
873 next = rb_next(&mi->rb_node);
874 rb_erase(&mi->rb_node, modules);
880 static struct module_info *find_module(const char *name,
881 struct rb_root *modules)
883 struct rb_node *n = modules->rb_node;
886 struct module_info *m;
889 m = rb_entry(n, struct module_info, rb_node);
890 cmp = strcmp(name, m->name);
902 static int __read_proc_modules(void *arg, const char *name, u64 start)
904 struct rb_root *modules = arg;
905 struct module_info *mi;
907 mi = zalloc(sizeof(struct module_info));
911 mi->name = strdup(name);
919 add_module(mi, modules);
924 static int read_proc_modules(const char *filename, struct rb_root *modules)
926 if (symbol__restricted_filename(filename, "/proc/modules"))
929 if (modules__parse(filename, modules, __read_proc_modules)) {
930 delete_modules(modules);
937 int compare_proc_modules(const char *from, const char *to)
939 struct rb_root from_modules = RB_ROOT;
940 struct rb_root to_modules = RB_ROOT;
941 struct rb_node *from_node, *to_node;
942 struct module_info *from_m, *to_m;
945 if (read_proc_modules(from, &from_modules))
948 if (read_proc_modules(to, &to_modules))
949 goto out_delete_from;
951 from_node = rb_first(&from_modules);
952 to_node = rb_first(&to_modules);
957 from_m = rb_entry(from_node, struct module_info, rb_node);
958 to_m = rb_entry(to_node, struct module_info, rb_node);
960 if (from_m->start != to_m->start ||
961 strcmp(from_m->name, to_m->name))
964 from_node = rb_next(from_node);
965 to_node = rb_next(to_node);
968 if (!from_node && !to_node)
971 delete_modules(&to_modules);
973 delete_modules(&from_modules);
978 static int do_validate_kcore_modules(const char *filename, struct map *map,
979 struct map_groups *kmaps)
981 struct rb_root modules = RB_ROOT;
985 err = read_proc_modules(filename, &modules);
989 old_map = map_groups__first(kmaps, map->type);
991 struct map *next = map_groups__next(old_map);
992 struct module_info *mi;
994 if (old_map == map || old_map->start == map->start) {
1000 /* Module must be in memory at the same address */
1001 mi = find_module(old_map->dso->short_name, &modules);
1002 if (!mi || mi->start != old_map->start) {
1010 delete_modules(&modules);
1015 * If kallsyms is referenced by name then we look for filename in the same
1018 static bool filename_from_kallsyms_filename(char *filename,
1019 const char *base_name,
1020 const char *kallsyms_filename)
1024 strcpy(filename, kallsyms_filename);
1025 name = strrchr(filename, '/');
1031 if (!strcmp(name, "kallsyms")) {
1032 strcpy(name, base_name);
1039 static int validate_kcore_modules(const char *kallsyms_filename,
1042 struct map_groups *kmaps = map__kmaps(map);
1043 char modules_filename[PATH_MAX];
1048 if (!filename_from_kallsyms_filename(modules_filename, "modules",
1052 if (do_validate_kcore_modules(modules_filename, map, kmaps))
1058 static int validate_kcore_addresses(const char *kallsyms_filename,
1061 struct kmap *kmap = map__kmap(map);
1066 if (kmap->ref_reloc_sym && kmap->ref_reloc_sym->name) {
1069 start = kallsyms__get_function_start(kallsyms_filename,
1070 kmap->ref_reloc_sym->name);
1071 if (start != kmap->ref_reloc_sym->addr)
1075 return validate_kcore_modules(kallsyms_filename, map);
1078 struct kcore_mapfn_data {
1081 struct list_head maps;
1084 static int kcore_mapfn(u64 start, u64 len, u64 pgoff, void *data)
1086 struct kcore_mapfn_data *md = data;
1089 map = map__new2(start, md->dso, md->type);
1093 map->end = map->start + len;
1096 list_add(&map->node, &md->maps);
1101 static int dso__load_kcore(struct dso *dso, struct map *map,
1102 const char *kallsyms_filename)
1104 struct map_groups *kmaps = map__kmaps(map);
1105 struct machine *machine;
1106 struct kcore_mapfn_data md;
1107 struct map *old_map, *new_map, *replacement_map = NULL;
1110 char kcore_filename[PATH_MAX];
1116 machine = kmaps->machine;
1118 /* This function requires that the map is the kernel map */
1119 if (map != machine->vmlinux_maps[map->type])
1122 if (!filename_from_kallsyms_filename(kcore_filename, "kcore",
1126 /* Modules and kernel must be present at their original addresses */
1127 if (validate_kcore_addresses(kallsyms_filename, map))
1131 md.type = map->type;
1132 INIT_LIST_HEAD(&md.maps);
1134 fd = open(kcore_filename, O_RDONLY);
1138 /* Read new maps into temporary lists */
1139 err = file__read_maps(fd, md.type == MAP__FUNCTION, kcore_mapfn, &md,
1143 dso->is_64_bit = is_64_bit;
1145 if (list_empty(&md.maps)) {
1150 /* Remove old maps */
1151 old_map = map_groups__first(kmaps, map->type);
1153 struct map *next = map_groups__next(old_map);
1156 map_groups__remove(kmaps, old_map);
1160 /* Find the kernel map using the first symbol */
1161 sym = dso__first_symbol(dso, map->type);
1162 list_for_each_entry(new_map, &md.maps, node) {
1163 if (sym && sym->start >= new_map->start &&
1164 sym->start < new_map->end) {
1165 replacement_map = new_map;
1170 if (!replacement_map)
1171 replacement_map = list_entry(md.maps.next, struct map, node);
1174 while (!list_empty(&md.maps)) {
1175 new_map = list_entry(md.maps.next, struct map, node);
1176 list_del_init(&new_map->node);
1177 if (new_map == replacement_map) {
1178 map->start = new_map->start;
1179 map->end = new_map->end;
1180 map->pgoff = new_map->pgoff;
1181 map->map_ip = new_map->map_ip;
1182 map->unmap_ip = new_map->unmap_ip;
1183 /* Ensure maps are correctly ordered */
1185 map_groups__remove(kmaps, map);
1186 map_groups__insert(kmaps, map);
1189 map_groups__insert(kmaps, new_map);
1196 * Set the data type and long name so that kcore can be read via
1197 * dso__data_read_addr().
1199 if (dso->kernel == DSO_TYPE_GUEST_KERNEL)
1200 dso->binary_type = DSO_BINARY_TYPE__GUEST_KCORE;
1202 dso->binary_type = DSO_BINARY_TYPE__KCORE;
1203 dso__set_long_name(dso, strdup(kcore_filename), true);
1207 if (map->type == MAP__FUNCTION)
1208 pr_debug("Using %s for kernel object code\n", kcore_filename);
1210 pr_debug("Using %s for kernel data\n", kcore_filename);
1215 while (!list_empty(&md.maps)) {
1216 map = list_entry(md.maps.next, struct map, node);
1217 list_del_init(&map->node);
1225 * If the kernel is relocated at boot time, kallsyms won't match. Compute the
1226 * delta based on the relocation reference symbol.
1228 static int kallsyms__delta(struct map *map, const char *filename, u64 *delta)
1230 struct kmap *kmap = map__kmap(map);
1236 if (!kmap->ref_reloc_sym || !kmap->ref_reloc_sym->name)
1239 addr = kallsyms__get_function_start(filename,
1240 kmap->ref_reloc_sym->name);
1244 *delta = addr - kmap->ref_reloc_sym->addr;
1248 int dso__load_kallsyms(struct dso *dso, const char *filename,
1249 struct map *map, symbol_filter_t filter)
1253 if (symbol__restricted_filename(filename, "/proc/kallsyms"))
1256 if (dso__load_all_kallsyms(dso, filename, map) < 0)
1259 if (kallsyms__delta(map, filename, &delta))
1262 symbols__fixup_duplicate(&dso->symbols[map->type]);
1263 symbols__fixup_end(&dso->symbols[map->type]);
1265 if (dso->kernel == DSO_TYPE_GUEST_KERNEL)
1266 dso->symtab_type = DSO_BINARY_TYPE__GUEST_KALLSYMS;
1268 dso->symtab_type = DSO_BINARY_TYPE__KALLSYMS;
1270 if (!dso__load_kcore(dso, map, filename))
1271 return dso__split_kallsyms_for_kcore(dso, map, filter);
1273 return dso__split_kallsyms(dso, map, delta, filter);
1276 static int dso__load_perf_map(struct dso *dso, struct map *map,
1277 symbol_filter_t filter)
1284 file = fopen(dso->long_name, "r");
1288 while (!feof(file)) {
1293 line_len = getline(&line, &n, file);
1300 line[--line_len] = '\0'; /* \n */
1302 len = hex2u64(line, &start);
1305 if (len + 2 >= line_len)
1308 len += hex2u64(line + len, &size);
1311 if (len + 2 >= line_len)
1314 sym = symbol__new(start, size, STB_GLOBAL, line + len);
1317 goto out_delete_line;
1319 if (filter && filter(map, sym))
1320 symbol__delete(sym);
1322 symbols__insert(&dso->symbols[map->type], sym);
1338 static bool dso__is_compatible_symtab_type(struct dso *dso, bool kmod,
1339 enum dso_binary_type type)
1342 case DSO_BINARY_TYPE__JAVA_JIT:
1343 case DSO_BINARY_TYPE__DEBUGLINK:
1344 case DSO_BINARY_TYPE__SYSTEM_PATH_DSO:
1345 case DSO_BINARY_TYPE__FEDORA_DEBUGINFO:
1346 case DSO_BINARY_TYPE__UBUNTU_DEBUGINFO:
1347 case DSO_BINARY_TYPE__BUILDID_DEBUGINFO:
1348 case DSO_BINARY_TYPE__OPENEMBEDDED_DEBUGINFO:
1349 return !kmod && dso->kernel == DSO_TYPE_USER;
1351 case DSO_BINARY_TYPE__KALLSYMS:
1352 case DSO_BINARY_TYPE__VMLINUX:
1353 case DSO_BINARY_TYPE__KCORE:
1354 return dso->kernel == DSO_TYPE_KERNEL;
1356 case DSO_BINARY_TYPE__GUEST_KALLSYMS:
1357 case DSO_BINARY_TYPE__GUEST_VMLINUX:
1358 case DSO_BINARY_TYPE__GUEST_KCORE:
1359 return dso->kernel == DSO_TYPE_GUEST_KERNEL;
1361 case DSO_BINARY_TYPE__GUEST_KMODULE:
1362 case DSO_BINARY_TYPE__GUEST_KMODULE_COMP:
1363 case DSO_BINARY_TYPE__SYSTEM_PATH_KMODULE:
1364 case DSO_BINARY_TYPE__SYSTEM_PATH_KMODULE_COMP:
1366 * kernel modules know their symtab type - it's set when
1367 * creating a module dso in machine__findnew_module_map().
1369 return kmod && dso->symtab_type == type;
1371 case DSO_BINARY_TYPE__BUILD_ID_CACHE:
1374 case DSO_BINARY_TYPE__NOT_FOUND:
1380 int dso__load(struct dso *dso, struct map *map, symbol_filter_t filter)
1385 struct machine *machine;
1386 char *root_dir = (char *) "";
1388 struct symsrc ss_[2];
1389 struct symsrc *syms_ss = NULL, *runtime_ss = NULL;
1392 pthread_mutex_lock(&dso->lock);
1394 /* check again under the dso->lock */
1395 if (dso__loaded(dso, map->type)) {
1401 if (dso->kernel == DSO_TYPE_KERNEL)
1402 ret = dso__load_kernel_sym(dso, map, filter);
1403 else if (dso->kernel == DSO_TYPE_GUEST_KERNEL)
1404 ret = dso__load_guest_kernel_sym(dso, map, filter);
1409 if (map->groups && map->groups->machine)
1410 machine = map->groups->machine;
1414 dso->adjust_symbols = 0;
1416 if (strncmp(dso->name, "/tmp/perf-", 10) == 0) {
1419 if (lstat(dso->name, &st) < 0)
1422 if (st.st_uid && (st.st_uid != geteuid())) {
1423 pr_warning("File %s not owned by current user or root, "
1424 "ignoring it.\n", dso->name);
1428 ret = dso__load_perf_map(dso, map, filter);
1429 dso->symtab_type = ret > 0 ? DSO_BINARY_TYPE__JAVA_JIT :
1430 DSO_BINARY_TYPE__NOT_FOUND;
1435 root_dir = machine->root_dir;
1437 name = malloc(PATH_MAX);
1441 kmod = dso->symtab_type == DSO_BINARY_TYPE__SYSTEM_PATH_KMODULE ||
1442 dso->symtab_type == DSO_BINARY_TYPE__SYSTEM_PATH_KMODULE_COMP ||
1443 dso->symtab_type == DSO_BINARY_TYPE__GUEST_KMODULE ||
1444 dso->symtab_type == DSO_BINARY_TYPE__GUEST_KMODULE_COMP;
1447 * Iterate over candidate debug images.
1448 * Keep track of "interesting" ones (those which have a symtab, dynsym,
1449 * and/or opd section) for processing.
1451 for (i = 0; i < DSO_BINARY_TYPE__SYMTAB_CNT; i++) {
1452 struct symsrc *ss = &ss_[ss_pos];
1453 bool next_slot = false;
1455 enum dso_binary_type symtab_type = binary_type_symtab[i];
1457 if (!dso__is_compatible_symtab_type(dso, kmod, symtab_type))
1460 if (dso__read_binary_type_filename(dso, symtab_type,
1461 root_dir, name, PATH_MAX))
1464 /* Name is now the name of the next image to try */
1465 if (symsrc__init(ss, dso, name, symtab_type) < 0)
1468 if (!syms_ss && symsrc__has_symtab(ss)) {
1471 if (!dso->symsrc_filename)
1472 dso->symsrc_filename = strdup(name);
1475 if (!runtime_ss && symsrc__possibly_runtime(ss)) {
1483 if (syms_ss && runtime_ss)
1486 symsrc__destroy(ss);
1491 if (!runtime_ss && !syms_ss)
1494 if (runtime_ss && !syms_ss) {
1495 syms_ss = runtime_ss;
1498 /* We'll have to hope for the best */
1499 if (!runtime_ss && syms_ss)
1500 runtime_ss = syms_ss;
1503 ret = dso__load_sym(dso, map, syms_ss, runtime_ss, filter, kmod);
1510 nr_plt = dso__synthesize_plt_symbols(dso, runtime_ss, map, filter);
1515 for (; ss_pos > 0; ss_pos--)
1516 symsrc__destroy(&ss_[ss_pos - 1]);
1519 if (ret < 0 && strstr(dso->name, " (deleted)") != NULL)
1522 dso__set_loaded(dso, map->type);
1523 pthread_mutex_unlock(&dso->lock);
1528 struct map *map_groups__find_by_name(struct map_groups *mg,
1529 enum map_type type, const char *name)
1531 struct maps *maps = &mg->maps[type];
1534 pthread_rwlock_rdlock(&maps->lock);
1536 for (map = maps__first(maps); map; map = map__next(map)) {
1537 if (map->dso && strcmp(map->dso->short_name, name) == 0)
1544 pthread_rwlock_unlock(&maps->lock);
1548 int dso__load_vmlinux(struct dso *dso, struct map *map,
1549 const char *vmlinux, bool vmlinux_allocated,
1550 symbol_filter_t filter)
1554 char symfs_vmlinux[PATH_MAX];
1555 enum dso_binary_type symtab_type;
1557 if (vmlinux[0] == '/')
1558 snprintf(symfs_vmlinux, sizeof(symfs_vmlinux), "%s", vmlinux);
1560 symbol__join_symfs(symfs_vmlinux, vmlinux);
1562 if (dso->kernel == DSO_TYPE_GUEST_KERNEL)
1563 symtab_type = DSO_BINARY_TYPE__GUEST_VMLINUX;
1565 symtab_type = DSO_BINARY_TYPE__VMLINUX;
1567 if (symsrc__init(&ss, dso, symfs_vmlinux, symtab_type))
1570 err = dso__load_sym(dso, map, &ss, &ss, filter, 0);
1571 symsrc__destroy(&ss);
1574 if (dso->kernel == DSO_TYPE_GUEST_KERNEL)
1575 dso->binary_type = DSO_BINARY_TYPE__GUEST_VMLINUX;
1577 dso->binary_type = DSO_BINARY_TYPE__VMLINUX;
1578 dso__set_long_name(dso, vmlinux, vmlinux_allocated);
1579 dso__set_loaded(dso, map->type);
1580 pr_debug("Using %s for symbols\n", symfs_vmlinux);
1586 int dso__load_vmlinux_path(struct dso *dso, struct map *map,
1587 symbol_filter_t filter)
1590 char *filename = NULL;
1592 if (!symbol_conf.ignore_vmlinux_buildid)
1593 filename = dso__build_id_filename(dso, NULL, 0);
1594 if (filename != NULL) {
1595 err = dso__load_vmlinux(dso, map, filename, true, filter);
1601 pr_debug("Looking at the vmlinux_path (%d entries long)\n",
1602 vmlinux_path__nr_entries + 1);
1604 for (i = 0; i < vmlinux_path__nr_entries; ++i) {
1605 err = dso__load_vmlinux(dso, map, vmlinux_path[i], false, filter);
1613 static int find_matching_kcore(struct map *map, char *dir, size_t dir_sz)
1615 char kallsyms_filename[PATH_MAX];
1616 struct dirent *dent;
1628 if (dent->d_type != DT_DIR)
1630 scnprintf(kallsyms_filename, sizeof(kallsyms_filename),
1631 "%s/%s/kallsyms", dir, dent->d_name);
1632 if (!validate_kcore_addresses(kallsyms_filename, map)) {
1633 strlcpy(dir, kallsyms_filename, dir_sz);
1644 static char *dso__find_kallsyms(struct dso *dso, struct map *map)
1646 u8 host_build_id[BUILD_ID_SIZE];
1647 char sbuild_id[BUILD_ID_SIZE * 2 + 1];
1648 bool is_host = false;
1649 char path[PATH_MAX];
1651 if (!dso->has_build_id) {
1653 * Last resort, if we don't have a build-id and couldn't find
1654 * any vmlinux file, try the running kernel kallsyms table.
1659 if (sysfs__read_build_id("/sys/kernel/notes", host_build_id,
1660 sizeof(host_build_id)) == 0)
1661 is_host = dso__build_id_equal(dso, host_build_id);
1663 build_id__sprintf(dso->build_id, sizeof(dso->build_id), sbuild_id);
1665 scnprintf(path, sizeof(path), "%s/[kernel.kcore]/%s", buildid_dir,
1668 /* Use /proc/kallsyms if possible */
1673 /* If no cached kcore go with /proc/kallsyms */
1680 * Do not check the build-id cache, until we know we cannot use
1683 fd = open("/proc/kcore", O_RDONLY);
1686 /* If module maps match go with /proc/kallsyms */
1687 if (!validate_kcore_addresses("/proc/kallsyms", map))
1691 /* Find kallsyms in build-id cache with kcore */
1692 if (!find_matching_kcore(map, path, sizeof(path)))
1693 return strdup(path);
1698 /* Find kallsyms in build-id cache with kcore */
1699 if (!find_matching_kcore(map, path, sizeof(path)))
1700 return strdup(path);
1702 scnprintf(path, sizeof(path), "%s/[kernel.kallsyms]/%s",
1703 buildid_dir, sbuild_id);
1705 if (access(path, F_OK)) {
1706 pr_err("No kallsyms or vmlinux with build-id %s was found\n",
1711 return strdup(path);
1714 return strdup("/proc/kallsyms");
1717 static int dso__load_kernel_sym(struct dso *dso, struct map *map,
1718 symbol_filter_t filter)
1721 const char *kallsyms_filename = NULL;
1722 char *kallsyms_allocated_filename = NULL;
1724 * Step 1: if the user specified a kallsyms or vmlinux filename, use
1725 * it and only it, reporting errors to the user if it cannot be used.
1727 * For instance, try to analyse an ARM perf.data file _without_ a
1728 * build-id, or if the user specifies the wrong path to the right
1729 * vmlinux file, obviously we can't fallback to another vmlinux (a
1730 * x86_86 one, on the machine where analysis is being performed, say),
1731 * or worse, /proc/kallsyms.
1733 * If the specified file _has_ a build-id and there is a build-id
1734 * section in the perf.data file, we will still do the expected
1735 * validation in dso__load_vmlinux and will bail out if they don't
1738 if (symbol_conf.kallsyms_name != NULL) {
1739 kallsyms_filename = symbol_conf.kallsyms_name;
1743 if (!symbol_conf.ignore_vmlinux && symbol_conf.vmlinux_name != NULL) {
1744 return dso__load_vmlinux(dso, map, symbol_conf.vmlinux_name,
1748 if (!symbol_conf.ignore_vmlinux && vmlinux_path != NULL) {
1749 err = dso__load_vmlinux_path(dso, map, filter);
1754 /* do not try local files if a symfs was given */
1755 if (symbol_conf.symfs[0] != 0)
1758 kallsyms_allocated_filename = dso__find_kallsyms(dso, map);
1759 if (!kallsyms_allocated_filename)
1762 kallsyms_filename = kallsyms_allocated_filename;
1765 err = dso__load_kallsyms(dso, kallsyms_filename, map, filter);
1767 pr_debug("Using %s for symbols\n", kallsyms_filename);
1768 free(kallsyms_allocated_filename);
1770 if (err > 0 && !dso__is_kcore(dso)) {
1771 dso->binary_type = DSO_BINARY_TYPE__KALLSYMS;
1772 dso__set_long_name(dso, "[kernel.kallsyms]", false);
1773 map__fixup_start(map);
1774 map__fixup_end(map);
1780 static int dso__load_guest_kernel_sym(struct dso *dso, struct map *map,
1781 symbol_filter_t filter)
1784 const char *kallsyms_filename = NULL;
1785 struct machine *machine;
1786 char path[PATH_MAX];
1789 pr_debug("Guest kernel map hasn't the point to groups\n");
1792 machine = map->groups->machine;
1794 if (machine__is_default_guest(machine)) {
1796 * if the user specified a vmlinux filename, use it and only
1797 * it, reporting errors to the user if it cannot be used.
1798 * Or use file guest_kallsyms inputted by user on commandline
1800 if (symbol_conf.default_guest_vmlinux_name != NULL) {
1801 err = dso__load_vmlinux(dso, map,
1802 symbol_conf.default_guest_vmlinux_name,
1807 kallsyms_filename = symbol_conf.default_guest_kallsyms;
1808 if (!kallsyms_filename)
1811 sprintf(path, "%s/proc/kallsyms", machine->root_dir);
1812 kallsyms_filename = path;
1815 err = dso__load_kallsyms(dso, kallsyms_filename, map, filter);
1817 pr_debug("Using %s for symbols\n", kallsyms_filename);
1818 if (err > 0 && !dso__is_kcore(dso)) {
1819 dso->binary_type = DSO_BINARY_TYPE__GUEST_KALLSYMS;
1820 machine__mmap_name(machine, path, sizeof(path));
1821 dso__set_long_name(dso, strdup(path), true);
1822 map__fixup_start(map);
1823 map__fixup_end(map);
1829 static void vmlinux_path__exit(void)
1831 while (--vmlinux_path__nr_entries >= 0)
1832 zfree(&vmlinux_path[vmlinux_path__nr_entries]);
1833 vmlinux_path__nr_entries = 0;
1835 zfree(&vmlinux_path);
1838 static int vmlinux_path__init(struct perf_session_env *env)
1842 char *kernel_version;
1844 vmlinux_path = malloc(sizeof(char *) * 6);
1845 if (vmlinux_path == NULL)
1848 vmlinux_path[vmlinux_path__nr_entries] = strdup("vmlinux");
1849 if (vmlinux_path[vmlinux_path__nr_entries] == NULL)
1851 ++vmlinux_path__nr_entries;
1852 vmlinux_path[vmlinux_path__nr_entries] = strdup("/boot/vmlinux");
1853 if (vmlinux_path[vmlinux_path__nr_entries] == NULL)
1855 ++vmlinux_path__nr_entries;
1857 /* only try kernel version if no symfs was given */
1858 if (symbol_conf.symfs[0] != 0)
1862 kernel_version = env->os_release;
1864 if (uname(&uts) < 0)
1867 kernel_version = uts.release;
1870 snprintf(bf, sizeof(bf), "/boot/vmlinux-%s", kernel_version);
1871 vmlinux_path[vmlinux_path__nr_entries] = strdup(bf);
1872 if (vmlinux_path[vmlinux_path__nr_entries] == NULL)
1874 ++vmlinux_path__nr_entries;
1875 snprintf(bf, sizeof(bf), "/usr/lib/debug/boot/vmlinux-%s",
1877 vmlinux_path[vmlinux_path__nr_entries] = strdup(bf);
1878 if (vmlinux_path[vmlinux_path__nr_entries] == NULL)
1880 ++vmlinux_path__nr_entries;
1881 snprintf(bf, sizeof(bf), "/lib/modules/%s/build/vmlinux", kernel_version);
1882 vmlinux_path[vmlinux_path__nr_entries] = strdup(bf);
1883 if (vmlinux_path[vmlinux_path__nr_entries] == NULL)
1885 ++vmlinux_path__nr_entries;
1886 snprintf(bf, sizeof(bf), "/usr/lib/debug/lib/modules/%s/vmlinux",
1888 vmlinux_path[vmlinux_path__nr_entries] = strdup(bf);
1889 if (vmlinux_path[vmlinux_path__nr_entries] == NULL)
1891 ++vmlinux_path__nr_entries;
1896 vmlinux_path__exit();
1900 int setup_list(struct strlist **list, const char *list_str,
1901 const char *list_name)
1903 if (list_str == NULL)
1906 *list = strlist__new(true, list_str);
1908 pr_err("problems parsing %s list\n", list_name);
1914 int setup_intlist(struct intlist **list, const char *list_str,
1915 const char *list_name)
1917 if (list_str == NULL)
1920 *list = intlist__new(list_str);
1922 pr_err("problems parsing %s list\n", list_name);
1928 static bool symbol__read_kptr_restrict(void)
1932 if (geteuid() != 0) {
1933 FILE *fp = fopen("/proc/sys/kernel/kptr_restrict", "r");
1937 if (fgets(line, sizeof(line), fp) != NULL)
1938 value = atoi(line) != 0;
1947 int symbol__init(struct perf_session_env *env)
1951 if (symbol_conf.initialized)
1954 symbol_conf.priv_size = PERF_ALIGN(symbol_conf.priv_size, sizeof(u64));
1958 if (symbol_conf.sort_by_name)
1959 symbol_conf.priv_size += (sizeof(struct symbol_name_rb_node) -
1960 sizeof(struct symbol));
1962 if (symbol_conf.try_vmlinux_path && vmlinux_path__init(env) < 0)
1965 if (symbol_conf.field_sep && *symbol_conf.field_sep == '.') {
1966 pr_err("'.' is the only non valid --field-separator argument\n");
1970 if (setup_list(&symbol_conf.dso_list,
1971 symbol_conf.dso_list_str, "dso") < 0)
1974 if (setup_list(&symbol_conf.comm_list,
1975 symbol_conf.comm_list_str, "comm") < 0)
1976 goto out_free_dso_list;
1978 if (setup_intlist(&symbol_conf.pid_list,
1979 symbol_conf.pid_list_str, "pid") < 0)
1980 goto out_free_comm_list;
1982 if (setup_intlist(&symbol_conf.tid_list,
1983 symbol_conf.tid_list_str, "tid") < 0)
1984 goto out_free_pid_list;
1986 if (setup_list(&symbol_conf.sym_list,
1987 symbol_conf.sym_list_str, "symbol") < 0)
1988 goto out_free_tid_list;
1991 * A path to symbols of "/" is identical to ""
1992 * reset here for simplicity.
1994 symfs = realpath(symbol_conf.symfs, NULL);
1996 symfs = symbol_conf.symfs;
1997 if (strcmp(symfs, "/") == 0)
1998 symbol_conf.symfs = "";
1999 if (symfs != symbol_conf.symfs)
2000 free((void *)symfs);
2002 symbol_conf.kptr_restrict = symbol__read_kptr_restrict();
2004 symbol_conf.initialized = true;
2008 intlist__delete(symbol_conf.tid_list);
2010 intlist__delete(symbol_conf.pid_list);
2012 strlist__delete(symbol_conf.comm_list);
2014 strlist__delete(symbol_conf.dso_list);
2018 void symbol__exit(void)
2020 if (!symbol_conf.initialized)
2022 strlist__delete(symbol_conf.sym_list);
2023 strlist__delete(symbol_conf.dso_list);
2024 strlist__delete(symbol_conf.comm_list);
2025 intlist__delete(symbol_conf.tid_list);
2026 intlist__delete(symbol_conf.pid_list);
2027 vmlinux_path__exit();
2028 symbol_conf.sym_list = symbol_conf.dso_list = symbol_conf.comm_list = NULL;
2029 symbol_conf.initialized = false;