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