1 // SPDX-License-Identifier: GPL-2.0
11 #include "map_groups.h"
14 #include "demangle-java.h"
15 #include "demangle-rust.h"
20 #include <linux/ctype.h>
21 #include <linux/kernel.h>
22 #include <linux/zalloc.h>
23 #include <symbol/kallsyms.h>
24 #include <internal/lib.h>
27 #define EM_AARCH64 183 /* ARM 64 bit */
30 #ifndef ELF32_ST_VISIBILITY
31 #define ELF32_ST_VISIBILITY(o) ((o) & 0x03)
34 /* For ELF64 the definitions are the same. */
35 #ifndef ELF64_ST_VISIBILITY
36 #define ELF64_ST_VISIBILITY(o) ELF32_ST_VISIBILITY (o)
39 /* How to extract information held in the st_other field. */
40 #ifndef GELF_ST_VISIBILITY
41 #define GELF_ST_VISIBILITY(val) ELF64_ST_VISIBILITY (val)
44 typedef Elf64_Nhdr GElf_Nhdr;
47 #define DMGL_NO_OPTS 0 /* For readability... */
48 #define DMGL_PARAMS (1 << 0) /* Include function args */
49 #define DMGL_ANSI (1 << 1) /* Include const, volatile, etc */
52 #ifdef HAVE_CPLUS_DEMANGLE_SUPPORT
53 extern char *cplus_demangle(const char *, int);
55 static inline char *bfd_demangle(void __maybe_unused *v, const char *c, int i)
57 return cplus_demangle(c, i);
61 static inline char *bfd_demangle(void __maybe_unused *v,
62 const char __maybe_unused *c,
68 #define PACKAGE 'perf'
73 #ifndef HAVE_ELF_GETPHDRNUM_SUPPORT
74 static int elf_getphdrnum(Elf *elf, size_t *dst)
79 ehdr = gelf_getehdr(elf, &gehdr);
89 #ifndef HAVE_ELF_GETSHDRSTRNDX_SUPPORT
90 static int elf_getshdrstrndx(Elf *elf __maybe_unused, size_t *dst __maybe_unused)
92 pr_err("%s: update your libelf to > 0.140, this one lacks elf_getshdrstrndx().\n", __func__);
97 #ifndef NT_GNU_BUILD_ID
98 #define NT_GNU_BUILD_ID 3
102 * elf_symtab__for_each_symbol - iterate thru all the symbols
104 * @syms: struct elf_symtab instance to iterate
106 * @sym: GElf_Sym iterator
108 #define elf_symtab__for_each_symbol(syms, nr_syms, idx, sym) \
109 for (idx = 0, gelf_getsym(syms, idx, &sym);\
111 idx++, gelf_getsym(syms, idx, &sym))
113 static inline uint8_t elf_sym__type(const GElf_Sym *sym)
115 return GELF_ST_TYPE(sym->st_info);
118 static inline uint8_t elf_sym__visibility(const GElf_Sym *sym)
120 return GELF_ST_VISIBILITY(sym->st_other);
123 #ifndef STT_GNU_IFUNC
124 #define STT_GNU_IFUNC 10
127 static inline int elf_sym__is_function(const GElf_Sym *sym)
129 return (elf_sym__type(sym) == STT_FUNC ||
130 elf_sym__type(sym) == STT_GNU_IFUNC) &&
132 sym->st_shndx != SHN_UNDEF;
135 static inline bool elf_sym__is_object(const GElf_Sym *sym)
137 return elf_sym__type(sym) == STT_OBJECT &&
139 sym->st_shndx != SHN_UNDEF;
142 static inline int elf_sym__is_label(const GElf_Sym *sym)
144 return elf_sym__type(sym) == STT_NOTYPE &&
146 sym->st_shndx != SHN_UNDEF &&
147 sym->st_shndx != SHN_ABS &&
148 elf_sym__visibility(sym) != STV_HIDDEN &&
149 elf_sym__visibility(sym) != STV_INTERNAL;
152 static bool elf_sym__filter(GElf_Sym *sym)
154 return elf_sym__is_function(sym) || elf_sym__is_object(sym);
157 static inline const char *elf_sym__name(const GElf_Sym *sym,
158 const Elf_Data *symstrs)
160 return symstrs->d_buf + sym->st_name;
163 static inline const char *elf_sec__name(const GElf_Shdr *shdr,
164 const Elf_Data *secstrs)
166 return secstrs->d_buf + shdr->sh_name;
169 static inline int elf_sec__is_text(const GElf_Shdr *shdr,
170 const Elf_Data *secstrs)
172 return strstr(elf_sec__name(shdr, secstrs), "text") != NULL;
175 static inline bool elf_sec__is_data(const GElf_Shdr *shdr,
176 const Elf_Data *secstrs)
178 return strstr(elf_sec__name(shdr, secstrs), "data") != NULL;
181 static bool elf_sec__filter(GElf_Shdr *shdr, Elf_Data *secstrs)
183 return elf_sec__is_text(shdr, secstrs) ||
184 elf_sec__is_data(shdr, secstrs);
187 static size_t elf_addr_to_index(Elf *elf, GElf_Addr addr)
193 while ((sec = elf_nextscn(elf, sec)) != NULL) {
194 gelf_getshdr(sec, &shdr);
196 if ((addr >= shdr.sh_addr) &&
197 (addr < (shdr.sh_addr + shdr.sh_size)))
206 Elf_Scn *elf_section_by_name(Elf *elf, GElf_Ehdr *ep,
207 GElf_Shdr *shp, const char *name, size_t *idx)
212 /* Elf is corrupted/truncated, avoid calling elf_strptr. */
213 if (!elf_rawdata(elf_getscn(elf, ep->e_shstrndx), NULL))
216 while ((sec = elf_nextscn(elf, sec)) != NULL) {
219 gelf_getshdr(sec, shp);
220 str = elf_strptr(elf, ep->e_shstrndx, shp->sh_name);
221 if (str && !strcmp(name, str)) {
232 static bool want_demangle(bool is_kernel_sym)
234 return is_kernel_sym ? symbol_conf.demangle_kernel : symbol_conf.demangle;
237 static char *demangle_sym(struct dso *dso, int kmodule, const char *elf_name)
239 int demangle_flags = verbose > 0 ? (DMGL_PARAMS | DMGL_ANSI) : DMGL_NO_OPTS;
240 char *demangled = NULL;
243 * We need to figure out if the object was created from C++ sources
244 * DWARF DW_compile_unit has this, but we don't always have access
247 if (!want_demangle(dso->kernel || kmodule))
250 demangled = bfd_demangle(NULL, elf_name, demangle_flags);
251 if (demangled == NULL)
252 demangled = java_demangle_sym(elf_name, JAVA_DEMANGLE_NORET);
253 else if (rust_is_mangled(demangled))
255 * Input to Rust demangling is the BFD-demangled
256 * name which it Rust-demangles in place.
258 rust_demangle_sym(demangled);
263 #define elf_section__for_each_rel(reldata, pos, pos_mem, idx, nr_entries) \
264 for (idx = 0, pos = gelf_getrel(reldata, 0, &pos_mem); \
266 ++idx, pos = gelf_getrel(reldata, idx, &pos_mem))
268 #define elf_section__for_each_rela(reldata, pos, pos_mem, idx, nr_entries) \
269 for (idx = 0, pos = gelf_getrela(reldata, 0, &pos_mem); \
271 ++idx, pos = gelf_getrela(reldata, idx, &pos_mem))
274 * We need to check if we have a .dynsym, so that we can handle the
275 * .plt, synthesizing its symbols, that aren't on the symtabs (be it
276 * .dynsym or .symtab).
277 * And always look at the original dso, not at debuginfo packages, that
278 * have the PLT data stripped out (shdr_rel_plt.sh_type == SHT_NOBITS).
280 int dso__synthesize_plt_symbols(struct dso *dso, struct symsrc *ss)
282 uint32_t nr_rel_entries, idx;
284 u64 plt_offset, plt_header_size, plt_entry_size;
287 GElf_Shdr shdr_rel_plt, shdr_dynsym;
288 Elf_Data *reldata, *syms, *symstrs;
289 Elf_Scn *scn_plt_rel, *scn_symstrs, *scn_dynsym;
292 char sympltname[1024];
294 int nr = 0, symidx, err = 0;
302 scn_dynsym = ss->dynsym;
303 shdr_dynsym = ss->dynshdr;
304 dynsym_idx = ss->dynsym_idx;
306 if (scn_dynsym == NULL)
309 scn_plt_rel = elf_section_by_name(elf, &ehdr, &shdr_rel_plt,
311 if (scn_plt_rel == NULL) {
312 scn_plt_rel = elf_section_by_name(elf, &ehdr, &shdr_rel_plt,
314 if (scn_plt_rel == NULL)
320 if (shdr_rel_plt.sh_link != dynsym_idx)
323 if (elf_section_by_name(elf, &ehdr, &shdr_plt, ".plt", NULL) == NULL)
327 * Fetch the relocation section to find the idxes to the GOT
328 * and the symbols in the .dynsym they refer to.
330 reldata = elf_getdata(scn_plt_rel, NULL);
334 syms = elf_getdata(scn_dynsym, NULL);
338 scn_symstrs = elf_getscn(elf, shdr_dynsym.sh_link);
339 if (scn_symstrs == NULL)
342 symstrs = elf_getdata(scn_symstrs, NULL);
346 if (symstrs->d_size == 0)
349 nr_rel_entries = shdr_rel_plt.sh_size / shdr_rel_plt.sh_entsize;
350 plt_offset = shdr_plt.sh_offset;
351 switch (ehdr.e_machine) {
353 plt_header_size = 20;
358 plt_header_size = 32;
363 plt_header_size = 48;
368 plt_header_size = 128;
372 default: /* FIXME: s390/alpha/mips/parisc/poperpc/sh/xtensa need to be checked */
373 plt_header_size = shdr_plt.sh_entsize;
374 plt_entry_size = shdr_plt.sh_entsize;
377 plt_offset += plt_header_size;
379 if (shdr_rel_plt.sh_type == SHT_RELA) {
380 GElf_Rela pos_mem, *pos;
382 elf_section__for_each_rela(reldata, pos, pos_mem, idx,
384 const char *elf_name = NULL;
385 char *demangled = NULL;
386 symidx = GELF_R_SYM(pos->r_info);
387 gelf_getsym(syms, symidx, &sym);
389 elf_name = elf_sym__name(&sym, symstrs);
390 demangled = demangle_sym(dso, 0, elf_name);
391 if (demangled != NULL)
392 elf_name = demangled;
393 snprintf(sympltname, sizeof(sympltname),
397 f = symbol__new(plt_offset, plt_entry_size,
398 STB_GLOBAL, STT_FUNC, sympltname);
402 plt_offset += plt_entry_size;
403 symbols__insert(&dso->symbols, f);
406 } else if (shdr_rel_plt.sh_type == SHT_REL) {
407 GElf_Rel pos_mem, *pos;
408 elf_section__for_each_rel(reldata, pos, pos_mem, idx,
410 const char *elf_name = NULL;
411 char *demangled = NULL;
412 symidx = GELF_R_SYM(pos->r_info);
413 gelf_getsym(syms, symidx, &sym);
415 elf_name = elf_sym__name(&sym, symstrs);
416 demangled = demangle_sym(dso, 0, elf_name);
417 if (demangled != NULL)
418 elf_name = demangled;
419 snprintf(sympltname, sizeof(sympltname),
423 f = symbol__new(plt_offset, plt_entry_size,
424 STB_GLOBAL, STT_FUNC, sympltname);
428 plt_offset += plt_entry_size;
429 symbols__insert(&dso->symbols, f);
438 pr_debug("%s: problems reading %s PLT info.\n",
439 __func__, dso->long_name);
443 char *dso__demangle_sym(struct dso *dso, int kmodule, const char *elf_name)
445 return demangle_sym(dso, kmodule, elf_name);
449 * Align offset to 4 bytes as needed for note name and descriptor data.
451 #define NOTE_ALIGN(n) (((n) + 3) & -4U)
453 static int elf_read_build_id(Elf *elf, void *bf, size_t size)
463 if (size < BUILD_ID_SIZE)
470 if (gelf_getehdr(elf, &ehdr) == NULL) {
471 pr_err("%s: cannot get elf header.\n", __func__);
476 * Check following sections for notes:
477 * '.note.gnu.build-id'
479 * '.note' (VDSO specific)
482 sec = elf_section_by_name(elf, &ehdr, &shdr,
483 ".note.gnu.build-id", NULL);
487 sec = elf_section_by_name(elf, &ehdr, &shdr,
492 sec = elf_section_by_name(elf, &ehdr, &shdr,
501 data = elf_getdata(sec, NULL);
506 while (ptr < (data->d_buf + data->d_size)) {
507 GElf_Nhdr *nhdr = ptr;
508 size_t namesz = NOTE_ALIGN(nhdr->n_namesz),
509 descsz = NOTE_ALIGN(nhdr->n_descsz);
512 ptr += sizeof(*nhdr);
515 if (nhdr->n_type == NT_GNU_BUILD_ID &&
516 nhdr->n_namesz == sizeof("GNU")) {
517 if (memcmp(name, "GNU", sizeof("GNU")) == 0) {
518 size_t sz = min(size, descsz);
520 memset(bf + sz, 0, size - sz);
532 int filename__read_build_id(const char *filename, void *bf, size_t size)
537 if (size < BUILD_ID_SIZE)
540 fd = open(filename, O_RDONLY);
544 elf = elf_begin(fd, PERF_ELF_C_READ_MMAP, NULL);
546 pr_debug2("%s: cannot read %s ELF file.\n", __func__, filename);
550 err = elf_read_build_id(elf, bf, size);
559 int sysfs__read_build_id(const char *filename, void *build_id, size_t size)
563 if (size < BUILD_ID_SIZE)
566 fd = open(filename, O_RDONLY);
573 size_t namesz, descsz;
575 if (read(fd, &nhdr, sizeof(nhdr)) != sizeof(nhdr))
578 namesz = NOTE_ALIGN(nhdr.n_namesz);
579 descsz = NOTE_ALIGN(nhdr.n_descsz);
580 if (nhdr.n_type == NT_GNU_BUILD_ID &&
581 nhdr.n_namesz == sizeof("GNU")) {
582 if (read(fd, bf, namesz) != (ssize_t)namesz)
584 if (memcmp(bf, "GNU", sizeof("GNU")) == 0) {
585 size_t sz = min(descsz, size);
586 if (read(fd, build_id, sz) == (ssize_t)sz) {
587 memset(build_id + sz, 0, size - sz);
591 } else if (read(fd, bf, descsz) != (ssize_t)descsz)
594 int n = namesz + descsz;
596 if (n > (int)sizeof(bf)) {
598 pr_debug("%s: truncating reading of build id in sysfs file %s: n_namesz=%u, n_descsz=%u.\n",
599 __func__, filename, nhdr.n_namesz, nhdr.n_descsz);
601 if (read(fd, bf, n) != n)
610 int filename__read_debuglink(const char *filename, char *debuglink,
621 fd = open(filename, O_RDONLY);
625 elf = elf_begin(fd, PERF_ELF_C_READ_MMAP, NULL);
627 pr_debug2("%s: cannot read %s ELF file.\n", __func__, filename);
635 if (gelf_getehdr(elf, &ehdr) == NULL) {
636 pr_err("%s: cannot get elf header.\n", __func__);
640 sec = elf_section_by_name(elf, &ehdr, &shdr,
641 ".gnu_debuglink", NULL);
645 data = elf_getdata(sec, NULL);
649 /* the start of this section is a zero-terminated string */
650 strncpy(debuglink, data->d_buf, size);
662 static int dso__swap_init(struct dso *dso, unsigned char eidata)
664 static unsigned int const endian = 1;
666 dso->needs_swap = DSO_SWAP__NO;
670 /* We are big endian, DSO is little endian. */
671 if (*(unsigned char const *)&endian != 1)
672 dso->needs_swap = DSO_SWAP__YES;
676 /* We are little endian, DSO is big endian. */
677 if (*(unsigned char const *)&endian != 0)
678 dso->needs_swap = DSO_SWAP__YES;
682 pr_err("unrecognized DSO data encoding %d\n", eidata);
689 bool symsrc__possibly_runtime(struct symsrc *ss)
691 return ss->dynsym || ss->opdsec;
694 bool symsrc__has_symtab(struct symsrc *ss)
696 return ss->symtab != NULL;
699 void symsrc__destroy(struct symsrc *ss)
706 bool __weak elf__needs_adjust_symbols(GElf_Ehdr ehdr)
708 return ehdr.e_type == ET_EXEC || ehdr.e_type == ET_REL;
711 int symsrc__init(struct symsrc *ss, struct dso *dso, const char *name,
712 enum dso_binary_type type)
718 if (dso__needs_decompress(dso)) {
719 fd = dso__decompress_kmodule_fd(dso, name);
723 type = dso->symtab_type;
725 fd = open(name, O_RDONLY);
727 dso->load_errno = errno;
732 elf = elf_begin(fd, PERF_ELF_C_READ_MMAP, NULL);
734 pr_debug("%s: cannot read %s ELF file.\n", __func__, name);
735 dso->load_errno = DSO_LOAD_ERRNO__INVALID_ELF;
739 if (gelf_getehdr(elf, &ehdr) == NULL) {
740 dso->load_errno = DSO_LOAD_ERRNO__INVALID_ELF;
741 pr_debug("%s: cannot get elf header.\n", __func__);
745 if (dso__swap_init(dso, ehdr.e_ident[EI_DATA])) {
746 dso->load_errno = DSO_LOAD_ERRNO__INTERNAL_ERROR;
750 /* Always reject images with a mismatched build-id: */
751 if (dso->has_build_id && !symbol_conf.ignore_vmlinux_buildid) {
752 u8 build_id[BUILD_ID_SIZE];
754 if (elf_read_build_id(elf, build_id, BUILD_ID_SIZE) < 0) {
755 dso->load_errno = DSO_LOAD_ERRNO__CANNOT_READ_BUILDID;
759 if (!dso__build_id_equal(dso, build_id)) {
760 pr_debug("%s: build id mismatch for %s.\n", __func__, name);
761 dso->load_errno = DSO_LOAD_ERRNO__MISMATCHING_BUILDID;
766 ss->is_64_bit = (gelf_getclass(elf) == ELFCLASS64);
768 ss->symtab = elf_section_by_name(elf, &ehdr, &ss->symshdr, ".symtab",
770 if (ss->symshdr.sh_type != SHT_SYMTAB)
774 ss->dynsym = elf_section_by_name(elf, &ehdr, &ss->dynshdr, ".dynsym",
776 if (ss->dynshdr.sh_type != SHT_DYNSYM)
780 ss->opdsec = elf_section_by_name(elf, &ehdr, &ss->opdshdr, ".opd",
782 if (ss->opdshdr.sh_type != SHT_PROGBITS)
785 if (dso->kernel == DSO_TYPE_USER)
786 ss->adjust_symbols = true;
788 ss->adjust_symbols = elf__needs_adjust_symbols(ehdr);
790 ss->name = strdup(name);
792 dso->load_errno = errno;
811 * ref_reloc_sym_not_found - has kernel relocation symbol been found.
812 * @kmap: kernel maps and relocation reference symbol
814 * This function returns %true if we are dealing with the kernel maps and the
815 * relocation reference symbol has not yet been found. Otherwise %false is
818 static bool ref_reloc_sym_not_found(struct kmap *kmap)
820 return kmap && kmap->ref_reloc_sym && kmap->ref_reloc_sym->name &&
821 !kmap->ref_reloc_sym->unrelocated_addr;
825 * ref_reloc - kernel relocation offset.
826 * @kmap: kernel maps and relocation reference symbol
828 * This function returns the offset of kernel addresses as determined by using
829 * the relocation reference symbol i.e. if the kernel has not been relocated
830 * then the return value is zero.
832 static u64 ref_reloc(struct kmap *kmap)
834 if (kmap && kmap->ref_reloc_sym &&
835 kmap->ref_reloc_sym->unrelocated_addr)
836 return kmap->ref_reloc_sym->addr -
837 kmap->ref_reloc_sym->unrelocated_addr;
841 void __weak arch__sym_update(struct symbol *s __maybe_unused,
842 GElf_Sym *sym __maybe_unused) { }
844 static int dso__process_kernel_symbol(struct dso *dso, struct map *map,
845 GElf_Sym *sym, GElf_Shdr *shdr,
846 struct map_groups *kmaps, struct kmap *kmap,
847 struct dso **curr_dsop, struct map **curr_mapp,
848 const char *section_name,
849 bool adjust_kernel_syms, bool kmodule, bool *remap_kernel)
851 struct dso *curr_dso = *curr_dsop;
852 struct map *curr_map;
853 char dso_name[PATH_MAX];
855 /* Adjust symbol to map to file offset */
856 if (adjust_kernel_syms)
857 sym->st_value -= shdr->sh_addr - shdr->sh_offset;
859 if (strcmp(section_name, (curr_dso->short_name + dso->short_name_len)) == 0)
862 if (strcmp(section_name, ".text") == 0) {
864 * The initial kernel mapping is based on
865 * kallsyms and identity maps. Overwrite it to
866 * map to the kernel dso.
868 if (*remap_kernel && dso->kernel) {
869 *remap_kernel = false;
870 map->start = shdr->sh_addr + ref_reloc(kmap);
871 map->end = map->start + shdr->sh_size;
872 map->pgoff = shdr->sh_offset;
873 map->map_ip = map__map_ip;
874 map->unmap_ip = map__unmap_ip;
875 /* Ensure maps are correctly ordered */
878 map_groups__remove(kmaps, map);
879 map_groups__insert(kmaps, map);
885 * The initial module mapping is based on
886 * /proc/modules mapped to offset zero.
887 * Overwrite it to map to the module dso.
889 if (*remap_kernel && kmodule) {
890 *remap_kernel = false;
891 map->pgoff = shdr->sh_offset;
902 snprintf(dso_name, sizeof(dso_name), "%s%s", dso->short_name, section_name);
904 curr_map = map_groups__find_by_name(kmaps, dso_name);
905 if (curr_map == NULL) {
906 u64 start = sym->st_value;
909 start += map->start + shdr->sh_offset;
911 curr_dso = dso__new(dso_name);
912 if (curr_dso == NULL)
914 curr_dso->kernel = dso->kernel;
915 curr_dso->long_name = dso->long_name;
916 curr_dso->long_name_len = dso->long_name_len;
917 curr_map = map__new2(start, curr_dso);
919 if (curr_map == NULL)
922 if (adjust_kernel_syms) {
923 curr_map->start = shdr->sh_addr + ref_reloc(kmap);
924 curr_map->end = curr_map->start + shdr->sh_size;
925 curr_map->pgoff = shdr->sh_offset;
927 curr_map->map_ip = curr_map->unmap_ip = identity__map_ip;
929 curr_dso->symtab_type = dso->symtab_type;
930 map_groups__insert(kmaps, curr_map);
932 * Add it before we drop the referece to curr_map, i.e. while
933 * we still are sure to have a reference to this DSO via
936 dsos__add(&map->groups->machine->dsos, curr_dso);
937 /* kmaps already got it */
939 dso__set_loaded(curr_dso);
940 *curr_mapp = curr_map;
941 *curr_dsop = curr_dso;
943 *curr_dsop = curr_map->dso;
948 int dso__load_sym(struct dso *dso, struct map *map, struct symsrc *syms_ss,
949 struct symsrc *runtime_ss, int kmodule)
951 struct kmap *kmap = dso->kernel ? map__kmap(map) : NULL;
952 struct map_groups *kmaps = kmap ? map__kmaps(map) : NULL;
953 struct map *curr_map = map;
954 struct dso *curr_dso = dso;
955 Elf_Data *symstrs, *secstrs;
962 Elf_Data *syms, *opddata = NULL;
964 Elf_Scn *sec, *sec_strndx;
967 bool remap_kernel = false, adjust_kernel_syms = false;
972 dso->symtab_type = syms_ss->type;
973 dso->is_64_bit = syms_ss->is_64_bit;
974 dso->rel = syms_ss->ehdr.e_type == ET_REL;
977 * Modules may already have symbols from kallsyms, but those symbols
978 * have the wrong values for the dso maps, so remove them.
980 if (kmodule && syms_ss->symtab)
981 symbols__delete(&dso->symbols);
983 if (!syms_ss->symtab) {
985 * If the vmlinux is stripped, fail so we will fall back
986 * to using kallsyms. The vmlinux runtime symbols aren't
992 syms_ss->symtab = syms_ss->dynsym;
993 syms_ss->symshdr = syms_ss->dynshdr;
997 ehdr = syms_ss->ehdr;
998 sec = syms_ss->symtab;
999 shdr = syms_ss->symshdr;
1001 if (elf_section_by_name(runtime_ss->elf, &runtime_ss->ehdr, &tshdr,
1003 dso->text_offset = tshdr.sh_addr - tshdr.sh_offset;
1005 if (runtime_ss->opdsec)
1006 opddata = elf_rawdata(runtime_ss->opdsec, NULL);
1008 syms = elf_getdata(sec, NULL);
1012 sec = elf_getscn(elf, shdr.sh_link);
1016 symstrs = elf_getdata(sec, NULL);
1017 if (symstrs == NULL)
1020 sec_strndx = elf_getscn(runtime_ss->elf, runtime_ss->ehdr.e_shstrndx);
1021 if (sec_strndx == NULL)
1024 secstrs = elf_getdata(sec_strndx, NULL);
1025 if (secstrs == NULL)
1028 nr_syms = shdr.sh_size / shdr.sh_entsize;
1030 memset(&sym, 0, sizeof(sym));
1033 * The kernel relocation symbol is needed in advance in order to adjust
1034 * kernel maps correctly.
1036 if (ref_reloc_sym_not_found(kmap)) {
1037 elf_symtab__for_each_symbol(syms, nr_syms, idx, sym) {
1038 const char *elf_name = elf_sym__name(&sym, symstrs);
1040 if (strcmp(elf_name, kmap->ref_reloc_sym->name))
1042 kmap->ref_reloc_sym->unrelocated_addr = sym.st_value;
1043 map->reloc = kmap->ref_reloc_sym->addr -
1044 kmap->ref_reloc_sym->unrelocated_addr;
1050 * Handle any relocation of vdso necessary because older kernels
1051 * attempted to prelink vdso to its virtual address.
1053 if (dso__is_vdso(dso))
1054 map->reloc = map->start - dso->text_offset;
1056 dso->adjust_symbols = runtime_ss->adjust_symbols || ref_reloc(kmap);
1058 * Initial kernel and module mappings do not map to the dso.
1061 if (dso->kernel || kmodule) {
1062 remap_kernel = true;
1063 adjust_kernel_syms = dso->adjust_symbols;
1065 elf_symtab__for_each_symbol(syms, nr_syms, idx, sym) {
1067 const char *elf_name = elf_sym__name(&sym, symstrs);
1068 char *demangled = NULL;
1069 int is_label = elf_sym__is_label(&sym);
1070 const char *section_name;
1071 bool used_opd = false;
1073 if (!is_label && !elf_sym__filter(&sym))
1076 /* Reject ARM ELF "mapping symbols": these aren't unique and
1077 * don't identify functions, so will confuse the profile
1079 if (ehdr.e_machine == EM_ARM || ehdr.e_machine == EM_AARCH64) {
1080 if (elf_name[0] == '$' && strchr("adtx", elf_name[1])
1081 && (elf_name[2] == '\0' || elf_name[2] == '.'))
1085 if (runtime_ss->opdsec && sym.st_shndx == runtime_ss->opdidx) {
1086 u32 offset = sym.st_value - syms_ss->opdshdr.sh_addr;
1087 u64 *opd = opddata->d_buf + offset;
1088 sym.st_value = DSO__SWAP(dso, u64, *opd);
1089 sym.st_shndx = elf_addr_to_index(runtime_ss->elf,
1094 * When loading symbols in a data mapping, ABS symbols (which
1095 * has a value of SHN_ABS in its st_shndx) failed at
1096 * elf_getscn(). And it marks the loading as a failure so
1097 * already loaded symbols cannot be fixed up.
1099 * I'm not sure what should be done. Just ignore them for now.
1102 if (sym.st_shndx == SHN_ABS)
1105 sec = elf_getscn(runtime_ss->elf, sym.st_shndx);
1109 gelf_getshdr(sec, &shdr);
1111 if (is_label && !elf_sec__filter(&shdr, secstrs))
1114 section_name = elf_sec__name(&shdr, secstrs);
1116 /* On ARM, symbols for thumb functions have 1 added to
1117 * the symbol address as a flag - remove it */
1118 if ((ehdr.e_machine == EM_ARM) &&
1119 (GELF_ST_TYPE(sym.st_info) == STT_FUNC) &&
1123 if (dso->kernel || kmodule) {
1124 if (dso__process_kernel_symbol(dso, map, &sym, &shdr, kmaps, kmap, &curr_dso, &curr_map,
1125 section_name, adjust_kernel_syms, kmodule, &remap_kernel))
1127 } else if ((used_opd && runtime_ss->adjust_symbols) ||
1128 (!used_opd && syms_ss->adjust_symbols)) {
1129 pr_debug4("%s: adjusting symbol: st_value: %#" PRIx64 " "
1130 "sh_addr: %#" PRIx64 " sh_offset: %#" PRIx64 "\n", __func__,
1131 (u64)sym.st_value, (u64)shdr.sh_addr,
1132 (u64)shdr.sh_offset);
1133 sym.st_value -= shdr.sh_addr - shdr.sh_offset;
1136 demangled = demangle_sym(dso, kmodule, elf_name);
1137 if (demangled != NULL)
1138 elf_name = demangled;
1140 f = symbol__new(sym.st_value, sym.st_size,
1141 GELF_ST_BIND(sym.st_info),
1142 GELF_ST_TYPE(sym.st_info), elf_name);
1147 arch__sym_update(f, &sym);
1149 __symbols__insert(&curr_dso->symbols, f, dso->kernel);
1154 * For misannotated, zeroed, ASM function sizes.
1157 symbols__fixup_end(&dso->symbols);
1158 symbols__fixup_duplicate(&dso->symbols);
1161 * We need to fixup this here too because we create new
1162 * maps here, for things like vsyscall sections.
1164 map_groups__fixup_end(kmaps);
1172 static int elf_read_maps(Elf *elf, bool exe, mapfn_t mapfn, void *data)
1179 if (elf_getphdrnum(elf, &phdrnum))
1182 for (i = 0; i < phdrnum; i++) {
1183 if (gelf_getphdr(elf, i, &phdr) == NULL)
1185 if (phdr.p_type != PT_LOAD)
1188 if (!(phdr.p_flags & PF_X))
1191 if (!(phdr.p_flags & PF_R))
1194 sz = min(phdr.p_memsz, phdr.p_filesz);
1197 err = mapfn(phdr.p_vaddr, sz, phdr.p_offset, data);
1204 int file__read_maps(int fd, bool exe, mapfn_t mapfn, void *data,
1210 elf = elf_begin(fd, PERF_ELF_C_READ_MMAP, NULL);
1215 *is_64_bit = (gelf_getclass(elf) == ELFCLASS64);
1217 err = elf_read_maps(elf, exe, mapfn, data);
1223 enum dso_type dso__type_fd(int fd)
1225 enum dso_type dso_type = DSO__TYPE_UNKNOWN;
1230 elf = elf_begin(fd, PERF_ELF_C_READ_MMAP, NULL);
1235 if (ek != ELF_K_ELF)
1238 if (gelf_getclass(elf) == ELFCLASS64) {
1239 dso_type = DSO__TYPE_64BIT;
1243 if (gelf_getehdr(elf, &ehdr) == NULL)
1246 if (ehdr.e_machine == EM_X86_64)
1247 dso_type = DSO__TYPE_X32BIT;
1249 dso_type = DSO__TYPE_32BIT;
1256 static int copy_bytes(int from, off_t from_offs, int to, off_t to_offs, u64 len)
1261 char *buf = malloc(page_size);
1266 if (lseek(to, to_offs, SEEK_SET) != to_offs)
1269 if (lseek(from, from_offs, SEEK_SET) != from_offs)
1276 /* Use read because mmap won't work on proc files */
1277 r = read(from, buf, n);
1283 r = write(to, buf, n);
1304 static int kcore__open(struct kcore *kcore, const char *filename)
1308 kcore->fd = open(filename, O_RDONLY);
1309 if (kcore->fd == -1)
1312 kcore->elf = elf_begin(kcore->fd, ELF_C_READ, NULL);
1316 kcore->elfclass = gelf_getclass(kcore->elf);
1317 if (kcore->elfclass == ELFCLASSNONE)
1320 ehdr = gelf_getehdr(kcore->elf, &kcore->ehdr);
1327 elf_end(kcore->elf);
1333 static int kcore__init(struct kcore *kcore, char *filename, int elfclass,
1336 kcore->elfclass = elfclass;
1339 kcore->fd = mkstemp(filename);
1341 kcore->fd = open(filename, O_WRONLY | O_CREAT | O_EXCL, 0400);
1342 if (kcore->fd == -1)
1345 kcore->elf = elf_begin(kcore->fd, ELF_C_WRITE, NULL);
1349 if (!gelf_newehdr(kcore->elf, elfclass))
1352 memset(&kcore->ehdr, 0, sizeof(GElf_Ehdr));
1357 elf_end(kcore->elf);
1364 static void kcore__close(struct kcore *kcore)
1366 elf_end(kcore->elf);
1370 static int kcore__copy_hdr(struct kcore *from, struct kcore *to, size_t count)
1372 GElf_Ehdr *ehdr = &to->ehdr;
1373 GElf_Ehdr *kehdr = &from->ehdr;
1375 memcpy(ehdr->e_ident, kehdr->e_ident, EI_NIDENT);
1376 ehdr->e_type = kehdr->e_type;
1377 ehdr->e_machine = kehdr->e_machine;
1378 ehdr->e_version = kehdr->e_version;
1381 ehdr->e_flags = kehdr->e_flags;
1382 ehdr->e_phnum = count;
1383 ehdr->e_shentsize = 0;
1385 ehdr->e_shstrndx = 0;
1387 if (from->elfclass == ELFCLASS32) {
1388 ehdr->e_phoff = sizeof(Elf32_Ehdr);
1389 ehdr->e_ehsize = sizeof(Elf32_Ehdr);
1390 ehdr->e_phentsize = sizeof(Elf32_Phdr);
1392 ehdr->e_phoff = sizeof(Elf64_Ehdr);
1393 ehdr->e_ehsize = sizeof(Elf64_Ehdr);
1394 ehdr->e_phentsize = sizeof(Elf64_Phdr);
1397 if (!gelf_update_ehdr(to->elf, ehdr))
1400 if (!gelf_newphdr(to->elf, count))
1406 static int kcore__add_phdr(struct kcore *kcore, int idx, off_t offset,
1411 .p_flags = PF_R | PF_W | PF_X,
1417 .p_align = page_size,
1420 if (!gelf_update_phdr(kcore->elf, idx, &phdr))
1426 static off_t kcore__write(struct kcore *kcore)
1428 return elf_update(kcore->elf, ELF_C_WRITE);
1436 struct list_head node;
1437 struct phdr_data *remaps;
1442 struct list_head node;
1445 struct kcore_copy_info {
1451 u64 last_module_symbol;
1453 struct list_head phdrs;
1454 struct list_head syms;
1457 #define kcore_copy__for_each_phdr(k, p) \
1458 list_for_each_entry((p), &(k)->phdrs, node)
1460 static struct phdr_data *phdr_data__new(u64 addr, u64 len, off_t offset)
1462 struct phdr_data *p = zalloc(sizeof(*p));
1473 static struct phdr_data *kcore_copy_info__addnew(struct kcore_copy_info *kci,
1477 struct phdr_data *p = phdr_data__new(addr, len, offset);
1480 list_add_tail(&p->node, &kci->phdrs);
1485 static void kcore_copy__free_phdrs(struct kcore_copy_info *kci)
1487 struct phdr_data *p, *tmp;
1489 list_for_each_entry_safe(p, tmp, &kci->phdrs, node) {
1490 list_del_init(&p->node);
1495 static struct sym_data *kcore_copy__new_sym(struct kcore_copy_info *kci,
1498 struct sym_data *s = zalloc(sizeof(*s));
1502 list_add_tail(&s->node, &kci->syms);
1508 static void kcore_copy__free_syms(struct kcore_copy_info *kci)
1510 struct sym_data *s, *tmp;
1512 list_for_each_entry_safe(s, tmp, &kci->syms, node) {
1513 list_del_init(&s->node);
1518 static int kcore_copy__process_kallsyms(void *arg, const char *name, char type,
1521 struct kcore_copy_info *kci = arg;
1523 if (!kallsyms__is_function(type))
1526 if (strchr(name, '[')) {
1527 if (start > kci->last_module_symbol)
1528 kci->last_module_symbol = start;
1532 if (!kci->first_symbol || start < kci->first_symbol)
1533 kci->first_symbol = start;
1535 if (!kci->last_symbol || start > kci->last_symbol)
1536 kci->last_symbol = start;
1538 if (!strcmp(name, "_stext")) {
1543 if (!strcmp(name, "_etext")) {
1548 if (is_entry_trampoline(name) && !kcore_copy__new_sym(kci, start))
1554 static int kcore_copy__parse_kallsyms(struct kcore_copy_info *kci,
1557 char kallsyms_filename[PATH_MAX];
1559 scnprintf(kallsyms_filename, PATH_MAX, "%s/kallsyms", dir);
1561 if (symbol__restricted_filename(kallsyms_filename, "/proc/kallsyms"))
1564 if (kallsyms__parse(kallsyms_filename, kci,
1565 kcore_copy__process_kallsyms) < 0)
1571 static int kcore_copy__process_modules(void *arg,
1572 const char *name __maybe_unused,
1573 u64 start, u64 size __maybe_unused)
1575 struct kcore_copy_info *kci = arg;
1577 if (!kci->first_module || start < kci->first_module)
1578 kci->first_module = start;
1583 static int kcore_copy__parse_modules(struct kcore_copy_info *kci,
1586 char modules_filename[PATH_MAX];
1588 scnprintf(modules_filename, PATH_MAX, "%s/modules", dir);
1590 if (symbol__restricted_filename(modules_filename, "/proc/modules"))
1593 if (modules__parse(modules_filename, kci,
1594 kcore_copy__process_modules) < 0)
1600 static int kcore_copy__map(struct kcore_copy_info *kci, u64 start, u64 end,
1601 u64 pgoff, u64 s, u64 e)
1605 if (s < start || s >= end)
1608 offset = (s - start) + pgoff;
1609 len = e < end ? e - s : end - s;
1611 return kcore_copy_info__addnew(kci, s, len, offset) ? 0 : -1;
1614 static int kcore_copy__read_map(u64 start, u64 len, u64 pgoff, void *data)
1616 struct kcore_copy_info *kci = data;
1617 u64 end = start + len;
1618 struct sym_data *sdat;
1620 if (kcore_copy__map(kci, start, end, pgoff, kci->stext, kci->etext))
1623 if (kcore_copy__map(kci, start, end, pgoff, kci->first_module,
1624 kci->last_module_symbol))
1627 list_for_each_entry(sdat, &kci->syms, node) {
1628 u64 s = round_down(sdat->addr, page_size);
1630 if (kcore_copy__map(kci, start, end, pgoff, s, s + len))
1637 static int kcore_copy__read_maps(struct kcore_copy_info *kci, Elf *elf)
1639 if (elf_read_maps(elf, true, kcore_copy__read_map, kci) < 0)
1645 static void kcore_copy__find_remaps(struct kcore_copy_info *kci)
1647 struct phdr_data *p, *k = NULL;
1653 /* Find phdr that corresponds to the kernel map (contains stext) */
1654 kcore_copy__for_each_phdr(kci, p) {
1655 u64 pend = p->addr + p->len - 1;
1657 if (p->addr <= kci->stext && pend >= kci->stext) {
1666 kend = k->offset + k->len;
1668 /* Find phdrs that remap the kernel */
1669 kcore_copy__for_each_phdr(kci, p) {
1670 u64 pend = p->offset + p->len;
1675 if (p->offset >= k->offset && pend <= kend)
1680 static void kcore_copy__layout(struct kcore_copy_info *kci)
1682 struct phdr_data *p;
1685 kcore_copy__find_remaps(kci);
1687 kcore_copy__for_each_phdr(kci, p) {
1695 kcore_copy__for_each_phdr(kci, p) {
1696 struct phdr_data *k = p->remaps;
1699 p->rel = p->offset - k->offset + k->rel;
1703 static int kcore_copy__calc_maps(struct kcore_copy_info *kci, const char *dir,
1706 if (kcore_copy__parse_kallsyms(kci, dir))
1709 if (kcore_copy__parse_modules(kci, dir))
1713 kci->stext = round_down(kci->stext, page_size);
1715 kci->stext = round_down(kci->first_symbol, page_size);
1718 kci->etext = round_up(kci->etext, page_size);
1719 } else if (kci->last_symbol) {
1720 kci->etext = round_up(kci->last_symbol, page_size);
1721 kci->etext += page_size;
1724 kci->first_module = round_down(kci->first_module, page_size);
1726 if (kci->last_module_symbol) {
1727 kci->last_module_symbol = round_up(kci->last_module_symbol,
1729 kci->last_module_symbol += page_size;
1732 if (!kci->stext || !kci->etext)
1735 if (kci->first_module && !kci->last_module_symbol)
1738 if (kcore_copy__read_maps(kci, elf))
1741 kcore_copy__layout(kci);
1746 static int kcore_copy__copy_file(const char *from_dir, const char *to_dir,
1749 char from_filename[PATH_MAX];
1750 char to_filename[PATH_MAX];
1752 scnprintf(from_filename, PATH_MAX, "%s/%s", from_dir, name);
1753 scnprintf(to_filename, PATH_MAX, "%s/%s", to_dir, name);
1755 return copyfile_mode(from_filename, to_filename, 0400);
1758 static int kcore_copy__unlink(const char *dir, const char *name)
1760 char filename[PATH_MAX];
1762 scnprintf(filename, PATH_MAX, "%s/%s", dir, name);
1764 return unlink(filename);
1767 static int kcore_copy__compare_fds(int from, int to)
1775 buf_from = malloc(page_size);
1776 buf_to = malloc(page_size);
1777 if (!buf_from || !buf_to)
1781 /* Use read because mmap won't work on proc files */
1782 ret = read(from, buf_from, page_size);
1791 if (readn(to, buf_to, len) != (int)len)
1794 if (memcmp(buf_from, buf_to, len))
1805 static int kcore_copy__compare_files(const char *from_filename,
1806 const char *to_filename)
1808 int from, to, err = -1;
1810 from = open(from_filename, O_RDONLY);
1814 to = open(to_filename, O_RDONLY);
1816 goto out_close_from;
1818 err = kcore_copy__compare_fds(from, to);
1826 static int kcore_copy__compare_file(const char *from_dir, const char *to_dir,
1829 char from_filename[PATH_MAX];
1830 char to_filename[PATH_MAX];
1832 scnprintf(from_filename, PATH_MAX, "%s/%s", from_dir, name);
1833 scnprintf(to_filename, PATH_MAX, "%s/%s", to_dir, name);
1835 return kcore_copy__compare_files(from_filename, to_filename);
1839 * kcore_copy - copy kallsyms, modules and kcore from one directory to another.
1840 * @from_dir: from directory
1841 * @to_dir: to directory
1843 * This function copies kallsyms, modules and kcore files from one directory to
1844 * another. kallsyms and modules are copied entirely. Only code segments are
1845 * copied from kcore. It is assumed that two segments suffice: one for the
1846 * kernel proper and one for all the modules. The code segments are determined
1847 * from kallsyms and modules files. The kernel map starts at _stext or the
1848 * lowest function symbol, and ends at _etext or the highest function symbol.
1849 * The module map starts at the lowest module address and ends at the highest
1850 * module symbol. Start addresses are rounded down to the nearest page. End
1851 * addresses are rounded up to the nearest page. An extra page is added to the
1852 * highest kernel symbol and highest module symbol to, hopefully, encompass that
1853 * symbol too. Because it contains only code sections, the resulting kcore is
1854 * unusual. One significant peculiarity is that the mapping (start -> pgoff)
1855 * is not the same for the kernel map and the modules map. That happens because
1856 * the data is copied adjacently whereas the original kcore has gaps. Finally,
1857 * kallsyms and modules files are compared with their copies to check that
1858 * modules have not been loaded or unloaded while the copies were taking place.
1860 * Return: %0 on success, %-1 on failure.
1862 int kcore_copy(const char *from_dir, const char *to_dir)
1865 struct kcore extract;
1866 int idx = 0, err = -1;
1868 struct kcore_copy_info kci = { .stext = 0, };
1869 char kcore_filename[PATH_MAX];
1870 char extract_filename[PATH_MAX];
1871 struct phdr_data *p;
1873 INIT_LIST_HEAD(&kci.phdrs);
1874 INIT_LIST_HEAD(&kci.syms);
1876 if (kcore_copy__copy_file(from_dir, to_dir, "kallsyms"))
1879 if (kcore_copy__copy_file(from_dir, to_dir, "modules"))
1880 goto out_unlink_kallsyms;
1882 scnprintf(kcore_filename, PATH_MAX, "%s/kcore", from_dir);
1883 scnprintf(extract_filename, PATH_MAX, "%s/kcore", to_dir);
1885 if (kcore__open(&kcore, kcore_filename))
1886 goto out_unlink_modules;
1888 if (kcore_copy__calc_maps(&kci, from_dir, kcore.elf))
1889 goto out_kcore_close;
1891 if (kcore__init(&extract, extract_filename, kcore.elfclass, false))
1892 goto out_kcore_close;
1894 if (kcore__copy_hdr(&kcore, &extract, kci.phnum))
1895 goto out_extract_close;
1897 offset = gelf_fsize(extract.elf, ELF_T_EHDR, 1, EV_CURRENT) +
1898 gelf_fsize(extract.elf, ELF_T_PHDR, kci.phnum, EV_CURRENT);
1899 offset = round_up(offset, page_size);
1901 kcore_copy__for_each_phdr(&kci, p) {
1902 off_t offs = p->rel + offset;
1904 if (kcore__add_phdr(&extract, idx++, offs, p->addr, p->len))
1905 goto out_extract_close;
1908 sz = kcore__write(&extract);
1909 if (sz < 0 || sz > offset)
1910 goto out_extract_close;
1912 kcore_copy__for_each_phdr(&kci, p) {
1913 off_t offs = p->rel + offset;
1917 if (copy_bytes(kcore.fd, p->offset, extract.fd, offs, p->len))
1918 goto out_extract_close;
1921 if (kcore_copy__compare_file(from_dir, to_dir, "modules"))
1922 goto out_extract_close;
1924 if (kcore_copy__compare_file(from_dir, to_dir, "kallsyms"))
1925 goto out_extract_close;
1930 kcore__close(&extract);
1932 unlink(extract_filename);
1934 kcore__close(&kcore);
1937 kcore_copy__unlink(to_dir, "modules");
1938 out_unlink_kallsyms:
1940 kcore_copy__unlink(to_dir, "kallsyms");
1942 kcore_copy__free_phdrs(&kci);
1943 kcore_copy__free_syms(&kci);
1948 int kcore_extract__create(struct kcore_extract *kce)
1951 struct kcore extract;
1953 int idx = 0, err = -1;
1954 off_t offset = page_size, sz;
1956 if (kcore__open(&kcore, kce->kcore_filename))
1959 strcpy(kce->extract_filename, PERF_KCORE_EXTRACT);
1960 if (kcore__init(&extract, kce->extract_filename, kcore.elfclass, true))
1961 goto out_kcore_close;
1963 if (kcore__copy_hdr(&kcore, &extract, count))
1964 goto out_extract_close;
1966 if (kcore__add_phdr(&extract, idx, offset, kce->addr, kce->len))
1967 goto out_extract_close;
1969 sz = kcore__write(&extract);
1970 if (sz < 0 || sz > offset)
1971 goto out_extract_close;
1973 if (copy_bytes(kcore.fd, kce->offs, extract.fd, offset, kce->len))
1974 goto out_extract_close;
1979 kcore__close(&extract);
1981 unlink(kce->extract_filename);
1983 kcore__close(&kcore);
1988 void kcore_extract__delete(struct kcore_extract *kce)
1990 unlink(kce->extract_filename);
1993 #ifdef HAVE_GELF_GETNOTE_SUPPORT
1995 static void sdt_adjust_loc(struct sdt_note *tmp, GElf_Addr base_off)
2001 tmp->addr.a32[SDT_NOTE_IDX_LOC] =
2002 tmp->addr.a32[SDT_NOTE_IDX_LOC] + base_off -
2003 tmp->addr.a32[SDT_NOTE_IDX_BASE];
2005 tmp->addr.a64[SDT_NOTE_IDX_LOC] =
2006 tmp->addr.a64[SDT_NOTE_IDX_LOC] + base_off -
2007 tmp->addr.a64[SDT_NOTE_IDX_BASE];
2010 static void sdt_adjust_refctr(struct sdt_note *tmp, GElf_Addr base_addr,
2016 if (tmp->bit32 && tmp->addr.a32[SDT_NOTE_IDX_REFCTR])
2017 tmp->addr.a32[SDT_NOTE_IDX_REFCTR] -= (base_addr - base_off);
2018 else if (tmp->addr.a64[SDT_NOTE_IDX_REFCTR])
2019 tmp->addr.a64[SDT_NOTE_IDX_REFCTR] -= (base_addr - base_off);
2023 * populate_sdt_note : Parse raw data and identify SDT note
2024 * @elf: elf of the opened file
2025 * @data: raw data of a section with description offset applied
2026 * @len: note description size
2027 * @type: type of the note
2028 * @sdt_notes: List to add the SDT note
2030 * Responsible for parsing the @data in section .note.stapsdt in @elf and
2031 * if its an SDT note, it appends to @sdt_notes list.
2033 static int populate_sdt_note(Elf **elf, const char *data, size_t len,
2034 struct list_head *sdt_notes)
2036 const char *provider, *name, *args;
2037 struct sdt_note *tmp = NULL;
2043 Elf64_Addr a64[NR_ADDR];
2044 Elf32_Addr a32[NR_ADDR];
2048 .d_buf = &buf, .d_type = ELF_T_ADDR, .d_version = EV_CURRENT,
2049 .d_size = gelf_fsize((*elf), ELF_T_ADDR, NR_ADDR, EV_CURRENT),
2050 .d_off = 0, .d_align = 0
2053 .d_buf = (void *) data, .d_type = ELF_T_ADDR,
2054 .d_version = EV_CURRENT, .d_size = dst.d_size, .d_off = 0,
2058 tmp = (struct sdt_note *)calloc(1, sizeof(struct sdt_note));
2064 INIT_LIST_HEAD(&tmp->note_list);
2066 if (len < dst.d_size + 3)
2069 /* Translation from file representation to memory representation */
2070 if (gelf_xlatetom(*elf, &dst, &src,
2071 elf_getident(*elf, NULL)[EI_DATA]) == NULL) {
2072 pr_err("gelf_xlatetom : %s\n", elf_errmsg(-1));
2076 /* Populate the fields of sdt_note */
2077 provider = data + dst.d_size;
2079 name = (const char *)memchr(provider, '\0', data + len - provider);
2083 tmp->provider = strdup(provider);
2084 if (!tmp->provider) {
2088 tmp->name = strdup(name);
2094 args = memchr(name, '\0', data + len - name);
2097 * There is no argument if:
2098 * - We reached the end of the note;
2099 * - There is not enough room to hold a potential string;
2100 * - The argument string is empty or just contains ':'.
2102 if (args == NULL || data + len - args < 2 ||
2103 args[1] == ':' || args[1] == '\0')
2106 tmp->args = strdup(++args);
2113 if (gelf_getclass(*elf) == ELFCLASS32) {
2114 memcpy(&tmp->addr, &buf, 3 * sizeof(Elf32_Addr));
2117 memcpy(&tmp->addr, &buf, 3 * sizeof(Elf64_Addr));
2121 if (!gelf_getehdr(*elf, &ehdr)) {
2122 pr_debug("%s : cannot get elf header.\n", __func__);
2127 /* Adjust the prelink effect :
2128 * Find out the .stapsdt.base section.
2129 * This scn will help us to handle prelinking (if present).
2130 * Compare the retrieved file offset of the base section with the
2131 * base address in the description of the SDT note. If its different,
2132 * then accordingly, adjust the note location.
2134 if (elf_section_by_name(*elf, &ehdr, &shdr, SDT_BASE_SCN, NULL))
2135 sdt_adjust_loc(tmp, shdr.sh_offset);
2137 /* Adjust reference counter offset */
2138 if (elf_section_by_name(*elf, &ehdr, &shdr, SDT_PROBES_SCN, NULL))
2139 sdt_adjust_refctr(tmp, shdr.sh_addr, shdr.sh_offset);
2141 list_add_tail(&tmp->note_list, sdt_notes);
2149 zfree(&tmp->provider);
2157 * construct_sdt_notes_list : constructs a list of SDT notes
2158 * @elf : elf to look into
2159 * @sdt_notes : empty list_head
2161 * Scans the sections in 'elf' for the section
2162 * .note.stapsdt. It, then calls populate_sdt_note to find
2163 * out the SDT events and populates the 'sdt_notes'.
2165 static int construct_sdt_notes_list(Elf *elf, struct list_head *sdt_notes)
2168 Elf_Scn *scn = NULL;
2171 size_t shstrndx, next;
2173 size_t name_off, desc_off, offset;
2176 if (gelf_getehdr(elf, &ehdr) == NULL) {
2180 if (elf_getshdrstrndx(elf, &shstrndx) != 0) {
2185 /* Look for the required section */
2186 scn = elf_section_by_name(elf, &ehdr, &shdr, SDT_NOTE_SCN, NULL);
2192 if ((shdr.sh_type != SHT_NOTE) || (shdr.sh_flags & SHF_ALLOC)) {
2197 data = elf_getdata(scn, NULL);
2199 /* Get the SDT notes */
2200 for (offset = 0; (next = gelf_getnote(data, offset, &nhdr, &name_off,
2201 &desc_off)) > 0; offset = next) {
2202 if (nhdr.n_namesz == sizeof(SDT_NOTE_NAME) &&
2203 !memcmp(data->d_buf + name_off, SDT_NOTE_NAME,
2204 sizeof(SDT_NOTE_NAME))) {
2205 /* Check the type of the note */
2206 if (nhdr.n_type != SDT_NOTE_TYPE)
2209 ret = populate_sdt_note(&elf, ((data->d_buf) + desc_off),
2210 nhdr.n_descsz, sdt_notes);
2215 if (list_empty(sdt_notes))
2223 * get_sdt_note_list : Wrapper to construct a list of sdt notes
2224 * @head : empty list_head
2225 * @target : file to find SDT notes from
2227 * This opens the file, initializes
2228 * the ELF and then calls construct_sdt_notes_list.
2230 int get_sdt_note_list(struct list_head *head, const char *target)
2235 fd = open(target, O_RDONLY);
2239 elf = elf_begin(fd, PERF_ELF_C_READ_MMAP, NULL);
2244 ret = construct_sdt_notes_list(elf, head);
2252 * cleanup_sdt_note_list : free the sdt notes' list
2253 * @sdt_notes: sdt notes' list
2255 * Free up the SDT notes in @sdt_notes.
2256 * Returns the number of SDT notes free'd.
2258 int cleanup_sdt_note_list(struct list_head *sdt_notes)
2260 struct sdt_note *tmp, *pos;
2263 list_for_each_entry_safe(pos, tmp, sdt_notes, note_list) {
2264 list_del_init(&pos->note_list);
2266 zfree(&pos->provider);
2274 * sdt_notes__get_count: Counts the number of sdt events
2275 * @start: list_head to sdt_notes list
2277 * Returns the number of SDT notes in a list
2279 int sdt_notes__get_count(struct list_head *start)
2281 struct sdt_note *sdt_ptr;
2284 list_for_each_entry(sdt_ptr, start, note_list)
2290 void symbol__elf_init(void)
2292 elf_version(EV_CURRENT);