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                         show_hist_headers;
 123         const char      *vmlinux_name,
 124                         *kallsyms_name,
 125                         *source_prefix,
 126                         *field_sep;
 127         const char      *default_guest_vmlinux_name,
 128                         *default_guest_kallsyms,
 129                         *default_guest_modules;
 130         const char      *guestmount;
 131         const char      *dso_list_str,
 132                         *comm_list_str,
 133                         *sym_list_str,
 134                         *col_width_list_str;
 135        struct strlist   *dso_list,
 136                         *comm_list,
 137                         *sym_list,
 138                         *dso_from_list,
 139                         *dso_to_list,
 140                         *sym_from_list,
 141                         *sym_to_list;
 142         const char      *symfs;
 143 };
 144
 145 extern struct symbol_conf symbol_conf;
 146 extern int vmlinux_path__nr_entries;
 147 extern char **vmlinux_path;
 148
 149 static inline void *symbol__priv(struct symbol *sym)
 150 {
 151         return ((void *)sym) - symbol_conf.priv_size;
 152 }
 153
 154 struct ref_reloc_sym {
 155         const char      *name;
 156         u64             addr;
 157         u64             unrelocated_addr;
 158 };
 159
 160 struct map_symbol {
 161         struct map    *map;
 162         struct symbol *sym;
 163         bool          unfolded;
 164         bool          has_children;
 165 };
 166
 167 struct addr_map_symbol {
 168         struct map    *map;
 169         struct symbol *sym;
 170         u64           addr;
 171         u64           al_addr;
 172 };
 173
 174 struct branch_info {
 175         struct addr_map_symbol from;
 176         struct addr_map_symbol to;
 177         struct branch_flags flags;
 178 };
 179
 180 struct mem_info {
 181         struct addr_map_symbol iaddr;
 182         struct addr_map_symbol daddr;
 183         union perf_mem_data_src data_src;
 184 };
 185
 186 struct addr_location {
 187         struct machine *machine;
 188         struct thread *thread;
 189         struct map    *map;
 190         struct symbol *sym;
 191         u64           addr;
 192         char          level;
 193         u8            filtered;
 194         u8            cpumode;
 195         s32           cpu;
 196 };
 197
 198 struct symsrc {
 199         char *name;
 200         int fd;
 201         enum dso_binary_type type;
 202
 203 #ifdef HAVE_LIBELF_SUPPORT
 204         Elf *elf;
 205         GElf_Ehdr ehdr;
 206
 207         Elf_Scn *opdsec;
 208         size_t opdidx;
 209         GElf_Shdr opdshdr;
 210
 211         Elf_Scn *symtab;
 212         GElf_Shdr symshdr;
 213
 214         Elf_Scn *dynsym;
 215         size_t dynsym_idx;
 216         GElf_Shdr dynshdr;
 217
 218         bool adjust_symbols;
 219         bool is_64_bit;
 220 #endif
 221 };
 222
 223 void symsrc__destroy(struct symsrc *ss);
 224 int symsrc__init(struct symsrc *ss, struct dso *dso, const char *name,
 225                  enum dso_binary_type type);
 226 bool symsrc__has_symtab(struct symsrc *ss);
 227 bool symsrc__possibly_runtime(struct symsrc *ss);
 228
 229 int dso__load(struct dso *dso, struct map *map, symbol_filter_t filter);
 230 int dso__load_vmlinux(struct dso *dso, struct map *map,
 231                       const char *vmlinux, bool vmlinux_allocated,
 232                       symbol_filter_t filter);
 233 int dso__load_vmlinux_path(struct dso *dso, struct map *map,
 234                            symbol_filter_t filter);
 235 int dso__load_kallsyms(struct dso *dso, const char *filename, struct map *map,
 236                        symbol_filter_t filter);
 237
 238 struct symbol *dso__find_symbol(struct dso *dso, enum map_type type,
 239                                 u64 addr);
 240 struct symbol *dso__find_symbol_by_name(struct dso *dso, enum map_type type,
 241                                         const char *name);
 242
 243 struct symbol *dso__first_symbol(struct dso *dso, enum map_type type);
 244 struct symbol *dso__next_symbol(struct symbol *sym);
 245
 246 enum dso_type dso__type_fd(int fd);
 247
 248 int filename__read_build_id(const char *filename, void *bf, size_t size);
 249 int sysfs__read_build_id(const char *filename, void *bf, size_t size);
 250 int modules__parse(const char *filename, void *arg,
 251                    int (*process_module)(void *arg, const char *name,
 252                                          u64 start));
 253 int filename__read_debuglink(const char *filename, char *debuglink,
 254                              size_t size);
 255
 256 int symbol__init(void);
 257 void symbol__exit(void);
 258 void symbol__elf_init(void);
 259 struct symbol *symbol__new(u64 start, u64 len, u8 binding, const char *name);
 260 size_t symbol__fprintf_symname_offs(const struct symbol *sym,
 261                                     const struct addr_location *al, FILE *fp);
 262 size_t symbol__fprintf_symname(const struct symbol *sym, FILE *fp);
 263 size_t symbol__fprintf(struct symbol *sym, FILE *fp);
 264 bool symbol_type__is_a(char symbol_type, enum map_type map_type);
 265 bool symbol__restricted_filename(const char *filename,
 266                                  const char *restricted_filename);
 267 bool symbol__is_idle(struct symbol *sym);
 268
 269 int dso__load_sym(struct dso *dso, struct map *map, struct symsrc *syms_ss,
 270                   struct symsrc *runtime_ss, symbol_filter_t filter,
 271                   int kmodule);
 272 int dso__synthesize_plt_symbols(struct dso *dso, struct symsrc *ss,
 273                                 struct map *map, symbol_filter_t filter);
 274
 275 void symbols__insert(struct rb_root *symbols, struct symbol *sym);
 276 void symbols__fixup_duplicate(struct rb_root *symbols);
 277 void symbols__fixup_end(struct rb_root *symbols);
 278 void __map_groups__fixup_end(struct map_groups *mg, enum map_type type);
 279
 280 typedef int (*mapfn_t)(u64 start, u64 len, u64 pgoff, void *data);
 281 int file__read_maps(int fd, bool exe, mapfn_t mapfn, void *data,
 282                     bool *is_64_bit);
 283
 284 #define PERF_KCORE_EXTRACT "/tmp/perf-kcore-XXXXXX"
 285
 286 struct kcore_extract {
 287         char *kcore_filename;
 288         u64 addr;
 289         u64 offs;
 290         u64 len;
 291         char extract_filename[sizeof(PERF_KCORE_EXTRACT)];
 292         int fd;
 293 };
 294
 295 int kcore_extract__create(struct kcore_extract *kce);
 296 void kcore_extract__delete(struct kcore_extract *kce);
 297
 298 int kcore_copy(const char *from_dir, const char *to_dir);
 299 int compare_proc_modules(const char *from, const char *to);
 300
 301 int setup_list(struct strlist **list, const char *list_str,
 302                const char *list_name);
 303
 304 #endif /* __PERF_SYMBOL */