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 #include <byteswap.h>
  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 - symtab entry
  54  *
  55  * @ignore - resolvable but tools ignore it (e.g. idle routines)
  56  */
  57 struct symbol {
  58         struct rb_node  rb_node;
  59         u64             start;
  60         u64             end;
  61         u16             namelen;
  62         u8              binding;
  63         bool            ignore;
  64         char            name[0];
  65 };
  66
  67 void symbol__delete(struct symbol *sym);
  68
  69 static inline size_t symbol__size(const struct symbol *sym)
  70 {
  71         return sym->end - sym->start + 1;
  72 }
  73
  74 struct strlist;
  75
  76 struct symbol_conf {
  77         unsigned short  priv_size;
  78         unsigned short  nr_events;
  79         bool            try_vmlinux_path,
  80                         show_kernel_path,
  81                         use_modules,
  82                         sort_by_name,
  83                         show_nr_samples,
  84                         show_total_period,
  85                         use_callchain,
  86                         exclude_other,
  87                         show_cpu_utilization,
  88                         initialized,
  89                         kptr_restrict,
  90                         annotate_asm_raw,
  91                         annotate_src;
  92         const char      *vmlinux_name,
  93                         *kallsyms_name,
  94                         *source_prefix,
  95                         *field_sep;
  96         const char      *default_guest_vmlinux_name,
  97                         *default_guest_kallsyms,
  98                         *default_guest_modules;
  99         const char      *guestmount;
 100         const char      *dso_list_str,
 101                         *comm_list_str,
 102                         *sym_list_str,
 103                         *col_width_list_str;
 104        struct strlist   *dso_list,
 105                         *comm_list,
 106                         *sym_list,
 107                         *dso_from_list,
 108                         *dso_to_list,
 109                         *sym_from_list,
 110                         *sym_to_list;
 111         const char      *symfs;
 112 };
 113
 114 extern struct symbol_conf symbol_conf;
 115
 116 static inline void *symbol__priv(struct symbol *sym)
 117 {
 118         return ((void *)sym) - symbol_conf.priv_size;
 119 }
 120
 121 struct ref_reloc_sym {
 122         const char      *name;
 123         u64             addr;
 124         u64             unrelocated_addr;
 125 };
 126
 127 struct map_symbol {
 128         struct map    *map;
 129         struct symbol *sym;
 130         bool          unfolded;
 131         bool          has_children;
 132 };
 133
 134 struct addr_map_symbol {
 135         struct map    *map;
 136         struct symbol *sym;
 137         u64           addr;
 138         u64           al_addr;
 139 };
 140
 141 struct branch_info {
 142         struct addr_map_symbol from;
 143         struct addr_map_symbol to;
 144         struct branch_flags flags;
 145 };
 146
 147 struct addr_location {
 148         struct thread *thread;
 149         struct map    *map;
 150         struct symbol *sym;
 151         u64           addr;
 152         char          level;
 153         bool          filtered;
 154         u8            cpumode;
 155         s32           cpu;
 156 };
 157
 158 enum dso_binary_type {
 159         DSO_BINARY_TYPE__KALLSYMS = 0,
 160         DSO_BINARY_TYPE__GUEST_KALLSYMS,
 161         DSO_BINARY_TYPE__JAVA_JIT,
 162         DSO_BINARY_TYPE__DEBUGLINK,
 163         DSO_BINARY_TYPE__BUILD_ID_CACHE,
 164         DSO_BINARY_TYPE__FEDORA_DEBUGINFO,
 165         DSO_BINARY_TYPE__UBUNTU_DEBUGINFO,
 166         DSO_BINARY_TYPE__BUILDID_DEBUGINFO,
 167         DSO_BINARY_TYPE__SYSTEM_PATH_DSO,
 168         DSO_BINARY_TYPE__GUEST_KMODULE,
 169         DSO_BINARY_TYPE__SYSTEM_PATH_KMODULE,
 170         DSO_BINARY_TYPE__NOT_FOUND,
 171 };
 172
 173 enum dso_kernel_type {
 174         DSO_TYPE_USER = 0,
 175         DSO_TYPE_KERNEL,
 176         DSO_TYPE_GUEST_KERNEL
 177 };
 178
 179 enum dso_swap_type {
 180         DSO_SWAP__UNSET,
 181         DSO_SWAP__NO,
 182         DSO_SWAP__YES,
 183 };
 184
 185 #define DSO__DATA_CACHE_SIZE 4096
 186 #define DSO__DATA_CACHE_MASK ~(DSO__DATA_CACHE_SIZE - 1)
 187
 188 struct dso_cache {
 189         struct rb_node  rb_node;
 190         u64 offset;
 191         u64 size;
 192         char data[0];
 193 };
 194
 195 struct dso {
 196         struct list_head node;
 197         struct rb_root   symbols[MAP__NR_TYPES];
 198         struct rb_root   symbol_names[MAP__NR_TYPES];
 199         struct rb_root   cache;
 200         enum dso_kernel_type    kernel;
 201         enum dso_swap_type      needs_swap;
 202         enum dso_binary_type    symtab_type;
 203         enum dso_binary_type    data_type;
 204         u8               adjust_symbols:1;
 205         u8               has_build_id:1;
 206         u8               hit:1;
 207         u8               annotate_warned:1;
 208         u8               sname_alloc:1;
 209         u8               lname_alloc:1;
 210         u8               sorted_by_name;
 211         u8               loaded;
 212         u8               build_id[BUILD_ID_SIZE];
 213         const char       *short_name;
 214         char             *long_name;
 215         u16              long_name_len;
 216         u16              short_name_len;
 217         char             name[0];
 218 };
 219
 220 #define DSO__SWAP(dso, type, val)                       \
 221 ({                                                      \
 222         type ____r = val;                               \
 223         BUG_ON(dso->needs_swap == DSO_SWAP__UNSET);     \
 224         if (dso->needs_swap == DSO_SWAP__YES) {         \
 225                 switch (sizeof(____r)) {                \
 226                 case 2:                                 \
 227                         ____r = bswap_16(val);          \
 228                         break;                          \
 229                 case 4:                                 \
 230                         ____r = bswap_32(val);          \
 231                         break;                          \
 232                 case 8:                                 \
 233                         ____r = bswap_64(val);          \
 234                         break;                          \
 235                 default:                                \
 236                         BUG_ON(1);                      \
 237                 }                                       \
 238         }                                               \
 239         ____r;                                          \
 240 })
 241
 242 struct dso *dso__new(const char *name);
 243 void dso__delete(struct dso *dso);
 244
 245 int dso__name_len(const struct dso *dso);
 246
 247 bool dso__loaded(const struct dso *dso, enum map_type type);
 248 bool dso__sorted_by_name(const struct dso *dso, enum map_type type);
 249
 250 static inline void dso__set_loaded(struct dso *dso, enum map_type type)
 251 {
 252         dso->loaded |= (1 << type);
 253 }
 254
 255 void dso__sort_by_name(struct dso *dso, enum map_type type);
 256
 257 struct dso *__dsos__findnew(struct list_head *head, const char *name);
 258
 259 int dso__load(struct dso *dso, struct map *map, symbol_filter_t filter);
 260 int dso__load_vmlinux(struct dso *dso, struct map *map,
 261                       const char *vmlinux, symbol_filter_t filter);
 262 int dso__load_vmlinux_path(struct dso *dso, struct map *map,
 263                            symbol_filter_t filter);
 264 int dso__load_kallsyms(struct dso *dso, const char *filename, struct map *map,
 265                        symbol_filter_t filter);
 266 int machine__load_kallsyms(struct machine *machine, const char *filename,
 267                            enum map_type type, symbol_filter_t filter);
 268 int machine__load_vmlinux_path(struct machine *machine, enum map_type type,
 269                                symbol_filter_t filter);
 270
 271 size_t __dsos__fprintf(struct list_head *head, FILE *fp);
 272
 273 size_t machine__fprintf_dsos_buildid(struct machine *machine,
 274                                      FILE *fp, bool with_hits);
 275 size_t machines__fprintf_dsos(struct rb_root *machines, FILE *fp);
 276 size_t machines__fprintf_dsos_buildid(struct rb_root *machines,
 277                                       FILE *fp, bool with_hits);
 278 size_t dso__fprintf_buildid(struct dso *dso, FILE *fp);
 279 size_t dso__fprintf_symbols_by_name(struct dso *dso,
 280                                     enum map_type type, FILE *fp);
 281 size_t dso__fprintf(struct dso *dso, enum map_type type, FILE *fp);
 282
 283 char dso__symtab_origin(const struct dso *dso);
 284 void dso__set_long_name(struct dso *dso, char *name);
 285 void dso__set_build_id(struct dso *dso, void *build_id);
 286 void dso__read_running_kernel_build_id(struct dso *dso,
 287                                        struct machine *machine);
 288 struct map *dso__new_map(const char *name);
 289 struct symbol *dso__find_symbol(struct dso *dso, enum map_type type,
 290                                 u64 addr);
 291 struct symbol *dso__find_symbol_by_name(struct dso *dso, enum map_type type,
 292                                         const char *name);
 293
 294 int filename__read_build_id(const char *filename, void *bf, size_t size);
 295 int sysfs__read_build_id(const char *filename, void *bf, size_t size);
 296 bool __dsos__read_build_ids(struct list_head *head, bool with_hits);
 297 int build_id__sprintf(const u8 *build_id, int len, char *bf);
 298 int kallsyms__parse(const char *filename, void *arg,
 299                     int (*process_symbol)(void *arg, const char *name,
 300                                           char type, u64 start, u64 end));
 301
 302 void machine__destroy_kernel_maps(struct machine *machine);
 303 int __machine__create_kernel_maps(struct machine *machine, struct dso *kernel);
 304 int machine__create_kernel_maps(struct machine *machine);
 305
 306 int machines__create_kernel_maps(struct rb_root *machines, pid_t pid);
 307 int machines__create_guest_kernel_maps(struct rb_root *machines);
 308 void machines__destroy_guest_kernel_maps(struct rb_root *machines);
 309
 310 int symbol__init(void);
 311 void symbol__exit(void);
 312 size_t symbol__fprintf_symname_offs(const struct symbol *sym,
 313                                     const struct addr_location *al, FILE *fp);
 314 size_t symbol__fprintf_symname(const struct symbol *sym, FILE *fp);
 315 bool symbol_type__is_a(char symbol_type, enum map_type map_type);
 316
 317 size_t machine__fprintf_vmlinux_path(struct machine *machine, FILE *fp);
 318
 319 int dso__binary_type_file(struct dso *dso, enum dso_binary_type type,
 320                           char *root_dir, char *file, size_t size);
 321
 322 int dso__data_fd(struct dso *dso, struct machine *machine);
 323 ssize_t dso__data_read_offset(struct dso *dso, struct machine *machine,
 324                               u64 offset, u8 *data, ssize_t size);
 325 ssize_t dso__data_read_addr(struct dso *dso, struct map *map,
 326                             struct machine *machine, u64 addr,
 327                             u8 *data, ssize_t size);
 328 int dso__test_data(void);
 329 #endif /* __PERF_SYMBOL */