9 #include "demangle-java.h"
10 #include "demangle-rust.h"
13 #include <symbol/kallsyms.h>
17 #define EM_AARCH64 183 /* ARM 64 bit */
20 typedef Elf64_Nhdr GElf_Nhdr;
22 #ifdef HAVE_CPLUS_DEMANGLE_SUPPORT
23 extern char *cplus_demangle(const char *, int);
25 static inline char *bfd_demangle(void __maybe_unused *v, const char *c, int i)
27 return cplus_demangle(c, i);
31 static inline char *bfd_demangle(void __maybe_unused *v,
32 const char __maybe_unused *c,
38 #define PACKAGE 'perf'
43 #ifndef HAVE_ELF_GETPHDRNUM_SUPPORT
44 static int elf_getphdrnum(Elf *elf, size_t *dst)
49 ehdr = gelf_getehdr(elf, &gehdr);
59 #ifndef HAVE_ELF_GETSHDRSTRNDX_SUPPORT
60 static int elf_getshdrstrndx(Elf *elf __maybe_unused, size_t *dst __maybe_unused)
62 pr_err("%s: update your libelf to > 0.140, this one lacks elf_getshdrstrndx().\n", __func__);
67 #ifndef NT_GNU_BUILD_ID
68 #define NT_GNU_BUILD_ID 3
72 * elf_symtab__for_each_symbol - iterate thru all the symbols
74 * @syms: struct elf_symtab instance to iterate
76 * @sym: GElf_Sym iterator
78 #define elf_symtab__for_each_symbol(syms, nr_syms, idx, sym) \
79 for (idx = 0, gelf_getsym(syms, idx, &sym);\
81 idx++, gelf_getsym(syms, idx, &sym))
83 static inline uint8_t elf_sym__type(const GElf_Sym *sym)
85 return GELF_ST_TYPE(sym->st_info);
89 #define STT_GNU_IFUNC 10
92 static inline int elf_sym__is_function(const GElf_Sym *sym)
94 return (elf_sym__type(sym) == STT_FUNC ||
95 elf_sym__type(sym) == STT_GNU_IFUNC) &&
97 sym->st_shndx != SHN_UNDEF;
100 static inline bool elf_sym__is_object(const GElf_Sym *sym)
102 return elf_sym__type(sym) == STT_OBJECT &&
104 sym->st_shndx != SHN_UNDEF;
107 static inline int elf_sym__is_label(const GElf_Sym *sym)
109 return elf_sym__type(sym) == STT_NOTYPE &&
111 sym->st_shndx != SHN_UNDEF &&
112 sym->st_shndx != SHN_ABS;
115 static bool elf_sym__is_a(GElf_Sym *sym, enum map_type type)
119 return elf_sym__is_function(sym);
121 return elf_sym__is_object(sym);
127 static inline const char *elf_sym__name(const GElf_Sym *sym,
128 const Elf_Data *symstrs)
130 return symstrs->d_buf + sym->st_name;
133 static inline const char *elf_sec__name(const GElf_Shdr *shdr,
134 const Elf_Data *secstrs)
136 return secstrs->d_buf + shdr->sh_name;
139 static inline int elf_sec__is_text(const GElf_Shdr *shdr,
140 const Elf_Data *secstrs)
142 return strstr(elf_sec__name(shdr, secstrs), "text") != NULL;
145 static inline bool elf_sec__is_data(const GElf_Shdr *shdr,
146 const Elf_Data *secstrs)
148 return strstr(elf_sec__name(shdr, secstrs), "data") != NULL;
151 static bool elf_sec__is_a(GElf_Shdr *shdr, Elf_Data *secstrs,
156 return elf_sec__is_text(shdr, secstrs);
158 return elf_sec__is_data(shdr, secstrs);
164 static size_t elf_addr_to_index(Elf *elf, GElf_Addr addr)
170 while ((sec = elf_nextscn(elf, sec)) != NULL) {
171 gelf_getshdr(sec, &shdr);
173 if ((addr >= shdr.sh_addr) &&
174 (addr < (shdr.sh_addr + shdr.sh_size)))
183 Elf_Scn *elf_section_by_name(Elf *elf, GElf_Ehdr *ep,
184 GElf_Shdr *shp, const char *name, size_t *idx)
189 /* Elf is corrupted/truncated, avoid calling elf_strptr. */
190 if (!elf_rawdata(elf_getscn(elf, ep->e_shstrndx), NULL))
193 while ((sec = elf_nextscn(elf, sec)) != NULL) {
196 gelf_getshdr(sec, shp);
197 str = elf_strptr(elf, ep->e_shstrndx, shp->sh_name);
198 if (str && !strcmp(name, str)) {
209 static bool want_demangle(bool is_kernel_sym)
211 return is_kernel_sym ? symbol_conf.demangle_kernel : symbol_conf.demangle;
214 static char *demangle_sym(struct dso *dso, int kmodule, const char *elf_name)
216 int demangle_flags = verbose ? (DMGL_PARAMS | DMGL_ANSI) : DMGL_NO_OPTS;
217 char *demangled = NULL;
220 * We need to figure out if the object was created from C++ sources
221 * DWARF DW_compile_unit has this, but we don't always have access
224 if (!want_demangle(dso->kernel || kmodule))
227 demangled = bfd_demangle(NULL, elf_name, demangle_flags);
228 if (demangled == NULL)
229 demangled = java_demangle_sym(elf_name, JAVA_DEMANGLE_NORET);
230 else if (rust_is_mangled(demangled))
232 * Input to Rust demangling is the BFD-demangled
233 * name which it Rust-demangles in place.
235 rust_demangle_sym(demangled);
240 #define elf_section__for_each_rel(reldata, pos, pos_mem, idx, nr_entries) \
241 for (idx = 0, pos = gelf_getrel(reldata, 0, &pos_mem); \
243 ++idx, pos = gelf_getrel(reldata, idx, &pos_mem))
245 #define elf_section__for_each_rela(reldata, pos, pos_mem, idx, nr_entries) \
246 for (idx = 0, pos = gelf_getrela(reldata, 0, &pos_mem); \
248 ++idx, pos = gelf_getrela(reldata, idx, &pos_mem))
251 * We need to check if we have a .dynsym, so that we can handle the
252 * .plt, synthesizing its symbols, that aren't on the symtabs (be it
253 * .dynsym or .symtab).
254 * And always look at the original dso, not at debuginfo packages, that
255 * have the PLT data stripped out (shdr_rel_plt.sh_type == SHT_NOBITS).
257 int dso__synthesize_plt_symbols(struct dso *dso, struct symsrc *ss, struct map *map)
259 uint32_t nr_rel_entries, idx;
264 GElf_Shdr shdr_rel_plt, shdr_dynsym;
265 Elf_Data *reldata, *syms, *symstrs;
266 Elf_Scn *scn_plt_rel, *scn_symstrs, *scn_dynsym;
269 char sympltname[1024];
271 int nr = 0, symidx, err = 0;
279 scn_dynsym = ss->dynsym;
280 shdr_dynsym = ss->dynshdr;
281 dynsym_idx = ss->dynsym_idx;
283 if (scn_dynsym == NULL)
286 scn_plt_rel = elf_section_by_name(elf, &ehdr, &shdr_rel_plt,
288 if (scn_plt_rel == NULL) {
289 scn_plt_rel = elf_section_by_name(elf, &ehdr, &shdr_rel_plt,
291 if (scn_plt_rel == NULL)
297 if (shdr_rel_plt.sh_link != dynsym_idx)
300 if (elf_section_by_name(elf, &ehdr, &shdr_plt, ".plt", NULL) == NULL)
304 * Fetch the relocation section to find the idxes to the GOT
305 * and the symbols in the .dynsym they refer to.
307 reldata = elf_getdata(scn_plt_rel, NULL);
311 syms = elf_getdata(scn_dynsym, NULL);
315 scn_symstrs = elf_getscn(elf, shdr_dynsym.sh_link);
316 if (scn_symstrs == NULL)
319 symstrs = elf_getdata(scn_symstrs, NULL);
323 if (symstrs->d_size == 0)
326 nr_rel_entries = shdr_rel_plt.sh_size / shdr_rel_plt.sh_entsize;
327 plt_offset = shdr_plt.sh_offset;
329 if (shdr_rel_plt.sh_type == SHT_RELA) {
330 GElf_Rela pos_mem, *pos;
332 elf_section__for_each_rela(reldata, pos, pos_mem, idx,
334 const char *elf_name = NULL;
335 char *demangled = NULL;
336 symidx = GELF_R_SYM(pos->r_info);
337 plt_offset += shdr_plt.sh_entsize;
338 gelf_getsym(syms, symidx, &sym);
340 elf_name = elf_sym__name(&sym, symstrs);
341 demangled = demangle_sym(dso, 0, elf_name);
342 if (demangled != NULL)
343 elf_name = demangled;
344 snprintf(sympltname, sizeof(sympltname),
348 f = symbol__new(plt_offset, shdr_plt.sh_entsize,
349 STB_GLOBAL, sympltname);
353 symbols__insert(&dso->symbols[map->type], f);
356 } else if (shdr_rel_plt.sh_type == SHT_REL) {
357 GElf_Rel pos_mem, *pos;
358 elf_section__for_each_rel(reldata, pos, pos_mem, idx,
360 const char *elf_name = NULL;
361 char *demangled = NULL;
362 symidx = GELF_R_SYM(pos->r_info);
363 plt_offset += shdr_plt.sh_entsize;
364 gelf_getsym(syms, symidx, &sym);
366 elf_name = elf_sym__name(&sym, symstrs);
367 demangled = demangle_sym(dso, 0, elf_name);
368 if (demangled != NULL)
369 elf_name = demangled;
370 snprintf(sympltname, sizeof(sympltname),
374 f = symbol__new(plt_offset, shdr_plt.sh_entsize,
375 STB_GLOBAL, sympltname);
379 symbols__insert(&dso->symbols[map->type], f);
388 pr_debug("%s: problems reading %s PLT info.\n",
389 __func__, dso->long_name);
394 * Align offset to 4 bytes as needed for note name and descriptor data.
396 #define NOTE_ALIGN(n) (((n) + 3) & -4U)
398 static int elf_read_build_id(Elf *elf, void *bf, size_t size)
408 if (size < BUILD_ID_SIZE)
415 if (gelf_getehdr(elf, &ehdr) == NULL) {
416 pr_err("%s: cannot get elf header.\n", __func__);
421 * Check following sections for notes:
422 * '.note.gnu.build-id'
424 * '.note' (VDSO specific)
427 sec = elf_section_by_name(elf, &ehdr, &shdr,
428 ".note.gnu.build-id", NULL);
432 sec = elf_section_by_name(elf, &ehdr, &shdr,
437 sec = elf_section_by_name(elf, &ehdr, &shdr,
446 data = elf_getdata(sec, NULL);
451 while (ptr < (data->d_buf + data->d_size)) {
452 GElf_Nhdr *nhdr = ptr;
453 size_t namesz = NOTE_ALIGN(nhdr->n_namesz),
454 descsz = NOTE_ALIGN(nhdr->n_descsz);
457 ptr += sizeof(*nhdr);
460 if (nhdr->n_type == NT_GNU_BUILD_ID &&
461 nhdr->n_namesz == sizeof("GNU")) {
462 if (memcmp(name, "GNU", sizeof("GNU")) == 0) {
463 size_t sz = min(size, descsz);
465 memset(bf + sz, 0, size - sz);
477 int filename__read_build_id(const char *filename, void *bf, size_t size)
482 if (size < BUILD_ID_SIZE)
485 fd = open(filename, O_RDONLY);
489 elf = elf_begin(fd, PERF_ELF_C_READ_MMAP, NULL);
491 pr_debug2("%s: cannot read %s ELF file.\n", __func__, filename);
495 err = elf_read_build_id(elf, bf, size);
504 int sysfs__read_build_id(const char *filename, void *build_id, size_t size)
508 if (size < BUILD_ID_SIZE)
511 fd = open(filename, O_RDONLY);
518 size_t namesz, descsz;
520 if (read(fd, &nhdr, sizeof(nhdr)) != sizeof(nhdr))
523 namesz = NOTE_ALIGN(nhdr.n_namesz);
524 descsz = NOTE_ALIGN(nhdr.n_descsz);
525 if (nhdr.n_type == NT_GNU_BUILD_ID &&
526 nhdr.n_namesz == sizeof("GNU")) {
527 if (read(fd, bf, namesz) != (ssize_t)namesz)
529 if (memcmp(bf, "GNU", sizeof("GNU")) == 0) {
530 size_t sz = min(descsz, size);
531 if (read(fd, build_id, sz) == (ssize_t)sz) {
532 memset(build_id + sz, 0, size - sz);
536 } else if (read(fd, bf, descsz) != (ssize_t)descsz)
539 int n = namesz + descsz;
540 if (read(fd, bf, n) != n)
549 int filename__read_debuglink(const char *filename, char *debuglink,
560 fd = open(filename, O_RDONLY);
564 elf = elf_begin(fd, PERF_ELF_C_READ_MMAP, NULL);
566 pr_debug2("%s: cannot read %s ELF file.\n", __func__, filename);
574 if (gelf_getehdr(elf, &ehdr) == NULL) {
575 pr_err("%s: cannot get elf header.\n", __func__);
579 sec = elf_section_by_name(elf, &ehdr, &shdr,
580 ".gnu_debuglink", NULL);
584 data = elf_getdata(sec, NULL);
588 /* the start of this section is a zero-terminated string */
589 strncpy(debuglink, data->d_buf, size);
601 static int dso__swap_init(struct dso *dso, unsigned char eidata)
603 static unsigned int const endian = 1;
605 dso->needs_swap = DSO_SWAP__NO;
609 /* We are big endian, DSO is little endian. */
610 if (*(unsigned char const *)&endian != 1)
611 dso->needs_swap = DSO_SWAP__YES;
615 /* We are little endian, DSO is big endian. */
616 if (*(unsigned char const *)&endian != 0)
617 dso->needs_swap = DSO_SWAP__YES;
621 pr_err("unrecognized DSO data encoding %d\n", eidata);
628 static int decompress_kmodule(struct dso *dso, const char *name,
629 enum dso_binary_type type)
632 char tmpbuf[] = "/tmp/perf-kmod-XXXXXX";
635 if (type != DSO_BINARY_TYPE__SYSTEM_PATH_KMODULE_COMP &&
636 type != DSO_BINARY_TYPE__GUEST_KMODULE_COMP &&
637 type != DSO_BINARY_TYPE__BUILD_ID_CACHE)
640 if (type == DSO_BINARY_TYPE__BUILD_ID_CACHE)
641 name = dso->long_name;
643 if (kmod_path__parse_ext(&m, name) || !m.comp)
646 fd = mkstemp(tmpbuf);
648 dso->load_errno = errno;
652 if (!decompress_to_file(m.ext, name, fd)) {
653 dso->load_errno = DSO_LOAD_ERRNO__DECOMPRESSION_FAILURE;
665 bool symsrc__possibly_runtime(struct symsrc *ss)
667 return ss->dynsym || ss->opdsec;
670 bool symsrc__has_symtab(struct symsrc *ss)
672 return ss->symtab != NULL;
675 void symsrc__destroy(struct symsrc *ss)
682 bool __weak elf__needs_adjust_symbols(GElf_Ehdr ehdr)
684 return ehdr.e_type == ET_EXEC || ehdr.e_type == ET_REL;
687 int symsrc__init(struct symsrc *ss, struct dso *dso, const char *name,
688 enum dso_binary_type type)
695 if (dso__needs_decompress(dso)) {
696 fd = decompress_kmodule(dso, name, type);
700 fd = open(name, O_RDONLY);
702 dso->load_errno = errno;
707 elf = elf_begin(fd, PERF_ELF_C_READ_MMAP, NULL);
709 pr_debug("%s: cannot read %s ELF file.\n", __func__, name);
710 dso->load_errno = DSO_LOAD_ERRNO__INVALID_ELF;
714 if (gelf_getehdr(elf, &ehdr) == NULL) {
715 dso->load_errno = DSO_LOAD_ERRNO__INVALID_ELF;
716 pr_debug("%s: cannot get elf header.\n", __func__);
720 if (dso__swap_init(dso, ehdr.e_ident[EI_DATA])) {
721 dso->load_errno = DSO_LOAD_ERRNO__INTERNAL_ERROR;
725 /* Always reject images with a mismatched build-id: */
726 if (dso->has_build_id && !symbol_conf.ignore_vmlinux_buildid) {
727 u8 build_id[BUILD_ID_SIZE];
729 if (elf_read_build_id(elf, build_id, BUILD_ID_SIZE) < 0) {
730 dso->load_errno = DSO_LOAD_ERRNO__CANNOT_READ_BUILDID;
734 if (!dso__build_id_equal(dso, build_id)) {
735 pr_debug("%s: build id mismatch for %s.\n", __func__, name);
736 dso->load_errno = DSO_LOAD_ERRNO__MISMATCHING_BUILDID;
741 ss->is_64_bit = (gelf_getclass(elf) == ELFCLASS64);
743 ss->symtab = elf_section_by_name(elf, &ehdr, &ss->symshdr, ".symtab",
745 if (ss->symshdr.sh_type != SHT_SYMTAB)
749 ss->dynsym = elf_section_by_name(elf, &ehdr, &ss->dynshdr, ".dynsym",
751 if (ss->dynshdr.sh_type != SHT_DYNSYM)
755 ss->opdsec = elf_section_by_name(elf, &ehdr, &ss->opdshdr, ".opd",
757 if (ss->opdshdr.sh_type != SHT_PROGBITS)
760 if (dso->kernel == DSO_TYPE_USER)
761 ss->adjust_symbols = true;
763 ss->adjust_symbols = elf__needs_adjust_symbols(ehdr);
765 ss->name = strdup(name);
767 dso->load_errno = errno;
786 * ref_reloc_sym_not_found - has kernel relocation symbol been found.
787 * @kmap: kernel maps and relocation reference symbol
789 * This function returns %true if we are dealing with the kernel maps and the
790 * relocation reference symbol has not yet been found. Otherwise %false is
793 static bool ref_reloc_sym_not_found(struct kmap *kmap)
795 return kmap && kmap->ref_reloc_sym && kmap->ref_reloc_sym->name &&
796 !kmap->ref_reloc_sym->unrelocated_addr;
800 * ref_reloc - kernel relocation offset.
801 * @kmap: kernel maps and relocation reference symbol
803 * This function returns the offset of kernel addresses as determined by using
804 * the relocation reference symbol i.e. if the kernel has not been relocated
805 * then the return value is zero.
807 static u64 ref_reloc(struct kmap *kmap)
809 if (kmap && kmap->ref_reloc_sym &&
810 kmap->ref_reloc_sym->unrelocated_addr)
811 return kmap->ref_reloc_sym->addr -
812 kmap->ref_reloc_sym->unrelocated_addr;
816 void __weak arch__sym_update(struct symbol *s __maybe_unused,
817 GElf_Sym *sym __maybe_unused) { }
819 int dso__load_sym(struct dso *dso, struct map *map, struct symsrc *syms_ss,
820 struct symsrc *runtime_ss, int kmodule)
822 struct kmap *kmap = dso->kernel ? map__kmap(map) : NULL;
823 struct map_groups *kmaps = kmap ? map__kmaps(map) : NULL;
824 struct map *curr_map = map;
825 struct dso *curr_dso = dso;
826 Elf_Data *symstrs, *secstrs;
833 Elf_Data *syms, *opddata = NULL;
835 Elf_Scn *sec, *sec_strndx;
838 bool remap_kernel = false, adjust_kernel_syms = false;
843 dso->symtab_type = syms_ss->type;
844 dso->is_64_bit = syms_ss->is_64_bit;
845 dso->rel = syms_ss->ehdr.e_type == ET_REL;
848 * Modules may already have symbols from kallsyms, but those symbols
849 * have the wrong values for the dso maps, so remove them.
851 if (kmodule && syms_ss->symtab)
852 symbols__delete(&dso->symbols[map->type]);
854 if (!syms_ss->symtab) {
856 * If the vmlinux is stripped, fail so we will fall back
857 * to using kallsyms. The vmlinux runtime symbols aren't
863 syms_ss->symtab = syms_ss->dynsym;
864 syms_ss->symshdr = syms_ss->dynshdr;
868 ehdr = syms_ss->ehdr;
869 sec = syms_ss->symtab;
870 shdr = syms_ss->symshdr;
872 if (elf_section_by_name(runtime_ss->elf, &runtime_ss->ehdr, &tshdr,
874 dso->text_offset = tshdr.sh_addr - tshdr.sh_offset;
876 if (runtime_ss->opdsec)
877 opddata = elf_rawdata(runtime_ss->opdsec, NULL);
879 syms = elf_getdata(sec, NULL);
883 sec = elf_getscn(elf, shdr.sh_link);
887 symstrs = elf_getdata(sec, NULL);
891 sec_strndx = elf_getscn(runtime_ss->elf, runtime_ss->ehdr.e_shstrndx);
892 if (sec_strndx == NULL)
895 secstrs = elf_getdata(sec_strndx, NULL);
899 nr_syms = shdr.sh_size / shdr.sh_entsize;
901 memset(&sym, 0, sizeof(sym));
904 * The kernel relocation symbol is needed in advance in order to adjust
905 * kernel maps correctly.
907 if (ref_reloc_sym_not_found(kmap)) {
908 elf_symtab__for_each_symbol(syms, nr_syms, idx, sym) {
909 const char *elf_name = elf_sym__name(&sym, symstrs);
911 if (strcmp(elf_name, kmap->ref_reloc_sym->name))
913 kmap->ref_reloc_sym->unrelocated_addr = sym.st_value;
914 map->reloc = kmap->ref_reloc_sym->addr -
915 kmap->ref_reloc_sym->unrelocated_addr;
921 * Handle any relocation of vdso necessary because older kernels
922 * attempted to prelink vdso to its virtual address.
924 if (dso__is_vdso(dso))
925 map->reloc = map->start - dso->text_offset;
927 dso->adjust_symbols = runtime_ss->adjust_symbols || ref_reloc(kmap);
929 * Initial kernel and module mappings do not map to the dso. For
930 * function mappings, flag the fixups.
932 if (map->type == MAP__FUNCTION && (dso->kernel || kmodule)) {
934 adjust_kernel_syms = dso->adjust_symbols;
936 elf_symtab__for_each_symbol(syms, nr_syms, idx, sym) {
938 const char *elf_name = elf_sym__name(&sym, symstrs);
939 char *demangled = NULL;
940 int is_label = elf_sym__is_label(&sym);
941 const char *section_name;
942 bool used_opd = false;
944 if (!is_label && !elf_sym__is_a(&sym, map->type))
947 /* Reject ARM ELF "mapping symbols": these aren't unique and
948 * don't identify functions, so will confuse the profile
950 if (ehdr.e_machine == EM_ARM || ehdr.e_machine == EM_AARCH64) {
951 if (elf_name[0] == '$' && strchr("adtx", elf_name[1])
952 && (elf_name[2] == '\0' || elf_name[2] == '.'))
956 if (runtime_ss->opdsec && sym.st_shndx == runtime_ss->opdidx) {
957 u32 offset = sym.st_value - syms_ss->opdshdr.sh_addr;
958 u64 *opd = opddata->d_buf + offset;
959 sym.st_value = DSO__SWAP(dso, u64, *opd);
960 sym.st_shndx = elf_addr_to_index(runtime_ss->elf,
965 * When loading symbols in a data mapping, ABS symbols (which
966 * has a value of SHN_ABS in its st_shndx) failed at
967 * elf_getscn(). And it marks the loading as a failure so
968 * already loaded symbols cannot be fixed up.
970 * I'm not sure what should be done. Just ignore them for now.
973 if (sym.st_shndx == SHN_ABS)
976 sec = elf_getscn(runtime_ss->elf, sym.st_shndx);
980 gelf_getshdr(sec, &shdr);
982 if (is_label && !elf_sec__is_a(&shdr, secstrs, map->type))
985 section_name = elf_sec__name(&shdr, secstrs);
987 /* On ARM, symbols for thumb functions have 1 added to
988 * the symbol address as a flag - remove it */
989 if ((ehdr.e_machine == EM_ARM) &&
990 (map->type == MAP__FUNCTION) &&
994 if (dso->kernel || kmodule) {
995 char dso_name[PATH_MAX];
997 /* Adjust symbol to map to file offset */
998 if (adjust_kernel_syms)
999 sym.st_value -= shdr.sh_addr - shdr.sh_offset;
1001 if (strcmp(section_name,
1002 (curr_dso->short_name +
1003 dso->short_name_len)) == 0)
1006 if (strcmp(section_name, ".text") == 0) {
1008 * The initial kernel mapping is based on
1009 * kallsyms and identity maps. Overwrite it to
1010 * map to the kernel dso.
1012 if (remap_kernel && dso->kernel) {
1013 remap_kernel = false;
1014 map->start = shdr.sh_addr +
1016 map->end = map->start + shdr.sh_size;
1017 map->pgoff = shdr.sh_offset;
1018 map->map_ip = map__map_ip;
1019 map->unmap_ip = map__unmap_ip;
1020 /* Ensure maps are correctly ordered */
1023 map_groups__remove(kmaps, map);
1024 map_groups__insert(kmaps, map);
1030 * The initial module mapping is based on
1031 * /proc/modules mapped to offset zero.
1032 * Overwrite it to map to the module dso.
1034 if (remap_kernel && kmodule) {
1035 remap_kernel = false;
1036 map->pgoff = shdr.sh_offset;
1047 snprintf(dso_name, sizeof(dso_name),
1048 "%s%s", dso->short_name, section_name);
1050 curr_map = map_groups__find_by_name(kmaps, map->type, dso_name);
1051 if (curr_map == NULL) {
1052 u64 start = sym.st_value;
1055 start += map->start + shdr.sh_offset;
1057 curr_dso = dso__new(dso_name);
1058 if (curr_dso == NULL)
1060 curr_dso->kernel = dso->kernel;
1061 curr_dso->long_name = dso->long_name;
1062 curr_dso->long_name_len = dso->long_name_len;
1063 curr_map = map__new2(start, curr_dso,
1066 if (curr_map == NULL) {
1069 if (adjust_kernel_syms) {
1070 curr_map->start = shdr.sh_addr +
1072 curr_map->end = curr_map->start +
1074 curr_map->pgoff = shdr.sh_offset;
1076 curr_map->map_ip = identity__map_ip;
1077 curr_map->unmap_ip = identity__map_ip;
1079 curr_dso->symtab_type = dso->symtab_type;
1080 map_groups__insert(kmaps, curr_map);
1082 * Add it before we drop the referece to curr_map,
1083 * i.e. while we still are sure to have a reference
1084 * to this DSO via curr_map->dso.
1086 dsos__add(&map->groups->machine->dsos, curr_dso);
1087 /* kmaps already got it */
1089 dso__set_loaded(curr_dso, map->type);
1091 curr_dso = curr_map->dso;
1096 if ((used_opd && runtime_ss->adjust_symbols)
1097 || (!used_opd && syms_ss->adjust_symbols)) {
1098 pr_debug4("%s: adjusting symbol: st_value: %#" PRIx64 " "
1099 "sh_addr: %#" PRIx64 " sh_offset: %#" PRIx64 "\n", __func__,
1100 (u64)sym.st_value, (u64)shdr.sh_addr,
1101 (u64)shdr.sh_offset);
1102 sym.st_value -= shdr.sh_addr - shdr.sh_offset;
1105 demangled = demangle_sym(dso, kmodule, elf_name);
1106 if (demangled != NULL)
1107 elf_name = demangled;
1109 f = symbol__new(sym.st_value, sym.st_size,
1110 GELF_ST_BIND(sym.st_info), elf_name);
1115 arch__sym_update(f, &sym);
1117 __symbols__insert(&curr_dso->symbols[curr_map->type], f, dso->kernel);
1122 * For misannotated, zeroed, ASM function sizes.
1125 symbols__fixup_end(&dso->symbols[map->type]);
1126 symbols__fixup_duplicate(&dso->symbols[map->type]);
1129 * We need to fixup this here too because we create new
1130 * maps here, for things like vsyscall sections.
1132 __map_groups__fixup_end(kmaps, map->type);
1140 static int elf_read_maps(Elf *elf, bool exe, mapfn_t mapfn, void *data)
1147 if (elf_getphdrnum(elf, &phdrnum))
1150 for (i = 0; i < phdrnum; i++) {
1151 if (gelf_getphdr(elf, i, &phdr) == NULL)
1153 if (phdr.p_type != PT_LOAD)
1156 if (!(phdr.p_flags & PF_X))
1159 if (!(phdr.p_flags & PF_R))
1162 sz = min(phdr.p_memsz, phdr.p_filesz);
1165 err = mapfn(phdr.p_vaddr, sz, phdr.p_offset, data);
1172 int file__read_maps(int fd, bool exe, mapfn_t mapfn, void *data,
1178 elf = elf_begin(fd, PERF_ELF_C_READ_MMAP, NULL);
1183 *is_64_bit = (gelf_getclass(elf) == ELFCLASS64);
1185 err = elf_read_maps(elf, exe, mapfn, data);
1191 enum dso_type dso__type_fd(int fd)
1193 enum dso_type dso_type = DSO__TYPE_UNKNOWN;
1198 elf = elf_begin(fd, PERF_ELF_C_READ_MMAP, NULL);
1203 if (ek != ELF_K_ELF)
1206 if (gelf_getclass(elf) == ELFCLASS64) {
1207 dso_type = DSO__TYPE_64BIT;
1211 if (gelf_getehdr(elf, &ehdr) == NULL)
1214 if (ehdr.e_machine == EM_X86_64)
1215 dso_type = DSO__TYPE_X32BIT;
1217 dso_type = DSO__TYPE_32BIT;
1224 static int copy_bytes(int from, off_t from_offs, int to, off_t to_offs, u64 len)
1229 char *buf = malloc(page_size);
1234 if (lseek(to, to_offs, SEEK_SET) != to_offs)
1237 if (lseek(from, from_offs, SEEK_SET) != from_offs)
1244 /* Use read because mmap won't work on proc files */
1245 r = read(from, buf, n);
1251 r = write(to, buf, n);
1272 static int kcore__open(struct kcore *kcore, const char *filename)
1276 kcore->fd = open(filename, O_RDONLY);
1277 if (kcore->fd == -1)
1280 kcore->elf = elf_begin(kcore->fd, ELF_C_READ, NULL);
1284 kcore->elfclass = gelf_getclass(kcore->elf);
1285 if (kcore->elfclass == ELFCLASSNONE)
1288 ehdr = gelf_getehdr(kcore->elf, &kcore->ehdr);
1295 elf_end(kcore->elf);
1301 static int kcore__init(struct kcore *kcore, char *filename, int elfclass,
1304 kcore->elfclass = elfclass;
1307 kcore->fd = mkstemp(filename);
1309 kcore->fd = open(filename, O_WRONLY | O_CREAT | O_EXCL, 0400);
1310 if (kcore->fd == -1)
1313 kcore->elf = elf_begin(kcore->fd, ELF_C_WRITE, NULL);
1317 if (!gelf_newehdr(kcore->elf, elfclass))
1320 memset(&kcore->ehdr, 0, sizeof(GElf_Ehdr));
1325 elf_end(kcore->elf);
1332 static void kcore__close(struct kcore *kcore)
1334 elf_end(kcore->elf);
1338 static int kcore__copy_hdr(struct kcore *from, struct kcore *to, size_t count)
1340 GElf_Ehdr *ehdr = &to->ehdr;
1341 GElf_Ehdr *kehdr = &from->ehdr;
1343 memcpy(ehdr->e_ident, kehdr->e_ident, EI_NIDENT);
1344 ehdr->e_type = kehdr->e_type;
1345 ehdr->e_machine = kehdr->e_machine;
1346 ehdr->e_version = kehdr->e_version;
1349 ehdr->e_flags = kehdr->e_flags;
1350 ehdr->e_phnum = count;
1351 ehdr->e_shentsize = 0;
1353 ehdr->e_shstrndx = 0;
1355 if (from->elfclass == ELFCLASS32) {
1356 ehdr->e_phoff = sizeof(Elf32_Ehdr);
1357 ehdr->e_ehsize = sizeof(Elf32_Ehdr);
1358 ehdr->e_phentsize = sizeof(Elf32_Phdr);
1360 ehdr->e_phoff = sizeof(Elf64_Ehdr);
1361 ehdr->e_ehsize = sizeof(Elf64_Ehdr);
1362 ehdr->e_phentsize = sizeof(Elf64_Phdr);
1365 if (!gelf_update_ehdr(to->elf, ehdr))
1368 if (!gelf_newphdr(to->elf, count))
1374 static int kcore__add_phdr(struct kcore *kcore, int idx, off_t offset,
1379 .p_flags = PF_R | PF_W | PF_X,
1385 .p_align = page_size,
1388 if (!gelf_update_phdr(kcore->elf, idx, &phdr))
1394 static off_t kcore__write(struct kcore *kcore)
1396 return elf_update(kcore->elf, ELF_C_WRITE);
1405 struct kcore_copy_info {
1411 u64 last_module_symbol;
1412 struct phdr_data kernel_map;
1413 struct phdr_data modules_map;
1416 static int kcore_copy__process_kallsyms(void *arg, const char *name, char type,
1419 struct kcore_copy_info *kci = arg;
1421 if (!symbol_type__is_a(type, MAP__FUNCTION))
1424 if (strchr(name, '[')) {
1425 if (start > kci->last_module_symbol)
1426 kci->last_module_symbol = start;
1430 if (!kci->first_symbol || start < kci->first_symbol)
1431 kci->first_symbol = start;
1433 if (!kci->last_symbol || start > kci->last_symbol)
1434 kci->last_symbol = start;
1436 if (!strcmp(name, "_stext")) {
1441 if (!strcmp(name, "_etext")) {
1449 static int kcore_copy__parse_kallsyms(struct kcore_copy_info *kci,
1452 char kallsyms_filename[PATH_MAX];
1454 scnprintf(kallsyms_filename, PATH_MAX, "%s/kallsyms", dir);
1456 if (symbol__restricted_filename(kallsyms_filename, "/proc/kallsyms"))
1459 if (kallsyms__parse(kallsyms_filename, kci,
1460 kcore_copy__process_kallsyms) < 0)
1466 static int kcore_copy__process_modules(void *arg,
1467 const char *name __maybe_unused,
1470 struct kcore_copy_info *kci = arg;
1472 if (!kci->first_module || start < kci->first_module)
1473 kci->first_module = start;
1478 static int kcore_copy__parse_modules(struct kcore_copy_info *kci,
1481 char modules_filename[PATH_MAX];
1483 scnprintf(modules_filename, PATH_MAX, "%s/modules", dir);
1485 if (symbol__restricted_filename(modules_filename, "/proc/modules"))
1488 if (modules__parse(modules_filename, kci,
1489 kcore_copy__process_modules) < 0)
1495 static void kcore_copy__map(struct phdr_data *p, u64 start, u64 end, u64 pgoff,
1498 if (p->addr || s < start || s >= end)
1502 p->offset = (s - start) + pgoff;
1503 p->len = e < end ? e - s : end - s;
1506 static int kcore_copy__read_map(u64 start, u64 len, u64 pgoff, void *data)
1508 struct kcore_copy_info *kci = data;
1509 u64 end = start + len;
1511 kcore_copy__map(&kci->kernel_map, start, end, pgoff, kci->stext,
1514 kcore_copy__map(&kci->modules_map, start, end, pgoff, kci->first_module,
1515 kci->last_module_symbol);
1520 static int kcore_copy__read_maps(struct kcore_copy_info *kci, Elf *elf)
1522 if (elf_read_maps(elf, true, kcore_copy__read_map, kci) < 0)
1528 static int kcore_copy__calc_maps(struct kcore_copy_info *kci, const char *dir,
1531 if (kcore_copy__parse_kallsyms(kci, dir))
1534 if (kcore_copy__parse_modules(kci, dir))
1538 kci->stext = round_down(kci->stext, page_size);
1540 kci->stext = round_down(kci->first_symbol, page_size);
1543 kci->etext = round_up(kci->etext, page_size);
1544 } else if (kci->last_symbol) {
1545 kci->etext = round_up(kci->last_symbol, page_size);
1546 kci->etext += page_size;
1549 kci->first_module = round_down(kci->first_module, page_size);
1551 if (kci->last_module_symbol) {
1552 kci->last_module_symbol = round_up(kci->last_module_symbol,
1554 kci->last_module_symbol += page_size;
1557 if (!kci->stext || !kci->etext)
1560 if (kci->first_module && !kci->last_module_symbol)
1563 return kcore_copy__read_maps(kci, elf);
1566 static int kcore_copy__copy_file(const char *from_dir, const char *to_dir,
1569 char from_filename[PATH_MAX];
1570 char to_filename[PATH_MAX];
1572 scnprintf(from_filename, PATH_MAX, "%s/%s", from_dir, name);
1573 scnprintf(to_filename, PATH_MAX, "%s/%s", to_dir, name);
1575 return copyfile_mode(from_filename, to_filename, 0400);
1578 static int kcore_copy__unlink(const char *dir, const char *name)
1580 char filename[PATH_MAX];
1582 scnprintf(filename, PATH_MAX, "%s/%s", dir, name);
1584 return unlink(filename);
1587 static int kcore_copy__compare_fds(int from, int to)
1595 buf_from = malloc(page_size);
1596 buf_to = malloc(page_size);
1597 if (!buf_from || !buf_to)
1601 /* Use read because mmap won't work on proc files */
1602 ret = read(from, buf_from, page_size);
1611 if (readn(to, buf_to, len) != (int)len)
1614 if (memcmp(buf_from, buf_to, len))
1625 static int kcore_copy__compare_files(const char *from_filename,
1626 const char *to_filename)
1628 int from, to, err = -1;
1630 from = open(from_filename, O_RDONLY);
1634 to = open(to_filename, O_RDONLY);
1636 goto out_close_from;
1638 err = kcore_copy__compare_fds(from, to);
1646 static int kcore_copy__compare_file(const char *from_dir, const char *to_dir,
1649 char from_filename[PATH_MAX];
1650 char to_filename[PATH_MAX];
1652 scnprintf(from_filename, PATH_MAX, "%s/%s", from_dir, name);
1653 scnprintf(to_filename, PATH_MAX, "%s/%s", to_dir, name);
1655 return kcore_copy__compare_files(from_filename, to_filename);
1659 * kcore_copy - copy kallsyms, modules and kcore from one directory to another.
1660 * @from_dir: from directory
1661 * @to_dir: to directory
1663 * This function copies kallsyms, modules and kcore files from one directory to
1664 * another. kallsyms and modules are copied entirely. Only code segments are
1665 * copied from kcore. It is assumed that two segments suffice: one for the
1666 * kernel proper and one for all the modules. The code segments are determined
1667 * from kallsyms and modules files. The kernel map starts at _stext or the
1668 * lowest function symbol, and ends at _etext or the highest function symbol.
1669 * The module map starts at the lowest module address and ends at the highest
1670 * module symbol. Start addresses are rounded down to the nearest page. End
1671 * addresses are rounded up to the nearest page. An extra page is added to the
1672 * highest kernel symbol and highest module symbol to, hopefully, encompass that
1673 * symbol too. Because it contains only code sections, the resulting kcore is
1674 * unusual. One significant peculiarity is that the mapping (start -> pgoff)
1675 * is not the same for the kernel map and the modules map. That happens because
1676 * the data is copied adjacently whereas the original kcore has gaps. Finally,
1677 * kallsyms and modules files are compared with their copies to check that
1678 * modules have not been loaded or unloaded while the copies were taking place.
1680 * Return: %0 on success, %-1 on failure.
1682 int kcore_copy(const char *from_dir, const char *to_dir)
1685 struct kcore extract;
1687 int idx = 0, err = -1;
1688 off_t offset = page_size, sz, modules_offset = 0;
1689 struct kcore_copy_info kci = { .stext = 0, };
1690 char kcore_filename[PATH_MAX];
1691 char extract_filename[PATH_MAX];
1693 if (kcore_copy__copy_file(from_dir, to_dir, "kallsyms"))
1696 if (kcore_copy__copy_file(from_dir, to_dir, "modules"))
1697 goto out_unlink_kallsyms;
1699 scnprintf(kcore_filename, PATH_MAX, "%s/kcore", from_dir);
1700 scnprintf(extract_filename, PATH_MAX, "%s/kcore", to_dir);
1702 if (kcore__open(&kcore, kcore_filename))
1703 goto out_unlink_modules;
1705 if (kcore_copy__calc_maps(&kci, from_dir, kcore.elf))
1706 goto out_kcore_close;
1708 if (kcore__init(&extract, extract_filename, kcore.elfclass, false))
1709 goto out_kcore_close;
1711 if (!kci.modules_map.addr)
1714 if (kcore__copy_hdr(&kcore, &extract, count))
1715 goto out_extract_close;
1717 if (kcore__add_phdr(&extract, idx++, offset, kci.kernel_map.addr,
1718 kci.kernel_map.len))
1719 goto out_extract_close;
1721 if (kci.modules_map.addr) {
1722 modules_offset = offset + kci.kernel_map.len;
1723 if (kcore__add_phdr(&extract, idx, modules_offset,
1724 kci.modules_map.addr, kci.modules_map.len))
1725 goto out_extract_close;
1728 sz = kcore__write(&extract);
1729 if (sz < 0 || sz > offset)
1730 goto out_extract_close;
1732 if (copy_bytes(kcore.fd, kci.kernel_map.offset, extract.fd, offset,
1733 kci.kernel_map.len))
1734 goto out_extract_close;
1736 if (modules_offset && copy_bytes(kcore.fd, kci.modules_map.offset,
1737 extract.fd, modules_offset,
1738 kci.modules_map.len))
1739 goto out_extract_close;
1741 if (kcore_copy__compare_file(from_dir, to_dir, "modules"))
1742 goto out_extract_close;
1744 if (kcore_copy__compare_file(from_dir, to_dir, "kallsyms"))
1745 goto out_extract_close;
1750 kcore__close(&extract);
1752 unlink(extract_filename);
1754 kcore__close(&kcore);
1757 kcore_copy__unlink(to_dir, "modules");
1758 out_unlink_kallsyms:
1760 kcore_copy__unlink(to_dir, "kallsyms");
1765 int kcore_extract__create(struct kcore_extract *kce)
1768 struct kcore extract;
1770 int idx = 0, err = -1;
1771 off_t offset = page_size, sz;
1773 if (kcore__open(&kcore, kce->kcore_filename))
1776 strcpy(kce->extract_filename, PERF_KCORE_EXTRACT);
1777 if (kcore__init(&extract, kce->extract_filename, kcore.elfclass, true))
1778 goto out_kcore_close;
1780 if (kcore__copy_hdr(&kcore, &extract, count))
1781 goto out_extract_close;
1783 if (kcore__add_phdr(&extract, idx, offset, kce->addr, kce->len))
1784 goto out_extract_close;
1786 sz = kcore__write(&extract);
1787 if (sz < 0 || sz > offset)
1788 goto out_extract_close;
1790 if (copy_bytes(kcore.fd, kce->offs, extract.fd, offset, kce->len))
1791 goto out_extract_close;
1796 kcore__close(&extract);
1798 unlink(kce->extract_filename);
1800 kcore__close(&kcore);
1805 void kcore_extract__delete(struct kcore_extract *kce)
1807 unlink(kce->extract_filename);
1810 #ifdef HAVE_GELF_GETNOTE_SUPPORT
1812 * populate_sdt_note : Parse raw data and identify SDT note
1813 * @elf: elf of the opened file
1814 * @data: raw data of a section with description offset applied
1815 * @len: note description size
1816 * @type: type of the note
1817 * @sdt_notes: List to add the SDT note
1819 * Responsible for parsing the @data in section .note.stapsdt in @elf and
1820 * if its an SDT note, it appends to @sdt_notes list.
1822 static int populate_sdt_note(Elf **elf, const char *data, size_t len,
1823 struct list_head *sdt_notes)
1825 const char *provider, *name;
1826 struct sdt_note *tmp = NULL;
1828 GElf_Addr base_off = 0;
1833 Elf64_Addr a64[NR_ADDR];
1834 Elf32_Addr a32[NR_ADDR];
1838 .d_buf = &buf, .d_type = ELF_T_ADDR, .d_version = EV_CURRENT,
1839 .d_size = gelf_fsize((*elf), ELF_T_ADDR, NR_ADDR, EV_CURRENT),
1840 .d_off = 0, .d_align = 0
1843 .d_buf = (void *) data, .d_type = ELF_T_ADDR,
1844 .d_version = EV_CURRENT, .d_size = dst.d_size, .d_off = 0,
1848 tmp = (struct sdt_note *)calloc(1, sizeof(struct sdt_note));
1854 INIT_LIST_HEAD(&tmp->note_list);
1856 if (len < dst.d_size + 3)
1859 /* Translation from file representation to memory representation */
1860 if (gelf_xlatetom(*elf, &dst, &src,
1861 elf_getident(*elf, NULL)[EI_DATA]) == NULL) {
1862 pr_err("gelf_xlatetom : %s\n", elf_errmsg(-1));
1866 /* Populate the fields of sdt_note */
1867 provider = data + dst.d_size;
1869 name = (const char *)memchr(provider, '\0', data + len - provider);
1873 tmp->provider = strdup(provider);
1874 if (!tmp->provider) {
1878 tmp->name = strdup(name);
1884 if (gelf_getclass(*elf) == ELFCLASS32) {
1885 memcpy(&tmp->addr, &buf, 3 * sizeof(Elf32_Addr));
1888 memcpy(&tmp->addr, &buf, 3 * sizeof(Elf64_Addr));
1892 if (!gelf_getehdr(*elf, &ehdr)) {
1893 pr_debug("%s : cannot get elf header.\n", __func__);
1898 /* Adjust the prelink effect :
1899 * Find out the .stapsdt.base section.
1900 * This scn will help us to handle prelinking (if present).
1901 * Compare the retrieved file offset of the base section with the
1902 * base address in the description of the SDT note. If its different,
1903 * then accordingly, adjust the note location.
1905 if (elf_section_by_name(*elf, &ehdr, &shdr, SDT_BASE_SCN, NULL)) {
1906 base_off = shdr.sh_offset;
1909 tmp->addr.a32[0] = tmp->addr.a32[0] + base_off -
1912 tmp->addr.a64[0] = tmp->addr.a64[0] + base_off -
1917 list_add_tail(&tmp->note_list, sdt_notes);
1923 free(tmp->provider);
1931 * construct_sdt_notes_list : constructs a list of SDT notes
1932 * @elf : elf to look into
1933 * @sdt_notes : empty list_head
1935 * Scans the sections in 'elf' for the section
1936 * .note.stapsdt. It, then calls populate_sdt_note to find
1937 * out the SDT events and populates the 'sdt_notes'.
1939 static int construct_sdt_notes_list(Elf *elf, struct list_head *sdt_notes)
1942 Elf_Scn *scn = NULL;
1945 size_t shstrndx, next;
1947 size_t name_off, desc_off, offset;
1950 if (gelf_getehdr(elf, &ehdr) == NULL) {
1954 if (elf_getshdrstrndx(elf, &shstrndx) != 0) {
1959 /* Look for the required section */
1960 scn = elf_section_by_name(elf, &ehdr, &shdr, SDT_NOTE_SCN, NULL);
1966 if ((shdr.sh_type != SHT_NOTE) || (shdr.sh_flags & SHF_ALLOC)) {
1971 data = elf_getdata(scn, NULL);
1973 /* Get the SDT notes */
1974 for (offset = 0; (next = gelf_getnote(data, offset, &nhdr, &name_off,
1975 &desc_off)) > 0; offset = next) {
1976 if (nhdr.n_namesz == sizeof(SDT_NOTE_NAME) &&
1977 !memcmp(data->d_buf + name_off, SDT_NOTE_NAME,
1978 sizeof(SDT_NOTE_NAME))) {
1979 /* Check the type of the note */
1980 if (nhdr.n_type != SDT_NOTE_TYPE)
1983 ret = populate_sdt_note(&elf, ((data->d_buf) + desc_off),
1984 nhdr.n_descsz, sdt_notes);
1989 if (list_empty(sdt_notes))
1997 * get_sdt_note_list : Wrapper to construct a list of sdt notes
1998 * @head : empty list_head
1999 * @target : file to find SDT notes from
2001 * This opens the file, initializes
2002 * the ELF and then calls construct_sdt_notes_list.
2004 int get_sdt_note_list(struct list_head *head, const char *target)
2009 fd = open(target, O_RDONLY);
2013 elf = elf_begin(fd, PERF_ELF_C_READ_MMAP, NULL);
2018 ret = construct_sdt_notes_list(elf, head);
2026 * cleanup_sdt_note_list : free the sdt notes' list
2027 * @sdt_notes: sdt notes' list
2029 * Free up the SDT notes in @sdt_notes.
2030 * Returns the number of SDT notes free'd.
2032 int cleanup_sdt_note_list(struct list_head *sdt_notes)
2034 struct sdt_note *tmp, *pos;
2037 list_for_each_entry_safe(pos, tmp, sdt_notes, note_list) {
2038 list_del(&pos->note_list);
2040 free(pos->provider);
2048 * sdt_notes__get_count: Counts the number of sdt events
2049 * @start: list_head to sdt_notes list
2051 * Returns the number of SDT notes in a list
2053 int sdt_notes__get_count(struct list_head *start)
2055 struct sdt_note *sdt_ptr;
2058 list_for_each_entry(sdt_ptr, start, note_list)
2064 void symbol__elf_init(void)
2066 elf_version(EV_CURRENT);