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