xref: /openbmc/linux/tools/perf/util/symbol.h (revision b6bec26c)
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 
16 #ifdef LIBELF_SUPPORT
17 #include <libelf.h>
18 #include <gelf.h>
19 #include <elf.h>
20 #endif
21 
22 #include "dso.h"
23 
24 #ifdef HAVE_CPLUS_DEMANGLE
25 extern char *cplus_demangle(const char *, int);
26 
27 static inline char *bfd_demangle(void __maybe_unused *v, const char *c, int i)
28 {
29 	return cplus_demangle(c, i);
30 }
31 #else
32 #ifdef NO_DEMANGLE
33 static inline char *bfd_demangle(void __maybe_unused *v,
34 				 const char __maybe_unused *c,
35 				 int __maybe_unused i)
36 {
37 	return NULL;
38 }
39 #else
40 #define PACKAGE 'perf'
41 #include <bfd.h>
42 #endif
43 #endif
44 
45 /*
46  * libelf 0.8.x and earlier do not support ELF_C_READ_MMAP;
47  * for newer versions we can use mmap to reduce memory usage:
48  */
49 #ifdef LIBELF_MMAP
50 # define PERF_ELF_C_READ_MMAP ELF_C_READ_MMAP
51 #else
52 # define PERF_ELF_C_READ_MMAP ELF_C_READ
53 #endif
54 
55 #ifndef DMGL_PARAMS
56 #define DMGL_PARAMS      (1 << 0)       /* Include function args */
57 #define DMGL_ANSI        (1 << 1)       /* Include const, volatile, etc */
58 #endif
59 
60 /** struct symbol - symtab entry
61  *
62  * @ignore - resolvable but tools ignore it (e.g. idle routines)
63  */
64 struct symbol {
65 	struct rb_node	rb_node;
66 	u64		start;
67 	u64		end;
68 	u16		namelen;
69 	u8		binding;
70 	bool		ignore;
71 	char		name[0];
72 };
73 
74 void symbol__delete(struct symbol *sym);
75 void symbols__delete(struct rb_root *symbols);
76 
77 static inline size_t symbol__size(const struct symbol *sym)
78 {
79 	return sym->end - sym->start + 1;
80 }
81 
82 struct strlist;
83 
84 struct symbol_conf {
85 	unsigned short	priv_size;
86 	unsigned short	nr_events;
87 	bool		try_vmlinux_path,
88 			show_kernel_path,
89 			use_modules,
90 			sort_by_name,
91 			show_nr_samples,
92 			show_total_period,
93 			use_callchain,
94 			exclude_other,
95 			show_cpu_utilization,
96 			initialized,
97 			kptr_restrict,
98 			annotate_asm_raw,
99 			annotate_src;
100 	const char	*vmlinux_name,
101 			*kallsyms_name,
102 			*source_prefix,
103 			*field_sep;
104 	const char	*default_guest_vmlinux_name,
105 			*default_guest_kallsyms,
106 			*default_guest_modules;
107 	const char	*guestmount;
108 	const char	*dso_list_str,
109 			*comm_list_str,
110 			*sym_list_str,
111 			*col_width_list_str;
112        struct strlist	*dso_list,
113 			*comm_list,
114 			*sym_list,
115 			*dso_from_list,
116 			*dso_to_list,
117 			*sym_from_list,
118 			*sym_to_list;
119 	const char	*symfs;
120 };
121 
122 extern struct symbol_conf symbol_conf;
123 
124 static inline void *symbol__priv(struct symbol *sym)
125 {
126 	return ((void *)sym) - symbol_conf.priv_size;
127 }
128 
129 struct ref_reloc_sym {
130 	const char	*name;
131 	u64		addr;
132 	u64		unrelocated_addr;
133 };
134 
135 struct map_symbol {
136 	struct map    *map;
137 	struct symbol *sym;
138 	bool	      unfolded;
139 	bool	      has_children;
140 };
141 
142 struct addr_map_symbol {
143 	struct map    *map;
144 	struct symbol *sym;
145 	u64	      addr;
146 	u64	      al_addr;
147 };
148 
149 struct branch_info {
150 	struct addr_map_symbol from;
151 	struct addr_map_symbol to;
152 	struct branch_flags flags;
153 };
154 
155 struct addr_location {
156 	struct thread *thread;
157 	struct map    *map;
158 	struct symbol *sym;
159 	u64	      addr;
160 	char	      level;
161 	bool	      filtered;
162 	u8	      cpumode;
163 	s32	      cpu;
164 };
165 
166 struct symsrc {
167 	char *name;
168 	int fd;
169 	enum dso_binary_type type;
170 
171 #ifdef LIBELF_SUPPORT
172 	Elf *elf;
173 	GElf_Ehdr ehdr;
174 
175 	Elf_Scn *opdsec;
176 	size_t opdidx;
177 	GElf_Shdr opdshdr;
178 
179 	Elf_Scn *symtab;
180 	GElf_Shdr symshdr;
181 
182 	Elf_Scn *dynsym;
183 	size_t dynsym_idx;
184 	GElf_Shdr dynshdr;
185 
186 	bool adjust_symbols;
187 #endif
188 };
189 
190 void symsrc__destroy(struct symsrc *ss);
191 int symsrc__init(struct symsrc *ss, struct dso *dso, const char *name,
192 		 enum dso_binary_type type);
193 bool symsrc__has_symtab(struct symsrc *ss);
194 bool symsrc__possibly_runtime(struct symsrc *ss);
195 
196 int dso__load(struct dso *dso, struct map *map, symbol_filter_t filter);
197 int dso__load_vmlinux(struct dso *dso, struct map *map,
198 		      const char *vmlinux, symbol_filter_t filter);
199 int dso__load_vmlinux_path(struct dso *dso, struct map *map,
200 			   symbol_filter_t filter);
201 int dso__load_kallsyms(struct dso *dso, const char *filename, struct map *map,
202 		       symbol_filter_t filter);
203 
204 struct symbol *dso__find_symbol(struct dso *dso, enum map_type type,
205 				u64 addr);
206 struct symbol *dso__find_symbol_by_name(struct dso *dso, enum map_type type,
207 					const char *name);
208 
209 int filename__read_build_id(const char *filename, void *bf, size_t size);
210 int sysfs__read_build_id(const char *filename, void *bf, size_t size);
211 int kallsyms__parse(const char *filename, void *arg,
212 		    int (*process_symbol)(void *arg, const char *name,
213 					  char type, u64 start));
214 int filename__read_debuglink(const char *filename, char *debuglink,
215 			     size_t size);
216 
217 int symbol__init(void);
218 void symbol__exit(void);
219 void symbol__elf_init(void);
220 struct symbol *symbol__new(u64 start, u64 len, u8 binding, const char *name);
221 size_t symbol__fprintf_symname_offs(const struct symbol *sym,
222 				    const struct addr_location *al, FILE *fp);
223 size_t symbol__fprintf_symname(const struct symbol *sym, FILE *fp);
224 size_t symbol__fprintf(struct symbol *sym, FILE *fp);
225 bool symbol_type__is_a(char symbol_type, enum map_type map_type);
226 
227 int dso__load_sym(struct dso *dso, struct map *map, struct symsrc *syms_ss,
228 		  struct symsrc *runtime_ss, symbol_filter_t filter,
229 		  int kmodule);
230 int dso__synthesize_plt_symbols(struct dso *dso, struct symsrc *ss,
231 				struct map *map, symbol_filter_t filter);
232 
233 void symbols__insert(struct rb_root *symbols, struct symbol *sym);
234 void symbols__fixup_duplicate(struct rb_root *symbols);
235 void symbols__fixup_end(struct rb_root *symbols);
236 void __map_groups__fixup_end(struct map_groups *mg, enum map_type type);
237 
238 #endif /* __PERF_SYMBOL */
239