xref: /openbmc/linux/tools/perf/util/symbol.h (revision a8fe58ce)
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 extern 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 /** struct symbol - symtab entry
48  *
49  * @ignore - resolvable but tools ignore it (e.g. idle routines)
50  */
51 struct symbol {
52 	struct rb_node	rb_node;
53 	u64		start;
54 	u64		end;
55 	u16		namelen;
56 	u8		binding;
57 	bool		ignore;
58 	char		name[0];
59 };
60 
61 void symbol__delete(struct symbol *sym);
62 void symbols__delete(struct rb_root *symbols);
63 
64 /* symbols__for_each_entry - iterate over symbols (rb_root)
65  *
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
69  */
70 #define symbols__for_each_entry(symbols, pos, nd)			\
71 	for (nd = rb_first(symbols);					\
72 	     nd && (pos = rb_entry(nd, struct symbol, rb_node));	\
73 	     nd = rb_next(nd))
74 
75 static inline size_t symbol__size(const struct symbol *sym)
76 {
77 	return sym->end - sym->start;
78 }
79 
80 struct strlist;
81 struct intlist;
82 
83 struct symbol_conf {
84 	unsigned short	priv_size;
85 	unsigned short	nr_events;
86 	bool		try_vmlinux_path,
87 			force,
88 			ignore_vmlinux,
89 			ignore_vmlinux_buildid,
90 			show_kernel_path,
91 			use_modules,
92 			allow_aliases,
93 			sort_by_name,
94 			show_nr_samples,
95 			show_total_period,
96 			use_callchain,
97 			cumulate_callchain,
98 			exclude_other,
99 			show_cpu_utilization,
100 			initialized,
101 			kptr_restrict,
102 			annotate_asm_raw,
103 			annotate_src,
104 			event_group,
105 			demangle,
106 			demangle_kernel,
107 			filter_relative,
108 			show_hist_headers,
109 			branch_callstack,
110 			has_filter,
111 			show_ref_callgraph,
112 			hide_unresolved,
113 			raw_trace;
114 	const char	*vmlinux_name,
115 			*kallsyms_name,
116 			*source_prefix,
117 			*field_sep;
118 	const char	*default_guest_vmlinux_name,
119 			*default_guest_kallsyms,
120 			*default_guest_modules;
121 	const char	*guestmount;
122 	const char	*dso_list_str,
123 			*comm_list_str,
124 			*pid_list_str,
125 			*tid_list_str,
126 			*sym_list_str,
127 			*col_width_list_str;
128        struct strlist	*dso_list,
129 			*comm_list,
130 			*sym_list,
131 			*dso_from_list,
132 			*dso_to_list,
133 			*sym_from_list,
134 			*sym_to_list;
135 	struct intlist	*pid_list,
136 			*tid_list;
137 	const char	*symfs;
138 };
139 
140 extern struct symbol_conf symbol_conf;
141 
142 static inline int __symbol__join_symfs(char *bf, size_t size, const char *path)
143 {
144 	return path__join(bf, size, symbol_conf.symfs, path);
145 }
146 
147 #define symbol__join_symfs(bf, path) __symbol__join_symfs(bf, sizeof(bf), path)
148 
149 extern int vmlinux_path__nr_entries;
150 extern char **vmlinux_path;
151 
152 static inline void *symbol__priv(struct symbol *sym)
153 {
154 	return ((void *)sym) - symbol_conf.priv_size;
155 }
156 
157 struct ref_reloc_sym {
158 	const char	*name;
159 	u64		addr;
160 	u64		unrelocated_addr;
161 };
162 
163 struct map_symbol {
164 	struct map    *map;
165 	struct symbol *sym;
166 };
167 
168 struct addr_map_symbol {
169 	struct map    *map;
170 	struct symbol *sym;
171 	u64	      addr;
172 	u64	      al_addr;
173 };
174 
175 struct branch_info {
176 	struct addr_map_symbol from;
177 	struct addr_map_symbol to;
178 	struct branch_flags flags;
179 };
180 
181 struct mem_info {
182 	struct addr_map_symbol iaddr;
183 	struct addr_map_symbol daddr;
184 	union perf_mem_data_src data_src;
185 };
186 
187 struct addr_location {
188 	struct machine *machine;
189 	struct thread *thread;
190 	struct map    *map;
191 	struct symbol *sym;
192 	u64	      addr;
193 	char	      level;
194 	u8	      filtered;
195 	u8	      cpumode;
196 	s32	      cpu;
197 	s32	      socket;
198 };
199 
200 struct symsrc {
201 	char *name;
202 	int fd;
203 	enum dso_binary_type type;
204 
205 #ifdef HAVE_LIBELF_SUPPORT
206 	Elf *elf;
207 	GElf_Ehdr ehdr;
208 
209 	Elf_Scn *opdsec;
210 	size_t opdidx;
211 	GElf_Shdr opdshdr;
212 
213 	Elf_Scn *symtab;
214 	GElf_Shdr symshdr;
215 
216 	Elf_Scn *dynsym;
217 	size_t dynsym_idx;
218 	GElf_Shdr dynshdr;
219 
220 	bool adjust_symbols;
221 	bool is_64_bit;
222 #endif
223 };
224 
225 void symsrc__destroy(struct symsrc *ss);
226 int symsrc__init(struct symsrc *ss, struct dso *dso, const char *name,
227 		 enum dso_binary_type type);
228 bool symsrc__has_symtab(struct symsrc *ss);
229 bool symsrc__possibly_runtime(struct symsrc *ss);
230 
231 int dso__load(struct dso *dso, struct map *map, symbol_filter_t filter);
232 int dso__load_vmlinux(struct dso *dso, struct map *map,
233 		      const char *vmlinux, bool vmlinux_allocated,
234 		      symbol_filter_t filter);
235 int dso__load_vmlinux_path(struct dso *dso, struct map *map,
236 			   symbol_filter_t filter);
237 int dso__load_kallsyms(struct dso *dso, const char *filename, struct map *map,
238 		       symbol_filter_t filter);
239 
240 struct symbol *dso__find_symbol(struct dso *dso, enum map_type type,
241 				u64 addr);
242 struct symbol *dso__find_symbol_by_name(struct dso *dso, enum map_type type,
243 					const char *name);
244 struct symbol *symbol__next_by_name(struct symbol *sym);
245 
246 struct symbol *dso__first_symbol(struct dso *dso, enum map_type type);
247 struct symbol *dso__next_symbol(struct symbol *sym);
248 
249 enum dso_type dso__type_fd(int fd);
250 
251 int filename__read_build_id(const char *filename, void *bf, size_t size);
252 int sysfs__read_build_id(const char *filename, void *bf, size_t size);
253 int modules__parse(const char *filename, void *arg,
254 		   int (*process_module)(void *arg, const char *name,
255 					 u64 start));
256 int filename__read_debuglink(const char *filename, char *debuglink,
257 			     size_t size);
258 
259 struct perf_env;
260 int symbol__init(struct perf_env *env);
261 void symbol__exit(void);
262 void symbol__elf_init(void);
263 struct symbol *symbol__new(u64 start, u64 len, u8 binding, const char *name);
264 size_t symbol__fprintf_symname_offs(const struct symbol *sym,
265 				    const struct addr_location *al, FILE *fp);
266 size_t symbol__fprintf_symname(const struct symbol *sym, FILE *fp);
267 size_t symbol__fprintf(struct symbol *sym, FILE *fp);
268 bool symbol_type__is_a(char symbol_type, enum map_type map_type);
269 bool symbol__restricted_filename(const char *filename,
270 				 const char *restricted_filename);
271 bool symbol__is_idle(struct symbol *sym);
272 
273 int dso__load_sym(struct dso *dso, struct map *map, struct symsrc *syms_ss,
274 		  struct symsrc *runtime_ss, symbol_filter_t filter,
275 		  int kmodule);
276 int dso__synthesize_plt_symbols(struct dso *dso, struct symsrc *ss,
277 				struct map *map, symbol_filter_t filter);
278 
279 void symbols__insert(struct rb_root *symbols, struct symbol *sym);
280 void symbols__fixup_duplicate(struct rb_root *symbols);
281 void symbols__fixup_end(struct rb_root *symbols);
282 void __map_groups__fixup_end(struct map_groups *mg, enum map_type type);
283 
284 typedef int (*mapfn_t)(u64 start, u64 len, u64 pgoff, void *data);
285 int file__read_maps(int fd, bool exe, mapfn_t mapfn, void *data,
286 		    bool *is_64_bit);
287 
288 #define PERF_KCORE_EXTRACT "/tmp/perf-kcore-XXXXXX"
289 
290 struct kcore_extract {
291 	char *kcore_filename;
292 	u64 addr;
293 	u64 offs;
294 	u64 len;
295 	char extract_filename[sizeof(PERF_KCORE_EXTRACT)];
296 	int fd;
297 };
298 
299 int kcore_extract__create(struct kcore_extract *kce);
300 void kcore_extract__delete(struct kcore_extract *kce);
301 
302 int kcore_copy(const char *from_dir, const char *to_dir);
303 int compare_proc_modules(const char *from, const char *to);
304 
305 int setup_list(struct strlist **list, const char *list_str,
306 	       const char *list_name);
307 int setup_intlist(struct intlist **list, const char *list_str,
308 		  const char *list_name);
309 
310 #ifdef HAVE_LIBELF_SUPPORT
311 bool elf__needs_adjust_symbols(GElf_Ehdr ehdr);
312 void arch__elf_sym_adjust(GElf_Sym *sym);
313 #endif
314 
315 #define SYMBOL_A 0
316 #define SYMBOL_B 1
317 
318 int arch__choose_best_symbol(struct symbol *syma, struct symbol *symb);
319 
320 #endif /* __PERF_SYMBOL */
321