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