1 /* SPDX-License-Identifier: GPL-2.0 */ 2 #ifndef __PERF_SYMBOL 3 #define __PERF_SYMBOL 1 4 5 #include <linux/types.h> 6 #include <stdbool.h> 7 #include <stdint.h> 8 #include "map.h" 9 #include "../perf.h" 10 #include <linux/list.h> 11 #include <linux/rbtree.h> 12 #include <stdio.h> 13 #include <byteswap.h> 14 #include <libgen.h> 15 #include "build-id.h" 16 #include "event.h" 17 #include "path.h" 18 19 #ifdef HAVE_LIBELF_SUPPORT 20 #include <libelf.h> 21 #include <gelf.h> 22 #endif 23 #include <elf.h> 24 25 #include "dso.h" 26 27 /* 28 * libelf 0.8.x and earlier do not support ELF_C_READ_MMAP; 29 * for newer versions we can use mmap to reduce memory usage: 30 */ 31 #ifdef HAVE_LIBELF_MMAP_SUPPORT 32 # define PERF_ELF_C_READ_MMAP ELF_C_READ_MMAP 33 #else 34 # define PERF_ELF_C_READ_MMAP ELF_C_READ 35 #endif 36 37 #ifdef HAVE_LIBELF_SUPPORT 38 Elf_Scn *elf_section_by_name(Elf *elf, GElf_Ehdr *ep, 39 GElf_Shdr *shp, const char *name, size_t *idx); 40 #endif 41 42 #ifndef DMGL_PARAMS 43 #define DMGL_NO_OPTS 0 /* For readability... */ 44 #define DMGL_PARAMS (1 << 0) /* Include function args */ 45 #define DMGL_ANSI (1 << 1) /* Include const, volatile, etc */ 46 #endif 47 48 #define DSO__NAME_KALLSYMS "[kernel.kallsyms]" 49 #define DSO__NAME_KCORE "[kernel.kcore]" 50 51 /** struct symbol - symtab entry 52 * 53 * @ignore - resolvable but tools ignore it (e.g. idle routines) 54 */ 55 struct symbol { 56 struct rb_node rb_node; 57 u64 start; 58 u64 end; 59 u16 namelen; 60 u8 binding; 61 u8 idle:1; 62 u8 ignore:1; 63 u8 inlined:1; 64 u8 arch_sym; 65 char name[0]; 66 }; 67 68 void symbol__delete(struct symbol *sym); 69 void symbols__delete(struct rb_root *symbols); 70 71 /* symbols__for_each_entry - iterate over symbols (rb_root) 72 * 73 * @symbols: the rb_root of symbols 74 * @pos: the 'struct symbol *' to use as a loop cursor 75 * @nd: the 'struct rb_node *' to use as a temporary storage 76 */ 77 #define symbols__for_each_entry(symbols, pos, nd) \ 78 for (nd = rb_first(symbols); \ 79 nd && (pos = rb_entry(nd, struct symbol, rb_node)); \ 80 nd = rb_next(nd)) 81 82 static inline size_t symbol__size(const struct symbol *sym) 83 { 84 return sym->end - sym->start; 85 } 86 87 struct strlist; 88 struct intlist; 89 90 struct symbol_conf { 91 unsigned short priv_size; 92 unsigned short nr_events; 93 bool try_vmlinux_path, 94 init_annotation, 95 force, 96 ignore_vmlinux, 97 ignore_vmlinux_buildid, 98 show_kernel_path, 99 use_modules, 100 allow_aliases, 101 sort_by_name, 102 show_nr_samples, 103 show_total_period, 104 use_callchain, 105 cumulate_callchain, 106 show_branchflag_count, 107 exclude_other, 108 show_cpu_utilization, 109 initialized, 110 kptr_restrict, 111 annotate_asm_raw, 112 annotate_src, 113 event_group, 114 demangle, 115 demangle_kernel, 116 filter_relative, 117 show_hist_headers, 118 branch_callstack, 119 has_filter, 120 show_ref_callgraph, 121 hide_unresolved, 122 raw_trace, 123 report_hierarchy, 124 inline_name; 125 const char *vmlinux_name, 126 *kallsyms_name, 127 *source_prefix, 128 *field_sep; 129 const char *default_guest_vmlinux_name, 130 *default_guest_kallsyms, 131 *default_guest_modules; 132 const char *guestmount; 133 const char *dso_list_str, 134 *comm_list_str, 135 *pid_list_str, 136 *tid_list_str, 137 *sym_list_str, 138 *col_width_list_str, 139 *bt_stop_list_str; 140 struct strlist *dso_list, 141 *comm_list, 142 *sym_list, 143 *dso_from_list, 144 *dso_to_list, 145 *sym_from_list, 146 *sym_to_list, 147 *bt_stop_list; 148 struct intlist *pid_list, 149 *tid_list; 150 const char *symfs; 151 }; 152 153 extern struct symbol_conf symbol_conf; 154 155 struct symbol_name_rb_node { 156 struct rb_node rb_node; 157 struct symbol sym; 158 }; 159 160 static inline int __symbol__join_symfs(char *bf, size_t size, const char *path) 161 { 162 return path__join(bf, size, symbol_conf.symfs, path); 163 } 164 165 #define symbol__join_symfs(bf, path) __symbol__join_symfs(bf, sizeof(bf), path) 166 167 extern int vmlinux_path__nr_entries; 168 extern char **vmlinux_path; 169 170 static inline void *symbol__priv(struct symbol *sym) 171 { 172 return ((void *)sym) - symbol_conf.priv_size; 173 } 174 175 struct ref_reloc_sym { 176 const char *name; 177 u64 addr; 178 u64 unrelocated_addr; 179 }; 180 181 struct map_symbol { 182 struct map *map; 183 struct symbol *sym; 184 }; 185 186 struct addr_map_symbol { 187 struct map *map; 188 struct symbol *sym; 189 u64 addr; 190 u64 al_addr; 191 u64 phys_addr; 192 }; 193 194 struct branch_info { 195 struct addr_map_symbol from; 196 struct addr_map_symbol to; 197 struct branch_flags flags; 198 char *srcline_from; 199 char *srcline_to; 200 }; 201 202 struct mem_info { 203 struct addr_map_symbol iaddr; 204 struct addr_map_symbol daddr; 205 union perf_mem_data_src data_src; 206 }; 207 208 struct addr_location { 209 struct machine *machine; 210 struct thread *thread; 211 struct map *map; 212 struct symbol *sym; 213 const char *srcline; 214 u64 addr; 215 char level; 216 u8 filtered; 217 u8 cpumode; 218 s32 cpu; 219 s32 socket; 220 }; 221 222 struct symsrc { 223 char *name; 224 int fd; 225 enum dso_binary_type type; 226 227 #ifdef HAVE_LIBELF_SUPPORT 228 Elf *elf; 229 GElf_Ehdr ehdr; 230 231 Elf_Scn *opdsec; 232 size_t opdidx; 233 GElf_Shdr opdshdr; 234 235 Elf_Scn *symtab; 236 GElf_Shdr symshdr; 237 238 Elf_Scn *dynsym; 239 size_t dynsym_idx; 240 GElf_Shdr dynshdr; 241 242 bool adjust_symbols; 243 bool is_64_bit; 244 #endif 245 }; 246 247 void symsrc__destroy(struct symsrc *ss); 248 int symsrc__init(struct symsrc *ss, struct dso *dso, const char *name, 249 enum dso_binary_type type); 250 bool symsrc__has_symtab(struct symsrc *ss); 251 bool symsrc__possibly_runtime(struct symsrc *ss); 252 253 int dso__load(struct dso *dso, struct map *map); 254 int dso__load_vmlinux(struct dso *dso, struct map *map, 255 const char *vmlinux, bool vmlinux_allocated); 256 int dso__load_vmlinux_path(struct dso *dso, struct map *map); 257 int __dso__load_kallsyms(struct dso *dso, const char *filename, struct map *map, 258 bool no_kcore); 259 int dso__load_kallsyms(struct dso *dso, const char *filename, struct map *map); 260 261 void dso__insert_symbol(struct dso *dso, enum map_type type, 262 struct symbol *sym); 263 264 struct symbol *dso__find_symbol(struct dso *dso, enum map_type type, 265 u64 addr); 266 struct symbol *dso__find_symbol_by_name(struct dso *dso, enum map_type type, 267 const char *name); 268 struct symbol *symbol__next_by_name(struct symbol *sym); 269 270 struct symbol *dso__first_symbol(struct dso *dso, enum map_type type); 271 struct symbol *dso__last_symbol(struct dso *dso, enum map_type type); 272 struct symbol *dso__next_symbol(struct symbol *sym); 273 274 enum dso_type dso__type_fd(int fd); 275 276 int filename__read_build_id(const char *filename, void *bf, size_t size); 277 int sysfs__read_build_id(const char *filename, void *bf, size_t size); 278 int modules__parse(const char *filename, void *arg, 279 int (*process_module)(void *arg, const char *name, 280 u64 start, u64 size)); 281 int filename__read_debuglink(const char *filename, char *debuglink, 282 size_t size); 283 284 struct perf_env; 285 int symbol__init(struct perf_env *env); 286 void symbol__exit(void); 287 void symbol__elf_init(void); 288 int symbol__annotation_init(void); 289 290 struct symbol *symbol__new(u64 start, u64 len, u8 binding, const char *name); 291 size_t __symbol__fprintf_symname_offs(const struct symbol *sym, 292 const struct addr_location *al, 293 bool unknown_as_addr, 294 bool print_offsets, FILE *fp); 295 size_t symbol__fprintf_symname_offs(const struct symbol *sym, 296 const struct addr_location *al, FILE *fp); 297 size_t __symbol__fprintf_symname(const struct symbol *sym, 298 const struct addr_location *al, 299 bool unknown_as_addr, FILE *fp); 300 size_t symbol__fprintf_symname(const struct symbol *sym, FILE *fp); 301 size_t symbol__fprintf(struct symbol *sym, FILE *fp); 302 bool symbol_type__is_a(char symbol_type, enum map_type map_type); 303 bool symbol__restricted_filename(const char *filename, 304 const char *restricted_filename); 305 int symbol__config_symfs(const struct option *opt __maybe_unused, 306 const char *dir, int unset __maybe_unused); 307 308 int dso__load_sym(struct dso *dso, struct map *map, struct symsrc *syms_ss, 309 struct symsrc *runtime_ss, int kmodule); 310 int dso__synthesize_plt_symbols(struct dso *dso, struct symsrc *ss, 311 struct map *map); 312 313 char *dso__demangle_sym(struct dso *dso, int kmodule, const char *elf_name); 314 315 void __symbols__insert(struct rb_root *symbols, struct symbol *sym, bool kernel); 316 void symbols__insert(struct rb_root *symbols, struct symbol *sym); 317 void symbols__fixup_duplicate(struct rb_root *symbols); 318 void symbols__fixup_end(struct rb_root *symbols); 319 void __map_groups__fixup_end(struct map_groups *mg, enum map_type type); 320 321 typedef int (*mapfn_t)(u64 start, u64 len, u64 pgoff, void *data); 322 int file__read_maps(int fd, bool exe, mapfn_t mapfn, void *data, 323 bool *is_64_bit); 324 325 #define PERF_KCORE_EXTRACT "/tmp/perf-kcore-XXXXXX" 326 327 struct kcore_extract { 328 char *kcore_filename; 329 u64 addr; 330 u64 offs; 331 u64 len; 332 char extract_filename[sizeof(PERF_KCORE_EXTRACT)]; 333 int fd; 334 }; 335 336 int kcore_extract__create(struct kcore_extract *kce); 337 void kcore_extract__delete(struct kcore_extract *kce); 338 339 int kcore_copy(const char *from_dir, const char *to_dir); 340 int compare_proc_modules(const char *from, const char *to); 341 342 int setup_list(struct strlist **list, const char *list_str, 343 const char *list_name); 344 int setup_intlist(struct intlist **list, const char *list_str, 345 const char *list_name); 346 347 #ifdef HAVE_LIBELF_SUPPORT 348 bool elf__needs_adjust_symbols(GElf_Ehdr ehdr); 349 void arch__sym_update(struct symbol *s, GElf_Sym *sym); 350 #endif 351 352 #define SYMBOL_A 0 353 #define SYMBOL_B 1 354 355 int arch__compare_symbol_names(const char *namea, const char *nameb); 356 int arch__compare_symbol_names_n(const char *namea, const char *nameb, 357 unsigned int n); 358 int arch__choose_best_symbol(struct symbol *syma, struct symbol *symb); 359 360 enum symbol_tag_include { 361 SYMBOL_TAG_INCLUDE__NONE = 0, 362 SYMBOL_TAG_INCLUDE__DEFAULT_ONLY 363 }; 364 365 int symbol__match_symbol_name(const char *namea, const char *nameb, 366 enum symbol_tag_include includes); 367 368 /* structure containing an SDT note's info */ 369 struct sdt_note { 370 char *name; /* name of the note*/ 371 char *provider; /* provider name */ 372 char *args; 373 bool bit32; /* whether the location is 32 bits? */ 374 union { /* location, base and semaphore addrs */ 375 Elf64_Addr a64[3]; 376 Elf32_Addr a32[3]; 377 } addr; 378 struct list_head note_list; /* SDT notes' list */ 379 }; 380 381 int get_sdt_note_list(struct list_head *head, const char *target); 382 int cleanup_sdt_note_list(struct list_head *sdt_notes); 383 int sdt_notes__get_count(struct list_head *start); 384 385 #define SDT_BASE_SCN ".stapsdt.base" 386 #define SDT_NOTE_SCN ".note.stapsdt" 387 #define SDT_NOTE_TYPE 3 388 #define SDT_NOTE_NAME "stapsdt" 389 #define NR_ADDR 3 390 391 #endif /* __PERF_SYMBOL */ 392