Loading...
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 "../perf.h"
9#include <linux/list.h>
10#include <linux/rbtree.h>
11#include <stdio.h>
12#include <byteswap.h>
13
14#ifdef HAVE_CPLUS_DEMANGLE
15extern char *cplus_demangle(const char *, int);
16
17static inline char *bfd_demangle(void __used *v, const char *c, int i)
18{
19 return cplus_demangle(c, i);
20}
21#else
22#ifdef NO_DEMANGLE
23static inline char *bfd_demangle(void __used *v, const char __used *c,
24 int __used i)
25{
26 return NULL;
27}
28#else
29#include <bfd.h>
30#endif
31#endif
32
33int hex2u64(const char *ptr, u64 *val);
34char *strxfrchar(char *s, char from, char to);
35
36/*
37 * libelf 0.8.x and earlier do not support ELF_C_READ_MMAP;
38 * for newer versions we can use mmap to reduce memory usage:
39 */
40#ifdef LIBELF_NO_MMAP
41# define PERF_ELF_C_READ_MMAP ELF_C_READ
42#else
43# define PERF_ELF_C_READ_MMAP ELF_C_READ_MMAP
44#endif
45
46#ifndef DMGL_PARAMS
47#define DMGL_PARAMS (1 << 0) /* Include function args */
48#define DMGL_ANSI (1 << 1) /* Include const, volatile, etc */
49#endif
50
51#define BUILD_ID_SIZE 20
52
53/** struct symbol - symtab entry
54 *
55 * @ignore - resolvable but tools ignore it (e.g. idle routines)
56 */
57struct symbol {
58 struct rb_node rb_node;
59 u64 start;
60 u64 end;
61 u16 namelen;
62 u8 binding;
63 bool ignore;
64 char name[0];
65};
66
67void symbol__delete(struct symbol *sym);
68
69static inline size_t symbol__size(const struct symbol *sym)
70{
71 return sym->end - sym->start + 1;
72}
73
74struct strlist;
75
76struct symbol_conf {
77 unsigned short priv_size;
78 unsigned short nr_events;
79 bool try_vmlinux_path,
80 show_kernel_path,
81 use_modules,
82 sort_by_name,
83 show_nr_samples,
84 show_total_period,
85 use_callchain,
86 exclude_other,
87 show_cpu_utilization,
88 initialized,
89 kptr_restrict,
90 annotate_asm_raw,
91 annotate_src;
92 const char *vmlinux_name,
93 *kallsyms_name,
94 *source_prefix,
95 *field_sep;
96 const char *default_guest_vmlinux_name,
97 *default_guest_kallsyms,
98 *default_guest_modules;
99 const char *guestmount;
100 const char *dso_list_str,
101 *comm_list_str,
102 *sym_list_str,
103 *col_width_list_str;
104 struct strlist *dso_list,
105 *comm_list,
106 *sym_list,
107 *dso_from_list,
108 *dso_to_list,
109 *sym_from_list,
110 *sym_to_list;
111 const char *symfs;
112};
113
114extern struct symbol_conf symbol_conf;
115
116static inline void *symbol__priv(struct symbol *sym)
117{
118 return ((void *)sym) - symbol_conf.priv_size;
119}
120
121struct ref_reloc_sym {
122 const char *name;
123 u64 addr;
124 u64 unrelocated_addr;
125};
126
127struct map_symbol {
128 struct map *map;
129 struct symbol *sym;
130 bool unfolded;
131 bool has_children;
132};
133
134struct addr_map_symbol {
135 struct map *map;
136 struct symbol *sym;
137 u64 addr;
138 u64 al_addr;
139};
140
141struct branch_info {
142 struct addr_map_symbol from;
143 struct addr_map_symbol to;
144 struct branch_flags flags;
145};
146
147struct addr_location {
148 struct thread *thread;
149 struct map *map;
150 struct symbol *sym;
151 u64 addr;
152 char level;
153 bool filtered;
154 u8 cpumode;
155 s32 cpu;
156};
157
158enum dso_kernel_type {
159 DSO_TYPE_USER = 0,
160 DSO_TYPE_KERNEL,
161 DSO_TYPE_GUEST_KERNEL
162};
163
164enum dso_swap_type {
165 DSO_SWAP__UNSET,
166 DSO_SWAP__NO,
167 DSO_SWAP__YES,
168};
169
170struct dso {
171 struct list_head node;
172 struct rb_root symbols[MAP__NR_TYPES];
173 struct rb_root symbol_names[MAP__NR_TYPES];
174 enum dso_kernel_type kernel;
175 enum dso_swap_type needs_swap;
176 u8 adjust_symbols:1;
177 u8 has_build_id:1;
178 u8 hit:1;
179 u8 annotate_warned:1;
180 u8 sname_alloc:1;
181 u8 lname_alloc:1;
182 unsigned char symtab_type;
183 u8 sorted_by_name;
184 u8 loaded;
185 u8 build_id[BUILD_ID_SIZE];
186 const char *short_name;
187 char *long_name;
188 u16 long_name_len;
189 u16 short_name_len;
190 char name[0];
191};
192
193#define DSO__SWAP(dso, type, val) \
194({ \
195 type ____r = val; \
196 BUG_ON(dso->needs_swap == DSO_SWAP__UNSET); \
197 if (dso->needs_swap == DSO_SWAP__YES) { \
198 switch (sizeof(____r)) { \
199 case 2: \
200 ____r = bswap_16(val); \
201 break; \
202 case 4: \
203 ____r = bswap_32(val); \
204 break; \
205 case 8: \
206 ____r = bswap_64(val); \
207 break; \
208 default: \
209 BUG_ON(1); \
210 } \
211 } \
212 ____r; \
213})
214
215struct dso *dso__new(const char *name);
216void dso__delete(struct dso *dso);
217
218int dso__name_len(const struct dso *dso);
219
220bool dso__loaded(const struct dso *dso, enum map_type type);
221bool dso__sorted_by_name(const struct dso *dso, enum map_type type);
222
223static inline void dso__set_loaded(struct dso *dso, enum map_type type)
224{
225 dso->loaded |= (1 << type);
226}
227
228void dso__sort_by_name(struct dso *dso, enum map_type type);
229
230struct dso *__dsos__findnew(struct list_head *head, const char *name);
231
232int dso__load(struct dso *dso, struct map *map, symbol_filter_t filter);
233int dso__load_vmlinux(struct dso *dso, struct map *map,
234 const char *vmlinux, symbol_filter_t filter);
235int dso__load_vmlinux_path(struct dso *dso, struct map *map,
236 symbol_filter_t filter);
237int dso__load_kallsyms(struct dso *dso, const char *filename, struct map *map,
238 symbol_filter_t filter);
239int machine__load_kallsyms(struct machine *machine, const char *filename,
240 enum map_type type, symbol_filter_t filter);
241int machine__load_vmlinux_path(struct machine *machine, enum map_type type,
242 symbol_filter_t filter);
243
244size_t __dsos__fprintf(struct list_head *head, FILE *fp);
245
246size_t machine__fprintf_dsos_buildid(struct machine *machine,
247 FILE *fp, bool with_hits);
248size_t machines__fprintf_dsos(struct rb_root *machines, FILE *fp);
249size_t machines__fprintf_dsos_buildid(struct rb_root *machines,
250 FILE *fp, bool with_hits);
251size_t dso__fprintf_buildid(struct dso *dso, FILE *fp);
252size_t dso__fprintf_symbols_by_name(struct dso *dso,
253 enum map_type type, FILE *fp);
254size_t dso__fprintf(struct dso *dso, enum map_type type, FILE *fp);
255
256enum symtab_type {
257 SYMTAB__KALLSYMS = 0,
258 SYMTAB__GUEST_KALLSYMS,
259 SYMTAB__JAVA_JIT,
260 SYMTAB__BUILD_ID_CACHE,
261 SYMTAB__FEDORA_DEBUGINFO,
262 SYMTAB__UBUNTU_DEBUGINFO,
263 SYMTAB__BUILDID_DEBUGINFO,
264 SYMTAB__SYSTEM_PATH_DSO,
265 SYMTAB__GUEST_KMODULE,
266 SYMTAB__SYSTEM_PATH_KMODULE,
267 SYMTAB__NOT_FOUND,
268};
269
270char dso__symtab_origin(const struct dso *dso);
271void dso__set_long_name(struct dso *dso, char *name);
272void dso__set_build_id(struct dso *dso, void *build_id);
273void dso__read_running_kernel_build_id(struct dso *dso,
274 struct machine *machine);
275struct map *dso__new_map(const char *name);
276struct symbol *dso__find_symbol(struct dso *dso, enum map_type type,
277 u64 addr);
278struct symbol *dso__find_symbol_by_name(struct dso *dso, enum map_type type,
279 const char *name);
280
281int filename__read_build_id(const char *filename, void *bf, size_t size);
282int sysfs__read_build_id(const char *filename, void *bf, size_t size);
283bool __dsos__read_build_ids(struct list_head *head, bool with_hits);
284int build_id__sprintf(const u8 *build_id, int len, char *bf);
285int kallsyms__parse(const char *filename, void *arg,
286 int (*process_symbol)(void *arg, const char *name,
287 char type, u64 start, u64 end));
288
289void machine__destroy_kernel_maps(struct machine *machine);
290int __machine__create_kernel_maps(struct machine *machine, struct dso *kernel);
291int machine__create_kernel_maps(struct machine *machine);
292
293int machines__create_kernel_maps(struct rb_root *machines, pid_t pid);
294int machines__create_guest_kernel_maps(struct rb_root *machines);
295void machines__destroy_guest_kernel_maps(struct rb_root *machines);
296
297int symbol__init(void);
298void symbol__exit(void);
299size_t symbol__fprintf_symname_offs(const struct symbol *sym,
300 const struct addr_location *al, FILE *fp);
301size_t symbol__fprintf_symname(const struct symbol *sym, FILE *fp);
302bool symbol_type__is_a(char symbol_type, enum map_type map_type);
303
304size_t machine__fprintf_vmlinux_path(struct machine *machine, FILE *fp);
305
306#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/**
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 */