xref: /openbmc/linux/tools/perf/util/dso.h (revision 259dce91)
1 /* SPDX-License-Identifier: GPL-2.0 */
2 #ifndef __PERF_DSO
3 #define __PERF_DSO
4 
5 #include <linux/refcount.h>
6 #include <linux/types.h>
7 #include <linux/rbtree.h>
8 #include <sys/types.h>
9 #include <stdbool.h>
10 #include <stdio.h>
11 #include <linux/bitops.h>
12 #include "build-id.h"
13 #include "mutex.h"
14 
15 struct machine;
16 struct map;
17 struct perf_env;
18 
19 #define DSO__NAME_KALLSYMS	"[kernel.kallsyms]"
20 #define DSO__NAME_KCORE		"[kernel.kcore]"
21 
22 enum dso_binary_type {
23 	DSO_BINARY_TYPE__KALLSYMS = 0,
24 	DSO_BINARY_TYPE__GUEST_KALLSYMS,
25 	DSO_BINARY_TYPE__VMLINUX,
26 	DSO_BINARY_TYPE__GUEST_VMLINUX,
27 	DSO_BINARY_TYPE__JAVA_JIT,
28 	DSO_BINARY_TYPE__DEBUGLINK,
29 	DSO_BINARY_TYPE__BUILD_ID_CACHE,
30 	DSO_BINARY_TYPE__BUILD_ID_CACHE_DEBUGINFO,
31 	DSO_BINARY_TYPE__FEDORA_DEBUGINFO,
32 	DSO_BINARY_TYPE__UBUNTU_DEBUGINFO,
33 	DSO_BINARY_TYPE__MIXEDUP_UBUNTU_DEBUGINFO,
34 	DSO_BINARY_TYPE__BUILDID_DEBUGINFO,
35 	DSO_BINARY_TYPE__SYSTEM_PATH_DSO,
36 	DSO_BINARY_TYPE__GUEST_KMODULE,
37 	DSO_BINARY_TYPE__GUEST_KMODULE_COMP,
38 	DSO_BINARY_TYPE__SYSTEM_PATH_KMODULE,
39 	DSO_BINARY_TYPE__SYSTEM_PATH_KMODULE_COMP,
40 	DSO_BINARY_TYPE__KCORE,
41 	DSO_BINARY_TYPE__GUEST_KCORE,
42 	DSO_BINARY_TYPE__OPENEMBEDDED_DEBUGINFO,
43 	DSO_BINARY_TYPE__BPF_PROG_INFO,
44 	DSO_BINARY_TYPE__BPF_IMAGE,
45 	DSO_BINARY_TYPE__OOL,
46 	DSO_BINARY_TYPE__NOT_FOUND,
47 };
48 
49 enum dso_space_type {
50 	DSO_SPACE__USER = 0,
51 	DSO_SPACE__KERNEL,
52 	DSO_SPACE__KERNEL_GUEST
53 };
54 
55 enum dso_swap_type {
56 	DSO_SWAP__UNSET,
57 	DSO_SWAP__NO,
58 	DSO_SWAP__YES,
59 };
60 
61 enum dso_data_status {
62 	DSO_DATA_STATUS_ERROR	= -1,
63 	DSO_DATA_STATUS_UNKNOWN	= 0,
64 	DSO_DATA_STATUS_OK	= 1,
65 };
66 
67 enum dso_data_status_seen {
68 	DSO_DATA_STATUS_SEEN_ITRACE,
69 };
70 
71 enum dso_type {
72 	DSO__TYPE_UNKNOWN,
73 	DSO__TYPE_64BIT,
74 	DSO__TYPE_32BIT,
75 	DSO__TYPE_X32BIT,
76 };
77 
78 enum dso_load_errno {
79 	DSO_LOAD_ERRNO__SUCCESS		= 0,
80 
81 	/*
82 	 * Choose an arbitrary negative big number not to clash with standard
83 	 * errno since SUS requires the errno has distinct positive values.
84 	 * See 'Issue 6' in the link below.
85 	 *
86 	 * http://pubs.opengroup.org/onlinepubs/9699919799/basedefs/errno.h.html
87 	 */
88 	__DSO_LOAD_ERRNO__START		= -10000,
89 
90 	DSO_LOAD_ERRNO__INTERNAL_ERROR	= __DSO_LOAD_ERRNO__START,
91 
92 	/* for symsrc__init() */
93 	DSO_LOAD_ERRNO__INVALID_ELF,
94 	DSO_LOAD_ERRNO__CANNOT_READ_BUILDID,
95 	DSO_LOAD_ERRNO__MISMATCHING_BUILDID,
96 
97 	/* for decompress_kmodule */
98 	DSO_LOAD_ERRNO__DECOMPRESSION_FAILURE,
99 
100 	__DSO_LOAD_ERRNO__END,
101 };
102 
103 #define DSO__SWAP(dso, type, val)			\
104 ({							\
105 	type ____r = val;				\
106 	BUG_ON(dso->needs_swap == DSO_SWAP__UNSET);	\
107 	if (dso->needs_swap == DSO_SWAP__YES) {		\
108 		switch (sizeof(____r)) {		\
109 		case 2:					\
110 			____r = bswap_16(val);		\
111 			break;				\
112 		case 4:					\
113 			____r = bswap_32(val);		\
114 			break;				\
115 		case 8:					\
116 			____r = bswap_64(val);		\
117 			break;				\
118 		default:				\
119 			BUG_ON(1);			\
120 		}					\
121 	}						\
122 	____r;						\
123 })
124 
125 #define DSO__DATA_CACHE_SIZE 4096
126 #define DSO__DATA_CACHE_MASK ~(DSO__DATA_CACHE_SIZE - 1)
127 
128 /*
129  * Data about backing storage DSO, comes from PERF_RECORD_MMAP2 meta events
130  */
131 struct dso_id {
132 	u32	maj;
133 	u32	min;
134 	u64	ino;
135 	u64	ino_generation;
136 };
137 
138 struct dso_cache {
139 	struct rb_node	rb_node;
140 	u64 offset;
141 	u64 size;
142 	char data[];
143 };
144 
145 struct auxtrace_cache;
146 
147 struct dso {
148 	struct mutex	 lock;
149 	struct list_head node;
150 	struct rb_node	 rb_node;	/* rbtree node sorted by long name */
151 	struct rb_root	 *root;		/* root of rbtree that rb_node is in */
152 	struct rb_root_cached symbols;
153 	struct symbol	 **symbol_names;
154 	size_t		 symbol_names_len;
155 	struct rb_root_cached inlined_nodes;
156 	struct rb_root_cached srclines;
157 	struct {
158 		u64		addr;
159 		struct symbol	*symbol;
160 	} last_find_result;
161 	void		 *a2l;
162 	char		 *symsrc_filename;
163 	unsigned int	 a2l_fails;
164 	enum dso_space_type	kernel;
165 	enum dso_swap_type	needs_swap;
166 	enum dso_binary_type	symtab_type;
167 	enum dso_binary_type	binary_type;
168 	enum dso_load_errno	load_errno;
169 	u8		 adjust_symbols:1;
170 	u8		 has_build_id:1;
171 	u8		 header_build_id:1;
172 	u8		 has_srcline:1;
173 	u8		 hit:1;
174 	u8		 annotate_warned:1;
175 	u8		 auxtrace_warned:1;
176 	u8		 short_name_allocated:1;
177 	u8		 long_name_allocated:1;
178 	u8		 is_64_bit:1;
179 	bool		 sorted_by_name;
180 	bool		 loaded;
181 	u8		 rel;
182 	struct build_id	 bid;
183 	u64		 text_offset;
184 	const char	 *short_name;
185 	const char	 *long_name;
186 	u16		 long_name_len;
187 	u16		 short_name_len;
188 	void		*dwfl;			/* DWARF debug info */
189 	struct auxtrace_cache *auxtrace_cache;
190 	int		 comp;
191 
192 	/* dso data file */
193 	struct {
194 		struct rb_root	 cache;
195 		int		 fd;
196 		int		 status;
197 		u32		 status_seen;
198 		u64		 file_size;
199 		struct list_head open_entry;
200 		u64		 elf_base_addr;
201 		u64		 debug_frame_offset;
202 		u64		 eh_frame_hdr_addr;
203 		u64		 eh_frame_hdr_offset;
204 	} data;
205 	/* bpf prog information */
206 	struct {
207 		u32		id;
208 		u32		sub_id;
209 		struct perf_env	*env;
210 	} bpf_prog;
211 
212 	union { /* Tool specific area */
213 		void	 *priv;
214 		u64	 db_id;
215 	};
216 	struct nsinfo	*nsinfo;
217 	struct dso_id	 id;
218 	refcount_t	 refcnt;
219 	char		 name[];
220 };
221 
222 /* dso__for_each_symbol - iterate over the symbols of given type
223  *
224  * @dso: the 'struct dso *' in which symbols are iterated
225  * @pos: the 'struct symbol *' to use as a loop cursor
226  * @n: the 'struct rb_node *' to use as a temporary storage
227  */
228 #define dso__for_each_symbol(dso, pos, n)	\
229 	symbols__for_each_entry(&(dso)->symbols, pos, n)
230 
231 #define dsos__for_each_with_build_id(pos, head)	\
232 	list_for_each_entry(pos, head, node)	\
233 		if (!pos->has_build_id)		\
234 			continue;		\
235 		else
236 
dso__set_loaded(struct dso * dso)237 static inline void dso__set_loaded(struct dso *dso)
238 {
239 	dso->loaded = true;
240 }
241 
242 struct dso *dso__new_id(const char *name, struct dso_id *id);
243 struct dso *dso__new(const char *name);
244 void dso__delete(struct dso *dso);
245 
246 int dso__cmp_id(struct dso *a, struct dso *b);
247 void dso__set_short_name(struct dso *dso, const char *name, bool name_allocated);
248 void dso__set_long_name(struct dso *dso, const char *name, bool name_allocated);
249 
250 int dso__name_len(const struct dso *dso);
251 
252 struct dso *dso__get(struct dso *dso);
253 void dso__put(struct dso *dso);
254 
__dso__zput(struct dso ** dso)255 static inline void __dso__zput(struct dso **dso)
256 {
257 	dso__put(*dso);
258 	*dso = NULL;
259 }
260 
261 #define dso__zput(dso) __dso__zput(&dso)
262 
263 bool dso__loaded(const struct dso *dso);
264 
dso__has_symbols(const struct dso * dso)265 static inline bool dso__has_symbols(const struct dso *dso)
266 {
267 	return !RB_EMPTY_ROOT(&dso->symbols.rb_root);
268 }
269 
270 char *dso__filename_with_chroot(const struct dso *dso, const char *filename);
271 
272 bool dso__sorted_by_name(const struct dso *dso);
273 void dso__set_sorted_by_name(struct dso *dso);
274 void dso__sort_by_name(struct dso *dso);
275 
276 void dso__set_build_id(struct dso *dso, struct build_id *bid);
277 bool dso__build_id_equal(const struct dso *dso, struct build_id *bid);
278 void dso__read_running_kernel_build_id(struct dso *dso,
279 				       struct machine *machine);
280 int dso__kernel_module_get_build_id(struct dso *dso, const char *root_dir);
281 
282 char dso__symtab_origin(const struct dso *dso);
283 int dso__read_binary_type_filename(const struct dso *dso, enum dso_binary_type type,
284 				   char *root_dir, char *filename, size_t size);
285 bool is_kernel_module(const char *pathname, int cpumode);
286 bool dso__needs_decompress(struct dso *dso);
287 int dso__decompress_kmodule_fd(struct dso *dso, const char *name);
288 int dso__decompress_kmodule_path(struct dso *dso, const char *name,
289 				 char *pathname, size_t len);
290 int filename__decompress(const char *name, char *pathname,
291 			 size_t len, int comp, int *err);
292 
293 #define KMOD_DECOMP_NAME  "/tmp/perf-kmod-XXXXXX"
294 #define KMOD_DECOMP_LEN   sizeof(KMOD_DECOMP_NAME)
295 
296 struct kmod_path {
297 	char *name;
298 	int   comp;
299 	bool  kmod;
300 };
301 
302 int __kmod_path__parse(struct kmod_path *m, const char *path,
303 		     bool alloc_name);
304 
305 #define kmod_path__parse(__m, __p)      __kmod_path__parse(__m, __p, false)
306 #define kmod_path__parse_name(__m, __p) __kmod_path__parse(__m, __p, true)
307 
308 void dso__set_module_info(struct dso *dso, struct kmod_path *m,
309 			  struct machine *machine);
310 
311 /*
312  * The dso__data_* external interface provides following functions:
313  *   dso__data_get_fd
314  *   dso__data_put_fd
315  *   dso__data_close
316  *   dso__data_size
317  *   dso__data_read_offset
318  *   dso__data_read_addr
319  *   dso__data_write_cache_offs
320  *   dso__data_write_cache_addr
321  *
322  * Please refer to the dso.c object code for each function and
323  * arguments documentation. Following text tries to explain the
324  * dso file descriptor caching.
325  *
326  * The dso__data* interface allows caching of opened file descriptors
327  * to speed up the dso data accesses. The idea is to leave the file
328  * descriptor opened ideally for the whole life of the dso object.
329  *
330  * The current usage of the dso__data_* interface is as follows:
331  *
332  * Get DSO's fd:
333  *   int fd = dso__data_get_fd(dso, machine);
334  *   if (fd >= 0) {
335  *       USE 'fd' SOMEHOW
336  *       dso__data_put_fd(dso);
337  *   }
338  *
339  * Read DSO's data:
340  *   n = dso__data_read_offset(dso_0, &machine, 0, buf, BUFSIZE);
341  *   n = dso__data_read_addr(dso_0, &machine, 0, buf, BUFSIZE);
342  *
343  * Eventually close DSO's fd:
344  *   dso__data_close(dso);
345  *
346  * It is not necessary to close the DSO object data file. Each time new
347  * DSO data file is opened, the limit (RLIMIT_NOFILE/2) is checked. Once
348  * it is crossed, the oldest opened DSO object is closed.
349  *
350  * The dso__delete function calls close_dso function to ensure the
351  * data file descriptor gets closed/unmapped before the dso object
352  * is freed.
353  *
354  * TODO
355 */
356 int dso__data_get_fd(struct dso *dso, struct machine *machine);
357 void dso__data_put_fd(struct dso *dso);
358 void dso__data_close(struct dso *dso);
359 
360 int dso__data_file_size(struct dso *dso, struct machine *machine);
361 off_t dso__data_size(struct dso *dso, struct machine *machine);
362 ssize_t dso__data_read_offset(struct dso *dso, struct machine *machine,
363 			      u64 offset, u8 *data, ssize_t size);
364 ssize_t dso__data_read_addr(struct dso *dso, struct map *map,
365 			    struct machine *machine, u64 addr,
366 			    u8 *data, ssize_t size);
367 bool dso__data_status_seen(struct dso *dso, enum dso_data_status_seen by);
368 ssize_t dso__data_write_cache_offs(struct dso *dso, struct machine *machine,
369 				   u64 offset, const u8 *data, ssize_t size);
370 ssize_t dso__data_write_cache_addr(struct dso *dso, struct map *map,
371 				   struct machine *machine, u64 addr,
372 				   const u8 *data, ssize_t size);
373 
374 struct map *dso__new_map(const char *name);
375 struct dso *machine__findnew_kernel(struct machine *machine, const char *name,
376 				    const char *short_name, int dso_type);
377 
378 void dso__reset_find_symbol_cache(struct dso *dso);
379 
380 size_t dso__fprintf_symbols_by_name(struct dso *dso, FILE *fp);
381 size_t dso__fprintf(struct dso *dso, FILE *fp);
382 
dso__is_vmlinux(const struct dso * dso)383 static inline bool dso__is_vmlinux(const struct dso *dso)
384 {
385 	return dso->binary_type == DSO_BINARY_TYPE__VMLINUX ||
386 	       dso->binary_type == DSO_BINARY_TYPE__GUEST_VMLINUX;
387 }
388 
dso__is_kcore(const struct dso * dso)389 static inline bool dso__is_kcore(const struct dso *dso)
390 {
391 	return dso->binary_type == DSO_BINARY_TYPE__KCORE ||
392 	       dso->binary_type == DSO_BINARY_TYPE__GUEST_KCORE;
393 }
394 
dso__is_kallsyms(const struct dso * dso)395 static inline bool dso__is_kallsyms(const struct dso *dso)
396 {
397 	return dso->kernel && dso->long_name[0] != '/';
398 }
399 
400 bool dso__is_object_file(const struct dso *dso);
401 
402 void dso__free_a2l(struct dso *dso);
403 
404 enum dso_type dso__type(struct dso *dso, struct machine *machine);
405 
406 int dso__strerror_load(struct dso *dso, char *buf, size_t buflen);
407 
408 void reset_fd_limit(void);
409 
410 #endif /* __PERF_DSO */
411