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