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