1 /* SPDX-License-Identifier: GPL-2.0 */
3 #define __PERF_SYMBOL 1
5 #include <linux/types.h>
6 #include <linux/refcount.h>
9 #include <linux/list.h>
10 #include <linux/rbtree.h>
13 #include "symbol_conf.h"
16 #ifdef HAVE_LIBELF_SUPPORT
28 * libelf 0.8.x and earlier do not support ELF_C_READ_MMAP;
29 * for newer versions we can use mmap to reduce memory usage:
31 #ifdef HAVE_LIBELF_MMAP_SUPPORT
32 # define PERF_ELF_C_READ_MMAP ELF_C_READ_MMAP
34 # define PERF_ELF_C_READ_MMAP ELF_C_READ
37 #ifdef HAVE_LIBELF_SUPPORT
38 Elf_Scn *elf_section_by_name(Elf *elf, GElf_Ehdr *ep,
39 GElf_Shdr *shp, const char *name, size_t *idx);
42 /** struct symbol - symtab entry
44 * @ignore - resolvable but tools ignore it (e.g. idle routines)
47 struct rb_node rb_node;
61 void symbol__delete(struct symbol *sym);
62 void symbols__delete(struct rb_root_cached *symbols);
64 /* symbols__for_each_entry - iterate over symbols (rb_root)
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
70 #define symbols__for_each_entry(symbols, pos, nd) \
71 for (nd = rb_first_cached(symbols); \
72 nd && (pos = rb_entry(nd, struct symbol, rb_node)); \
75 static inline size_t symbol__size(const struct symbol *sym)
77 return sym->end - sym->start;
83 struct symbol_name_rb_node {
84 struct rb_node rb_node;
88 static inline int __symbol__join_symfs(char *bf, size_t size, const char *path)
90 return path__join(bf, size, symbol_conf.symfs, path);
93 #define symbol__join_symfs(bf, path) __symbol__join_symfs(bf, sizeof(bf), path)
95 extern int vmlinux_path__nr_entries;
96 extern char **vmlinux_path;
98 static inline void *symbol__priv(struct symbol *sym)
100 return ((void *)sym) - symbol_conf.priv_size;
103 struct ref_reloc_sym {
106 u64 unrelocated_addr;
115 s64 cycles_spark[NUM_SPARKS];
121 struct addr_location {
122 struct machine *machine;
123 struct thread *thread;
135 int dso__load(struct dso *dso, struct map *map);
136 int dso__load_vmlinux(struct dso *dso, struct map *map,
137 const char *vmlinux, bool vmlinux_allocated);
138 int dso__load_vmlinux_path(struct dso *dso, struct map *map);
139 int __dso__load_kallsyms(struct dso *dso, const char *filename, struct map *map,
141 int dso__load_kallsyms(struct dso *dso, const char *filename, struct map *map);
143 void dso__insert_symbol(struct dso *dso,
146 struct symbol *dso__find_symbol(struct dso *dso, u64 addr);
147 struct symbol *dso__find_symbol_by_name(struct dso *dso, const char *name);
149 struct symbol *symbol__next_by_name(struct symbol *sym);
151 struct symbol *dso__first_symbol(struct dso *dso);
152 struct symbol *dso__last_symbol(struct dso *dso);
153 struct symbol *dso__next_symbol(struct symbol *sym);
155 enum dso_type dso__type_fd(int fd);
157 int filename__read_build_id(const char *filename, void *bf, size_t size);
158 int sysfs__read_build_id(const char *filename, void *bf, size_t size);
159 int modules__parse(const char *filename, void *arg,
160 int (*process_module)(void *arg, const char *name,
161 u64 start, u64 size));
162 int filename__read_debuglink(const char *filename, char *debuglink,
166 int symbol__init(struct perf_env *env);
167 void symbol__exit(void);
168 void symbol__elf_init(void);
169 int symbol__annotation_init(void);
171 struct symbol *symbol__new(u64 start, u64 len, u8 binding, u8 type, const char *name);
172 size_t __symbol__fprintf_symname_offs(const struct symbol *sym,
173 const struct addr_location *al,
174 bool unknown_as_addr,
175 bool print_offsets, FILE *fp);
176 size_t symbol__fprintf_symname_offs(const struct symbol *sym,
177 const struct addr_location *al, FILE *fp);
178 size_t __symbol__fprintf_symname(const struct symbol *sym,
179 const struct addr_location *al,
180 bool unknown_as_addr, FILE *fp);
181 size_t symbol__fprintf_symname(const struct symbol *sym, FILE *fp);
182 size_t symbol__fprintf(struct symbol *sym, FILE *fp);
183 bool symbol__restricted_filename(const char *filename,
184 const char *restricted_filename);
185 int symbol__config_symfs(const struct option *opt __maybe_unused,
186 const char *dir, int unset __maybe_unused);
190 int dso__load_sym(struct dso *dso, struct map *map, struct symsrc *syms_ss,
191 struct symsrc *runtime_ss, int kmodule);
192 int dso__synthesize_plt_symbols(struct dso *dso, struct symsrc *ss);
194 char *dso__demangle_sym(struct dso *dso, int kmodule, const char *elf_name);
196 void __symbols__insert(struct rb_root_cached *symbols, struct symbol *sym,
198 void symbols__insert(struct rb_root_cached *symbols, struct symbol *sym);
199 void symbols__fixup_duplicate(struct rb_root_cached *symbols);
200 void symbols__fixup_end(struct rb_root_cached *symbols);
201 void map_groups__fixup_end(struct map_groups *mg);
203 typedef int (*mapfn_t)(u64 start, u64 len, u64 pgoff, void *data);
204 int file__read_maps(int fd, bool exe, mapfn_t mapfn, void *data,
207 #define PERF_KCORE_EXTRACT "/tmp/perf-kcore-XXXXXX"
209 struct kcore_extract {
210 char *kcore_filename;
214 char extract_filename[sizeof(PERF_KCORE_EXTRACT)];
218 int kcore_extract__create(struct kcore_extract *kce);
219 void kcore_extract__delete(struct kcore_extract *kce);
221 int kcore_copy(const char *from_dir, const char *to_dir);
222 int compare_proc_modules(const char *from, const char *to);
224 int setup_list(struct strlist **list, const char *list_str,
225 const char *list_name);
226 int setup_intlist(struct intlist **list, const char *list_str,
227 const char *list_name);
229 #ifdef HAVE_LIBELF_SUPPORT
230 bool elf__needs_adjust_symbols(GElf_Ehdr ehdr);
231 void arch__sym_update(struct symbol *s, GElf_Sym *sym);
234 const char *arch__normalize_symbol_name(const char *name);
238 void arch__symbols__fixup_end(struct symbol *p, struct symbol *c);
239 int arch__compare_symbol_names(const char *namea, const char *nameb);
240 int arch__compare_symbol_names_n(const char *namea, const char *nameb,
242 int arch__choose_best_symbol(struct symbol *syma, struct symbol *symb);
244 enum symbol_tag_include {
245 SYMBOL_TAG_INCLUDE__NONE = 0,
246 SYMBOL_TAG_INCLUDE__DEFAULT_ONLY
249 int symbol__match_symbol_name(const char *namea, const char *nameb,
250 enum symbol_tag_include includes);
252 /* structure containing an SDT note's info */
254 char *name; /* name of the note*/
255 char *provider; /* provider name */
257 bool bit32; /* whether the location is 32 bits? */
258 union { /* location, base and semaphore addrs */
262 struct list_head note_list; /* SDT notes' list */
265 int get_sdt_note_list(struct list_head *head, const char *target);
266 int cleanup_sdt_note_list(struct list_head *sdt_notes);
267 int sdt_notes__get_count(struct list_head *start);
269 #define SDT_PROBES_SCN ".probes"
270 #define SDT_BASE_SCN ".stapsdt.base"
271 #define SDT_NOTE_SCN ".note.stapsdt"
272 #define SDT_NOTE_TYPE 3
273 #define SDT_NOTE_NAME "stapsdt"
277 SDT_NOTE_IDX_LOC = 0,
282 struct mem_info *mem_info__new(void);
283 struct mem_info *mem_info__get(struct mem_info *mi);
284 void mem_info__put(struct mem_info *mi);
286 static inline void __mem_info__zput(struct mem_info **mi)
292 #define mem_info__zput(mi) __mem_info__zput(&mi)
294 struct block_info *block_info__new(void);
295 struct block_info *block_info__get(struct block_info *bi);
296 void block_info__put(struct block_info *bi);
298 static inline void __block_info__zput(struct block_info **bi)
300 block_info__put(*bi);
304 #define block_info__zput(bi) __block_info__zput(&bi)
306 #endif /* __PERF_SYMBOL */