1 /* SPDX-License-Identifier: GPL-2.0 */ 2 #ifndef __PERF_SYMBOL 3 #define __PERF_SYMBOL 1 4 5 #include <linux/types.h> 6 #include <linux/refcount.h> 7 #include <stdbool.h> 8 #include <stdint.h> 9 #include <linux/list.h> 10 #include <linux/rbtree.h> 11 #include <stdio.h> 12 #include "map_symbol.h" 13 #include "branch.h" 14 #include "path.h" 15 #include "symbol_conf.h" 16 17 #ifdef HAVE_LIBELF_SUPPORT 18 #include <libelf.h> 19 #include <gelf.h> 20 #endif 21 #include <elf.h> 22 23 struct dso; 24 struct map; 25 struct map_groups; 26 struct option; 27 28 /* 29 * libelf 0.8.x and earlier do not support ELF_C_READ_MMAP; 30 * for newer versions we can use mmap to reduce memory usage: 31 */ 32 #ifdef HAVE_LIBELF_MMAP_SUPPORT 33 # define PERF_ELF_C_READ_MMAP ELF_C_READ_MMAP 34 #else 35 # define PERF_ELF_C_READ_MMAP ELF_C_READ 36 #endif 37 38 #ifdef HAVE_LIBELF_SUPPORT 39 Elf_Scn *elf_section_by_name(Elf *elf, GElf_Ehdr *ep, 40 GElf_Shdr *shp, const char *name, size_t *idx); 41 #endif 42 43 /** struct symbol - symtab entry 44 * 45 * @ignore - resolvable but tools ignore it (e.g. idle routines) 46 */ 47 struct symbol { 48 struct rb_node rb_node; 49 u64 start; 50 u64 end; 51 u16 namelen; 52 u8 type:4; 53 u8 binding:4; 54 u8 idle:1; 55 u8 ignore:1; 56 u8 inlined:1; 57 u8 arch_sym; 58 bool annotate2; 59 char name[0]; 60 }; 61 62 void symbol__delete(struct symbol *sym); 63 void symbols__delete(struct rb_root_cached *symbols); 64 65 /* symbols__for_each_entry - iterate over symbols (rb_root) 66 * 67 * @symbols: the rb_root of symbols 68 * @pos: the 'struct symbol *' to use as a loop cursor 69 * @nd: the 'struct rb_node *' to use as a temporary storage 70 */ 71 #define symbols__for_each_entry(symbols, pos, nd) \ 72 for (nd = rb_first_cached(symbols); \ 73 nd && (pos = rb_entry(nd, struct symbol, rb_node)); \ 74 nd = rb_next(nd)) 75 76 static inline size_t symbol__size(const struct symbol *sym) 77 { 78 return sym->end - sym->start; 79 } 80 81 struct strlist; 82 struct intlist; 83 84 struct symbol_name_rb_node { 85 struct rb_node rb_node; 86 struct symbol sym; 87 }; 88 89 static inline int __symbol__join_symfs(char *bf, size_t size, const char *path) 90 { 91 return path__join(bf, size, symbol_conf.symfs, path); 92 } 93 94 #define symbol__join_symfs(bf, path) __symbol__join_symfs(bf, sizeof(bf), path) 95 96 extern int vmlinux_path__nr_entries; 97 extern char **vmlinux_path; 98 99 static inline void *symbol__priv(struct symbol *sym) 100 { 101 return ((void *)sym) - symbol_conf.priv_size; 102 } 103 104 struct ref_reloc_sym { 105 const char *name; 106 u64 addr; 107 u64 unrelocated_addr; 108 }; 109 110 struct branch_info { 111 struct addr_map_symbol from; 112 struct addr_map_symbol to; 113 struct branch_flags flags; 114 char *srcline_from; 115 char *srcline_to; 116 }; 117 118 struct mem_info { 119 struct addr_map_symbol iaddr; 120 struct addr_map_symbol daddr; 121 union perf_mem_data_src data_src; 122 refcount_t refcnt; 123 }; 124 125 struct block_info { 126 struct symbol *sym; 127 u64 start; 128 u64 end; 129 u64 cycles; 130 u64 cycles_aggr; 131 int num; 132 int num_aggr; 133 refcount_t refcnt; 134 }; 135 136 struct addr_location { 137 struct machine *machine; 138 struct thread *thread; 139 struct map *map; 140 struct symbol *sym; 141 const char *srcline; 142 u64 addr; 143 char level; 144 u8 filtered; 145 u8 cpumode; 146 s32 cpu; 147 s32 socket; 148 }; 149 150 int dso__load(struct dso *dso, struct map *map); 151 int dso__load_vmlinux(struct dso *dso, struct map *map, 152 const char *vmlinux, bool vmlinux_allocated); 153 int dso__load_vmlinux_path(struct dso *dso, struct map *map); 154 int __dso__load_kallsyms(struct dso *dso, const char *filename, struct map *map, 155 bool no_kcore); 156 int dso__load_kallsyms(struct dso *dso, const char *filename, struct map *map); 157 158 void dso__insert_symbol(struct dso *dso, 159 struct symbol *sym); 160 161 struct symbol *dso__find_symbol(struct dso *dso, u64 addr); 162 struct symbol *dso__find_symbol_by_name(struct dso *dso, const char *name); 163 164 struct symbol *symbol__next_by_name(struct symbol *sym); 165 166 struct symbol *dso__first_symbol(struct dso *dso); 167 struct symbol *dso__last_symbol(struct dso *dso); 168 struct symbol *dso__next_symbol(struct symbol *sym); 169 170 enum dso_type dso__type_fd(int fd); 171 172 int filename__read_build_id(const char *filename, void *bf, size_t size); 173 int sysfs__read_build_id(const char *filename, void *bf, size_t size); 174 int modules__parse(const char *filename, void *arg, 175 int (*process_module)(void *arg, const char *name, 176 u64 start, u64 size)); 177 int filename__read_debuglink(const char *filename, char *debuglink, 178 size_t size); 179 180 struct perf_env; 181 int symbol__init(struct perf_env *env); 182 void symbol__exit(void); 183 void symbol__elf_init(void); 184 int symbol__annotation_init(void); 185 186 struct symbol *symbol__new(u64 start, u64 len, u8 binding, u8 type, const char *name); 187 size_t __symbol__fprintf_symname_offs(const struct symbol *sym, 188 const struct addr_location *al, 189 bool unknown_as_addr, 190 bool print_offsets, FILE *fp); 191 size_t symbol__fprintf_symname_offs(const struct symbol *sym, 192 const struct addr_location *al, FILE *fp); 193 size_t __symbol__fprintf_symname(const struct symbol *sym, 194 const struct addr_location *al, 195 bool unknown_as_addr, FILE *fp); 196 size_t symbol__fprintf_symname(const struct symbol *sym, FILE *fp); 197 size_t symbol__fprintf(struct symbol *sym, FILE *fp); 198 bool symbol__restricted_filename(const char *filename, 199 const char *restricted_filename); 200 int symbol__config_symfs(const struct option *opt __maybe_unused, 201 const char *dir, int unset __maybe_unused); 202 203 struct symsrc; 204 205 int dso__load_sym(struct dso *dso, struct map *map, struct symsrc *syms_ss, 206 struct symsrc *runtime_ss, int kmodule); 207 int dso__synthesize_plt_symbols(struct dso *dso, struct symsrc *ss); 208 209 char *dso__demangle_sym(struct dso *dso, int kmodule, const char *elf_name); 210 211 void __symbols__insert(struct rb_root_cached *symbols, struct symbol *sym, 212 bool kernel); 213 void symbols__insert(struct rb_root_cached *symbols, struct symbol *sym); 214 void symbols__fixup_duplicate(struct rb_root_cached *symbols); 215 void symbols__fixup_end(struct rb_root_cached *symbols); 216 void map_groups__fixup_end(struct map_groups *mg); 217 218 typedef int (*mapfn_t)(u64 start, u64 len, u64 pgoff, void *data); 219 int file__read_maps(int fd, bool exe, mapfn_t mapfn, void *data, 220 bool *is_64_bit); 221 222 #define PERF_KCORE_EXTRACT "/tmp/perf-kcore-XXXXXX" 223 224 struct kcore_extract { 225 char *kcore_filename; 226 u64 addr; 227 u64 offs; 228 u64 len; 229 char extract_filename[sizeof(PERF_KCORE_EXTRACT)]; 230 int fd; 231 }; 232 233 int kcore_extract__create(struct kcore_extract *kce); 234 void kcore_extract__delete(struct kcore_extract *kce); 235 236 int kcore_copy(const char *from_dir, const char *to_dir); 237 int compare_proc_modules(const char *from, const char *to); 238 239 int setup_list(struct strlist **list, const char *list_str, 240 const char *list_name); 241 int setup_intlist(struct intlist **list, const char *list_str, 242 const char *list_name); 243 244 #ifdef HAVE_LIBELF_SUPPORT 245 bool elf__needs_adjust_symbols(GElf_Ehdr ehdr); 246 void arch__sym_update(struct symbol *s, GElf_Sym *sym); 247 #endif 248 249 const char *arch__normalize_symbol_name(const char *name); 250 #define SYMBOL_A 0 251 #define SYMBOL_B 1 252 253 void arch__symbols__fixup_end(struct symbol *p, struct symbol *c); 254 int arch__compare_symbol_names(const char *namea, const char *nameb); 255 int arch__compare_symbol_names_n(const char *namea, const char *nameb, 256 unsigned int n); 257 int arch__choose_best_symbol(struct symbol *syma, struct symbol *symb); 258 259 enum symbol_tag_include { 260 SYMBOL_TAG_INCLUDE__NONE = 0, 261 SYMBOL_TAG_INCLUDE__DEFAULT_ONLY 262 }; 263 264 int symbol__match_symbol_name(const char *namea, const char *nameb, 265 enum symbol_tag_include includes); 266 267 /* structure containing an SDT note's info */ 268 struct sdt_note { 269 char *name; /* name of the note*/ 270 char *provider; /* provider name */ 271 char *args; 272 bool bit32; /* whether the location is 32 bits? */ 273 union { /* location, base and semaphore addrs */ 274 Elf64_Addr a64[3]; 275 Elf32_Addr a32[3]; 276 } addr; 277 struct list_head note_list; /* SDT notes' list */ 278 }; 279 280 int get_sdt_note_list(struct list_head *head, const char *target); 281 int cleanup_sdt_note_list(struct list_head *sdt_notes); 282 int sdt_notes__get_count(struct list_head *start); 283 284 #define SDT_PROBES_SCN ".probes" 285 #define SDT_BASE_SCN ".stapsdt.base" 286 #define SDT_NOTE_SCN ".note.stapsdt" 287 #define SDT_NOTE_TYPE 3 288 #define SDT_NOTE_NAME "stapsdt" 289 #define NR_ADDR 3 290 291 enum { 292 SDT_NOTE_IDX_LOC = 0, 293 SDT_NOTE_IDX_BASE, 294 SDT_NOTE_IDX_REFCTR, 295 }; 296 297 struct mem_info *mem_info__new(void); 298 struct mem_info *mem_info__get(struct mem_info *mi); 299 void mem_info__put(struct mem_info *mi); 300 301 static inline void __mem_info__zput(struct mem_info **mi) 302 { 303 mem_info__put(*mi); 304 *mi = NULL; 305 } 306 307 #define mem_info__zput(mi) __mem_info__zput(&mi) 308 309 struct block_info *block_info__new(void); 310 struct block_info *block_info__get(struct block_info *bi); 311 void block_info__put(struct block_info *bi); 312 313 static inline void __block_info__zput(struct block_info **bi) 314 { 315 block_info__put(*bi); 316 *bi = NULL; 317 } 318 319 #define block_info__zput(bi) __block_info__zput(&bi) 320 321 #endif /* __PERF_SYMBOL */ 322