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
  16 #ifdef LIBELF_SUPPORT
  17 #include <libelf.h>
  18 #include <gelf.h>
  19 #endif
  20 #include <elf.h>
  21
  22 #include "dso.h"
  23
  24 #ifdef HAVE_CPLUS_DEMANGLE
  25 extern char *cplus_demangle(const char *, int);
  26
  27 static inline char *bfd_demangle(void __maybe_unused *v, const char *c, int i)
  28 {
  29         return cplus_demangle(c, i);
  30 }
  31 #else
  32 #ifdef NO_DEMANGLE
  33 static inline char *bfd_demangle(void __maybe_unused *v,
  34                                  const char __maybe_unused *c,
  35                                  int __maybe_unused i)
  36 {
  37         return NULL;
  38 }
  39 #else
  40 #define PACKAGE 'perf'
  41 #include <bfd.h>
  42 #endif
  43 #endif
  44
  45 /*
  46  * libelf 0.8.x and earlier do not support ELF_C_READ_MMAP;
  47  * for newer versions we can use mmap to reduce memory usage:
  48  */
  49 #ifdef LIBELF_MMAP
  50 # define PERF_ELF_C_READ_MMAP ELF_C_READ_MMAP
  51 #else
  52 # define PERF_ELF_C_READ_MMAP ELF_C_READ
  53 #endif
  54
  55 #ifndef DMGL_PARAMS
  56 #define DMGL_PARAMS      (1 << 0)       /* Include function args */
  57 #define DMGL_ANSI        (1 << 1)       /* Include const, volatile, etc */
  58 #endif
  59
  60 /** struct symbol - symtab entry
  61  *
  62  * @ignore - resolvable but tools ignore it (e.g. idle routines)
  63  */
  64 struct symbol {
  65         struct rb_node  rb_node;
  66         u64             start;
  67         u64             end;
  68         u16             namelen;
  69         u8              binding;
  70         bool            ignore;
  71         char            name[0];
  72 };
  73
  74 void symbol__delete(struct symbol *sym);
  75 void symbols__delete(struct rb_root *symbols);
  76
  77 static inline size_t symbol__size(const struct symbol *sym)
  78 {
  79         return sym->end - sym->start + 1;
  80 }
  81
  82 struct strlist;
  83
  84 struct symbol_conf {
  85         unsigned short  priv_size;
  86         unsigned short  nr_events;
  87         bool            try_vmlinux_path,
  88                         show_kernel_path,
  89                         use_modules,
  90                         sort_by_name,
  91                         show_nr_samples,
  92                         show_total_period,
  93                         use_callchain,
  94                         exclude_other,
  95                         show_cpu_utilization,
  96                         initialized,
  97                         kptr_restrict,
  98                         annotate_asm_raw,
  99                         annotate_src,
 100                         event_group;
 101         const char      *vmlinux_name,
 102                         *kallsyms_name,
 103                         *source_prefix,
 104                         *field_sep;
 105         const char      *default_guest_vmlinux_name,
 106                         *default_guest_kallsyms,
 107                         *default_guest_modules;
 108         const char      *guestmount;
 109         const char      *dso_list_str,
 110                         *comm_list_str,
 111                         *sym_list_str,
 112                         *col_width_list_str;
 113        struct strlist   *dso_list,
 114                         *comm_list,
 115                         *sym_list,
 116                         *dso_from_list,
 117                         *dso_to_list,
 118                         *sym_from_list,
 119                         *sym_to_list;
 120         const char      *symfs;
 121 };
 122
 123 extern struct symbol_conf symbol_conf;
 124 extern int vmlinux_path__nr_entries;
 125 extern char **vmlinux_path;
 126
 127 static inline void *symbol__priv(struct symbol *sym)
 128 {
 129         return ((void *)sym) - symbol_conf.priv_size;
 130 }
 131
 132 struct ref_reloc_sym {
 133         const char      *name;
 134         u64             addr;
 135         u64             unrelocated_addr;
 136 };
 137
 138 struct map_symbol {
 139         struct map    *map;
 140         struct symbol *sym;
 141         bool          unfolded;
 142         bool          has_children;
 143 };
 144
 145 struct addr_map_symbol {
 146         struct map    *map;
 147         struct symbol *sym;
 148         u64           addr;
 149         u64           al_addr;
 150 };
 151
 152 struct branch_info {
 153         struct addr_map_symbol from;
 154         struct addr_map_symbol to;
 155         struct branch_flags flags;
 156 };
 157
 158 struct addr_location {
 159         struct thread *thread;
 160         struct map    *map;
 161         struct symbol *sym;
 162         u64           addr;
 163         char          level;
 164         bool          filtered;
 165         u8            cpumode;
 166         s32           cpu;
 167 };
 168
 169 struct symsrc {
 170         char *name;
 171         int fd;
 172         enum dso_binary_type type;
 173
 174 #ifdef LIBELF_SUPPORT
 175         Elf *elf;
 176         GElf_Ehdr ehdr;
 177
 178         Elf_Scn *opdsec;
 179         size_t opdidx;
 180         GElf_Shdr opdshdr;
 181
 182         Elf_Scn *symtab;
 183         GElf_Shdr symshdr;
 184
 185         Elf_Scn *dynsym;
 186         size_t dynsym_idx;
 187         GElf_Shdr dynshdr;
 188
 189         bool adjust_symbols;
 190 #endif
 191 };
 192
 193 void symsrc__destroy(struct symsrc *ss);
 194 int symsrc__init(struct symsrc *ss, struct dso *dso, const char *name,
 195                  enum dso_binary_type type);
 196 bool symsrc__has_symtab(struct symsrc *ss);
 197 bool symsrc__possibly_runtime(struct symsrc *ss);
 198
 199 int dso__load(struct dso *dso, struct map *map, symbol_filter_t filter);
 200 int dso__load_vmlinux(struct dso *dso, struct map *map,
 201                       const char *vmlinux, symbol_filter_t filter);
 202 int dso__load_vmlinux_path(struct dso *dso, struct map *map,
 203                            symbol_filter_t filter);
 204 int dso__load_kallsyms(struct dso *dso, const char *filename, struct map *map,
 205                        symbol_filter_t filter);
 206
 207 struct symbol *dso__find_symbol(struct dso *dso, enum map_type type,
 208                                 u64 addr);
 209 struct symbol *dso__find_symbol_by_name(struct dso *dso, enum map_type type,
 210                                         const char *name);
 211
 212 int filename__read_build_id(const char *filename, void *bf, size_t size);
 213 int sysfs__read_build_id(const char *filename, void *bf, size_t size);
 214 int kallsyms__parse(const char *filename, void *arg,
 215                     int (*process_symbol)(void *arg, const char *name,
 216                                           char type, u64 start));
 217 int filename__read_debuglink(const char *filename, char *debuglink,
 218                              size_t size);
 219
 220 int symbol__init(void);
 221 void symbol__exit(void);
 222 void symbol__elf_init(void);
 223 struct symbol *symbol__new(u64 start, u64 len, u8 binding, const char *name);
 224 size_t symbol__fprintf_symname_offs(const struct symbol *sym,
 225                                     const struct addr_location *al, FILE *fp);
 226 size_t symbol__fprintf_symname(const struct symbol *sym, FILE *fp);
 227 size_t symbol__fprintf(struct symbol *sym, FILE *fp);
 228 bool symbol_type__is_a(char symbol_type, enum map_type map_type);
 229 bool symbol__restricted_filename(const char *filename,
 230                                  const char *restricted_filename);
 231
 232 int dso__load_sym(struct dso *dso, struct map *map, struct symsrc *syms_ss,
 233                   struct symsrc *runtime_ss, symbol_filter_t filter,
 234                   int kmodule);
 235 int dso__synthesize_plt_symbols(struct dso *dso, struct symsrc *ss,
 236                                 struct map *map, symbol_filter_t filter);
 237
 238 void symbols__insert(struct rb_root *symbols, struct symbol *sym);
 239 void symbols__fixup_duplicate(struct rb_root *symbols);
 240 void symbols__fixup_end(struct rb_root *symbols);
 241 void __map_groups__fixup_end(struct map_groups *mg, enum map_type type);
 242
 243 #endif /* __PERF_SYMBOL */