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