xref: /linux/tools/perf/util/symbol.h (revision e5c86679d5e864947a52fb31e45a425dea3e7fa9)
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 "util.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 	const char	*vmlinux_name,
123 			*kallsyms_name,
124 			*source_prefix,
125 			*field_sep;
126 	const char	*default_guest_vmlinux_name,
127 			*default_guest_kallsyms,
128 			*default_guest_modules;
129 	const char	*guestmount;
130 	const char	*dso_list_str,
131 			*comm_list_str,
132 			*pid_list_str,
133 			*tid_list_str,
134 			*sym_list_str,
135 			*col_width_list_str,
136 			*bt_stop_list_str;
137        struct strlist	*dso_list,
138 			*comm_list,
139 			*sym_list,
140 			*dso_from_list,
141 			*dso_to_list,
142 			*sym_from_list,
143 			*sym_to_list,
144 			*bt_stop_list;
145 	struct intlist	*pid_list,
146 			*tid_list;
147 	const char	*symfs;
148 };
149 
150 extern struct symbol_conf symbol_conf;
151 
152 struct symbol_name_rb_node {
153 	struct rb_node	rb_node;
154 	struct symbol	sym;
155 };
156 
157 static inline int __symbol__join_symfs(char *bf, size_t size, const char *path)
158 {
159 	return path__join(bf, size, symbol_conf.symfs, path);
160 }
161 
162 #define symbol__join_symfs(bf, path) __symbol__join_symfs(bf, sizeof(bf), path)
163 
164 extern int vmlinux_path__nr_entries;
165 extern char **vmlinux_path;
166 
167 static inline void *symbol__priv(struct symbol *sym)
168 {
169 	return ((void *)sym) - symbol_conf.priv_size;
170 }
171 
172 struct ref_reloc_sym {
173 	const char	*name;
174 	u64		addr;
175 	u64		unrelocated_addr;
176 };
177 
178 struct map_symbol {
179 	struct map    *map;
180 	struct symbol *sym;
181 };
182 
183 struct addr_map_symbol {
184 	struct map    *map;
185 	struct symbol *sym;
186 	u64	      addr;
187 	u64	      al_addr;
188 };
189 
190 struct branch_info {
191 	struct addr_map_symbol from;
192 	struct addr_map_symbol to;
193 	struct branch_flags flags;
194 	char			*srcline_from;
195 	char			*srcline_to;
196 };
197 
198 struct mem_info {
199 	struct addr_map_symbol iaddr;
200 	struct addr_map_symbol daddr;
201 	union perf_mem_data_src data_src;
202 };
203 
204 struct addr_location {
205 	struct machine *machine;
206 	struct thread *thread;
207 	struct map    *map;
208 	struct symbol *sym;
209 	u64	      addr;
210 	char	      level;
211 	u8	      filtered;
212 	u8	      cpumode;
213 	s32	      cpu;
214 	s32	      socket;
215 };
216 
217 struct symsrc {
218 	char *name;
219 	int fd;
220 	enum dso_binary_type type;
221 
222 #ifdef HAVE_LIBELF_SUPPORT
223 	Elf *elf;
224 	GElf_Ehdr ehdr;
225 
226 	Elf_Scn *opdsec;
227 	size_t opdidx;
228 	GElf_Shdr opdshdr;
229 
230 	Elf_Scn *symtab;
231 	GElf_Shdr symshdr;
232 
233 	Elf_Scn *dynsym;
234 	size_t dynsym_idx;
235 	GElf_Shdr dynshdr;
236 
237 	bool adjust_symbols;
238 	bool is_64_bit;
239 #endif
240 };
241 
242 void symsrc__destroy(struct symsrc *ss);
243 int symsrc__init(struct symsrc *ss, struct dso *dso, const char *name,
244 		 enum dso_binary_type type);
245 bool symsrc__has_symtab(struct symsrc *ss);
246 bool symsrc__possibly_runtime(struct symsrc *ss);
247 
248 int dso__load(struct dso *dso, struct map *map);
249 int dso__load_vmlinux(struct dso *dso, struct map *map,
250 		      const char *vmlinux, bool vmlinux_allocated);
251 int dso__load_vmlinux_path(struct dso *dso, struct map *map);
252 int __dso__load_kallsyms(struct dso *dso, const char *filename, struct map *map,
253 			 bool no_kcore);
254 int dso__load_kallsyms(struct dso *dso, const char *filename, struct map *map);
255 
256 void dso__insert_symbol(struct dso *dso, enum map_type type,
257 			struct symbol *sym);
258 
259 struct symbol *dso__find_symbol(struct dso *dso, enum map_type type,
260 				u64 addr);
261 struct symbol *dso__find_symbol_by_name(struct dso *dso, enum map_type type,
262 					const char *name);
263 struct symbol *symbol__next_by_name(struct symbol *sym);
264 
265 struct symbol *dso__first_symbol(struct dso *dso, enum map_type type);
266 struct symbol *dso__last_symbol(struct dso *dso, enum map_type type);
267 struct symbol *dso__next_symbol(struct symbol *sym);
268 
269 enum dso_type dso__type_fd(int fd);
270 
271 int filename__read_build_id(const char *filename, void *bf, size_t size);
272 int sysfs__read_build_id(const char *filename, void *bf, size_t size);
273 int modules__parse(const char *filename, void *arg,
274 		   int (*process_module)(void *arg, const char *name,
275 					 u64 start));
276 int filename__read_debuglink(const char *filename, char *debuglink,
277 			     size_t size);
278 
279 struct perf_env;
280 int symbol__init(struct perf_env *env);
281 void symbol__exit(void);
282 void symbol__elf_init(void);
283 int symbol__annotation_init(void);
284 
285 struct symbol *symbol__new(u64 start, u64 len, u8 binding, const char *name);
286 size_t __symbol__fprintf_symname_offs(const struct symbol *sym,
287 				      const struct addr_location *al,
288 				      bool unknown_as_addr,
289 				      bool print_offsets, FILE *fp);
290 size_t symbol__fprintf_symname_offs(const struct symbol *sym,
291 				    const struct addr_location *al, FILE *fp);
292 size_t __symbol__fprintf_symname(const struct symbol *sym,
293 				 const struct addr_location *al,
294 				 bool unknown_as_addr, FILE *fp);
295 size_t symbol__fprintf_symname(const struct symbol *sym, FILE *fp);
296 size_t symbol__fprintf(struct symbol *sym, FILE *fp);
297 bool symbol_type__is_a(char symbol_type, enum map_type map_type);
298 bool symbol__restricted_filename(const char *filename,
299 				 const char *restricted_filename);
300 int symbol__config_symfs(const struct option *opt __maybe_unused,
301 			 const char *dir, int unset __maybe_unused);
302 
303 int dso__load_sym(struct dso *dso, struct map *map, struct symsrc *syms_ss,
304 		  struct symsrc *runtime_ss, int kmodule);
305 int dso__synthesize_plt_symbols(struct dso *dso, struct symsrc *ss,
306 				struct map *map);
307 
308 void __symbols__insert(struct rb_root *symbols, struct symbol *sym, bool kernel);
309 void symbols__insert(struct rb_root *symbols, struct symbol *sym);
310 void symbols__fixup_duplicate(struct rb_root *symbols);
311 void symbols__fixup_end(struct rb_root *symbols);
312 void __map_groups__fixup_end(struct map_groups *mg, enum map_type type);
313 
314 typedef int (*mapfn_t)(u64 start, u64 len, u64 pgoff, void *data);
315 int file__read_maps(int fd, bool exe, mapfn_t mapfn, void *data,
316 		    bool *is_64_bit);
317 
318 #define PERF_KCORE_EXTRACT "/tmp/perf-kcore-XXXXXX"
319 
320 struct kcore_extract {
321 	char *kcore_filename;
322 	u64 addr;
323 	u64 offs;
324 	u64 len;
325 	char extract_filename[sizeof(PERF_KCORE_EXTRACT)];
326 	int fd;
327 };
328 
329 int kcore_extract__create(struct kcore_extract *kce);
330 void kcore_extract__delete(struct kcore_extract *kce);
331 
332 int kcore_copy(const char *from_dir, const char *to_dir);
333 int compare_proc_modules(const char *from, const char *to);
334 
335 int setup_list(struct strlist **list, const char *list_str,
336 	       const char *list_name);
337 int setup_intlist(struct intlist **list, const char *list_str,
338 		  const char *list_name);
339 
340 #ifdef HAVE_LIBELF_SUPPORT
341 bool elf__needs_adjust_symbols(GElf_Ehdr ehdr);
342 void arch__sym_update(struct symbol *s, GElf_Sym *sym);
343 #endif
344 
345 #define SYMBOL_A 0
346 #define SYMBOL_B 1
347 
348 int arch__choose_best_symbol(struct symbol *syma, struct symbol *symb);
349 
350 /* structure containing an SDT note's info */
351 struct sdt_note {
352 	char *name;			/* name of the note*/
353 	char *provider;			/* provider name */
354 	bool bit32;			/* whether the location is 32 bits? */
355 	union {				/* location, base and semaphore addrs */
356 		Elf64_Addr a64[3];
357 		Elf32_Addr a32[3];
358 	} addr;
359 	struct list_head note_list;	/* SDT notes' list */
360 };
361 
362 int get_sdt_note_list(struct list_head *head, const char *target);
363 int cleanup_sdt_note_list(struct list_head *sdt_notes);
364 int sdt_notes__get_count(struct list_head *start);
365 
366 #define SDT_BASE_SCN ".stapsdt.base"
367 #define SDT_NOTE_SCN  ".note.stapsdt"
368 #define SDT_NOTE_TYPE 3
369 #define SDT_NOTE_NAME "stapsdt"
370 #define NR_ADDR 3
371 
372 #endif /* __PERF_SYMBOL */
373