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 <linux/list.h>
   9 #include <linux/rbtree.h>
  10 #include <stdio.h>
  11
  12 #ifdef HAVE_CPLUS_DEMANGLE
  13 extern char *cplus_demangle(const char *, int);
  14
  15 static inline char *bfd_demangle(void __used *v, const char *c, int i)
  16 {
  17         return cplus_demangle(c, i);
  18 }
  19 #else
  20 #ifdef NO_DEMANGLE
  21 static inline char *bfd_demangle(void __used *v, const char __used *c,
  22                                  int __used i)
  23 {
  24         return NULL;
  25 }
  26 #else
  27 #include <bfd.h>
  28 #endif
  29 #endif
  30
  31 int hex2u64(const char *ptr, u64 *val);
  32 char *strxfrchar(char *s, char from, char to);
  33
  34 /*
  35  * libelf 0.8.x and earlier do not support ELF_C_READ_MMAP;
  36  * for newer versions we can use mmap to reduce memory usage:
  37  */
  38 #ifdef LIBELF_NO_MMAP
  39 # define PERF_ELF_C_READ_MMAP ELF_C_READ
  40 #else
  41 # define PERF_ELF_C_READ_MMAP ELF_C_READ_MMAP
  42 #endif
  43
  44 #ifndef DMGL_PARAMS
  45 #define DMGL_PARAMS      (1 << 0)       /* Include function args */
  46 #define DMGL_ANSI        (1 << 1)       /* Include const, volatile, etc */
  47 #endif
  48
  49 #define BUILD_ID_SIZE 20
  50
  51 /** struct symbol - symtab entry
  52  *
  53  * @ignore - resolvable but tools ignore it (e.g. idle routines)
  54  */
  55 struct symbol {
  56         struct rb_node  rb_node;
  57         u64             start;
  58         u64             end;
  59         u16             namelen;
  60         u8              binding;
  61         bool            ignore;
  62         char            name[0];
  63 };
  64
  65 void symbol__delete(struct symbol *sym);
  66
  67 struct strlist;
  68
  69 struct symbol_conf {
  70         unsigned short  priv_size;
  71         bool            try_vmlinux_path,
  72                         use_modules,
  73                         sort_by_name,
  74                         show_nr_samples,
  75                         show_total_period,
  76                         use_callchain,
  77                         exclude_other,
  78                         show_cpu_utilization,
  79                         initialized,
  80                         kptr_restrict,
  81                         annotate_asm_raw,
  82                         annotate_src;
  83         const char      *vmlinux_name,
  84                         *kallsyms_name,
  85                         *source_prefix,
  86                         *field_sep;
  87         const char      *default_guest_vmlinux_name,
  88                         *default_guest_kallsyms,
  89                         *default_guest_modules;
  90         const char      *guestmount;
  91         const char      *dso_list_str,
  92                         *comm_list_str,
  93                         *sym_list_str,
  94                         *col_width_list_str;
  95        struct strlist   *dso_list,
  96                         *comm_list,
  97                         *sym_list;
  98         const char      *symfs;
  99 };
 100
 101 extern struct symbol_conf symbol_conf;
 102
 103 static inline void *symbol__priv(struct symbol *sym)
 104 {
 105         return ((void *)sym) - symbol_conf.priv_size;
 106 }
 107
 108 struct ref_reloc_sym {
 109         const char      *name;
 110         u64             addr;
 111         u64             unrelocated_addr;
 112 };
 113
 114 struct map_symbol {
 115         struct map    *map;
 116         struct symbol *sym;
 117         bool          unfolded;
 118         bool          has_children;
 119 };
 120
 121 struct addr_location {
 122         struct thread *thread;
 123         struct map    *map;
 124         struct symbol *sym;
 125         u64           addr;
 126         char          level;
 127         bool          filtered;
 128         u8            cpumode;
 129         s32           cpu;
 130 };
 131
 132 enum dso_kernel_type {
 133         DSO_TYPE_USER = 0,
 134         DSO_TYPE_KERNEL,
 135         DSO_TYPE_GUEST_KERNEL
 136 };
 137
 138 struct dso {
 139         struct list_head node;
 140         struct rb_root   symbols[MAP__NR_TYPES];
 141         struct rb_root   symbol_names[MAP__NR_TYPES];
 142         enum dso_kernel_type    kernel;
 143         u8               adjust_symbols:1;
 144         u8               has_build_id:1;
 145         u8               hit:1;
 146         u8               annotate_warned:1;
 147         u8               sname_alloc:1;
 148         u8               lname_alloc:1;
 149         unsigned char    symtab_type;
 150         u8               sorted_by_name;
 151         u8               loaded;
 152         u8               build_id[BUILD_ID_SIZE];
 153         const char       *short_name;
 154         char             *long_name;
 155         u16              long_name_len;
 156         u16              short_name_len;
 157         char             name[0];
 158 };
 159
 160 struct dso *dso__new(const char *name);
 161 void dso__delete(struct dso *dso);
 162
 163 int dso__name_len(const struct dso *dso);
 164
 165 bool dso__loaded(const struct dso *dso, enum map_type type);
 166 bool dso__sorted_by_name(const struct dso *dso, enum map_type type);
 167
 168 static inline void dso__set_loaded(struct dso *dso, enum map_type type)
 169 {
 170         dso->loaded |= (1 << type);
 171 }
 172
 173 void dso__sort_by_name(struct dso *dso, enum map_type type);
 174
 175 struct dso *__dsos__findnew(struct list_head *head, const char *name);
 176
 177 int dso__load(struct dso *dso, struct map *map, symbol_filter_t filter);
 178 int dso__load_vmlinux(struct dso *dso, struct map *map,
 179                       const char *vmlinux, symbol_filter_t filter);
 180 int dso__load_vmlinux_path(struct dso *dso, struct map *map,
 181                            symbol_filter_t filter);
 182 int dso__load_kallsyms(struct dso *dso, const char *filename, struct map *map,
 183                        symbol_filter_t filter);
 184 int machine__load_kallsyms(struct machine *machine, const char *filename,
 185                            enum map_type type, symbol_filter_t filter);
 186 int machine__load_vmlinux_path(struct machine *machine, enum map_type type,
 187                                symbol_filter_t filter);
 188
 189 size_t __dsos__fprintf(struct list_head *head, FILE *fp);
 190
 191 size_t machine__fprintf_dsos_buildid(struct machine *machine,
 192                                      FILE *fp, bool with_hits);
 193 size_t machines__fprintf_dsos(struct rb_root *machines, FILE *fp);
 194 size_t machines__fprintf_dsos_buildid(struct rb_root *machines,
 195                                       FILE *fp, bool with_hits);
 196 size_t dso__fprintf_buildid(struct dso *dso, FILE *fp);
 197 size_t dso__fprintf_symbols_by_name(struct dso *dso,
 198                                     enum map_type type, FILE *fp);
 199 size_t dso__fprintf(struct dso *dso, enum map_type type, FILE *fp);
 200
 201 enum symtab_type {
 202         SYMTAB__KALLSYMS = 0,
 203         SYMTAB__GUEST_KALLSYMS,
 204         SYMTAB__JAVA_JIT,
 205         SYMTAB__BUILD_ID_CACHE,
 206         SYMTAB__FEDORA_DEBUGINFO,
 207         SYMTAB__UBUNTU_DEBUGINFO,
 208         SYMTAB__BUILDID_DEBUGINFO,
 209         SYMTAB__SYSTEM_PATH_DSO,
 210         SYMTAB__GUEST_KMODULE,
 211         SYMTAB__SYSTEM_PATH_KMODULE,
 212         SYMTAB__NOT_FOUND,
 213 };
 214
 215 char dso__symtab_origin(const struct dso *dso);
 216 void dso__set_long_name(struct dso *dso, char *name);
 217 void dso__set_build_id(struct dso *dso, void *build_id);
 218 void dso__read_running_kernel_build_id(struct dso *dso,
 219                                        struct machine *machine);
 220 struct symbol *dso__find_symbol(struct dso *dso, enum map_type type,
 221                                 u64 addr);
 222 struct symbol *dso__find_symbol_by_name(struct dso *dso, enum map_type type,
 223                                         const char *name);
 224
 225 int filename__read_build_id(const char *filename, void *bf, size_t size);
 226 int sysfs__read_build_id(const char *filename, void *bf, size_t size);
 227 bool __dsos__read_build_ids(struct list_head *head, bool with_hits);
 228 int build_id__sprintf(const u8 *build_id, int len, char *bf);
 229 int kallsyms__parse(const char *filename, void *arg,
 230                     int (*process_symbol)(void *arg, const char *name,
 231                                           char type, u64 start, u64 end));
 232
 233 void machine__destroy_kernel_maps(struct machine *machine);
 234 int __machine__create_kernel_maps(struct machine *machine, struct dso *kernel);
 235 int machine__create_kernel_maps(struct machine *machine);
 236
 237 int machines__create_kernel_maps(struct rb_root *machines, pid_t pid);
 238 int machines__create_guest_kernel_maps(struct rb_root *machines);
 239 void machines__destroy_guest_kernel_maps(struct rb_root *machines);
 240
 241 int symbol__init(void);
 242 void symbol__exit(void);
 243 bool symbol_type__is_a(char symbol_type, enum map_type map_type);
 244
 245 size_t machine__fprintf_vmlinux_path(struct machine *machine, FILE *fp);
 246
 247 #endif /* __PERF_SYMBOL */