tools/perf/util/symbol.h

   1 #ifndef __PERF_SYMBOL
   2 #define __PERF_SYMBOL 1
   3
   4 #include <linux/types.h>
   5 #include <stdbool.h>
   6 #include <stdint.h>
   7 #include "map.h"
   8 #include "../perf.h"
   9 #include <linux/list.h>
  10 #include <linux/rbtree.h>
  11 #include <stdio.h>
  12 #include <byteswap.h>
  13 #include <libgen.h>
  14 #include "build-id.h"
  15 #include "event.h"
  16 #include "util.h"
  17
  18 #ifdef HAVE_LIBELF_SUPPORT
  19 #include <libelf.h>
  20 #include <gelf.h>
  21 #endif
  22 #include <elf.h>
  23
  24 #include "dso.h"
  25
  26 /*
  27  * libelf 0.8.x and earlier do not support ELF_C_READ_MMAP;
  28  * for newer versions we can use mmap to reduce memory usage:
  29  */
  30 #ifdef HAVE_LIBELF_MMAP_SUPPORT
  31 # define PERF_ELF_C_READ_MMAP ELF_C_READ_MMAP
  32 #else
  33 # define PERF_ELF_C_READ_MMAP ELF_C_READ
  34 #endif
  35
  36 #ifdef HAVE_LIBELF_SUPPORT
  37 Elf_Scn *elf_section_by_name(Elf *elf, GElf_Ehdr *ep,
  38                              GElf_Shdr *shp, const char *name, size_t *idx);
  39 #endif
  40
  41 #ifndef DMGL_PARAMS
  42 #define DMGL_NO_OPTS     0              /* For readability... */
  43 #define DMGL_PARAMS      (1 << 0)       /* Include function args */
  44 #define DMGL_ANSI        (1 << 1)       /* Include const, volatile, etc */
  45 #endif
  46
  47 #define DSO__NAME_KALLSYMS      "[kernel.kallsyms]"
  48 #define DSO__NAME_KCORE         "[kernel.kcore]"
  49
  50 /** struct symbol - symtab entry
  51  *
  52  * @ignore - resolvable but tools ignore it (e.g. idle routines)
  53  */
  54 struct symbol {
  55         struct rb_node  rb_node;
  56         u64             start;
  57         u64             end;
  58         u16             namelen;
  59         u8              binding;
  60         bool            ignore;
  61         u8              arch_sym;
  62         char            name[0];
  63 };
  64
  65 void symbol__delete(struct symbol *sym);
  66 void symbols__delete(struct rb_root *symbols);
  67
  68 /* symbols__for_each_entry - iterate over symbols (rb_root)
  69  *
  70  * @symbols: the rb_root of symbols
  71  * @pos: the 'struct symbol *' to use as a loop cursor
  72  * @nd: the 'struct rb_node *' to use as a temporary storage
  73  */
  74 #define symbols__for_each_entry(symbols, pos, nd)                       \
  75         for (nd = rb_first(symbols);                                    \
  76              nd && (pos = rb_entry(nd, struct symbol, rb_node));        \
  77              nd = rb_next(nd))
  78
  79 static inline size_t symbol__size(const struct symbol *sym)
  80 {
  81         return sym->end - sym->start;
  82 }
  83
  84 struct strlist;
  85 struct intlist;
  86
  87 struct symbol_conf {
  88         unsigned short  priv_size;
  89         unsigned short  nr_events;
  90         bool            try_vmlinux_path,
  91                         force,
  92                         ignore_vmlinux,
  93                         ignore_vmlinux_buildid,
  94                         show_kernel_path,
  95                         use_modules,
  96                         allow_aliases,
  97                         sort_by_name,
  98                         show_nr_samples,
  99                         show_total_period,
 100                         use_callchain,
 101                         cumulate_callchain,
 102                         exclude_other,
 103                         show_cpu_utilization,
 104                         initialized,
 105                         kptr_restrict,
 106                         annotate_asm_raw,
 107                         annotate_src,
 108                         event_group,
 109                         demangle,
 110                         demangle_kernel,
 111                         filter_relative,
 112                         show_hist_headers,
 113                         branch_callstack,
 114                         has_filter,
 115                         show_ref_callgraph,
 116                         hide_unresolved,
 117                         raw_trace,
 118                         report_hierarchy;
 119         const char      *vmlinux_name,
 120                         *kallsyms_name,
 121                         *source_prefix,
 122                         *field_sep;
 123         const char      *default_guest_vmlinux_name,
 124                         *default_guest_kallsyms,
 125                         *default_guest_modules;
 126         const char      *guestmount;
 127         const char      *dso_list_str,
 128                         *comm_list_str,
 129                         *pid_list_str,
 130                         *tid_list_str,
 131                         *sym_list_str,
 132                         *col_width_list_str;
 133        struct strlist   *dso_list,
 134                         *comm_list,
 135                         *sym_list,
 136                         *dso_from_list,
 137                         *dso_to_list,
 138                         *sym_from_list,
 139                         *sym_to_list;
 140         struct intlist  *pid_list,
 141                         *tid_list;
 142         const char      *symfs;
 143 };
 144
 145 extern struct symbol_conf symbol_conf;
 146
 147 struct symbol_name_rb_node {
 148         struct rb_node  rb_node;
 149         struct symbol   sym;
 150 };
 151
 152 static inline int __symbol__join_symfs(char *bf, size_t size, const char *path)
 153 {
 154         return path__join(bf, size, symbol_conf.symfs, path);
 155 }
 156
 157 #define symbol__join_symfs(bf, path) __symbol__join_symfs(bf, sizeof(bf), path)
 158
 159 extern int vmlinux_path__nr_entries;
 160 extern char **vmlinux_path;
 161
 162 static inline void *symbol__priv(struct symbol *sym)
 163 {
 164         return ((void *)sym) - symbol_conf.priv_size;
 165 }
 166
 167 struct ref_reloc_sym {
 168         const char      *name;
 169         u64             addr;
 170         u64             unrelocated_addr;
 171 };
 172
 173 struct map_symbol {
 174         struct map    *map;
 175         struct symbol *sym;
 176 };
 177
 178 struct addr_map_symbol {
 179         struct map    *map;
 180         struct symbol *sym;
 181         u64           addr;
 182         u64           al_addr;
 183 };
 184
 185 struct branch_info {
 186         struct addr_map_symbol from;
 187         struct addr_map_symbol to;
 188         struct branch_flags flags;
 189         char                    *srcline_from;
 190         char                    *srcline_to;
 191 };
 192
 193 struct mem_info {
 194         struct addr_map_symbol iaddr;
 195         struct addr_map_symbol daddr;
 196         union perf_mem_data_src data_src;
 197 };
 198
 199 struct addr_location {
 200         struct machine *machine;
 201         struct thread *thread;
 202         struct map    *map;
 203         struct symbol *sym;
 204         u64           addr;
 205         char          level;
 206         u8            filtered;
 207         u8            cpumode;
 208         s32           cpu;
 209         s32           socket;
 210 };
 211
 212 struct symsrc {
 213         char *name;
 214         int fd;
 215         enum dso_binary_type type;
 216
 217 #ifdef HAVE_LIBELF_SUPPORT
 218         Elf *elf;
 219         GElf_Ehdr ehdr;
 220
 221         Elf_Scn *opdsec;
 222         size_t opdidx;
 223         GElf_Shdr opdshdr;
 224
 225         Elf_Scn *symtab;
 226         GElf_Shdr symshdr;
 227
 228         Elf_Scn *dynsym;
 229         size_t dynsym_idx;
 230         GElf_Shdr dynshdr;
 231
 232         bool adjust_symbols;
 233         bool is_64_bit;
 234 #endif
 235 };
 236
 237 void symsrc__destroy(struct symsrc *ss);
 238 int symsrc__init(struct symsrc *ss, struct dso *dso, const char *name,
 239                  enum dso_binary_type type);
 240 bool symsrc__has_symtab(struct symsrc *ss);
 241 bool symsrc__possibly_runtime(struct symsrc *ss);
 242
 243 int dso__load(struct dso *dso, struct map *map, symbol_filter_t filter);
 244 int dso__load_vmlinux(struct dso *dso, struct map *map,
 245                       const char *vmlinux, bool vmlinux_allocated,
 246                       symbol_filter_t filter);
 247 int dso__load_vmlinux_path(struct dso *dso, struct map *map,
 248                            symbol_filter_t filter);
 249 int __dso__load_kallsyms(struct dso *dso, const char *filename, struct map *map,
 250                          bool no_kcore, symbol_filter_t filter);
 251 int dso__load_kallsyms(struct dso *dso, const char *filename, struct map *map,
 252                        symbol_filter_t filter);
 253
 254 void dso__insert_symbol(struct dso *dso, enum map_type type,
 255                         struct symbol *sym);
 256
 257 struct symbol *dso__find_symbol(struct dso *dso, enum map_type type,
 258                                 u64 addr);
 259 struct symbol *dso__find_symbol_by_name(struct dso *dso, enum map_type type,
 260                                         const char *name);
 261 struct symbol *symbol__next_by_name(struct symbol *sym);
 262
 263 struct symbol *dso__first_symbol(struct dso *dso, enum map_type type);
 264 struct symbol *dso__next_symbol(struct symbol *sym);
 265
 266 enum dso_type dso__type_fd(int fd);
 267
 268 int filename__read_build_id(const char *filename, void *bf, size_t size);
 269 int sysfs__read_build_id(const char *filename, void *bf, size_t size);
 270 int modules__parse(const char *filename, void *arg,
 271                    int (*process_module)(void *arg, const char *name,
 272                                          u64 start));
 273 int filename__read_debuglink(const char *filename, char *debuglink,
 274                              size_t size);
 275
 276 struct perf_env;
 277 int symbol__init(struct perf_env *env);
 278 void symbol__exit(void);
 279 void symbol__elf_init(void);
 280 struct symbol *symbol__new(u64 start, u64 len, u8 binding, const char *name);
 281 size_t __symbol__fprintf_symname_offs(const struct symbol *sym,
 282                                       const struct addr_location *al,
 283                                       bool unknown_as_addr, FILE *fp);
 284 size_t symbol__fprintf_symname_offs(const struct symbol *sym,
 285                                     const struct addr_location *al, FILE *fp);
 286 size_t __symbol__fprintf_symname(const struct symbol *sym,
 287                                  const struct addr_location *al,
 288                                  bool unknown_as_addr, FILE *fp);
 289 size_t symbol__fprintf_symname(const struct symbol *sym, FILE *fp);
 290 size_t symbol__fprintf(struct symbol *sym, FILE *fp);
 291 bool symbol_type__is_a(char symbol_type, enum map_type map_type);
 292 bool symbol__restricted_filename(const char *filename,
 293                                  const char *restricted_filename);
 294 bool symbol__is_idle(struct symbol *sym);
 295 int symbol__config_symfs(const struct option *opt __maybe_unused,
 296                          const char *dir, int unset __maybe_unused);
 297
 298 int dso__load_sym(struct dso *dso, struct map *map, struct symsrc *syms_ss,
 299                   struct symsrc *runtime_ss, symbol_filter_t filter,
 300                   int kmodule);
 301 int dso__synthesize_plt_symbols(struct dso *dso, struct symsrc *ss,
 302                                 struct map *map, symbol_filter_t filter);
 303
 304 void symbols__insert(struct rb_root *symbols, struct symbol *sym);
 305 void symbols__fixup_duplicate(struct rb_root *symbols);
 306 void symbols__fixup_end(struct rb_root *symbols);
 307 void __map_groups__fixup_end(struct map_groups *mg, enum map_type type);
 308
 309 typedef int (*mapfn_t)(u64 start, u64 len, u64 pgoff, void *data);
 310 int file__read_maps(int fd, bool exe, mapfn_t mapfn, void *data,
 311                     bool *is_64_bit);
 312
 313 #define PERF_KCORE_EXTRACT "/tmp/perf-kcore-XXXXXX"
 314
 315 struct kcore_extract {
 316         char *kcore_filename;
 317         u64 addr;
 318         u64 offs;
 319         u64 len;
 320         char extract_filename[sizeof(PERF_KCORE_EXTRACT)];
 321         int fd;
 322 };
 323
 324 int kcore_extract__create(struct kcore_extract *kce);
 325 void kcore_extract__delete(struct kcore_extract *kce);
 326
 327 int kcore_copy(const char *from_dir, const char *to_dir);
 328 int compare_proc_modules(const char *from, const char *to);
 329
 330 int setup_list(struct strlist **list, const char *list_str,
 331                const char *list_name);
 332 int setup_intlist(struct intlist **list, const char *list_str,
 333                   const char *list_name);
 334
 335 #ifdef HAVE_LIBELF_SUPPORT
 336 bool elf__needs_adjust_symbols(GElf_Ehdr ehdr);
 337 void arch__sym_update(struct symbol *s, GElf_Sym *sym);
 338 #endif
 339
 340 #define SYMBOL_A 0
 341 #define SYMBOL_B 1
 342
 343 int arch__choose_best_symbol(struct symbol *syma, struct symbol *symb);
 344
 345 /* structure containing an SDT note's info */
 346 struct sdt_note {
 347         char *name;                     /* name of the note*/
 348         char *provider;                 /* provider name */
 349         bool bit32;                     /* whether the location is 32 bits? */
 350         union {                         /* location, base and semaphore addrs */
 351                 Elf64_Addr a64[3];
 352                 Elf32_Addr a32[3];
 353         } addr;
 354         struct list_head note_list;     /* SDT notes' list */
 355 };
 356
 357 int get_sdt_note_list(struct list_head *head, const char *target);
 358 int cleanup_sdt_note_list(struct list_head *sdt_notes);
 359 int sdt_notes__get_count(struct list_head *start);
 360
 361 #define SDT_BASE_SCN ".stapsdt.base"
 362 #define SDT_NOTE_SCN  ".note.stapsdt"
 363 #define SDT_NOTE_TYPE 3
 364 #define SDT_NOTE_NAME "stapsdt"
 365 #define NR_ADDR 3
 366
 367 #endif /* __PERF_SYMBOL */