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_anon_memory(const char *filename, u32 flags)
32 return flags & MAP_HUGETLB ||
33 !strcmp(filename, "//anon") ||
34 !strncmp(filename, "/dev/zero", sizeof("/dev/zero") - 1) ||
35 !strncmp(filename, "/anon_hugepage", sizeof("/anon_hugepage") - 1);
38 static inline int is_no_dso_memory(const char *filename)
40 return !strncmp(filename, "[stack", 6) ||
41 !strncmp(filename, "/SYSV",5) ||
42 !strcmp(filename, "[heap]");
45 static inline int is_android_lib(const char *filename)
47 return strstarts(filename, "/data/app-lib/") ||
48 strstarts(filename, "/system/lib/");
51 static inline bool replace_android_lib(const char *filename, char *newfilename)
55 size_t app_abi_length, new_length;
56 size_t lib_length = 0;
58 libname = strrchr(filename, '/');
60 lib_length = strlen(libname);
62 app_abi = getenv("APP_ABI");
66 app_abi_length = strlen(app_abi);
68 if (strstarts(filename, "/data/app-lib/")) {
74 new_length = 7 + app_abi_length + lib_length;
76 apk_path = getenv("APK_PATH");
78 new_length += strlen(apk_path) + 1;
79 if (new_length > PATH_MAX)
81 snprintf(newfilename, new_length,
82 "%s/libs/%s/%s", apk_path, app_abi, libname);
84 if (new_length > PATH_MAX)
86 snprintf(newfilename, new_length,
87 "libs/%s/%s", app_abi, libname);
92 if (strstarts(filename, "/system/lib/")) {
98 ndk = getenv("NDK_ROOT");
99 app = getenv("APP_PLATFORM");
104 ndk_length = strlen(ndk);
105 app_length = strlen(app);
107 if (!(ndk_length && app_length && app_abi_length))
110 arch = !strncmp(app_abi, "arm", 3) ? "arm" :
111 !strncmp(app_abi, "mips", 4) ? "mips" :
112 !strncmp(app_abi, "x86", 3) ? "x86" : NULL;
117 new_length = 27 + ndk_length +
118 app_length + lib_length
121 if (new_length > PATH_MAX)
123 snprintf(newfilename, new_length,
124 "%s/platforms/%s/arch-%s/usr/lib/%s",
125 ndk, app, arch, libname);
132 void map__init(struct map *map, u64 start, u64 end, u64 pgoff, struct dso *dso)
138 map->dso = dso__get(dso);
139 map->map_ip = map__map_ip;
140 map->unmap_ip = map__unmap_ip;
141 RB_CLEAR_NODE(&map->rb_node);
142 map->erange_warned = false;
143 refcount_set(&map->refcnt, 1);
146 struct map *map__new(struct machine *machine, u64 start, u64 len,
147 u64 pgoff, struct dso_id *id,
148 u32 prot, u32 flags, char *filename,
149 struct thread *thread)
151 struct map *map = malloc(sizeof(*map));
152 struct nsinfo *nsi = NULL;
156 char newfilename[PATH_MAX];
158 int anon, no_dso, vdso, android;
160 android = is_android_lib(filename);
161 anon = is_anon_memory(filename, flags);
162 vdso = is_vdso_map(filename);
163 no_dso = is_no_dso_memory(filename);
166 nsi = nsinfo__get(thread->nsinfo);
168 if ((anon || no_dso) && nsi && (prot & PROT_EXEC)) {
169 snprintf(newfilename, sizeof(newfilename),
170 "/tmp/perf-%d.map", nsi->pid);
171 filename = newfilename;
175 if (replace_android_lib(filename, newfilename))
176 filename = newfilename;
180 /* The vdso maps are always on the host and not the
181 * container. Ensure that we don't use setns to look
184 nnsi = nsinfo__copy(nsi);
187 nnsi->need_setns = false;
191 dso = machine__findnew_vdso(machine, thread);
193 dso = machine__findnew_dso_id(machine, filename, id);
198 map__init(map, start, start + len, pgoff, dso);
200 if (anon || no_dso) {
201 map->map_ip = map->unmap_ip = identity__map_ip;
204 * Set memory without DSO as loaded. All map__find_*
205 * functions still return NULL, and we avoid the
206 * unnecessary map__load warning.
208 if (!(prot & PROT_EXEC))
209 dso__set_loaded(dso);
222 * Constructor variant for modules (where we know from /proc/modules where
223 * they are loaded) and for vmlinux, where only after we load all the
224 * symbols we'll know where it starts and ends.
226 struct map *map__new2(u64 start, struct dso *dso)
228 struct map *map = calloc(1, (sizeof(*map) +
229 (dso->kernel ? sizeof(struct kmap) : 0)));
232 * ->end will be filled after we load all the symbols
234 map__init(map, start, 0, 0, dso);
240 bool __map__is_kernel(const struct map *map)
242 if (!map->dso->kernel)
244 return machine__kernel_map(map__kmaps((struct map *)map)->machine) == map;
247 bool __map__is_extra_kernel_map(const struct map *map)
249 struct kmap *kmap = __map__kmap((struct map *)map);
251 return kmap && kmap->name[0];
254 bool __map__is_bpf_prog(const struct map *map)
258 if (map->dso->binary_type == DSO_BINARY_TYPE__BPF_PROG_INFO)
262 * If PERF_RECORD_BPF_EVENT is not included, the dso will not have
263 * type of DSO_BINARY_TYPE__BPF_PROG_INFO. In such cases, we can
264 * guess the type based on name.
266 name = map->dso->short_name;
267 return name && (strstr(name, "bpf_prog_") == name);
270 bool __map__is_bpf_image(const struct map *map)
274 if (map->dso->binary_type == DSO_BINARY_TYPE__BPF_IMAGE)
278 * If PERF_RECORD_KSYMBOL is not included, the dso will not have
279 * type of DSO_BINARY_TYPE__BPF_IMAGE. In such cases, we can
280 * guess the type based on name.
282 name = map->dso->short_name;
283 return name && is_bpf_image(name);
286 bool __map__is_ool(const struct map *map)
288 return map->dso && map->dso->binary_type == DSO_BINARY_TYPE__OOL;
291 bool map__has_symbols(const struct map *map)
293 return dso__has_symbols(map->dso);
296 static void map__exit(struct map *map)
298 BUG_ON(refcount_read(&map->refcnt) != 0);
302 void map__delete(struct map *map)
308 void map__put(struct map *map)
310 if (map && refcount_dec_and_test(&map->refcnt))
314 void map__fixup_start(struct map *map)
316 struct rb_root_cached *symbols = &map->dso->symbols;
317 struct rb_node *nd = rb_first_cached(symbols);
319 struct symbol *sym = rb_entry(nd, struct symbol, rb_node);
320 map->start = sym->start;
324 void map__fixup_end(struct map *map)
326 struct rb_root_cached *symbols = &map->dso->symbols;
327 struct rb_node *nd = rb_last(&symbols->rb_root);
329 struct symbol *sym = rb_entry(nd, struct symbol, rb_node);
334 #define DSO__DELETED "(deleted)"
336 int map__load(struct map *map)
338 const char *name = map->dso->long_name;
341 if (dso__loaded(map->dso))
344 nr = dso__load(map->dso, map);
346 if (map->dso->has_build_id) {
347 char sbuild_id[SBUILD_ID_SIZE];
349 build_id__sprintf(map->dso->build_id,
350 sizeof(map->dso->build_id),
352 pr_debug("%s with build id %s not found", name, sbuild_id);
354 pr_debug("Failed to open %s", name);
356 pr_debug(", continuing without symbols\n");
358 } else if (nr == 0) {
359 #ifdef HAVE_LIBELF_SUPPORT
360 const size_t len = strlen(name);
361 const size_t real_len = len - sizeof(DSO__DELETED);
363 if (len > sizeof(DSO__DELETED) &&
364 strcmp(name + real_len + 1, DSO__DELETED) == 0) {
365 pr_debug("%.*s was updated (is prelink enabled?). "
366 "Restart the long running apps that use it!\n",
367 (int)real_len, name);
369 pr_debug("no symbols found in %s, maybe install a debug package?\n", name);
378 struct symbol *map__find_symbol(struct map *map, u64 addr)
380 if (map__load(map) < 0)
383 return dso__find_symbol(map->dso, addr);
386 struct symbol *map__find_symbol_by_name(struct map *map, const char *name)
388 if (map__load(map) < 0)
391 if (!dso__sorted_by_name(map->dso))
392 dso__sort_by_name(map->dso);
394 return dso__find_symbol_by_name(map->dso, name);
397 struct map *map__clone(struct map *from)
399 size_t size = sizeof(struct map);
402 if (from->dso && from->dso->kernel)
403 size += sizeof(struct kmap);
405 map = memdup(from, size);
407 refcount_set(&map->refcnt, 1);
408 RB_CLEAR_NODE(&map->rb_node);
415 size_t map__fprintf(struct map *map, FILE *fp)
417 return fprintf(fp, " %" PRIx64 "-%" PRIx64 " %" PRIx64 " %s\n",
418 map->start, map->end, map->pgoff, map->dso->name);
421 size_t map__fprintf_dsoname(struct map *map, FILE *fp)
423 char buf[symbol_conf.pad_output_len_dso + 1];
424 const char *dsoname = "[unknown]";
426 if (map && map->dso) {
427 if (symbol_conf.show_kernel_path && map->dso->long_name)
428 dsoname = map->dso->long_name;
430 dsoname = map->dso->name;
433 if (symbol_conf.pad_output_len_dso) {
434 scnprintf_pad(buf, symbol_conf.pad_output_len_dso, "%s", dsoname);
438 return fprintf(fp, "%s", dsoname);
441 char *map__srcline(struct map *map, u64 addr, struct symbol *sym)
444 return SRCLINE_UNKNOWN;
445 return get_srcline(map->dso, map__rip_2objdump(map, addr), sym, true, true, addr);
448 int map__fprintf_srcline(struct map *map, u64 addr, const char *prefix,
453 if (map && map->dso) {
454 char *srcline = map__srcline(map, addr, NULL);
455 if (strncmp(srcline, SRCLINE_UNKNOWN, strlen(SRCLINE_UNKNOWN)) != 0)
456 ret = fprintf(fp, "%s%s", prefix, srcline);
457 free_srcline(srcline);
462 void srccode_state_free(struct srccode_state *state)
464 zfree(&state->srcfile);
469 * map__rip_2objdump - convert symbol start address to objdump address.
471 * @rip: symbol start address
473 * objdump wants/reports absolute IPs for ET_EXEC, and RIPs for ET_DYN.
474 * map->dso->adjust_symbols==1 for ET_EXEC-like cases except ET_REL which is
475 * relative to section start.
477 * Return: Address suitable for passing to "objdump --start-address="
479 u64 map__rip_2objdump(struct map *map, u64 rip)
481 struct kmap *kmap = __map__kmap(map);
484 * vmlinux does not have program headers for PTI entry trampolines and
485 * kcore may not either. However the trampoline object code is on the
486 * main kernel map, so just use that instead.
488 if (kmap && is_entry_trampoline(kmap->name) && kmap->kmaps && kmap->kmaps->machine) {
489 struct map *kernel_map = machine__kernel_map(kmap->kmaps->machine);
495 if (!map->dso->adjust_symbols)
499 return rip - map->pgoff;
502 * kernel modules also have DSO_TYPE_USER in dso->kernel,
503 * but all kernel modules are ET_REL, so won't get here.
505 if (map->dso->kernel == DSO_SPACE__USER)
506 return rip + map->dso->text_offset;
508 return map->unmap_ip(map, rip) - map->reloc;
512 * map__objdump_2mem - convert objdump address to a memory address.
514 * @ip: objdump address
516 * Closely related to map__rip_2objdump(), this function takes an address from
517 * objdump and converts it to a memory address. Note this assumes that @map
518 * contains the address. To be sure the result is valid, check it forwards
519 * e.g. map__rip_2objdump(map->map_ip(map, map__objdump_2mem(map, ip))) == ip
521 * Return: Memory address.
523 u64 map__objdump_2mem(struct map *map, u64 ip)
525 if (!map->dso->adjust_symbols)
526 return map->unmap_ip(map, ip);
529 return map->unmap_ip(map, ip + map->pgoff);
532 * kernel modules also have DSO_TYPE_USER in dso->kernel,
533 * but all kernel modules are ET_REL, so won't get here.
535 if (map->dso->kernel == DSO_SPACE__USER)
536 return map->unmap_ip(map, ip - map->dso->text_offset);
538 return ip + map->reloc;
541 void maps__init(struct maps *maps, struct machine *machine)
543 maps->entries = RB_ROOT;
544 init_rwsem(&maps->lock);
545 maps->machine = machine;
546 maps->last_search_by_name = NULL;
548 maps->maps_by_name = NULL;
549 refcount_set(&maps->refcnt, 1);
552 static void __maps__free_maps_by_name(struct maps *maps)
555 * Free everything to try to do it from the rbtree in the next search
557 zfree(&maps->maps_by_name);
558 maps->nr_maps_allocated = 0;
561 void maps__insert(struct maps *maps, struct map *map)
563 down_write(&maps->lock);
564 __maps__insert(maps, map);
567 if (map->dso && map->dso->kernel) {
568 struct kmap *kmap = map__kmap(map);
573 pr_err("Internal error: kernel dso with non kernel map\n");
578 * If we already performed some search by name, then we need to add the just
579 * inserted map and resort.
581 if (maps->maps_by_name) {
582 if (maps->nr_maps > maps->nr_maps_allocated) {
583 int nr_allocate = maps->nr_maps * 2;
584 struct map **maps_by_name = realloc(maps->maps_by_name, nr_allocate * sizeof(map));
586 if (maps_by_name == NULL) {
587 __maps__free_maps_by_name(maps);
588 up_write(&maps->lock);
592 maps->maps_by_name = maps_by_name;
593 maps->nr_maps_allocated = nr_allocate;
595 maps->maps_by_name[maps->nr_maps - 1] = map;
596 __maps__sort_by_name(maps);
598 up_write(&maps->lock);
601 static void __maps__remove(struct maps *maps, struct map *map)
603 rb_erase_init(&map->rb_node, &maps->entries);
607 void maps__remove(struct maps *maps, struct map *map)
609 down_write(&maps->lock);
610 if (maps->last_search_by_name == map)
611 maps->last_search_by_name = NULL;
613 __maps__remove(maps, map);
615 if (maps->maps_by_name)
616 __maps__free_maps_by_name(maps);
617 up_write(&maps->lock);
620 static void __maps__purge(struct maps *maps)
622 struct map *pos, *next;
624 maps__for_each_entry_safe(maps, pos, next) {
625 rb_erase_init(&pos->rb_node, &maps->entries);
630 void maps__exit(struct maps *maps)
632 down_write(&maps->lock);
634 up_write(&maps->lock);
637 bool maps__empty(struct maps *maps)
639 return !maps__first(maps);
642 struct maps *maps__new(struct machine *machine)
644 struct maps *maps = zalloc(sizeof(*maps));
647 maps__init(maps, machine);
652 void maps__delete(struct maps *maps)
655 unwind__finish_access(maps);
659 void maps__put(struct maps *maps)
661 if (maps && refcount_dec_and_test(&maps->refcnt))
665 struct symbol *maps__find_symbol(struct maps *maps, u64 addr, struct map **mapp)
667 struct map *map = maps__find(maps, 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, struct map **mapp)
691 down_read(&maps->lock);
693 maps__for_each_entry(maps, pos) {
694 sym = map__find_symbol_by_name(pos, name);
698 if (!map__contains_symbol(pos, sym)) {
709 up_read(&maps->lock);
713 int maps__find_ams(struct maps *maps, struct addr_map_symbol *ams)
715 if (ams->addr < ams->ms.map->start || ams->addr >= ams->ms.map->end) {
718 ams->ms.map = maps__find(maps, ams->addr);
719 if (ams->ms.map == NULL)
723 ams->al_addr = ams->ms.map->map_ip(ams->ms.map, ams->addr);
724 ams->ms.sym = map__find_symbol(ams->ms.map, ams->al_addr);
726 return ams->ms.sym ? 0 : -1;
729 size_t maps__fprintf(struct maps *maps, FILE *fp)
734 down_read(&maps->lock);
736 maps__for_each_entry(maps, pos) {
737 printed += fprintf(fp, "Map:");
738 printed += map__fprintf(pos, fp);
740 printed += dso__fprintf(pos->dso, fp);
741 printed += fprintf(fp, "--\n");
745 up_read(&maps->lock);
750 int maps__fixup_overlappings(struct maps *maps, struct map *map, FILE *fp)
752 struct rb_root *root;
753 struct rb_node *next, *first;
756 down_write(&maps->lock);
758 root = &maps->entries;
761 * Find first map where end > map->start.
762 * Same as find_vma() in kernel.
764 next = root->rb_node;
767 struct map *pos = rb_entry(next, struct map, rb_node);
769 if (pos->end > map->start) {
771 if (pos->start <= map->start)
773 next = next->rb_left;
775 next = next->rb_right;
780 struct map *pos = rb_entry(next, struct map, rb_node);
781 next = rb_next(&pos->rb_node);
784 * Stop if current map starts after map->end.
785 * Maps are ordered by start: next will not overlap for sure.
787 if (pos->start >= map->end)
793 pr_debug("overlapping maps in %s (disable tui for more info)\n",
796 fputs("overlapping maps:\n", fp);
797 map__fprintf(map, fp);
798 map__fprintf(pos, fp);
802 rb_erase_init(&pos->rb_node, root);
804 * Now check if we need to create new maps for areas not
805 * overlapped by the new map:
807 if (map->start > pos->start) {
808 struct map *before = map__clone(pos);
810 if (before == NULL) {
815 before->end = map->start;
816 __maps__insert(maps, before);
817 if (verbose >= 2 && !use_browser)
818 map__fprintf(before, fp);
822 if (map->end < pos->end) {
823 struct map *after = map__clone(pos);
830 after->start = map->end;
831 after->pgoff += map->end - pos->start;
832 assert(pos->map_ip(pos, map->end) == after->map_ip(after, map->end));
833 __maps__insert(maps, after);
834 if (verbose >= 2 && !use_browser)
835 map__fprintf(after, fp);
847 up_write(&maps->lock);
852 * XXX This should not really _copy_ te maps, but refcount them.
854 int maps__clone(struct thread *thread, struct maps *parent)
856 struct maps *maps = thread->maps;
860 down_read(&parent->lock);
862 maps__for_each_entry(parent, map) {
863 struct map *new = map__clone(map);
867 err = unwind__prepare_access(maps, new, NULL);
871 maps__insert(maps, new);
877 up_read(&parent->lock);
881 static void __maps__insert(struct maps *maps, struct map *map)
883 struct rb_node **p = &maps->entries.rb_node;
884 struct rb_node *parent = NULL;
885 const u64 ip = map->start;
890 m = rb_entry(parent, struct map, rb_node);
897 rb_link_node(&map->rb_node, parent, p);
898 rb_insert_color(&map->rb_node, &maps->entries);
902 struct map *maps__find(struct maps *maps, u64 ip)
907 down_read(&maps->lock);
909 p = maps->entries.rb_node;
911 m = rb_entry(p, struct map, rb_node);
914 else if (ip >= m->end)
922 up_read(&maps->lock);
926 struct map *maps__first(struct maps *maps)
928 struct rb_node *first = rb_first(&maps->entries);
931 return rb_entry(first, struct map, rb_node);
935 static struct map *__map__next(struct map *map)
937 struct rb_node *next = rb_next(&map->rb_node);
940 return rb_entry(next, struct map, rb_node);
944 struct map *map__next(struct map *map)
946 return map ? __map__next(map) : NULL;
949 struct kmap *__map__kmap(struct map *map)
951 if (!map->dso || !map->dso->kernel)
953 return (struct kmap *)(map + 1);
956 struct kmap *map__kmap(struct map *map)
958 struct kmap *kmap = __map__kmap(map);
961 pr_err("Internal error: map__kmap with a non-kernel map\n");
965 struct maps *map__kmaps(struct map *map)
967 struct kmap *kmap = map__kmap(map);
969 if (!kmap || !kmap->kmaps) {
970 pr_err("Internal error: map__kmaps with a non-kernel map\n");