xref: /linux/tools/perf/util/symbol.h (revision 8ab596afb97bc9e2f9140dc1d993e81749acff42)
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 
16 #ifdef HAVE_LIBELF_SUPPORT
17 #include <libelf.h>
18 #include <gelf.h>
19 #endif
20 #include <elf.h>
21 
22 #include "dso.h"
23 
24 #ifdef HAVE_CPLUS_DEMANGLE_SUPPORT
25 extern char *cplus_demangle(const char *, int);
26 
27 static inline char *bfd_demangle(void __maybe_unused *v, const char *c, int i)
28 {
29 	return cplus_demangle(c, i);
30 }
31 #else
32 #ifdef NO_DEMANGLE
33 static inline char *bfd_demangle(void __maybe_unused *v,
34 				 const char __maybe_unused *c,
35 				 int __maybe_unused i)
36 {
37 	return NULL;
38 }
39 #else
40 #define PACKAGE 'perf'
41 #include <bfd.h>
42 #endif
43 #endif
44 
45 /*
46  * libelf 0.8.x and earlier do not support ELF_C_READ_MMAP;
47  * for newer versions we can use mmap to reduce memory usage:
48  */
49 #ifdef HAVE_LIBELF_MMAP_SUPPORT
50 # define PERF_ELF_C_READ_MMAP ELF_C_READ_MMAP
51 #else
52 # define PERF_ELF_C_READ_MMAP ELF_C_READ
53 #endif
54 
55 #ifdef HAVE_LIBELF_SUPPORT
56 extern Elf_Scn *elf_section_by_name(Elf *elf, GElf_Ehdr *ep,
57 				GElf_Shdr *shp, const char *name, size_t *idx);
58 #endif
59 
60 #ifndef DMGL_PARAMS
61 #define DMGL_PARAMS      (1 << 0)       /* Include function args */
62 #define DMGL_ANSI        (1 << 1)       /* Include const, volatile, etc */
63 #endif
64 
65 /** struct symbol - symtab entry
66  *
67  * @ignore - resolvable but tools ignore it (e.g. idle routines)
68  */
69 struct symbol {
70 	struct rb_node	rb_node;
71 	u64		start;
72 	u64		end;
73 	u16		namelen;
74 	u8		binding;
75 	bool		ignore;
76 	char		name[0];
77 };
78 
79 void symbol__delete(struct symbol *sym);
80 void symbols__delete(struct rb_root *symbols);
81 
82 /* symbols__for_each_entry - iterate over symbols (rb_root)
83  *
84  * @symbols: the rb_root of symbols
85  * @pos: the 'struct symbol *' to use as a loop cursor
86  * @nd: the 'struct rb_node *' to use as a temporary storage
87  */
88 #define symbols__for_each_entry(symbols, pos, nd)			\
89 	for (nd = rb_first(symbols);					\
90 	     nd && (pos = rb_entry(nd, struct symbol, rb_node));	\
91 	     nd = rb_next(nd))
92 
93 static inline size_t symbol__size(const struct symbol *sym)
94 {
95 	return sym->end - sym->start + 1;
96 }
97 
98 struct strlist;
99 
100 struct symbol_conf {
101 	unsigned short	priv_size;
102 	unsigned short	nr_events;
103 	bool		try_vmlinux_path,
104 			ignore_vmlinux,
105 			show_kernel_path,
106 			use_modules,
107 			sort_by_name,
108 			show_nr_samples,
109 			show_total_period,
110 			use_callchain,
111 			exclude_other,
112 			show_cpu_utilization,
113 			initialized,
114 			kptr_restrict,
115 			annotate_asm_raw,
116 			annotate_src,
117 			event_group,
118 			demangle,
119 			filter_relative;
120 	const char	*vmlinux_name,
121 			*kallsyms_name,
122 			*source_prefix,
123 			*field_sep;
124 	const char	*default_guest_vmlinux_name,
125 			*default_guest_kallsyms,
126 			*default_guest_modules;
127 	const char	*guestmount;
128 	const char	*dso_list_str,
129 			*comm_list_str,
130 			*sym_list_str,
131 			*col_width_list_str;
132        struct strlist	*dso_list,
133 			*comm_list,
134 			*sym_list,
135 			*dso_from_list,
136 			*dso_to_list,
137 			*sym_from_list,
138 			*sym_to_list;
139 	const char	*symfs;
140 };
141 
142 extern struct symbol_conf symbol_conf;
143 extern int vmlinux_path__nr_entries;
144 extern char **vmlinux_path;
145 
146 static inline void *symbol__priv(struct symbol *sym)
147 {
148 	return ((void *)sym) - symbol_conf.priv_size;
149 }
150 
151 struct ref_reloc_sym {
152 	const char	*name;
153 	u64		addr;
154 	u64		unrelocated_addr;
155 };
156 
157 struct map_symbol {
158 	struct map    *map;
159 	struct symbol *sym;
160 	bool	      unfolded;
161 	bool	      has_children;
162 };
163 
164 struct addr_map_symbol {
165 	struct map    *map;
166 	struct symbol *sym;
167 	u64	      addr;
168 	u64	      al_addr;
169 };
170 
171 struct branch_info {
172 	struct addr_map_symbol from;
173 	struct addr_map_symbol to;
174 	struct branch_flags flags;
175 };
176 
177 struct mem_info {
178 	struct addr_map_symbol iaddr;
179 	struct addr_map_symbol daddr;
180 	union perf_mem_data_src data_src;
181 };
182 
183 struct addr_location {
184 	struct machine *machine;
185 	struct thread *thread;
186 	struct map    *map;
187 	struct symbol *sym;
188 	u64	      addr;
189 	char	      level;
190 	u8	      filtered;
191 	u8	      cpumode;
192 	s32	      cpu;
193 };
194 
195 struct symsrc {
196 	char *name;
197 	int fd;
198 	enum dso_binary_type type;
199 
200 #ifdef HAVE_LIBELF_SUPPORT
201 	Elf *elf;
202 	GElf_Ehdr ehdr;
203 
204 	Elf_Scn *opdsec;
205 	size_t opdidx;
206 	GElf_Shdr opdshdr;
207 
208 	Elf_Scn *symtab;
209 	GElf_Shdr symshdr;
210 
211 	Elf_Scn *dynsym;
212 	size_t dynsym_idx;
213 	GElf_Shdr dynshdr;
214 
215 	bool adjust_symbols;
216 #endif
217 };
218 
219 void symsrc__destroy(struct symsrc *ss);
220 int symsrc__init(struct symsrc *ss, struct dso *dso, const char *name,
221 		 enum dso_binary_type type);
222 bool symsrc__has_symtab(struct symsrc *ss);
223 bool symsrc__possibly_runtime(struct symsrc *ss);
224 
225 int dso__load(struct dso *dso, struct map *map, symbol_filter_t filter);
226 int dso__load_vmlinux(struct dso *dso, struct map *map,
227 		      const char *vmlinux, bool vmlinux_allocated,
228 		      symbol_filter_t filter);
229 int dso__load_vmlinux_path(struct dso *dso, struct map *map,
230 			   symbol_filter_t filter);
231 int dso__load_kallsyms(struct dso *dso, const char *filename, struct map *map,
232 		       symbol_filter_t filter);
233 
234 struct symbol *dso__find_symbol(struct dso *dso, enum map_type type,
235 				u64 addr);
236 struct symbol *dso__find_symbol_by_name(struct dso *dso, enum map_type type,
237 					const char *name);
238 
239 int filename__read_build_id(const char *filename, void *bf, size_t size);
240 int sysfs__read_build_id(const char *filename, void *bf, size_t size);
241 int modules__parse(const char *filename, void *arg,
242 		   int (*process_module)(void *arg, const char *name,
243 					 u64 start));
244 int filename__read_debuglink(const char *filename, char *debuglink,
245 			     size_t size);
246 
247 int symbol__init(void);
248 void symbol__exit(void);
249 void symbol__elf_init(void);
250 struct symbol *symbol__new(u64 start, u64 len, u8 binding, const char *name);
251 size_t symbol__fprintf_symname_offs(const struct symbol *sym,
252 				    const struct addr_location *al, FILE *fp);
253 size_t symbol__fprintf_symname(const struct symbol *sym, FILE *fp);
254 size_t symbol__fprintf(struct symbol *sym, FILE *fp);
255 bool symbol_type__is_a(char symbol_type, enum map_type map_type);
256 bool symbol__restricted_filename(const char *filename,
257 				 const char *restricted_filename);
258 bool symbol__is_idle(struct symbol *sym);
259 
260 int dso__load_sym(struct dso *dso, struct map *map, struct symsrc *syms_ss,
261 		  struct symsrc *runtime_ss, symbol_filter_t filter,
262 		  int kmodule);
263 int dso__synthesize_plt_symbols(struct dso *dso, struct symsrc *ss,
264 				struct map *map, symbol_filter_t filter);
265 
266 void symbols__insert(struct rb_root *symbols, struct symbol *sym);
267 void symbols__fixup_duplicate(struct rb_root *symbols);
268 void symbols__fixup_end(struct rb_root *symbols);
269 void __map_groups__fixup_end(struct map_groups *mg, enum map_type type);
270 
271 typedef int (*mapfn_t)(u64 start, u64 len, u64 pgoff, void *data);
272 int file__read_maps(int fd, bool exe, mapfn_t mapfn, void *data,
273 		    bool *is_64_bit);
274 
275 #define PERF_KCORE_EXTRACT "/tmp/perf-kcore-XXXXXX"
276 
277 struct kcore_extract {
278 	char *kcore_filename;
279 	u64 addr;
280 	u64 offs;
281 	u64 len;
282 	char extract_filename[sizeof(PERF_KCORE_EXTRACT)];
283 	int fd;
284 };
285 
286 int kcore_extract__create(struct kcore_extract *kce);
287 void kcore_extract__delete(struct kcore_extract *kce);
288 
289 int kcore_copy(const char *from_dir, const char *to_dir);
290 int compare_proc_modules(const char *from, const char *to);
291 
292 int setup_list(struct strlist **list, const char *list_str,
293 	       const char *list_name);
294 
295 #endif /* __PERF_SYMBOL */
296