24 #include <symbol/kallsyms.h>
25 #include <sys/utsname.h>
27 static int dso__load_kernel_sym(struct dso *dso, struct map *map);
28 static int dso__load_guest_kernel_sym(struct dso *dso, struct map *map);
29 static bool symbol__is_idle(const char *name);
31 int vmlinux_path__nr_entries;
34 struct symbol_conf symbol_conf = {
36 .try_vmlinux_path = true,
39 .demangle_kernel = false,
40 .cumulate_callchain = true,
41 .show_hist_headers = true,
46 static enum dso_binary_type binary_type_symtab[] = {
47 DSO_BINARY_TYPE__KALLSYMS,
48 DSO_BINARY_TYPE__GUEST_KALLSYMS,
49 DSO_BINARY_TYPE__JAVA_JIT,
50 DSO_BINARY_TYPE__DEBUGLINK,
51 DSO_BINARY_TYPE__BUILD_ID_CACHE,
52 DSO_BINARY_TYPE__FEDORA_DEBUGINFO,
53 DSO_BINARY_TYPE__UBUNTU_DEBUGINFO,
54 DSO_BINARY_TYPE__BUILDID_DEBUGINFO,
55 DSO_BINARY_TYPE__SYSTEM_PATH_DSO,
56 DSO_BINARY_TYPE__GUEST_KMODULE,
57 DSO_BINARY_TYPE__GUEST_KMODULE_COMP,
58 DSO_BINARY_TYPE__SYSTEM_PATH_KMODULE,
59 DSO_BINARY_TYPE__SYSTEM_PATH_KMODULE_COMP,
60 DSO_BINARY_TYPE__OPENEMBEDDED_DEBUGINFO,
61 DSO_BINARY_TYPE__NOT_FOUND,
64 #define DSO_BINARY_TYPE__SYMTAB_CNT ARRAY_SIZE(binary_type_symtab)
66 bool symbol_type__is_a(char symbol_type, enum map_type map_type)
68 symbol_type = toupper(symbol_type);
72 return symbol_type == 'T' || symbol_type == 'W';
74 return symbol_type == 'D';
80 static int prefix_underscores_count(const char *str)
82 const char *tail = str;
90 int __weak arch__choose_best_symbol(struct symbol *syma,
91 struct symbol *symb __maybe_unused)
93 /* Avoid "SyS" kernel syscall aliases */
94 if (strlen(syma->name) >= 3 && !strncmp(syma->name, "SyS", 3))
96 if (strlen(syma->name) >= 10 && !strncmp(syma->name, "compat_SyS", 10))
102 static int choose_best_symbol(struct symbol *syma, struct symbol *symb)
108 /* Prefer a symbol with non zero length */
109 a = syma->end - syma->start;
110 b = symb->end - symb->start;
111 if ((b == 0) && (a > 0))
113 else if ((a == 0) && (b > 0))
116 /* Prefer a non weak symbol over a weak one */
117 a = syma->binding == STB_WEAK;
118 b = symb->binding == STB_WEAK;
124 /* Prefer a global symbol over a non global one */
125 a = syma->binding == STB_GLOBAL;
126 b = symb->binding == STB_GLOBAL;
132 /* Prefer a symbol with less underscores */
133 a = prefix_underscores_count(syma->name);
134 b = prefix_underscores_count(symb->name);
140 /* Choose the symbol with the longest name */
141 na = strlen(syma->name);
142 nb = strlen(symb->name);
148 return arch__choose_best_symbol(syma, symb);
151 void symbols__fixup_duplicate(struct rb_root *symbols)
154 struct symbol *curr, *next;
156 if (symbol_conf.allow_aliases)
159 nd = rb_first(symbols);
162 curr = rb_entry(nd, struct symbol, rb_node);
164 nd = rb_next(&curr->rb_node);
165 next = rb_entry(nd, struct symbol, rb_node);
170 if (curr->start != next->start)
173 if (choose_best_symbol(curr, next) == SYMBOL_A) {
174 rb_erase(&next->rb_node, symbols);
175 symbol__delete(next);
178 nd = rb_next(&curr->rb_node);
179 rb_erase(&curr->rb_node, symbols);
180 symbol__delete(curr);
185 void symbols__fixup_end(struct rb_root *symbols)
187 struct rb_node *nd, *prevnd = rb_first(symbols);
188 struct symbol *curr, *prev;
193 curr = rb_entry(prevnd, struct symbol, rb_node);
195 for (nd = rb_next(prevnd); nd; nd = rb_next(nd)) {
197 curr = rb_entry(nd, struct symbol, rb_node);
199 if (prev->end == prev->start && prev->end != curr->start)
200 prev->end = curr->start;
204 if (curr->end == curr->start)
205 curr->end = roundup(curr->start, 4096);
208 void __map_groups__fixup_end(struct map_groups *mg, enum map_type type)
210 struct maps *maps = &mg->maps[type];
211 struct map *next, *curr;
213 pthread_rwlock_wrlock(&maps->lock);
215 curr = maps__first(maps);
219 for (next = map__next(curr); next; next = map__next(curr)) {
220 curr->end = next->start;
225 * We still haven't the actual symbols, so guess the
226 * last map final address.
231 pthread_rwlock_unlock(&maps->lock);
234 struct symbol *symbol__new(u64 start, u64 len, u8 binding, const char *name)
236 size_t namelen = strlen(name) + 1;
237 struct symbol *sym = calloc(1, (symbol_conf.priv_size +
238 sizeof(*sym) + namelen));
242 if (symbol_conf.priv_size) {
243 if (symbol_conf.init_annotation) {
244 struct annotation *notes = (void *)sym;
245 pthread_mutex_init(¬es->lock, NULL);
247 sym = ((void *)sym) + symbol_conf.priv_size;
251 sym->end = len ? start + len : start;
252 sym->binding = binding;
253 sym->namelen = namelen - 1;
255 pr_debug4("%s: %s %#" PRIx64 "-%#" PRIx64 "\n",
256 __func__, name, start, sym->end);
257 memcpy(sym->name, name, namelen);
262 void symbol__delete(struct symbol *sym)
264 free(((void *)sym) - symbol_conf.priv_size);
267 void symbols__delete(struct rb_root *symbols)
270 struct rb_node *next = rb_first(symbols);
273 pos = rb_entry(next, struct symbol, rb_node);
274 next = rb_next(&pos->rb_node);
275 rb_erase(&pos->rb_node, symbols);
280 void __symbols__insert(struct rb_root *symbols, struct symbol *sym, bool kernel)
282 struct rb_node **p = &symbols->rb_node;
283 struct rb_node *parent = NULL;
284 const u64 ip = sym->start;
288 const char *name = sym->name;
290 * ppc64 uses function descriptors and appends a '.' to the
291 * start of every instruction address. Remove it.
295 sym->idle = symbol__is_idle(name);
300 s = rb_entry(parent, struct symbol, rb_node);
306 rb_link_node(&sym->rb_node, parent, p);
307 rb_insert_color(&sym->rb_node, symbols);
310 void symbols__insert(struct rb_root *symbols, struct symbol *sym)
312 __symbols__insert(symbols, sym, false);
315 static struct symbol *symbols__find(struct rb_root *symbols, u64 ip)
322 n = symbols->rb_node;
325 struct symbol *s = rb_entry(n, struct symbol, rb_node);
329 else if (ip > s->end || (ip == s->end && ip != s->start))
338 static struct symbol *symbols__first(struct rb_root *symbols)
340 struct rb_node *n = rb_first(symbols);
343 return rb_entry(n, struct symbol, rb_node);
348 static struct symbol *symbols__last(struct rb_root *symbols)
350 struct rb_node *n = rb_last(symbols);
353 return rb_entry(n, struct symbol, rb_node);
358 static struct symbol *symbols__next(struct symbol *sym)
360 struct rb_node *n = rb_next(&sym->rb_node);
363 return rb_entry(n, struct symbol, rb_node);
368 static void symbols__insert_by_name(struct rb_root *symbols, struct symbol *sym)
370 struct rb_node **p = &symbols->rb_node;
371 struct rb_node *parent = NULL;
372 struct symbol_name_rb_node *symn, *s;
374 symn = container_of(sym, struct symbol_name_rb_node, sym);
378 s = rb_entry(parent, struct symbol_name_rb_node, rb_node);
379 if (strcmp(sym->name, s->sym.name) < 0)
384 rb_link_node(&symn->rb_node, parent, p);
385 rb_insert_color(&symn->rb_node, symbols);
388 static void symbols__sort_by_name(struct rb_root *symbols,
389 struct rb_root *source)
393 for (nd = rb_first(source); nd; nd = rb_next(nd)) {
394 struct symbol *pos = rb_entry(nd, struct symbol, rb_node);
395 symbols__insert_by_name(symbols, pos);
399 static struct symbol *symbols__find_by_name(struct rb_root *symbols,
403 struct symbol_name_rb_node *s = NULL;
408 n = symbols->rb_node;
413 s = rb_entry(n, struct symbol_name_rb_node, rb_node);
414 cmp = arch__compare_symbol_names(name, s->sym.name);
427 /* return first symbol that has same name (if any) */
428 for (n = rb_prev(n); n; n = rb_prev(n)) {
429 struct symbol_name_rb_node *tmp;
431 tmp = rb_entry(n, struct symbol_name_rb_node, rb_node);
432 if (arch__compare_symbol_names(tmp->sym.name, s->sym.name))
441 void dso__reset_find_symbol_cache(struct dso *dso)
445 for (type = MAP__FUNCTION; type <= MAP__VARIABLE; ++type) {
446 dso->last_find_result[type].addr = 0;
447 dso->last_find_result[type].symbol = NULL;
451 void dso__insert_symbol(struct dso *dso, enum map_type type, struct symbol *sym)
453 __symbols__insert(&dso->symbols[type], sym, dso->kernel);
455 /* update the symbol cache if necessary */
456 if (dso->last_find_result[type].addr >= sym->start &&
457 (dso->last_find_result[type].addr < sym->end ||
458 sym->start == sym->end)) {
459 dso->last_find_result[type].symbol = sym;
463 struct symbol *dso__find_symbol(struct dso *dso,
464 enum map_type type, u64 addr)
466 if (dso->last_find_result[type].addr != addr) {
467 dso->last_find_result[type].addr = addr;
468 dso->last_find_result[type].symbol = symbols__find(&dso->symbols[type], addr);
471 return dso->last_find_result[type].symbol;
474 struct symbol *dso__first_symbol(struct dso *dso, enum map_type type)
476 return symbols__first(&dso->symbols[type]);
479 struct symbol *dso__last_symbol(struct dso *dso, enum map_type type)
481 return symbols__last(&dso->symbols[type]);
484 struct symbol *dso__next_symbol(struct symbol *sym)
486 return symbols__next(sym);
489 struct symbol *symbol__next_by_name(struct symbol *sym)
491 struct symbol_name_rb_node *s = container_of(sym, struct symbol_name_rb_node, sym);
492 struct rb_node *n = rb_next(&s->rb_node);
494 return n ? &rb_entry(n, struct symbol_name_rb_node, rb_node)->sym : NULL;
498 * Teturns first symbol that matched with @name.
500 struct symbol *dso__find_symbol_by_name(struct dso *dso, enum map_type type,
503 return symbols__find_by_name(&dso->symbol_names[type], name);
506 void dso__sort_by_name(struct dso *dso, enum map_type type)
508 dso__set_sorted_by_name(dso, type);
509 return symbols__sort_by_name(&dso->symbol_names[type],
510 &dso->symbols[type]);
513 int modules__parse(const char *filename, void *arg,
514 int (*process_module)(void *arg, const char *name,
522 file = fopen(filename, "r");
532 line_len = getline(&line, &n, file);
545 line[--line_len] = '\0'; /* \n */
547 sep = strrchr(line, 'x');
551 hex2u64(sep + 1, &start);
553 sep = strchr(line, ' ');
559 scnprintf(name, sizeof(name), "[%s]", line);
561 err = process_module(arg, name, start);
571 struct process_kallsyms_args {
577 * These are symbols in the kernel image, so make sure that
578 * sym is from a kernel DSO.
580 static bool symbol__is_idle(const char *name)
582 const char * const idle_symbols[] = {
591 "mwait_idle_with_hints",
593 "ppc64_runlatch_off",
594 "pseries_dedicated_idle_sleep",
599 for (i = 0; idle_symbols[i]; i++) {
600 if (!strcmp(idle_symbols[i], name))
607 static int map__process_kallsym_symbol(void *arg, const char *name,
608 char type, u64 start)
611 struct process_kallsyms_args *a = arg;
612 struct rb_root *root = &a->dso->symbols[a->map->type];
614 if (!symbol_type__is_a(type, a->map->type))
618 * module symbols are not sorted so we add all
619 * symbols, setting length to 0, and rely on
620 * symbols__fixup_end() to fix it up.
622 sym = symbol__new(start, 0, kallsyms2elf_binding(type), name);
626 * We will pass the symbols to the filter later, in
627 * map__split_kallsyms, when we have split the maps per module
629 __symbols__insert(root, sym, !strchr(name, '['));
635 * Loads the function entries in /proc/kallsyms into kernel_map->dso,
636 * so that we can in the next step set the symbol ->end address and then
637 * call kernel_maps__split_kallsyms.
639 static int dso__load_all_kallsyms(struct dso *dso, const char *filename,
642 struct process_kallsyms_args args = { .map = map, .dso = dso, };
643 return kallsyms__parse(filename, &args, map__process_kallsym_symbol);
646 static int dso__split_kallsyms_for_kcore(struct dso *dso, struct map *map)
648 struct map_groups *kmaps = map__kmaps(map);
649 struct map *curr_map;
652 struct rb_root old_root = dso->symbols[map->type];
653 struct rb_root *root = &dso->symbols[map->type];
654 struct rb_node *next = rb_first(root);
664 pos = rb_entry(next, struct symbol, rb_node);
665 next = rb_next(&pos->rb_node);
667 rb_erase_init(&pos->rb_node, &old_root);
669 module = strchr(pos->name, '\t');
673 curr_map = map_groups__find(kmaps, map->type, pos->start);
680 pos->start -= curr_map->start - curr_map->pgoff;
682 pos->end -= curr_map->start - curr_map->pgoff;
683 symbols__insert(&curr_map->dso->symbols[curr_map->type], pos);
687 /* Symbols have been adjusted */
688 dso->adjust_symbols = 1;
694 * Split the symbols into maps, making sure there are no overlaps, i.e. the
695 * kernel range is broken in several maps, named [kernel].N, as we don't have
696 * the original ELF section names vmlinux have.
698 static int dso__split_kallsyms(struct dso *dso, struct map *map, u64 delta)
700 struct map_groups *kmaps = map__kmaps(map);
701 struct machine *machine;
702 struct map *curr_map = map;
704 int count = 0, moved = 0;
705 struct rb_root *root = &dso->symbols[map->type];
706 struct rb_node *next = rb_first(root);
707 int kernel_range = 0;
712 machine = kmaps->machine;
717 pos = rb_entry(next, struct symbol, rb_node);
718 next = rb_next(&pos->rb_node);
720 module = strchr(pos->name, '\t');
722 if (!symbol_conf.use_modules)
727 if (strcmp(curr_map->dso->short_name, module)) {
728 if (curr_map != map &&
729 dso->kernel == DSO_TYPE_GUEST_KERNEL &&
730 machine__is_default_guest(machine)) {
732 * We assume all symbols of a module are
733 * continuous in * kallsyms, so curr_map
734 * points to a module and all its
735 * symbols are in its kmap. Mark it as
738 dso__set_loaded(curr_map->dso,
742 curr_map = map_groups__find_by_name(kmaps,
744 if (curr_map == NULL) {
745 pr_debug("%s/proc/{kallsyms,modules} "
746 "inconsistency while looking "
747 "for \"%s\" module!\n",
748 machine->root_dir, module);
753 if (curr_map->dso->loaded &&
754 !machine__is_default_guest(machine))
758 * So that we look just like we get from .ko files,
759 * i.e. not prelinked, relative to map->start.
761 pos->start = curr_map->map_ip(curr_map, pos->start);
762 pos->end = curr_map->map_ip(curr_map, pos->end);
763 } else if (curr_map != map) {
764 char dso_name[PATH_MAX];
768 /* Kernel was relocated at boot time */
778 if (dso->kernel == DSO_TYPE_GUEST_KERNEL)
779 snprintf(dso_name, sizeof(dso_name),
783 snprintf(dso_name, sizeof(dso_name),
787 ndso = dso__new(dso_name);
791 ndso->kernel = dso->kernel;
793 curr_map = map__new2(pos->start, ndso, map->type);
794 if (curr_map == NULL) {
799 curr_map->map_ip = curr_map->unmap_ip = identity__map_ip;
800 map_groups__insert(kmaps, curr_map);
803 /* Kernel was relocated at boot time */
808 if (curr_map != map) {
809 rb_erase(&pos->rb_node, root);
810 symbols__insert(&curr_map->dso->symbols[curr_map->type], pos);
817 rb_erase(&pos->rb_node, root);
821 if (curr_map != map &&
822 dso->kernel == DSO_TYPE_GUEST_KERNEL &&
823 machine__is_default_guest(kmaps->machine)) {
824 dso__set_loaded(curr_map->dso, curr_map->type);
827 return count + moved;
830 bool symbol__restricted_filename(const char *filename,
831 const char *restricted_filename)
833 bool restricted = false;
835 if (symbol_conf.kptr_restrict) {
836 char *r = realpath(filename, NULL);
839 restricted = strcmp(r, restricted_filename) == 0;
849 struct rb_node rb_node;
854 static void add_module(struct module_info *mi, struct rb_root *modules)
856 struct rb_node **p = &modules->rb_node;
857 struct rb_node *parent = NULL;
858 struct module_info *m;
862 m = rb_entry(parent, struct module_info, rb_node);
863 if (strcmp(mi->name, m->name) < 0)
868 rb_link_node(&mi->rb_node, parent, p);
869 rb_insert_color(&mi->rb_node, modules);
872 static void delete_modules(struct rb_root *modules)
874 struct module_info *mi;
875 struct rb_node *next = rb_first(modules);
878 mi = rb_entry(next, struct module_info, rb_node);
879 next = rb_next(&mi->rb_node);
880 rb_erase(&mi->rb_node, modules);
886 static struct module_info *find_module(const char *name,
887 struct rb_root *modules)
889 struct rb_node *n = modules->rb_node;
892 struct module_info *m;
895 m = rb_entry(n, struct module_info, rb_node);
896 cmp = strcmp(name, m->name);
908 static int __read_proc_modules(void *arg, const char *name, u64 start)
910 struct rb_root *modules = arg;
911 struct module_info *mi;
913 mi = zalloc(sizeof(struct module_info));
917 mi->name = strdup(name);
925 add_module(mi, modules);
930 static int read_proc_modules(const char *filename, struct rb_root *modules)
932 if (symbol__restricted_filename(filename, "/proc/modules"))
935 if (modules__parse(filename, modules, __read_proc_modules)) {
936 delete_modules(modules);
943 int compare_proc_modules(const char *from, const char *to)
945 struct rb_root from_modules = RB_ROOT;
946 struct rb_root to_modules = RB_ROOT;
947 struct rb_node *from_node, *to_node;
948 struct module_info *from_m, *to_m;
951 if (read_proc_modules(from, &from_modules))
954 if (read_proc_modules(to, &to_modules))
955 goto out_delete_from;
957 from_node = rb_first(&from_modules);
958 to_node = rb_first(&to_modules);
963 from_m = rb_entry(from_node, struct module_info, rb_node);
964 to_m = rb_entry(to_node, struct module_info, rb_node);
966 if (from_m->start != to_m->start ||
967 strcmp(from_m->name, to_m->name))
970 from_node = rb_next(from_node);
971 to_node = rb_next(to_node);
974 if (!from_node && !to_node)
977 delete_modules(&to_modules);
979 delete_modules(&from_modules);
984 static int do_validate_kcore_modules(const char *filename, struct map *map,
985 struct map_groups *kmaps)
987 struct rb_root modules = RB_ROOT;
991 err = read_proc_modules(filename, &modules);
995 old_map = map_groups__first(kmaps, map->type);
997 struct map *next = map_groups__next(old_map);
998 struct module_info *mi;
1000 if (old_map == map || old_map->start == map->start) {
1001 /* The kernel map */
1006 /* Module must be in memory at the same address */
1007 mi = find_module(old_map->dso->short_name, &modules);
1008 if (!mi || mi->start != old_map->start) {
1016 delete_modules(&modules);
1021 * If kallsyms is referenced by name then we look for filename in the same
1024 static bool filename_from_kallsyms_filename(char *filename,
1025 const char *base_name,
1026 const char *kallsyms_filename)
1030 strcpy(filename, kallsyms_filename);
1031 name = strrchr(filename, '/');
1037 if (!strcmp(name, "kallsyms")) {
1038 strcpy(name, base_name);
1045 static int validate_kcore_modules(const char *kallsyms_filename,
1048 struct map_groups *kmaps = map__kmaps(map);
1049 char modules_filename[PATH_MAX];
1054 if (!filename_from_kallsyms_filename(modules_filename, "modules",
1058 if (do_validate_kcore_modules(modules_filename, map, kmaps))
1064 static int validate_kcore_addresses(const char *kallsyms_filename,
1067 struct kmap *kmap = map__kmap(map);
1072 if (kmap->ref_reloc_sym && kmap->ref_reloc_sym->name) {
1075 start = kallsyms__get_function_start(kallsyms_filename,
1076 kmap->ref_reloc_sym->name);
1077 if (start != kmap->ref_reloc_sym->addr)
1081 return validate_kcore_modules(kallsyms_filename, map);
1084 struct kcore_mapfn_data {
1087 struct list_head maps;
1090 static int kcore_mapfn(u64 start, u64 len, u64 pgoff, void *data)
1092 struct kcore_mapfn_data *md = data;
1095 map = map__new2(start, md->dso, md->type);
1099 map->end = map->start + len;
1102 list_add(&map->node, &md->maps);
1107 static int dso__load_kcore(struct dso *dso, struct map *map,
1108 const char *kallsyms_filename)
1110 struct map_groups *kmaps = map__kmaps(map);
1111 struct machine *machine;
1112 struct kcore_mapfn_data md;
1113 struct map *old_map, *new_map, *replacement_map = NULL;
1116 char kcore_filename[PATH_MAX];
1122 machine = kmaps->machine;
1124 /* This function requires that the map is the kernel map */
1125 if (map != machine->vmlinux_maps[map->type])
1128 if (!filename_from_kallsyms_filename(kcore_filename, "kcore",
1132 /* Modules and kernel must be present at their original addresses */
1133 if (validate_kcore_addresses(kallsyms_filename, map))
1137 md.type = map->type;
1138 INIT_LIST_HEAD(&md.maps);
1140 fd = open(kcore_filename, O_RDONLY);
1142 pr_debug("Failed to open %s. Note /proc/kcore requires CAP_SYS_RAWIO capability to access.\n",
1147 /* Read new maps into temporary lists */
1148 err = file__read_maps(fd, md.type == MAP__FUNCTION, kcore_mapfn, &md,
1152 dso->is_64_bit = is_64_bit;
1154 if (list_empty(&md.maps)) {
1159 /* Remove old maps */
1160 old_map = map_groups__first(kmaps, map->type);
1162 struct map *next = map_groups__next(old_map);
1165 map_groups__remove(kmaps, old_map);
1169 /* Find the kernel map using the first symbol */
1170 sym = dso__first_symbol(dso, map->type);
1171 list_for_each_entry(new_map, &md.maps, node) {
1172 if (sym && sym->start >= new_map->start &&
1173 sym->start < new_map->end) {
1174 replacement_map = new_map;
1179 if (!replacement_map)
1180 replacement_map = list_entry(md.maps.next, struct map, node);
1183 while (!list_empty(&md.maps)) {
1184 new_map = list_entry(md.maps.next, struct map, node);
1185 list_del_init(&new_map->node);
1186 if (new_map == replacement_map) {
1187 map->start = new_map->start;
1188 map->end = new_map->end;
1189 map->pgoff = new_map->pgoff;
1190 map->map_ip = new_map->map_ip;
1191 map->unmap_ip = new_map->unmap_ip;
1192 /* Ensure maps are correctly ordered */
1194 map_groups__remove(kmaps, map);
1195 map_groups__insert(kmaps, map);
1198 map_groups__insert(kmaps, new_map);
1205 * Set the data type and long name so that kcore can be read via
1206 * dso__data_read_addr().
1208 if (dso->kernel == DSO_TYPE_GUEST_KERNEL)
1209 dso->binary_type = DSO_BINARY_TYPE__GUEST_KCORE;
1211 dso->binary_type = DSO_BINARY_TYPE__KCORE;
1212 dso__set_long_name(dso, strdup(kcore_filename), true);
1216 if (map->type == MAP__FUNCTION)
1217 pr_debug("Using %s for kernel object code\n", kcore_filename);
1219 pr_debug("Using %s for kernel data\n", kcore_filename);
1224 while (!list_empty(&md.maps)) {
1225 map = list_entry(md.maps.next, struct map, node);
1226 list_del_init(&map->node);
1234 * If the kernel is relocated at boot time, kallsyms won't match. Compute the
1235 * delta based on the relocation reference symbol.
1237 static int kallsyms__delta(struct map *map, const char *filename, u64 *delta)
1239 struct kmap *kmap = map__kmap(map);
1245 if (!kmap->ref_reloc_sym || !kmap->ref_reloc_sym->name)
1248 addr = kallsyms__get_function_start(filename,
1249 kmap->ref_reloc_sym->name);
1253 *delta = addr - kmap->ref_reloc_sym->addr;
1257 int __dso__load_kallsyms(struct dso *dso, const char *filename,
1258 struct map *map, bool no_kcore)
1262 if (symbol__restricted_filename(filename, "/proc/kallsyms"))
1265 if (dso__load_all_kallsyms(dso, filename, map) < 0)
1268 if (kallsyms__delta(map, filename, &delta))
1271 symbols__fixup_end(&dso->symbols[map->type]);
1272 symbols__fixup_duplicate(&dso->symbols[map->type]);
1274 if (dso->kernel == DSO_TYPE_GUEST_KERNEL)
1275 dso->symtab_type = DSO_BINARY_TYPE__GUEST_KALLSYMS;
1277 dso->symtab_type = DSO_BINARY_TYPE__KALLSYMS;
1279 if (!no_kcore && !dso__load_kcore(dso, map, filename))
1280 return dso__split_kallsyms_for_kcore(dso, map);
1282 return dso__split_kallsyms(dso, map, delta);
1285 int dso__load_kallsyms(struct dso *dso, const char *filename,
1288 return __dso__load_kallsyms(dso, filename, map, false);
1291 static int dso__load_perf_map(struct dso *dso, struct map *map)
1298 file = fopen(dso->long_name, "r");
1302 while (!feof(file)) {
1307 line_len = getline(&line, &n, file);
1314 line[--line_len] = '\0'; /* \n */
1316 len = hex2u64(line, &start);
1319 if (len + 2 >= line_len)
1322 len += hex2u64(line + len, &size);
1325 if (len + 2 >= line_len)
1328 sym = symbol__new(start, size, STB_GLOBAL, line + len);
1331 goto out_delete_line;
1333 symbols__insert(&dso->symbols[map->type], sym);
1348 static bool dso__is_compatible_symtab_type(struct dso *dso, bool kmod,
1349 enum dso_binary_type type)
1352 case DSO_BINARY_TYPE__JAVA_JIT:
1353 case DSO_BINARY_TYPE__DEBUGLINK:
1354 case DSO_BINARY_TYPE__SYSTEM_PATH_DSO:
1355 case DSO_BINARY_TYPE__FEDORA_DEBUGINFO:
1356 case DSO_BINARY_TYPE__UBUNTU_DEBUGINFO:
1357 case DSO_BINARY_TYPE__BUILDID_DEBUGINFO:
1358 case DSO_BINARY_TYPE__OPENEMBEDDED_DEBUGINFO:
1359 return !kmod && dso->kernel == DSO_TYPE_USER;
1361 case DSO_BINARY_TYPE__KALLSYMS:
1362 case DSO_BINARY_TYPE__VMLINUX:
1363 case DSO_BINARY_TYPE__KCORE:
1364 return dso->kernel == DSO_TYPE_KERNEL;
1366 case DSO_BINARY_TYPE__GUEST_KALLSYMS:
1367 case DSO_BINARY_TYPE__GUEST_VMLINUX:
1368 case DSO_BINARY_TYPE__GUEST_KCORE:
1369 return dso->kernel == DSO_TYPE_GUEST_KERNEL;
1371 case DSO_BINARY_TYPE__GUEST_KMODULE:
1372 case DSO_BINARY_TYPE__GUEST_KMODULE_COMP:
1373 case DSO_BINARY_TYPE__SYSTEM_PATH_KMODULE:
1374 case DSO_BINARY_TYPE__SYSTEM_PATH_KMODULE_COMP:
1376 * kernel modules know their symtab type - it's set when
1377 * creating a module dso in machine__findnew_module_map().
1379 return kmod && dso->symtab_type == type;
1381 case DSO_BINARY_TYPE__BUILD_ID_CACHE:
1384 case DSO_BINARY_TYPE__NOT_FOUND:
1390 int dso__load(struct dso *dso, struct map *map)
1395 struct machine *machine;
1396 char *root_dir = (char *) "";
1398 struct symsrc ss_[2];
1399 struct symsrc *syms_ss = NULL, *runtime_ss = NULL;
1401 unsigned char build_id[BUILD_ID_SIZE];
1403 pthread_mutex_lock(&dso->lock);
1405 /* check again under the dso->lock */
1406 if (dso__loaded(dso, map->type)) {
1412 if (dso->kernel == DSO_TYPE_KERNEL)
1413 ret = dso__load_kernel_sym(dso, map);
1414 else if (dso->kernel == DSO_TYPE_GUEST_KERNEL)
1415 ret = dso__load_guest_kernel_sym(dso, map);
1420 if (map->groups && map->groups->machine)
1421 machine = map->groups->machine;
1425 dso->adjust_symbols = 0;
1427 if (strncmp(dso->name, "/tmp/perf-", 10) == 0) {
1430 if (lstat(dso->name, &st) < 0)
1433 if (!symbol_conf.force && st.st_uid && (st.st_uid != geteuid())) {
1434 pr_warning("File %s not owned by current user or root, "
1435 "ignoring it (use -f to override).\n", dso->name);
1439 ret = dso__load_perf_map(dso, map);
1440 dso->symtab_type = ret > 0 ? DSO_BINARY_TYPE__JAVA_JIT :
1441 DSO_BINARY_TYPE__NOT_FOUND;
1446 root_dir = machine->root_dir;
1448 name = malloc(PATH_MAX);
1452 kmod = dso->symtab_type == DSO_BINARY_TYPE__SYSTEM_PATH_KMODULE ||
1453 dso->symtab_type == DSO_BINARY_TYPE__SYSTEM_PATH_KMODULE_COMP ||
1454 dso->symtab_type == DSO_BINARY_TYPE__GUEST_KMODULE ||
1455 dso->symtab_type == DSO_BINARY_TYPE__GUEST_KMODULE_COMP;
1459 * Read the build id if possible. This is required for
1460 * DSO_BINARY_TYPE__BUILDID_DEBUGINFO to work
1462 if (is_regular_file(dso->long_name) &&
1463 filename__read_build_id(dso->long_name, build_id, BUILD_ID_SIZE) > 0)
1464 dso__set_build_id(dso, build_id);
1467 * Iterate over candidate debug images.
1468 * Keep track of "interesting" ones (those which have a symtab, dynsym,
1469 * and/or opd section) for processing.
1471 for (i = 0; i < DSO_BINARY_TYPE__SYMTAB_CNT; i++) {
1472 struct symsrc *ss = &ss_[ss_pos];
1473 bool next_slot = false;
1475 enum dso_binary_type symtab_type = binary_type_symtab[i];
1477 if (!dso__is_compatible_symtab_type(dso, kmod, symtab_type))
1480 if (dso__read_binary_type_filename(dso, symtab_type,
1481 root_dir, name, PATH_MAX))
1484 if (!is_regular_file(name))
1487 /* Name is now the name of the next image to try */
1488 if (symsrc__init(ss, dso, name, symtab_type) < 0)
1491 if (!syms_ss && symsrc__has_symtab(ss)) {
1494 if (!dso->symsrc_filename)
1495 dso->symsrc_filename = strdup(name);
1498 if (!runtime_ss && symsrc__possibly_runtime(ss)) {
1506 if (syms_ss && runtime_ss)
1509 symsrc__destroy(ss);
1514 if (!runtime_ss && !syms_ss)
1517 if (runtime_ss && !syms_ss) {
1518 syms_ss = runtime_ss;
1521 /* We'll have to hope for the best */
1522 if (!runtime_ss && syms_ss)
1523 runtime_ss = syms_ss;
1525 if (syms_ss && syms_ss->type == DSO_BINARY_TYPE__BUILD_ID_CACHE)
1526 if (dso__build_id_is_kmod(dso, name, PATH_MAX))
1530 ret = dso__load_sym(dso, map, syms_ss, runtime_ss, kmod);
1537 nr_plt = dso__synthesize_plt_symbols(dso, runtime_ss, map);
1542 for (; ss_pos > 0; ss_pos--)
1543 symsrc__destroy(&ss_[ss_pos - 1]);
1546 if (ret < 0 && strstr(dso->name, " (deleted)") != NULL)
1549 dso__set_loaded(dso, map->type);
1550 pthread_mutex_unlock(&dso->lock);
1555 struct map *map_groups__find_by_name(struct map_groups *mg,
1556 enum map_type type, const char *name)
1558 struct maps *maps = &mg->maps[type];
1561 pthread_rwlock_rdlock(&maps->lock);
1563 for (map = maps__first(maps); map; map = map__next(map)) {
1564 if (map->dso && strcmp(map->dso->short_name, name) == 0)
1571 pthread_rwlock_unlock(&maps->lock);
1575 int dso__load_vmlinux(struct dso *dso, struct map *map,
1576 const char *vmlinux, bool vmlinux_allocated)
1580 char symfs_vmlinux[PATH_MAX];
1581 enum dso_binary_type symtab_type;
1583 if (vmlinux[0] == '/')
1584 snprintf(symfs_vmlinux, sizeof(symfs_vmlinux), "%s", vmlinux);
1586 symbol__join_symfs(symfs_vmlinux, vmlinux);
1588 if (dso->kernel == DSO_TYPE_GUEST_KERNEL)
1589 symtab_type = DSO_BINARY_TYPE__GUEST_VMLINUX;
1591 symtab_type = DSO_BINARY_TYPE__VMLINUX;
1593 if (symsrc__init(&ss, dso, symfs_vmlinux, symtab_type))
1596 err = dso__load_sym(dso, map, &ss, &ss, 0);
1597 symsrc__destroy(&ss);
1600 if (dso->kernel == DSO_TYPE_GUEST_KERNEL)
1601 dso->binary_type = DSO_BINARY_TYPE__GUEST_VMLINUX;
1603 dso->binary_type = DSO_BINARY_TYPE__VMLINUX;
1604 dso__set_long_name(dso, vmlinux, vmlinux_allocated);
1605 dso__set_loaded(dso, map->type);
1606 pr_debug("Using %s for symbols\n", symfs_vmlinux);
1612 int dso__load_vmlinux_path(struct dso *dso, struct map *map)
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);
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);
1638 static bool visible_dir_filter(const char *name, struct dirent *d)
1640 if (d->d_type != DT_DIR)
1642 return lsdir_no_dot_filter(name, d);
1645 static int find_matching_kcore(struct map *map, char *dir, size_t dir_sz)
1647 char kallsyms_filename[PATH_MAX];
1649 struct strlist *dirs;
1650 struct str_node *nd;
1652 dirs = lsdir(dir, visible_dir_filter);
1656 strlist__for_each_entry(nd, dirs) {
1657 scnprintf(kallsyms_filename, sizeof(kallsyms_filename),
1658 "%s/%s/kallsyms", dir, nd->s);
1659 if (!validate_kcore_addresses(kallsyms_filename, map)) {
1660 strlcpy(dir, kallsyms_filename, dir_sz);
1666 strlist__delete(dirs);
1672 * Use open(O_RDONLY) to check readability directly instead of access(R_OK)
1673 * since access(R_OK) only checks with real UID/GID but open() use effective
1674 * UID/GID and actual capabilities (e.g. /proc/kcore requires CAP_SYS_RAWIO).
1676 static bool filename__readable(const char *file)
1678 int fd = open(file, O_RDONLY);
1685 static char *dso__find_kallsyms(struct dso *dso, struct map *map)
1687 u8 host_build_id[BUILD_ID_SIZE];
1688 char sbuild_id[SBUILD_ID_SIZE];
1689 bool is_host = false;
1690 char path[PATH_MAX];
1692 if (!dso->has_build_id) {
1694 * Last resort, if we don't have a build-id and couldn't find
1695 * any vmlinux file, try the running kernel kallsyms table.
1700 if (sysfs__read_build_id("/sys/kernel/notes", host_build_id,
1701 sizeof(host_build_id)) == 0)
1702 is_host = dso__build_id_equal(dso, host_build_id);
1704 /* Try a fast path for /proc/kallsyms if possible */
1707 * Do not check the build-id cache, unless we know we cannot use
1708 * /proc/kcore or module maps don't match to /proc/kallsyms.
1709 * To check readability of /proc/kcore, do not use access(R_OK)
1710 * since /proc/kcore requires CAP_SYS_RAWIO to read and access
1713 if (filename__readable("/proc/kcore") &&
1714 !validate_kcore_addresses("/proc/kallsyms", map))
1718 build_id__sprintf(dso->build_id, sizeof(dso->build_id), sbuild_id);
1720 /* Find kallsyms in build-id cache with kcore */
1721 scnprintf(path, sizeof(path), "%s/%s/%s",
1722 buildid_dir, DSO__NAME_KCORE, sbuild_id);
1724 if (!find_matching_kcore(map, path, sizeof(path)))
1725 return strdup(path);
1727 /* Use current /proc/kallsyms if possible */
1730 return strdup("/proc/kallsyms");
1733 /* Finally, find a cache of kallsyms */
1734 if (!build_id_cache__kallsyms_path(sbuild_id, path, sizeof(path))) {
1735 pr_err("No kallsyms or vmlinux with build-id %s was found\n",
1740 return strdup(path);
1743 static int dso__load_kernel_sym(struct dso *dso, struct map *map)
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, false);
1772 if (!symbol_conf.ignore_vmlinux && vmlinux_path != NULL) {
1773 err = dso__load_vmlinux_path(dso, map);
1778 /* do not try local files if a symfs was given */
1779 if (symbol_conf.symfs[0] != 0)
1782 kallsyms_allocated_filename = dso__find_kallsyms(dso, map);
1783 if (!kallsyms_allocated_filename)
1786 kallsyms_filename = kallsyms_allocated_filename;
1789 err = dso__load_kallsyms(dso, kallsyms_filename, map);
1791 pr_debug("Using %s for symbols\n", kallsyms_filename);
1792 free(kallsyms_allocated_filename);
1794 if (err > 0 && !dso__is_kcore(dso)) {
1795 dso->binary_type = DSO_BINARY_TYPE__KALLSYMS;
1796 dso__set_long_name(dso, DSO__NAME_KALLSYMS, false);
1797 map__fixup_start(map);
1798 map__fixup_end(map);
1804 static int dso__load_guest_kernel_sym(struct dso *dso, struct map *map)
1807 const char *kallsyms_filename = NULL;
1808 struct machine *machine;
1809 char path[PATH_MAX];
1812 pr_debug("Guest kernel map hasn't the point to groups\n");
1815 machine = map->groups->machine;
1817 if (machine__is_default_guest(machine)) {
1819 * if the user specified a vmlinux filename, use it and only
1820 * it, reporting errors to the user if it cannot be used.
1821 * Or use file guest_kallsyms inputted by user on commandline
1823 if (symbol_conf.default_guest_vmlinux_name != NULL) {
1824 err = dso__load_vmlinux(dso, map,
1825 symbol_conf.default_guest_vmlinux_name,
1830 kallsyms_filename = symbol_conf.default_guest_kallsyms;
1831 if (!kallsyms_filename)
1834 sprintf(path, "%s/proc/kallsyms", machine->root_dir);
1835 kallsyms_filename = path;
1838 err = dso__load_kallsyms(dso, kallsyms_filename, map);
1840 pr_debug("Using %s for symbols\n", kallsyms_filename);
1841 if (err > 0 && !dso__is_kcore(dso)) {
1842 dso->binary_type = DSO_BINARY_TYPE__GUEST_KALLSYMS;
1843 machine__mmap_name(machine, path, sizeof(path));
1844 dso__set_long_name(dso, strdup(path), true);
1845 map__fixup_start(map);
1846 map__fixup_end(map);
1852 static void vmlinux_path__exit(void)
1854 while (--vmlinux_path__nr_entries >= 0)
1855 zfree(&vmlinux_path[vmlinux_path__nr_entries]);
1856 vmlinux_path__nr_entries = 0;
1858 zfree(&vmlinux_path);
1861 static const char * const vmlinux_paths[] = {
1866 static const char * const vmlinux_paths_upd[] = {
1868 "/usr/lib/debug/boot/vmlinux-%s",
1869 "/lib/modules/%s/build/vmlinux",
1870 "/usr/lib/debug/lib/modules/%s/vmlinux",
1871 "/usr/lib/debug/boot/vmlinux-%s.debug"
1874 static int vmlinux_path__add(const char *new_entry)
1876 vmlinux_path[vmlinux_path__nr_entries] = strdup(new_entry);
1877 if (vmlinux_path[vmlinux_path__nr_entries] == NULL)
1879 ++vmlinux_path__nr_entries;
1884 static int vmlinux_path__init(struct perf_env *env)
1888 char *kernel_version;
1891 vmlinux_path = malloc(sizeof(char *) * (ARRAY_SIZE(vmlinux_paths) +
1892 ARRAY_SIZE(vmlinux_paths_upd)));
1893 if (vmlinux_path == NULL)
1896 for (i = 0; i < ARRAY_SIZE(vmlinux_paths); i++)
1897 if (vmlinux_path__add(vmlinux_paths[i]) < 0)
1900 /* only try kernel version if no symfs was given */
1901 if (symbol_conf.symfs[0] != 0)
1905 kernel_version = env->os_release;
1907 if (uname(&uts) < 0)
1910 kernel_version = uts.release;
1913 for (i = 0; i < ARRAY_SIZE(vmlinux_paths_upd); i++) {
1914 snprintf(bf, sizeof(bf), vmlinux_paths_upd[i], kernel_version);
1915 if (vmlinux_path__add(bf) < 0)
1922 vmlinux_path__exit();
1926 int setup_list(struct strlist **list, const char *list_str,
1927 const char *list_name)
1929 if (list_str == NULL)
1932 *list = strlist__new(list_str, NULL);
1934 pr_err("problems parsing %s list\n", list_name);
1938 symbol_conf.has_filter = true;
1942 int setup_intlist(struct intlist **list, const char *list_str,
1943 const char *list_name)
1945 if (list_str == NULL)
1948 *list = intlist__new(list_str);
1950 pr_err("problems parsing %s list\n", list_name);
1956 static bool symbol__read_kptr_restrict(void)
1959 FILE *fp = fopen("/proc/sys/kernel/kptr_restrict", "r");
1964 if (fgets(line, sizeof(line), fp) != NULL)
1965 value = (geteuid() != 0) ?
1975 int symbol__annotation_init(void)
1977 if (symbol_conf.initialized) {
1978 pr_err("Annotation needs to be init before symbol__init()\n");
1982 if (symbol_conf.init_annotation) {
1983 pr_warning("Annotation being initialized multiple times\n");
1987 symbol_conf.priv_size += sizeof(struct annotation);
1988 symbol_conf.init_annotation = true;
1992 int symbol__init(struct perf_env *env)
1996 if (symbol_conf.initialized)
1999 symbol_conf.priv_size = PERF_ALIGN(symbol_conf.priv_size, sizeof(u64));
2003 if (symbol_conf.sort_by_name)
2004 symbol_conf.priv_size += (sizeof(struct symbol_name_rb_node) -
2005 sizeof(struct symbol));
2007 if (symbol_conf.try_vmlinux_path && vmlinux_path__init(env) < 0)
2010 if (symbol_conf.field_sep && *symbol_conf.field_sep == '.') {
2011 pr_err("'.' is the only non valid --field-separator argument\n");
2015 if (setup_list(&symbol_conf.dso_list,
2016 symbol_conf.dso_list_str, "dso") < 0)
2019 if (setup_list(&symbol_conf.comm_list,
2020 symbol_conf.comm_list_str, "comm") < 0)
2021 goto out_free_dso_list;
2023 if (setup_intlist(&symbol_conf.pid_list,
2024 symbol_conf.pid_list_str, "pid") < 0)
2025 goto out_free_comm_list;
2027 if (setup_intlist(&symbol_conf.tid_list,
2028 symbol_conf.tid_list_str, "tid") < 0)
2029 goto out_free_pid_list;
2031 if (setup_list(&symbol_conf.sym_list,
2032 symbol_conf.sym_list_str, "symbol") < 0)
2033 goto out_free_tid_list;
2036 * A path to symbols of "/" is identical to ""
2037 * reset here for simplicity.
2039 symfs = realpath(symbol_conf.symfs, NULL);
2041 symfs = symbol_conf.symfs;
2042 if (strcmp(symfs, "/") == 0)
2043 symbol_conf.symfs = "";
2044 if (symfs != symbol_conf.symfs)
2045 free((void *)symfs);
2047 symbol_conf.kptr_restrict = symbol__read_kptr_restrict();
2049 symbol_conf.initialized = true;
2053 intlist__delete(symbol_conf.tid_list);
2055 intlist__delete(symbol_conf.pid_list);
2057 strlist__delete(symbol_conf.comm_list);
2059 strlist__delete(symbol_conf.dso_list);
2063 void symbol__exit(void)
2065 if (!symbol_conf.initialized)
2067 strlist__delete(symbol_conf.sym_list);
2068 strlist__delete(symbol_conf.dso_list);
2069 strlist__delete(symbol_conf.comm_list);
2070 intlist__delete(symbol_conf.tid_list);
2071 intlist__delete(symbol_conf.pid_list);
2072 vmlinux_path__exit();
2073 symbol_conf.sym_list = symbol_conf.dso_list = symbol_conf.comm_list = NULL;
2074 symbol_conf.initialized = false;
2077 int symbol__config_symfs(const struct option *opt __maybe_unused,
2078 const char *dir, int unset __maybe_unused)
2083 symbol_conf.symfs = strdup(dir);
2084 if (symbol_conf.symfs == NULL)
2087 /* skip the locally configured cache if a symfs is given, and
2088 * config buildid dir to symfs/.debug
2090 ret = asprintf(&bf, "%s/%s", dir, ".debug");
2094 set_buildid_dir(bf);