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