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 void dso__reset_find_symbol_cache(struct dso *dso)
448 for (type = MAP__FUNCTION; type <= MAP__VARIABLE; ++type) {
449 dso->last_find_result[type].addr = 0;
450 dso->last_find_result[type].symbol = NULL;
454 struct symbol *dso__find_symbol(struct dso *dso,
455 enum map_type type, u64 addr)
457 if (dso->last_find_result[type].addr != addr) {
458 dso->last_find_result[type].addr = addr;
459 dso->last_find_result[type].symbol = symbols__find(&dso->symbols[type], addr);
462 return dso->last_find_result[type].symbol;
465 struct symbol *dso__first_symbol(struct dso *dso, enum map_type type)
467 return symbols__first(&dso->symbols[type]);
470 struct symbol *dso__next_symbol(struct symbol *sym)
472 return symbols__next(sym);
475 struct symbol *symbol__next_by_name(struct symbol *sym)
477 struct symbol_name_rb_node *s = container_of(sym, struct symbol_name_rb_node, sym);
478 struct rb_node *n = rb_next(&s->rb_node);
480 return n ? &rb_entry(n, struct symbol_name_rb_node, rb_node)->sym : NULL;
484 * Teturns first symbol that matched with @name.
486 struct symbol *dso__find_symbol_by_name(struct dso *dso, enum map_type type,
489 return symbols__find_by_name(&dso->symbol_names[type], name);
492 void dso__sort_by_name(struct dso *dso, enum map_type type)
494 dso__set_sorted_by_name(dso, type);
495 return symbols__sort_by_name(&dso->symbol_names[type],
496 &dso->symbols[type]);
499 size_t dso__fprintf_symbols_by_name(struct dso *dso,
500 enum map_type type, FILE *fp)
504 struct symbol_name_rb_node *pos;
506 for (nd = rb_first(&dso->symbol_names[type]); nd; nd = rb_next(nd)) {
507 pos = rb_entry(nd, struct symbol_name_rb_node, rb_node);
508 fprintf(fp, "%s\n", pos->sym.name);
514 int modules__parse(const char *filename, void *arg,
515 int (*process_module)(void *arg, const char *name,
523 file = fopen(filename, "r");
533 line_len = getline(&line, &n, file);
546 line[--line_len] = '\0'; /* \n */
548 sep = strrchr(line, 'x');
552 hex2u64(sep + 1, &start);
554 sep = strchr(line, ' ');
560 scnprintf(name, sizeof(name), "[%s]", line);
562 err = process_module(arg, name, start);
572 struct process_kallsyms_args {
578 * These are symbols in the kernel image, so make sure that
579 * sym is from a kernel DSO.
581 bool symbol__is_idle(struct symbol *sym)
583 const char * const idle_symbols[] = {
592 "mwait_idle_with_hints",
594 "ppc64_runlatch_off",
595 "pseries_dedicated_idle_sleep",
604 for (i = 0; idle_symbols[i]; i++) {
605 if (!strcmp(idle_symbols[i], sym->name))
612 static int map__process_kallsym_symbol(void *arg, const char *name,
613 char type, u64 start)
616 struct process_kallsyms_args *a = arg;
617 struct rb_root *root = &a->dso->symbols[a->map->type];
619 if (!symbol_type__is_a(type, a->map->type))
623 * module symbols are not sorted so we add all
624 * symbols, setting length to 0, and rely on
625 * symbols__fixup_end() to fix it up.
627 sym = symbol__new(start, 0, kallsyms2elf_binding(type), name);
631 * We will pass the symbols to the filter later, in
632 * map__split_kallsyms, when we have split the maps per module
634 symbols__insert(root, sym);
640 * Loads the function entries in /proc/kallsyms into kernel_map->dso,
641 * so that we can in the next step set the symbol ->end address and then
642 * call kernel_maps__split_kallsyms.
644 static int dso__load_all_kallsyms(struct dso *dso, const char *filename,
647 struct process_kallsyms_args args = { .map = map, .dso = dso, };
648 return kallsyms__parse(filename, &args, map__process_kallsym_symbol);
651 static int dso__split_kallsyms_for_kcore(struct dso *dso, struct map *map,
652 symbol_filter_t filter)
654 struct map_groups *kmaps = map__kmaps(map);
655 struct map *curr_map;
658 struct rb_root old_root = dso->symbols[map->type];
659 struct rb_root *root = &dso->symbols[map->type];
660 struct rb_node *next = rb_first(root);
670 pos = rb_entry(next, struct symbol, rb_node);
671 next = rb_next(&pos->rb_node);
673 rb_erase_init(&pos->rb_node, &old_root);
675 module = strchr(pos->name, '\t');
679 curr_map = map_groups__find(kmaps, map->type, pos->start);
681 if (!curr_map || (filter && filter(curr_map, pos))) {
686 pos->start -= curr_map->start - curr_map->pgoff;
688 pos->end -= curr_map->start - curr_map->pgoff;
689 symbols__insert(&curr_map->dso->symbols[curr_map->type], pos);
693 /* Symbols have been adjusted */
694 dso->adjust_symbols = 1;
700 * Split the symbols into maps, making sure there are no overlaps, i.e. the
701 * kernel range is broken in several maps, named [kernel].N, as we don't have
702 * the original ELF section names vmlinux have.
704 static int dso__split_kallsyms(struct dso *dso, struct map *map, u64 delta,
705 symbol_filter_t filter)
707 struct map_groups *kmaps = map__kmaps(map);
708 struct machine *machine;
709 struct map *curr_map = map;
711 int count = 0, moved = 0;
712 struct rb_root *root = &dso->symbols[map->type];
713 struct rb_node *next = rb_first(root);
714 int kernel_range = 0;
719 machine = kmaps->machine;
724 pos = rb_entry(next, struct symbol, rb_node);
725 next = rb_next(&pos->rb_node);
727 module = strchr(pos->name, '\t');
729 if (!symbol_conf.use_modules)
734 if (strcmp(curr_map->dso->short_name, module)) {
735 if (curr_map != map &&
736 dso->kernel == DSO_TYPE_GUEST_KERNEL &&
737 machine__is_default_guest(machine)) {
739 * We assume all symbols of a module are
740 * continuous in * kallsyms, so curr_map
741 * points to a module and all its
742 * symbols are in its kmap. Mark it as
745 dso__set_loaded(curr_map->dso,
749 curr_map = map_groups__find_by_name(kmaps,
751 if (curr_map == NULL) {
752 pr_debug("%s/proc/{kallsyms,modules} "
753 "inconsistency while looking "
754 "for \"%s\" module!\n",
755 machine->root_dir, module);
760 if (curr_map->dso->loaded &&
761 !machine__is_default_guest(machine))
765 * So that we look just like we get from .ko files,
766 * i.e. not prelinked, relative to map->start.
768 pos->start = curr_map->map_ip(curr_map, pos->start);
769 pos->end = curr_map->map_ip(curr_map, pos->end);
770 } else if (curr_map != map) {
771 char dso_name[PATH_MAX];
775 /* Kernel was relocated at boot time */
785 if (dso->kernel == DSO_TYPE_GUEST_KERNEL)
786 snprintf(dso_name, sizeof(dso_name),
790 snprintf(dso_name, sizeof(dso_name),
794 ndso = dso__new(dso_name);
798 ndso->kernel = dso->kernel;
800 curr_map = map__new2(pos->start, ndso, map->type);
801 if (curr_map == NULL) {
806 curr_map->map_ip = curr_map->unmap_ip = identity__map_ip;
807 map_groups__insert(kmaps, curr_map);
810 /* Kernel was relocated at boot time */
815 if (filter && filter(curr_map, pos)) {
816 discard_symbol: rb_erase(&pos->rb_node, root);
819 if (curr_map != map) {
820 rb_erase(&pos->rb_node, root);
821 symbols__insert(&curr_map->dso->symbols[curr_map->type], pos);
828 if (curr_map != map &&
829 dso->kernel == DSO_TYPE_GUEST_KERNEL &&
830 machine__is_default_guest(kmaps->machine)) {
831 dso__set_loaded(curr_map->dso, curr_map->type);
834 return count + moved;
837 bool symbol__restricted_filename(const char *filename,
838 const char *restricted_filename)
840 bool restricted = false;
842 if (symbol_conf.kptr_restrict) {
843 char *r = realpath(filename, NULL);
846 restricted = strcmp(r, restricted_filename) == 0;
856 struct rb_node rb_node;
861 static void add_module(struct module_info *mi, struct rb_root *modules)
863 struct rb_node **p = &modules->rb_node;
864 struct rb_node *parent = NULL;
865 struct module_info *m;
869 m = rb_entry(parent, struct module_info, rb_node);
870 if (strcmp(mi->name, m->name) < 0)
875 rb_link_node(&mi->rb_node, parent, p);
876 rb_insert_color(&mi->rb_node, modules);
879 static void delete_modules(struct rb_root *modules)
881 struct module_info *mi;
882 struct rb_node *next = rb_first(modules);
885 mi = rb_entry(next, struct module_info, rb_node);
886 next = rb_next(&mi->rb_node);
887 rb_erase(&mi->rb_node, modules);
893 static struct module_info *find_module(const char *name,
894 struct rb_root *modules)
896 struct rb_node *n = modules->rb_node;
899 struct module_info *m;
902 m = rb_entry(n, struct module_info, rb_node);
903 cmp = strcmp(name, m->name);
915 static int __read_proc_modules(void *arg, const char *name, u64 start)
917 struct rb_root *modules = arg;
918 struct module_info *mi;
920 mi = zalloc(sizeof(struct module_info));
924 mi->name = strdup(name);
932 add_module(mi, modules);
937 static int read_proc_modules(const char *filename, struct rb_root *modules)
939 if (symbol__restricted_filename(filename, "/proc/modules"))
942 if (modules__parse(filename, modules, __read_proc_modules)) {
943 delete_modules(modules);
950 int compare_proc_modules(const char *from, const char *to)
952 struct rb_root from_modules = RB_ROOT;
953 struct rb_root to_modules = RB_ROOT;
954 struct rb_node *from_node, *to_node;
955 struct module_info *from_m, *to_m;
958 if (read_proc_modules(from, &from_modules))
961 if (read_proc_modules(to, &to_modules))
962 goto out_delete_from;
964 from_node = rb_first(&from_modules);
965 to_node = rb_first(&to_modules);
970 from_m = rb_entry(from_node, struct module_info, rb_node);
971 to_m = rb_entry(to_node, struct module_info, rb_node);
973 if (from_m->start != to_m->start ||
974 strcmp(from_m->name, to_m->name))
977 from_node = rb_next(from_node);
978 to_node = rb_next(to_node);
981 if (!from_node && !to_node)
984 delete_modules(&to_modules);
986 delete_modules(&from_modules);
991 static int do_validate_kcore_modules(const char *filename, struct map *map,
992 struct map_groups *kmaps)
994 struct rb_root modules = RB_ROOT;
998 err = read_proc_modules(filename, &modules);
1002 old_map = map_groups__first(kmaps, map->type);
1004 struct map *next = map_groups__next(old_map);
1005 struct module_info *mi;
1007 if (old_map == map || old_map->start == map->start) {
1008 /* The kernel map */
1013 /* Module must be in memory at the same address */
1014 mi = find_module(old_map->dso->short_name, &modules);
1015 if (!mi || mi->start != old_map->start) {
1023 delete_modules(&modules);
1028 * If kallsyms is referenced by name then we look for filename in the same
1031 static bool filename_from_kallsyms_filename(char *filename,
1032 const char *base_name,
1033 const char *kallsyms_filename)
1037 strcpy(filename, kallsyms_filename);
1038 name = strrchr(filename, '/');
1044 if (!strcmp(name, "kallsyms")) {
1045 strcpy(name, base_name);
1052 static int validate_kcore_modules(const char *kallsyms_filename,
1055 struct map_groups *kmaps = map__kmaps(map);
1056 char modules_filename[PATH_MAX];
1061 if (!filename_from_kallsyms_filename(modules_filename, "modules",
1065 if (do_validate_kcore_modules(modules_filename, map, kmaps))
1071 static int validate_kcore_addresses(const char *kallsyms_filename,
1074 struct kmap *kmap = map__kmap(map);
1079 if (kmap->ref_reloc_sym && kmap->ref_reloc_sym->name) {
1082 start = kallsyms__get_function_start(kallsyms_filename,
1083 kmap->ref_reloc_sym->name);
1084 if (start != kmap->ref_reloc_sym->addr)
1088 return validate_kcore_modules(kallsyms_filename, map);
1091 struct kcore_mapfn_data {
1094 struct list_head maps;
1097 static int kcore_mapfn(u64 start, u64 len, u64 pgoff, void *data)
1099 struct kcore_mapfn_data *md = data;
1102 map = map__new2(start, md->dso, md->type);
1106 map->end = map->start + len;
1109 list_add(&map->node, &md->maps);
1114 static int dso__load_kcore(struct dso *dso, struct map *map,
1115 const char *kallsyms_filename)
1117 struct map_groups *kmaps = map__kmaps(map);
1118 struct machine *machine;
1119 struct kcore_mapfn_data md;
1120 struct map *old_map, *new_map, *replacement_map = NULL;
1123 char kcore_filename[PATH_MAX];
1129 machine = kmaps->machine;
1131 /* This function requires that the map is the kernel map */
1132 if (map != machine->vmlinux_maps[map->type])
1135 if (!filename_from_kallsyms_filename(kcore_filename, "kcore",
1139 /* Modules and kernel must be present at their original addresses */
1140 if (validate_kcore_addresses(kallsyms_filename, map))
1144 md.type = map->type;
1145 INIT_LIST_HEAD(&md.maps);
1147 fd = open(kcore_filename, O_RDONLY);
1149 pr_debug("Failed to open %s. Note /proc/kcore requires CAP_SYS_RAWIO capability to access.\n",
1154 /* Read new maps into temporary lists */
1155 err = file__read_maps(fd, md.type == MAP__FUNCTION, kcore_mapfn, &md,
1159 dso->is_64_bit = is_64_bit;
1161 if (list_empty(&md.maps)) {
1166 /* Remove old maps */
1167 old_map = map_groups__first(kmaps, map->type);
1169 struct map *next = map_groups__next(old_map);
1172 map_groups__remove(kmaps, old_map);
1176 /* Find the kernel map using the first symbol */
1177 sym = dso__first_symbol(dso, map->type);
1178 list_for_each_entry(new_map, &md.maps, node) {
1179 if (sym && sym->start >= new_map->start &&
1180 sym->start < new_map->end) {
1181 replacement_map = new_map;
1186 if (!replacement_map)
1187 replacement_map = list_entry(md.maps.next, struct map, node);
1190 while (!list_empty(&md.maps)) {
1191 new_map = list_entry(md.maps.next, struct map, node);
1192 list_del_init(&new_map->node);
1193 if (new_map == replacement_map) {
1194 map->start = new_map->start;
1195 map->end = new_map->end;
1196 map->pgoff = new_map->pgoff;
1197 map->map_ip = new_map->map_ip;
1198 map->unmap_ip = new_map->unmap_ip;
1199 /* Ensure maps are correctly ordered */
1201 map_groups__remove(kmaps, map);
1202 map_groups__insert(kmaps, map);
1205 map_groups__insert(kmaps, new_map);
1212 * Set the data type and long name so that kcore can be read via
1213 * dso__data_read_addr().
1215 if (dso->kernel == DSO_TYPE_GUEST_KERNEL)
1216 dso->binary_type = DSO_BINARY_TYPE__GUEST_KCORE;
1218 dso->binary_type = DSO_BINARY_TYPE__KCORE;
1219 dso__set_long_name(dso, strdup(kcore_filename), true);
1223 if (map->type == MAP__FUNCTION)
1224 pr_debug("Using %s for kernel object code\n", kcore_filename);
1226 pr_debug("Using %s for kernel data\n", kcore_filename);
1231 while (!list_empty(&md.maps)) {
1232 map = list_entry(md.maps.next, struct map, node);
1233 list_del_init(&map->node);
1241 * If the kernel is relocated at boot time, kallsyms won't match. Compute the
1242 * delta based on the relocation reference symbol.
1244 static int kallsyms__delta(struct map *map, const char *filename, u64 *delta)
1246 struct kmap *kmap = map__kmap(map);
1252 if (!kmap->ref_reloc_sym || !kmap->ref_reloc_sym->name)
1255 addr = kallsyms__get_function_start(filename,
1256 kmap->ref_reloc_sym->name);
1260 *delta = addr - kmap->ref_reloc_sym->addr;
1264 int dso__load_kallsyms(struct dso *dso, const char *filename,
1265 struct map *map, symbol_filter_t filter)
1269 if (symbol__restricted_filename(filename, "/proc/kallsyms"))
1272 if (dso__load_all_kallsyms(dso, filename, map) < 0)
1275 if (kallsyms__delta(map, filename, &delta))
1278 symbols__fixup_duplicate(&dso->symbols[map->type]);
1279 symbols__fixup_end(&dso->symbols[map->type]);
1281 if (dso->kernel == DSO_TYPE_GUEST_KERNEL)
1282 dso->symtab_type = DSO_BINARY_TYPE__GUEST_KALLSYMS;
1284 dso->symtab_type = DSO_BINARY_TYPE__KALLSYMS;
1286 if (!dso__load_kcore(dso, map, filename))
1287 return dso__split_kallsyms_for_kcore(dso, map, filter);
1289 return dso__split_kallsyms(dso, map, delta, filter);
1292 static int dso__load_perf_map(struct dso *dso, struct map *map,
1293 symbol_filter_t filter)
1300 file = fopen(dso->long_name, "r");
1304 while (!feof(file)) {
1309 line_len = getline(&line, &n, file);
1316 line[--line_len] = '\0'; /* \n */
1318 len = hex2u64(line, &start);
1321 if (len + 2 >= line_len)
1324 len += hex2u64(line + len, &size);
1327 if (len + 2 >= line_len)
1330 sym = symbol__new(start, size, STB_GLOBAL, line + len);
1333 goto out_delete_line;
1335 if (filter && filter(map, sym))
1336 symbol__delete(sym);
1338 symbols__insert(&dso->symbols[map->type], sym);
1354 static bool dso__is_compatible_symtab_type(struct dso *dso, bool kmod,
1355 enum dso_binary_type type)
1358 case DSO_BINARY_TYPE__JAVA_JIT:
1359 case DSO_BINARY_TYPE__DEBUGLINK:
1360 case DSO_BINARY_TYPE__SYSTEM_PATH_DSO:
1361 case DSO_BINARY_TYPE__FEDORA_DEBUGINFO:
1362 case DSO_BINARY_TYPE__UBUNTU_DEBUGINFO:
1363 case DSO_BINARY_TYPE__BUILDID_DEBUGINFO:
1364 case DSO_BINARY_TYPE__OPENEMBEDDED_DEBUGINFO:
1365 return !kmod && dso->kernel == DSO_TYPE_USER;
1367 case DSO_BINARY_TYPE__KALLSYMS:
1368 case DSO_BINARY_TYPE__VMLINUX:
1369 case DSO_BINARY_TYPE__KCORE:
1370 return dso->kernel == DSO_TYPE_KERNEL;
1372 case DSO_BINARY_TYPE__GUEST_KALLSYMS:
1373 case DSO_BINARY_TYPE__GUEST_VMLINUX:
1374 case DSO_BINARY_TYPE__GUEST_KCORE:
1375 return dso->kernel == DSO_TYPE_GUEST_KERNEL;
1377 case DSO_BINARY_TYPE__GUEST_KMODULE:
1378 case DSO_BINARY_TYPE__GUEST_KMODULE_COMP:
1379 case DSO_BINARY_TYPE__SYSTEM_PATH_KMODULE:
1380 case DSO_BINARY_TYPE__SYSTEM_PATH_KMODULE_COMP:
1382 * kernel modules know their symtab type - it's set when
1383 * creating a module dso in machine__findnew_module_map().
1385 return kmod && dso->symtab_type == type;
1387 case DSO_BINARY_TYPE__BUILD_ID_CACHE:
1390 case DSO_BINARY_TYPE__NOT_FOUND:
1396 int dso__load(struct dso *dso, struct map *map, symbol_filter_t filter)
1401 struct machine *machine;
1402 char *root_dir = (char *) "";
1404 struct symsrc ss_[2];
1405 struct symsrc *syms_ss = NULL, *runtime_ss = NULL;
1407 unsigned char build_id[BUILD_ID_SIZE];
1409 pthread_mutex_lock(&dso->lock);
1411 /* check again under the dso->lock */
1412 if (dso__loaded(dso, map->type)) {
1418 if (dso->kernel == DSO_TYPE_KERNEL)
1419 ret = dso__load_kernel_sym(dso, map, filter);
1420 else if (dso->kernel == DSO_TYPE_GUEST_KERNEL)
1421 ret = dso__load_guest_kernel_sym(dso, map, filter);
1426 if (map->groups && map->groups->machine)
1427 machine = map->groups->machine;
1431 dso->adjust_symbols = 0;
1433 if (strncmp(dso->name, "/tmp/perf-", 10) == 0) {
1436 if (lstat(dso->name, &st) < 0)
1439 if (!symbol_conf.force && st.st_uid && (st.st_uid != geteuid())) {
1440 pr_warning("File %s not owned by current user or root, "
1441 "ignoring it (use -f to override).\n", dso->name);
1445 ret = dso__load_perf_map(dso, map, filter);
1446 dso->symtab_type = ret > 0 ? DSO_BINARY_TYPE__JAVA_JIT :
1447 DSO_BINARY_TYPE__NOT_FOUND;
1452 root_dir = machine->root_dir;
1454 name = malloc(PATH_MAX);
1458 kmod = dso->symtab_type == DSO_BINARY_TYPE__SYSTEM_PATH_KMODULE ||
1459 dso->symtab_type == DSO_BINARY_TYPE__SYSTEM_PATH_KMODULE_COMP ||
1460 dso->symtab_type == DSO_BINARY_TYPE__GUEST_KMODULE ||
1461 dso->symtab_type == DSO_BINARY_TYPE__GUEST_KMODULE_COMP;
1465 * Read the build id if possible. This is required for
1466 * DSO_BINARY_TYPE__BUILDID_DEBUGINFO to work
1468 if (filename__read_build_id(dso->name, build_id, BUILD_ID_SIZE) > 0)
1469 dso__set_build_id(dso, build_id);
1472 * Iterate over candidate debug images.
1473 * Keep track of "interesting" ones (those which have a symtab, dynsym,
1474 * and/or opd section) for processing.
1476 for (i = 0; i < DSO_BINARY_TYPE__SYMTAB_CNT; i++) {
1477 struct symsrc *ss = &ss_[ss_pos];
1478 bool next_slot = false;
1480 enum dso_binary_type symtab_type = binary_type_symtab[i];
1482 if (!dso__is_compatible_symtab_type(dso, kmod, symtab_type))
1485 if (dso__read_binary_type_filename(dso, symtab_type,
1486 root_dir, name, PATH_MAX))
1489 /* Name is now the name of the next image to try */
1490 if (symsrc__init(ss, dso, name, symtab_type) < 0)
1493 if (!syms_ss && symsrc__has_symtab(ss)) {
1496 if (!dso->symsrc_filename)
1497 dso->symsrc_filename = strdup(name);
1500 if (!runtime_ss && symsrc__possibly_runtime(ss)) {
1508 if (syms_ss && runtime_ss)
1511 symsrc__destroy(ss);
1516 if (!runtime_ss && !syms_ss)
1519 if (runtime_ss && !syms_ss) {
1520 syms_ss = runtime_ss;
1523 /* We'll have to hope for the best */
1524 if (!runtime_ss && syms_ss)
1525 runtime_ss = syms_ss;
1528 ret = dso__load_sym(dso, map, syms_ss, runtime_ss, filter, kmod);
1535 nr_plt = dso__synthesize_plt_symbols(dso, runtime_ss, map, filter);
1540 for (; ss_pos > 0; ss_pos--)
1541 symsrc__destroy(&ss_[ss_pos - 1]);
1544 if (ret < 0 && strstr(dso->name, " (deleted)") != NULL)
1547 dso__set_loaded(dso, map->type);
1548 pthread_mutex_unlock(&dso->lock);
1553 struct map *map_groups__find_by_name(struct map_groups *mg,
1554 enum map_type type, const char *name)
1556 struct maps *maps = &mg->maps[type];
1559 pthread_rwlock_rdlock(&maps->lock);
1561 for (map = maps__first(maps); map; map = map__next(map)) {
1562 if (map->dso && strcmp(map->dso->short_name, name) == 0)
1569 pthread_rwlock_unlock(&maps->lock);
1573 int dso__load_vmlinux(struct dso *dso, struct map *map,
1574 const char *vmlinux, bool vmlinux_allocated,
1575 symbol_filter_t filter)
1579 char symfs_vmlinux[PATH_MAX];
1580 enum dso_binary_type symtab_type;
1582 if (vmlinux[0] == '/')
1583 snprintf(symfs_vmlinux, sizeof(symfs_vmlinux), "%s", vmlinux);
1585 symbol__join_symfs(symfs_vmlinux, vmlinux);
1587 if (dso->kernel == DSO_TYPE_GUEST_KERNEL)
1588 symtab_type = DSO_BINARY_TYPE__GUEST_VMLINUX;
1590 symtab_type = DSO_BINARY_TYPE__VMLINUX;
1592 if (symsrc__init(&ss, dso, symfs_vmlinux, symtab_type))
1595 err = dso__load_sym(dso, map, &ss, &ss, filter, 0);
1596 symsrc__destroy(&ss);
1599 if (dso->kernel == DSO_TYPE_GUEST_KERNEL)
1600 dso->binary_type = DSO_BINARY_TYPE__GUEST_VMLINUX;
1602 dso->binary_type = DSO_BINARY_TYPE__VMLINUX;
1603 dso__set_long_name(dso, vmlinux, vmlinux_allocated);
1604 dso__set_loaded(dso, map->type);
1605 pr_debug("Using %s for symbols\n", symfs_vmlinux);
1611 int dso__load_vmlinux_path(struct dso *dso, struct map *map,
1612 symbol_filter_t filter)
1615 char *filename = NULL;
1617 pr_debug("Looking at the vmlinux_path (%d entries long)\n",
1618 vmlinux_path__nr_entries + 1);
1620 for (i = 0; i < vmlinux_path__nr_entries; ++i) {
1621 err = dso__load_vmlinux(dso, map, vmlinux_path[i], false, filter);
1626 if (!symbol_conf.ignore_vmlinux_buildid)
1627 filename = dso__build_id_filename(dso, NULL, 0);
1628 if (filename != NULL) {
1629 err = dso__load_vmlinux(dso, map, filename, true, filter);
1638 static int find_matching_kcore(struct map *map, char *dir, size_t dir_sz)
1640 char kallsyms_filename[PATH_MAX];
1641 struct dirent *dent;
1653 if (dent->d_type != DT_DIR)
1655 scnprintf(kallsyms_filename, sizeof(kallsyms_filename),
1656 "%s/%s/kallsyms", dir, dent->d_name);
1657 if (!validate_kcore_addresses(kallsyms_filename, map)) {
1658 strlcpy(dir, kallsyms_filename, dir_sz);
1669 static char *dso__find_kallsyms(struct dso *dso, struct map *map)
1671 u8 host_build_id[BUILD_ID_SIZE];
1672 char sbuild_id[BUILD_ID_SIZE * 2 + 1];
1673 bool is_host = false;
1674 char path[PATH_MAX];
1676 if (!dso->has_build_id) {
1678 * Last resort, if we don't have a build-id and couldn't find
1679 * any vmlinux file, try the running kernel kallsyms table.
1684 if (sysfs__read_build_id("/sys/kernel/notes", host_build_id,
1685 sizeof(host_build_id)) == 0)
1686 is_host = dso__build_id_equal(dso, host_build_id);
1688 build_id__sprintf(dso->build_id, sizeof(dso->build_id), sbuild_id);
1690 scnprintf(path, sizeof(path), "%s/[kernel.kcore]/%s", buildid_dir,
1693 /* Use /proc/kallsyms if possible */
1698 /* If no cached kcore go with /proc/kallsyms */
1705 * Do not check the build-id cache, until we know we cannot use
1708 fd = open("/proc/kcore", O_RDONLY);
1711 /* If module maps match go with /proc/kallsyms */
1712 if (!validate_kcore_addresses("/proc/kallsyms", map))
1716 /* Find kallsyms in build-id cache with kcore */
1717 if (!find_matching_kcore(map, path, sizeof(path)))
1718 return strdup(path);
1723 /* Find kallsyms in build-id cache with kcore */
1724 if (!find_matching_kcore(map, path, sizeof(path)))
1725 return strdup(path);
1727 scnprintf(path, sizeof(path), "%s/[kernel.kallsyms]/%s",
1728 buildid_dir, sbuild_id);
1730 if (access(path, F_OK)) {
1731 pr_err("No kallsyms or vmlinux with build-id %s was found\n",
1736 return strdup(path);
1739 return strdup("/proc/kallsyms");
1742 static int dso__load_kernel_sym(struct dso *dso, struct map *map,
1743 symbol_filter_t filter)
1746 const char *kallsyms_filename = NULL;
1747 char *kallsyms_allocated_filename = NULL;
1749 * Step 1: if the user specified a kallsyms or vmlinux filename, use
1750 * it and only it, reporting errors to the user if it cannot be used.
1752 * For instance, try to analyse an ARM perf.data file _without_ a
1753 * build-id, or if the user specifies the wrong path to the right
1754 * vmlinux file, obviously we can't fallback to another vmlinux (a
1755 * x86_86 one, on the machine where analysis is being performed, say),
1756 * or worse, /proc/kallsyms.
1758 * If the specified file _has_ a build-id and there is a build-id
1759 * section in the perf.data file, we will still do the expected
1760 * validation in dso__load_vmlinux and will bail out if they don't
1763 if (symbol_conf.kallsyms_name != NULL) {
1764 kallsyms_filename = symbol_conf.kallsyms_name;
1768 if (!symbol_conf.ignore_vmlinux && symbol_conf.vmlinux_name != NULL) {
1769 return dso__load_vmlinux(dso, map, symbol_conf.vmlinux_name,
1773 if (!symbol_conf.ignore_vmlinux && vmlinux_path != NULL) {
1774 err = dso__load_vmlinux_path(dso, map, filter);
1779 /* do not try local files if a symfs was given */
1780 if (symbol_conf.symfs[0] != 0)
1783 kallsyms_allocated_filename = dso__find_kallsyms(dso, map);
1784 if (!kallsyms_allocated_filename)
1787 kallsyms_filename = kallsyms_allocated_filename;
1790 err = dso__load_kallsyms(dso, kallsyms_filename, map, filter);
1792 pr_debug("Using %s for symbols\n", kallsyms_filename);
1793 free(kallsyms_allocated_filename);
1795 if (err > 0 && !dso__is_kcore(dso)) {
1796 dso->binary_type = DSO_BINARY_TYPE__KALLSYMS;
1797 dso__set_long_name(dso, "[kernel.kallsyms]", false);
1798 map__fixup_start(map);
1799 map__fixup_end(map);
1805 static int dso__load_guest_kernel_sym(struct dso *dso, struct map *map,
1806 symbol_filter_t filter)
1809 const char *kallsyms_filename = NULL;
1810 struct machine *machine;
1811 char path[PATH_MAX];
1814 pr_debug("Guest kernel map hasn't the point to groups\n");
1817 machine = map->groups->machine;
1819 if (machine__is_default_guest(machine)) {
1821 * if the user specified a vmlinux filename, use it and only
1822 * it, reporting errors to the user if it cannot be used.
1823 * Or use file guest_kallsyms inputted by user on commandline
1825 if (symbol_conf.default_guest_vmlinux_name != NULL) {
1826 err = dso__load_vmlinux(dso, map,
1827 symbol_conf.default_guest_vmlinux_name,
1832 kallsyms_filename = symbol_conf.default_guest_kallsyms;
1833 if (!kallsyms_filename)
1836 sprintf(path, "%s/proc/kallsyms", machine->root_dir);
1837 kallsyms_filename = path;
1840 err = dso__load_kallsyms(dso, kallsyms_filename, map, filter);
1842 pr_debug("Using %s for symbols\n", kallsyms_filename);
1843 if (err > 0 && !dso__is_kcore(dso)) {
1844 dso->binary_type = DSO_BINARY_TYPE__GUEST_KALLSYMS;
1845 machine__mmap_name(machine, path, sizeof(path));
1846 dso__set_long_name(dso, strdup(path), true);
1847 map__fixup_start(map);
1848 map__fixup_end(map);
1854 static void vmlinux_path__exit(void)
1856 while (--vmlinux_path__nr_entries >= 0)
1857 zfree(&vmlinux_path[vmlinux_path__nr_entries]);
1858 vmlinux_path__nr_entries = 0;
1860 zfree(&vmlinux_path);
1863 static int vmlinux_path__init(struct perf_env *env)
1867 char *kernel_version;
1869 vmlinux_path = malloc(sizeof(char *) * 6);
1870 if (vmlinux_path == NULL)
1873 vmlinux_path[vmlinux_path__nr_entries] = strdup("vmlinux");
1874 if (vmlinux_path[vmlinux_path__nr_entries] == NULL)
1876 ++vmlinux_path__nr_entries;
1877 vmlinux_path[vmlinux_path__nr_entries] = strdup("/boot/vmlinux");
1878 if (vmlinux_path[vmlinux_path__nr_entries] == NULL)
1880 ++vmlinux_path__nr_entries;
1882 /* only try kernel version if no symfs was given */
1883 if (symbol_conf.symfs[0] != 0)
1887 kernel_version = env->os_release;
1889 if (uname(&uts) < 0)
1892 kernel_version = uts.release;
1895 snprintf(bf, sizeof(bf), "/boot/vmlinux-%s", kernel_version);
1896 vmlinux_path[vmlinux_path__nr_entries] = strdup(bf);
1897 if (vmlinux_path[vmlinux_path__nr_entries] == NULL)
1899 ++vmlinux_path__nr_entries;
1900 snprintf(bf, sizeof(bf), "/usr/lib/debug/boot/vmlinux-%s",
1902 vmlinux_path[vmlinux_path__nr_entries] = strdup(bf);
1903 if (vmlinux_path[vmlinux_path__nr_entries] == NULL)
1905 ++vmlinux_path__nr_entries;
1906 snprintf(bf, sizeof(bf), "/lib/modules/%s/build/vmlinux", kernel_version);
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), "/usr/lib/debug/lib/modules/%s/vmlinux",
1913 vmlinux_path[vmlinux_path__nr_entries] = strdup(bf);
1914 if (vmlinux_path[vmlinux_path__nr_entries] == NULL)
1916 ++vmlinux_path__nr_entries;
1921 vmlinux_path__exit();
1925 int setup_list(struct strlist **list, const char *list_str,
1926 const char *list_name)
1928 if (list_str == NULL)
1931 *list = strlist__new(list_str, NULL);
1933 pr_err("problems parsing %s list\n", list_name);
1937 symbol_conf.has_filter = true;
1941 int setup_intlist(struct intlist **list, const char *list_str,
1942 const char *list_name)
1944 if (list_str == NULL)
1947 *list = intlist__new(list_str);
1949 pr_err("problems parsing %s list\n", list_name);
1955 static bool symbol__read_kptr_restrict(void)
1959 if (geteuid() != 0) {
1960 FILE *fp = fopen("/proc/sys/kernel/kptr_restrict", "r");
1964 if (fgets(line, sizeof(line), fp) != NULL)
1965 value = atoi(line) != 0;
1974 int symbol__init(struct perf_env *env)
1978 if (symbol_conf.initialized)
1981 symbol_conf.priv_size = PERF_ALIGN(symbol_conf.priv_size, sizeof(u64));
1985 if (symbol_conf.sort_by_name)
1986 symbol_conf.priv_size += (sizeof(struct symbol_name_rb_node) -
1987 sizeof(struct symbol));
1989 if (symbol_conf.try_vmlinux_path && vmlinux_path__init(env) < 0)
1992 if (symbol_conf.field_sep && *symbol_conf.field_sep == '.') {
1993 pr_err("'.' is the only non valid --field-separator argument\n");
1997 if (setup_list(&symbol_conf.dso_list,
1998 symbol_conf.dso_list_str, "dso") < 0)
2001 if (setup_list(&symbol_conf.comm_list,
2002 symbol_conf.comm_list_str, "comm") < 0)
2003 goto out_free_dso_list;
2005 if (setup_intlist(&symbol_conf.pid_list,
2006 symbol_conf.pid_list_str, "pid") < 0)
2007 goto out_free_comm_list;
2009 if (setup_intlist(&symbol_conf.tid_list,
2010 symbol_conf.tid_list_str, "tid") < 0)
2011 goto out_free_pid_list;
2013 if (setup_list(&symbol_conf.sym_list,
2014 symbol_conf.sym_list_str, "symbol") < 0)
2015 goto out_free_tid_list;
2018 * A path to symbols of "/" is identical to ""
2019 * reset here for simplicity.
2021 symfs = realpath(symbol_conf.symfs, NULL);
2023 symfs = symbol_conf.symfs;
2024 if (strcmp(symfs, "/") == 0)
2025 symbol_conf.symfs = "";
2026 if (symfs != symbol_conf.symfs)
2027 free((void *)symfs);
2029 symbol_conf.kptr_restrict = symbol__read_kptr_restrict();
2031 symbol_conf.initialized = true;
2035 intlist__delete(symbol_conf.tid_list);
2037 intlist__delete(symbol_conf.pid_list);
2039 strlist__delete(symbol_conf.comm_list);
2041 strlist__delete(symbol_conf.dso_list);
2045 void symbol__exit(void)
2047 if (!symbol_conf.initialized)
2049 strlist__delete(symbol_conf.sym_list);
2050 strlist__delete(symbol_conf.dso_list);
2051 strlist__delete(symbol_conf.comm_list);
2052 intlist__delete(symbol_conf.tid_list);
2053 intlist__delete(symbol_conf.pid_list);
2054 vmlinux_path__exit();
2055 symbol_conf.sym_list = symbol_conf.dso_list = symbol_conf.comm_list = NULL;
2056 symbol_conf.initialized = false;