xref: /linux/tools/perf/util/symbol.h (revision 12871a0bd67dd4db4418e1daafcd46e9d329ef10)
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 <linux/list.h>
9 #include <linux/rbtree.h>
10 #include <stdio.h>
11 
12 #ifdef HAVE_CPLUS_DEMANGLE
13 extern char *cplus_demangle(const char *, int);
14 
15 static inline char *bfd_demangle(void __used *v, const char *c, int i)
16 {
17 	return cplus_demangle(c, i);
18 }
19 #else
20 #ifdef NO_DEMANGLE
21 static inline char *bfd_demangle(void __used *v, const char __used *c,
22 				 int __used i)
23 {
24 	return NULL;
25 }
26 #else
27 #include <bfd.h>
28 #endif
29 #endif
30 
31 int hex2u64(const char *ptr, u64 *val);
32 char *strxfrchar(char *s, char from, char to);
33 
34 /*
35  * libelf 0.8.x and earlier do not support ELF_C_READ_MMAP;
36  * for newer versions we can use mmap to reduce memory usage:
37  */
38 #ifdef LIBELF_NO_MMAP
39 # define PERF_ELF_C_READ_MMAP ELF_C_READ
40 #else
41 # define PERF_ELF_C_READ_MMAP ELF_C_READ_MMAP
42 #endif
43 
44 #ifndef DMGL_PARAMS
45 #define DMGL_PARAMS      (1 << 0)       /* Include function args */
46 #define DMGL_ANSI        (1 << 1)       /* Include const, volatile, etc */
47 #endif
48 
49 #define BUILD_ID_SIZE 20
50 
51 /** struct symbol - symtab entry
52  *
53  * @ignore - resolvable but tools ignore it (e.g. idle routines)
54  */
55 struct symbol {
56 	struct rb_node	rb_node;
57 	u64		start;
58 	u64		end;
59 	u16		namelen;
60 	u8		binding;
61 	bool		ignore;
62 	char		name[0];
63 };
64 
65 void symbol__delete(struct symbol *sym);
66 
67 struct strlist;
68 
69 struct symbol_conf {
70 	unsigned short	priv_size;
71 	bool		try_vmlinux_path,
72 			use_modules,
73 			sort_by_name,
74 			show_nr_samples,
75 			use_callchain,
76 			exclude_other,
77 			show_cpu_utilization,
78 			initialized,
79 			kptr_restrict;
80 	const char	*vmlinux_name,
81 			*kallsyms_name,
82 			*source_prefix,
83 			*field_sep;
84 	const char	*default_guest_vmlinux_name,
85 			*default_guest_kallsyms,
86 			*default_guest_modules;
87 	const char	*guestmount;
88 	const char	*dso_list_str,
89 			*comm_list_str,
90 			*sym_list_str,
91 			*col_width_list_str;
92        struct strlist	*dso_list,
93 			*comm_list,
94 			*sym_list;
95 	const char	*symfs;
96 };
97 
98 extern struct symbol_conf symbol_conf;
99 
100 static inline void *symbol__priv(struct symbol *sym)
101 {
102 	return ((void *)sym) - symbol_conf.priv_size;
103 }
104 
105 struct ref_reloc_sym {
106 	const char	*name;
107 	u64		addr;
108 	u64		unrelocated_addr;
109 };
110 
111 struct map_symbol {
112 	struct map    *map;
113 	struct symbol *sym;
114 	bool	      unfolded;
115 	bool	      has_children;
116 };
117 
118 struct addr_location {
119 	struct thread *thread;
120 	struct map    *map;
121 	struct symbol *sym;
122 	u64	      addr;
123 	char	      level;
124 	bool	      filtered;
125 	u8	      cpumode;
126 	s32	      cpu;
127 };
128 
129 enum dso_kernel_type {
130 	DSO_TYPE_USER = 0,
131 	DSO_TYPE_KERNEL,
132 	DSO_TYPE_GUEST_KERNEL
133 };
134 
135 struct dso {
136 	struct list_head node;
137 	struct rb_root	 symbols[MAP__NR_TYPES];
138 	struct rb_root	 symbol_names[MAP__NR_TYPES];
139 	enum dso_kernel_type	kernel;
140 	u8		 adjust_symbols:1;
141 	u8		 has_build_id:1;
142 	u8		 hit:1;
143 	u8		 annotate_warned:1;
144 	u8		 sname_alloc:1;
145 	u8		 lname_alloc:1;
146 	unsigned char	 symtab_type;
147 	u8		 sorted_by_name;
148 	u8		 loaded;
149 	u8		 build_id[BUILD_ID_SIZE];
150 	const char	 *short_name;
151 	char	 	 *long_name;
152 	u16		 long_name_len;
153 	u16		 short_name_len;
154 	char		 name[0];
155 };
156 
157 struct dso *dso__new(const char *name);
158 struct dso *dso__new_kernel(const char *name);
159 void dso__delete(struct dso *dso);
160 
161 int dso__name_len(const struct dso *dso);
162 
163 bool dso__loaded(const struct dso *dso, enum map_type type);
164 bool dso__sorted_by_name(const struct dso *dso, enum map_type type);
165 
166 static inline void dso__set_loaded(struct dso *dso, enum map_type type)
167 {
168 	dso->loaded |= (1 << type);
169 }
170 
171 void dso__sort_by_name(struct dso *dso, enum map_type type);
172 
173 struct dso *__dsos__findnew(struct list_head *head, const char *name);
174 
175 int dso__load(struct dso *dso, struct map *map, symbol_filter_t filter);
176 int dso__load_vmlinux(struct dso *dso, struct map *map,
177 		      const char *vmlinux, symbol_filter_t filter);
178 int dso__load_vmlinux_path(struct dso *dso, struct map *map,
179 			   symbol_filter_t filter);
180 int dso__load_kallsyms(struct dso *dso, const char *filename, struct map *map,
181 		       symbol_filter_t filter);
182 int machine__load_kallsyms(struct machine *machine, const char *filename,
183 			   enum map_type type, symbol_filter_t filter);
184 int machine__load_vmlinux_path(struct machine *machine, enum map_type type,
185 			       symbol_filter_t filter);
186 
187 size_t __dsos__fprintf(struct list_head *head, FILE *fp);
188 
189 size_t machine__fprintf_dsos_buildid(struct machine *machine,
190 				     FILE *fp, bool with_hits);
191 size_t machines__fprintf_dsos(struct rb_root *machines, FILE *fp);
192 size_t machines__fprintf_dsos_buildid(struct rb_root *machines,
193 				      FILE *fp, bool with_hits);
194 size_t dso__fprintf_buildid(struct dso *dso, FILE *fp);
195 size_t dso__fprintf_symbols_by_name(struct dso *dso,
196 				    enum map_type type, FILE *fp);
197 size_t dso__fprintf(struct dso *dso, enum map_type type, FILE *fp);
198 
199 enum symtab_type {
200 	SYMTAB__KALLSYMS = 0,
201 	SYMTAB__GUEST_KALLSYMS,
202 	SYMTAB__JAVA_JIT,
203 	SYMTAB__BUILD_ID_CACHE,
204 	SYMTAB__FEDORA_DEBUGINFO,
205 	SYMTAB__UBUNTU_DEBUGINFO,
206 	SYMTAB__BUILDID_DEBUGINFO,
207 	SYMTAB__SYSTEM_PATH_DSO,
208 	SYMTAB__GUEST_KMODULE,
209 	SYMTAB__SYSTEM_PATH_KMODULE,
210 	SYMTAB__NOT_FOUND,
211 };
212 
213 char dso__symtab_origin(const struct dso *dso);
214 void dso__set_long_name(struct dso *dso, char *name);
215 void dso__set_build_id(struct dso *dso, void *build_id);
216 void dso__read_running_kernel_build_id(struct dso *dso,
217 				       struct machine *machine);
218 struct symbol *dso__find_symbol(struct dso *dso, enum map_type type,
219 				u64 addr);
220 struct symbol *dso__find_symbol_by_name(struct dso *dso, enum map_type type,
221 					const char *name);
222 
223 int filename__read_build_id(const char *filename, void *bf, size_t size);
224 int sysfs__read_build_id(const char *filename, void *bf, size_t size);
225 bool __dsos__read_build_ids(struct list_head *head, bool with_hits);
226 int build_id__sprintf(const u8 *build_id, int len, char *bf);
227 int kallsyms__parse(const char *filename, void *arg,
228 		    int (*process_symbol)(void *arg, const char *name,
229 					  char type, u64 start, u64 end));
230 
231 void machine__destroy_kernel_maps(struct machine *machine);
232 int __machine__create_kernel_maps(struct machine *machine, struct dso *kernel);
233 int machine__create_kernel_maps(struct machine *machine);
234 
235 int machines__create_kernel_maps(struct rb_root *machines, pid_t pid);
236 int machines__create_guest_kernel_maps(struct rb_root *machines);
237 void machines__destroy_guest_kernel_maps(struct rb_root *machines);
238 
239 int symbol__init(void);
240 void symbol__exit(void);
241 bool symbol_type__is_a(char symbol_type, enum map_type map_type);
242 
243 size_t machine__fprintf_vmlinux_path(struct machine *machine, FILE *fp);
244 
245 #endif /* __PERF_SYMBOL */
246