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