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;
109 struct addr_location {
110 struct thread *thread;
123 int dso__load(struct dso *dso, struct map *map);
124 int dso__load_vmlinux(struct dso *dso, struct map *map,
125 const char *vmlinux, bool vmlinux_allocated);
126 int dso__load_vmlinux_path(struct dso *dso, struct map *map);
127 int __dso__load_kallsyms(struct dso *dso, const char *filename, struct map *map,
129 int dso__load_kallsyms(struct dso *dso, const char *filename, struct map *map);
131 void dso__insert_symbol(struct dso *dso,
134 struct symbol *dso__find_symbol(struct dso *dso, u64 addr);
135 struct symbol *dso__find_symbol_by_name(struct dso *dso, const char *name);
137 struct symbol *symbol__next_by_name(struct symbol *sym);
139 struct symbol *dso__first_symbol(struct dso *dso);
140 struct symbol *dso__last_symbol(struct dso *dso);
141 struct symbol *dso__next_symbol(struct symbol *sym);
143 enum dso_type dso__type_fd(int fd);
145 int filename__read_build_id(const char *filename, void *bf, size_t size);
146 int sysfs__read_build_id(const char *filename, void *bf, size_t size);
147 int modules__parse(const char *filename, void *arg,
148 int (*process_module)(void *arg, const char *name,
149 u64 start, u64 size));
150 int filename__read_debuglink(const char *filename, char *debuglink,
154 int symbol__init(struct perf_env *env);
155 void symbol__exit(void);
156 void symbol__elf_init(void);
157 int symbol__annotation_init(void);
159 struct symbol *symbol__new(u64 start, u64 len, u8 binding, u8 type, const char *name);
160 size_t __symbol__fprintf_symname_offs(const struct symbol *sym,
161 const struct addr_location *al,
162 bool unknown_as_addr,
163 bool print_offsets, FILE *fp);
164 size_t symbol__fprintf_symname_offs(const struct symbol *sym,
165 const struct addr_location *al, FILE *fp);
166 size_t __symbol__fprintf_symname(const struct symbol *sym,
167 const struct addr_location *al,
168 bool unknown_as_addr, FILE *fp);
169 size_t symbol__fprintf_symname(const struct symbol *sym, FILE *fp);
170 size_t symbol__fprintf(struct symbol *sym, FILE *fp);
171 bool symbol__restricted_filename(const char *filename,
172 const char *restricted_filename);
173 int symbol__config_symfs(const struct option *opt __maybe_unused,
174 const char *dir, int unset __maybe_unused);
178 int dso__load_sym(struct dso *dso, struct map *map, struct symsrc *syms_ss,
179 struct symsrc *runtime_ss, int kmodule);
180 int dso__synthesize_plt_symbols(struct dso *dso, struct symsrc *ss);
182 char *dso__demangle_sym(struct dso *dso, int kmodule, const char *elf_name);
184 void __symbols__insert(struct rb_root_cached *symbols, struct symbol *sym,
186 void symbols__insert(struct rb_root_cached *symbols, struct symbol *sym);
187 void symbols__fixup_duplicate(struct rb_root_cached *symbols);
188 void symbols__fixup_end(struct rb_root_cached *symbols);
189 void maps__fixup_end(struct maps *maps);
191 typedef int (*mapfn_t)(u64 start, u64 len, u64 pgoff, void *data);
192 int file__read_maps(int fd, bool exe, mapfn_t mapfn, void *data,
195 #define PERF_KCORE_EXTRACT "/tmp/perf-kcore-XXXXXX"
197 struct kcore_extract {
198 char *kcore_filename;
202 char extract_filename[sizeof(PERF_KCORE_EXTRACT)];
206 int kcore_extract__create(struct kcore_extract *kce);
207 void kcore_extract__delete(struct kcore_extract *kce);
209 int kcore_copy(const char *from_dir, const char *to_dir);
210 int compare_proc_modules(const char *from, const char *to);
212 int setup_list(struct strlist **list, const char *list_str,
213 const char *list_name);
214 int setup_intlist(struct intlist **list, const char *list_str,
215 const char *list_name);
217 #ifdef HAVE_LIBELF_SUPPORT
218 bool elf__needs_adjust_symbols(GElf_Ehdr ehdr);
219 void arch__sym_update(struct symbol *s, GElf_Sym *sym);
222 const char *arch__normalize_symbol_name(const char *name);
226 void arch__symbols__fixup_end(struct symbol *p, struct symbol *c);
227 int arch__compare_symbol_names(const char *namea, const char *nameb);
228 int arch__compare_symbol_names_n(const char *namea, const char *nameb,
230 int arch__choose_best_symbol(struct symbol *syma, struct symbol *symb);
232 enum symbol_tag_include {
233 SYMBOL_TAG_INCLUDE__NONE = 0,
234 SYMBOL_TAG_INCLUDE__DEFAULT_ONLY
237 int symbol__match_symbol_name(const char *namea, const char *nameb,
238 enum symbol_tag_include includes);
240 /* structure containing an SDT note's info */
242 char *name; /* name of the note*/
243 char *provider; /* provider name */
245 bool bit32; /* whether the location is 32 bits? */
246 union { /* location, base and semaphore addrs */
250 struct list_head note_list; /* SDT notes' list */
253 int get_sdt_note_list(struct list_head *head, const char *target);
254 int cleanup_sdt_note_list(struct list_head *sdt_notes);
255 int sdt_notes__get_count(struct list_head *start);
257 #define SDT_PROBES_SCN ".probes"
258 #define SDT_BASE_SCN ".stapsdt.base"
259 #define SDT_NOTE_SCN ".note.stapsdt"
260 #define SDT_NOTE_TYPE 3
261 #define SDT_NOTE_NAME "stapsdt"
265 SDT_NOTE_IDX_LOC = 0,
270 struct mem_info *mem_info__new(void);
271 struct mem_info *mem_info__get(struct mem_info *mi);
272 void mem_info__put(struct mem_info *mi);
274 static inline void __mem_info__zput(struct mem_info **mi)
280 #define mem_info__zput(mi) __mem_info__zput(&mi)
282 #endif /* __PERF_SYMBOL */