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 #include <libgen.h>
  14 #include "build-id.h"
  15 #include "event.h"
  16 #include "util.h"
  17
  18 #ifdef HAVE_LIBELF_SUPPORT
  19 #include <libelf.h>
  20 #include <gelf.h>
  21 #endif
  22 #include <elf.h>
  23
  24 #include "dso.h"
  25
  26 /*
  27  * libelf 0.8.x and earlier do not support ELF_C_READ_MMAP;
  28  * for newer versions we can use mmap to reduce memory usage:
  29  */
  30 #ifdef HAVE_LIBELF_MMAP_SUPPORT
  31 # define PERF_ELF_C_READ_MMAP ELF_C_READ_MMAP
  32 #else
  33 # define PERF_ELF_C_READ_MMAP ELF_C_READ
  34 #endif
  35
  36 #ifdef HAVE_LIBELF_SUPPORT
  37 extern Elf_Scn *elf_section_by_name(Elf *elf, GElf_Ehdr *ep,
  38                                 GElf_Shdr *shp, const char *name, size_t *idx);
  39 #endif
  40
  41 #ifndef DMGL_PARAMS
  42 #define DMGL_NO_OPTS     0              /* For readability... */
  43 #define DMGL_PARAMS      (1 << 0)       /* Include function args */
  44 #define DMGL_ANSI        (1 << 1)       /* Include const, volatile, etc */
  45 #endif
  46
  47 /** struct symbol - symtab entry
  48  *
  49  * @ignore - resolvable but tools ignore it (e.g. idle routines)
  50  */
  51 struct symbol {
  52         struct rb_node  rb_node;
  53         u64             start;
  54         u64             end;
  55         u16             namelen;
  56         u8              binding;
  57         bool            ignore;
  58         char            name[0];
  59 };
  60
  61 void symbol__delete(struct symbol *sym);
  62 void symbols__delete(struct rb_root *symbols);
  63
  64 /* symbols__for_each_entry - iterate over symbols (rb_root)
  65  *
  66  * @symbols: the rb_root of symbols
  67  * @pos: the 'struct symbol *' to use as a loop cursor
  68  * @nd: the 'struct rb_node *' to use as a temporary storage
  69  */
  70 #define symbols__for_each_entry(symbols, pos, nd)                       \
  71         for (nd = rb_first(symbols);                                    \
  72              nd && (pos = rb_entry(nd, struct symbol, rb_node));        \
  73              nd = rb_next(nd))
  74
  75 static inline size_t symbol__size(const struct symbol *sym)
  76 {
  77         return sym->end - sym->start;
  78 }
  79
  80 struct strlist;
  81
  82 struct symbol_conf {
  83         unsigned short  priv_size;
  84         unsigned short  nr_events;
  85         bool            try_vmlinux_path,
  86                         ignore_vmlinux,
  87                         ignore_vmlinux_buildid,
  88                         show_kernel_path,
  89                         use_modules,
  90                         allow_aliases,
  91                         sort_by_name,
  92                         show_nr_samples,
  93                         show_total_period,
  94                         use_callchain,
  95                         cumulate_callchain,
  96                         exclude_other,
  97                         show_cpu_utilization,
  98                         initialized,
  99                         kptr_restrict,
 100                         annotate_asm_raw,
 101                         annotate_src,
 102                         event_group,
 103                         demangle,
 104                         demangle_kernel,
 105                         filter_relative,
 106                         show_hist_headers,
 107                         branch_callstack;
 108         const char      *vmlinux_name,
 109                         *kallsyms_name,
 110                         *source_prefix,
 111                         *field_sep;
 112         const char      *default_guest_vmlinux_name,
 113                         *default_guest_kallsyms,
 114                         *default_guest_modules;
 115         const char      *guestmount;
 116         const char      *dso_list_str,
 117                         *comm_list_str,
 118                         *sym_list_str,
 119                         *col_width_list_str;
 120        struct strlist   *dso_list,
 121                         *comm_list,
 122                         *sym_list,
 123                         *dso_from_list,
 124                         *dso_to_list,
 125                         *sym_from_list,
 126                         *sym_to_list;
 127         const char      *symfs;
 128 };
 129
 130 extern struct symbol_conf symbol_conf;
 131
 132 static inline int __symbol__join_symfs(char *bf, size_t size, const char *path)
 133 {
 134         return path__join(bf, size, symbol_conf.symfs, path);
 135 }
 136
 137 #define symbol__join_symfs(bf, path) __symbol__join_symfs(bf, sizeof(bf), path)
 138
 139 extern int vmlinux_path__nr_entries;
 140 extern char **vmlinux_path;
 141
 142 static inline void *symbol__priv(struct symbol *sym)
 143 {
 144         return ((void *)sym) - symbol_conf.priv_size;
 145 }
 146
 147 struct ref_reloc_sym {
 148         const char      *name;
 149         u64             addr;
 150         u64             unrelocated_addr;
 151 };
 152
 153 struct map_symbol {
 154         struct map    *map;
 155         struct symbol *sym;
 156         bool          unfolded;
 157         bool          has_children;
 158 };
 159
 160 struct addr_map_symbol {
 161         struct map    *map;
 162         struct symbol *sym;
 163         u64           addr;
 164         u64           al_addr;
 165 };
 166
 167 struct branch_info {
 168         struct addr_map_symbol from;
 169         struct addr_map_symbol to;
 170         struct branch_flags flags;
 171 };
 172
 173 struct mem_info {
 174         struct addr_map_symbol iaddr;
 175         struct addr_map_symbol daddr;
 176         union perf_mem_data_src data_src;
 177 };
 178
 179 struct addr_location {
 180         struct machine *machine;
 181         struct thread *thread;
 182         struct map    *map;
 183         struct symbol *sym;
 184         u64           addr;
 185         char          level;
 186         u8            filtered;
 187         u8            cpumode;
 188         s32           cpu;
 189 };
 190
 191 struct symsrc {
 192         char *name;
 193         int fd;
 194         enum dso_binary_type type;
 195
 196 #ifdef HAVE_LIBELF_SUPPORT
 197         Elf *elf;
 198         GElf_Ehdr ehdr;
 199
 200         Elf_Scn *opdsec;
 201         size_t opdidx;
 202         GElf_Shdr opdshdr;
 203
 204         Elf_Scn *symtab;
 205         GElf_Shdr symshdr;
 206
 207         Elf_Scn *dynsym;
 208         size_t dynsym_idx;
 209         GElf_Shdr dynshdr;
 210
 211         bool adjust_symbols;
 212         bool is_64_bit;
 213 #endif
 214 };
 215
 216 void symsrc__destroy(struct symsrc *ss);
 217 int symsrc__init(struct symsrc *ss, struct dso *dso, const char *name,
 218                  enum dso_binary_type type);
 219 bool symsrc__has_symtab(struct symsrc *ss);
 220 bool symsrc__possibly_runtime(struct symsrc *ss);
 221
 222 int dso__load(struct dso *dso, struct map *map, symbol_filter_t filter);
 223 int dso__load_vmlinux(struct dso *dso, struct map *map,
 224                       const char *vmlinux, bool vmlinux_allocated,
 225                       symbol_filter_t filter);
 226 int dso__load_vmlinux_path(struct dso *dso, struct map *map,
 227                            symbol_filter_t filter);
 228 int dso__load_kallsyms(struct dso *dso, const char *filename, struct map *map,
 229                        symbol_filter_t filter);
 230
 231 struct symbol *dso__find_symbol(struct dso *dso, enum map_type type,
 232                                 u64 addr);
 233 struct symbol *dso__find_symbol_by_name(struct dso *dso, enum map_type type,
 234                                         const char *name);
 235 struct symbol *symbol__next_by_name(struct symbol *sym);
 236
 237 struct symbol *dso__first_symbol(struct dso *dso, enum map_type type);
 238 struct symbol *dso__next_symbol(struct symbol *sym);
 239
 240 enum dso_type dso__type_fd(int fd);
 241
 242 int filename__read_build_id(const char *filename, void *bf, size_t size);
 243 int sysfs__read_build_id(const char *filename, void *bf, size_t size);
 244 int modules__parse(const char *filename, void *arg,
 245                    int (*process_module)(void *arg, const char *name,
 246                                          u64 start));
 247 int filename__read_debuglink(const char *filename, char *debuglink,
 248                              size_t size);
 249
 250 struct perf_session_env;
 251 int symbol__init(struct perf_session_env *env);
 252 void symbol__exit(void);
 253 void symbol__elf_init(void);
 254 struct symbol *symbol__new(u64 start, u64 len, u8 binding, const char *name);
 255 size_t symbol__fprintf_symname_offs(const struct symbol *sym,
 256                                     const struct addr_location *al, FILE *fp);
 257 size_t symbol__fprintf_symname(const struct symbol *sym, FILE *fp);
 258 size_t symbol__fprintf(struct symbol *sym, FILE *fp);
 259 bool symbol_type__is_a(char symbol_type, enum map_type map_type);
 260 bool symbol__restricted_filename(const char *filename,
 261                                  const char *restricted_filename);
 262 bool symbol__is_idle(struct symbol *sym);
 263
 264 int dso__load_sym(struct dso *dso, struct map *map, struct symsrc *syms_ss,
 265                   struct symsrc *runtime_ss, symbol_filter_t filter,
 266                   int kmodule);
 267 int dso__synthesize_plt_symbols(struct dso *dso, struct symsrc *ss,
 268                                 struct map *map, symbol_filter_t filter);
 269
 270 void symbols__insert(struct rb_root *symbols, struct symbol *sym);
 271 void symbols__fixup_duplicate(struct rb_root *symbols);
 272 void symbols__fixup_end(struct rb_root *symbols);
 273 void __map_groups__fixup_end(struct map_groups *mg, enum map_type type);
 274
 275 typedef int (*mapfn_t)(u64 start, u64 len, u64 pgoff, void *data);
 276 int file__read_maps(int fd, bool exe, mapfn_t mapfn, void *data,
 277                     bool *is_64_bit);
 278
 279 #define PERF_KCORE_EXTRACT "/tmp/perf-kcore-XXXXXX"
 280
 281 struct kcore_extract {
 282         char *kcore_filename;
 283         u64 addr;
 284         u64 offs;
 285         u64 len;
 286         char extract_filename[sizeof(PERF_KCORE_EXTRACT)];
 287         int fd;
 288 };
 289
 290 int kcore_extract__create(struct kcore_extract *kce);
 291 void kcore_extract__delete(struct kcore_extract *kce);
 292
 293 int kcore_copy(const char *from_dir, const char *to_dir);
 294 int compare_proc_modules(const char *from, const char *to);
 295
 296 int setup_list(struct strlist **list, const char *list_str,
 297                const char *list_name);
 298
 299 #endif /* __PERF_SYMBOL */