1/* SPDX-License-Identifier: GPL-2.0 */ 2#ifndef __PERF_SYMBOL 3#define __PERF_SYMBOL 1 4 5#include <linux/types.h> 6#include <linux/refcount.h> 7#include <stdbool.h> 8#include <stdint.h> 9#include <linux/list.h> 10#include <linux/rbtree.h> 11#include <stdio.h> 12#include "path.h" 13#include "symbol_conf.h" 14#include "spark.h" 15 16#ifdef HAVE_LIBELF_SUPPORT 17#include <libelf.h> 18#include <gelf.h> 19#endif 20#include <elf.h> 21 22struct dso; 23struct map; 24struct maps; 25struct option; 26struct build_id; 27 28/* 29 * libelf 0.8.x and earlier do not support ELF_C_READ_MMAP; 30 * for newer versions we can use mmap to reduce memory usage: 31 */ 32#ifdef ELF_C_READ_MMAP 33# define PERF_ELF_C_READ_MMAP ELF_C_READ_MMAP 34#else 35# define PERF_ELF_C_READ_MMAP ELF_C_READ 36#endif 37 38#ifdef HAVE_LIBELF_SUPPORT 39Elf_Scn *elf_section_by_name(Elf *elf, GElf_Ehdr *ep, 40 GElf_Shdr *shp, const char *name, size_t *idx); 41#endif 42 43/** struct symbol - symtab entry 44 * 45 * @ignore - resolvable but tools ignore it (e.g. idle routines) 46 */ 47struct symbol { 48 struct rb_node rb_node; 49 u64 start; 50 u64 end; 51 u16 namelen; 52 u8 type:4; 53 u8 binding:4; 54 u8 idle:1; 55 u8 ignore:1; 56 u8 inlined:1; 57 u8 arch_sym; 58 bool annotate2; 59 char name[]; 60}; 61 62void symbol__delete(struct symbol *sym); 63void symbols__delete(struct rb_root_cached *symbols); 64 65/* symbols__for_each_entry - iterate over symbols (rb_root) 66 * 67 * @symbols: the rb_root of symbols 68 * @pos: the 'struct symbol *' to use as a loop cursor 69 * @nd: the 'struct rb_node *' to use as a temporary storage 70 */ 71#define symbols__for_each_entry(symbols, pos, nd) \ 72 for (nd = rb_first_cached(symbols); \ 73 nd && (pos = rb_entry(nd, struct symbol, rb_node)); \ 74 nd = rb_next(nd)) 75 76static inline size_t symbol__size(const struct symbol *sym) 77{ 78 return sym->end - sym->start; 79} 80 81struct strlist; 82struct intlist; 83 84struct symbol_name_rb_node { 85 struct rb_node rb_node; 86 struct symbol sym; 87}; 88 89static inline int __symbol__join_symfs(char *bf, size_t size, const char *path) 90{ 91 return path__join(bf, size, symbol_conf.symfs, path); 92} 93 94#define symbol__join_symfs(bf, path) __symbol__join_symfs(bf, sizeof(bf), path) 95 96extern int vmlinux_path__nr_entries; 97extern char **vmlinux_path; 98 99static inline void *symbol__priv(struct symbol *sym) 100{ 101 return ((void *)sym) - symbol_conf.priv_size; 102} 103 104struct ref_reloc_sym { 105 const char *name; 106 u64 addr; 107 u64 unrelocated_addr; 108}; 109 110struct addr_location { 111 struct thread *thread; 112 struct maps *maps; 113 struct map *map; 114 struct symbol *sym; 115 const char *srcline; 116 u64 addr; 117 char level; 118 u8 filtered; 119 u8 cpumode; 120 s32 cpu; 121 s32 socket; 122}; 123 124int dso__load(struct dso *dso, struct map *map); 125int dso__load_vmlinux(struct dso *dso, struct map *map, 126 const char *vmlinux, bool vmlinux_allocated); 127int dso__load_vmlinux_path(struct dso *dso, struct map *map); 128int __dso__load_kallsyms(struct dso *dso, const char *filename, struct map *map, 129 bool no_kcore); 130int dso__load_kallsyms(struct dso *dso, const char *filename, struct map *map); 131 132void dso__insert_symbol(struct dso *dso, 133 struct symbol *sym); 134void dso__delete_symbol(struct dso *dso, 135 struct symbol *sym); 136 137struct symbol *dso__find_symbol(struct dso *dso, u64 addr); 138struct symbol *dso__find_symbol_by_name(struct dso *dso, const char *name); 139 140struct symbol *symbol__next_by_name(struct symbol *sym); 141 142struct symbol *dso__first_symbol(struct dso *dso); 143struct symbol *dso__last_symbol(struct dso *dso); 144struct symbol *dso__next_symbol(struct symbol *sym); 145 146enum dso_type dso__type_fd(int fd); 147 148int filename__read_build_id(const char *filename, struct build_id *id); 149int sysfs__read_build_id(const char *filename, struct build_id *bid); 150int modules__parse(const char *filename, void *arg, 151 int (*process_module)(void *arg, const char *name, 152 u64 start, u64 size)); 153int filename__read_debuglink(const char *filename, char *debuglink, 154 size_t size); 155 156struct perf_env; 157int symbol__init(struct perf_env *env); 158void symbol__exit(void); 159void symbol__elf_init(void); 160int symbol__annotation_init(void); 161 162struct symbol *symbol__new(u64 start, u64 len, u8 binding, u8 type, const char *name); 163size_t __symbol__fprintf_symname_offs(const struct symbol *sym, 164 const struct addr_location *al, 165 bool unknown_as_addr, 166 bool print_offsets, FILE *fp); 167size_t symbol__fprintf_symname_offs(const struct symbol *sym, 168 const struct addr_location *al, FILE *fp); 169size_t __symbol__fprintf_symname(const struct symbol *sym, 170 const struct addr_location *al, 171 bool unknown_as_addr, FILE *fp); 172size_t symbol__fprintf_symname(const struct symbol *sym, FILE *fp); 173size_t symbol__fprintf(struct symbol *sym, FILE *fp); 174bool symbol__restricted_filename(const char *filename, 175 const char *restricted_filename); 176int symbol__config_symfs(const struct option *opt __maybe_unused, 177 const char *dir, int unset __maybe_unused); 178 179struct symsrc; 180 181#ifdef HAVE_LIBBFD_SUPPORT 182int dso__load_bfd_symbols(struct dso *dso, const char *debugfile); 183#endif 184 185int dso__load_sym(struct dso *dso, struct map *map, struct symsrc *syms_ss, 186 struct symsrc *runtime_ss, int kmodule); 187int dso__synthesize_plt_symbols(struct dso *dso, struct symsrc *ss); 188 189char *dso__demangle_sym(struct dso *dso, int kmodule, const char *elf_name); 190 191void __symbols__insert(struct rb_root_cached *symbols, struct symbol *sym, 192 bool kernel); 193void symbols__insert(struct rb_root_cached *symbols, struct symbol *sym); 194void symbols__fixup_duplicate(struct rb_root_cached *symbols); 195void symbols__fixup_end(struct rb_root_cached *symbols, bool is_kallsyms); 196void maps__fixup_end(struct maps *maps); 197 198typedef int (*mapfn_t)(u64 start, u64 len, u64 pgoff, void *data); 199int file__read_maps(int fd, bool exe, mapfn_t mapfn, void *data, 200 bool *is_64_bit); 201 202#define PERF_KCORE_EXTRACT "/tmp/perf-kcore-XXXXXX" 203 204struct kcore_extract { 205 char *kcore_filename; 206 u64 addr; 207 u64 offs; 208 u64 len; 209 char extract_filename[sizeof(PERF_KCORE_EXTRACT)]; 210 int fd; 211}; 212 213int kcore_extract__create(struct kcore_extract *kce); 214void kcore_extract__delete(struct kcore_extract *kce); 215 216int kcore_copy(const char *from_dir, const char *to_dir); 217int compare_proc_modules(const char *from, const char *to); 218 219int setup_list(struct strlist **list, const char *list_str, 220 const char *list_name); 221int setup_intlist(struct intlist **list, const char *list_str, 222 const char *list_name); 223 224#ifdef HAVE_LIBELF_SUPPORT 225bool elf__needs_adjust_symbols(GElf_Ehdr ehdr); 226void arch__sym_update(struct symbol *s, GElf_Sym *sym); 227#endif 228 229const char *arch__normalize_symbol_name(const char *name); 230#define SYMBOL_A 0 231#define SYMBOL_B 1 232 233int arch__compare_symbol_names(const char *namea, const char *nameb); 234int arch__compare_symbol_names_n(const char *namea, const char *nameb, 235 unsigned int n); 236int arch__choose_best_symbol(struct symbol *syma, struct symbol *symb); 237 238enum symbol_tag_include { 239 SYMBOL_TAG_INCLUDE__NONE = 0, 240 SYMBOL_TAG_INCLUDE__DEFAULT_ONLY 241}; 242 243int symbol__match_symbol_name(const char *namea, const char *nameb, 244 enum symbol_tag_include includes); 245 246/* structure containing an SDT note's info */ 247struct sdt_note { 248 char *name; /* name of the note*/ 249 char *provider; /* provider name */ 250 char *args; 251 bool bit32; /* whether the location is 32 bits? */ 252 union { /* location, base and semaphore addrs */ 253 Elf64_Addr a64[3]; 254 Elf32_Addr a32[3]; 255 } addr; 256 struct list_head note_list; /* SDT notes' list */ 257}; 258 259int get_sdt_note_list(struct list_head *head, const char *target); 260int cleanup_sdt_note_list(struct list_head *sdt_notes); 261int sdt_notes__get_count(struct list_head *start); 262 263#define SDT_PROBES_SCN ".probes" 264#define SDT_BASE_SCN ".stapsdt.base" 265#define SDT_NOTE_SCN ".note.stapsdt" 266#define SDT_NOTE_TYPE 3 267#define SDT_NOTE_NAME "stapsdt" 268#define NR_ADDR 3 269 270enum { 271 SDT_NOTE_IDX_LOC = 0, 272 SDT_NOTE_IDX_BASE, 273 SDT_NOTE_IDX_REFCTR, 274}; 275 276struct mem_info *mem_info__new(void); 277struct mem_info *mem_info__get(struct mem_info *mi); 278void mem_info__put(struct mem_info *mi); 279 280static inline void __mem_info__zput(struct mem_info **mi) 281{ 282 mem_info__put(*mi); 283 *mi = NULL; 284} 285 286#define mem_info__zput(mi) __mem_info__zput(&mi) 287 288#endif /* __PERF_SYMBOL */ 289