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 type:4; 61 u8 binding:4; 62 u8 idle:1; 63 u8 ignore:1; 64 u8 inlined:1; 65 u8 arch_sym; 66 char name[0]; 67 }; 68 69 void symbol__delete(struct symbol *sym); 70 void symbols__delete(struct rb_root *symbols); 71 72 /* symbols__for_each_entry - iterate over symbols (rb_root) 73 * 74 * @symbols: the rb_root of symbols 75 * @pos: the 'struct symbol *' to use as a loop cursor 76 * @nd: the 'struct rb_node *' to use as a temporary storage 77 */ 78 #define symbols__for_each_entry(symbols, pos, nd) \ 79 for (nd = rb_first(symbols); \ 80 nd && (pos = rb_entry(nd, struct symbol, rb_node)); \ 81 nd = rb_next(nd)) 82 83 static inline size_t symbol__size(const struct symbol *sym) 84 { 85 return sym->end - sym->start; 86 } 87 88 struct strlist; 89 struct intlist; 90 91 struct symbol_conf { 92 unsigned short priv_size; 93 unsigned short nr_events; 94 bool try_vmlinux_path, 95 init_annotation, 96 force, 97 ignore_vmlinux, 98 ignore_vmlinux_buildid, 99 show_kernel_path, 100 use_modules, 101 allow_aliases, 102 sort_by_name, 103 show_nr_samples, 104 show_total_period, 105 use_callchain, 106 cumulate_callchain, 107 show_branchflag_count, 108 exclude_other, 109 show_cpu_utilization, 110 initialized, 111 kptr_restrict, 112 annotate_asm_raw, 113 annotate_src, 114 event_group, 115 demangle, 116 demangle_kernel, 117 filter_relative, 118 show_hist_headers, 119 branch_callstack, 120 has_filter, 121 show_ref_callgraph, 122 hide_unresolved, 123 raw_trace, 124 report_hierarchy, 125 inline_name; 126 const char *vmlinux_name, 127 *kallsyms_name, 128 *source_prefix, 129 *field_sep; 130 const char *default_guest_vmlinux_name, 131 *default_guest_kallsyms, 132 *default_guest_modules; 133 const char *guestmount; 134 const char *dso_list_str, 135 *comm_list_str, 136 *pid_list_str, 137 *tid_list_str, 138 *sym_list_str, 139 *col_width_list_str, 140 *bt_stop_list_str; 141 struct strlist *dso_list, 142 *comm_list, 143 *sym_list, 144 *dso_from_list, 145 *dso_to_list, 146 *sym_from_list, 147 *sym_to_list, 148 *bt_stop_list; 149 struct intlist *pid_list, 150 *tid_list; 151 const char *symfs; 152 }; 153 154 extern struct symbol_conf symbol_conf; 155 156 struct symbol_name_rb_node { 157 struct rb_node rb_node; 158 struct symbol sym; 159 }; 160 161 static inline int __symbol__join_symfs(char *bf, size_t size, const char *path) 162 { 163 return path__join(bf, size, symbol_conf.symfs, path); 164 } 165 166 #define symbol__join_symfs(bf, path) __symbol__join_symfs(bf, sizeof(bf), path) 167 168 extern int vmlinux_path__nr_entries; 169 extern char **vmlinux_path; 170 171 static inline void *symbol__priv(struct symbol *sym) 172 { 173 return ((void *)sym) - symbol_conf.priv_size; 174 } 175 176 struct ref_reloc_sym { 177 const char *name; 178 u64 addr; 179 u64 unrelocated_addr; 180 }; 181 182 struct map_symbol { 183 struct map *map; 184 struct symbol *sym; 185 }; 186 187 struct addr_map_symbol { 188 struct map *map; 189 struct symbol *sym; 190 u64 addr; 191 u64 al_addr; 192 u64 phys_addr; 193 }; 194 195 struct branch_info { 196 struct addr_map_symbol from; 197 struct addr_map_symbol to; 198 struct branch_flags flags; 199 char *srcline_from; 200 char *srcline_to; 201 }; 202 203 struct mem_info { 204 struct addr_map_symbol iaddr; 205 struct addr_map_symbol daddr; 206 union perf_mem_data_src data_src; 207 refcount_t refcnt; 208 }; 209 210 struct addr_location { 211 struct machine *machine; 212 struct thread *thread; 213 struct map *map; 214 struct symbol *sym; 215 const char *srcline; 216 u64 addr; 217 char level; 218 u8 filtered; 219 u8 cpumode; 220 s32 cpu; 221 s32 socket; 222 }; 223 224 struct symsrc { 225 char *name; 226 int fd; 227 enum dso_binary_type type; 228 229 #ifdef HAVE_LIBELF_SUPPORT 230 Elf *elf; 231 GElf_Ehdr ehdr; 232 233 Elf_Scn *opdsec; 234 size_t opdidx; 235 GElf_Shdr opdshdr; 236 237 Elf_Scn *symtab; 238 GElf_Shdr symshdr; 239 240 Elf_Scn *dynsym; 241 size_t dynsym_idx; 242 GElf_Shdr dynshdr; 243 244 bool adjust_symbols; 245 bool is_64_bit; 246 #endif 247 }; 248 249 void symsrc__destroy(struct symsrc *ss); 250 int symsrc__init(struct symsrc *ss, struct dso *dso, const char *name, 251 enum dso_binary_type type); 252 bool symsrc__has_symtab(struct symsrc *ss); 253 bool symsrc__possibly_runtime(struct symsrc *ss); 254 255 int dso__load(struct dso *dso, struct map *map); 256 int dso__load_vmlinux(struct dso *dso, struct map *map, 257 const char *vmlinux, bool vmlinux_allocated); 258 int dso__load_vmlinux_path(struct dso *dso, struct map *map); 259 int __dso__load_kallsyms(struct dso *dso, const char *filename, struct map *map, 260 bool no_kcore); 261 int dso__load_kallsyms(struct dso *dso, const char *filename, struct map *map); 262 263 void dso__insert_symbol(struct dso *dso, 264 struct symbol *sym); 265 266 struct symbol *dso__find_symbol(struct dso *dso, u64 addr); 267 struct symbol *dso__find_symbol_by_name(struct dso *dso, const char *name); 268 269 struct symbol *symbol__next_by_name(struct symbol *sym); 270 271 struct symbol *dso__first_symbol(struct dso *dso); 272 struct symbol *dso__last_symbol(struct dso *dso); 273 struct symbol *dso__next_symbol(struct symbol *sym); 274 275 enum dso_type dso__type_fd(int fd); 276 277 int filename__read_build_id(const char *filename, void *bf, size_t size); 278 int sysfs__read_build_id(const char *filename, void *bf, size_t size); 279 int modules__parse(const char *filename, void *arg, 280 int (*process_module)(void *arg, const char *name, 281 u64 start, u64 size)); 282 int filename__read_debuglink(const char *filename, char *debuglink, 283 size_t size); 284 285 struct perf_env; 286 int symbol__init(struct perf_env *env); 287 void symbol__exit(void); 288 void symbol__elf_init(void); 289 int symbol__annotation_init(void); 290 291 struct symbol *symbol__new(u64 start, u64 len, u8 binding, u8 type, const char *name); 292 size_t __symbol__fprintf_symname_offs(const struct symbol *sym, 293 const struct addr_location *al, 294 bool unknown_as_addr, 295 bool print_offsets, FILE *fp); 296 size_t symbol__fprintf_symname_offs(const struct symbol *sym, 297 const struct addr_location *al, FILE *fp); 298 size_t __symbol__fprintf_symname(const struct symbol *sym, 299 const struct addr_location *al, 300 bool unknown_as_addr, FILE *fp); 301 size_t symbol__fprintf_symname(const struct symbol *sym, FILE *fp); 302 size_t symbol__fprintf(struct symbol *sym, FILE *fp); 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 312 char *dso__demangle_sym(struct dso *dso, int kmodule, const char *elf_name); 313 314 void __symbols__insert(struct rb_root *symbols, struct symbol *sym, bool kernel); 315 void symbols__insert(struct rb_root *symbols, struct symbol *sym); 316 void symbols__fixup_duplicate(struct rb_root *symbols); 317 void symbols__fixup_end(struct rb_root *symbols); 318 void map_groups__fixup_end(struct map_groups *mg); 319 320 typedef int (*mapfn_t)(u64 start, u64 len, u64 pgoff, void *data); 321 int file__read_maps(int fd, bool exe, mapfn_t mapfn, void *data, 322 bool *is_64_bit); 323 324 #define PERF_KCORE_EXTRACT "/tmp/perf-kcore-XXXXXX" 325 326 struct kcore_extract { 327 char *kcore_filename; 328 u64 addr; 329 u64 offs; 330 u64 len; 331 char extract_filename[sizeof(PERF_KCORE_EXTRACT)]; 332 int fd; 333 }; 334 335 int kcore_extract__create(struct kcore_extract *kce); 336 void kcore_extract__delete(struct kcore_extract *kce); 337 338 int kcore_copy(const char *from_dir, const char *to_dir); 339 int compare_proc_modules(const char *from, const char *to); 340 341 int setup_list(struct strlist **list, const char *list_str, 342 const char *list_name); 343 int setup_intlist(struct intlist **list, const char *list_str, 344 const char *list_name); 345 346 #ifdef HAVE_LIBELF_SUPPORT 347 bool elf__needs_adjust_symbols(GElf_Ehdr ehdr); 348 void arch__sym_update(struct symbol *s, GElf_Sym *sym); 349 #endif 350 351 const char *arch__normalize_symbol_name(const char *name); 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 struct mem_info *mem_info__new(void); 392 struct mem_info *mem_info__get(struct mem_info *mi); 393 void mem_info__put(struct mem_info *mi); 394 395 static inline void __mem_info__zput(struct mem_info **mi) 396 { 397 mem_info__put(*mi); 398 *mi = NULL; 399 } 400 401 #define mem_info__zput(mi) __mem_info__zput(&mi) 402 403 #endif /* __PERF_SYMBOL */ 404