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 /** 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[];
  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 addr_location {
 111         struct thread *thread;
 112         struct maps   *maps;
 113         struct map    *map;
 114         struct symbol *sym;
 115         const char    *srcline;
 116         u64           addr;
 117         char          level;
 118         u8            filtered;
 119         u8            cpumode;
 120         s32           cpu;
 121         s32           socket;
 122 };
 123
 124 int dso__load(struct dso *dso, struct map *map);
 125 int dso__load_vmlinux(struct dso *dso, struct map *map,
 126                       const char *vmlinux, bool vmlinux_allocated);
 127 int dso__load_vmlinux_path(struct dso *dso, struct map *map);
 128 int __dso__load_kallsyms(struct dso *dso, const char *filename, struct map *map,
 129                          bool no_kcore);
 130 int dso__load_kallsyms(struct dso *dso, const char *filename, struct map *map);
 131
 132 void dso__insert_symbol(struct dso *dso,
 133                         struct symbol *sym);
 134 void dso__delete_symbol(struct dso *dso,
 135                         struct symbol *sym);
 136
 137 struct symbol *dso__find_symbol(struct dso *dso, u64 addr);
 138 struct symbol *dso__find_symbol_by_name(struct dso *dso, const char *name);
 139
 140 struct symbol *symbol__next_by_name(struct symbol *sym);
 141
 142 struct symbol *dso__first_symbol(struct dso *dso);
 143 struct symbol *dso__last_symbol(struct dso *dso);
 144 struct symbol *dso__next_symbol(struct symbol *sym);
 145
 146 enum dso_type dso__type_fd(int fd);
 147
 148 int filename__read_build_id(const char *filename, struct build_id *id);
 149 int sysfs__read_build_id(const char *filename, struct build_id *bid);
 150 int modules__parse(const char *filename, void *arg,
 151                    int (*process_module)(void *arg, const char *name,
 152                                          u64 start, u64 size));
 153 int filename__read_debuglink(const char *filename, char *debuglink,
 154                              size_t size);
 155
 156 struct perf_env;
 157 int symbol__init(struct perf_env *env);
 158 void symbol__exit(void);
 159 void symbol__elf_init(void);
 160 int symbol__annotation_init(void);
 161
 162 struct symbol *symbol__new(u64 start, u64 len, u8 binding, u8 type, const char *name);
 163 size_t __symbol__fprintf_symname_offs(const struct symbol *sym,
 164                                       const struct addr_location *al,
 165                                       bool unknown_as_addr,
 166                                       bool print_offsets, FILE *fp);
 167 size_t symbol__fprintf_symname_offs(const struct symbol *sym,
 168                                     const struct addr_location *al, FILE *fp);
 169 size_t __symbol__fprintf_symname(const struct symbol *sym,
 170                                  const struct addr_location *al,
 171                                  bool unknown_as_addr, FILE *fp);
 172 size_t symbol__fprintf_symname(const struct symbol *sym, FILE *fp);
 173 size_t symbol__fprintf(struct symbol *sym, FILE *fp);
 174 bool symbol__restricted_filename(const char *filename,
 175                                  const char *restricted_filename);
 176 int symbol__config_symfs(const struct option *opt __maybe_unused,
 177                          const char *dir, int unset __maybe_unused);
 178
 179 struct symsrc;
 180
 181 #ifdef HAVE_LIBBFD_SUPPORT
 182 int dso__load_bfd_symbols(struct dso *dso, const char *debugfile);
 183 #endif
 184
 185 int dso__load_sym(struct dso *dso, struct map *map, struct symsrc *syms_ss,
 186                   struct symsrc *runtime_ss, int kmodule);
 187 int dso__synthesize_plt_symbols(struct dso *dso, struct symsrc *ss);
 188
 189 char *dso__demangle_sym(struct dso *dso, int kmodule, const char *elf_name);
 190
 191 void __symbols__insert(struct rb_root_cached *symbols, struct symbol *sym,
 192                        bool kernel);
 193 void symbols__insert(struct rb_root_cached *symbols, struct symbol *sym);
 194 void symbols__fixup_duplicate(struct rb_root_cached *symbols);
 195 void symbols__fixup_end(struct rb_root_cached *symbols);
 196 void maps__fixup_end(struct maps *maps);
 197
 198 typedef int (*mapfn_t)(u64 start, u64 len, u64 pgoff, void *data);
 199 int file__read_maps(int fd, bool exe, mapfn_t mapfn, void *data,
 200                     bool *is_64_bit);
 201
 202 #define PERF_KCORE_EXTRACT "/tmp/perf-kcore-XXXXXX"
 203
 204 struct kcore_extract {
 205         char *kcore_filename;
 206         u64 addr;
 207         u64 offs;
 208         u64 len;
 209         char extract_filename[sizeof(PERF_KCORE_EXTRACT)];
 210         int fd;
 211 };
 212
 213 int kcore_extract__create(struct kcore_extract *kce);
 214 void kcore_extract__delete(struct kcore_extract *kce);
 215
 216 int kcore_copy(const char *from_dir, const char *to_dir);
 217 int compare_proc_modules(const char *from, const char *to);
 218
 219 int setup_list(struct strlist **list, const char *list_str,
 220                const char *list_name);
 221 int setup_intlist(struct intlist **list, const char *list_str,
 222                   const char *list_name);
 223
 224 #ifdef HAVE_LIBELF_SUPPORT
 225 bool elf__needs_adjust_symbols(GElf_Ehdr ehdr);
 226 void arch__sym_update(struct symbol *s, GElf_Sym *sym);
 227 #endif
 228
 229 const char *arch__normalize_symbol_name(const char *name);
 230 #define SYMBOL_A 0
 231 #define SYMBOL_B 1
 232
 233 void arch__symbols__fixup_end(struct symbol *p, struct symbol *c);
 234 int arch__compare_symbol_names(const char *namea, const char *nameb);
 235 int arch__compare_symbol_names_n(const char *namea, const char *nameb,
 236                                  unsigned int n);
 237 int arch__choose_best_symbol(struct symbol *syma, struct symbol *symb);
 238
 239 enum symbol_tag_include {
 240         SYMBOL_TAG_INCLUDE__NONE = 0,
 241         SYMBOL_TAG_INCLUDE__DEFAULT_ONLY
 242 };
 243
 244 int symbol__match_symbol_name(const char *namea, const char *nameb,
 245                               enum symbol_tag_include includes);
 246
 247 /* structure containing an SDT note's info */
 248 struct sdt_note {
 249         char *name;                     /* name of the note*/
 250         char *provider;                 /* provider name */
 251         char *args;
 252         bool bit32;                     /* whether the location is 32 bits? */
 253         union {                         /* location, base and semaphore addrs */
 254                 Elf64_Addr a64[3];
 255                 Elf32_Addr a32[3];
 256         } addr;
 257         struct list_head note_list;     /* SDT notes' list */
 258 };
 259
 260 int get_sdt_note_list(struct list_head *head, const char *target);
 261 int cleanup_sdt_note_list(struct list_head *sdt_notes);
 262 int sdt_notes__get_count(struct list_head *start);
 263
 264 #define SDT_PROBES_SCN ".probes"
 265 #define SDT_BASE_SCN ".stapsdt.base"
 266 #define SDT_NOTE_SCN  ".note.stapsdt"
 267 #define SDT_NOTE_TYPE 3
 268 #define SDT_NOTE_NAME "stapsdt"
 269 #define NR_ADDR 3
 270
 271 enum {
 272         SDT_NOTE_IDX_LOC = 0,
 273         SDT_NOTE_IDX_BASE,
 274         SDT_NOTE_IDX_REFCTR,
 275 };
 276
 277 struct mem_info *mem_info__new(void);
 278 struct mem_info *mem_info__get(struct mem_info *mi);
 279 void   mem_info__put(struct mem_info *mi);
 280
 281 static inline void __mem_info__zput(struct mem_info **mi)
 282 {
 283         mem_info__put(*mi);
 284         *mi = NULL;
 285 }
 286
 287 #define mem_info__zput(mi) __mem_info__zput(&mi)
 288
 289 #endif /* __PERF_SYMBOL */