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