1 /* SPDX-License-Identifier: GPL-2.0 */
2 #ifndef __PERF_SYMBOL
3 #define __PERF_SYMBOL 1
4
5 #include <linux/types.h>
6 #include <stdbool.h>
7 #include <stdint.h>
8 #include "map.h"
9 #include "../perf.h"
10 #include <linux/list.h>
11 #include <linux/rbtree.h>
12 #include <stdio.h>
13 #include <byteswap.h>
14 #include <libgen.h>
15 #include "build-id.h"
16 #include "event.h"
17 #include "path.h"
18
19 #ifdef HAVE_LIBELF_SUPPORT
20 #include <libelf.h>
21 #include <gelf.h>
22 #endif
23 #include <elf.h>
24
25 #include "dso.h"
26
27 /*
28 * libelf 0.8.x and earlier do not support ELF_C_READ_MMAP;
29 * for newer versions we can use mmap to reduce memory usage:
30 */
31 #ifdef HAVE_LIBELF_MMAP_SUPPORT
32 # define PERF_ELF_C_READ_MMAP ELF_C_READ_MMAP
33 #else
34 # define PERF_ELF_C_READ_MMAP ELF_C_READ
35 #endif
36
37 #ifdef HAVE_LIBELF_SUPPORT
38 Elf_Scn *elf_section_by_name(Elf *elf, GElf_Ehdr *ep,
39 GElf_Shdr *shp, const char *name, size_t *idx);
40 #endif
41
42 #ifndef DMGL_PARAMS
43 #define DMGL_NO_OPTS 0 /* For readability... */
44 #define DMGL_PARAMS (1 << 0) /* Include function args */
45 #define DMGL_ANSI (1 << 1) /* Include const, volatile, etc */
46 #endif
47
48 #define DSO__NAME_KALLSYMS "[kernel.kallsyms]"
49 #define DSO__NAME_KCORE "[kernel.kcore]"
50
51 /** struct symbol - symtab entry
52 *
53 * @ignore - resolvable but tools ignore it (e.g. idle routines)
54 */
55 struct symbol {
56 struct rb_node rb_node;
57 u64 start;
58 u64 end;
59 u16 namelen;
60 u8 type:4;
61 u8 binding:4;
62 u8 idle:1;
63 u8 ignore:1;
64 u8 inlined:1;
65 u8 arch_sym;
66 char name[0];
67 };
68
69 void symbol__delete(struct symbol *sym);
70 void symbols__delete(struct rb_root *symbols);
71
72 /* symbols__for_each_entry - iterate over symbols (rb_root)
73 *
74 * @symbols: the rb_root of symbols
75 * @pos: the 'struct symbol *' to use as a loop cursor
76 * @nd: the 'struct rb_node *' to use as a temporary storage
77 */
78 #define symbols__for_each_entry(symbols, pos, nd) \
79 for (nd = rb_first(symbols); \
80 nd && (pos = rb_entry(nd, struct symbol, rb_node)); \
81 nd = rb_next(nd))
82
symbol__size(const struct symbol * sym)83 static inline size_t symbol__size(const struct symbol *sym)
84 {
85 return sym->end - sym->start;
86 }
87
88 struct strlist;
89 struct intlist;
90
91 struct symbol_conf {
92 unsigned short priv_size;
93 bool try_vmlinux_path,
94 init_annotation,
95 force,
96 ignore_vmlinux,
97 ignore_vmlinux_buildid,
98 show_kernel_path,
99 use_modules,
100 allow_aliases,
101 sort_by_name,
102 show_nr_samples,
103 show_total_period,
104 use_callchain,
105 cumulate_callchain,
106 show_branchflag_count,
107 exclude_other,
108 show_cpu_utilization,
109 initialized,
110 kptr_restrict,
111 event_group,
112 demangle,
113 demangle_kernel,
114 filter_relative,
115 show_hist_headers,
116 branch_callstack,
117 has_filter,
118 show_ref_callgraph,
119 hide_unresolved,
120 raw_trace,
121 report_hierarchy,
122 inline_name;
123 const char *vmlinux_name,
124 *kallsyms_name,
125 *source_prefix,
126 *field_sep;
127 const char *default_guest_vmlinux_name,
128 *default_guest_kallsyms,
129 *default_guest_modules;
130 const char *guestmount;
131 const char *dso_list_str,
132 *comm_list_str,
133 *pid_list_str,
134 *tid_list_str,
135 *sym_list_str,
136 *col_width_list_str,
137 *bt_stop_list_str;
138 struct strlist *dso_list,
139 *comm_list,
140 *sym_list,
141 *dso_from_list,
142 *dso_to_list,
143 *sym_from_list,
144 *sym_to_list,
145 *bt_stop_list;
146 struct intlist *pid_list,
147 *tid_list;
148 const char *symfs;
149 };
150
151 extern struct symbol_conf symbol_conf;
152
153 struct symbol_name_rb_node {
154 struct rb_node rb_node;
155 struct symbol sym;
156 };
157
__symbol__join_symfs(char * bf,size_t size,const char * path)158 static inline int __symbol__join_symfs(char *bf, size_t size, const char *path)
159 {
160 return path__join(bf, size, symbol_conf.symfs, path);
161 }
162
163 #define symbol__join_symfs(bf, path) __symbol__join_symfs(bf, sizeof(bf), path)
164
165 extern int vmlinux_path__nr_entries;
166 extern char **vmlinux_path;
167
symbol__priv(struct symbol * sym)168 static inline void *symbol__priv(struct symbol *sym)
169 {
170 return ((void *)sym) - symbol_conf.priv_size;
171 }
172
173 struct ref_reloc_sym {
174 const char *name;
175 u64 addr;
176 u64 unrelocated_addr;
177 };
178
179 struct map_symbol {
180 struct map *map;
181 struct symbol *sym;
182 };
183
184 struct addr_map_symbol {
185 struct map *map;
186 struct symbol *sym;
187 u64 addr;
188 u64 al_addr;
189 u64 phys_addr;
190 };
191
192 struct branch_info {
193 struct addr_map_symbol from;
194 struct addr_map_symbol to;
195 struct branch_flags flags;
196 char *srcline_from;
197 char *srcline_to;
198 };
199
200 struct mem_info {
201 struct addr_map_symbol iaddr;
202 struct addr_map_symbol daddr;
203 union perf_mem_data_src data_src;
204 refcount_t refcnt;
205 };
206
207 struct addr_location {
208 struct machine *machine;
209 struct thread *thread;
210 struct map *map;
211 struct symbol *sym;
212 const char *srcline;
213 u64 addr;
214 char level;
215 u8 filtered;
216 u8 cpumode;
217 s32 cpu;
218 s32 socket;
219 };
220
221 struct symsrc {
222 char *name;
223 int fd;
224 enum dso_binary_type type;
225
226 #ifdef HAVE_LIBELF_SUPPORT
227 Elf *elf;
228 GElf_Ehdr ehdr;
229
230 Elf_Scn *opdsec;
231 size_t opdidx;
232 GElf_Shdr opdshdr;
233
234 Elf_Scn *symtab;
235 GElf_Shdr symshdr;
236
237 Elf_Scn *dynsym;
238 size_t dynsym_idx;
239 GElf_Shdr dynshdr;
240
241 bool adjust_symbols;
242 bool is_64_bit;
243 #endif
244 };
245
246 void symsrc__destroy(struct symsrc *ss);
247 int symsrc__init(struct symsrc *ss, struct dso *dso, const char *name,
248 enum dso_binary_type type);
249 bool symsrc__has_symtab(struct symsrc *ss);
250 bool symsrc__possibly_runtime(struct symsrc *ss);
251
252 int dso__load(struct dso *dso, struct map *map);
253 int dso__load_vmlinux(struct dso *dso, struct map *map,
254 const char *vmlinux, bool vmlinux_allocated);
255 int dso__load_vmlinux_path(struct dso *dso, struct map *map);
256 int __dso__load_kallsyms(struct dso *dso, const char *filename, struct map *map,
257 bool no_kcore);
258 int dso__load_kallsyms(struct dso *dso, const char *filename, struct map *map);
259
260 void dso__insert_symbol(struct dso *dso,
261 struct symbol *sym);
262
263 struct symbol *dso__find_symbol(struct dso *dso, u64 addr);
264 struct symbol *dso__find_symbol_by_name(struct dso *dso, const char *name);
265
266 struct symbol *symbol__next_by_name(struct symbol *sym);
267
268 struct symbol *dso__first_symbol(struct dso *dso);
269 struct symbol *dso__last_symbol(struct dso *dso);
270 struct symbol *dso__next_symbol(struct symbol *sym);
271
272 enum dso_type dso__type_fd(int fd);
273
274 int filename__read_build_id(const char *filename, void *bf, size_t size);
275 int sysfs__read_build_id(const char *filename, void *bf, size_t size);
276 int modules__parse(const char *filename, void *arg,
277 int (*process_module)(void *arg, const char *name,
278 u64 start, u64 size));
279 int filename__read_debuglink(const char *filename, char *debuglink,
280 size_t size);
281
282 struct perf_env;
283 int symbol__init(struct perf_env *env);
284 void symbol__exit(void);
285 void symbol__elf_init(void);
286 int symbol__annotation_init(void);
287
288 struct symbol *symbol__new(u64 start, u64 len, u8 binding, u8 type, const char *name);
289 size_t __symbol__fprintf_symname_offs(const struct symbol *sym,
290 const struct addr_location *al,
291 bool unknown_as_addr,
292 bool print_offsets, FILE *fp);
293 size_t symbol__fprintf_symname_offs(const struct symbol *sym,
294 const struct addr_location *al, FILE *fp);
295 size_t __symbol__fprintf_symname(const struct symbol *sym,
296 const struct addr_location *al,
297 bool unknown_as_addr, FILE *fp);
298 size_t symbol__fprintf_symname(const struct symbol *sym, FILE *fp);
299 size_t symbol__fprintf(struct symbol *sym, FILE *fp);
300 bool symbol__restricted_filename(const char *filename,
301 const char *restricted_filename);
302 int symbol__config_symfs(const struct option *opt __maybe_unused,
303 const char *dir, int unset __maybe_unused);
304
305 int dso__load_sym(struct dso *dso, struct map *map, struct symsrc *syms_ss,
306 struct symsrc *runtime_ss, int kmodule);
307 int dso__synthesize_plt_symbols(struct dso *dso, struct symsrc *ss);
308
309 char *dso__demangle_sym(struct dso *dso, int kmodule, const char *elf_name);
310
311 void __symbols__insert(struct rb_root *symbols, struct symbol *sym, bool kernel);
312 void symbols__insert(struct rb_root *symbols, struct symbol *sym);
313 void symbols__fixup_duplicate(struct rb_root *symbols);
314 void symbols__fixup_end(struct rb_root *symbols);
315 void map_groups__fixup_end(struct map_groups *mg);
316
317 typedef int (*mapfn_t)(u64 start, u64 len, u64 pgoff, void *data);
318 int file__read_maps(int fd, bool exe, mapfn_t mapfn, void *data,
319 bool *is_64_bit);
320
321 #define PERF_KCORE_EXTRACT "/tmp/perf-kcore-XXXXXX"
322
323 struct kcore_extract {
324 char *kcore_filename;
325 u64 addr;
326 u64 offs;
327 u64 len;
328 char extract_filename[sizeof(PERF_KCORE_EXTRACT)];
329 int fd;
330 };
331
332 int kcore_extract__create(struct kcore_extract *kce);
333 void kcore_extract__delete(struct kcore_extract *kce);
334
335 int kcore_copy(const char *from_dir, const char *to_dir);
336 int compare_proc_modules(const char *from, const char *to);
337
338 int setup_list(struct strlist **list, const char *list_str,
339 const char *list_name);
340 int setup_intlist(struct intlist **list, const char *list_str,
341 const char *list_name);
342
343 #ifdef HAVE_LIBELF_SUPPORT
344 bool elf__needs_adjust_symbols(GElf_Ehdr ehdr);
345 void arch__sym_update(struct symbol *s, GElf_Sym *sym);
346 #endif
347
348 const char *arch__normalize_symbol_name(const char *name);
349 #define SYMBOL_A 0
350 #define SYMBOL_B 1
351
352 int arch__compare_symbol_names(const char *namea, const char *nameb);
353 int arch__compare_symbol_names_n(const char *namea, const char *nameb,
354 unsigned int n);
355 int arch__choose_best_symbol(struct symbol *syma, struct symbol *symb);
356
357 enum symbol_tag_include {
358 SYMBOL_TAG_INCLUDE__NONE = 0,
359 SYMBOL_TAG_INCLUDE__DEFAULT_ONLY
360 };
361
362 int symbol__match_symbol_name(const char *namea, const char *nameb,
363 enum symbol_tag_include includes);
364
365 /* structure containing an SDT note's info */
366 struct sdt_note {
367 char *name; /* name of the note*/
368 char *provider; /* provider name */
369 char *args;
370 bool bit32; /* whether the location is 32 bits? */
371 union { /* location, base and semaphore addrs */
372 Elf64_Addr a64[3];
373 Elf32_Addr a32[3];
374 } addr;
375 struct list_head note_list; /* SDT notes' list */
376 };
377
378 int get_sdt_note_list(struct list_head *head, const char *target);
379 int cleanup_sdt_note_list(struct list_head *sdt_notes);
380 int sdt_notes__get_count(struct list_head *start);
381
382 #define SDT_BASE_SCN ".stapsdt.base"
383 #define SDT_NOTE_SCN ".note.stapsdt"
384 #define SDT_NOTE_TYPE 3
385 #define SDT_NOTE_NAME "stapsdt"
386 #define NR_ADDR 3
387
388 struct mem_info *mem_info__new(void);
389 struct mem_info *mem_info__get(struct mem_info *mi);
390 void mem_info__put(struct mem_info *mi);
391
__mem_info__zput(struct mem_info ** mi)392 static inline void __mem_info__zput(struct mem_info **mi)
393 {
394 mem_info__put(*mi);
395 *mi = NULL;
396 }
397
398 #define mem_info__zput(mi) __mem_info__zput(&mi)
399
400 #endif /* __PERF_SYMBOL */
401
