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
37extern 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 */
51struct 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
61void symbol__delete(struct symbol *sym);
62void 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
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_conf {
84	unsigned short	priv_size;
85	unsigned short	nr_events;
86	bool		try_vmlinux_path,
87			ignore_vmlinux,
88			ignore_vmlinux_buildid,
89			show_kernel_path,
90			use_modules,
91			allow_aliases,
92			sort_by_name,
93			show_nr_samples,
94			show_total_period,
95			use_callchain,
96			cumulate_callchain,
97			exclude_other,
98			show_cpu_utilization,
99			initialized,
100			kptr_restrict,
101			annotate_asm_raw,
102			annotate_src,
103			event_group,
104			demangle,
105			demangle_kernel,
106			filter_relative,
107			show_hist_headers,
108			branch_callstack,
109			has_filter;
110	const char	*vmlinux_name,
111			*kallsyms_name,
112			*source_prefix,
113			*field_sep;
114	const char	*default_guest_vmlinux_name,
115			*default_guest_kallsyms,
116			*default_guest_modules;
117	const char	*guestmount;
118	const char	*dso_list_str,
119			*comm_list_str,
120			*pid_list_str,
121			*tid_list_str,
122			*sym_list_str,
123			*col_width_list_str;
124       struct strlist	*dso_list,
125			*comm_list,
126			*sym_list,
127			*dso_from_list,
128			*dso_to_list,
129			*sym_from_list,
130			*sym_to_list;
131	struct intlist	*pid_list,
132			*tid_list;
133	const char	*symfs;
134};
135
136extern struct symbol_conf symbol_conf;
137
138static inline int __symbol__join_symfs(char *bf, size_t size, const char *path)
139{
140	return path__join(bf, size, symbol_conf.symfs, path);
141}
142
143#define symbol__join_symfs(bf, path) __symbol__join_symfs(bf, sizeof(bf), path)
144
145extern int vmlinux_path__nr_entries;
146extern char **vmlinux_path;
147
148static inline void *symbol__priv(struct symbol *sym)
149{
150	return ((void *)sym) - symbol_conf.priv_size;
151}
152
153struct ref_reloc_sym {
154	const char	*name;
155	u64		addr;
156	u64		unrelocated_addr;
157};
158
159struct map_symbol {
160	struct map    *map;
161	struct symbol *sym;
162	bool	      unfolded;
163	bool	      has_children;
164};
165
166struct addr_map_symbol {
167	struct map    *map;
168	struct symbol *sym;
169	u64	      addr;
170	u64	      al_addr;
171};
172
173struct branch_info {
174	struct addr_map_symbol from;
175	struct addr_map_symbol to;
176	struct branch_flags flags;
177};
178
179struct mem_info {
180	struct addr_map_symbol iaddr;
181	struct addr_map_symbol daddr;
182	union perf_mem_data_src data_src;
183};
184
185struct 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};
196
197struct symsrc {
198	char *name;
199	int fd;
200	enum dso_binary_type type;
201
202#ifdef HAVE_LIBELF_SUPPORT
203	Elf *elf;
204	GElf_Ehdr ehdr;
205
206	Elf_Scn *opdsec;
207	size_t opdidx;
208	GElf_Shdr opdshdr;
209
210	Elf_Scn *symtab;
211	GElf_Shdr symshdr;
212
213	Elf_Scn *dynsym;
214	size_t dynsym_idx;
215	GElf_Shdr dynshdr;
216
217	bool adjust_symbols;
218	bool is_64_bit;
219#endif
220};
221
222void symsrc__destroy(struct symsrc *ss);
223int symsrc__init(struct symsrc *ss, struct dso *dso, const char *name,
224		 enum dso_binary_type type);
225bool symsrc__has_symtab(struct symsrc *ss);
226bool symsrc__possibly_runtime(struct symsrc *ss);
227
228int dso__load(struct dso *dso, struct map *map, symbol_filter_t filter);
229int dso__load_vmlinux(struct dso *dso, struct map *map,
230		      const char *vmlinux, bool vmlinux_allocated,
231		      symbol_filter_t filter);
232int dso__load_vmlinux_path(struct dso *dso, struct map *map,
233			   symbol_filter_t filter);
234int dso__load_kallsyms(struct dso *dso, const char *filename, struct map *map,
235		       symbol_filter_t filter);
236
237struct symbol *dso__find_symbol(struct dso *dso, enum map_type type,
238				u64 addr);
239struct symbol *dso__find_symbol_by_name(struct dso *dso, enum map_type type,
240					const char *name);
241struct symbol *symbol__next_by_name(struct symbol *sym);
242
243struct symbol *dso__first_symbol(struct dso *dso, enum map_type type);
244struct symbol *dso__next_symbol(struct symbol *sym);
245
246enum dso_type dso__type_fd(int fd);
247
248int filename__read_build_id(const char *filename, void *bf, size_t size);
249int sysfs__read_build_id(const char *filename, void *bf, size_t size);
250int modules__parse(const char *filename, void *arg,
251		   int (*process_module)(void *arg, const char *name,
252					 u64 start));
253int filename__read_debuglink(const char *filename, char *debuglink,
254			     size_t size);
255
256struct perf_session_env;
257int symbol__init(struct perf_session_env *env);
258void symbol__exit(void);
259void symbol__elf_init(void);
260struct symbol *symbol__new(u64 start, u64 len, u8 binding, const char *name);
261size_t symbol__fprintf_symname_offs(const struct symbol *sym,
262				    const struct addr_location *al, FILE *fp);
263size_t symbol__fprintf_symname(const struct symbol *sym, FILE *fp);
264size_t symbol__fprintf(struct symbol *sym, FILE *fp);
265bool symbol_type__is_a(char symbol_type, enum map_type map_type);
266bool symbol__restricted_filename(const char *filename,
267				 const char *restricted_filename);
268bool symbol__is_idle(struct symbol *sym);
269
270int dso__load_sym(struct dso *dso, struct map *map, struct symsrc *syms_ss,
271		  struct symsrc *runtime_ss, symbol_filter_t filter,
272		  int kmodule);
273int dso__synthesize_plt_symbols(struct dso *dso, struct symsrc *ss,
274				struct map *map, symbol_filter_t filter);
275
276void symbols__insert(struct rb_root *symbols, struct symbol *sym);
277void symbols__fixup_duplicate(struct rb_root *symbols);
278void symbols__fixup_end(struct rb_root *symbols);
279void __map_groups__fixup_end(struct map_groups *mg, enum map_type type);
280
281typedef int (*mapfn_t)(u64 start, u64 len, u64 pgoff, void *data);
282int file__read_maps(int fd, bool exe, mapfn_t mapfn, void *data,
283		    bool *is_64_bit);
284
285#define PERF_KCORE_EXTRACT "/tmp/perf-kcore-XXXXXX"
286
287struct kcore_extract {
288	char *kcore_filename;
289	u64 addr;
290	u64 offs;
291	u64 len;
292	char extract_filename[sizeof(PERF_KCORE_EXTRACT)];
293	int fd;
294};
295
296int kcore_extract__create(struct kcore_extract *kce);
297void kcore_extract__delete(struct kcore_extract *kce);
298
299int kcore_copy(const char *from_dir, const char *to_dir);
300int compare_proc_modules(const char *from, const char *to);
301
302int setup_list(struct strlist **list, const char *list_str,
303	       const char *list_name);
304int setup_intlist(struct intlist **list, const char *list_str,
305		  const char *list_name);
306
307#endif /* __PERF_SYMBOL */
308