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 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 event_group, 112 demangle, 113 demangle_kernel, 114 filter_relative, 115 show_hist_headers, 116 branch_callstack, 117 has_filter, 118 show_ref_callgraph, 119 hide_unresolved, 120 raw_trace, 121 report_hierarchy, 122 inline_name; 123 const char *vmlinux_name, 124 *kallsyms_name, 125 *source_prefix, 126 *field_sep, 127 *graph_function; 128 const char *default_guest_vmlinux_name, 129 *default_guest_kallsyms, 130 *default_guest_modules; 131 const char *guestmount; 132 const char *dso_list_str, 133 *comm_list_str, 134 *pid_list_str, 135 *tid_list_str, 136 *sym_list_str, 137 *col_width_list_str, 138 *bt_stop_list_str; 139 struct strlist *dso_list, 140 *comm_list, 141 *sym_list, 142 *dso_from_list, 143 *dso_to_list, 144 *sym_from_list, 145 *sym_to_list, 146 *bt_stop_list; 147 struct intlist *pid_list, 148 *tid_list; 149 const char *symfs; 150 }; 151 152 extern struct symbol_conf symbol_conf; 153 154 struct symbol_name_rb_node { 155 struct rb_node rb_node; 156 struct symbol sym; 157 }; 158 159 static inline int __symbol__join_symfs(char *bf, size_t size, const char *path) 160 { 161 return path__join(bf, size, symbol_conf.symfs, path); 162 } 163 164 #define symbol__join_symfs(bf, path) __symbol__join_symfs(bf, sizeof(bf), path) 165 166 extern int vmlinux_path__nr_entries; 167 extern char **vmlinux_path; 168 169 static inline void *symbol__priv(struct symbol *sym) 170 { 171 return ((void *)sym) - symbol_conf.priv_size; 172 } 173 174 struct ref_reloc_sym { 175 const char *name; 176 u64 addr; 177 u64 unrelocated_addr; 178 }; 179 180 struct map_symbol { 181 struct map *map; 182 struct symbol *sym; 183 }; 184 185 struct addr_map_symbol { 186 struct map *map; 187 struct symbol *sym; 188 u64 addr; 189 u64 al_addr; 190 u64 phys_addr; 191 }; 192 193 struct branch_info { 194 struct addr_map_symbol from; 195 struct addr_map_symbol to; 196 struct branch_flags flags; 197 char *srcline_from; 198 char *srcline_to; 199 }; 200 201 struct mem_info { 202 struct addr_map_symbol iaddr; 203 struct addr_map_symbol daddr; 204 union perf_mem_data_src data_src; 205 refcount_t refcnt; 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, 262 struct symbol *sym); 263 264 struct symbol *dso__find_symbol(struct dso *dso, u64 addr); 265 struct symbol *dso__find_symbol_by_name(struct dso *dso, const char *name); 266 267 struct symbol *symbol__next_by_name(struct symbol *sym); 268 269 struct symbol *dso__first_symbol(struct dso *dso); 270 struct symbol *dso__last_symbol(struct dso *dso); 271 struct symbol *dso__next_symbol(struct symbol *sym); 272 273 enum dso_type dso__type_fd(int fd); 274 275 int filename__read_build_id(const char *filename, void *bf, size_t size); 276 int sysfs__read_build_id(const char *filename, void *bf, size_t size); 277 int modules__parse(const char *filename, void *arg, 278 int (*process_module)(void *arg, const char *name, 279 u64 start, u64 size)); 280 int filename__read_debuglink(const char *filename, char *debuglink, 281 size_t size); 282 283 struct perf_env; 284 int symbol__init(struct perf_env *env); 285 void symbol__exit(void); 286 void symbol__elf_init(void); 287 int symbol__annotation_init(void); 288 289 struct symbol *symbol__new(u64 start, u64 len, u8 binding, u8 type, const char *name); 290 size_t __symbol__fprintf_symname_offs(const struct symbol *sym, 291 const struct addr_location *al, 292 bool unknown_as_addr, 293 bool print_offsets, FILE *fp); 294 size_t symbol__fprintf_symname_offs(const struct symbol *sym, 295 const struct addr_location *al, FILE *fp); 296 size_t __symbol__fprintf_symname(const struct symbol *sym, 297 const struct addr_location *al, 298 bool unknown_as_addr, FILE *fp); 299 size_t symbol__fprintf_symname(const struct symbol *sym, FILE *fp); 300 size_t symbol__fprintf(struct symbol *sym, FILE *fp); 301 bool symbol__restricted_filename(const char *filename, 302 const char *restricted_filename); 303 int symbol__config_symfs(const struct option *opt __maybe_unused, 304 const char *dir, int unset __maybe_unused); 305 306 int dso__load_sym(struct dso *dso, struct map *map, struct symsrc *syms_ss, 307 struct symsrc *runtime_ss, int kmodule); 308 int dso__synthesize_plt_symbols(struct dso *dso, struct symsrc *ss); 309 310 char *dso__demangle_sym(struct dso *dso, int kmodule, const char *elf_name); 311 312 void __symbols__insert(struct rb_root *symbols, struct symbol *sym, bool kernel); 313 void symbols__insert(struct rb_root *symbols, struct symbol *sym); 314 void symbols__fixup_duplicate(struct rb_root *symbols); 315 void symbols__fixup_end(struct rb_root *symbols); 316 void map_groups__fixup_end(struct map_groups *mg); 317 318 typedef int (*mapfn_t)(u64 start, u64 len, u64 pgoff, void *data); 319 int file__read_maps(int fd, bool exe, mapfn_t mapfn, void *data, 320 bool *is_64_bit); 321 322 #define PERF_KCORE_EXTRACT "/tmp/perf-kcore-XXXXXX" 323 324 struct kcore_extract { 325 char *kcore_filename; 326 u64 addr; 327 u64 offs; 328 u64 len; 329 char extract_filename[sizeof(PERF_KCORE_EXTRACT)]; 330 int fd; 331 }; 332 333 int kcore_extract__create(struct kcore_extract *kce); 334 void kcore_extract__delete(struct kcore_extract *kce); 335 336 int kcore_copy(const char *from_dir, const char *to_dir); 337 int compare_proc_modules(const char *from, const char *to); 338 339 int setup_list(struct strlist **list, const char *list_str, 340 const char *list_name); 341 int setup_intlist(struct intlist **list, const char *list_str, 342 const char *list_name); 343 344 #ifdef HAVE_LIBELF_SUPPORT 345 bool elf__needs_adjust_symbols(GElf_Ehdr ehdr); 346 void arch__sym_update(struct symbol *s, GElf_Sym *sym); 347 #endif 348 349 const char *arch__normalize_symbol_name(const char *name); 350 #define SYMBOL_A 0 351 #define SYMBOL_B 1 352 353 int arch__compare_symbol_names(const char *namea, const char *nameb); 354 int arch__compare_symbol_names_n(const char *namea, const char *nameb, 355 unsigned int n); 356 int arch__choose_best_symbol(struct symbol *syma, struct symbol *symb); 357 358 enum symbol_tag_include { 359 SYMBOL_TAG_INCLUDE__NONE = 0, 360 SYMBOL_TAG_INCLUDE__DEFAULT_ONLY 361 }; 362 363 int symbol__match_symbol_name(const char *namea, const char *nameb, 364 enum symbol_tag_include includes); 365 366 /* structure containing an SDT note's info */ 367 struct sdt_note { 368 char *name; /* name of the note*/ 369 char *provider; /* provider name */ 370 char *args; 371 bool bit32; /* whether the location is 32 bits? */ 372 union { /* location, base and semaphore addrs */ 373 Elf64_Addr a64[3]; 374 Elf32_Addr a32[3]; 375 } addr; 376 struct list_head note_list; /* SDT notes' list */ 377 }; 378 379 int get_sdt_note_list(struct list_head *head, const char *target); 380 int cleanup_sdt_note_list(struct list_head *sdt_notes); 381 int sdt_notes__get_count(struct list_head *start); 382 383 #define SDT_PROBES_SCN ".probes" 384 #define SDT_BASE_SCN ".stapsdt.base" 385 #define SDT_NOTE_SCN ".note.stapsdt" 386 #define SDT_NOTE_TYPE 3 387 #define SDT_NOTE_NAME "stapsdt" 388 #define NR_ADDR 3 389 390 enum { 391 SDT_NOTE_IDX_LOC = 0, 392 SDT_NOTE_IDX_BASE, 393 SDT_NOTE_IDX_REFCTR, 394 }; 395 396 struct mem_info *mem_info__new(void); 397 struct mem_info *mem_info__get(struct mem_info *mi); 398 void mem_info__put(struct mem_info *mi); 399 400 static inline void __mem_info__zput(struct mem_info **mi) 401 { 402 mem_info__put(*mi); 403 *mi = NULL; 404 } 405 406 #define mem_info__zput(mi) __mem_info__zput(&mi) 407 408 #endif /* __PERF_SYMBOL */ 409