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