linux/tools/perf/util/symbol.h
<<
>>
Prefs
   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
  37Elf_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 */
  54struct symbol {
  55        struct rb_node  rb_node;
  56        u64             start;
  57        u64             end;
  58        u16             namelen;
  59        u8              binding;
  60        u8              idle:1;
  61        u8              arch_sym;
  62        char            name[0];
  63};
  64
  65void symbol__delete(struct symbol *sym);
  66void 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
  79static inline size_t symbol__size(const struct symbol *sym)
  80{
  81        return sym->end - sym->start;
  82}
  83
  84struct strlist;
  85struct intlist;
  86
  87struct symbol_conf {
  88        unsigned short  priv_size;
  89        unsigned short  nr_events;
  90        bool            try_vmlinux_path,
  91                        init_annotation,
  92                        force,
  93                        ignore_vmlinux,
  94                        ignore_vmlinux_buildid,
  95                        show_kernel_path,
  96                        use_modules,
  97                        allow_aliases,
  98                        sort_by_name,
  99                        show_nr_samples,
 100                        show_total_period,
 101                        use_callchain,
 102                        cumulate_callchain,
 103                        exclude_other,
 104                        show_cpu_utilization,
 105                        initialized,
 106                        kptr_restrict,
 107                        annotate_asm_raw,
 108                        annotate_src,
 109                        event_group,
 110                        demangle,
 111                        demangle_kernel,
 112                        filter_relative,
 113                        show_hist_headers,
 114                        branch_callstack,
 115                        has_filter,
 116                        show_ref_callgraph,
 117                        hide_unresolved,
 118                        raw_trace,
 119                        report_hierarchy;
 120        const char      *vmlinux_name,
 121                        *kallsyms_name,
 122                        *source_prefix,
 123                        *field_sep;
 124        const char      *default_guest_vmlinux_name,
 125                        *default_guest_kallsyms,
 126                        *default_guest_modules;
 127        const char      *guestmount;
 128        const char      *dso_list_str,
 129                        *comm_list_str,
 130                        *pid_list_str,
 131                        *tid_list_str,
 132                        *sym_list_str,
 133                        *col_width_list_str;
 134       struct strlist   *dso_list,
 135                        *comm_list,
 136                        *sym_list,
 137                        *dso_from_list,
 138                        *dso_to_list,
 139                        *sym_from_list,
 140                        *sym_to_list;
 141        struct intlist  *pid_list,
 142                        *tid_list;
 143        const char      *symfs;
 144};
 145
 146extern struct symbol_conf symbol_conf;
 147
 148struct symbol_name_rb_node {
 149        struct rb_node  rb_node;
 150        struct symbol   sym;
 151};
 152
 153static inline int __symbol__join_symfs(char *bf, size_t size, const char *path)
 154{
 155        return path__join(bf, size, symbol_conf.symfs, path);
 156}
 157
 158#define symbol__join_symfs(bf, path) __symbol__join_symfs(bf, sizeof(bf), path)
 159
 160extern int vmlinux_path__nr_entries;
 161extern char **vmlinux_path;
 162
 163static inline void *symbol__priv(struct symbol *sym)
 164{
 165        return ((void *)sym) - symbol_conf.priv_size;
 166}
 167
 168struct ref_reloc_sym {
 169        const char      *name;
 170        u64             addr;
 171        u64             unrelocated_addr;
 172};
 173
 174struct map_symbol {
 175        struct map    *map;
 176        struct symbol *sym;
 177};
 178
 179struct addr_map_symbol {
 180        struct map    *map;
 181        struct symbol *sym;
 182        u64           addr;
 183        u64           al_addr;
 184};
 185
 186struct branch_info {
 187        struct addr_map_symbol from;
 188        struct addr_map_symbol to;
 189        struct branch_flags flags;
 190        char                    *srcline_from;
 191        char                    *srcline_to;
 192};
 193
 194struct mem_info {
 195        struct addr_map_symbol iaddr;
 196        struct addr_map_symbol daddr;
 197        union perf_mem_data_src data_src;
 198};
 199
 200struct addr_location {
 201        struct machine *machine;
 202        struct thread *thread;
 203        struct map    *map;
 204        struct symbol *sym;
 205        u64           addr;
 206        char          level;
 207        u8            filtered;
 208        u8            cpumode;
 209        s32           cpu;
 210        s32           socket;
 211};
 212
 213struct symsrc {
 214        char *name;
 215        int fd;
 216        enum dso_binary_type type;
 217
 218#ifdef HAVE_LIBELF_SUPPORT
 219        Elf *elf;
 220        GElf_Ehdr ehdr;
 221
 222        Elf_Scn *opdsec;
 223        size_t opdidx;
 224        GElf_Shdr opdshdr;
 225
 226        Elf_Scn *symtab;
 227        GElf_Shdr symshdr;
 228
 229        Elf_Scn *dynsym;
 230        size_t dynsym_idx;
 231        GElf_Shdr dynshdr;
 232
 233        bool adjust_symbols;
 234        bool is_64_bit;
 235#endif
 236};
 237
 238void symsrc__destroy(struct symsrc *ss);
 239int symsrc__init(struct symsrc *ss, struct dso *dso, const char *name,
 240                 enum dso_binary_type type);
 241bool symsrc__has_symtab(struct symsrc *ss);
 242bool symsrc__possibly_runtime(struct symsrc *ss);
 243
 244int dso__load(struct dso *dso, struct map *map);
 245int dso__load_vmlinux(struct dso *dso, struct map *map,
 246                      const char *vmlinux, bool vmlinux_allocated);
 247int dso__load_vmlinux_path(struct dso *dso, struct map *map);
 248int __dso__load_kallsyms(struct dso *dso, const char *filename, struct map *map,
 249                         bool no_kcore);
 250int dso__load_kallsyms(struct dso *dso, const char *filename, struct map *map);
 251
 252void dso__insert_symbol(struct dso *dso, enum map_type type,
 253                        struct symbol *sym);
 254
 255struct symbol *dso__find_symbol(struct dso *dso, enum map_type type,
 256                                u64 addr);
 257struct symbol *dso__find_symbol_by_name(struct dso *dso, enum map_type type,
 258                                        const char *name);
 259struct symbol *symbol__next_by_name(struct symbol *sym);
 260
 261struct symbol *dso__first_symbol(struct dso *dso, enum map_type type);
 262struct symbol *dso__last_symbol(struct dso *dso, enum map_type type);
 263struct symbol *dso__next_symbol(struct symbol *sym);
 264
 265enum dso_type dso__type_fd(int fd);
 266
 267int filename__read_build_id(const char *filename, void *bf, size_t size);
 268int sysfs__read_build_id(const char *filename, void *bf, size_t size);
 269int modules__parse(const char *filename, void *arg,
 270                   int (*process_module)(void *arg, const char *name,
 271                                         u64 start));
 272int filename__read_debuglink(const char *filename, char *debuglink,
 273                             size_t size);
 274
 275struct perf_env;
 276int symbol__init(struct perf_env *env);
 277void symbol__exit(void);
 278void symbol__elf_init(void);
 279int symbol__annotation_init(void);
 280
 281struct symbol *symbol__new(u64 start, u64 len, u8 binding, const char *name);
 282size_t __symbol__fprintf_symname_offs(const struct symbol *sym,
 283                                      const struct addr_location *al,
 284                                      bool unknown_as_addr, FILE *fp);
 285size_t symbol__fprintf_symname_offs(const struct symbol *sym,
 286                                    const struct addr_location *al, FILE *fp);
 287size_t __symbol__fprintf_symname(const struct symbol *sym,
 288                                 const struct addr_location *al,
 289                                 bool unknown_as_addr, FILE *fp);
 290size_t symbol__fprintf_symname(const struct symbol *sym, FILE *fp);
 291size_t symbol__fprintf(struct symbol *sym, FILE *fp);
 292bool symbol_type__is_a(char symbol_type, enum map_type map_type);
 293bool symbol__restricted_filename(const char *filename,
 294                                 const char *restricted_filename);
 295int symbol__config_symfs(const struct option *opt __maybe_unused,
 296                         const char *dir, int unset __maybe_unused);
 297
 298int dso__load_sym(struct dso *dso, struct map *map, struct symsrc *syms_ss,
 299                  struct symsrc *runtime_ss, int kmodule);
 300int dso__synthesize_plt_symbols(struct dso *dso, struct symsrc *ss,
 301                                struct map *map);
 302
 303void __symbols__insert(struct rb_root *symbols, struct symbol *sym, bool kernel);
 304void symbols__insert(struct rb_root *symbols, struct symbol *sym);
 305void symbols__fixup_duplicate(struct rb_root *symbols);
 306void symbols__fixup_end(struct rb_root *symbols);
 307void __map_groups__fixup_end(struct map_groups *mg, enum map_type type);
 308
 309typedef int (*mapfn_t)(u64 start, u64 len, u64 pgoff, void *data);
 310int 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
 315struct 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
 324int kcore_extract__create(struct kcore_extract *kce);
 325void kcore_extract__delete(struct kcore_extract *kce);
 326
 327int kcore_copy(const char *from_dir, const char *to_dir);
 328int compare_proc_modules(const char *from, const char *to);
 329
 330int setup_list(struct strlist **list, const char *list_str,
 331               const char *list_name);
 332int setup_intlist(struct intlist **list, const char *list_str,
 333                  const char *list_name);
 334
 335#ifdef HAVE_LIBELF_SUPPORT
 336bool elf__needs_adjust_symbols(GElf_Ehdr ehdr);
 337void arch__sym_update(struct symbol *s, GElf_Sym *sym);
 338#endif
 339
 340#define SYMBOL_A 0
 341#define SYMBOL_B 1
 342
 343int arch__choose_best_symbol(struct symbol *syma, struct symbol *symb);
 344
 345/* structure containing an SDT note's info */
 346struct 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
 357int get_sdt_note_list(struct list_head *head, const char *target);
 358int cleanup_sdt_note_list(struct list_head *sdt_notes);
 359int 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 */
 368