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
  17 #ifdef HAVE_LIBELF_SUPPORT
  18 #include <libelf.h>
  19 #include <gelf.h>
  20 #endif
  21 #include <elf.h>
  22
  23 #include "dso.h"
  24
  25 #ifdef HAVE_CPLUS_DEMANGLE_SUPPORT
  26 extern char *cplus_demangle(const char *, int);
  27
  28 static inline char *bfd_demangle(void __maybe_unused *v, const char *c, int i)
  29 {
  30         return cplus_demangle(c, i);
  31 }
  32 #else
  33 #ifdef NO_DEMANGLE
  34 static inline char *bfd_demangle(void __maybe_unused *v,
  35                                  const char __maybe_unused *c,
  36                                  int __maybe_unused i)
  37 {
  38         return NULL;
  39 }
  40 #else
  41 #define PACKAGE 'perf'
  42 #include <bfd.h>
  43 #endif
  44 #endif
  45
  46 /*
  47  * libelf 0.8.x and earlier do not support ELF_C_READ_MMAP;
  48  * for newer versions we can use mmap to reduce memory usage:
  49  */
  50 #ifdef HAVE_LIBELF_MMAP_SUPPORT
  51 # define PERF_ELF_C_READ_MMAP ELF_C_READ_MMAP
  52 #else
  53 # define PERF_ELF_C_READ_MMAP ELF_C_READ
  54 #endif
  55
  56 #ifdef HAVE_LIBELF_SUPPORT
  57 extern Elf_Scn *elf_section_by_name(Elf *elf, GElf_Ehdr *ep,
  58                                 GElf_Shdr *shp, const char *name, size_t *idx);
  59 #endif
  60
  61 #ifndef DMGL_PARAMS
  62 #define DMGL_PARAMS      (1 << 0)       /* Include function args */
  63 #define DMGL_ANSI        (1 << 1)       /* Include const, volatile, etc */
  64 #endif
  65
  66 /** struct symbol - symtab entry
  67  *
  68  * @ignore - resolvable but tools ignore it (e.g. idle routines)
  69  */
  70 struct symbol {
  71         struct rb_node  rb_node;
  72         u64             start;
  73         u64             end;
  74         u16             namelen;
  75         u8              binding;
  76         bool            ignore;
  77         char            name[0];
  78 };
  79
  80 void symbol__delete(struct symbol *sym);
  81 void symbols__delete(struct rb_root *symbols);
  82
  83 /* symbols__for_each_entry - iterate over symbols (rb_root)
  84  *
  85  * @symbols: the rb_root of symbols
  86  * @pos: the 'struct symbol *' to use as a loop cursor
  87  * @nd: the 'struct rb_node *' to use as a temporary storage
  88  */
  89 #define symbols__for_each_entry(symbols, pos, nd)                       \
  90         for (nd = rb_first(symbols);                                    \
  91              nd && (pos = rb_entry(nd, struct symbol, rb_node));        \
  92              nd = rb_next(nd))
  93
  94 static inline size_t symbol__size(const struct symbol *sym)
  95 {
  96         return sym->end - sym->start + 1;
  97 }
  98
  99 struct strlist;
 100
 101 struct symbol_conf {
 102         unsigned short  priv_size;
 103         unsigned short  nr_events;
 104         bool            try_vmlinux_path,
 105                         ignore_vmlinux,
 106                         show_kernel_path,
 107                         use_modules,
 108                         sort_by_name,
 109                         show_nr_samples,
 110                         show_total_period,
 111                         use_callchain,
 112                         cumulate_callchain,
 113                         exclude_other,
 114                         show_cpu_utilization,
 115                         initialized,
 116                         kptr_restrict,
 117                         annotate_asm_raw,
 118                         annotate_src,
 119                         event_group,
 120                         demangle,
 121                         filter_relative;
 122         const char      *vmlinux_name,
 123                         *kallsyms_name,
 124                         *source_prefix,
 125                         *field_sep;
 126         const char      *default_guest_vmlinux_name,
 127                         *default_guest_kallsyms,
 128                         *default_guest_modules;
 129         const char      *guestmount;
 130         const char      *dso_list_str,
 131                         *comm_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         const char      *symfs;
 142 };
 143
 144 extern struct symbol_conf symbol_conf;
 145 extern int vmlinux_path__nr_entries;
 146 extern char **vmlinux_path;
 147
 148 static inline void *symbol__priv(struct symbol *sym)
 149 {
 150         return ((void *)sym) - symbol_conf.priv_size;
 151 }
 152
 153 struct ref_reloc_sym {
 154         const char      *name;
 155         u64             addr;
 156         u64             unrelocated_addr;
 157 };
 158
 159 struct map_symbol {
 160         struct map    *map;
 161         struct symbol *sym;
 162         bool          unfolded;
 163         bool          has_children;
 164 };
 165
 166 struct addr_map_symbol {
 167         struct map    *map;
 168         struct symbol *sym;
 169         u64           addr;
 170         u64           al_addr;
 171 };
 172
 173 struct branch_info {
 174         struct addr_map_symbol from;
 175         struct addr_map_symbol to;
 176         struct branch_flags flags;
 177 };
 178
 179 struct mem_info {
 180         struct addr_map_symbol iaddr;
 181         struct addr_map_symbol daddr;
 182         union perf_mem_data_src data_src;
 183 };
 184
 185 struct addr_location {
 186         struct machine *machine;
 187         struct thread *thread;
 188         struct map    *map;
 189         struct symbol *sym;
 190         u64           addr;
 191         char          level;
 192         u8            filtered;
 193         u8            cpumode;
 194         s32           cpu;
 195 };
 196
 197 struct symsrc {
 198         char *name;
 199         int fd;
 200         enum dso_binary_type type;
 201
 202 #ifdef HAVE_LIBELF_SUPPORT
 203         Elf *elf;
 204         GElf_Ehdr ehdr;
 205
 206         Elf_Scn *opdsec;
 207         size_t opdidx;
 208         GElf_Shdr opdshdr;
 209
 210         Elf_Scn *symtab;
 211         GElf_Shdr symshdr;
 212
 213         Elf_Scn *dynsym;
 214         size_t dynsym_idx;
 215         GElf_Shdr dynshdr;
 216
 217         bool adjust_symbols;
 218 #endif
 219 };
 220
 221 void symsrc__destroy(struct symsrc *ss);
 222 int symsrc__init(struct symsrc *ss, struct dso *dso, const char *name,
 223                  enum dso_binary_type type);
 224 bool symsrc__has_symtab(struct symsrc *ss);
 225 bool symsrc__possibly_runtime(struct symsrc *ss);
 226
 227 int dso__load(struct dso *dso, struct map *map, symbol_filter_t filter);
 228 int dso__load_vmlinux(struct dso *dso, struct map *map,
 229                       const char *vmlinux, bool vmlinux_allocated,
 230                       symbol_filter_t filter);
 231 int dso__load_vmlinux_path(struct dso *dso, struct map *map,
 232                            symbol_filter_t filter);
 233 int dso__load_kallsyms(struct dso *dso, const char *filename, struct map *map,
 234                        symbol_filter_t filter);
 235
 236 struct symbol *dso__find_symbol(struct dso *dso, enum map_type type,
 237                                 u64 addr);
 238 struct symbol *dso__find_symbol_by_name(struct dso *dso, enum map_type type,
 239                                         const char *name);
 240
 241 int filename__read_build_id(const char *filename, void *bf, size_t size);
 242 int sysfs__read_build_id(const char *filename, void *bf, size_t size);
 243 int modules__parse(const char *filename, void *arg,
 244                    int (*process_module)(void *arg, const char *name,
 245                                          u64 start));
 246 int filename__read_debuglink(const char *filename, char *debuglink,
 247                              size_t size);
 248
 249 int symbol__init(void);
 250 void symbol__exit(void);
 251 void symbol__elf_init(void);
 252 struct symbol *symbol__new(u64 start, u64 len, u8 binding, const char *name);
 253 size_t symbol__fprintf_symname_offs(const struct symbol *sym,
 254                                     const struct addr_location *al, FILE *fp);
 255 size_t symbol__fprintf_symname(const struct symbol *sym, FILE *fp);
 256 size_t symbol__fprintf(struct symbol *sym, FILE *fp);
 257 bool symbol_type__is_a(char symbol_type, enum map_type map_type);
 258 bool symbol__restricted_filename(const char *filename,
 259                                  const char *restricted_filename);
 260 bool symbol__is_idle(struct symbol *sym);
 261
 262 int dso__load_sym(struct dso *dso, struct map *map, struct symsrc *syms_ss,
 263                   struct symsrc *runtime_ss, symbol_filter_t filter,
 264                   int kmodule);
 265 int dso__synthesize_plt_symbols(struct dso *dso, struct symsrc *ss,
 266                                 struct map *map, symbol_filter_t filter);
 267
 268 void symbols__insert(struct rb_root *symbols, struct symbol *sym);
 269 void symbols__fixup_duplicate(struct rb_root *symbols);
 270 void symbols__fixup_end(struct rb_root *symbols);
 271 void __map_groups__fixup_end(struct map_groups *mg, enum map_type type);
 272
 273 typedef int (*mapfn_t)(u64 start, u64 len, u64 pgoff, void *data);
 274 int file__read_maps(int fd, bool exe, mapfn_t mapfn, void *data,
 275                     bool *is_64_bit);
 276
 277 #define PERF_KCORE_EXTRACT "/tmp/perf-kcore-XXXXXX"
 278
 279 struct kcore_extract {
 280         char *kcore_filename;
 281         u64 addr;
 282         u64 offs;
 283         u64 len;
 284         char extract_filename[sizeof(PERF_KCORE_EXTRACT)];
 285         int fd;
 286 };
 287
 288 int kcore_extract__create(struct kcore_extract *kce);
 289 void kcore_extract__delete(struct kcore_extract *kce);
 290
 291 int kcore_copy(const char *from_dir, const char *to_dir);
 292 int compare_proc_modules(const char *from, const char *to);
 293
 294 int setup_list(struct strlist **list, const char *list_str,
 295                const char *list_name);
 296
 297 #endif /* __PERF_SYMBOL */