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 <linux/list.h>
   9 #include <linux/rbtree.h>
  10 #include <stdio.h>
  11 #include "map_symbol.h"
  12 #include "branch.h"
  13 #include "path.h"
  14 #include "symbol_conf.h"
  15
  16 #ifdef HAVE_LIBELF_SUPPORT
  17 #include <libelf.h>
  18 #include <gelf.h>
  19 #endif
  20 #include <elf.h>
  21
  22 #include "dso.h"
  23
  24 struct map;
  25 struct map_groups;
  26 struct option;
  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 HAVE_LIBELF_MMAP_SUPPORT
  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 #ifndef DMGL_PARAMS
  44 #define DMGL_NO_OPTS     0              /* For readability... */
  45 #define DMGL_PARAMS      (1 << 0)       /* Include function args */
  46 #define DMGL_ANSI        (1 << 1)       /* Include const, volatile, etc */
  47 #endif
  48
  49 /** struct symbol - symtab entry
  50  *
  51  * @ignore - resolvable but tools ignore it (e.g. idle routines)
  52  */
  53 struct symbol {
  54         struct rb_node  rb_node;
  55         u64             start;
  56         u64             end;
  57         u16             namelen;
  58         u8              type:4;
  59         u8              binding:4;
  60         u8              idle:1;
  61         u8              ignore:1;
  62         u8              inlined:1;
  63         u8              arch_sym;
  64         bool            annotate2;
  65         char            name[0];
  66 };
  67
  68 void symbol__delete(struct symbol *sym);
  69 void symbols__delete(struct rb_root_cached *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_cached(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_name_rb_node {
  91         struct rb_node  rb_node;
  92         struct symbol   sym;
  93 };
  94
  95 static inline int __symbol__join_symfs(char *bf, size_t size, const char *path)
  96 {
  97         return path__join(bf, size, symbol_conf.symfs, path);
  98 }
  99
 100 #define symbol__join_symfs(bf, path) __symbol__join_symfs(bf, sizeof(bf), path)
 101
 102 extern int vmlinux_path__nr_entries;
 103 extern char **vmlinux_path;
 104
 105 static inline void *symbol__priv(struct symbol *sym)
 106 {
 107         return ((void *)sym) - symbol_conf.priv_size;
 108 }
 109
 110 struct ref_reloc_sym {
 111         const char      *name;
 112         u64             addr;
 113         u64             unrelocated_addr;
 114 };
 115
 116 struct branch_info {
 117         struct addr_map_symbol from;
 118         struct addr_map_symbol to;
 119         struct branch_flags flags;
 120         char                    *srcline_from;
 121         char                    *srcline_to;
 122 };
 123
 124 struct mem_info {
 125         struct addr_map_symbol  iaddr;
 126         struct addr_map_symbol  daddr;
 127         union perf_mem_data_src data_src;
 128         refcount_t              refcnt;
 129 };
 130
 131 struct block_info {
 132         struct symbol           *sym;
 133         u64                     start;
 134         u64                     end;
 135         u64                     cycles;
 136         u64                     cycles_aggr;
 137         int                     num;
 138         int                     num_aggr;
 139         refcount_t              refcnt;
 140 };
 141
 142 struct addr_location {
 143         struct machine *machine;
 144         struct thread *thread;
 145         struct map    *map;
 146         struct symbol *sym;
 147         const char    *srcline;
 148         u64           addr;
 149         char          level;
 150         u8            filtered;
 151         u8            cpumode;
 152         s32           cpu;
 153         s32           socket;
 154 };
 155
 156 struct symsrc {
 157         char *name;
 158         int fd;
 159         enum dso_binary_type type;
 160
 161 #ifdef HAVE_LIBELF_SUPPORT
 162         Elf *elf;
 163         GElf_Ehdr ehdr;
 164
 165         Elf_Scn *opdsec;
 166         size_t opdidx;
 167         GElf_Shdr opdshdr;
 168
 169         Elf_Scn *symtab;
 170         GElf_Shdr symshdr;
 171
 172         Elf_Scn *dynsym;
 173         size_t dynsym_idx;
 174         GElf_Shdr dynshdr;
 175
 176         bool adjust_symbols;
 177         bool is_64_bit;
 178 #endif
 179 };
 180
 181 void symsrc__destroy(struct symsrc *ss);
 182 int symsrc__init(struct symsrc *ss, struct dso *dso, const char *name,
 183                  enum dso_binary_type type);
 184 bool symsrc__has_symtab(struct symsrc *ss);
 185 bool symsrc__possibly_runtime(struct symsrc *ss);
 186
 187 int dso__load(struct dso *dso, struct map *map);
 188 int dso__load_vmlinux(struct dso *dso, struct map *map,
 189                       const char *vmlinux, bool vmlinux_allocated);
 190 int dso__load_vmlinux_path(struct dso *dso, struct map *map);
 191 int __dso__load_kallsyms(struct dso *dso, const char *filename, struct map *map,
 192                          bool no_kcore);
 193 int dso__load_kallsyms(struct dso *dso, const char *filename, struct map *map);
 194
 195 void dso__insert_symbol(struct dso *dso,
 196                         struct symbol *sym);
 197
 198 struct symbol *dso__find_symbol(struct dso *dso, u64 addr);
 199 struct symbol *dso__find_symbol_by_name(struct dso *dso, const char *name);
 200
 201 struct symbol *symbol__next_by_name(struct symbol *sym);
 202
 203 struct symbol *dso__first_symbol(struct dso *dso);
 204 struct symbol *dso__last_symbol(struct dso *dso);
 205 struct symbol *dso__next_symbol(struct symbol *sym);
 206
 207 enum dso_type dso__type_fd(int fd);
 208
 209 int filename__read_build_id(const char *filename, void *bf, size_t size);
 210 int sysfs__read_build_id(const char *filename, void *bf, size_t size);
 211 int modules__parse(const char *filename, void *arg,
 212                    int (*process_module)(void *arg, const char *name,
 213                                          u64 start, u64 size));
 214 int filename__read_debuglink(const char *filename, char *debuglink,
 215                              size_t size);
 216
 217 struct perf_env;
 218 int symbol__init(struct perf_env *env);
 219 void symbol__exit(void);
 220 void symbol__elf_init(void);
 221 int symbol__annotation_init(void);
 222
 223 struct symbol *symbol__new(u64 start, u64 len, u8 binding, u8 type, const char *name);
 224 size_t __symbol__fprintf_symname_offs(const struct symbol *sym,
 225                                       const struct addr_location *al,
 226                                       bool unknown_as_addr,
 227                                       bool print_offsets, FILE *fp);
 228 size_t symbol__fprintf_symname_offs(const struct symbol *sym,
 229                                     const struct addr_location *al, FILE *fp);
 230 size_t __symbol__fprintf_symname(const struct symbol *sym,
 231                                  const struct addr_location *al,
 232                                  bool unknown_as_addr, FILE *fp);
 233 size_t symbol__fprintf_symname(const struct symbol *sym, FILE *fp);
 234 size_t symbol__fprintf(struct symbol *sym, FILE *fp);
 235 bool symbol__restricted_filename(const char *filename,
 236                                  const char *restricted_filename);
 237 int symbol__config_symfs(const struct option *opt __maybe_unused,
 238                          const char *dir, int unset __maybe_unused);
 239
 240 int dso__load_sym(struct dso *dso, struct map *map, struct symsrc *syms_ss,
 241                   struct symsrc *runtime_ss, int kmodule);
 242 int dso__synthesize_plt_symbols(struct dso *dso, struct symsrc *ss);
 243
 244 char *dso__demangle_sym(struct dso *dso, int kmodule, const char *elf_name);
 245
 246 void __symbols__insert(struct rb_root_cached *symbols, struct symbol *sym,
 247                        bool kernel);
 248 void symbols__insert(struct rb_root_cached *symbols, struct symbol *sym);
 249 void symbols__fixup_duplicate(struct rb_root_cached *symbols);
 250 void symbols__fixup_end(struct rb_root_cached *symbols);
 251 void map_groups__fixup_end(struct map_groups *mg);
 252
 253 typedef int (*mapfn_t)(u64 start, u64 len, u64 pgoff, void *data);
 254 int file__read_maps(int fd, bool exe, mapfn_t mapfn, void *data,
 255                     bool *is_64_bit);
 256
 257 #define PERF_KCORE_EXTRACT "/tmp/perf-kcore-XXXXXX"
 258
 259 struct kcore_extract {
 260         char *kcore_filename;
 261         u64 addr;
 262         u64 offs;
 263         u64 len;
 264         char extract_filename[sizeof(PERF_KCORE_EXTRACT)];
 265         int fd;
 266 };
 267
 268 int kcore_extract__create(struct kcore_extract *kce);
 269 void kcore_extract__delete(struct kcore_extract *kce);
 270
 271 int kcore_copy(const char *from_dir, const char *to_dir);
 272 int compare_proc_modules(const char *from, const char *to);
 273
 274 int setup_list(struct strlist **list, const char *list_str,
 275                const char *list_name);
 276 int setup_intlist(struct intlist **list, const char *list_str,
 277                   const char *list_name);
 278
 279 #ifdef HAVE_LIBELF_SUPPORT
 280 bool elf__needs_adjust_symbols(GElf_Ehdr ehdr);
 281 void arch__sym_update(struct symbol *s, GElf_Sym *sym);
 282 #endif
 283
 284 const char *arch__normalize_symbol_name(const char *name);
 285 #define SYMBOL_A 0
 286 #define SYMBOL_B 1
 287
 288 void arch__symbols__fixup_end(struct symbol *p, struct symbol *c);
 289 int arch__compare_symbol_names(const char *namea, const char *nameb);
 290 int arch__compare_symbol_names_n(const char *namea, const char *nameb,
 291                                  unsigned int n);
 292 int arch__choose_best_symbol(struct symbol *syma, struct symbol *symb);
 293
 294 enum symbol_tag_include {
 295         SYMBOL_TAG_INCLUDE__NONE = 0,
 296         SYMBOL_TAG_INCLUDE__DEFAULT_ONLY
 297 };
 298
 299 int symbol__match_symbol_name(const char *namea, const char *nameb,
 300                               enum symbol_tag_include includes);
 301
 302 /* structure containing an SDT note's info */
 303 struct sdt_note {
 304         char *name;                     /* name of the note*/
 305         char *provider;                 /* provider name */
 306         char *args;
 307         bool bit32;                     /* whether the location is 32 bits? */
 308         union {                         /* location, base and semaphore addrs */
 309                 Elf64_Addr a64[3];
 310                 Elf32_Addr a32[3];
 311         } addr;
 312         struct list_head note_list;     /* SDT notes' list */
 313 };
 314
 315 int get_sdt_note_list(struct list_head *head, const char *target);
 316 int cleanup_sdt_note_list(struct list_head *sdt_notes);
 317 int sdt_notes__get_count(struct list_head *start);
 318
 319 #define SDT_PROBES_SCN ".probes"
 320 #define SDT_BASE_SCN ".stapsdt.base"
 321 #define SDT_NOTE_SCN  ".note.stapsdt"
 322 #define SDT_NOTE_TYPE 3
 323 #define SDT_NOTE_NAME "stapsdt"
 324 #define NR_ADDR 3
 325
 326 enum {
 327         SDT_NOTE_IDX_LOC = 0,
 328         SDT_NOTE_IDX_BASE,
 329         SDT_NOTE_IDX_REFCTR,
 330 };
 331
 332 struct mem_info *mem_info__new(void);
 333 struct mem_info *mem_info__get(struct mem_info *mi);
 334 void   mem_info__put(struct mem_info *mi);
 335
 336 static inline void __mem_info__zput(struct mem_info **mi)
 337 {
 338         mem_info__put(*mi);
 339         *mi = NULL;
 340 }
 341
 342 #define mem_info__zput(mi) __mem_info__zput(&mi)
 343
 344 struct block_info *block_info__new(void);
 345 struct block_info *block_info__get(struct block_info *bi);
 346 void   block_info__put(struct block_info *bi);
 347
 348 static inline void __block_info__zput(struct block_info **bi)
 349 {
 350         block_info__put(*bi);
 351         *bi = NULL;
 352 }
 353
 354 #define block_info__zput(bi) __block_info__zput(&bi)
 355
 356 #endif /* __PERF_SYMBOL */