xref: /openbmc/linux/tools/perf/util/symbol.h (revision df2634f43f5106947f3735a0b61a6527a4b278cd)
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 {
52 	struct rb_node	rb_node;
53 	u64		start;
54 	u64		end;
55 	u16		namelen;
56 	u8		binding;
57 	char		name[0];
58 };
59 
60 void symbol__delete(struct symbol *self);
61 
62 struct strlist;
63 
64 struct symbol_conf {
65 	unsigned short	priv_size;
66 	bool		try_vmlinux_path,
67 			use_modules,
68 			sort_by_name,
69 			show_nr_samples,
70 			use_callchain,
71 			exclude_other,
72 			show_cpu_utilization,
73 			initialized;
74 	const char	*vmlinux_name,
75 			*kallsyms_name,
76 			*source_prefix,
77 			*field_sep;
78 	const char	*default_guest_vmlinux_name,
79 			*default_guest_kallsyms,
80 			*default_guest_modules;
81 	const char	*guestmount;
82 	const char	*dso_list_str,
83 			*comm_list_str,
84 			*sym_list_str,
85 			*col_width_list_str;
86        struct strlist	*dso_list,
87 			*comm_list,
88 			*sym_list;
89 	const char	*symfs;
90 };
91 
92 extern struct symbol_conf symbol_conf;
93 
94 static inline void *symbol__priv(struct symbol *self)
95 {
96 	return ((void *)self) - symbol_conf.priv_size;
97 }
98 
99 struct ref_reloc_sym {
100 	const char	*name;
101 	u64		addr;
102 	u64		unrelocated_addr;
103 };
104 
105 struct map_symbol {
106 	struct map    *map;
107 	struct symbol *sym;
108 	bool	      unfolded;
109 	bool	      has_children;
110 };
111 
112 struct addr_location {
113 	struct thread *thread;
114 	struct map    *map;
115 	struct symbol *sym;
116 	u64	      addr;
117 	char	      level;
118 	bool	      filtered;
119 	u8	      cpumode;
120 	s32	      cpu;
121 };
122 
123 enum dso_kernel_type {
124 	DSO_TYPE_USER = 0,
125 	DSO_TYPE_KERNEL,
126 	DSO_TYPE_GUEST_KERNEL
127 };
128 
129 struct dso {
130 	struct list_head node;
131 	struct rb_root	 symbols[MAP__NR_TYPES];
132 	struct rb_root	 symbol_names[MAP__NR_TYPES];
133 	enum dso_kernel_type	kernel;
134 	u8		 adjust_symbols:1;
135 	u8		 slen_calculated:1;
136 	u8		 has_build_id:1;
137 	u8		 hit:1;
138 	u8		 annotate_warned:1;
139 	u8		 sname_alloc:1;
140 	u8		 lname_alloc:1;
141 	unsigned char	 origin;
142 	u8		 sorted_by_name;
143 	u8		 loaded;
144 	u8		 build_id[BUILD_ID_SIZE];
145 	const char	 *short_name;
146 	char	 	 *long_name;
147 	u16		 long_name_len;
148 	u16		 short_name_len;
149 	char		 name[0];
150 };
151 
152 struct dso *dso__new(const char *name);
153 struct dso *dso__new_kernel(const char *name);
154 void dso__delete(struct dso *self);
155 
156 int dso__name_len(const struct dso *self);
157 
158 bool dso__loaded(const struct dso *self, enum map_type type);
159 bool dso__sorted_by_name(const struct dso *self, enum map_type type);
160 
161 static inline void dso__set_loaded(struct dso *self, enum map_type type)
162 {
163 	self->loaded |= (1 << type);
164 }
165 
166 void dso__sort_by_name(struct dso *self, enum map_type type);
167 
168 struct dso *__dsos__findnew(struct list_head *head, const char *name);
169 
170 int dso__load(struct dso *self, struct map *map, symbol_filter_t filter);
171 int dso__load_vmlinux(struct dso *self, struct map *map,
172 		      const char *vmlinux, symbol_filter_t filter);
173 int dso__load_vmlinux_path(struct dso *self, struct map *map,
174 			   symbol_filter_t filter);
175 int dso__load_kallsyms(struct dso *self, const char *filename, struct map *map,
176 		       symbol_filter_t filter);
177 int machine__load_kallsyms(struct machine *self, const char *filename,
178 			   enum map_type type, symbol_filter_t filter);
179 int machine__load_vmlinux_path(struct machine *self, enum map_type type,
180 			       symbol_filter_t filter);
181 
182 size_t __dsos__fprintf(struct list_head *head, FILE *fp);
183 
184 size_t machine__fprintf_dsos_buildid(struct machine *self, FILE *fp, bool with_hits);
185 size_t machines__fprintf_dsos(struct rb_root *self, FILE *fp);
186 size_t machines__fprintf_dsos_buildid(struct rb_root *self, FILE *fp, bool with_hits);
187 
188 size_t dso__fprintf_buildid(struct dso *self, FILE *fp);
189 size_t dso__fprintf_symbols_by_name(struct dso *self, enum map_type type, FILE *fp);
190 size_t dso__fprintf(struct dso *self, enum map_type type, FILE *fp);
191 
192 enum dso_origin {
193 	DSO__ORIG_KERNEL = 0,
194 	DSO__ORIG_GUEST_KERNEL,
195 	DSO__ORIG_JAVA_JIT,
196 	DSO__ORIG_BUILD_ID_CACHE,
197 	DSO__ORIG_FEDORA,
198 	DSO__ORIG_UBUNTU,
199 	DSO__ORIG_BUILDID,
200 	DSO__ORIG_DSO,
201 	DSO__ORIG_GUEST_KMODULE,
202 	DSO__ORIG_KMODULE,
203 	DSO__ORIG_NOT_FOUND,
204 };
205 
206 char dso__symtab_origin(const struct dso *self);
207 void dso__set_long_name(struct dso *self, char *name);
208 void dso__set_build_id(struct dso *self, void *build_id);
209 void dso__read_running_kernel_build_id(struct dso *self, struct machine *machine);
210 struct symbol *dso__find_symbol(struct dso *self, enum map_type type, u64 addr);
211 struct symbol *dso__find_symbol_by_name(struct dso *self, enum map_type type,
212 					const char *name);
213 
214 int filename__read_build_id(const char *filename, void *bf, size_t size);
215 int sysfs__read_build_id(const char *filename, void *bf, size_t size);
216 bool __dsos__read_build_ids(struct list_head *head, bool with_hits);
217 int build_id__sprintf(const u8 *self, int len, char *bf);
218 int kallsyms__parse(const char *filename, void *arg,
219 		    int (*process_symbol)(void *arg, const char *name,
220 					  char type, u64 start, u64 end));
221 
222 void machine__destroy_kernel_maps(struct machine *self);
223 int __machine__create_kernel_maps(struct machine *self, struct dso *kernel);
224 int machine__create_kernel_maps(struct machine *self);
225 
226 int machines__create_kernel_maps(struct rb_root *self, pid_t pid);
227 int machines__create_guest_kernel_maps(struct rb_root *self);
228 void machines__destroy_guest_kernel_maps(struct rb_root *self);
229 
230 int symbol__init(void);
231 void symbol__exit(void);
232 bool symbol_type__is_a(char symbol_type, enum map_type map_type);
233 
234 size_t machine__fprintf_vmlinux_path(struct machine *self, FILE *fp);
235 
236 #endif /* __PERF_SYMBOL */
237