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