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 <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
15#ifdef HAVE_LIBELF_SUPPORT
16#include <libelf.h>
17#include <gelf.h>
18#endif
19#include <elf.h>
20
21struct dso;
22struct map;
23struct map_groups;
24struct option;
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
37Elf_Scn *elf_section_by_name(Elf *elf, GElf_Ehdr *ep,
38 GElf_Shdr *shp, const char *name, size_t *idx);
39#endif
40
41/** struct symbol - symtab entry
42 *
43 * @ignore - resolvable but tools ignore it (e.g. idle routines)
44 */
45struct symbol {
46 struct rb_node rb_node;
47 u64 start;
48 u64 end;
49 u16 namelen;
50 u8 type:4;
51 u8 binding:4;
52 u8 idle:1;
53 u8 ignore:1;
54 u8 inlined:1;
55 u8 arch_sym;
56 bool annotate2;
57 char name[0];
58};
59
60void symbol__delete(struct symbol *sym);
61void symbols__delete(struct rb_root_cached *symbols);
62
63/* symbols__for_each_entry - iterate over symbols (rb_root)
64 *
65 * @symbols: the rb_root of symbols
66 * @pos: the 'struct symbol *' to use as a loop cursor
67 * @nd: the 'struct rb_node *' to use as a temporary storage
68 */
69#define symbols__for_each_entry(symbols, pos, nd) \
70 for (nd = rb_first_cached(symbols); \
71 nd && (pos = rb_entry(nd, struct symbol, rb_node)); \
72 nd = rb_next(nd))
73
74static inline size_t symbol__size(const struct symbol *sym)
75{
76 return sym->end - sym->start;
77}
78
79struct strlist;
80struct intlist;
81
82struct symbol_name_rb_node {
83 struct rb_node rb_node;
84 struct symbol sym;
85};
86
87static inline int __symbol__join_symfs(char *bf, size_t size, const char *path)
88{
89 return path__join(bf, size, symbol_conf.symfs, path);
90}
91
92#define symbol__join_symfs(bf, path) __symbol__join_symfs(bf, sizeof(bf), path)
93
94extern int vmlinux_path__nr_entries;
95extern char **vmlinux_path;
96
97static inline void *symbol__priv(struct symbol *sym)
98{
99 return ((void *)sym) - symbol_conf.priv_size;
100}
101
102struct ref_reloc_sym {
103 const char *name;
104 u64 addr;
105 u64 unrelocated_addr;
106};
107
108struct block_info {
109 struct symbol *sym;
110 u64 start;
111 u64 end;
112 u64 cycles;
113 u64 cycles_aggr;
114 int num;
115 int num_aggr;
116 refcount_t refcnt;
117};
118
119struct addr_location {
120 struct machine *machine;
121 struct thread *thread;
122 struct map *map;
123 struct symbol *sym;
124 const char *srcline;
125 u64 addr;
126 char level;
127 u8 filtered;
128 u8 cpumode;
129 s32 cpu;
130 s32 socket;
131};
132
133int dso__load(struct dso *dso, struct map *map);
134int dso__load_vmlinux(struct dso *dso, struct map *map,
135 const char *vmlinux, bool vmlinux_allocated);
136int dso__load_vmlinux_path(struct dso *dso, struct map *map);
137int __dso__load_kallsyms(struct dso *dso, const char *filename, struct map *map,
138 bool no_kcore);
139int dso__load_kallsyms(struct dso *dso, const char *filename, struct map *map);
140
141void dso__insert_symbol(struct dso *dso,
142 struct symbol *sym);
143
144struct symbol *dso__find_symbol(struct dso *dso, u64 addr);
145struct symbol *dso__find_symbol_by_name(struct dso *dso, const char *name);
146
147struct symbol *symbol__next_by_name(struct symbol *sym);
148
149struct symbol *dso__first_symbol(struct dso *dso);
150struct symbol *dso__last_symbol(struct dso *dso);
151struct symbol *dso__next_symbol(struct symbol *sym);
152
153enum dso_type dso__type_fd(int fd);
154
155int filename__read_build_id(const char *filename, void *bf, size_t size);
156int sysfs__read_build_id(const char *filename, void *bf, size_t size);
157int modules__parse(const char *filename, void *arg,
158 int (*process_module)(void *arg, const char *name,
159 u64 start, u64 size));
160int filename__read_debuglink(const char *filename, char *debuglink,
161 size_t size);
162
163struct perf_env;
164int symbol__init(struct perf_env *env);
165void symbol__exit(void);
166void symbol__elf_init(void);
167int symbol__annotation_init(void);
168
169struct symbol *symbol__new(u64 start, u64 len, u8 binding, u8 type, const char *name);
170size_t __symbol__fprintf_symname_offs(const struct symbol *sym,
171 const struct addr_location *al,
172 bool unknown_as_addr,
173 bool print_offsets, FILE *fp);
174size_t symbol__fprintf_symname_offs(const struct symbol *sym,
175 const struct addr_location *al, FILE *fp);
176size_t __symbol__fprintf_symname(const struct symbol *sym,
177 const struct addr_location *al,
178 bool unknown_as_addr, FILE *fp);
179size_t symbol__fprintf_symname(const struct symbol *sym, FILE *fp);
180size_t symbol__fprintf(struct symbol *sym, FILE *fp);
181bool symbol__restricted_filename(const char *filename,
182 const char *restricted_filename);
183int symbol__config_symfs(const struct option *opt __maybe_unused,
184 const char *dir, int unset __maybe_unused);
185
186struct symsrc;
187
188int dso__load_sym(struct dso *dso, struct map *map, struct symsrc *syms_ss,
189 struct symsrc *runtime_ss, int kmodule);
190int dso__synthesize_plt_symbols(struct dso *dso, struct symsrc *ss);
191
192char *dso__demangle_sym(struct dso *dso, int kmodule, const char *elf_name);
193
194void __symbols__insert(struct rb_root_cached *symbols, struct symbol *sym,
195 bool kernel);
196void symbols__insert(struct rb_root_cached *symbols, struct symbol *sym);
197void symbols__fixup_duplicate(struct rb_root_cached *symbols);
198void symbols__fixup_end(struct rb_root_cached *symbols);
199void map_groups__fixup_end(struct map_groups *mg);
200
201typedef int (*mapfn_t)(u64 start, u64 len, u64 pgoff, void *data);
202int file__read_maps(int fd, bool exe, mapfn_t mapfn, void *data,
203 bool *is_64_bit);
204
205#define PERF_KCORE_EXTRACT "/tmp/perf-kcore-XXXXXX"
206
207struct kcore_extract {
208 char *kcore_filename;
209 u64 addr;
210 u64 offs;
211 u64 len;
212 char extract_filename[sizeof(PERF_KCORE_EXTRACT)];
213 int fd;
214};
215
216int kcore_extract__create(struct kcore_extract *kce);
217void kcore_extract__delete(struct kcore_extract *kce);
218
219int kcore_copy(const char *from_dir, const char *to_dir);
220int compare_proc_modules(const char *from, const char *to);
221
222int setup_list(struct strlist **list, const char *list_str,
223 const char *list_name);
224int setup_intlist(struct intlist **list, const char *list_str,
225 const char *list_name);
226
227#ifdef HAVE_LIBELF_SUPPORT
228bool elf__needs_adjust_symbols(GElf_Ehdr ehdr);
229void arch__sym_update(struct symbol *s, GElf_Sym *sym);
230#endif
231
232const char *arch__normalize_symbol_name(const char *name);
233#define SYMBOL_A 0
234#define SYMBOL_B 1
235
236void arch__symbols__fixup_end(struct symbol *p, struct symbol *c);
237int arch__compare_symbol_names(const char *namea, const char *nameb);
238int arch__compare_symbol_names_n(const char *namea, const char *nameb,
239 unsigned int n);
240int arch__choose_best_symbol(struct symbol *syma, struct symbol *symb);
241
242enum symbol_tag_include {
243 SYMBOL_TAG_INCLUDE__NONE = 0,
244 SYMBOL_TAG_INCLUDE__DEFAULT_ONLY
245};
246
247int symbol__match_symbol_name(const char *namea, const char *nameb,
248 enum symbol_tag_include includes);
249
250/* structure containing an SDT note's info */
251struct sdt_note {
252 char *name; /* name of the note*/
253 char *provider; /* provider name */
254 char *args;
255 bool bit32; /* whether the location is 32 bits? */
256 union { /* location, base and semaphore addrs */
257 Elf64_Addr a64[3];
258 Elf32_Addr a32[3];
259 } addr;
260 struct list_head note_list; /* SDT notes' list */
261};
262
263int get_sdt_note_list(struct list_head *head, const char *target);
264int cleanup_sdt_note_list(struct list_head *sdt_notes);
265int sdt_notes__get_count(struct list_head *start);
266
267#define SDT_PROBES_SCN ".probes"
268#define SDT_BASE_SCN ".stapsdt.base"
269#define SDT_NOTE_SCN ".note.stapsdt"
270#define SDT_NOTE_TYPE 3
271#define SDT_NOTE_NAME "stapsdt"
272#define NR_ADDR 3
273
274enum {
275 SDT_NOTE_IDX_LOC = 0,
276 SDT_NOTE_IDX_BASE,
277 SDT_NOTE_IDX_REFCTR,
278};
279
280struct mem_info *mem_info__new(void);
281struct mem_info *mem_info__get(struct mem_info *mi);
282void mem_info__put(struct mem_info *mi);
283
284static inline void __mem_info__zput(struct mem_info **mi)
285{
286 mem_info__put(*mi);
287 *mi = NULL;
288}
289
290#define mem_info__zput(mi) __mem_info__zput(&mi)
291
292struct block_info *block_info__new(void);
293struct block_info *block_info__get(struct block_info *bi);
294void block_info__put(struct block_info *bi);
295
296static inline void __block_info__zput(struct block_info **bi)
297{
298 block_info__put(*bi);
299 *bi = NULL;
300}
301
302#define block_info__zput(bi) __block_info__zput(&bi)
303
304#endif /* __PERF_SYMBOL */
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 <linux/list.h>
9#include <linux/rbtree.h>
10#include <stdio.h>
11
12#ifdef HAVE_CPLUS_DEMANGLE
13extern char *cplus_demangle(const char *, int);
14
15static inline char *bfd_demangle(void __used *v, const char *c, int i)
16{
17 return cplus_demangle(c, i);
18}
19#else
20#ifdef NO_DEMANGLE
21static inline char *bfd_demangle(void __used *v, const char __used *c,
22 int __used i)
23{
24 return NULL;
25}
26#else
27#include <bfd.h>
28#endif
29#endif
30
31int hex2u64(const char *ptr, u64 *val);
32char *strxfrchar(char *s, char from, char to);
33
34/*
35 * libelf 0.8.x and earlier do not support ELF_C_READ_MMAP;
36 * for newer versions we can use mmap to reduce memory usage:
37 */
38#ifdef LIBELF_NO_MMAP
39# define PERF_ELF_C_READ_MMAP ELF_C_READ
40#else
41# define PERF_ELF_C_READ_MMAP ELF_C_READ_MMAP
42#endif
43
44#ifndef DMGL_PARAMS
45#define DMGL_PARAMS (1 << 0) /* Include function args */
46#define DMGL_ANSI (1 << 1) /* Include const, volatile, etc */
47#endif
48
49#define BUILD_ID_SIZE 20
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 bool ignore;
62 char name[0];
63};
64
65void symbol__delete(struct symbol *sym);
66
67struct strlist;
68
69struct symbol_conf {
70 unsigned short priv_size;
71 bool try_vmlinux_path,
72 use_modules,
73 sort_by_name,
74 show_nr_samples,
75 use_callchain,
76 exclude_other,
77 show_cpu_utilization,
78 initialized,
79 kptr_restrict;
80 const char *vmlinux_name,
81 *kallsyms_name,
82 *source_prefix,
83 *field_sep;
84 const char *default_guest_vmlinux_name,
85 *default_guest_kallsyms,
86 *default_guest_modules;
87 const char *guestmount;
88 const char *dso_list_str,
89 *comm_list_str,
90 *sym_list_str,
91 *col_width_list_str;
92 struct strlist *dso_list,
93 *comm_list,
94 *sym_list;
95 const char *symfs;
96};
97
98extern struct symbol_conf symbol_conf;
99
100static inline void *symbol__priv(struct symbol *sym)
101{
102 return ((void *)sym) - symbol_conf.priv_size;
103}
104
105struct ref_reloc_sym {
106 const char *name;
107 u64 addr;
108 u64 unrelocated_addr;
109};
110
111struct map_symbol {
112 struct map *map;
113 struct symbol *sym;
114 bool unfolded;
115 bool has_children;
116};
117
118struct addr_location {
119 struct thread *thread;
120 struct map *map;
121 struct symbol *sym;
122 u64 addr;
123 char level;
124 bool filtered;
125 u8 cpumode;
126 s32 cpu;
127};
128
129enum dso_kernel_type {
130 DSO_TYPE_USER = 0,
131 DSO_TYPE_KERNEL,
132 DSO_TYPE_GUEST_KERNEL
133};
134
135struct dso {
136 struct list_head node;
137 struct rb_root symbols[MAP__NR_TYPES];
138 struct rb_root symbol_names[MAP__NR_TYPES];
139 enum dso_kernel_type kernel;
140 u8 adjust_symbols:1;
141 u8 has_build_id:1;
142 u8 hit:1;
143 u8 annotate_warned:1;
144 u8 sname_alloc:1;
145 u8 lname_alloc:1;
146 unsigned char symtab_type;
147 u8 sorted_by_name;
148 u8 loaded;
149 u8 build_id[BUILD_ID_SIZE];
150 const char *short_name;
151 char *long_name;
152 u16 long_name_len;
153 u16 short_name_len;
154 char name[0];
155};
156
157struct dso *dso__new(const char *name);
158void dso__delete(struct dso *dso);
159
160int dso__name_len(const struct dso *dso);
161
162bool dso__loaded(const struct dso *dso, enum map_type type);
163bool dso__sorted_by_name(const struct dso *dso, enum map_type type);
164
165static inline void dso__set_loaded(struct dso *dso, enum map_type type)
166{
167 dso->loaded |= (1 << type);
168}
169
170void dso__sort_by_name(struct dso *dso, enum map_type type);
171
172struct dso *__dsos__findnew(struct list_head *head, const char *name);
173
174int dso__load(struct dso *dso, struct map *map, symbol_filter_t filter);
175int dso__load_vmlinux(struct dso *dso, struct map *map,
176 const char *vmlinux, symbol_filter_t filter);
177int dso__load_vmlinux_path(struct dso *dso, struct map *map,
178 symbol_filter_t filter);
179int dso__load_kallsyms(struct dso *dso, const char *filename, struct map *map,
180 symbol_filter_t filter);
181int machine__load_kallsyms(struct machine *machine, const char *filename,
182 enum map_type type, symbol_filter_t filter);
183int machine__load_vmlinux_path(struct machine *machine, enum map_type type,
184 symbol_filter_t filter);
185
186size_t __dsos__fprintf(struct list_head *head, FILE *fp);
187
188size_t machine__fprintf_dsos_buildid(struct machine *machine,
189 FILE *fp, bool with_hits);
190size_t machines__fprintf_dsos(struct rb_root *machines, FILE *fp);
191size_t machines__fprintf_dsos_buildid(struct rb_root *machines,
192 FILE *fp, bool with_hits);
193size_t dso__fprintf_buildid(struct dso *dso, FILE *fp);
194size_t dso__fprintf_symbols_by_name(struct dso *dso,
195 enum map_type type, FILE *fp);
196size_t dso__fprintf(struct dso *dso, enum map_type type, FILE *fp);
197
198enum symtab_type {
199 SYMTAB__KALLSYMS = 0,
200 SYMTAB__GUEST_KALLSYMS,
201 SYMTAB__JAVA_JIT,
202 SYMTAB__BUILD_ID_CACHE,
203 SYMTAB__FEDORA_DEBUGINFO,
204 SYMTAB__UBUNTU_DEBUGINFO,
205 SYMTAB__BUILDID_DEBUGINFO,
206 SYMTAB__SYSTEM_PATH_DSO,
207 SYMTAB__GUEST_KMODULE,
208 SYMTAB__SYSTEM_PATH_KMODULE,
209 SYMTAB__NOT_FOUND,
210};
211
212char dso__symtab_origin(const struct dso *dso);
213void dso__set_long_name(struct dso *dso, char *name);
214void dso__set_build_id(struct dso *dso, void *build_id);
215void dso__read_running_kernel_build_id(struct dso *dso,
216 struct machine *machine);
217struct symbol *dso__find_symbol(struct dso *dso, enum map_type type,
218 u64 addr);
219struct symbol *dso__find_symbol_by_name(struct dso *dso, enum map_type type,
220 const char *name);
221
222int filename__read_build_id(const char *filename, void *bf, size_t size);
223int sysfs__read_build_id(const char *filename, void *bf, size_t size);
224bool __dsos__read_build_ids(struct list_head *head, bool with_hits);
225int build_id__sprintf(const u8 *build_id, int len, char *bf);
226int kallsyms__parse(const char *filename, void *arg,
227 int (*process_symbol)(void *arg, const char *name,
228 char type, u64 start, u64 end));
229
230void machine__destroy_kernel_maps(struct machine *machine);
231int __machine__create_kernel_maps(struct machine *machine, struct dso *kernel);
232int machine__create_kernel_maps(struct machine *machine);
233
234int machines__create_kernel_maps(struct rb_root *machines, pid_t pid);
235int machines__create_guest_kernel_maps(struct rb_root *machines);
236void machines__destroy_guest_kernel_maps(struct rb_root *machines);
237
238int symbol__init(void);
239void symbol__exit(void);
240bool symbol_type__is_a(char symbol_type, enum map_type map_type);
241
242size_t machine__fprintf_vmlinux_path(struct machine *machine, FILE *fp);
243
244#endif /* __PERF_SYMBOL */