1 // SPDX-License-Identifier: GPL-2.0
11 #include <uapi/linux/mman.h> /* To get things like MAP_HUGETLB even on older libc headers */
14 #include "map_symbol.h"
20 #include <linux/string.h>
21 #include <linux/zalloc.h>
23 #include "namespaces.h"
28 static void __maps__insert(struct maps *maps, struct map *map);
29 static void __maps__insert_name(struct maps *maps, struct map *map);
31 static inline int is_anon_memory(const char *filename, u32 flags)
33 return flags & MAP_HUGETLB ||
34 !strcmp(filename, "//anon") ||
35 !strncmp(filename, "/dev/zero", sizeof("/dev/zero") - 1) ||
36 !strncmp(filename, "/anon_hugepage", sizeof("/anon_hugepage") - 1);
39 static inline int is_no_dso_memory(const char *filename)
41 return !strncmp(filename, "[stack", 6) ||
42 !strncmp(filename, "/SYSV",5) ||
43 !strcmp(filename, "[heap]");
46 static inline int is_android_lib(const char *filename)
48 return !strncmp(filename, "/data/app-lib", 13) ||
49 !strncmp(filename, "/system/lib", 11);
52 static inline bool replace_android_lib(const char *filename, char *newfilename)
56 size_t app_abi_length, new_length;
57 size_t lib_length = 0;
59 libname = strrchr(filename, '/');
61 lib_length = strlen(libname);
63 app_abi = getenv("APP_ABI");
67 app_abi_length = strlen(app_abi);
69 if (!strncmp(filename, "/data/app-lib", 13)) {
75 new_length = 7 + app_abi_length + lib_length;
77 apk_path = getenv("APK_PATH");
79 new_length += strlen(apk_path) + 1;
80 if (new_length > PATH_MAX)
82 snprintf(newfilename, new_length,
83 "%s/libs/%s/%s", apk_path, app_abi, libname);
85 if (new_length > PATH_MAX)
87 snprintf(newfilename, new_length,
88 "libs/%s/%s", app_abi, libname);
93 if (!strncmp(filename, "/system/lib/", 11)) {
99 ndk = getenv("NDK_ROOT");
100 app = getenv("APP_PLATFORM");
105 ndk_length = strlen(ndk);
106 app_length = strlen(app);
108 if (!(ndk_length && app_length && app_abi_length))
111 arch = !strncmp(app_abi, "arm", 3) ? "arm" :
112 !strncmp(app_abi, "mips", 4) ? "mips" :
113 !strncmp(app_abi, "x86", 3) ? "x86" : NULL;
118 new_length = 27 + ndk_length +
119 app_length + lib_length
122 if (new_length > PATH_MAX)
124 snprintf(newfilename, new_length,
125 "%s/platforms/%s/arch-%s/usr/lib/%s",
126 ndk, app, arch, libname);
133 void map__init(struct map *map, u64 start, u64 end, u64 pgoff, struct dso *dso)
139 map->dso = dso__get(dso);
140 map->map_ip = map__map_ip;
141 map->unmap_ip = map__unmap_ip;
142 RB_CLEAR_NODE(&map->rb_node);
144 map->erange_warned = false;
145 refcount_set(&map->refcnt, 1);
148 struct map *map__new(struct machine *machine, u64 start, u64 len,
149 u64 pgoff, u32 d_maj, u32 d_min, u64 ino,
150 u64 ino_gen, u32 prot, u32 flags, char *filename,
151 struct thread *thread)
153 struct map *map = malloc(sizeof(*map));
154 struct nsinfo *nsi = NULL;
158 char newfilename[PATH_MAX];
160 int anon, no_dso, vdso, android;
162 android = is_android_lib(filename);
163 anon = is_anon_memory(filename, flags);
164 vdso = is_vdso_map(filename);
165 no_dso = is_no_dso_memory(filename);
170 map->ino_generation = ino_gen;
173 nsi = nsinfo__get(thread->nsinfo);
175 if ((anon || no_dso) && nsi && (prot & PROT_EXEC)) {
176 snprintf(newfilename, sizeof(newfilename),
177 "/tmp/perf-%d.map", nsi->pid);
178 filename = newfilename;
182 if (replace_android_lib(filename, newfilename))
183 filename = newfilename;
187 /* The vdso maps are always on the host and not the
188 * container. Ensure that we don't use setns to look
191 nnsi = nsinfo__copy(nsi);
194 nnsi->need_setns = false;
198 dso = machine__findnew_vdso(machine, thread);
200 dso = machine__findnew_dso(machine, filename);
205 map__init(map, start, start + len, pgoff, dso);
207 if (anon || no_dso) {
208 map->map_ip = map->unmap_ip = identity__map_ip;
211 * Set memory without DSO as loaded. All map__find_*
212 * functions still return NULL, and we avoid the
213 * unnecessary map__load warning.
215 if (!(prot & PROT_EXEC))
216 dso__set_loaded(dso);
229 * Constructor variant for modules (where we know from /proc/modules where
230 * they are loaded) and for vmlinux, where only after we load all the
231 * symbols we'll know where it starts and ends.
233 struct map *map__new2(u64 start, struct dso *dso)
235 struct map *map = calloc(1, (sizeof(*map) +
236 (dso->kernel ? sizeof(struct kmap) : 0)));
239 * ->end will be filled after we load all the symbols
241 map__init(map, start, 0, 0, dso);
248 * Use this and __map__is_kmodule() for map instances that are in
249 * machine->kmaps, and thus have map->groups->machine all properly set, to
250 * disambiguate between the kernel and modules.
252 * When the need arises, introduce map__is_{kernel,kmodule)() that
253 * checks (map->groups != NULL && map->groups->machine != NULL &&
254 * map->dso->kernel) before calling __map__is_{kernel,kmodule}())
256 bool __map__is_kernel(const struct map *map)
258 return machine__kernel_map(map->groups->machine) == map;
261 bool __map__is_extra_kernel_map(const struct map *map)
263 struct kmap *kmap = __map__kmap((struct map *)map);
265 return kmap && kmap->name[0];
268 bool __map__is_bpf_prog(const struct map *map)
272 if (map->dso->binary_type == DSO_BINARY_TYPE__BPF_PROG_INFO)
276 * If PERF_RECORD_BPF_EVENT is not included, the dso will not have
277 * type of DSO_BINARY_TYPE__BPF_PROG_INFO. In such cases, we can
278 * guess the type based on name.
280 name = map->dso->short_name;
281 return name && (strstr(name, "bpf_prog_") == name);
284 bool map__has_symbols(const struct map *map)
286 return dso__has_symbols(map->dso);
289 static void map__exit(struct map *map)
291 BUG_ON(!RB_EMPTY_NODE(&map->rb_node));
295 void map__delete(struct map *map)
301 void map__put(struct map *map)
303 if (map && refcount_dec_and_test(&map->refcnt))
307 void map__fixup_start(struct map *map)
309 struct rb_root_cached *symbols = &map->dso->symbols;
310 struct rb_node *nd = rb_first_cached(symbols);
312 struct symbol *sym = rb_entry(nd, struct symbol, rb_node);
313 map->start = sym->start;
317 void map__fixup_end(struct map *map)
319 struct rb_root_cached *symbols = &map->dso->symbols;
320 struct rb_node *nd = rb_last(&symbols->rb_root);
322 struct symbol *sym = rb_entry(nd, struct symbol, rb_node);
327 #define DSO__DELETED "(deleted)"
329 int map__load(struct map *map)
331 const char *name = map->dso->long_name;
334 if (dso__loaded(map->dso))
337 nr = dso__load(map->dso, map);
339 if (map->dso->has_build_id) {
340 char sbuild_id[SBUILD_ID_SIZE];
342 build_id__sprintf(map->dso->build_id,
343 sizeof(map->dso->build_id),
345 pr_debug("%s with build id %s not found", name, sbuild_id);
347 pr_debug("Failed to open %s", name);
349 pr_debug(", continuing without symbols\n");
351 } else if (nr == 0) {
352 #ifdef HAVE_LIBELF_SUPPORT
353 const size_t len = strlen(name);
354 const size_t real_len = len - sizeof(DSO__DELETED);
356 if (len > sizeof(DSO__DELETED) &&
357 strcmp(name + real_len + 1, DSO__DELETED) == 0) {
358 pr_debug("%.*s was updated (is prelink enabled?). "
359 "Restart the long running apps that use it!\n",
360 (int)real_len, name);
362 pr_debug("no symbols found in %s, maybe install a debug package?\n", name);
371 struct symbol *map__find_symbol(struct map *map, u64 addr)
373 if (map__load(map) < 0)
376 return dso__find_symbol(map->dso, addr);
379 struct symbol *map__find_symbol_by_name(struct map *map, const char *name)
381 if (map__load(map) < 0)
384 if (!dso__sorted_by_name(map->dso))
385 dso__sort_by_name(map->dso);
387 return dso__find_symbol_by_name(map->dso, name);
390 struct map *map__clone(struct map *from)
392 struct map *map = memdup(from, sizeof(*map));
395 refcount_set(&map->refcnt, 1);
396 RB_CLEAR_NODE(&map->rb_node);
404 size_t map__fprintf(struct map *map, FILE *fp)
406 return fprintf(fp, " %" PRIx64 "-%" PRIx64 " %" PRIx64 " %s\n",
407 map->start, map->end, map->pgoff, map->dso->name);
410 size_t map__fprintf_dsoname(struct map *map, FILE *fp)
412 char buf[symbol_conf.pad_output_len_dso + 1];
413 const char *dsoname = "[unknown]";
415 if (map && map->dso) {
416 if (symbol_conf.show_kernel_path && map->dso->long_name)
417 dsoname = map->dso->long_name;
419 dsoname = map->dso->name;
422 if (symbol_conf.pad_output_len_dso) {
423 scnprintf_pad(buf, symbol_conf.pad_output_len_dso, "%s", dsoname);
427 return fprintf(fp, "%s", dsoname);
430 char *map__srcline(struct map *map, u64 addr, struct symbol *sym)
433 return SRCLINE_UNKNOWN;
434 return get_srcline(map->dso, map__rip_2objdump(map, addr), sym, true, true, addr);
437 int map__fprintf_srcline(struct map *map, u64 addr, const char *prefix,
442 if (map && map->dso) {
443 char *srcline = map__srcline(map, addr, NULL);
444 if (srcline != SRCLINE_UNKNOWN)
445 ret = fprintf(fp, "%s%s", prefix, srcline);
446 free_srcline(srcline);
451 int map__fprintf_srccode(struct map *map, u64 addr,
453 struct srccode_state *state)
461 if (!map || !map->dso)
463 srcfile = get_srcline_split(map->dso,
464 map__rip_2objdump(map, addr),
469 /* Avoid redundant printing */
472 !strcmp(state->srcfile, srcfile) &&
473 state->line == line) {
478 srccode = find_sourceline(srcfile, line, &len);
482 ret = fprintf(fp, "|%-8d %.*s", line, len, srccode);
485 state->srcfile = srcfile;
496 void srccode_state_free(struct srccode_state *state)
498 zfree(&state->srcfile);
503 * map__rip_2objdump - convert symbol start address to objdump address.
505 * @rip: symbol start address
507 * objdump wants/reports absolute IPs for ET_EXEC, and RIPs for ET_DYN.
508 * map->dso->adjust_symbols==1 for ET_EXEC-like cases except ET_REL which is
509 * relative to section start.
511 * Return: Address suitable for passing to "objdump --start-address="
513 u64 map__rip_2objdump(struct map *map, u64 rip)
515 struct kmap *kmap = __map__kmap(map);
518 * vmlinux does not have program headers for PTI entry trampolines and
519 * kcore may not either. However the trampoline object code is on the
520 * main kernel map, so just use that instead.
522 if (kmap && is_entry_trampoline(kmap->name) && kmap->kmaps && kmap->kmaps->machine) {
523 struct map *kernel_map = machine__kernel_map(kmap->kmaps->machine);
529 if (!map->dso->adjust_symbols)
533 return rip - map->pgoff;
536 * kernel modules also have DSO_TYPE_USER in dso->kernel,
537 * but all kernel modules are ET_REL, so won't get here.
539 if (map->dso->kernel == DSO_TYPE_USER)
540 return rip + map->dso->text_offset;
542 return map->unmap_ip(map, rip) - map->reloc;
546 * map__objdump_2mem - convert objdump address to a memory address.
548 * @ip: objdump address
550 * Closely related to map__rip_2objdump(), this function takes an address from
551 * objdump and converts it to a memory address. Note this assumes that @map
552 * contains the address. To be sure the result is valid, check it forwards
553 * e.g. map__rip_2objdump(map->map_ip(map, map__objdump_2mem(map, ip))) == ip
555 * Return: Memory address.
557 u64 map__objdump_2mem(struct map *map, u64 ip)
559 if (!map->dso->adjust_symbols)
560 return map->unmap_ip(map, ip);
563 return map->unmap_ip(map, ip + map->pgoff);
566 * kernel modules also have DSO_TYPE_USER in dso->kernel,
567 * but all kernel modules are ET_REL, so won't get here.
569 if (map->dso->kernel == DSO_TYPE_USER)
570 return map->unmap_ip(map, ip - map->dso->text_offset);
572 return ip + map->reloc;
575 static void maps__init(struct maps *maps)
577 maps->entries = RB_ROOT;
578 maps->names = RB_ROOT;
579 init_rwsem(&maps->lock);
582 void map_groups__init(struct map_groups *mg, struct machine *machine)
584 maps__init(&mg->maps);
585 mg->machine = machine;
586 refcount_set(&mg->refcnt, 1);
589 void map_groups__insert(struct map_groups *mg, struct map *map)
591 maps__insert(&mg->maps, map);
595 static void __maps__purge(struct maps *maps)
597 struct rb_root *root = &maps->entries;
598 struct rb_node *next = rb_first(root);
601 struct map *pos = rb_entry(next, struct map, rb_node);
603 next = rb_next(&pos->rb_node);
604 rb_erase_init(&pos->rb_node, root);
609 static void __maps__purge_names(struct maps *maps)
611 struct rb_root *root = &maps->names;
612 struct rb_node *next = rb_first(root);
615 struct map *pos = rb_entry(next, struct map, rb_node_name);
617 next = rb_next(&pos->rb_node_name);
618 rb_erase_init(&pos->rb_node_name, root);
623 static void maps__exit(struct maps *maps)
625 down_write(&maps->lock);
627 __maps__purge_names(maps);
628 up_write(&maps->lock);
631 void map_groups__exit(struct map_groups *mg)
633 maps__exit(&mg->maps);
636 bool map_groups__empty(struct map_groups *mg)
638 return !maps__first(&mg->maps);
641 struct map_groups *map_groups__new(struct machine *machine)
643 struct map_groups *mg = zalloc(sizeof(*mg));
646 map_groups__init(mg, machine);
651 void map_groups__delete(struct map_groups *mg)
653 map_groups__exit(mg);
654 unwind__finish_access(mg);
658 void map_groups__put(struct map_groups *mg)
660 if (mg && refcount_dec_and_test(&mg->refcnt))
661 map_groups__delete(mg);
664 struct symbol *map_groups__find_symbol(struct map_groups *mg,
665 u64 addr, struct map **mapp)
667 struct map *map = map_groups__find(mg, addr);
669 /* Ensure map is loaded before using map->map_ip */
670 if (map != NULL && map__load(map) >= 0) {
673 return map__find_symbol(map, map->map_ip(map, addr));
679 static bool map__contains_symbol(struct map *map, struct symbol *sym)
681 u64 ip = map->unmap_ip(map, sym->start);
683 return ip >= map->start && ip < map->end;
686 struct symbol *maps__find_symbol_by_name(struct maps *maps, const char *name,
692 down_read(&maps->lock);
694 for (nd = rb_first(&maps->entries); nd; nd = rb_next(nd)) {
695 struct map *pos = rb_entry(nd, struct map, rb_node);
697 sym = map__find_symbol_by_name(pos, name);
701 if (!map__contains_symbol(pos, sym)) {
712 up_read(&maps->lock);
716 struct symbol *map_groups__find_symbol_by_name(struct map_groups *mg,
720 return maps__find_symbol_by_name(&mg->maps, name, mapp);
723 int map_groups__find_ams(struct addr_map_symbol *ams)
725 if (ams->addr < ams->map->start || ams->addr >= ams->map->end) {
726 if (ams->map->groups == NULL)
728 ams->map = map_groups__find(ams->map->groups, ams->addr);
729 if (ams->map == NULL)
733 ams->al_addr = ams->map->map_ip(ams->map, ams->addr);
734 ams->sym = map__find_symbol(ams->map, ams->al_addr);
736 return ams->sym ? 0 : -1;
739 static size_t maps__fprintf(struct maps *maps, FILE *fp)
744 down_read(&maps->lock);
746 for (nd = rb_first(&maps->entries); nd; nd = rb_next(nd)) {
747 struct map *pos = rb_entry(nd, struct map, rb_node);
748 printed += fprintf(fp, "Map:");
749 printed += map__fprintf(pos, fp);
751 printed += dso__fprintf(pos->dso, fp);
752 printed += fprintf(fp, "--\n");
756 up_read(&maps->lock);
761 size_t map_groups__fprintf(struct map_groups *mg, FILE *fp)
763 return maps__fprintf(&mg->maps, fp);
766 static void __map_groups__insert(struct map_groups *mg, struct map *map)
768 __maps__insert(&mg->maps, map);
769 __maps__insert_name(&mg->maps, map);
773 static int maps__fixup_overlappings(struct maps *maps, struct map *map, FILE *fp)
775 struct rb_root *root;
776 struct rb_node *next, *first;
779 down_write(&maps->lock);
781 root = &maps->entries;
784 * Find first map where end > map->start.
785 * Same as find_vma() in kernel.
787 next = root->rb_node;
790 struct map *pos = rb_entry(next, struct map, rb_node);
792 if (pos->end > map->start) {
794 if (pos->start <= map->start)
796 next = next->rb_left;
798 next = next->rb_right;
803 struct map *pos = rb_entry(next, struct map, rb_node);
804 next = rb_next(&pos->rb_node);
807 * Stop if current map starts after map->end.
808 * Maps are ordered by start: next will not overlap for sure.
810 if (pos->start >= map->end)
816 pr_debug("overlapping maps in %s (disable tui for more info)\n",
819 fputs("overlapping maps:\n", fp);
820 map__fprintf(map, fp);
821 map__fprintf(pos, fp);
825 rb_erase_init(&pos->rb_node, root);
827 * Now check if we need to create new maps for areas not
828 * overlapped by the new map:
830 if (map->start > pos->start) {
831 struct map *before = map__clone(pos);
833 if (before == NULL) {
838 before->end = map->start;
839 __map_groups__insert(pos->groups, before);
840 if (verbose >= 2 && !use_browser)
841 map__fprintf(before, fp);
845 if (map->end < pos->end) {
846 struct map *after = map__clone(pos);
853 after->start = map->end;
854 after->pgoff += map->end - pos->start;
855 assert(pos->map_ip(pos, map->end) == after->map_ip(after, map->end));
856 __map_groups__insert(pos->groups, after);
857 if (verbose >= 2 && !use_browser)
858 map__fprintf(after, fp);
870 up_write(&maps->lock);
874 int map_groups__fixup_overlappings(struct map_groups *mg, struct map *map,
877 return maps__fixup_overlappings(&mg->maps, map, fp);
881 * XXX This should not really _copy_ te maps, but refcount them.
883 int map_groups__clone(struct thread *thread, struct map_groups *parent)
885 struct map_groups *mg = thread->mg;
888 struct maps *maps = &parent->maps;
890 down_read(&maps->lock);
892 for (map = maps__first(maps); map; map = map__next(map)) {
893 struct map *new = map__clone(map);
897 err = unwind__prepare_access(mg, new, NULL);
901 map_groups__insert(mg, new);
907 up_read(&maps->lock);
911 static void __maps__insert(struct maps *maps, struct map *map)
913 struct rb_node **p = &maps->entries.rb_node;
914 struct rb_node *parent = NULL;
915 const u64 ip = map->start;
920 m = rb_entry(parent, struct map, rb_node);
927 rb_link_node(&map->rb_node, parent, p);
928 rb_insert_color(&map->rb_node, &maps->entries);
932 static void __maps__insert_name(struct maps *maps, struct map *map)
934 struct rb_node **p = &maps->names.rb_node;
935 struct rb_node *parent = NULL;
941 m = rb_entry(parent, struct map, rb_node_name);
942 rc = strcmp(m->dso->short_name, map->dso->short_name);
948 rb_link_node(&map->rb_node_name, parent, p);
949 rb_insert_color(&map->rb_node_name, &maps->names);
953 void maps__insert(struct maps *maps, struct map *map)
955 down_write(&maps->lock);
956 __maps__insert(maps, map);
957 __maps__insert_name(maps, map);
958 up_write(&maps->lock);
961 static void __maps__remove(struct maps *maps, struct map *map)
963 rb_erase_init(&map->rb_node, &maps->entries);
966 rb_erase_init(&map->rb_node_name, &maps->names);
970 void maps__remove(struct maps *maps, struct map *map)
972 down_write(&maps->lock);
973 __maps__remove(maps, map);
974 up_write(&maps->lock);
977 struct map *maps__find(struct maps *maps, u64 ip)
982 down_read(&maps->lock);
984 p = maps->entries.rb_node;
986 m = rb_entry(p, struct map, rb_node);
989 else if (ip >= m->end)
997 up_read(&maps->lock);
1001 struct map *maps__first(struct maps *maps)
1003 struct rb_node *first = rb_first(&maps->entries);
1006 return rb_entry(first, struct map, rb_node);
1010 struct map *map__next(struct map *map)
1012 struct rb_node *next = rb_next(&map->rb_node);
1015 return rb_entry(next, struct map, rb_node);
1019 struct kmap *__map__kmap(struct map *map)
1021 if (!map->dso || !map->dso->kernel)
1023 return (struct kmap *)(map + 1);
1026 struct kmap *map__kmap(struct map *map)
1028 struct kmap *kmap = __map__kmap(map);
1031 pr_err("Internal error: map__kmap with a non-kernel map\n");
1035 struct map_groups *map__kmaps(struct map *map)
1037 struct kmap *kmap = map__kmap(map);
1039 if (!kmap || !kmap->kmaps) {
1040 pr_err("Internal error: map__kmaps with a non-kernel map\n");