1 /* SPDX-License-Identifier: GPL-2.0 */
6 #include <linux/refcount.h>
7 #include <linux/types.h>
8 #include <linux/rbtree.h>
12 #include <linux/bitops.h>
19 #define DSO__NAME_KALLSYMS "[kernel.kallsyms]"
20 #define DSO__NAME_KCORE "[kernel.kcore]"
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
,
46 DSO_BINARY_TYPE__NOT_FOUND
,
52 DSO_SPACE__KERNEL_GUEST
61 enum dso_data_status
{
62 DSO_DATA_STATUS_ERROR
= -1,
63 DSO_DATA_STATUS_UNKNOWN
= 0,
64 DSO_DATA_STATUS_OK
= 1,
67 enum dso_data_status_seen
{
68 DSO_DATA_STATUS_SEEN_ITRACE
,
79 DSO_LOAD_ERRNO__SUCCESS
= 0,
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.
86 * http://pubs.opengroup.org/onlinepubs/9699919799/basedefs/errno.h.html
88 __DSO_LOAD_ERRNO__START
= -10000,
90 DSO_LOAD_ERRNO__INTERNAL_ERROR
= __DSO_LOAD_ERRNO__START
,
92 /* for symsrc__init() */
93 DSO_LOAD_ERRNO__INVALID_ELF
,
94 DSO_LOAD_ERRNO__CANNOT_READ_BUILDID
,
95 DSO_LOAD_ERRNO__MISMATCHING_BUILDID
,
97 /* for decompress_kmodule */
98 DSO_LOAD_ERRNO__DECOMPRESSION_FAILURE
,
100 __DSO_LOAD_ERRNO__END
,
103 #define DSO__SWAP(dso, type, val) \
106 BUG_ON(dso->needs_swap == DSO_SWAP__UNSET); \
107 if (dso->needs_swap == DSO_SWAP__YES) { \
108 switch (sizeof(____r)) { \
110 ____r = bswap_16(val); \
113 ____r = bswap_32(val); \
116 ____r = bswap_64(val); \
125 #define DSO__DATA_CACHE_SIZE 4096
126 #define DSO__DATA_CACHE_MASK ~(DSO__DATA_CACHE_SIZE - 1)
129 * Data about backing storage DSO, comes from PERF_RECORD_MMAP2 meta events
139 struct rb_node rb_node
;
145 struct auxtrace_cache
;
148 pthread_mutex_t 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 rb_root_cached symbol_names
;
154 struct rb_root_cached inlined_nodes
;
155 struct rb_root_cached srclines
;
158 struct symbol
*symbol
;
161 char *symsrc_filename
;
162 unsigned int a2l_fails
;
163 enum dso_space_type kernel
;
164 enum dso_swap_type needs_swap
;
165 enum dso_binary_type symtab_type
;
166 enum dso_binary_type binary_type
;
167 enum dso_load_errno load_errno
;
172 u8 annotate_warned
:1;
173 u8 short_name_allocated
:1;
174 u8 long_name_allocated
:1;
179 u8 build_id
[BUILD_ID_SIZE
];
181 const char *short_name
;
182 const char *long_name
;
185 void *dwfl
; /* DWARF debug info */
186 struct auxtrace_cache
*auxtrace_cache
;
191 struct rb_root cache
;
196 struct list_head open_entry
;
197 u64 debug_frame_offset
;
198 u64 eh_frame_hdr_offset
;
200 /* bpf prog information */
204 struct perf_env
*env
;
207 union { /* Tool specific area */
211 struct nsinfo
*nsinfo
;
217 /* dso__for_each_symbol - iterate over the symbols of given type
219 * @dso: the 'struct dso *' in which symbols itereated
220 * @pos: the 'struct symbol *' to use as a loop cursor
221 * @n: the 'struct rb_node *' to use as a temporary storage
223 #define dso__for_each_symbol(dso, pos, n) \
224 symbols__for_each_entry(&(dso)->symbols, pos, n)
226 static inline void dso__set_loaded(struct dso
*dso
)
231 struct dso
*dso__new_id(const char *name
, struct dso_id
*id
);
232 struct dso
*dso__new(const char *name
);
233 void dso__delete(struct dso
*dso
);
235 int dso__cmp_id(struct dso
*a
, struct dso
*b
);
236 void dso__set_short_name(struct dso
*dso
, const char *name
, bool name_allocated
);
237 void dso__set_long_name(struct dso
*dso
, const char *name
, bool name_allocated
);
239 int dso__name_len(const struct dso
*dso
);
241 struct dso
*dso__get(struct dso
*dso
);
242 void dso__put(struct dso
*dso
);
244 static inline void __dso__zput(struct dso
**dso
)
250 #define dso__zput(dso) __dso__zput(&dso)
252 bool dso__loaded(const struct dso
*dso
);
254 static inline bool dso__has_symbols(const struct dso
*dso
)
256 return !RB_EMPTY_ROOT(&dso
->symbols
.rb_root
);
259 bool dso__sorted_by_name(const struct dso
*dso
);
260 void dso__set_sorted_by_name(struct dso
*dso
);
261 void dso__sort_by_name(struct dso
*dso
);
263 void dso__set_build_id(struct dso
*dso
, void *build_id
);
264 bool dso__build_id_equal(const struct dso
*dso
, u8
*build_id
);
265 void dso__read_running_kernel_build_id(struct dso
*dso
,
266 struct machine
*machine
);
267 int dso__kernel_module_get_build_id(struct dso
*dso
, const char *root_dir
);
269 char dso__symtab_origin(const struct dso
*dso
);
270 int dso__read_binary_type_filename(const struct dso
*dso
, enum dso_binary_type type
,
271 char *root_dir
, char *filename
, size_t size
);
272 bool is_kernel_module(const char *pathname
, int cpumode
);
273 bool dso__needs_decompress(struct dso
*dso
);
274 int dso__decompress_kmodule_fd(struct dso
*dso
, const char *name
);
275 int dso__decompress_kmodule_path(struct dso
*dso
, const char *name
,
276 char *pathname
, size_t len
);
278 #define KMOD_DECOMP_NAME "/tmp/perf-kmod-XXXXXX"
279 #define KMOD_DECOMP_LEN sizeof(KMOD_DECOMP_NAME)
287 int __kmod_path__parse(struct kmod_path
*m
, const char *path
,
290 #define kmod_path__parse(__m, __p) __kmod_path__parse(__m, __p, false)
291 #define kmod_path__parse_name(__m, __p) __kmod_path__parse(__m, __p, true)
293 void dso__set_module_info(struct dso
*dso
, struct kmod_path
*m
,
294 struct machine
*machine
);
297 * The dso__data_* external interface provides following functions:
302 * dso__data_read_offset
303 * dso__data_read_addr
304 * dso__data_write_cache_offs
305 * dso__data_write_cache_addr
307 * Please refer to the dso.c object code for each function and
308 * arguments documentation. Following text tries to explain the
309 * dso file descriptor caching.
311 * The dso__data* interface allows caching of opened file descriptors
312 * to speed up the dso data accesses. The idea is to leave the file
313 * descriptor opened ideally for the whole life of the dso object.
315 * The current usage of the dso__data_* interface is as follows:
318 * int fd = dso__data_get_fd(dso, machine);
321 * dso__data_put_fd(dso);
325 * n = dso__data_read_offset(dso_0, &machine, 0, buf, BUFSIZE);
326 * n = dso__data_read_addr(dso_0, &machine, 0, buf, BUFSIZE);
328 * Eventually close DSO's fd:
329 * dso__data_close(dso);
331 * It is not necessary to close the DSO object data file. Each time new
332 * DSO data file is opened, the limit (RLIMIT_NOFILE/2) is checked. Once
333 * it is crossed, the oldest opened DSO object is closed.
335 * The dso__delete function calls close_dso function to ensure the
336 * data file descriptor gets closed/unmapped before the dso object
341 int dso__data_get_fd(struct dso
*dso
, struct machine
*machine
);
342 void dso__data_put_fd(struct dso
*dso
);
343 void dso__data_close(struct dso
*dso
);
345 int dso__data_file_size(struct dso
*dso
, struct machine
*machine
);
346 off_t
dso__data_size(struct dso
*dso
, struct machine
*machine
);
347 ssize_t
dso__data_read_offset(struct dso
*dso
, struct machine
*machine
,
348 u64 offset
, u8
*data
, ssize_t size
);
349 ssize_t
dso__data_read_addr(struct dso
*dso
, struct map
*map
,
350 struct machine
*machine
, u64 addr
,
351 u8
*data
, ssize_t size
);
352 bool dso__data_status_seen(struct dso
*dso
, enum dso_data_status_seen by
);
353 ssize_t
dso__data_write_cache_offs(struct dso
*dso
, struct machine
*machine
,
354 u64 offset
, const u8
*data
, ssize_t size
);
355 ssize_t
dso__data_write_cache_addr(struct dso
*dso
, struct map
*map
,
356 struct machine
*machine
, u64 addr
,
357 const u8
*data
, ssize_t size
);
359 struct map
*dso__new_map(const char *name
);
360 struct dso
*machine__findnew_kernel(struct machine
*machine
, const char *name
,
361 const char *short_name
, int dso_type
);
363 void dso__reset_find_symbol_cache(struct dso
*dso
);
365 size_t dso__fprintf_buildid(struct dso
*dso
, FILE *fp
);
366 size_t dso__fprintf_symbols_by_name(struct dso
*dso
, FILE *fp
);
367 size_t dso__fprintf(struct dso
*dso
, FILE *fp
);
369 static inline bool dso__is_vmlinux(struct dso
*dso
)
371 return dso
->binary_type
== DSO_BINARY_TYPE__VMLINUX
||
372 dso
->binary_type
== DSO_BINARY_TYPE__GUEST_VMLINUX
;
375 static inline bool dso__is_kcore(struct dso
*dso
)
377 return dso
->binary_type
== DSO_BINARY_TYPE__KCORE
||
378 dso
->binary_type
== DSO_BINARY_TYPE__GUEST_KCORE
;
381 static inline bool dso__is_kallsyms(struct dso
*dso
)
383 return dso
->kernel
&& dso
->long_name
[0] != '/';
386 void dso__free_a2l(struct dso
*dso
);
388 enum dso_type
dso__type(struct dso
*dso
, struct machine
*machine
);
390 int dso__strerror_load(struct dso
*dso
, char *buf
, size_t buflen
);
392 void reset_fd_limit(void);
394 #endif /* __PERF_DSO */