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