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 #include <libgen.h>
14 #include "build-id.h"
15 #include "event.h"
16 #include "util.h"
17
18 #ifdef HAVE_LIBELF_SUPPORT
19 #include <libelf.h>
20 #include <gelf.h>
21 #endif
22 #include <elf.h>
23
24 #include "dso.h"
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
37 extern Elf_Scn *elf_section_by_name(Elf *elf, GElf_Ehdr *ep,
38 GElf_Shdr *shp, const char *name, size_t *idx);
39 #endif
40
41 #ifndef DMGL_PARAMS
42 #define DMGL_NO_OPTS 0 /* For readability... */
43 #define DMGL_PARAMS (1 << 0) /* Include function args */
44 #define DMGL_ANSI (1 << 1) /* Include const, volatile, etc */
45 #endif
46
47 /** struct symbol - symtab entry
48 *
49 * @ignore - resolvable but tools ignore it (e.g. idle routines)
50 */
51 struct symbol {
52 struct rb_node rb_node;
53 u64 start;
54 u64 end;
55 u16 namelen;
56 u8 binding;
57 bool ignore;
58 char name[0];
59 };
60
61 void symbol__delete(struct symbol *sym);
62 void symbols__delete(struct rb_root *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(symbols); \
72 nd && (pos = rb_entry(nd, struct symbol, rb_node)); \
73 nd = rb_next(nd))
74
symbol__size(const struct symbol * sym)75 static inline size_t symbol__size(const struct symbol *sym)
76 {
77 return sym->end - sym->start;
78 }
79
80 struct strlist;
81 struct intlist;
82
83 struct symbol_conf {
84 unsigned short priv_size;
85 unsigned short nr_events;
86 bool try_vmlinux_path,
87 force,
88 ignore_vmlinux,
89 ignore_vmlinux_buildid,
90 show_kernel_path,
91 use_modules,
92 allow_aliases,
93 sort_by_name,
94 show_nr_samples,
95 show_total_period,
96 use_callchain,
97 cumulate_callchain,
98 exclude_other,
99 show_cpu_utilization,
100 initialized,
101 kptr_restrict,
102 annotate_asm_raw,
103 annotate_src,
104 event_group,
105 demangle,
106 demangle_kernel,
107 filter_relative,
108 show_hist_headers,
109 branch_callstack,
110 has_filter,
111 show_ref_callgraph;
112 const char *vmlinux_name,
113 *kallsyms_name,
114 *source_prefix,
115 *field_sep;
116 const char *default_guest_vmlinux_name,
117 *default_guest_kallsyms,
118 *default_guest_modules;
119 const char *guestmount;
120 const char *dso_list_str,
121 *comm_list_str,
122 *pid_list_str,
123 *tid_list_str,
124 *sym_list_str,
125 *col_width_list_str;
126 struct strlist *dso_list,
127 *comm_list,
128 *sym_list,
129 *dso_from_list,
130 *dso_to_list,
131 *sym_from_list,
132 *sym_to_list;
133 struct intlist *pid_list,
134 *tid_list;
135 const char *symfs;
136 };
137
138 extern struct symbol_conf symbol_conf;
139
__symbol__join_symfs(char * bf,size_t size,const char * path)140 static inline int __symbol__join_symfs(char *bf, size_t size, const char *path)
141 {
142 return path__join(bf, size, symbol_conf.symfs, path);
143 }
144
145 #define symbol__join_symfs(bf, path) __symbol__join_symfs(bf, sizeof(bf), path)
146
147 extern int vmlinux_path__nr_entries;
148 extern char **vmlinux_path;
149
symbol__priv(struct symbol * sym)150 static inline void *symbol__priv(struct symbol *sym)
151 {
152 return ((void *)sym) - symbol_conf.priv_size;
153 }
154
155 struct ref_reloc_sym {
156 const char *name;
157 u64 addr;
158 u64 unrelocated_addr;
159 };
160
161 struct map_symbol {
162 struct map *map;
163 struct symbol *sym;
164 };
165
166 struct addr_map_symbol {
167 struct map *map;
168 struct symbol *sym;
169 u64 addr;
170 u64 al_addr;
171 };
172
173 struct branch_info {
174 struct addr_map_symbol from;
175 struct addr_map_symbol to;
176 struct branch_flags flags;
177 };
178
179 struct mem_info {
180 struct addr_map_symbol iaddr;
181 struct addr_map_symbol daddr;
182 union perf_mem_data_src data_src;
183 };
184
185 struct addr_location {
186 struct machine *machine;
187 struct thread *thread;
188 struct map *map;
189 struct symbol *sym;
190 u64 addr;
191 char level;
192 u8 filtered;
193 u8 cpumode;
194 s32 cpu;
195 s32 socket;
196 };
197
198 struct symsrc {
199 char *name;
200 int fd;
201 enum dso_binary_type type;
202
203 #ifdef HAVE_LIBELF_SUPPORT
204 Elf *elf;
205 GElf_Ehdr ehdr;
206
207 Elf_Scn *opdsec;
208 size_t opdidx;
209 GElf_Shdr opdshdr;
210
211 Elf_Scn *symtab;
212 GElf_Shdr symshdr;
213
214 Elf_Scn *dynsym;
215 size_t dynsym_idx;
216 GElf_Shdr dynshdr;
217
218 bool adjust_symbols;
219 bool is_64_bit;
220 #endif
221 };
222
223 void symsrc__destroy(struct symsrc *ss);
224 int symsrc__init(struct symsrc *ss, struct dso *dso, const char *name,
225 enum dso_binary_type type);
226 bool symsrc__has_symtab(struct symsrc *ss);
227 bool symsrc__possibly_runtime(struct symsrc *ss);
228
229 int dso__load(struct dso *dso, struct map *map, symbol_filter_t filter);
230 int dso__load_vmlinux(struct dso *dso, struct map *map,
231 const char *vmlinux, bool vmlinux_allocated,
232 symbol_filter_t filter);
233 int dso__load_vmlinux_path(struct dso *dso, struct map *map,
234 symbol_filter_t filter);
235 int dso__load_kallsyms(struct dso *dso, const char *filename, struct map *map,
236 symbol_filter_t filter);
237
238 struct symbol *dso__find_symbol(struct dso *dso, enum map_type type,
239 u64 addr);
240 struct symbol *dso__find_symbol_by_name(struct dso *dso, enum map_type type,
241 const char *name);
242 struct symbol *symbol__next_by_name(struct symbol *sym);
243
244 struct symbol *dso__first_symbol(struct dso *dso, enum map_type type);
245 struct symbol *dso__next_symbol(struct symbol *sym);
246
247 enum dso_type dso__type_fd(int fd);
248
249 int filename__read_build_id(const char *filename, void *bf, size_t size);
250 int sysfs__read_build_id(const char *filename, void *bf, size_t size);
251 int modules__parse(const char *filename, void *arg,
252 int (*process_module)(void *arg, const char *name,
253 u64 start));
254 int filename__read_debuglink(const char *filename, char *debuglink,
255 size_t size);
256
257 struct perf_env;
258 int symbol__init(struct perf_env *env);
259 void symbol__exit(void);
260 void symbol__elf_init(void);
261 struct symbol *symbol__new(u64 start, u64 len, u8 binding, const char *name);
262 size_t symbol__fprintf_symname_offs(const struct symbol *sym,
263 const struct addr_location *al, FILE *fp);
264 size_t symbol__fprintf_symname(const struct symbol *sym, FILE *fp);
265 size_t symbol__fprintf(struct symbol *sym, FILE *fp);
266 bool symbol_type__is_a(char symbol_type, enum map_type map_type);
267 bool symbol__restricted_filename(const char *filename,
268 const char *restricted_filename);
269 bool symbol__is_idle(struct symbol *sym);
270
271 int dso__load_sym(struct dso *dso, struct map *map, struct symsrc *syms_ss,
272 struct symsrc *runtime_ss, symbol_filter_t filter,
273 int kmodule);
274 int dso__synthesize_plt_symbols(struct dso *dso, struct symsrc *ss,
275 struct map *map, symbol_filter_t filter);
276
277 void symbols__insert(struct rb_root *symbols, struct symbol *sym);
278 void symbols__fixup_duplicate(struct rb_root *symbols);
279 void symbols__fixup_end(struct rb_root *symbols);
280 void __map_groups__fixup_end(struct map_groups *mg, enum map_type type);
281
282 typedef int (*mapfn_t)(u64 start, u64 len, u64 pgoff, void *data);
283 int file__read_maps(int fd, bool exe, mapfn_t mapfn, void *data,
284 bool *is_64_bit);
285
286 #define PERF_KCORE_EXTRACT "/tmp/perf-kcore-XXXXXX"
287
288 struct kcore_extract {
289 char *kcore_filename;
290 u64 addr;
291 u64 offs;
292 u64 len;
293 char extract_filename[sizeof(PERF_KCORE_EXTRACT)];
294 int fd;
295 };
296
297 int kcore_extract__create(struct kcore_extract *kce);
298 void kcore_extract__delete(struct kcore_extract *kce);
299
300 int kcore_copy(const char *from_dir, const char *to_dir);
301 int compare_proc_modules(const char *from, const char *to);
302
303 int setup_list(struct strlist **list, const char *list_str,
304 const char *list_name);
305 int setup_intlist(struct intlist **list, const char *list_str,
306 const char *list_name);
307
308 #ifdef HAVE_LIBELF_SUPPORT
309 bool elf__needs_adjust_symbols(GElf_Ehdr ehdr);
310 void arch__elf_sym_adjust(GElf_Sym *sym);
311 #endif
312
313 #define SYMBOL_A 0
314 #define SYMBOL_B 1
315
316 int arch__choose_best_symbol(struct symbol *syma, struct symbol *symb);
317
318 #endif /* __PERF_SYMBOL */
319