Linux 5.1.15
[linux/fpc-iii.git] / tools / perf / util / symbol.h
blob9a8fe012910a736d49e2054406bc976c8281115d
1 /* SPDX-License-Identifier: GPL-2.0 */
2 #ifndef __PERF_SYMBOL
3 #define __PERF_SYMBOL 1
5 #include <linux/types.h>
6 #include <stdbool.h>
7 #include <stdint.h>
8 #include <linux/list.h>
9 #include <linux/rbtree.h>
10 #include <stdio.h>
11 #include "map_symbol.h"
12 #include "branch.h"
13 #include "path.h"
14 #include "symbol_conf.h"
16 #ifdef HAVE_LIBELF_SUPPORT
17 #include <libelf.h>
18 #include <gelf.h>
19 #endif
20 #include <elf.h>
22 #include "dso.h"
24 struct map;
25 struct map_groups;
26 struct option;
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
34 #else
35 # define PERF_ELF_C_READ_MMAP ELF_C_READ
36 #endif
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
43 #ifndef DMGL_PARAMS
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 */
47 #endif
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)
56 struct symbol {
57 struct rb_node rb_node;
58 u64 start;
59 u64 end;
60 u16 namelen;
61 u8 type:4;
62 u8 binding:4;
63 u8 idle:1;
64 u8 ignore:1;
65 u8 inlined:1;
66 u8 arch_sym;
67 bool annotate2;
68 char name[0];
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)); \
83 nd = rb_next(nd))
85 static inline size_t symbol__size(const struct symbol *sym)
87 return sym->end - sym->start;
90 struct strlist;
91 struct intlist;
93 struct symbol_name_rb_node {
94 struct rb_node rb_node;
95 struct symbol sym;
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 {
114 const char *name;
115 u64 addr;
116 u64 unrelocated_addr;
119 struct branch_info {
120 struct addr_map_symbol from;
121 struct addr_map_symbol to;
122 struct branch_flags flags;
123 char *srcline_from;
124 char *srcline_to;
127 struct mem_info {
128 struct addr_map_symbol iaddr;
129 struct addr_map_symbol daddr;
130 union perf_mem_data_src data_src;
131 refcount_t refcnt;
134 struct addr_location {
135 struct machine *machine;
136 struct thread *thread;
137 struct map *map;
138 struct symbol *sym;
139 const char *srcline;
140 u64 addr;
141 char level;
142 u8 filtered;
143 u8 cpumode;
144 s32 cpu;
145 s32 socket;
148 struct symsrc {
149 char *name;
150 int fd;
151 enum dso_binary_type type;
153 #ifdef HAVE_LIBELF_SUPPORT
154 Elf *elf;
155 GElf_Ehdr ehdr;
157 Elf_Scn *opdsec;
158 size_t opdidx;
159 GElf_Shdr opdshdr;
161 Elf_Scn *symtab;
162 GElf_Shdr symshdr;
164 Elf_Scn *dynsym;
165 size_t dynsym_idx;
166 GElf_Shdr dynshdr;
168 bool adjust_symbols;
169 bool is_64_bit;
170 #endif
173 void symsrc__destroy(struct symsrc *ss);
174 int symsrc__init(struct symsrc *ss, struct dso *dso, const char *name,
175 enum dso_binary_type type);
176 bool symsrc__has_symtab(struct symsrc *ss);
177 bool symsrc__possibly_runtime(struct symsrc *ss);
179 int dso__load(struct dso *dso, struct map *map);
180 int dso__load_vmlinux(struct dso *dso, struct map *map,
181 const char *vmlinux, bool vmlinux_allocated);
182 int dso__load_vmlinux_path(struct dso *dso, struct map *map);
183 int __dso__load_kallsyms(struct dso *dso, const char *filename, struct map *map,
184 bool no_kcore);
185 int dso__load_kallsyms(struct dso *dso, const char *filename, struct map *map);
187 void dso__insert_symbol(struct dso *dso,
188 struct symbol *sym);
190 struct symbol *dso__find_symbol(struct dso *dso, u64 addr);
191 struct symbol *dso__find_symbol_by_name(struct dso *dso, const char *name);
193 struct symbol *symbol__next_by_name(struct symbol *sym);
195 struct symbol *dso__first_symbol(struct dso *dso);
196 struct symbol *dso__last_symbol(struct dso *dso);
197 struct symbol *dso__next_symbol(struct symbol *sym);
199 enum dso_type dso__type_fd(int fd);
201 int filename__read_build_id(const char *filename, void *bf, size_t size);
202 int sysfs__read_build_id(const char *filename, void *bf, size_t size);
203 int modules__parse(const char *filename, void *arg,
204 int (*process_module)(void *arg, const char *name,
205 u64 start, u64 size));
206 int filename__read_debuglink(const char *filename, char *debuglink,
207 size_t size);
209 struct perf_env;
210 int symbol__init(struct perf_env *env);
211 void symbol__exit(void);
212 void symbol__elf_init(void);
213 int symbol__annotation_init(void);
215 struct symbol *symbol__new(u64 start, u64 len, u8 binding, u8 type, const char *name);
216 size_t __symbol__fprintf_symname_offs(const struct symbol *sym,
217 const struct addr_location *al,
218 bool unknown_as_addr,
219 bool print_offsets, FILE *fp);
220 size_t symbol__fprintf_symname_offs(const struct symbol *sym,
221 const struct addr_location *al, FILE *fp);
222 size_t __symbol__fprintf_symname(const struct symbol *sym,
223 const struct addr_location *al,
224 bool unknown_as_addr, FILE *fp);
225 size_t symbol__fprintf_symname(const struct symbol *sym, FILE *fp);
226 size_t symbol__fprintf(struct symbol *sym, FILE *fp);
227 bool symbol__restricted_filename(const char *filename,
228 const char *restricted_filename);
229 int symbol__config_symfs(const struct option *opt __maybe_unused,
230 const char *dir, int unset __maybe_unused);
232 int dso__load_sym(struct dso *dso, struct map *map, struct symsrc *syms_ss,
233 struct symsrc *runtime_ss, int kmodule);
234 int dso__synthesize_plt_symbols(struct dso *dso, struct symsrc *ss);
236 char *dso__demangle_sym(struct dso *dso, int kmodule, const char *elf_name);
238 void __symbols__insert(struct rb_root_cached *symbols, struct symbol *sym,
239 bool kernel);
240 void symbols__insert(struct rb_root_cached *symbols, struct symbol *sym);
241 void symbols__fixup_duplicate(struct rb_root_cached *symbols);
242 void symbols__fixup_end(struct rb_root_cached *symbols);
243 void map_groups__fixup_end(struct map_groups *mg);
245 typedef int (*mapfn_t)(u64 start, u64 len, u64 pgoff, void *data);
246 int file__read_maps(int fd, bool exe, mapfn_t mapfn, void *data,
247 bool *is_64_bit);
249 #define PERF_KCORE_EXTRACT "/tmp/perf-kcore-XXXXXX"
251 struct kcore_extract {
252 char *kcore_filename;
253 u64 addr;
254 u64 offs;
255 u64 len;
256 char extract_filename[sizeof(PERF_KCORE_EXTRACT)];
257 int fd;
260 int kcore_extract__create(struct kcore_extract *kce);
261 void kcore_extract__delete(struct kcore_extract *kce);
263 int kcore_copy(const char *from_dir, const char *to_dir);
264 int compare_proc_modules(const char *from, const char *to);
266 int setup_list(struct strlist **list, const char *list_str,
267 const char *list_name);
268 int setup_intlist(struct intlist **list, const char *list_str,
269 const char *list_name);
271 #ifdef HAVE_LIBELF_SUPPORT
272 bool elf__needs_adjust_symbols(GElf_Ehdr ehdr);
273 void arch__sym_update(struct symbol *s, GElf_Sym *sym);
274 #endif
276 const char *arch__normalize_symbol_name(const char *name);
277 #define SYMBOL_A 0
278 #define SYMBOL_B 1
280 int arch__compare_symbol_names(const char *namea, const char *nameb);
281 int arch__compare_symbol_names_n(const char *namea, const char *nameb,
282 unsigned int n);
283 int arch__choose_best_symbol(struct symbol *syma, struct symbol *symb);
285 enum symbol_tag_include {
286 SYMBOL_TAG_INCLUDE__NONE = 0,
287 SYMBOL_TAG_INCLUDE__DEFAULT_ONLY
290 int symbol__match_symbol_name(const char *namea, const char *nameb,
291 enum symbol_tag_include includes);
293 /* structure containing an SDT note's info */
294 struct sdt_note {
295 char *name; /* name of the note*/
296 char *provider; /* provider name */
297 char *args;
298 bool bit32; /* whether the location is 32 bits? */
299 union { /* location, base and semaphore addrs */
300 Elf64_Addr a64[3];
301 Elf32_Addr a32[3];
302 } addr;
303 struct list_head note_list; /* SDT notes' list */
306 int get_sdt_note_list(struct list_head *head, const char *target);
307 int cleanup_sdt_note_list(struct list_head *sdt_notes);
308 int sdt_notes__get_count(struct list_head *start);
310 #define SDT_PROBES_SCN ".probes"
311 #define SDT_BASE_SCN ".stapsdt.base"
312 #define SDT_NOTE_SCN ".note.stapsdt"
313 #define SDT_NOTE_TYPE 3
314 #define SDT_NOTE_NAME "stapsdt"
315 #define NR_ADDR 3
317 enum {
318 SDT_NOTE_IDX_LOC = 0,
319 SDT_NOTE_IDX_BASE,
320 SDT_NOTE_IDX_REFCTR,
323 struct mem_info *mem_info__new(void);
324 struct mem_info *mem_info__get(struct mem_info *mi);
325 void mem_info__put(struct mem_info *mi);
327 static inline void __mem_info__zput(struct mem_info **mi)
329 mem_info__put(*mi);
330 *mi = NULL;
333 #define mem_info__zput(mi) __mem_info__zput(&mi)
335 #endif /* __PERF_SYMBOL */