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