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