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