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