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);
30 static inline int is_android_lib(const char *filename)
32 return strstarts(filename, "/data/app-lib/") ||
33 strstarts(filename, "/system/lib/");
36 static inline bool replace_android_lib(const char *filename, char *newfilename)
40 size_t app_abi_length, new_length;
41 size_t lib_length = 0;
43 libname = strrchr(filename, '/');
45 lib_length = strlen(libname);
47 app_abi = getenv("APP_ABI");
51 app_abi_length = strlen(app_abi);
53 if (strstarts(filename, "/data/app-lib/")) {
59 new_length = 7 + app_abi_length + lib_length;
61 apk_path = getenv("APK_PATH");
63 new_length += strlen(apk_path) + 1;
64 if (new_length > PATH_MAX)
66 snprintf(newfilename, new_length,
67 "%s/libs/%s/%s", apk_path, app_abi, libname);
69 if (new_length > PATH_MAX)
71 snprintf(newfilename, new_length,
72 "libs/%s/%s", app_abi, libname);
77 if (strstarts(filename, "/system/lib/")) {
80 int ndk_length, app_length;
82 ndk = getenv("NDK_ROOT");
83 app = getenv("APP_PLATFORM");
88 ndk_length = strlen(ndk);
89 app_length = strlen(app);
91 if (!(ndk_length && app_length && app_abi_length))
94 arch = !strncmp(app_abi, "arm", 3) ? "arm" :
95 !strncmp(app_abi, "mips", 4) ? "mips" :
96 !strncmp(app_abi, "x86", 3) ? "x86" : NULL;
101 new_length = 27 + ndk_length +
102 app_length + lib_length
105 if (new_length > PATH_MAX)
107 snprintf(newfilename, new_length,
108 "%.*s/platforms/%.*s/arch-%s/usr/lib/%s",
109 ndk_length, ndk, app_length, app, arch, libname);
116 void map__init(struct map *map, u64 start, u64 end, u64 pgoff, struct dso *dso)
122 map->dso = dso__get(dso);
123 map->map_ip = map__map_ip;
124 map->unmap_ip = map__unmap_ip;
125 RB_CLEAR_NODE(&map->rb_node);
126 map->erange_warned = false;
127 refcount_set(&map->refcnt, 1);
130 struct map *map__new(struct machine *machine, u64 start, u64 len,
131 u64 pgoff, struct dso_id *id,
132 u32 prot, u32 flags, struct build_id *bid,
133 char *filename, struct thread *thread)
135 struct map *map = malloc(sizeof(*map));
136 struct nsinfo *nsi = NULL;
140 char newfilename[PATH_MAX];
142 int anon, no_dso, vdso, android;
144 android = is_android_lib(filename);
145 anon = is_anon_memory(filename) || flags & MAP_HUGETLB;
146 vdso = is_vdso_map(filename);
147 no_dso = is_no_dso_memory(filename);
150 nsi = nsinfo__get(thread->nsinfo);
152 if ((anon || no_dso) && nsi && (prot & PROT_EXEC)) {
153 snprintf(newfilename, sizeof(newfilename),
154 "/tmp/perf-%d.map", nsi->pid);
155 filename = newfilename;
159 if (replace_android_lib(filename, newfilename))
160 filename = newfilename;
164 /* The vdso maps are always on the host and not the
165 * container. Ensure that we don't use setns to look
168 nnsi = nsinfo__copy(nsi);
171 nnsi->need_setns = false;
175 dso = machine__findnew_vdso(machine, thread);
177 dso = machine__findnew_dso_id(machine, filename, id);
182 map__init(map, start, start + len, pgoff, dso);
184 if (anon || no_dso) {
185 map->map_ip = map->unmap_ip = identity__map_ip;
188 * Set memory without DSO as loaded. All map__find_*
189 * functions still return NULL, and we avoid the
190 * unnecessary map__load warning.
192 if (!(prot & PROT_EXEC))
193 dso__set_loaded(dso);
196 nsinfo__put(dso->nsinfo);
199 if (build_id__is_defined(bid))
200 dso__set_build_id(dso, bid);
212 * Constructor variant for modules (where we know from /proc/modules where
213 * they are loaded) and for vmlinux, where only after we load all the
214 * symbols we'll know where it starts and ends.
216 struct map *map__new2(u64 start, struct dso *dso)
218 struct map *map = calloc(1, (sizeof(*map) +
219 (dso->kernel ? sizeof(struct kmap) : 0)));
222 * ->end will be filled after we load all the symbols
224 map__init(map, start, 0, 0, dso);
230 bool __map__is_kernel(const struct map *map)
232 if (!map->dso->kernel)
234 return machine__kernel_map(map__kmaps((struct map *)map)->machine) == map;
237 bool __map__is_extra_kernel_map(const struct map *map)
239 struct kmap *kmap = __map__kmap((struct map *)map);
241 return kmap && kmap->name[0];
244 bool __map__is_bpf_prog(const struct map *map)
248 if (map->dso->binary_type == DSO_BINARY_TYPE__BPF_PROG_INFO)
252 * If PERF_RECORD_BPF_EVENT is not included, the dso will not have
253 * type of DSO_BINARY_TYPE__BPF_PROG_INFO. In such cases, we can
254 * guess the type based on name.
256 name = map->dso->short_name;
257 return name && (strstr(name, "bpf_prog_") == name);
260 bool __map__is_bpf_image(const struct map *map)
264 if (map->dso->binary_type == DSO_BINARY_TYPE__BPF_IMAGE)
268 * If PERF_RECORD_KSYMBOL is not included, the dso will not have
269 * type of DSO_BINARY_TYPE__BPF_IMAGE. In such cases, we can
270 * guess the type based on name.
272 name = map->dso->short_name;
273 return name && is_bpf_image(name);
276 bool __map__is_ool(const struct map *map)
278 return map->dso && map->dso->binary_type == DSO_BINARY_TYPE__OOL;
281 bool map__has_symbols(const struct map *map)
283 return dso__has_symbols(map->dso);
286 static void map__exit(struct map *map)
288 BUG_ON(refcount_read(&map->refcnt) != 0);
292 void map__delete(struct map *map)
298 void map__put(struct map *map)
300 if (map && refcount_dec_and_test(&map->refcnt))
304 void map__fixup_start(struct map *map)
306 struct rb_root_cached *symbols = &map->dso->symbols;
307 struct rb_node *nd = rb_first_cached(symbols);
309 struct symbol *sym = rb_entry(nd, struct symbol, rb_node);
310 map->start = sym->start;
314 void map__fixup_end(struct map *map)
316 struct rb_root_cached *symbols = &map->dso->symbols;
317 struct rb_node *nd = rb_last(&symbols->rb_root);
319 struct symbol *sym = rb_entry(nd, struct symbol, rb_node);
324 #define DSO__DELETED "(deleted)"
326 int map__load(struct map *map)
328 const char *name = map->dso->long_name;
331 if (dso__loaded(map->dso))
334 nr = dso__load(map->dso, map);
336 if (map->dso->has_build_id) {
337 char sbuild_id[SBUILD_ID_SIZE];
339 build_id__sprintf(&map->dso->bid, sbuild_id);
340 pr_debug("%s with build id %s not found", name, sbuild_id);
342 pr_debug("Failed to open %s", name);
344 pr_debug(", continuing without symbols\n");
346 } else if (nr == 0) {
347 #ifdef HAVE_LIBELF_SUPPORT
348 const size_t len = strlen(name);
349 const size_t real_len = len - sizeof(DSO__DELETED);
351 if (len > sizeof(DSO__DELETED) &&
352 strcmp(name + real_len + 1, DSO__DELETED) == 0) {
353 pr_debug("%.*s was updated (is prelink enabled?). "
354 "Restart the long running apps that use it!\n",
355 (int)real_len, name);
357 pr_debug("no symbols found in %s, maybe install a debug package?\n", name);
366 struct symbol *map__find_symbol(struct map *map, u64 addr)
368 if (map__load(map) < 0)
371 return dso__find_symbol(map->dso, addr);
374 struct symbol *map__find_symbol_by_name(struct map *map, const char *name)
376 if (map__load(map) < 0)
379 if (!dso__sorted_by_name(map->dso))
380 dso__sort_by_name(map->dso);
382 return dso__find_symbol_by_name(map->dso, name);
385 struct map *map__clone(struct map *from)
387 size_t size = sizeof(struct map);
390 if (from->dso && from->dso->kernel)
391 size += sizeof(struct kmap);
393 map = memdup(from, size);
395 refcount_set(&map->refcnt, 1);
396 RB_CLEAR_NODE(&map->rb_node);
403 size_t map__fprintf(struct map *map, FILE *fp)
405 return fprintf(fp, " %" PRIx64 "-%" PRIx64 " %" PRIx64 " %s\n",
406 map->start, map->end, map->pgoff, map->dso->name);
409 size_t map__fprintf_dsoname(struct map *map, FILE *fp)
411 char buf[symbol_conf.pad_output_len_dso + 1];
412 const char *dsoname = "[unknown]";
414 if (map && map->dso) {
415 if (symbol_conf.show_kernel_path && map->dso->long_name)
416 dsoname = map->dso->long_name;
418 dsoname = map->dso->name;
421 if (symbol_conf.pad_output_len_dso) {
422 scnprintf_pad(buf, symbol_conf.pad_output_len_dso, "%s", dsoname);
426 return fprintf(fp, "%s", dsoname);
429 char *map__srcline(struct map *map, u64 addr, struct symbol *sym)
432 return SRCLINE_UNKNOWN;
433 return get_srcline(map->dso, map__rip_2objdump(map, addr), sym, true, true, addr);
436 int map__fprintf_srcline(struct map *map, u64 addr, const char *prefix,
441 if (map && map->dso) {
442 char *srcline = map__srcline(map, addr, NULL);
443 if (strncmp(srcline, SRCLINE_UNKNOWN, strlen(SRCLINE_UNKNOWN)) != 0)
444 ret = fprintf(fp, "%s%s", prefix, srcline);
445 free_srcline(srcline);
450 void srccode_state_free(struct srccode_state *state)
452 zfree(&state->srcfile);
457 * map__rip_2objdump - convert symbol start address to objdump address.
459 * @rip: symbol start address
461 * objdump wants/reports absolute IPs for ET_EXEC, and RIPs for ET_DYN.
462 * map->dso->adjust_symbols==1 for ET_EXEC-like cases except ET_REL which is
463 * relative to section start.
465 * Return: Address suitable for passing to "objdump --start-address="
467 u64 map__rip_2objdump(struct map *map, u64 rip)
469 struct kmap *kmap = __map__kmap(map);
472 * vmlinux does not have program headers for PTI entry trampolines and
473 * kcore may not either. However the trampoline object code is on the
474 * main kernel map, so just use that instead.
476 if (kmap && is_entry_trampoline(kmap->name) && kmap->kmaps && kmap->kmaps->machine) {
477 struct map *kernel_map = machine__kernel_map(kmap->kmaps->machine);
483 if (!map->dso->adjust_symbols)
487 return rip - map->pgoff;
490 * kernel modules also have DSO_TYPE_USER in dso->kernel,
491 * but all kernel modules are ET_REL, so won't get here.
493 if (map->dso->kernel == DSO_SPACE__USER)
494 return rip + map->dso->text_offset;
496 return map->unmap_ip(map, rip) - map->reloc;
500 * map__objdump_2mem - convert objdump address to a memory address.
502 * @ip: objdump address
504 * Closely related to map__rip_2objdump(), this function takes an address from
505 * objdump and converts it to a memory address. Note this assumes that @map
506 * contains the address. To be sure the result is valid, check it forwards
507 * e.g. map__rip_2objdump(map->map_ip(map, map__objdump_2mem(map, ip))) == ip
509 * Return: Memory address.
511 u64 map__objdump_2mem(struct map *map, u64 ip)
513 if (!map->dso->adjust_symbols)
514 return map->unmap_ip(map, ip);
517 return map->unmap_ip(map, ip + map->pgoff);
520 * kernel modules also have DSO_TYPE_USER in dso->kernel,
521 * but all kernel modules are ET_REL, so won't get here.
523 if (map->dso->kernel == DSO_SPACE__USER)
524 return map->unmap_ip(map, ip - map->dso->text_offset);
526 return ip + map->reloc;
529 void maps__init(struct maps *maps, struct machine *machine)
531 maps->entries = RB_ROOT;
532 init_rwsem(&maps->lock);
533 maps->machine = machine;
534 maps->last_search_by_name = NULL;
536 maps->maps_by_name = NULL;
537 refcount_set(&maps->refcnt, 1);
540 static void __maps__free_maps_by_name(struct maps *maps)
543 * Free everything to try to do it from the rbtree in the next search
545 zfree(&maps->maps_by_name);
546 maps->nr_maps_allocated = 0;
549 void maps__insert(struct maps *maps, struct map *map)
551 down_write(&maps->lock);
552 __maps__insert(maps, map);
555 if (map->dso && map->dso->kernel) {
556 struct kmap *kmap = map__kmap(map);
561 pr_err("Internal error: kernel dso with non kernel map\n");
566 * If we already performed some search by name, then we need to add the just
567 * inserted map and resort.
569 if (maps->maps_by_name) {
570 if (maps->nr_maps > maps->nr_maps_allocated) {
571 int nr_allocate = maps->nr_maps * 2;
572 struct map **maps_by_name = realloc(maps->maps_by_name, nr_allocate * sizeof(map));
574 if (maps_by_name == NULL) {
575 __maps__free_maps_by_name(maps);
576 up_write(&maps->lock);
580 maps->maps_by_name = maps_by_name;
581 maps->nr_maps_allocated = nr_allocate;
583 maps->maps_by_name[maps->nr_maps - 1] = map;
584 __maps__sort_by_name(maps);
586 up_write(&maps->lock);
589 static void __maps__remove(struct maps *maps, struct map *map)
591 rb_erase_init(&map->rb_node, &maps->entries);
595 void maps__remove(struct maps *maps, struct map *map)
597 down_write(&maps->lock);
598 if (maps->last_search_by_name == map)
599 maps->last_search_by_name = NULL;
601 __maps__remove(maps, map);
603 if (maps->maps_by_name)
604 __maps__free_maps_by_name(maps);
605 up_write(&maps->lock);
608 static void __maps__purge(struct maps *maps)
610 struct map *pos, *next;
612 maps__for_each_entry_safe(maps, pos, next) {
613 rb_erase_init(&pos->rb_node, &maps->entries);
618 void maps__exit(struct maps *maps)
620 down_write(&maps->lock);
622 up_write(&maps->lock);
625 bool maps__empty(struct maps *maps)
627 return !maps__first(maps);
630 struct maps *maps__new(struct machine *machine)
632 struct maps *maps = zalloc(sizeof(*maps));
635 maps__init(maps, machine);
640 void maps__delete(struct maps *maps)
643 unwind__finish_access(maps);
647 void maps__put(struct maps *maps)
649 if (maps && refcount_dec_and_test(&maps->refcnt))
653 struct symbol *maps__find_symbol(struct maps *maps, u64 addr, struct map **mapp)
655 struct map *map = maps__find(maps, addr);
657 /* Ensure map is loaded before using map->map_ip */
658 if (map != NULL && map__load(map) >= 0) {
661 return map__find_symbol(map, map->map_ip(map, addr));
667 static bool map__contains_symbol(struct map *map, struct symbol *sym)
669 u64 ip = map->unmap_ip(map, sym->start);
671 return ip >= map->start && ip < map->end;
674 struct symbol *maps__find_symbol_by_name(struct maps *maps, const char *name, struct map **mapp)
679 down_read(&maps->lock);
681 maps__for_each_entry(maps, pos) {
682 sym = map__find_symbol_by_name(pos, name);
686 if (!map__contains_symbol(pos, sym)) {
697 up_read(&maps->lock);
701 int maps__find_ams(struct maps *maps, struct addr_map_symbol *ams)
703 if (ams->addr < ams->ms.map->start || ams->addr >= ams->ms.map->end) {
706 ams->ms.map = maps__find(maps, ams->addr);
707 if (ams->ms.map == NULL)
711 ams->al_addr = ams->ms.map->map_ip(ams->ms.map, ams->addr);
712 ams->ms.sym = map__find_symbol(ams->ms.map, ams->al_addr);
714 return ams->ms.sym ? 0 : -1;
717 size_t maps__fprintf(struct maps *maps, FILE *fp)
722 down_read(&maps->lock);
724 maps__for_each_entry(maps, pos) {
725 printed += fprintf(fp, "Map:");
726 printed += map__fprintf(pos, fp);
728 printed += dso__fprintf(pos->dso, fp);
729 printed += fprintf(fp, "--\n");
733 up_read(&maps->lock);
738 int maps__fixup_overlappings(struct maps *maps, struct map *map, FILE *fp)
740 struct rb_root *root;
741 struct rb_node *next, *first;
744 down_write(&maps->lock);
746 root = &maps->entries;
749 * Find first map where end > map->start.
750 * Same as find_vma() in kernel.
752 next = root->rb_node;
755 struct map *pos = rb_entry(next, struct map, rb_node);
757 if (pos->end > map->start) {
759 if (pos->start <= map->start)
761 next = next->rb_left;
763 next = next->rb_right;
768 struct map *pos = rb_entry(next, struct map, rb_node);
769 next = rb_next(&pos->rb_node);
772 * Stop if current map starts after map->end.
773 * Maps are ordered by start: next will not overlap for sure.
775 if (pos->start >= map->end)
781 pr_debug("overlapping maps in %s (disable tui for more info)\n",
784 fputs("overlapping maps:\n", fp);
785 map__fprintf(map, fp);
786 map__fprintf(pos, fp);
790 rb_erase_init(&pos->rb_node, root);
792 * Now check if we need to create new maps for areas not
793 * overlapped by the new map:
795 if (map->start > pos->start) {
796 struct map *before = map__clone(pos);
798 if (before == NULL) {
803 before->end = map->start;
804 __maps__insert(maps, before);
805 if (verbose >= 2 && !use_browser)
806 map__fprintf(before, fp);
810 if (map->end < pos->end) {
811 struct map *after = map__clone(pos);
818 after->start = map->end;
819 after->pgoff += map->end - pos->start;
820 assert(pos->map_ip(pos, map->end) == after->map_ip(after, map->end));
821 __maps__insert(maps, after);
822 if (verbose >= 2 && !use_browser)
823 map__fprintf(after, fp);
835 up_write(&maps->lock);
840 * XXX This should not really _copy_ te maps, but refcount them.
842 int maps__clone(struct thread *thread, struct maps *parent)
844 struct maps *maps = thread->maps;
848 down_read(&parent->lock);
850 maps__for_each_entry(parent, map) {
851 struct map *new = map__clone(map);
858 err = unwind__prepare_access(maps, new, NULL);
862 maps__insert(maps, new);
868 up_read(&parent->lock);
872 static void __maps__insert(struct maps *maps, struct map *map)
874 struct rb_node **p = &maps->entries.rb_node;
875 struct rb_node *parent = NULL;
876 const u64 ip = map->start;
881 m = rb_entry(parent, struct map, rb_node);
888 rb_link_node(&map->rb_node, parent, p);
889 rb_insert_color(&map->rb_node, &maps->entries);
893 struct map *maps__find(struct maps *maps, u64 ip)
898 down_read(&maps->lock);
900 p = maps->entries.rb_node;
902 m = rb_entry(p, struct map, rb_node);
905 else if (ip >= m->end)
913 up_read(&maps->lock);
917 struct map *maps__first(struct maps *maps)
919 struct rb_node *first = rb_first(&maps->entries);
922 return rb_entry(first, struct map, rb_node);
926 static struct map *__map__next(struct map *map)
928 struct rb_node *next = rb_next(&map->rb_node);
931 return rb_entry(next, struct map, rb_node);
935 struct map *map__next(struct map *map)
937 return map ? __map__next(map) : NULL;
940 struct kmap *__map__kmap(struct map *map)
942 if (!map->dso || !map->dso->kernel)
944 return (struct kmap *)(map + 1);
947 struct kmap *map__kmap(struct map *map)
949 struct kmap *kmap = __map__kmap(map);
952 pr_err("Internal error: map__kmap with a non-kernel map\n");
956 struct maps *map__kmaps(struct map *map)
958 struct kmap *kmap = map__kmap(map);
960 if (!kmap || !kmap->kmaps) {
961 pr_err("Internal error: map__kmaps with a non-kernel map\n");