tools/perf/util/symbol.h

   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              arch_sym;
  64         char            name[0];
  65 };
  66
  67 void symbol__delete(struct symbol *sym);
  68 void symbols__delete(struct rb_root *symbols);
  69
  70 /* symbols__for_each_entry - iterate over symbols (rb_root)
  71  *
  72  * @symbols: the rb_root of symbols
  73  * @pos: the 'struct symbol *' to use as a loop cursor
  74  * @nd: the 'struct rb_node *' to use as a temporary storage
  75  */
  76 #define symbols__for_each_entry(symbols, pos, nd)                       \
  77         for (nd = rb_first(symbols);                                    \
  78              nd && (pos = rb_entry(nd, struct symbol, rb_node));        \
  79              nd = rb_next(nd))
  80
  81 static inline size_t symbol__size(const struct symbol *sym)
  82 {
  83         return sym->end - sym->start;
  84 }
  85
  86 struct strlist;
  87 struct intlist;
  88
  89 struct symbol_conf {
  90         unsigned short  priv_size;
  91         unsigned short  nr_events;
  92         bool            try_vmlinux_path,
  93                         init_annotation,
  94                         force,
  95                         ignore_vmlinux,
  96                         ignore_vmlinux_buildid,
  97                         show_kernel_path,
  98                         use_modules,
  99                         allow_aliases,
 100                         sort_by_name,
 101                         show_nr_samples,
 102                         show_total_period,
 103                         use_callchain,
 104                         cumulate_callchain,
 105                         show_branchflag_count,
 106                         exclude_other,
 107                         show_cpu_utilization,
 108                         initialized,
 109                         kptr_restrict,
 110                         annotate_asm_raw,
 111                         annotate_src,
 112                         event_group,
 113                         demangle,
 114                         demangle_kernel,
 115                         filter_relative,
 116                         show_hist_headers,
 117                         branch_callstack,
 118                         has_filter,
 119                         show_ref_callgraph,
 120                         hide_unresolved,
 121                         raw_trace,
 122                         report_hierarchy,
 123                         inline_name;
 124         const char      *vmlinux_name,
 125                         *kallsyms_name,
 126                         *source_prefix,
 127                         *field_sep;
 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 };
 206
 207 struct addr_location {
 208         struct machine *machine;
 209         struct thread *thread;
 210         struct map    *map;
 211         struct symbol *sym;
 212         u64           addr;
 213         char          level;
 214         u8            filtered;
 215         u8            cpumode;
 216         s32           cpu;
 217         s32           socket;
 218 };
 219
 220 struct symsrc {
 221         char *name;
 222         int fd;
 223         enum dso_binary_type type;
 224
 225 #ifdef HAVE_LIBELF_SUPPORT
 226         Elf *elf;
 227         GElf_Ehdr ehdr;
 228
 229         Elf_Scn *opdsec;
 230         size_t opdidx;
 231         GElf_Shdr opdshdr;
 232
 233         Elf_Scn *symtab;
 234         GElf_Shdr symshdr;
 235
 236         Elf_Scn *dynsym;
 237         size_t dynsym_idx;
 238         GElf_Shdr dynshdr;
 239
 240         bool adjust_symbols;
 241         bool is_64_bit;
 242 #endif
 243 };
 244
 245 void symsrc__destroy(struct symsrc *ss);
 246 int symsrc__init(struct symsrc *ss, struct dso *dso, const char *name,
 247                  enum dso_binary_type type);
 248 bool symsrc__has_symtab(struct symsrc *ss);
 249 bool symsrc__possibly_runtime(struct symsrc *ss);
 250
 251 int dso__load(struct dso *dso, struct map *map);
 252 int dso__load_vmlinux(struct dso *dso, struct map *map,
 253                       const char *vmlinux, bool vmlinux_allocated);
 254 int dso__load_vmlinux_path(struct dso *dso, struct map *map);
 255 int __dso__load_kallsyms(struct dso *dso, const char *filename, struct map *map,
 256                          bool no_kcore);
 257 int dso__load_kallsyms(struct dso *dso, const char *filename, struct map *map);
 258
 259 void dso__insert_symbol(struct dso *dso, enum map_type type,
 260                         struct symbol *sym);
 261
 262 struct symbol *dso__find_symbol(struct dso *dso, enum map_type type,
 263                                 u64 addr);
 264 struct symbol *dso__find_symbol_by_name(struct dso *dso, enum map_type type,
 265                                         const char *name);
 266 struct symbol *symbol__next_by_name(struct symbol *sym);
 267
 268 struct symbol *dso__first_symbol(struct dso *dso, enum map_type type);
 269 struct symbol *dso__last_symbol(struct dso *dso, enum map_type type);
 270 struct symbol *dso__next_symbol(struct symbol *sym);
 271
 272 enum dso_type dso__type_fd(int fd);
 273
 274 int filename__read_build_id(const char *filename, void *bf, size_t size);
 275 int sysfs__read_build_id(const char *filename, void *bf, size_t size);
 276 int modules__parse(const char *filename, void *arg,
 277                    int (*process_module)(void *arg, const char *name,
 278                                          u64 start, u64 size));
 279 int filename__read_debuglink(const char *filename, char *debuglink,
 280                              size_t size);
 281
 282 struct perf_env;
 283 int symbol__init(struct perf_env *env);
 284 void symbol__exit(void);
 285 void symbol__elf_init(void);
 286 int symbol__annotation_init(void);
 287
 288 struct symbol *symbol__new(u64 start, u64 len, u8 binding, const char *name);
 289 size_t __symbol__fprintf_symname_offs(const struct symbol *sym,
 290                                       const struct addr_location *al,
 291                                       bool unknown_as_addr,
 292                                       bool print_offsets, FILE *fp);
 293 size_t symbol__fprintf_symname_offs(const struct symbol *sym,
 294                                     const struct addr_location *al, FILE *fp);
 295 size_t __symbol__fprintf_symname(const struct symbol *sym,
 296                                  const struct addr_location *al,
 297                                  bool unknown_as_addr, FILE *fp);
 298 size_t symbol__fprintf_symname(const struct symbol *sym, FILE *fp);
 299 size_t symbol__fprintf(struct symbol *sym, FILE *fp);
 300 bool symbol_type__is_a(char symbol_type, enum map_type map_type);
 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                                 struct map *map);
 310
 311 char *dso__demangle_sym(struct dso *dso, int kmodule, const char *elf_name);
 312
 313 void __symbols__insert(struct rb_root *symbols, struct symbol *sym, bool kernel);
 314 void symbols__insert(struct rb_root *symbols, struct symbol *sym);
 315 void symbols__fixup_duplicate(struct rb_root *symbols);
 316 void symbols__fixup_end(struct rb_root *symbols);
 317 void __map_groups__fixup_end(struct map_groups *mg, enum map_type type);
 318
 319 typedef int (*mapfn_t)(u64 start, u64 len, u64 pgoff, void *data);
 320 int file__read_maps(int fd, bool exe, mapfn_t mapfn, void *data,
 321                     bool *is_64_bit);
 322
 323 #define PERF_KCORE_EXTRACT "/tmp/perf-kcore-XXXXXX"
 324
 325 struct kcore_extract {
 326         char *kcore_filename;
 327         u64 addr;
 328         u64 offs;
 329         u64 len;
 330         char extract_filename[sizeof(PERF_KCORE_EXTRACT)];
 331         int fd;
 332 };
 333
 334 int kcore_extract__create(struct kcore_extract *kce);
 335 void kcore_extract__delete(struct kcore_extract *kce);
 336
 337 int kcore_copy(const char *from_dir, const char *to_dir);
 338 int compare_proc_modules(const char *from, const char *to);
 339
 340 int setup_list(struct strlist **list, const char *list_str,
 341                const char *list_name);
 342 int setup_intlist(struct intlist **list, const char *list_str,
 343                   const char *list_name);
 344
 345 #ifdef HAVE_LIBELF_SUPPORT
 346 bool elf__needs_adjust_symbols(GElf_Ehdr ehdr);
 347 void arch__sym_update(struct symbol *s, GElf_Sym *sym);
 348 #endif
 349
 350 const char *arch__normalize_symbol_name(const char *name);
 351 #define SYMBOL_A 0
 352 #define SYMBOL_B 1
 353
 354 void arch__symbols__fixup_end(struct symbol *p, struct symbol *c);
 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 */