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 {
  52         struct rb_node  rb_node;
  53         u64             start;
  54         u64             end;
  55         u16             namelen;
  56         u8              binding;
  57         char            name[0];
  58 };
  59
  60 void symbol__delete(struct symbol *self);
  61
  62 struct strlist;
  63
  64 struct symbol_conf {
  65         unsigned short  priv_size;
  66         bool            try_vmlinux_path,
  67                         use_modules,
  68                         sort_by_name,
  69                         show_nr_samples,
  70                         use_callchain,
  71                         exclude_other,
  72                         show_cpu_utilization,
  73                         initialized;
  74         const char      *vmlinux_name,
  75                         *kallsyms_name,
  76                         *source_prefix,
  77                         *field_sep;
  78         const char      *default_guest_vmlinux_name,
  79                         *default_guest_kallsyms,
  80                         *default_guest_modules;
  81         const char      *guestmount;
  82         const char      *dso_list_str,
  83                         *comm_list_str,
  84                         *sym_list_str,
  85                         *col_width_list_str;
  86        struct strlist   *dso_list,
  87                         *comm_list,
  88                         *sym_list;
  89         const char      *symfs;
  90 };
  91
  92 extern struct symbol_conf symbol_conf;
  93
  94 static inline void *symbol__priv(struct symbol *self)
  95 {
  96         return ((void *)self) - symbol_conf.priv_size;
  97 }
  98
  99 struct ref_reloc_sym {
 100         const char      *name;
 101         u64             addr;
 102         u64             unrelocated_addr;
 103 };
 104
 105 struct map_symbol {
 106         struct map    *map;
 107         struct symbol *sym;
 108         bool          unfolded;
 109         bool          has_children;
 110 };
 111
 112 struct addr_location {
 113         struct thread *thread;
 114         struct map    *map;
 115         struct symbol *sym;
 116         u64           addr;
 117         char          level;
 118         bool          filtered;
 119         u8            cpumode;
 120         s32           cpu;
 121 };
 122
 123 enum dso_kernel_type {
 124         DSO_TYPE_USER = 0,
 125         DSO_TYPE_KERNEL,
 126         DSO_TYPE_GUEST_KERNEL
 127 };
 128
 129 struct dso {
 130         struct list_head node;
 131         struct rb_root   symbols[MAP__NR_TYPES];
 132         struct rb_root   symbol_names[MAP__NR_TYPES];
 133         enum dso_kernel_type    kernel;
 134         u8               adjust_symbols:1;
 135         u8               has_build_id:1;
 136         u8               hit:1;
 137         u8               annotate_warned:1;
 138         u8               sname_alloc:1;
 139         u8               lname_alloc:1;
 140         unsigned char    origin;
 141         u8               sorted_by_name;
 142         u8               loaded;
 143         u8               build_id[BUILD_ID_SIZE];
 144         const char       *short_name;
 145         char             *long_name;
 146         u16              long_name_len;
 147         u16              short_name_len;
 148         char             name[0];
 149 };
 150
 151 struct dso *dso__new(const char *name);
 152 struct dso *dso__new_kernel(const char *name);
 153 void dso__delete(struct dso *self);
 154
 155 int dso__name_len(const struct dso *self);
 156
 157 bool dso__loaded(const struct dso *self, enum map_type type);
 158 bool dso__sorted_by_name(const struct dso *self, enum map_type type);
 159
 160 static inline void dso__set_loaded(struct dso *self, enum map_type type)
 161 {
 162         self->loaded |= (1 << type);
 163 }
 164
 165 void dso__sort_by_name(struct dso *self, enum map_type type);
 166
 167 struct dso *__dsos__findnew(struct list_head *head, const char *name);
 168
 169 int dso__load(struct dso *self, struct map *map, symbol_filter_t filter);
 170 int dso__load_vmlinux(struct dso *self, struct map *map,
 171                       const char *vmlinux, symbol_filter_t filter);
 172 int dso__load_vmlinux_path(struct dso *self, struct map *map,
 173                            symbol_filter_t filter);
 174 int dso__load_kallsyms(struct dso *self, const char *filename, struct map *map,
 175                        symbol_filter_t filter);
 176 int machine__load_kallsyms(struct machine *self, const char *filename,
 177                            enum map_type type, symbol_filter_t filter);
 178 int machine__load_vmlinux_path(struct machine *self, enum map_type type,
 179                                symbol_filter_t filter);
 180
 181 size_t __dsos__fprintf(struct list_head *head, FILE *fp);
 182
 183 size_t machine__fprintf_dsos_buildid(struct machine *self, FILE *fp, bool with_hits);
 184 size_t machines__fprintf_dsos(struct rb_root *self, FILE *fp);
 185 size_t machines__fprintf_dsos_buildid(struct rb_root *self, FILE *fp, bool with_hits);
 186
 187 size_t dso__fprintf_buildid(struct dso *self, FILE *fp);
 188 size_t dso__fprintf_symbols_by_name(struct dso *self, enum map_type type, FILE *fp);
 189 size_t dso__fprintf(struct dso *self, enum map_type type, FILE *fp);
 190
 191 enum dso_origin {
 192         DSO__ORIG_KERNEL = 0,
 193         DSO__ORIG_GUEST_KERNEL,
 194         DSO__ORIG_JAVA_JIT,
 195         DSO__ORIG_BUILD_ID_CACHE,
 196         DSO__ORIG_FEDORA,
 197         DSO__ORIG_UBUNTU,
 198         DSO__ORIG_BUILDID,
 199         DSO__ORIG_DSO,
 200         DSO__ORIG_GUEST_KMODULE,
 201         DSO__ORIG_KMODULE,
 202         DSO__ORIG_NOT_FOUND,
 203 };
 204
 205 char dso__symtab_origin(const struct dso *self);
 206 void dso__set_long_name(struct dso *self, char *name);
 207 void dso__set_build_id(struct dso *self, void *build_id);
 208 void dso__read_running_kernel_build_id(struct dso *self, struct machine *machine);
 209 struct symbol *dso__find_symbol(struct dso *self, enum map_type type, u64 addr);
 210 struct symbol *dso__find_symbol_by_name(struct dso *self, enum map_type type,
 211                                         const char *name);
 212
 213 int filename__read_build_id(const char *filename, void *bf, size_t size);
 214 int sysfs__read_build_id(const char *filename, void *bf, size_t size);
 215 bool __dsos__read_build_ids(struct list_head *head, bool with_hits);
 216 int build_id__sprintf(const u8 *self, int len, char *bf);
 217 int kallsyms__parse(const char *filename, void *arg,
 218                     int (*process_symbol)(void *arg, const char *name,
 219                                           char type, u64 start, u64 end));
 220
 221 void machine__destroy_kernel_maps(struct machine *self);
 222 int __machine__create_kernel_maps(struct machine *self, struct dso *kernel);
 223 int machine__create_kernel_maps(struct machine *self);
 224
 225 int machines__create_kernel_maps(struct rb_root *self, pid_t pid);
 226 int machines__create_guest_kernel_maps(struct rb_root *self);
 227 void machines__destroy_guest_kernel_maps(struct rb_root *self);
 228
 229 int symbol__init(void);
 230 void symbol__exit(void);
 231 bool symbol_type__is_a(char symbol_type, enum map_type map_type);
 232
 233 size_t machine__fprintf_vmlinux_path(struct machine *self, FILE *fp);
 234
 235 #endif /* __PERF_SYMBOL */