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/* 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;
26struct build_id;
27
28/*
29 * libelf 0.8.x and earlier do not support ELF_C_READ_MMAP;
30 * for newer versions we can use mmap to reduce memory usage:
31 */
32#ifdef ELF_C_READ_MMAP
33# define PERF_ELF_C_READ_MMAP ELF_C_READ_MMAP
34#else
35# define PERF_ELF_C_READ_MMAP ELF_C_READ
36#endif
37
38#ifdef HAVE_LIBELF_SUPPORT
39Elf_Scn *elf_section_by_name(Elf *elf, GElf_Ehdr *ep,
40 GElf_Shdr *shp, const char *name, size_t *idx);
41#endif
42
43/** struct symbol - symtab entry
44 *
45 * @ignore - resolvable but tools ignore it (e.g. idle routines)
46 */
47struct symbol {
48 struct rb_node rb_node;
49 u64 start;
50 u64 end;
51 u16 namelen;
52 u8 type:4;
53 u8 binding:4;
54 u8 idle:1;
55 u8 ignore:1;
56 u8 inlined:1;
57 u8 arch_sym;
58 bool annotate2;
59 char name[];
60};
61
62void symbol__delete(struct symbol *sym);
63void symbols__delete(struct rb_root_cached *symbols);
64
65/* symbols__for_each_entry - iterate over symbols (rb_root)
66 *
67 * @symbols: the rb_root of symbols
68 * @pos: the 'struct symbol *' to use as a loop cursor
69 * @nd: the 'struct rb_node *' to use as a temporary storage
70 */
71#define symbols__for_each_entry(symbols, pos, nd) \
72 for (nd = rb_first_cached(symbols); \
73 nd && (pos = rb_entry(nd, struct symbol, rb_node)); \
74 nd = rb_next(nd))
75
76static inline size_t symbol__size(const struct symbol *sym)
77{
78 return sym->end - sym->start;
79}
80
81struct strlist;
82struct intlist;
83
84struct symbol_name_rb_node {
85 struct rb_node rb_node;
86 struct symbol sym;
87};
88
89static inline int __symbol__join_symfs(char *bf, size_t size, const char *path)
90{
91 return path__join(bf, size, symbol_conf.symfs, path);
92}
93
94#define symbol__join_symfs(bf, path) __symbol__join_symfs(bf, sizeof(bf), path)
95
96extern int vmlinux_path__nr_entries;
97extern char **vmlinux_path;
98
99static inline void *symbol__priv(struct symbol *sym)
100{
101 return ((void *)sym) - symbol_conf.priv_size;
102}
103
104struct ref_reloc_sym {
105 const char *name;
106 u64 addr;
107 u64 unrelocated_addr;
108};
109
110struct addr_location {
111 struct thread *thread;
112 struct maps *maps;
113 struct map *map;
114 struct symbol *sym;
115 const char *srcline;
116 u64 addr;
117 char level;
118 u8 filtered;
119 u8 cpumode;
120 s32 cpu;
121 s32 socket;
122};
123
124int dso__load(struct dso *dso, struct map *map);
125int dso__load_vmlinux(struct dso *dso, struct map *map,
126 const char *vmlinux, bool vmlinux_allocated);
127int dso__load_vmlinux_path(struct dso *dso, struct map *map);
128int __dso__load_kallsyms(struct dso *dso, const char *filename, struct map *map,
129 bool no_kcore);
130int dso__load_kallsyms(struct dso *dso, const char *filename, struct map *map);
131
132void dso__insert_symbol(struct dso *dso,
133 struct symbol *sym);
134void dso__delete_symbol(struct dso *dso,
135 struct symbol *sym);
136
137struct symbol *dso__find_symbol(struct dso *dso, u64 addr);
138struct symbol *dso__find_symbol_by_name(struct dso *dso, const char *name);
139
140struct symbol *symbol__next_by_name(struct symbol *sym);
141
142struct symbol *dso__first_symbol(struct dso *dso);
143struct symbol *dso__last_symbol(struct dso *dso);
144struct symbol *dso__next_symbol(struct symbol *sym);
145
146enum dso_type dso__type_fd(int fd);
147
148int filename__read_build_id(const char *filename, struct build_id *id);
149int sysfs__read_build_id(const char *filename, struct build_id *bid);
150int modules__parse(const char *filename, void *arg,
151 int (*process_module)(void *arg, const char *name,
152 u64 start, u64 size));
153int filename__read_debuglink(const char *filename, char *debuglink,
154 size_t size);
155
156struct perf_env;
157int symbol__init(struct perf_env *env);
158void symbol__exit(void);
159void symbol__elf_init(void);
160int symbol__annotation_init(void);
161
162struct symbol *symbol__new(u64 start, u64 len, u8 binding, u8 type, const char *name);
163size_t __symbol__fprintf_symname_offs(const struct symbol *sym,
164 const struct addr_location *al,
165 bool unknown_as_addr,
166 bool print_offsets, FILE *fp);
167size_t symbol__fprintf_symname_offs(const struct symbol *sym,
168 const struct addr_location *al, FILE *fp);
169size_t __symbol__fprintf_symname(const struct symbol *sym,
170 const struct addr_location *al,
171 bool unknown_as_addr, FILE *fp);
172size_t symbol__fprintf_symname(const struct symbol *sym, FILE *fp);
173size_t symbol__fprintf(struct symbol *sym, FILE *fp);
174bool symbol__restricted_filename(const char *filename,
175 const char *restricted_filename);
176int symbol__config_symfs(const struct option *opt __maybe_unused,
177 const char *dir, int unset __maybe_unused);
178
179struct symsrc;
180
181#ifdef HAVE_LIBBFD_SUPPORT
182int dso__load_bfd_symbols(struct dso *dso, const char *debugfile);
183#endif
184
185int dso__load_sym(struct dso *dso, struct map *map, struct symsrc *syms_ss,
186 struct symsrc *runtime_ss, int kmodule);
187int dso__synthesize_plt_symbols(struct dso *dso, struct symsrc *ss);
188
189char *dso__demangle_sym(struct dso *dso, int kmodule, const char *elf_name);
190
191void __symbols__insert(struct rb_root_cached *symbols, struct symbol *sym,
192 bool kernel);
193void symbols__insert(struct rb_root_cached *symbols, struct symbol *sym);
194void symbols__fixup_duplicate(struct rb_root_cached *symbols);
195void symbols__fixup_end(struct rb_root_cached *symbols);
196void maps__fixup_end(struct maps *maps);
197
198typedef int (*mapfn_t)(u64 start, u64 len, u64 pgoff, void *data);
199int file__read_maps(int fd, bool exe, mapfn_t mapfn, void *data,
200 bool *is_64_bit);
201
202#define PERF_KCORE_EXTRACT "/tmp/perf-kcore-XXXXXX"
203
204struct kcore_extract {
205 char *kcore_filename;
206 u64 addr;
207 u64 offs;
208 u64 len;
209 char extract_filename[sizeof(PERF_KCORE_EXTRACT)];
210 int fd;
211};
212
213int kcore_extract__create(struct kcore_extract *kce);
214void kcore_extract__delete(struct kcore_extract *kce);
215
216int kcore_copy(const char *from_dir, const char *to_dir);
217int compare_proc_modules(const char *from, const char *to);
218
219int setup_list(struct strlist **list, const char *list_str,
220 const char *list_name);
221int setup_intlist(struct intlist **list, const char *list_str,
222 const char *list_name);
223
224#ifdef HAVE_LIBELF_SUPPORT
225bool elf__needs_adjust_symbols(GElf_Ehdr ehdr);
226void arch__sym_update(struct symbol *s, GElf_Sym *sym);
227#endif
228
229const char *arch__normalize_symbol_name(const char *name);
230#define SYMBOL_A 0
231#define SYMBOL_B 1
232
233void arch__symbols__fixup_end(struct symbol *p, struct symbol *c);
234int arch__compare_symbol_names(const char *namea, const char *nameb);
235int arch__compare_symbol_names_n(const char *namea, const char *nameb,
236 unsigned int n);
237int arch__choose_best_symbol(struct symbol *syma, struct symbol *symb);
238
239enum symbol_tag_include {
240 SYMBOL_TAG_INCLUDE__NONE = 0,
241 SYMBOL_TAG_INCLUDE__DEFAULT_ONLY
242};
243
244int symbol__match_symbol_name(const char *namea, const char *nameb,
245 enum symbol_tag_include includes);
246
247/* structure containing an SDT note's info */
248struct sdt_note {
249 char *name; /* name of the note*/
250 char *provider; /* provider name */
251 char *args;
252 bool bit32; /* whether the location is 32 bits? */
253 union { /* location, base and semaphore addrs */
254 Elf64_Addr a64[3];
255 Elf32_Addr a32[3];
256 } addr;
257 struct list_head note_list; /* SDT notes' list */
258};
259
260int get_sdt_note_list(struct list_head *head, const char *target);
261int cleanup_sdt_note_list(struct list_head *sdt_notes);
262int sdt_notes__get_count(struct list_head *start);
263
264#define SDT_PROBES_SCN ".probes"
265#define SDT_BASE_SCN ".stapsdt.base"
266#define SDT_NOTE_SCN ".note.stapsdt"
267#define SDT_NOTE_TYPE 3
268#define SDT_NOTE_NAME "stapsdt"
269#define NR_ADDR 3
270
271enum {
272 SDT_NOTE_IDX_LOC = 0,
273 SDT_NOTE_IDX_BASE,
274 SDT_NOTE_IDX_REFCTR,
275};
276
277struct mem_info *mem_info__new(void);
278struct mem_info *mem_info__get(struct mem_info *mi);
279void mem_info__put(struct mem_info *mi);
280
281static inline void __mem_info__zput(struct mem_info **mi)
282{
283 mem_info__put(*mi);
284 *mi = NULL;
285}
286
287#define mem_info__zput(mi) __mem_info__zput(&mi)
288
289#endif /* __PERF_SYMBOL */