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