1 /* SPDX-License-Identifier: GPL-2.0 */
3 #define __PERF_SYMBOL 1
5 #include <linux/types.h>
8 #include <linux/list.h>
9 #include <linux/rbtree.h>
11 #include "map_symbol.h"
14 #include "symbol_conf.h"
16 #ifdef HAVE_LIBELF_SUPPORT
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:
32 #ifdef HAVE_LIBELF_MMAP_SUPPORT
33 # define PERF_ELF_C_READ_MMAP ELF_C_READ_MMAP
35 # define PERF_ELF_C_READ_MMAP ELF_C_READ
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);
44 #define DMGL_NO_OPTS 0 /* For readability... */
45 #define DMGL_PARAMS (1 << 0) /* Include function args */
46 #define DMGL_ANSI (1 << 1) /* Include const, volatile, etc */
49 #define DSO__NAME_KALLSYMS "[kernel.kallsyms]"
50 #define DSO__NAME_KCORE "[kernel.kcore]"
52 /** struct symbol - symtab entry
54 * @ignore - resolvable but tools ignore it (e.g. idle routines)
57 struct rb_node rb_node;
71 void symbol__delete(struct symbol *sym);
72 void symbols__delete(struct rb_root_cached *symbols);
74 /* symbols__for_each_entry - iterate over symbols (rb_root)
76 * @symbols: the rb_root of symbols
77 * @pos: the 'struct symbol *' to use as a loop cursor
78 * @nd: the 'struct rb_node *' to use as a temporary storage
80 #define symbols__for_each_entry(symbols, pos, nd) \
81 for (nd = rb_first_cached(symbols); \
82 nd && (pos = rb_entry(nd, struct symbol, rb_node)); \
85 static inline size_t symbol__size(const struct symbol *sym)
87 return sym->end - sym->start;
93 struct symbol_name_rb_node {
94 struct rb_node rb_node;
98 static inline int __symbol__join_symfs(char *bf, size_t size, const char *path)
100 return path__join(bf, size, symbol_conf.symfs, path);
103 #define symbol__join_symfs(bf, path) __symbol__join_symfs(bf, sizeof(bf), path)
105 extern int vmlinux_path__nr_entries;
106 extern char **vmlinux_path;
108 static inline void *symbol__priv(struct symbol *sym)
110 return ((void *)sym) - symbol_conf.priv_size;
113 struct ref_reloc_sym {
116 u64 unrelocated_addr;
120 struct addr_map_symbol from;
121 struct addr_map_symbol to;
122 struct branch_flags flags;
128 struct addr_map_symbol iaddr;
129 struct addr_map_symbol daddr;
130 union perf_mem_data_src data_src;
145 struct addr_location {
146 struct machine *machine;
147 struct thread *thread;
162 enum dso_binary_type type;
164 #ifdef HAVE_LIBELF_SUPPORT
184 void symsrc__destroy(struct symsrc *ss);
185 int symsrc__init(struct symsrc *ss, struct dso *dso, const char *name,
186 enum dso_binary_type type);
187 bool symsrc__has_symtab(struct symsrc *ss);
188 bool symsrc__possibly_runtime(struct symsrc *ss);
190 int dso__load(struct dso *dso, struct map *map);
191 int dso__load_vmlinux(struct dso *dso, struct map *map,
192 const char *vmlinux, bool vmlinux_allocated);
193 int dso__load_vmlinux_path(struct dso *dso, struct map *map);
194 int __dso__load_kallsyms(struct dso *dso, const char *filename, struct map *map,
196 int dso__load_kallsyms(struct dso *dso, const char *filename, struct map *map);
198 void dso__insert_symbol(struct dso *dso,
201 struct symbol *dso__find_symbol(struct dso *dso, u64 addr);
202 struct symbol *dso__find_symbol_by_name(struct dso *dso, const char *name);
204 struct symbol *symbol__next_by_name(struct symbol *sym);
206 struct symbol *dso__first_symbol(struct dso *dso);
207 struct symbol *dso__last_symbol(struct dso *dso);
208 struct symbol *dso__next_symbol(struct symbol *sym);
210 enum dso_type dso__type_fd(int fd);
212 int filename__read_build_id(const char *filename, void *bf, size_t size);
213 int sysfs__read_build_id(const char *filename, void *bf, size_t size);
214 int modules__parse(const char *filename, void *arg,
215 int (*process_module)(void *arg, const char *name,
216 u64 start, u64 size));
217 int filename__read_debuglink(const char *filename, char *debuglink,
221 int symbol__init(struct perf_env *env);
222 void symbol__exit(void);
223 void symbol__elf_init(void);
224 int symbol__annotation_init(void);
226 struct symbol *symbol__new(u64 start, u64 len, u8 binding, u8 type, const char *name);
227 size_t __symbol__fprintf_symname_offs(const struct symbol *sym,
228 const struct addr_location *al,
229 bool unknown_as_addr,
230 bool print_offsets, FILE *fp);
231 size_t symbol__fprintf_symname_offs(const struct symbol *sym,
232 const struct addr_location *al, FILE *fp);
233 size_t __symbol__fprintf_symname(const struct symbol *sym,
234 const struct addr_location *al,
235 bool unknown_as_addr, FILE *fp);
236 size_t symbol__fprintf_symname(const struct symbol *sym, FILE *fp);
237 size_t symbol__fprintf(struct symbol *sym, FILE *fp);
238 bool symbol__restricted_filename(const char *filename,
239 const char *restricted_filename);
240 int symbol__config_symfs(const struct option *opt __maybe_unused,
241 const char *dir, int unset __maybe_unused);
243 int dso__load_sym(struct dso *dso, struct map *map, struct symsrc *syms_ss,
244 struct symsrc *runtime_ss, int kmodule);
245 int dso__synthesize_plt_symbols(struct dso *dso, struct symsrc *ss);
247 char *dso__demangle_sym(struct dso *dso, int kmodule, const char *elf_name);
249 void __symbols__insert(struct rb_root_cached *symbols, struct symbol *sym,
251 void symbols__insert(struct rb_root_cached *symbols, struct symbol *sym);
252 void symbols__fixup_duplicate(struct rb_root_cached *symbols);
253 void symbols__fixup_end(struct rb_root_cached *symbols);
254 void map_groups__fixup_end(struct map_groups *mg);
256 typedef int (*mapfn_t)(u64 start, u64 len, u64 pgoff, void *data);
257 int file__read_maps(int fd, bool exe, mapfn_t mapfn, void *data,
260 #define PERF_KCORE_EXTRACT "/tmp/perf-kcore-XXXXXX"
262 struct kcore_extract {
263 char *kcore_filename;
267 char extract_filename[sizeof(PERF_KCORE_EXTRACT)];
271 int kcore_extract__create(struct kcore_extract *kce);
272 void kcore_extract__delete(struct kcore_extract *kce);
274 int kcore_copy(const char *from_dir, const char *to_dir);
275 int compare_proc_modules(const char *from, const char *to);
277 int setup_list(struct strlist **list, const char *list_str,
278 const char *list_name);
279 int setup_intlist(struct intlist **list, const char *list_str,
280 const char *list_name);
282 #ifdef HAVE_LIBELF_SUPPORT
283 bool elf__needs_adjust_symbols(GElf_Ehdr ehdr);
284 void arch__sym_update(struct symbol *s, GElf_Sym *sym);
287 const char *arch__normalize_symbol_name(const char *name);
291 int arch__compare_symbol_names(const char *namea, const char *nameb);
292 int arch__compare_symbol_names_n(const char *namea, const char *nameb,
294 int arch__choose_best_symbol(struct symbol *syma, struct symbol *symb);
296 enum symbol_tag_include {
297 SYMBOL_TAG_INCLUDE__NONE = 0,
298 SYMBOL_TAG_INCLUDE__DEFAULT_ONLY
301 int symbol__match_symbol_name(const char *namea, const char *nameb,
302 enum symbol_tag_include includes);
304 /* structure containing an SDT note's info */
306 char *name; /* name of the note*/
307 char *provider; /* provider name */
309 bool bit32; /* whether the location is 32 bits? */
310 union { /* location, base and semaphore addrs */
314 struct list_head note_list; /* SDT notes' list */
317 int get_sdt_note_list(struct list_head *head, const char *target);
318 int cleanup_sdt_note_list(struct list_head *sdt_notes);
319 int sdt_notes__get_count(struct list_head *start);
321 #define SDT_PROBES_SCN ".probes"
322 #define SDT_BASE_SCN ".stapsdt.base"
323 #define SDT_NOTE_SCN ".note.stapsdt"
324 #define SDT_NOTE_TYPE 3
325 #define SDT_NOTE_NAME "stapsdt"
329 SDT_NOTE_IDX_LOC = 0,
334 struct mem_info *mem_info__new(void);
335 struct mem_info *mem_info__get(struct mem_info *mi);
336 void mem_info__put(struct mem_info *mi);
338 static inline void __mem_info__zput(struct mem_info **mi)
344 #define mem_info__zput(mi) __mem_info__zput(&mi)
346 struct block_info *block_info__new(void);
347 struct block_info *block_info__get(struct block_info *bi);
348 void block_info__put(struct block_info *bi);
350 static inline void __block_info__zput(struct block_info **bi)
352 block_info__put(*bi);
356 #define block_info__zput(bi) __block_info__zput(&bi)
358 #endif /* __PERF_SYMBOL */