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 <linux/refcount.h>
   7 #include <stdbool.h>
   8 #include <stdint.h>
   9 #include <linux/list.h>
  10 #include <linux/rbtree.h>
  11 #include <stdio.h>
  12 #include "path.h"
  13 #include "symbol_conf.h"
  14 #include "spark.h"
  15
  16 #ifdef HAVE_LIBELF_SUPPORT
  17 #include <libelf.h>
  18 #include <gelf.h>
  19 #endif
  20 #include <elf.h>
  21
  22 struct dso;
  23 struct map;
  24 struct maps;
  25 struct option;
  26 struct build_id;
  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 ELF_C_READ_MMAP
  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 /**
  44  * A symtab entry. When allocated this may be preceded by an annotation (see
  45  * symbol__annotation), a browser_index (see symbol__browser_index) and rb_node
  46  * to sort by name (see struct symbol_name_rb_node).
  47  */
  48 struct symbol {
  49         struct rb_node  rb_node;
  50         /** Range of symbol [start, end). */
  51         u64             start;
  52         u64             end;
  53         /** Length of the string name. */
  54         u16             namelen;
  55         /** ELF symbol type as defined for st_info. E.g STT_OBJECT or STT_FUNC. */
  56         u8              type:4;
  57         /** ELF binding type as defined for st_info. E.g. STB_WEAK or STB_GLOBAL. */
  58         u8              binding:4;
  59         /** Set true for kernel symbols of idle routines. */
  60         u8              idle:1;
  61         /** Resolvable but tools ignore it (e.g. idle routines). */
  62         u8              ignore:1;
  63         /** Symbol for an inlined function. */
  64         u8              inlined:1;
  65         /** Has symbol__annotate2 been performed. */
  66         u8              annotate2:1;
  67         /** Architecture specific. Unused except on PPC where it holds st_other. */
  68         u8              arch_sym;
  69         /** The name of length namelen associated with the symbol. */
  70         char            name[];
  71 };
  72
  73 void symbol__delete(struct symbol *sym);
  74 void symbols__delete(struct rb_root_cached *symbols);
  75
  76 /* symbols__for_each_entry - iterate over symbols (rb_root)
  77  *
  78  * @symbols: the rb_root of symbols
  79  * @pos: the 'struct symbol *' to use as a loop cursor
  80  * @nd: the 'struct rb_node *' to use as a temporary storage
  81  */
  82 #define symbols__for_each_entry(symbols, pos, nd)                       \
  83         for (nd = rb_first_cached(symbols);                                     \
  84              nd && (pos = rb_entry(nd, struct symbol, rb_node));        \
  85              nd = rb_next(nd))
  86
  87 static inline size_t symbol__size(const struct symbol *sym)
  88 {
  89         return sym->end - sym->start;
  90 }
  91
  92 struct strlist;
  93 struct intlist;
  94
  95 struct symbol_name_rb_node {
  96         struct rb_node  rb_node;
  97         struct symbol   sym;
  98 };
  99
 100 static inline int __symbol__join_symfs(char *bf, size_t size, const char *path)
 101 {
 102         return path__join(bf, size, symbol_conf.symfs, path);
 103 }
 104
 105 #define symbol__join_symfs(bf, path) __symbol__join_symfs(bf, sizeof(bf), path)
 106
 107 extern int vmlinux_path__nr_entries;
 108 extern char **vmlinux_path;
 109
 110 static inline void *symbol__priv(struct symbol *sym)
 111 {
 112         return ((void *)sym) - symbol_conf.priv_size;
 113 }
 114
 115 struct ref_reloc_sym {
 116         const char      *name;
 117         u64             addr;
 118         u64             unrelocated_addr;
 119 };
 120
 121 struct addr_location {
 122         struct thread *thread;
 123         struct maps   *maps;
 124         struct map    *map;
 125         struct symbol *sym;
 126         const char    *srcline;
 127         u64           addr;
 128         char          level;
 129         u8            filtered;
 130         u8            cpumode;
 131         s32           cpu;
 132         s32           socket;
 133 };
 134
 135 int dso__load(struct dso *dso, struct map *map);
 136 int dso__load_vmlinux(struct dso *dso, struct map *map,
 137                       const char *vmlinux, bool vmlinux_allocated);
 138 int dso__load_vmlinux_path(struct dso *dso, struct map *map);
 139 int __dso__load_kallsyms(struct dso *dso, const char *filename, struct map *map,
 140                          bool no_kcore);
 141 int dso__load_kallsyms(struct dso *dso, const char *filename, struct map *map);
 142
 143 void dso__insert_symbol(struct dso *dso,
 144                         struct symbol *sym);
 145 void dso__delete_symbol(struct dso *dso,
 146                         struct symbol *sym);
 147
 148 struct symbol *dso__find_symbol(struct dso *dso, u64 addr);
 149 struct symbol *dso__find_symbol_by_name(struct dso *dso, const char *name);
 150
 151 struct symbol *symbol__next_by_name(struct symbol *sym);
 152
 153 struct symbol *dso__first_symbol(struct dso *dso);
 154 struct symbol *dso__last_symbol(struct dso *dso);
 155 struct symbol *dso__next_symbol(struct symbol *sym);
 156
 157 enum dso_type dso__type_fd(int fd);
 158
 159 int filename__read_build_id(const char *filename, struct build_id *id);
 160 int sysfs__read_build_id(const char *filename, struct build_id *bid);
 161 int modules__parse(const char *filename, void *arg,
 162                    int (*process_module)(void *arg, const char *name,
 163                                          u64 start, u64 size));
 164 int filename__read_debuglink(const char *filename, char *debuglink,
 165                              size_t size);
 166
 167 struct perf_env;
 168 int symbol__init(struct perf_env *env);
 169 void symbol__exit(void);
 170 void symbol__elf_init(void);
 171 int symbol__annotation_init(void);
 172
 173 struct symbol *symbol__new(u64 start, u64 len, u8 binding, u8 type, const char *name);
 174 size_t __symbol__fprintf_symname_offs(const struct symbol *sym,
 175                                       const struct addr_location *al,
 176                                       bool unknown_as_addr,
 177                                       bool print_offsets, FILE *fp);
 178 size_t symbol__fprintf_symname_offs(const struct symbol *sym,
 179                                     const struct addr_location *al, FILE *fp);
 180 size_t __symbol__fprintf_symname(const struct symbol *sym,
 181                                  const struct addr_location *al,
 182                                  bool unknown_as_addr, FILE *fp);
 183 size_t symbol__fprintf_symname(const struct symbol *sym, FILE *fp);
 184 size_t symbol__fprintf(struct symbol *sym, FILE *fp);
 185 bool symbol__restricted_filename(const char *filename,
 186                                  const char *restricted_filename);
 187 int symbol__config_symfs(const struct option *opt __maybe_unused,
 188                          const char *dir, int unset __maybe_unused);
 189
 190 struct symsrc;
 191
 192 #ifdef HAVE_LIBBFD_SUPPORT
 193 int dso__load_bfd_symbols(struct dso *dso, const char *debugfile);
 194 #endif
 195
 196 int dso__load_sym(struct dso *dso, struct map *map, struct symsrc *syms_ss,
 197                   struct symsrc *runtime_ss, int kmodule);
 198 int dso__synthesize_plt_symbols(struct dso *dso, struct symsrc *ss);
 199
 200 char *dso__demangle_sym(struct dso *dso, int kmodule, const char *elf_name);
 201
 202 void __symbols__insert(struct rb_root_cached *symbols, struct symbol *sym,
 203                        bool kernel);
 204 void symbols__insert(struct rb_root_cached *symbols, struct symbol *sym);
 205 void symbols__fixup_duplicate(struct rb_root_cached *symbols);
 206 void symbols__fixup_end(struct rb_root_cached *symbols, bool is_kallsyms);
 207 void maps__fixup_end(struct maps *maps);
 208
 209 typedef int (*mapfn_t)(u64 start, u64 len, u64 pgoff, void *data);
 210 int file__read_maps(int fd, bool exe, mapfn_t mapfn, void *data,
 211                     bool *is_64_bit);
 212
 213 #define PERF_KCORE_EXTRACT "/tmp/perf-kcore-XXXXXX"
 214
 215 struct kcore_extract {
 216         char *kcore_filename;
 217         u64 addr;
 218         u64 offs;
 219         u64 len;
 220         char extract_filename[sizeof(PERF_KCORE_EXTRACT)];
 221         int fd;
 222 };
 223
 224 int kcore_extract__create(struct kcore_extract *kce);
 225 void kcore_extract__delete(struct kcore_extract *kce);
 226
 227 int kcore_copy(const char *from_dir, const char *to_dir);
 228 int compare_proc_modules(const char *from, const char *to);
 229
 230 int setup_list(struct strlist **list, const char *list_str,
 231                const char *list_name);
 232 int setup_intlist(struct intlist **list, const char *list_str,
 233                   const char *list_name);
 234
 235 #ifdef HAVE_LIBELF_SUPPORT
 236 bool elf__needs_adjust_symbols(GElf_Ehdr ehdr);
 237 void arch__sym_update(struct symbol *s, GElf_Sym *sym);
 238 #endif
 239
 240 const char *arch__normalize_symbol_name(const char *name);
 241 #define SYMBOL_A 0
 242 #define SYMBOL_B 1
 243
 244 int arch__compare_symbol_names(const char *namea, const char *nameb);
 245 int arch__compare_symbol_names_n(const char *namea, const char *nameb,
 246                                  unsigned int n);
 247 int arch__choose_best_symbol(struct symbol *syma, struct symbol *symb);
 248
 249 enum symbol_tag_include {
 250         SYMBOL_TAG_INCLUDE__NONE = 0,
 251         SYMBOL_TAG_INCLUDE__DEFAULT_ONLY
 252 };
 253
 254 int symbol__match_symbol_name(const char *namea, const char *nameb,
 255                               enum symbol_tag_include includes);
 256
 257 /* structure containing an SDT note's info */
 258 struct sdt_note {
 259         char *name;                     /* name of the note*/
 260         char *provider;                 /* provider name */
 261         char *args;
 262         bool bit32;                     /* whether the location is 32 bits? */
 263         union {                         /* location, base and semaphore addrs */
 264                 Elf64_Addr a64[3];
 265                 Elf32_Addr a32[3];
 266         } addr;
 267         struct list_head note_list;     /* SDT notes' list */
 268 };
 269
 270 int get_sdt_note_list(struct list_head *head, const char *target);
 271 int cleanup_sdt_note_list(struct list_head *sdt_notes);
 272 int sdt_notes__get_count(struct list_head *start);
 273
 274 #define SDT_PROBES_SCN ".probes"
 275 #define SDT_BASE_SCN ".stapsdt.base"
 276 #define SDT_NOTE_SCN  ".note.stapsdt"
 277 #define SDT_NOTE_TYPE 3
 278 #define SDT_NOTE_NAME "stapsdt"
 279 #define NR_ADDR 3
 280
 281 enum {
 282         SDT_NOTE_IDX_LOC = 0,
 283         SDT_NOTE_IDX_BASE,
 284         SDT_NOTE_IDX_REFCTR,
 285 };
 286
 287 struct mem_info *mem_info__new(void);
 288 struct mem_info *mem_info__get(struct mem_info *mi);
 289 void   mem_info__put(struct mem_info *mi);
 290
 291 static inline void __mem_info__zput(struct mem_info **mi)
 292 {
 293         mem_info__put(*mi);
 294         *mi = NULL;
 295 }
 296
 297 #define mem_info__zput(mi) __mem_info__zput(&mi)
 298
 299 int symbol__validate_sym_arguments(void);
 300
 301 #endif /* __PERF_SYMBOL */