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, char *filename,
133 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);
206 * Constructor variant for modules (where we know from /proc/modules where
207 * they are loaded) and for vmlinux, where only after we load all the
208 * symbols we'll know where it starts and ends.
210 struct map *map__new2(u64 start, struct dso *dso)
212 struct map *map = calloc(1, (sizeof(*map) +
213 (dso->kernel ? sizeof(struct kmap) : 0)));
216 * ->end will be filled after we load all the symbols
218 map__init(map, start, 0, 0, dso);
224 bool __map__is_kernel(const struct map *map)
226 if (!map->dso->kernel)
228 return machine__kernel_map(map__kmaps((struct map *)map)->machine) == map;
231 bool __map__is_extra_kernel_map(const struct map *map)
233 struct kmap *kmap = __map__kmap((struct map *)map);
235 return kmap && kmap->name[0];
238 bool __map__is_bpf_prog(const struct map *map)
242 if (map->dso->binary_type == DSO_BINARY_TYPE__BPF_PROG_INFO)
246 * If PERF_RECORD_BPF_EVENT is not included, the dso will not have
247 * type of DSO_BINARY_TYPE__BPF_PROG_INFO. In such cases, we can
248 * guess the type based on name.
250 name = map->dso->short_name;
251 return name && (strstr(name, "bpf_prog_") == name);
254 bool __map__is_bpf_image(const struct map *map)
258 if (map->dso->binary_type == DSO_BINARY_TYPE__BPF_IMAGE)
262 * If PERF_RECORD_KSYMBOL is not included, the dso will not have
263 * type of DSO_BINARY_TYPE__BPF_IMAGE. In such cases, we can
264 * guess the type based on name.
266 name = map->dso->short_name;
267 return name && is_bpf_image(name);
270 bool __map__is_ool(const struct map *map)
272 return map->dso && map->dso->binary_type == DSO_BINARY_TYPE__OOL;
275 bool map__has_symbols(const struct map *map)
277 return dso__has_symbols(map->dso);
280 static void map__exit(struct map *map)
282 BUG_ON(refcount_read(&map->refcnt) != 0);
286 void map__delete(struct map *map)
292 void map__put(struct map *map)
294 if (map && refcount_dec_and_test(&map->refcnt))
298 void map__fixup_start(struct map *map)
300 struct rb_root_cached *symbols = &map->dso->symbols;
301 struct rb_node *nd = rb_first_cached(symbols);
303 struct symbol *sym = rb_entry(nd, struct symbol, rb_node);
304 map->start = sym->start;
308 void map__fixup_end(struct map *map)
310 struct rb_root_cached *symbols = &map->dso->symbols;
311 struct rb_node *nd = rb_last(&symbols->rb_root);
313 struct symbol *sym = rb_entry(nd, struct symbol, rb_node);
318 #define DSO__DELETED "(deleted)"
320 int map__load(struct map *map)
322 const char *name = map->dso->long_name;
325 if (dso__loaded(map->dso))
328 nr = dso__load(map->dso, map);
330 if (map->dso->has_build_id) {
331 char sbuild_id[SBUILD_ID_SIZE];
333 build_id__sprintf(&map->dso->bid, sbuild_id);
334 pr_debug("%s with build id %s not found", name, sbuild_id);
336 pr_debug("Failed to open %s", name);
338 pr_debug(", continuing without symbols\n");
340 } else if (nr == 0) {
341 #ifdef HAVE_LIBELF_SUPPORT
342 const size_t len = strlen(name);
343 const size_t real_len = len - sizeof(DSO__DELETED);
345 if (len > sizeof(DSO__DELETED) &&
346 strcmp(name + real_len + 1, DSO__DELETED) == 0) {
347 pr_debug("%.*s was updated (is prelink enabled?). "
348 "Restart the long running apps that use it!\n",
349 (int)real_len, name);
351 pr_debug("no symbols found in %s, maybe install a debug package?\n", name);
360 struct symbol *map__find_symbol(struct map *map, u64 addr)
362 if (map__load(map) < 0)
365 return dso__find_symbol(map->dso, addr);
368 struct symbol *map__find_symbol_by_name(struct map *map, const char *name)
370 if (map__load(map) < 0)
373 if (!dso__sorted_by_name(map->dso))
374 dso__sort_by_name(map->dso);
376 return dso__find_symbol_by_name(map->dso, name);
379 struct map *map__clone(struct map *from)
381 size_t size = sizeof(struct map);
384 if (from->dso && from->dso->kernel)
385 size += sizeof(struct kmap);
387 map = memdup(from, size);
389 refcount_set(&map->refcnt, 1);
390 RB_CLEAR_NODE(&map->rb_node);
397 size_t map__fprintf(struct map *map, FILE *fp)
399 return fprintf(fp, " %" PRIx64 "-%" PRIx64 " %" PRIx64 " %s\n",
400 map->start, map->end, map->pgoff, map->dso->name);
403 size_t map__fprintf_dsoname(struct map *map, FILE *fp)
405 char buf[symbol_conf.pad_output_len_dso + 1];
406 const char *dsoname = "[unknown]";
408 if (map && map->dso) {
409 if (symbol_conf.show_kernel_path && map->dso->long_name)
410 dsoname = map->dso->long_name;
412 dsoname = map->dso->name;
415 if (symbol_conf.pad_output_len_dso) {
416 scnprintf_pad(buf, symbol_conf.pad_output_len_dso, "%s", dsoname);
420 return fprintf(fp, "%s", dsoname);
423 char *map__srcline(struct map *map, u64 addr, struct symbol *sym)
426 return SRCLINE_UNKNOWN;
427 return get_srcline(map->dso, map__rip_2objdump(map, addr), sym, true, true, addr);
430 int map__fprintf_srcline(struct map *map, u64 addr, const char *prefix,
435 if (map && map->dso) {
436 char *srcline = map__srcline(map, addr, NULL);
437 if (strncmp(srcline, SRCLINE_UNKNOWN, strlen(SRCLINE_UNKNOWN)) != 0)
438 ret = fprintf(fp, "%s%s", prefix, srcline);
439 free_srcline(srcline);
444 void srccode_state_free(struct srccode_state *state)
446 zfree(&state->srcfile);
451 * map__rip_2objdump - convert symbol start address to objdump address.
453 * @rip: symbol start address
455 * objdump wants/reports absolute IPs for ET_EXEC, and RIPs for ET_DYN.
456 * map->dso->adjust_symbols==1 for ET_EXEC-like cases except ET_REL which is
457 * relative to section start.
459 * Return: Address suitable for passing to "objdump --start-address="
461 u64 map__rip_2objdump(struct map *map, u64 rip)
463 struct kmap *kmap = __map__kmap(map);
466 * vmlinux does not have program headers for PTI entry trampolines and
467 * kcore may not either. However the trampoline object code is on the
468 * main kernel map, so just use that instead.
470 if (kmap && is_entry_trampoline(kmap->name) && kmap->kmaps && kmap->kmaps->machine) {
471 struct map *kernel_map = machine__kernel_map(kmap->kmaps->machine);
477 if (!map->dso->adjust_symbols)
481 return rip - map->pgoff;
484 * kernel modules also have DSO_TYPE_USER in dso->kernel,
485 * but all kernel modules are ET_REL, so won't get here.
487 if (map->dso->kernel == DSO_SPACE__USER)
488 return rip + map->dso->text_offset;
490 return map->unmap_ip(map, rip) - map->reloc;
494 * map__objdump_2mem - convert objdump address to a memory address.
496 * @ip: objdump address
498 * Closely related to map__rip_2objdump(), this function takes an address from
499 * objdump and converts it to a memory address. Note this assumes that @map
500 * contains the address. To be sure the result is valid, check it forwards
501 * e.g. map__rip_2objdump(map->map_ip(map, map__objdump_2mem(map, ip))) == ip
503 * Return: Memory address.
505 u64 map__objdump_2mem(struct map *map, u64 ip)
507 if (!map->dso->adjust_symbols)
508 return map->unmap_ip(map, ip);
511 return map->unmap_ip(map, ip + map->pgoff);
514 * kernel modules also have DSO_TYPE_USER in dso->kernel,
515 * but all kernel modules are ET_REL, so won't get here.
517 if (map->dso->kernel == DSO_SPACE__USER)
518 return map->unmap_ip(map, ip - map->dso->text_offset);
520 return ip + map->reloc;
523 void maps__init(struct maps *maps, struct machine *machine)
525 maps->entries = RB_ROOT;
526 init_rwsem(&maps->lock);
527 maps->machine = machine;
528 maps->last_search_by_name = NULL;
530 maps->maps_by_name = NULL;
531 refcount_set(&maps->refcnt, 1);
534 static void __maps__free_maps_by_name(struct maps *maps)
537 * Free everything to try to do it from the rbtree in the next search
539 zfree(&maps->maps_by_name);
540 maps->nr_maps_allocated = 0;
543 void maps__insert(struct maps *maps, struct map *map)
545 down_write(&maps->lock);
546 __maps__insert(maps, map);
549 if (map->dso && map->dso->kernel) {
550 struct kmap *kmap = map__kmap(map);
555 pr_err("Internal error: kernel dso with non kernel map\n");
560 * If we already performed some search by name, then we need to add the just
561 * inserted map and resort.
563 if (maps->maps_by_name) {
564 if (maps->nr_maps > maps->nr_maps_allocated) {
565 int nr_allocate = maps->nr_maps * 2;
566 struct map **maps_by_name = realloc(maps->maps_by_name, nr_allocate * sizeof(map));
568 if (maps_by_name == NULL) {
569 __maps__free_maps_by_name(maps);
570 up_write(&maps->lock);
574 maps->maps_by_name = maps_by_name;
575 maps->nr_maps_allocated = nr_allocate;
577 maps->maps_by_name[maps->nr_maps - 1] = map;
578 __maps__sort_by_name(maps);
580 up_write(&maps->lock);
583 static void __maps__remove(struct maps *maps, struct map *map)
585 rb_erase_init(&map->rb_node, &maps->entries);
589 void maps__remove(struct maps *maps, struct map *map)
591 down_write(&maps->lock);
592 if (maps->last_search_by_name == map)
593 maps->last_search_by_name = NULL;
595 __maps__remove(maps, map);
597 if (maps->maps_by_name)
598 __maps__free_maps_by_name(maps);
599 up_write(&maps->lock);
602 static void __maps__purge(struct maps *maps)
604 struct map *pos, *next;
606 maps__for_each_entry_safe(maps, pos, next) {
607 rb_erase_init(&pos->rb_node, &maps->entries);
612 void maps__exit(struct maps *maps)
614 down_write(&maps->lock);
616 up_write(&maps->lock);
619 bool maps__empty(struct maps *maps)
621 return !maps__first(maps);
624 struct maps *maps__new(struct machine *machine)
626 struct maps *maps = zalloc(sizeof(*maps));
629 maps__init(maps, machine);
634 void maps__delete(struct maps *maps)
637 unwind__finish_access(maps);
641 void maps__put(struct maps *maps)
643 if (maps && refcount_dec_and_test(&maps->refcnt))
647 struct symbol *maps__find_symbol(struct maps *maps, u64 addr, struct map **mapp)
649 struct map *map = maps__find(maps, addr);
651 /* Ensure map is loaded before using map->map_ip */
652 if (map != NULL && map__load(map) >= 0) {
655 return map__find_symbol(map, map->map_ip(map, addr));
661 static bool map__contains_symbol(struct map *map, struct symbol *sym)
663 u64 ip = map->unmap_ip(map, sym->start);
665 return ip >= map->start && ip < map->end;
668 struct symbol *maps__find_symbol_by_name(struct maps *maps, const char *name, struct map **mapp)
673 down_read(&maps->lock);
675 maps__for_each_entry(maps, pos) {
676 sym = map__find_symbol_by_name(pos, name);
680 if (!map__contains_symbol(pos, sym)) {
691 up_read(&maps->lock);
695 int maps__find_ams(struct maps *maps, struct addr_map_symbol *ams)
697 if (ams->addr < ams->ms.map->start || ams->addr >= ams->ms.map->end) {
700 ams->ms.map = maps__find(maps, ams->addr);
701 if (ams->ms.map == NULL)
705 ams->al_addr = ams->ms.map->map_ip(ams->ms.map, ams->addr);
706 ams->ms.sym = map__find_symbol(ams->ms.map, ams->al_addr);
708 return ams->ms.sym ? 0 : -1;
711 size_t maps__fprintf(struct maps *maps, FILE *fp)
716 down_read(&maps->lock);
718 maps__for_each_entry(maps, pos) {
719 printed += fprintf(fp, "Map:");
720 printed += map__fprintf(pos, fp);
722 printed += dso__fprintf(pos->dso, fp);
723 printed += fprintf(fp, "--\n");
727 up_read(&maps->lock);
732 int maps__fixup_overlappings(struct maps *maps, struct map *map, FILE *fp)
734 struct rb_root *root;
735 struct rb_node *next, *first;
738 down_write(&maps->lock);
740 root = &maps->entries;
743 * Find first map where end > map->start.
744 * Same as find_vma() in kernel.
746 next = root->rb_node;
749 struct map *pos = rb_entry(next, struct map, rb_node);
751 if (pos->end > map->start) {
753 if (pos->start <= map->start)
755 next = next->rb_left;
757 next = next->rb_right;
762 struct map *pos = rb_entry(next, struct map, rb_node);
763 next = rb_next(&pos->rb_node);
766 * Stop if current map starts after map->end.
767 * Maps are ordered by start: next will not overlap for sure.
769 if (pos->start >= map->end)
775 pr_debug("overlapping maps in %s (disable tui for more info)\n",
778 fputs("overlapping maps:\n", fp);
779 map__fprintf(map, fp);
780 map__fprintf(pos, fp);
784 rb_erase_init(&pos->rb_node, root);
786 * Now check if we need to create new maps for areas not
787 * overlapped by the new map:
789 if (map->start > pos->start) {
790 struct map *before = map__clone(pos);
792 if (before == NULL) {
797 before->end = map->start;
798 __maps__insert(maps, before);
799 if (verbose >= 2 && !use_browser)
800 map__fprintf(before, fp);
804 if (map->end < pos->end) {
805 struct map *after = map__clone(pos);
812 after->start = map->end;
813 after->pgoff += map->end - pos->start;
814 assert(pos->map_ip(pos, map->end) == after->map_ip(after, map->end));
815 __maps__insert(maps, after);
816 if (verbose >= 2 && !use_browser)
817 map__fprintf(after, fp);
829 up_write(&maps->lock);
834 * XXX This should not really _copy_ te maps, but refcount them.
836 int maps__clone(struct thread *thread, struct maps *parent)
838 struct maps *maps = thread->maps;
842 down_read(&parent->lock);
844 maps__for_each_entry(parent, map) {
845 struct map *new = map__clone(map);
852 err = unwind__prepare_access(maps, new, NULL);
856 maps__insert(maps, new);
862 up_read(&parent->lock);
866 static void __maps__insert(struct maps *maps, struct map *map)
868 struct rb_node **p = &maps->entries.rb_node;
869 struct rb_node *parent = NULL;
870 const u64 ip = map->start;
875 m = rb_entry(parent, struct map, rb_node);
882 rb_link_node(&map->rb_node, parent, p);
883 rb_insert_color(&map->rb_node, &maps->entries);
887 struct map *maps__find(struct maps *maps, u64 ip)
892 down_read(&maps->lock);
894 p = maps->entries.rb_node;
896 m = rb_entry(p, struct map, rb_node);
899 else if (ip >= m->end)
907 up_read(&maps->lock);
911 struct map *maps__first(struct maps *maps)
913 struct rb_node *first = rb_first(&maps->entries);
916 return rb_entry(first, struct map, rb_node);
920 static struct map *__map__next(struct map *map)
922 struct rb_node *next = rb_next(&map->rb_node);
925 return rb_entry(next, struct map, rb_node);
929 struct map *map__next(struct map *map)
931 return map ? __map__next(map) : NULL;
934 struct kmap *__map__kmap(struct map *map)
936 if (!map->dso || !map->dso->kernel)
938 return (struct kmap *)(map + 1);
941 struct kmap *map__kmap(struct map *map)
943 struct kmap *kmap = __map__kmap(map);
946 pr_err("Internal error: map__kmap with a non-kernel map\n");
950 struct maps *map__kmaps(struct map *map)
952 struct kmap *kmap = map__kmap(map);
954 if (!kmap || !kmap->kmaps) {
955 pr_err("Internal error: map__kmaps with a non-kernel map\n");