xref: /openbmc/linux/tools/perf/util/symbol.h (revision 99fee508)
1 #ifndef __PERF_SYMBOL
2 #define __PERF_SYMBOL 1
3 
4 #include <linux/types.h>
5 #include <stdbool.h>
6 #include <stdint.h>
7 #include "map.h"
8 #include "../perf.h"
9 #include <linux/list.h>
10 #include <linux/rbtree.h>
11 #include <stdio.h>
12 #include <byteswap.h>
13 #include <libgen.h>
14 #include "build-id.h"
15 #include "event.h"
16 #include "path.h"
17 
18 #ifdef HAVE_LIBELF_SUPPORT
19 #include <libelf.h>
20 #include <gelf.h>
21 #endif
22 #include <elf.h>
23 
24 #include "dso.h"
25 
26 /*
27  * libelf 0.8.x and earlier do not support ELF_C_READ_MMAP;
28  * for newer versions we can use mmap to reduce memory usage:
29  */
30 #ifdef HAVE_LIBELF_MMAP_SUPPORT
31 # define PERF_ELF_C_READ_MMAP ELF_C_READ_MMAP
32 #else
33 # define PERF_ELF_C_READ_MMAP ELF_C_READ
34 #endif
35 
36 #ifdef HAVE_LIBELF_SUPPORT
37 Elf_Scn *elf_section_by_name(Elf *elf, GElf_Ehdr *ep,
38 			     GElf_Shdr *shp, const char *name, size_t *idx);
39 #endif
40 
41 #ifndef DMGL_PARAMS
42 #define DMGL_NO_OPTS     0              /* For readability... */
43 #define DMGL_PARAMS      (1 << 0)       /* Include function args */
44 #define DMGL_ANSI        (1 << 1)       /* Include const, volatile, etc */
45 #endif
46 
47 #define DSO__NAME_KALLSYMS	"[kernel.kallsyms]"
48 #define DSO__NAME_KCORE		"[kernel.kcore]"
49 
50 /** struct symbol - symtab entry
51  *
52  * @ignore - resolvable but tools ignore it (e.g. idle routines)
53  */
54 struct symbol {
55 	struct rb_node	rb_node;
56 	u64		start;
57 	u64		end;
58 	u16		namelen;
59 	u8		binding;
60 	u8		idle:1;
61 	u8		ignore:1;
62 	u8		arch_sym;
63 	char		name[0];
64 };
65 
66 void symbol__delete(struct symbol *sym);
67 void symbols__delete(struct rb_root *symbols);
68 
69 /* symbols__for_each_entry - iterate over symbols (rb_root)
70  *
71  * @symbols: the rb_root of symbols
72  * @pos: the 'struct symbol *' to use as a loop cursor
73  * @nd: the 'struct rb_node *' to use as a temporary storage
74  */
75 #define symbols__for_each_entry(symbols, pos, nd)			\
76 	for (nd = rb_first(symbols);					\
77 	     nd && (pos = rb_entry(nd, struct symbol, rb_node));	\
78 	     nd = rb_next(nd))
79 
80 static inline size_t symbol__size(const struct symbol *sym)
81 {
82 	return sym->end - sym->start;
83 }
84 
85 struct strlist;
86 struct intlist;
87 
88 struct symbol_conf {
89 	unsigned short	priv_size;
90 	unsigned short	nr_events;
91 	bool		try_vmlinux_path,
92 			init_annotation,
93 			force,
94 			ignore_vmlinux,
95 			ignore_vmlinux_buildid,
96 			show_kernel_path,
97 			use_modules,
98 			allow_aliases,
99 			sort_by_name,
100 			show_nr_samples,
101 			show_total_period,
102 			use_callchain,
103 			cumulate_callchain,
104 			show_branchflag_count,
105 			exclude_other,
106 			show_cpu_utilization,
107 			initialized,
108 			kptr_restrict,
109 			annotate_asm_raw,
110 			annotate_src,
111 			event_group,
112 			demangle,
113 			demangle_kernel,
114 			filter_relative,
115 			show_hist_headers,
116 			branch_callstack,
117 			has_filter,
118 			show_ref_callgraph,
119 			hide_unresolved,
120 			raw_trace,
121 			report_hierarchy,
122 			inline_name;
123 	const char	*vmlinux_name,
124 			*kallsyms_name,
125 			*source_prefix,
126 			*field_sep;
127 	const char	*default_guest_vmlinux_name,
128 			*default_guest_kallsyms,
129 			*default_guest_modules;
130 	const char	*guestmount;
131 	const char	*dso_list_str,
132 			*comm_list_str,
133 			*pid_list_str,
134 			*tid_list_str,
135 			*sym_list_str,
136 			*col_width_list_str,
137 			*bt_stop_list_str;
138        struct strlist	*dso_list,
139 			*comm_list,
140 			*sym_list,
141 			*dso_from_list,
142 			*dso_to_list,
143 			*sym_from_list,
144 			*sym_to_list,
145 			*bt_stop_list;
146 	struct intlist	*pid_list,
147 			*tid_list;
148 	const char	*symfs;
149 };
150 
151 extern struct symbol_conf symbol_conf;
152 
153 struct symbol_name_rb_node {
154 	struct rb_node	rb_node;
155 	struct symbol	sym;
156 };
157 
158 static inline int __symbol__join_symfs(char *bf, size_t size, const char *path)
159 {
160 	return path__join(bf, size, symbol_conf.symfs, path);
161 }
162 
163 #define symbol__join_symfs(bf, path) __symbol__join_symfs(bf, sizeof(bf), path)
164 
165 extern int vmlinux_path__nr_entries;
166 extern char **vmlinux_path;
167 
168 static inline void *symbol__priv(struct symbol *sym)
169 {
170 	return ((void *)sym) - symbol_conf.priv_size;
171 }
172 
173 struct ref_reloc_sym {
174 	const char	*name;
175 	u64		addr;
176 	u64		unrelocated_addr;
177 };
178 
179 struct map_symbol {
180 	struct map    *map;
181 	struct symbol *sym;
182 };
183 
184 struct addr_map_symbol {
185 	struct map    *map;
186 	struct symbol *sym;
187 	u64	      addr;
188 	u64	      al_addr;
189 	u64	      phys_addr;
190 };
191 
192 struct branch_info {
193 	struct addr_map_symbol from;
194 	struct addr_map_symbol to;
195 	struct branch_flags flags;
196 	char			*srcline_from;
197 	char			*srcline_to;
198 };
199 
200 struct mem_info {
201 	struct addr_map_symbol iaddr;
202 	struct addr_map_symbol daddr;
203 	union perf_mem_data_src data_src;
204 };
205 
206 struct addr_location {
207 	struct machine *machine;
208 	struct thread *thread;
209 	struct map    *map;
210 	struct symbol *sym;
211 	u64	      addr;
212 	char	      level;
213 	u8	      filtered;
214 	u8	      cpumode;
215 	s32	      cpu;
216 	s32	      socket;
217 };
218 
219 struct symsrc {
220 	char *name;
221 	int fd;
222 	enum dso_binary_type type;
223 
224 #ifdef HAVE_LIBELF_SUPPORT
225 	Elf *elf;
226 	GElf_Ehdr ehdr;
227 
228 	Elf_Scn *opdsec;
229 	size_t opdidx;
230 	GElf_Shdr opdshdr;
231 
232 	Elf_Scn *symtab;
233 	GElf_Shdr symshdr;
234 
235 	Elf_Scn *dynsym;
236 	size_t dynsym_idx;
237 	GElf_Shdr dynshdr;
238 
239 	bool adjust_symbols;
240 	bool is_64_bit;
241 #endif
242 };
243 
244 void symsrc__destroy(struct symsrc *ss);
245 int symsrc__init(struct symsrc *ss, struct dso *dso, const char *name,
246 		 enum dso_binary_type type);
247 bool symsrc__has_symtab(struct symsrc *ss);
248 bool symsrc__possibly_runtime(struct symsrc *ss);
249 
250 int dso__load(struct dso *dso, struct map *map);
251 int dso__load_vmlinux(struct dso *dso, struct map *map,
252 		      const char *vmlinux, bool vmlinux_allocated);
253 int dso__load_vmlinux_path(struct dso *dso, struct map *map);
254 int __dso__load_kallsyms(struct dso *dso, const char *filename, struct map *map,
255 			 bool no_kcore);
256 int dso__load_kallsyms(struct dso *dso, const char *filename, struct map *map);
257 
258 void dso__insert_symbol(struct dso *dso, enum map_type type,
259 			struct symbol *sym);
260 
261 struct symbol *dso__find_symbol(struct dso *dso, enum map_type type,
262 				u64 addr);
263 struct symbol *dso__find_symbol_by_name(struct dso *dso, enum map_type type,
264 					const char *name);
265 struct symbol *symbol__next_by_name(struct symbol *sym);
266 
267 struct symbol *dso__first_symbol(struct dso *dso, enum map_type type);
268 struct symbol *dso__last_symbol(struct dso *dso, enum map_type type);
269 struct symbol *dso__next_symbol(struct symbol *sym);
270 
271 enum dso_type dso__type_fd(int fd);
272 
273 int filename__read_build_id(const char *filename, void *bf, size_t size);
274 int sysfs__read_build_id(const char *filename, void *bf, size_t size);
275 int modules__parse(const char *filename, void *arg,
276 		   int (*process_module)(void *arg, const char *name,
277 					 u64 start, u64 size));
278 int filename__read_debuglink(const char *filename, char *debuglink,
279 			     size_t size);
280 
281 struct perf_env;
282 int symbol__init(struct perf_env *env);
283 void symbol__exit(void);
284 void symbol__elf_init(void);
285 int symbol__annotation_init(void);
286 
287 struct symbol *symbol__new(u64 start, u64 len, u8 binding, const char *name);
288 size_t __symbol__fprintf_symname_offs(const struct symbol *sym,
289 				      const struct addr_location *al,
290 				      bool unknown_as_addr,
291 				      bool print_offsets, FILE *fp);
292 size_t symbol__fprintf_symname_offs(const struct symbol *sym,
293 				    const struct addr_location *al, FILE *fp);
294 size_t __symbol__fprintf_symname(const struct symbol *sym,
295 				 const struct addr_location *al,
296 				 bool unknown_as_addr, FILE *fp);
297 size_t symbol__fprintf_symname(const struct symbol *sym, FILE *fp);
298 size_t symbol__fprintf(struct symbol *sym, FILE *fp);
299 bool symbol_type__is_a(char symbol_type, enum map_type map_type);
300 bool symbol__restricted_filename(const char *filename,
301 				 const char *restricted_filename);
302 int symbol__config_symfs(const struct option *opt __maybe_unused,
303 			 const char *dir, int unset __maybe_unused);
304 
305 int dso__load_sym(struct dso *dso, struct map *map, struct symsrc *syms_ss,
306 		  struct symsrc *runtime_ss, int kmodule);
307 int dso__synthesize_plt_symbols(struct dso *dso, struct symsrc *ss,
308 				struct map *map);
309 
310 char *dso__demangle_sym(struct dso *dso, int kmodule, const char *elf_name);
311 
312 void __symbols__insert(struct rb_root *symbols, struct symbol *sym, bool kernel);
313 void symbols__insert(struct rb_root *symbols, struct symbol *sym);
314 void symbols__fixup_duplicate(struct rb_root *symbols);
315 void symbols__fixup_end(struct rb_root *symbols);
316 void __map_groups__fixup_end(struct map_groups *mg, enum map_type type);
317 
318 typedef int (*mapfn_t)(u64 start, u64 len, u64 pgoff, void *data);
319 int file__read_maps(int fd, bool exe, mapfn_t mapfn, void *data,
320 		    bool *is_64_bit);
321 
322 #define PERF_KCORE_EXTRACT "/tmp/perf-kcore-XXXXXX"
323 
324 struct kcore_extract {
325 	char *kcore_filename;
326 	u64 addr;
327 	u64 offs;
328 	u64 len;
329 	char extract_filename[sizeof(PERF_KCORE_EXTRACT)];
330 	int fd;
331 };
332 
333 int kcore_extract__create(struct kcore_extract *kce);
334 void kcore_extract__delete(struct kcore_extract *kce);
335 
336 int kcore_copy(const char *from_dir, const char *to_dir);
337 int compare_proc_modules(const char *from, const char *to);
338 
339 int setup_list(struct strlist **list, const char *list_str,
340 	       const char *list_name);
341 int setup_intlist(struct intlist **list, const char *list_str,
342 		  const char *list_name);
343 
344 #ifdef HAVE_LIBELF_SUPPORT
345 bool elf__needs_adjust_symbols(GElf_Ehdr ehdr);
346 void arch__sym_update(struct symbol *s, GElf_Sym *sym);
347 #endif
348 
349 #define SYMBOL_A 0
350 #define SYMBOL_B 1
351 
352 int arch__compare_symbol_names(const char *namea, const char *nameb);
353 int arch__compare_symbol_names_n(const char *namea, const char *nameb,
354 				 unsigned int n);
355 int arch__choose_best_symbol(struct symbol *syma, struct symbol *symb);
356 
357 enum symbol_tag_include {
358 	SYMBOL_TAG_INCLUDE__NONE = 0,
359 	SYMBOL_TAG_INCLUDE__DEFAULT_ONLY
360 };
361 
362 int symbol__match_symbol_name(const char *namea, const char *nameb,
363 			      enum symbol_tag_include includes);
364 
365 /* structure containing an SDT note's info */
366 struct sdt_note {
367 	char *name;			/* name of the note*/
368 	char *provider;			/* provider name */
369 	char *args;
370 	bool bit32;			/* whether the location is 32 bits? */
371 	union {				/* location, base and semaphore addrs */
372 		Elf64_Addr a64[3];
373 		Elf32_Addr a32[3];
374 	} addr;
375 	struct list_head note_list;	/* SDT notes' list */
376 };
377 
378 int get_sdt_note_list(struct list_head *head, const char *target);
379 int cleanup_sdt_note_list(struct list_head *sdt_notes);
380 int sdt_notes__get_count(struct list_head *start);
381 
382 #define SDT_BASE_SCN ".stapsdt.base"
383 #define SDT_NOTE_SCN  ".note.stapsdt"
384 #define SDT_NOTE_TYPE 3
385 #define SDT_NOTE_NAME "stapsdt"
386 #define NR_ADDR 3
387 
388 #endif /* __PERF_SYMBOL */
389