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