1 /* SPDX-License-Identifier: GPL-2.0 */
5 #include <linux/refcount.h>
6 #include <linux/types.h>
7 #include <linux/rbtree.h>
12 #include <linux/bitops.h>
19 enum dso_binary_type
{
20 DSO_BINARY_TYPE__KALLSYMS
= 0,
21 DSO_BINARY_TYPE__GUEST_KALLSYMS
,
22 DSO_BINARY_TYPE__VMLINUX
,
23 DSO_BINARY_TYPE__GUEST_VMLINUX
,
24 DSO_BINARY_TYPE__JAVA_JIT
,
25 DSO_BINARY_TYPE__DEBUGLINK
,
26 DSO_BINARY_TYPE__BUILD_ID_CACHE
,
27 DSO_BINARY_TYPE__BUILD_ID_CACHE_DEBUGINFO
,
28 DSO_BINARY_TYPE__FEDORA_DEBUGINFO
,
29 DSO_BINARY_TYPE__UBUNTU_DEBUGINFO
,
30 DSO_BINARY_TYPE__BUILDID_DEBUGINFO
,
31 DSO_BINARY_TYPE__SYSTEM_PATH_DSO
,
32 DSO_BINARY_TYPE__GUEST_KMODULE
,
33 DSO_BINARY_TYPE__GUEST_KMODULE_COMP
,
34 DSO_BINARY_TYPE__SYSTEM_PATH_KMODULE
,
35 DSO_BINARY_TYPE__SYSTEM_PATH_KMODULE_COMP
,
36 DSO_BINARY_TYPE__KCORE
,
37 DSO_BINARY_TYPE__GUEST_KCORE
,
38 DSO_BINARY_TYPE__OPENEMBEDDED_DEBUGINFO
,
39 DSO_BINARY_TYPE__BPF_PROG_INFO
,
40 DSO_BINARY_TYPE__NOT_FOUND
,
43 enum dso_kernel_type
{
55 enum dso_data_status
{
56 DSO_DATA_STATUS_ERROR
= -1,
57 DSO_DATA_STATUS_UNKNOWN
= 0,
58 DSO_DATA_STATUS_OK
= 1,
61 enum dso_data_status_seen
{
62 DSO_DATA_STATUS_SEEN_ITRACE
,
73 DSO_LOAD_ERRNO__SUCCESS
= 0,
76 * Choose an arbitrary negative big number not to clash with standard
77 * errno since SUS requires the errno has distinct positive values.
78 * See 'Issue 6' in the link below.
80 * http://pubs.opengroup.org/onlinepubs/9699919799/basedefs/errno.h.html
82 __DSO_LOAD_ERRNO__START
= -10000,
84 DSO_LOAD_ERRNO__INTERNAL_ERROR
= __DSO_LOAD_ERRNO__START
,
86 /* for symsrc__init() */
87 DSO_LOAD_ERRNO__INVALID_ELF
,
88 DSO_LOAD_ERRNO__CANNOT_READ_BUILDID
,
89 DSO_LOAD_ERRNO__MISMATCHING_BUILDID
,
91 /* for decompress_kmodule */
92 DSO_LOAD_ERRNO__DECOMPRESSION_FAILURE
,
94 __DSO_LOAD_ERRNO__END
,
97 #define DSO__SWAP(dso, type, val) \
100 BUG_ON(dso->needs_swap == DSO_SWAP__UNSET); \
101 if (dso->needs_swap == DSO_SWAP__YES) { \
102 switch (sizeof(____r)) { \
104 ____r = bswap_16(val); \
107 ____r = bswap_32(val); \
110 ____r = bswap_64(val); \
119 #define DSO__DATA_CACHE_SIZE 4096
120 #define DSO__DATA_CACHE_MASK ~(DSO__DATA_CACHE_SIZE - 1)
123 struct rb_node rb_node
;
130 * DSOs are put into both a list for fast iteration and rbtree for fast
134 struct list_head head
;
135 struct rb_root root
; /* rbtree root sorted by long name */
136 struct rw_semaphore lock
;
139 struct auxtrace_cache
;
142 pthread_mutex_t lock
;
143 struct list_head node
;
144 struct rb_node rb_node
; /* rbtree node sorted by long name */
145 struct rb_root
*root
; /* root of rbtree that rb_node is in */
146 struct rb_root_cached symbols
;
147 struct rb_root_cached symbol_names
;
148 struct rb_root_cached inlined_nodes
;
149 struct rb_root_cached srclines
;
152 struct symbol
*symbol
;
155 char *symsrc_filename
;
156 unsigned int a2l_fails
;
157 enum dso_kernel_type kernel
;
158 enum dso_swap_type needs_swap
;
159 enum dso_binary_type symtab_type
;
160 enum dso_binary_type binary_type
;
161 enum dso_load_errno load_errno
;
166 u8 annotate_warned
:1;
167 u8 short_name_allocated
:1;
168 u8 long_name_allocated
:1;
173 u8 build_id
[BUILD_ID_SIZE
];
175 const char *short_name
;
176 const char *long_name
;
179 void *dwfl
; /* DWARF debug info */
180 struct auxtrace_cache
*auxtrace_cache
;
185 struct rb_root cache
;
190 struct list_head open_entry
;
191 u64 debug_frame_offset
;
192 u64 eh_frame_hdr_offset
;
194 /* bpf prog information */
198 struct perf_env
*env
;
201 union { /* Tool specific area */
205 struct nsinfo
*nsinfo
;
210 /* dso__for_each_symbol - iterate over the symbols of given type
212 * @dso: the 'struct dso *' in which symbols itereated
213 * @pos: the 'struct symbol *' to use as a loop cursor
214 * @n: the 'struct rb_node *' to use as a temporary storage
216 #define dso__for_each_symbol(dso, pos, n) \
217 symbols__for_each_entry(&(dso)->symbols, pos, n)
219 static inline void dso__set_loaded(struct dso
*dso
)
224 struct dso
*dso__new(const char *name
);
225 void dso__delete(struct dso
*dso
);
227 void dso__set_short_name(struct dso
*dso
, const char *name
, bool name_allocated
);
228 void dso__set_long_name(struct dso
*dso
, const char *name
, bool name_allocated
);
230 int dso__name_len(const struct dso
*dso
);
232 struct dso
*dso__get(struct dso
*dso
);
233 void dso__put(struct dso
*dso
);
235 static inline void __dso__zput(struct dso
**dso
)
241 #define dso__zput(dso) __dso__zput(&dso)
243 bool dso__loaded(const struct dso
*dso
);
245 static inline bool dso__has_symbols(const struct dso
*dso
)
247 return !RB_EMPTY_ROOT(&dso
->symbols
.rb_root
);
250 bool dso__sorted_by_name(const struct dso
*dso
);
251 void dso__set_sorted_by_name(struct dso
*dso
);
252 void dso__sort_by_name(struct dso
*dso
);
254 void dso__set_build_id(struct dso
*dso
, void *build_id
);
255 bool dso__build_id_equal(const struct dso
*dso
, u8
*build_id
);
256 void dso__read_running_kernel_build_id(struct dso
*dso
,
257 struct machine
*machine
);
258 int dso__kernel_module_get_build_id(struct dso
*dso
, const char *root_dir
);
260 char dso__symtab_origin(const struct dso
*dso
);
261 int dso__read_binary_type_filename(const struct dso
*dso
, enum dso_binary_type type
,
262 char *root_dir
, char *filename
, size_t size
);
263 bool is_kernel_module(const char *pathname
, int cpumode
);
264 bool dso__needs_decompress(struct dso
*dso
);
265 int dso__decompress_kmodule_fd(struct dso
*dso
, const char *name
);
266 int dso__decompress_kmodule_path(struct dso
*dso
, const char *name
,
267 char *pathname
, size_t len
);
269 #define KMOD_DECOMP_NAME "/tmp/perf-kmod-XXXXXX"
270 #define KMOD_DECOMP_LEN sizeof(KMOD_DECOMP_NAME)
278 int __kmod_path__parse(struct kmod_path
*m
, const char *path
,
281 #define kmod_path__parse(__m, __p) __kmod_path__parse(__m, __p, false)
282 #define kmod_path__parse_name(__m, __p) __kmod_path__parse(__m, __p, true)
284 void dso__set_module_info(struct dso
*dso
, struct kmod_path
*m
,
285 struct machine
*machine
);
288 * The dso__data_* external interface provides following functions:
293 * dso__data_read_offset
294 * dso__data_read_addr
296 * Please refer to the dso.c object code for each function and
297 * arguments documentation. Following text tries to explain the
298 * dso file descriptor caching.
300 * The dso__data* interface allows caching of opened file descriptors
301 * to speed up the dso data accesses. The idea is to leave the file
302 * descriptor opened ideally for the whole life of the dso object.
304 * The current usage of the dso__data_* interface is as follows:
307 * int fd = dso__data_get_fd(dso, machine);
310 * dso__data_put_fd(dso);
314 * n = dso__data_read_offset(dso_0, &machine, 0, buf, BUFSIZE);
315 * n = dso__data_read_addr(dso_0, &machine, 0, buf, BUFSIZE);
317 * Eventually close DSO's fd:
318 * dso__data_close(dso);
320 * It is not necessary to close the DSO object data file. Each time new
321 * DSO data file is opened, the limit (RLIMIT_NOFILE/2) is checked. Once
322 * it is crossed, the oldest opened DSO object is closed.
324 * The dso__delete function calls close_dso function to ensure the
325 * data file descriptor gets closed/unmapped before the dso object
330 int dso__data_get_fd(struct dso
*dso
, struct machine
*machine
);
331 void dso__data_put_fd(struct dso
*dso
);
332 void dso__data_close(struct dso
*dso
);
334 int dso__data_file_size(struct dso
*dso
, struct machine
*machine
);
335 off_t
dso__data_size(struct dso
*dso
, struct machine
*machine
);
336 ssize_t
dso__data_read_offset(struct dso
*dso
, struct machine
*machine
,
337 u64 offset
, u8
*data
, ssize_t size
);
338 ssize_t
dso__data_read_addr(struct dso
*dso
, struct map
*map
,
339 struct machine
*machine
, u64 addr
,
340 u8
*data
, ssize_t size
);
341 bool dso__data_status_seen(struct dso
*dso
, enum dso_data_status_seen by
);
343 struct map
*dso__new_map(const char *name
);
344 struct dso
*machine__findnew_kernel(struct machine
*machine
, const char *name
,
345 const char *short_name
, int dso_type
);
347 void __dsos__add(struct dsos
*dsos
, struct dso
*dso
);
348 void dsos__add(struct dsos
*dsos
, struct dso
*dso
);
349 struct dso
*__dsos__addnew(struct dsos
*dsos
, const char *name
);
350 struct dso
*__dsos__find(struct dsos
*dsos
, const char *name
, bool cmp_short
);
351 struct dso
*dsos__find(struct dsos
*dsos
, const char *name
, bool cmp_short
);
352 struct dso
*__dsos__findnew(struct dsos
*dsos
, const char *name
);
353 struct dso
*dsos__findnew(struct dsos
*dsos
, const char *name
);
354 bool __dsos__read_build_ids(struct list_head
*head
, bool with_hits
);
356 void dso__reset_find_symbol_cache(struct dso
*dso
);
358 size_t __dsos__fprintf_buildid(struct list_head
*head
, FILE *fp
,
359 bool (skip
)(struct dso
*dso
, int parm
), int parm
);
360 size_t __dsos__fprintf(struct list_head
*head
, FILE *fp
);
362 size_t dso__fprintf_buildid(struct dso
*dso
, FILE *fp
);
363 size_t dso__fprintf_symbols_by_name(struct dso
*dso
, FILE *fp
);
364 size_t dso__fprintf(struct dso
*dso
, FILE *fp
);
366 static inline bool dso__is_vmlinux(struct dso
*dso
)
368 return dso
->binary_type
== DSO_BINARY_TYPE__VMLINUX
||
369 dso
->binary_type
== DSO_BINARY_TYPE__GUEST_VMLINUX
;
372 static inline bool dso__is_kcore(struct dso
*dso
)
374 return dso
->binary_type
== DSO_BINARY_TYPE__KCORE
||
375 dso
->binary_type
== DSO_BINARY_TYPE__GUEST_KCORE
;
378 static inline bool dso__is_kallsyms(struct dso
*dso
)
380 return dso
->kernel
&& dso
->long_name
[0] != '/';
383 void dso__free_a2l(struct dso
*dso
);
385 enum dso_type
dso__type(struct dso
*dso
, struct machine
*machine
);
387 int dso__strerror_load(struct dso
*dso
, char *buf
, size_t buflen
);
389 void reset_fd_limit(void);
391 #endif /* __PERF_DSO */