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