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 if (symbol_conf.allow_aliases)
157 nd = rb_first(symbols);
160 curr = rb_entry(nd, struct symbol, rb_node);
162 nd = rb_next(&curr->rb_node);
163 next = rb_entry(nd, struct symbol, rb_node);
168 if (curr->start != next->start)
171 if (choose_best_symbol(curr, next) == SYMBOL_A) {
172 rb_erase(&next->rb_node, symbols);
173 symbol__delete(next);
176 nd = rb_next(&curr->rb_node);
177 rb_erase(&curr->rb_node, symbols);
178 symbol__delete(curr);
183 void symbols__fixup_end(struct rb_root *symbols)
185 struct rb_node *nd, *prevnd = rb_first(symbols);
186 struct symbol *curr, *prev;
191 curr = rb_entry(prevnd, struct symbol, rb_node);
193 for (nd = rb_next(prevnd); nd; nd = rb_next(nd)) {
195 curr = rb_entry(nd, struct symbol, rb_node);
197 if (prev->end == prev->start && prev->end != curr->start)
198 prev->end = curr->start;
202 if (curr->end == curr->start)
203 curr->end = roundup(curr->start, 4096);
206 void __map_groups__fixup_end(struct map_groups *mg, enum map_type type)
208 struct maps *maps = &mg->maps[type];
209 struct map *next, *curr;
211 pthread_rwlock_wrlock(&maps->lock);
213 curr = maps__first(maps);
217 for (next = map__next(curr); next; next = map__next(curr)) {
218 curr->end = next->start;
223 * We still haven't the actual symbols, so guess the
224 * last map final address.
229 pthread_rwlock_unlock(&maps->lock);
232 struct symbol *symbol__new(u64 start, u64 len, u8 binding, const char *name)
234 size_t namelen = strlen(name) + 1;
235 struct symbol *sym = calloc(1, (symbol_conf.priv_size +
236 sizeof(*sym) + namelen));
240 if (symbol_conf.priv_size)
241 sym = ((void *)sym) + symbol_conf.priv_size;
244 sym->end = len ? start + len : start;
245 sym->binding = binding;
246 sym->namelen = namelen - 1;
248 pr_debug4("%s: %s %#" PRIx64 "-%#" PRIx64 "\n",
249 __func__, name, start, sym->end);
250 memcpy(sym->name, name, namelen);
255 void symbol__delete(struct symbol *sym)
257 free(((void *)sym) - symbol_conf.priv_size);
260 size_t symbol__fprintf(struct symbol *sym, FILE *fp)
262 return fprintf(fp, " %" PRIx64 "-%" PRIx64 " %c %s\n",
263 sym->start, sym->end,
264 sym->binding == STB_GLOBAL ? 'g' :
265 sym->binding == STB_LOCAL ? 'l' : 'w',
269 size_t symbol__fprintf_symname_offs(const struct symbol *sym,
270 const struct addr_location *al, FILE *fp)
272 unsigned long offset;
275 if (sym && sym->name) {
276 length = fprintf(fp, "%s", sym->name);
278 if (al->addr < sym->end)
279 offset = al->addr - sym->start;
281 offset = al->addr - al->map->start - sym->start;
282 length += fprintf(fp, "+0x%lx", offset);
286 return fprintf(fp, "[unknown]");
289 size_t symbol__fprintf_symname(const struct symbol *sym, FILE *fp)
291 return symbol__fprintf_symname_offs(sym, NULL, fp);
294 void symbols__delete(struct rb_root *symbols)
297 struct rb_node *next = rb_first(symbols);
300 pos = rb_entry(next, struct symbol, rb_node);
301 next = rb_next(&pos->rb_node);
302 rb_erase(&pos->rb_node, symbols);
307 void symbols__insert(struct rb_root *symbols, struct symbol *sym)
309 struct rb_node **p = &symbols->rb_node;
310 struct rb_node *parent = NULL;
311 const u64 ip = sym->start;
316 s = rb_entry(parent, struct symbol, rb_node);
322 rb_link_node(&sym->rb_node, parent, p);
323 rb_insert_color(&sym->rb_node, symbols);
326 static struct symbol *symbols__find(struct rb_root *symbols, u64 ip)
333 n = symbols->rb_node;
336 struct symbol *s = rb_entry(n, struct symbol, rb_node);
340 else if (ip >= s->end)
349 static struct symbol *symbols__first(struct rb_root *symbols)
351 struct rb_node *n = rb_first(symbols);
354 return rb_entry(n, struct symbol, rb_node);
359 static struct symbol *symbols__next(struct symbol *sym)
361 struct rb_node *n = rb_next(&sym->rb_node);
364 return rb_entry(n, struct symbol, rb_node);
369 struct symbol_name_rb_node {
370 struct rb_node rb_node;
374 static void symbols__insert_by_name(struct rb_root *symbols, struct symbol *sym)
376 struct rb_node **p = &symbols->rb_node;
377 struct rb_node *parent = NULL;
378 struct symbol_name_rb_node *symn, *s;
380 symn = container_of(sym, struct symbol_name_rb_node, sym);
384 s = rb_entry(parent, struct symbol_name_rb_node, rb_node);
385 if (strcmp(sym->name, s->sym.name) < 0)
390 rb_link_node(&symn->rb_node, parent, p);
391 rb_insert_color(&symn->rb_node, symbols);
394 static void symbols__sort_by_name(struct rb_root *symbols,
395 struct rb_root *source)
399 for (nd = rb_first(source); nd; nd = rb_next(nd)) {
400 struct symbol *pos = rb_entry(nd, struct symbol, rb_node);
401 symbols__insert_by_name(symbols, pos);
405 static struct symbol *symbols__find_by_name(struct rb_root *symbols,
409 struct symbol_name_rb_node *s = NULL;
414 n = symbols->rb_node;
419 s = rb_entry(n, struct symbol_name_rb_node, rb_node);
420 cmp = arch__compare_symbol_names(name, s->sym.name);
433 /* return first symbol that has same name (if any) */
434 for (n = rb_prev(n); n; n = rb_prev(n)) {
435 struct symbol_name_rb_node *tmp;
437 tmp = rb_entry(n, struct symbol_name_rb_node, rb_node);
438 if (arch__compare_symbol_names(tmp->sym.name, s->sym.name))
447 void dso__reset_find_symbol_cache(struct dso *dso)
451 for (type = MAP__FUNCTION; type <= MAP__VARIABLE; ++type) {
452 dso->last_find_result[type].addr = 0;
453 dso->last_find_result[type].symbol = NULL;
457 struct symbol *dso__find_symbol(struct dso *dso,
458 enum map_type type, u64 addr)
460 if (dso->last_find_result[type].addr != addr) {
461 dso->last_find_result[type].addr = addr;
462 dso->last_find_result[type].symbol = symbols__find(&dso->symbols[type], addr);
465 return dso->last_find_result[type].symbol;
468 struct symbol *dso__first_symbol(struct dso *dso, enum map_type type)
470 return symbols__first(&dso->symbols[type]);
473 struct symbol *dso__next_symbol(struct symbol *sym)
475 return symbols__next(sym);
478 struct symbol *symbol__next_by_name(struct symbol *sym)
480 struct symbol_name_rb_node *s = container_of(sym, struct symbol_name_rb_node, sym);
481 struct rb_node *n = rb_next(&s->rb_node);
483 return n ? &rb_entry(n, struct symbol_name_rb_node, rb_node)->sym : NULL;
487 * Teturns first symbol that matched with @name.
489 struct symbol *dso__find_symbol_by_name(struct dso *dso, enum map_type type,
492 return symbols__find_by_name(&dso->symbol_names[type], name);
495 void dso__sort_by_name(struct dso *dso, enum map_type type)
497 dso__set_sorted_by_name(dso, type);
498 return symbols__sort_by_name(&dso->symbol_names[type],
499 &dso->symbols[type]);
502 size_t dso__fprintf_symbols_by_name(struct dso *dso,
503 enum map_type type, FILE *fp)
507 struct symbol_name_rb_node *pos;
509 for (nd = rb_first(&dso->symbol_names[type]); nd; nd = rb_next(nd)) {
510 pos = rb_entry(nd, struct symbol_name_rb_node, rb_node);
511 fprintf(fp, "%s\n", pos->sym.name);
517 int modules__parse(const char *filename, void *arg,
518 int (*process_module)(void *arg, const char *name,
526 file = fopen(filename, "r");
536 line_len = getline(&line, &n, file);
549 line[--line_len] = '\0'; /* \n */
551 sep = strrchr(line, 'x');
555 hex2u64(sep + 1, &start);
557 sep = strchr(line, ' ');
563 scnprintf(name, sizeof(name), "[%s]", line);
565 err = process_module(arg, name, start);
575 struct process_kallsyms_args {
581 * These are symbols in the kernel image, so make sure that
582 * sym is from a kernel DSO.
584 bool symbol__is_idle(struct symbol *sym)
586 const char * const idle_symbols[] = {
595 "mwait_idle_with_hints",
597 "ppc64_runlatch_off",
598 "pseries_dedicated_idle_sleep",
607 for (i = 0; idle_symbols[i]; i++) {
608 if (!strcmp(idle_symbols[i], sym->name))
615 static int map__process_kallsym_symbol(void *arg, const char *name,
616 char type, u64 start)
619 struct process_kallsyms_args *a = arg;
620 struct rb_root *root = &a->dso->symbols[a->map->type];
622 if (!symbol_type__is_a(type, a->map->type))
626 * module symbols are not sorted so we add all
627 * symbols, setting length to 0, and rely on
628 * symbols__fixup_end() to fix it up.
630 sym = symbol__new(start, 0, kallsyms2elf_binding(type), name);
634 * We will pass the symbols to the filter later, in
635 * map__split_kallsyms, when we have split the maps per module
637 symbols__insert(root, sym);
643 * Loads the function entries in /proc/kallsyms into kernel_map->dso,
644 * so that we can in the next step set the symbol ->end address and then
645 * call kernel_maps__split_kallsyms.
647 static int dso__load_all_kallsyms(struct dso *dso, const char *filename,
650 struct process_kallsyms_args args = { .map = map, .dso = dso, };
651 return kallsyms__parse(filename, &args, map__process_kallsym_symbol);
654 static int dso__split_kallsyms_for_kcore(struct dso *dso, struct map *map,
655 symbol_filter_t filter)
657 struct map_groups *kmaps = map__kmaps(map);
658 struct map *curr_map;
661 struct rb_root old_root = dso->symbols[map->type];
662 struct rb_root *root = &dso->symbols[map->type];
663 struct rb_node *next = rb_first(root);
673 pos = rb_entry(next, struct symbol, rb_node);
674 next = rb_next(&pos->rb_node);
676 rb_erase_init(&pos->rb_node, &old_root);
678 module = strchr(pos->name, '\t');
682 curr_map = map_groups__find(kmaps, map->type, pos->start);
684 if (!curr_map || (filter && filter(curr_map, pos))) {
689 pos->start -= curr_map->start - curr_map->pgoff;
691 pos->end -= curr_map->start - curr_map->pgoff;
692 symbols__insert(&curr_map->dso->symbols[curr_map->type], pos);
696 /* Symbols have been adjusted */
697 dso->adjust_symbols = 1;
703 * Split the symbols into maps, making sure there are no overlaps, i.e. the
704 * kernel range is broken in several maps, named [kernel].N, as we don't have
705 * the original ELF section names vmlinux have.
707 static int dso__split_kallsyms(struct dso *dso, struct map *map, u64 delta,
708 symbol_filter_t filter)
710 struct map_groups *kmaps = map__kmaps(map);
711 struct machine *machine;
712 struct map *curr_map = map;
714 int count = 0, moved = 0;
715 struct rb_root *root = &dso->symbols[map->type];
716 struct rb_node *next = rb_first(root);
717 int kernel_range = 0;
722 machine = kmaps->machine;
727 pos = rb_entry(next, struct symbol, rb_node);
728 next = rb_next(&pos->rb_node);
730 module = strchr(pos->name, '\t');
732 if (!symbol_conf.use_modules)
737 if (strcmp(curr_map->dso->short_name, module)) {
738 if (curr_map != map &&
739 dso->kernel == DSO_TYPE_GUEST_KERNEL &&
740 machine__is_default_guest(machine)) {
742 * We assume all symbols of a module are
743 * continuous in * kallsyms, so curr_map
744 * points to a module and all its
745 * symbols are in its kmap. Mark it as
748 dso__set_loaded(curr_map->dso,
752 curr_map = map_groups__find_by_name(kmaps,
754 if (curr_map == NULL) {
755 pr_debug("%s/proc/{kallsyms,modules} "
756 "inconsistency while looking "
757 "for \"%s\" module!\n",
758 machine->root_dir, module);
763 if (curr_map->dso->loaded &&
764 !machine__is_default_guest(machine))
768 * So that we look just like we get from .ko files,
769 * i.e. not prelinked, relative to map->start.
771 pos->start = curr_map->map_ip(curr_map, pos->start);
772 pos->end = curr_map->map_ip(curr_map, pos->end);
773 } else if (curr_map != map) {
774 char dso_name[PATH_MAX];
778 /* Kernel was relocated at boot time */
788 if (dso->kernel == DSO_TYPE_GUEST_KERNEL)
789 snprintf(dso_name, sizeof(dso_name),
793 snprintf(dso_name, sizeof(dso_name),
797 ndso = dso__new(dso_name);
801 ndso->kernel = dso->kernel;
803 curr_map = map__new2(pos->start, ndso, map->type);
804 if (curr_map == NULL) {
809 curr_map->map_ip = curr_map->unmap_ip = identity__map_ip;
810 map_groups__insert(kmaps, curr_map);
813 /* Kernel was relocated at boot time */
818 if (filter && filter(curr_map, pos)) {
819 discard_symbol: rb_erase(&pos->rb_node, root);
822 if (curr_map != map) {
823 rb_erase(&pos->rb_node, root);
824 symbols__insert(&curr_map->dso->symbols[curr_map->type], pos);
831 if (curr_map != map &&
832 dso->kernel == DSO_TYPE_GUEST_KERNEL &&
833 machine__is_default_guest(kmaps->machine)) {
834 dso__set_loaded(curr_map->dso, curr_map->type);
837 return count + moved;
840 bool symbol__restricted_filename(const char *filename,
841 const char *restricted_filename)
843 bool restricted = false;
845 if (symbol_conf.kptr_restrict) {
846 char *r = realpath(filename, NULL);
849 restricted = strcmp(r, restricted_filename) == 0;
859 struct rb_node rb_node;
864 static void add_module(struct module_info *mi, struct rb_root *modules)
866 struct rb_node **p = &modules->rb_node;
867 struct rb_node *parent = NULL;
868 struct module_info *m;
872 m = rb_entry(parent, struct module_info, rb_node);
873 if (strcmp(mi->name, m->name) < 0)
878 rb_link_node(&mi->rb_node, parent, p);
879 rb_insert_color(&mi->rb_node, modules);
882 static void delete_modules(struct rb_root *modules)
884 struct module_info *mi;
885 struct rb_node *next = rb_first(modules);
888 mi = rb_entry(next, struct module_info, rb_node);
889 next = rb_next(&mi->rb_node);
890 rb_erase(&mi->rb_node, modules);
896 static struct module_info *find_module(const char *name,
897 struct rb_root *modules)
899 struct rb_node *n = modules->rb_node;
902 struct module_info *m;
905 m = rb_entry(n, struct module_info, rb_node);
906 cmp = strcmp(name, m->name);
918 static int __read_proc_modules(void *arg, const char *name, u64 start)
920 struct rb_root *modules = arg;
921 struct module_info *mi;
923 mi = zalloc(sizeof(struct module_info));
927 mi->name = strdup(name);
935 add_module(mi, modules);
940 static int read_proc_modules(const char *filename, struct rb_root *modules)
942 if (symbol__restricted_filename(filename, "/proc/modules"))
945 if (modules__parse(filename, modules, __read_proc_modules)) {
946 delete_modules(modules);
953 int compare_proc_modules(const char *from, const char *to)
955 struct rb_root from_modules = RB_ROOT;
956 struct rb_root to_modules = RB_ROOT;
957 struct rb_node *from_node, *to_node;
958 struct module_info *from_m, *to_m;
961 if (read_proc_modules(from, &from_modules))
964 if (read_proc_modules(to, &to_modules))
965 goto out_delete_from;
967 from_node = rb_first(&from_modules);
968 to_node = rb_first(&to_modules);
973 from_m = rb_entry(from_node, struct module_info, rb_node);
974 to_m = rb_entry(to_node, struct module_info, rb_node);
976 if (from_m->start != to_m->start ||
977 strcmp(from_m->name, to_m->name))
980 from_node = rb_next(from_node);
981 to_node = rb_next(to_node);
984 if (!from_node && !to_node)
987 delete_modules(&to_modules);
989 delete_modules(&from_modules);
994 static int do_validate_kcore_modules(const char *filename, struct map *map,
995 struct map_groups *kmaps)
997 struct rb_root modules = RB_ROOT;
1001 err = read_proc_modules(filename, &modules);
1005 old_map = map_groups__first(kmaps, map->type);
1007 struct map *next = map_groups__next(old_map);
1008 struct module_info *mi;
1010 if (old_map == map || old_map->start == map->start) {
1011 /* The kernel map */
1016 /* Module must be in memory at the same address */
1017 mi = find_module(old_map->dso->short_name, &modules);
1018 if (!mi || mi->start != old_map->start) {
1026 delete_modules(&modules);
1031 * If kallsyms is referenced by name then we look for filename in the same
1034 static bool filename_from_kallsyms_filename(char *filename,
1035 const char *base_name,
1036 const char *kallsyms_filename)
1040 strcpy(filename, kallsyms_filename);
1041 name = strrchr(filename, '/');
1047 if (!strcmp(name, "kallsyms")) {
1048 strcpy(name, base_name);
1055 static int validate_kcore_modules(const char *kallsyms_filename,
1058 struct map_groups *kmaps = map__kmaps(map);
1059 char modules_filename[PATH_MAX];
1064 if (!filename_from_kallsyms_filename(modules_filename, "modules",
1068 if (do_validate_kcore_modules(modules_filename, map, kmaps))
1074 static int validate_kcore_addresses(const char *kallsyms_filename,
1077 struct kmap *kmap = map__kmap(map);
1082 if (kmap->ref_reloc_sym && kmap->ref_reloc_sym->name) {
1085 start = kallsyms__get_function_start(kallsyms_filename,
1086 kmap->ref_reloc_sym->name);
1087 if (start != kmap->ref_reloc_sym->addr)
1091 return validate_kcore_modules(kallsyms_filename, map);
1094 struct kcore_mapfn_data {
1097 struct list_head maps;
1100 static int kcore_mapfn(u64 start, u64 len, u64 pgoff, void *data)
1102 struct kcore_mapfn_data *md = data;
1105 map = map__new2(start, md->dso, md->type);
1109 map->end = map->start + len;
1112 list_add(&map->node, &md->maps);
1117 static int dso__load_kcore(struct dso *dso, struct map *map,
1118 const char *kallsyms_filename)
1120 struct map_groups *kmaps = map__kmaps(map);
1121 struct machine *machine;
1122 struct kcore_mapfn_data md;
1123 struct map *old_map, *new_map, *replacement_map = NULL;
1126 char kcore_filename[PATH_MAX];
1132 machine = kmaps->machine;
1134 /* This function requires that the map is the kernel map */
1135 if (map != machine->vmlinux_maps[map->type])
1138 if (!filename_from_kallsyms_filename(kcore_filename, "kcore",
1142 /* Modules and kernel must be present at their original addresses */
1143 if (validate_kcore_addresses(kallsyms_filename, map))
1147 md.type = map->type;
1148 INIT_LIST_HEAD(&md.maps);
1150 fd = open(kcore_filename, O_RDONLY);
1152 pr_debug("Failed to open %s. Note /proc/kcore requires CAP_SYS_RAWIO capability to access.\n",
1157 /* Read new maps into temporary lists */
1158 err = file__read_maps(fd, md.type == MAP__FUNCTION, kcore_mapfn, &md,
1162 dso->is_64_bit = is_64_bit;
1164 if (list_empty(&md.maps)) {
1169 /* Remove old maps */
1170 old_map = map_groups__first(kmaps, map->type);
1172 struct map *next = map_groups__next(old_map);
1175 map_groups__remove(kmaps, old_map);
1179 /* Find the kernel map using the first symbol */
1180 sym = dso__first_symbol(dso, map->type);
1181 list_for_each_entry(new_map, &md.maps, node) {
1182 if (sym && sym->start >= new_map->start &&
1183 sym->start < new_map->end) {
1184 replacement_map = new_map;
1189 if (!replacement_map)
1190 replacement_map = list_entry(md.maps.next, struct map, node);
1193 while (!list_empty(&md.maps)) {
1194 new_map = list_entry(md.maps.next, struct map, node);
1195 list_del_init(&new_map->node);
1196 if (new_map == replacement_map) {
1197 map->start = new_map->start;
1198 map->end = new_map->end;
1199 map->pgoff = new_map->pgoff;
1200 map->map_ip = new_map->map_ip;
1201 map->unmap_ip = new_map->unmap_ip;
1202 /* Ensure maps are correctly ordered */
1204 map_groups__remove(kmaps, map);
1205 map_groups__insert(kmaps, map);
1208 map_groups__insert(kmaps, new_map);
1215 * Set the data type and long name so that kcore can be read via
1216 * dso__data_read_addr().
1218 if (dso->kernel == DSO_TYPE_GUEST_KERNEL)
1219 dso->binary_type = DSO_BINARY_TYPE__GUEST_KCORE;
1221 dso->binary_type = DSO_BINARY_TYPE__KCORE;
1222 dso__set_long_name(dso, strdup(kcore_filename), true);
1226 if (map->type == MAP__FUNCTION)
1227 pr_debug("Using %s for kernel object code\n", kcore_filename);
1229 pr_debug("Using %s for kernel data\n", kcore_filename);
1234 while (!list_empty(&md.maps)) {
1235 map = list_entry(md.maps.next, struct map, node);
1236 list_del_init(&map->node);
1244 * If the kernel is relocated at boot time, kallsyms won't match. Compute the
1245 * delta based on the relocation reference symbol.
1247 static int kallsyms__delta(struct map *map, const char *filename, u64 *delta)
1249 struct kmap *kmap = map__kmap(map);
1255 if (!kmap->ref_reloc_sym || !kmap->ref_reloc_sym->name)
1258 addr = kallsyms__get_function_start(filename,
1259 kmap->ref_reloc_sym->name);
1263 *delta = addr - kmap->ref_reloc_sym->addr;
1267 int dso__load_kallsyms(struct dso *dso, const char *filename,
1268 struct map *map, symbol_filter_t filter)
1272 if (symbol__restricted_filename(filename, "/proc/kallsyms"))
1275 if (dso__load_all_kallsyms(dso, filename, map) < 0)
1278 if (kallsyms__delta(map, filename, &delta))
1281 symbols__fixup_end(&dso->symbols[map->type]);
1282 symbols__fixup_duplicate(&dso->symbols[map->type]);
1284 if (dso->kernel == DSO_TYPE_GUEST_KERNEL)
1285 dso->symtab_type = DSO_BINARY_TYPE__GUEST_KALLSYMS;
1287 dso->symtab_type = DSO_BINARY_TYPE__KALLSYMS;
1289 if (!dso__load_kcore(dso, map, filename))
1290 return dso__split_kallsyms_for_kcore(dso, map, filter);
1292 return dso__split_kallsyms(dso, map, delta, filter);
1295 static int dso__load_perf_map(struct dso *dso, struct map *map,
1296 symbol_filter_t filter)
1303 file = fopen(dso->long_name, "r");
1307 while (!feof(file)) {
1312 line_len = getline(&line, &n, file);
1319 line[--line_len] = '\0'; /* \n */
1321 len = hex2u64(line, &start);
1324 if (len + 2 >= line_len)
1327 len += hex2u64(line + len, &size);
1330 if (len + 2 >= line_len)
1333 sym = symbol__new(start, size, STB_GLOBAL, line + len);
1336 goto out_delete_line;
1338 if (filter && filter(map, sym))
1339 symbol__delete(sym);
1341 symbols__insert(&dso->symbols[map->type], sym);
1357 static bool dso__is_compatible_symtab_type(struct dso *dso, bool kmod,
1358 enum dso_binary_type type)
1361 case DSO_BINARY_TYPE__JAVA_JIT:
1362 case DSO_BINARY_TYPE__DEBUGLINK:
1363 case DSO_BINARY_TYPE__SYSTEM_PATH_DSO:
1364 case DSO_BINARY_TYPE__FEDORA_DEBUGINFO:
1365 case DSO_BINARY_TYPE__UBUNTU_DEBUGINFO:
1366 case DSO_BINARY_TYPE__BUILDID_DEBUGINFO:
1367 case DSO_BINARY_TYPE__OPENEMBEDDED_DEBUGINFO:
1368 return !kmod && dso->kernel == DSO_TYPE_USER;
1370 case DSO_BINARY_TYPE__KALLSYMS:
1371 case DSO_BINARY_TYPE__VMLINUX:
1372 case DSO_BINARY_TYPE__KCORE:
1373 return dso->kernel == DSO_TYPE_KERNEL;
1375 case DSO_BINARY_TYPE__GUEST_KALLSYMS:
1376 case DSO_BINARY_TYPE__GUEST_VMLINUX:
1377 case DSO_BINARY_TYPE__GUEST_KCORE:
1378 return dso->kernel == DSO_TYPE_GUEST_KERNEL;
1380 case DSO_BINARY_TYPE__GUEST_KMODULE:
1381 case DSO_BINARY_TYPE__GUEST_KMODULE_COMP:
1382 case DSO_BINARY_TYPE__SYSTEM_PATH_KMODULE:
1383 case DSO_BINARY_TYPE__SYSTEM_PATH_KMODULE_COMP:
1385 * kernel modules know their symtab type - it's set when
1386 * creating a module dso in machine__findnew_module_map().
1388 return kmod && dso->symtab_type == type;
1390 case DSO_BINARY_TYPE__BUILD_ID_CACHE:
1393 case DSO_BINARY_TYPE__NOT_FOUND:
1399 int dso__load(struct dso *dso, struct map *map, symbol_filter_t filter)
1404 struct machine *machine;
1405 char *root_dir = (char *) "";
1407 struct symsrc ss_[2];
1408 struct symsrc *syms_ss = NULL, *runtime_ss = NULL;
1410 unsigned char build_id[BUILD_ID_SIZE];
1412 pthread_mutex_lock(&dso->lock);
1414 /* check again under the dso->lock */
1415 if (dso__loaded(dso, map->type)) {
1421 if (dso->kernel == DSO_TYPE_KERNEL)
1422 ret = dso__load_kernel_sym(dso, map, filter);
1423 else if (dso->kernel == DSO_TYPE_GUEST_KERNEL)
1424 ret = dso__load_guest_kernel_sym(dso, map, filter);
1429 if (map->groups && map->groups->machine)
1430 machine = map->groups->machine;
1434 dso->adjust_symbols = 0;
1436 if (strncmp(dso->name, "/tmp/perf-", 10) == 0) {
1439 if (lstat(dso->name, &st) < 0)
1442 if (!symbol_conf.force && st.st_uid && (st.st_uid != geteuid())) {
1443 pr_warning("File %s not owned by current user or root, "
1444 "ignoring it (use -f to override).\n", dso->name);
1448 ret = dso__load_perf_map(dso, map, filter);
1449 dso->symtab_type = ret > 0 ? DSO_BINARY_TYPE__JAVA_JIT :
1450 DSO_BINARY_TYPE__NOT_FOUND;
1455 root_dir = machine->root_dir;
1457 name = malloc(PATH_MAX);
1461 kmod = dso->symtab_type == DSO_BINARY_TYPE__SYSTEM_PATH_KMODULE ||
1462 dso->symtab_type == DSO_BINARY_TYPE__SYSTEM_PATH_KMODULE_COMP ||
1463 dso->symtab_type == DSO_BINARY_TYPE__GUEST_KMODULE ||
1464 dso->symtab_type == DSO_BINARY_TYPE__GUEST_KMODULE_COMP;
1468 * Read the build id if possible. This is required for
1469 * DSO_BINARY_TYPE__BUILDID_DEBUGINFO to work
1471 if ((!dso->has_build_id) &&
1472 (filename__read_build_id(dso->name, build_id, BUILD_ID_SIZE) > 0))
1473 dso__set_build_id(dso, build_id);
1476 * Iterate over candidate debug images.
1477 * Keep track of "interesting" ones (those which have a symtab, dynsym,
1478 * and/or opd section) for processing.
1480 for (i = 0; i < DSO_BINARY_TYPE__SYMTAB_CNT; i++) {
1481 struct symsrc *ss = &ss_[ss_pos];
1482 bool next_slot = false;
1484 enum dso_binary_type symtab_type = binary_type_symtab[i];
1486 if (!dso__is_compatible_symtab_type(dso, kmod, symtab_type))
1489 if (dso__read_binary_type_filename(dso, symtab_type,
1490 root_dir, name, PATH_MAX))
1493 /* Name is now the name of the next image to try */
1494 if (symsrc__init(ss, dso, name, symtab_type) < 0)
1497 if (!syms_ss && symsrc__has_symtab(ss)) {
1500 if (!dso->symsrc_filename)
1501 dso->symsrc_filename = strdup(name);
1504 if (!runtime_ss && symsrc__possibly_runtime(ss)) {
1512 if (syms_ss && runtime_ss)
1515 symsrc__destroy(ss);
1520 if (!runtime_ss && !syms_ss)
1523 if (runtime_ss && !syms_ss) {
1524 syms_ss = runtime_ss;
1527 /* We'll have to hope for the best */
1528 if (!runtime_ss && syms_ss)
1529 runtime_ss = syms_ss;
1532 ret = dso__load_sym(dso, map, syms_ss, runtime_ss, filter, kmod);
1539 nr_plt = dso__synthesize_plt_symbols(dso, runtime_ss, map, filter);
1544 for (; ss_pos > 0; ss_pos--)
1545 symsrc__destroy(&ss_[ss_pos - 1]);
1548 if (ret < 0 && strstr(dso->name, " (deleted)") != NULL)
1551 dso__set_loaded(dso, map->type);
1552 pthread_mutex_unlock(&dso->lock);
1557 struct map *map_groups__find_by_name(struct map_groups *mg,
1558 enum map_type type, const char *name)
1560 struct maps *maps = &mg->maps[type];
1563 pthread_rwlock_rdlock(&maps->lock);
1565 for (map = maps__first(maps); map; map = map__next(map)) {
1566 if (map->dso && strcmp(map->dso->short_name, name) == 0)
1573 pthread_rwlock_unlock(&maps->lock);
1577 int dso__load_vmlinux(struct dso *dso, struct map *map,
1578 const char *vmlinux, bool vmlinux_allocated,
1579 symbol_filter_t filter)
1583 char symfs_vmlinux[PATH_MAX];
1584 enum dso_binary_type symtab_type;
1586 if (vmlinux[0] == '/')
1587 snprintf(symfs_vmlinux, sizeof(symfs_vmlinux), "%s", vmlinux);
1589 symbol__join_symfs(symfs_vmlinux, vmlinux);
1591 if (dso->kernel == DSO_TYPE_GUEST_KERNEL)
1592 symtab_type = DSO_BINARY_TYPE__GUEST_VMLINUX;
1594 symtab_type = DSO_BINARY_TYPE__VMLINUX;
1596 if (symsrc__init(&ss, dso, symfs_vmlinux, symtab_type))
1599 err = dso__load_sym(dso, map, &ss, &ss, filter, 0);
1600 symsrc__destroy(&ss);
1603 if (dso->kernel == DSO_TYPE_GUEST_KERNEL)
1604 dso->binary_type = DSO_BINARY_TYPE__GUEST_VMLINUX;
1606 dso->binary_type = DSO_BINARY_TYPE__VMLINUX;
1607 dso__set_long_name(dso, vmlinux, vmlinux_allocated);
1608 dso__set_loaded(dso, map->type);
1609 pr_debug("Using %s for symbols\n", symfs_vmlinux);
1615 int dso__load_vmlinux_path(struct dso *dso, struct map *map,
1616 symbol_filter_t filter)
1619 char *filename = NULL;
1621 pr_debug("Looking at the vmlinux_path (%d entries long)\n",
1622 vmlinux_path__nr_entries + 1);
1624 for (i = 0; i < vmlinux_path__nr_entries; ++i) {
1625 err = dso__load_vmlinux(dso, map, vmlinux_path[i], false, filter);
1630 if (!symbol_conf.ignore_vmlinux_buildid)
1631 filename = dso__build_id_filename(dso, NULL, 0);
1632 if (filename != NULL) {
1633 err = dso__load_vmlinux(dso, map, filename, true, filter);
1642 static int find_matching_kcore(struct map *map, char *dir, size_t dir_sz)
1644 char kallsyms_filename[PATH_MAX];
1645 struct dirent *dent;
1657 if (dent->d_type != DT_DIR)
1659 scnprintf(kallsyms_filename, sizeof(kallsyms_filename),
1660 "%s/%s/kallsyms", dir, dent->d_name);
1661 if (!validate_kcore_addresses(kallsyms_filename, map)) {
1662 strlcpy(dir, kallsyms_filename, dir_sz);
1673 static char *dso__find_kallsyms(struct dso *dso, struct map *map)
1675 u8 host_build_id[BUILD_ID_SIZE];
1676 char sbuild_id[BUILD_ID_SIZE * 2 + 1];
1677 bool is_host = false;
1678 char path[PATH_MAX];
1680 if (!dso->has_build_id) {
1682 * Last resort, if we don't have a build-id and couldn't find
1683 * any vmlinux file, try the running kernel kallsyms table.
1688 if (sysfs__read_build_id("/sys/kernel/notes", host_build_id,
1689 sizeof(host_build_id)) == 0)
1690 is_host = dso__build_id_equal(dso, host_build_id);
1692 build_id__sprintf(dso->build_id, sizeof(dso->build_id), sbuild_id);
1694 scnprintf(path, sizeof(path), "%s/[kernel.kcore]/%s", buildid_dir,
1697 /* Use /proc/kallsyms if possible */
1702 /* If no cached kcore go with /proc/kallsyms */
1709 * Do not check the build-id cache, until we know we cannot use
1712 fd = open("/proc/kcore", O_RDONLY);
1715 /* If module maps match go with /proc/kallsyms */
1716 if (!validate_kcore_addresses("/proc/kallsyms", map))
1720 /* Find kallsyms in build-id cache with kcore */
1721 if (!find_matching_kcore(map, path, sizeof(path)))
1722 return strdup(path);
1727 /* Find kallsyms in build-id cache with kcore */
1728 if (!find_matching_kcore(map, path, sizeof(path)))
1729 return strdup(path);
1731 scnprintf(path, sizeof(path), "%s/[kernel.kallsyms]/%s",
1732 buildid_dir, sbuild_id);
1734 if (access(path, F_OK)) {
1735 pr_err("No kallsyms or vmlinux with build-id %s was found\n",
1740 return strdup(path);
1743 return strdup("/proc/kallsyms");
1746 static int dso__load_kernel_sym(struct dso *dso, struct map *map,
1747 symbol_filter_t filter)
1750 const char *kallsyms_filename = NULL;
1751 char *kallsyms_allocated_filename = NULL;
1753 * Step 1: if the user specified a kallsyms or vmlinux filename, use
1754 * it and only it, reporting errors to the user if it cannot be used.
1756 * For instance, try to analyse an ARM perf.data file _without_ a
1757 * build-id, or if the user specifies the wrong path to the right
1758 * vmlinux file, obviously we can't fallback to another vmlinux (a
1759 * x86_86 one, on the machine where analysis is being performed, say),
1760 * or worse, /proc/kallsyms.
1762 * If the specified file _has_ a build-id and there is a build-id
1763 * section in the perf.data file, we will still do the expected
1764 * validation in dso__load_vmlinux and will bail out if they don't
1767 if (symbol_conf.kallsyms_name != NULL) {
1768 kallsyms_filename = symbol_conf.kallsyms_name;
1772 if (!symbol_conf.ignore_vmlinux && symbol_conf.vmlinux_name != NULL) {
1773 return dso__load_vmlinux(dso, map, symbol_conf.vmlinux_name,
1777 if (!symbol_conf.ignore_vmlinux && vmlinux_path != NULL) {
1778 err = dso__load_vmlinux_path(dso, map, filter);
1783 /* do not try local files if a symfs was given */
1784 if (symbol_conf.symfs[0] != 0)
1787 kallsyms_allocated_filename = dso__find_kallsyms(dso, map);
1788 if (!kallsyms_allocated_filename)
1791 kallsyms_filename = kallsyms_allocated_filename;
1794 err = dso__load_kallsyms(dso, kallsyms_filename, map, filter);
1796 pr_debug("Using %s for symbols\n", kallsyms_filename);
1797 free(kallsyms_allocated_filename);
1799 if (err > 0 && !dso__is_kcore(dso)) {
1800 dso->binary_type = DSO_BINARY_TYPE__KALLSYMS;
1801 dso__set_long_name(dso, "[kernel.kallsyms]", false);
1802 map__fixup_start(map);
1803 map__fixup_end(map);
1809 static int dso__load_guest_kernel_sym(struct dso *dso, struct map *map,
1810 symbol_filter_t filter)
1813 const char *kallsyms_filename = NULL;
1814 struct machine *machine;
1815 char path[PATH_MAX];
1818 pr_debug("Guest kernel map hasn't the point to groups\n");
1821 machine = map->groups->machine;
1823 if (machine__is_default_guest(machine)) {
1825 * if the user specified a vmlinux filename, use it and only
1826 * it, reporting errors to the user if it cannot be used.
1827 * Or use file guest_kallsyms inputted by user on commandline
1829 if (symbol_conf.default_guest_vmlinux_name != NULL) {
1830 err = dso__load_vmlinux(dso, map,
1831 symbol_conf.default_guest_vmlinux_name,
1836 kallsyms_filename = symbol_conf.default_guest_kallsyms;
1837 if (!kallsyms_filename)
1840 sprintf(path, "%s/proc/kallsyms", machine->root_dir);
1841 kallsyms_filename = path;
1844 err = dso__load_kallsyms(dso, kallsyms_filename, map, filter);
1846 pr_debug("Using %s for symbols\n", kallsyms_filename);
1847 if (err > 0 && !dso__is_kcore(dso)) {
1848 dso->binary_type = DSO_BINARY_TYPE__GUEST_KALLSYMS;
1849 machine__mmap_name(machine, path, sizeof(path));
1850 dso__set_long_name(dso, strdup(path), true);
1851 map__fixup_start(map);
1852 map__fixup_end(map);
1858 static void vmlinux_path__exit(void)
1860 while (--vmlinux_path__nr_entries >= 0)
1861 zfree(&vmlinux_path[vmlinux_path__nr_entries]);
1862 vmlinux_path__nr_entries = 0;
1864 zfree(&vmlinux_path);
1867 static int vmlinux_path__init(struct perf_env *env)
1871 char *kernel_version;
1873 vmlinux_path = malloc(sizeof(char *) * 6);
1874 if (vmlinux_path == NULL)
1877 vmlinux_path[vmlinux_path__nr_entries] = strdup("vmlinux");
1878 if (vmlinux_path[vmlinux_path__nr_entries] == NULL)
1880 ++vmlinux_path__nr_entries;
1881 vmlinux_path[vmlinux_path__nr_entries] = strdup("/boot/vmlinux");
1882 if (vmlinux_path[vmlinux_path__nr_entries] == NULL)
1884 ++vmlinux_path__nr_entries;
1886 /* only try kernel version if no symfs was given */
1887 if (symbol_conf.symfs[0] != 0)
1891 kernel_version = env->os_release;
1893 if (uname(&uts) < 0)
1896 kernel_version = uts.release;
1899 snprintf(bf, sizeof(bf), "/boot/vmlinux-%s", kernel_version);
1900 vmlinux_path[vmlinux_path__nr_entries] = strdup(bf);
1901 if (vmlinux_path[vmlinux_path__nr_entries] == NULL)
1903 ++vmlinux_path__nr_entries;
1904 snprintf(bf, sizeof(bf), "/usr/lib/debug/boot/vmlinux-%s",
1906 vmlinux_path[vmlinux_path__nr_entries] = strdup(bf);
1907 if (vmlinux_path[vmlinux_path__nr_entries] == NULL)
1909 ++vmlinux_path__nr_entries;
1910 snprintf(bf, sizeof(bf), "/lib/modules/%s/build/vmlinux", kernel_version);
1911 vmlinux_path[vmlinux_path__nr_entries] = strdup(bf);
1912 if (vmlinux_path[vmlinux_path__nr_entries] == NULL)
1914 ++vmlinux_path__nr_entries;
1915 snprintf(bf, sizeof(bf), "/usr/lib/debug/lib/modules/%s/vmlinux",
1917 vmlinux_path[vmlinux_path__nr_entries] = strdup(bf);
1918 if (vmlinux_path[vmlinux_path__nr_entries] == NULL)
1920 ++vmlinux_path__nr_entries;
1925 vmlinux_path__exit();
1929 int setup_list(struct strlist **list, const char *list_str,
1930 const char *list_name)
1932 if (list_str == NULL)
1935 *list = strlist__new(list_str, NULL);
1937 pr_err("problems parsing %s list\n", list_name);
1941 symbol_conf.has_filter = true;
1945 int setup_intlist(struct intlist **list, const char *list_str,
1946 const char *list_name)
1948 if (list_str == NULL)
1951 *list = intlist__new(list_str);
1953 pr_err("problems parsing %s list\n", list_name);
1959 static bool symbol__read_kptr_restrict(void)
1963 if (geteuid() != 0) {
1964 FILE *fp = fopen("/proc/sys/kernel/kptr_restrict", "r");
1968 if (fgets(line, sizeof(line), fp) != NULL)
1969 value = atoi(line) != 0;
1978 int symbol__init(struct perf_env *env)
1982 if (symbol_conf.initialized)
1985 symbol_conf.priv_size = PERF_ALIGN(symbol_conf.priv_size, sizeof(u64));
1989 if (symbol_conf.sort_by_name)
1990 symbol_conf.priv_size += (sizeof(struct symbol_name_rb_node) -
1991 sizeof(struct symbol));
1993 if (symbol_conf.try_vmlinux_path && vmlinux_path__init(env) < 0)
1996 if (symbol_conf.field_sep && *symbol_conf.field_sep == '.') {
1997 pr_err("'.' is the only non valid --field-separator argument\n");
2001 if (setup_list(&symbol_conf.dso_list,
2002 symbol_conf.dso_list_str, "dso") < 0)
2005 if (setup_list(&symbol_conf.comm_list,
2006 symbol_conf.comm_list_str, "comm") < 0)
2007 goto out_free_dso_list;
2009 if (setup_intlist(&symbol_conf.pid_list,
2010 symbol_conf.pid_list_str, "pid") < 0)
2011 goto out_free_comm_list;
2013 if (setup_intlist(&symbol_conf.tid_list,
2014 symbol_conf.tid_list_str, "tid") < 0)
2015 goto out_free_pid_list;
2017 if (setup_list(&symbol_conf.sym_list,
2018 symbol_conf.sym_list_str, "symbol") < 0)
2019 goto out_free_tid_list;
2022 * A path to symbols of "/" is identical to ""
2023 * reset here for simplicity.
2025 symfs = realpath(symbol_conf.symfs, NULL);
2027 symfs = symbol_conf.symfs;
2028 if (strcmp(symfs, "/") == 0)
2029 symbol_conf.symfs = "";
2030 if (symfs != symbol_conf.symfs)
2031 free((void *)symfs);
2033 symbol_conf.kptr_restrict = symbol__read_kptr_restrict();
2035 symbol_conf.initialized = true;
2039 intlist__delete(symbol_conf.tid_list);
2041 intlist__delete(symbol_conf.pid_list);
2043 strlist__delete(symbol_conf.comm_list);
2045 strlist__delete(symbol_conf.dso_list);
2049 void symbol__exit(void)
2051 if (!symbol_conf.initialized)
2053 strlist__delete(symbol_conf.sym_list);
2054 strlist__delete(symbol_conf.dso_list);
2055 strlist__delete(symbol_conf.comm_list);
2056 intlist__delete(symbol_conf.tid_list);
2057 intlist__delete(symbol_conf.pid_list);
2058 vmlinux_path__exit();
2059 symbol_conf.sym_list = symbol_conf.dso_list = symbol_conf.comm_list = NULL;
2060 symbol_conf.initialized = false;