1 /* SPDX-License-Identifier: GPL-2.0 */
5 #include <linux/refcount.h>
6 #include <linux/types.h>
7 #include <linux/rbtree.h>
11 #include <linux/types.h>
12 #include <linux/bitops.h>
14 #include "namespaces.h"
17 enum dso_binary_type {
18 DSO_BINARY_TYPE__KALLSYMS = 0,
19 DSO_BINARY_TYPE__GUEST_KALLSYMS,
20 DSO_BINARY_TYPE__VMLINUX,
21 DSO_BINARY_TYPE__GUEST_VMLINUX,
22 DSO_BINARY_TYPE__JAVA_JIT,
23 DSO_BINARY_TYPE__DEBUGLINK,
24 DSO_BINARY_TYPE__BUILD_ID_CACHE,
25 DSO_BINARY_TYPE__BUILD_ID_CACHE_DEBUGINFO,
26 DSO_BINARY_TYPE__FEDORA_DEBUGINFO,
27 DSO_BINARY_TYPE__UBUNTU_DEBUGINFO,
28 DSO_BINARY_TYPE__BUILDID_DEBUGINFO,
29 DSO_BINARY_TYPE__SYSTEM_PATH_DSO,
30 DSO_BINARY_TYPE__GUEST_KMODULE,
31 DSO_BINARY_TYPE__GUEST_KMODULE_COMP,
32 DSO_BINARY_TYPE__SYSTEM_PATH_KMODULE,
33 DSO_BINARY_TYPE__SYSTEM_PATH_KMODULE_COMP,
34 DSO_BINARY_TYPE__KCORE,
35 DSO_BINARY_TYPE__GUEST_KCORE,
36 DSO_BINARY_TYPE__OPENEMBEDDED_DEBUGINFO,
37 DSO_BINARY_TYPE__NOT_FOUND,
40 enum dso_kernel_type {
52 enum dso_data_status {
53 DSO_DATA_STATUS_ERROR = -1,
54 DSO_DATA_STATUS_UNKNOWN = 0,
55 DSO_DATA_STATUS_OK = 1,
58 enum dso_data_status_seen {
59 DSO_DATA_STATUS_SEEN_ITRACE,
70 DSO_LOAD_ERRNO__SUCCESS = 0,
73 * Choose an arbitrary negative big number not to clash with standard
74 * errno since SUS requires the errno has distinct positive values.
75 * See 'Issue 6' in the link below.
77 * http://pubs.opengroup.org/onlinepubs/9699919799/basedefs/errno.h.html
79 __DSO_LOAD_ERRNO__START = -10000,
81 DSO_LOAD_ERRNO__INTERNAL_ERROR = __DSO_LOAD_ERRNO__START,
83 /* for symsrc__init() */
84 DSO_LOAD_ERRNO__INVALID_ELF,
85 DSO_LOAD_ERRNO__CANNOT_READ_BUILDID,
86 DSO_LOAD_ERRNO__MISMATCHING_BUILDID,
88 /* for decompress_kmodule */
89 DSO_LOAD_ERRNO__DECOMPRESSION_FAILURE,
91 __DSO_LOAD_ERRNO__END,
94 #define DSO__SWAP(dso, type, val) \
97 BUG_ON(dso->needs_swap == DSO_SWAP__UNSET); \
98 if (dso->needs_swap == DSO_SWAP__YES) { \
99 switch (sizeof(____r)) { \
101 ____r = bswap_16(val); \
104 ____r = bswap_32(val); \
107 ____r = bswap_64(val); \
116 #define DSO__DATA_CACHE_SIZE 4096
117 #define DSO__DATA_CACHE_MASK ~(DSO__DATA_CACHE_SIZE - 1)
120 struct rb_node rb_node;
127 * DSOs are put into both a list for fast iteration and rbtree for fast
131 struct list_head head;
132 struct rb_root root; /* rbtree root sorted by long name */
133 pthread_rwlock_t lock;
136 struct auxtrace_cache;
139 pthread_mutex_t lock;
140 struct list_head node;
141 struct rb_node rb_node; /* rbtree node sorted by long name */
142 struct rb_root *root; /* root of rbtree that rb_node is in */
143 struct rb_root symbols[MAP__NR_TYPES];
144 struct rb_root symbol_names[MAP__NR_TYPES];
147 struct symbol *symbol;
148 } last_find_result[MAP__NR_TYPES];
150 char *symsrc_filename;
151 unsigned int a2l_fails;
152 enum dso_kernel_type kernel;
153 enum dso_swap_type needs_swap;
154 enum dso_binary_type symtab_type;
155 enum dso_binary_type binary_type;
156 enum dso_load_errno load_errno;
161 u8 annotate_warned:1;
162 u8 short_name_allocated:1;
163 u8 long_name_allocated:1;
168 u8 build_id[BUILD_ID_SIZE];
170 const char *short_name;
171 const char *long_name;
174 void *dwfl; /* DWARF debug info */
175 struct auxtrace_cache *auxtrace_cache;
179 struct rb_root cache;
184 struct list_head open_entry;
185 u64 debug_frame_offset;
186 u64 eh_frame_hdr_offset;
189 union { /* Tool specific area */
193 struct nsinfo *nsinfo;
198 /* dso__for_each_symbol - iterate over the symbols of given type
200 * @dso: the 'struct dso *' in which symbols itereated
201 * @pos: the 'struct symbol *' to use as a loop cursor
202 * @n: the 'struct rb_node *' to use as a temporary storage
203 * @type: the 'enum map_type' type of symbols
205 #define dso__for_each_symbol(dso, pos, n, type) \
206 symbols__for_each_entry(&(dso)->symbols[(type)], pos, n)
208 static inline void dso__set_loaded(struct dso *dso, enum map_type type)
210 dso->loaded |= (1 << type);
213 struct dso *dso__new(const char *name);
214 void dso__delete(struct dso *dso);
216 void dso__set_short_name(struct dso *dso, const char *name, bool name_allocated);
217 void dso__set_long_name(struct dso *dso, const char *name, bool name_allocated);
219 int dso__name_len(const struct dso *dso);
221 struct dso *dso__get(struct dso *dso);
222 void dso__put(struct dso *dso);
224 static inline void __dso__zput(struct dso **dso)
230 #define dso__zput(dso) __dso__zput(&dso)
232 bool dso__loaded(const struct dso *dso, enum map_type type);
234 bool dso__sorted_by_name(const struct dso *dso, enum map_type type);
235 void dso__set_sorted_by_name(struct dso *dso, enum map_type type);
236 void dso__sort_by_name(struct dso *dso, enum map_type type);
238 void dso__set_build_id(struct dso *dso, void *build_id);
239 bool dso__build_id_equal(const struct dso *dso, u8 *build_id);
240 void dso__read_running_kernel_build_id(struct dso *dso,
241 struct machine *machine);
242 int dso__kernel_module_get_build_id(struct dso *dso, const char *root_dir);
244 char dso__symtab_origin(const struct dso *dso);
245 int dso__read_binary_type_filename(const struct dso *dso, enum dso_binary_type type,
246 char *root_dir, char *filename, size_t size);
247 bool is_supported_compression(const char *ext);
248 bool is_kernel_module(const char *pathname, int cpumode);
249 bool decompress_to_file(const char *ext, const char *filename, int output_fd);
250 bool dso__needs_decompress(struct dso *dso);
251 int dso__decompress_kmodule_fd(struct dso *dso, const char *name);
252 int dso__decompress_kmodule_path(struct dso *dso, const char *name,
253 char *pathname, size_t len);
255 #define KMOD_DECOMP_NAME "/tmp/perf-kmod-XXXXXX"
256 #define KMOD_DECOMP_LEN sizeof(KMOD_DECOMP_NAME)
265 int __kmod_path__parse(struct kmod_path *m, const char *path,
266 bool alloc_name, bool alloc_ext);
268 #define kmod_path__parse(__m, __p) __kmod_path__parse(__m, __p, false, false)
269 #define kmod_path__parse_name(__m, __p) __kmod_path__parse(__m, __p, true , false)
270 #define kmod_path__parse_ext(__m, __p) __kmod_path__parse(__m, __p, false, true)
272 void dso__set_module_info(struct dso *dso, struct kmod_path *m,
273 struct machine *machine);
276 * The dso__data_* external interface provides following functions:
281 * dso__data_read_offset
282 * dso__data_read_addr
284 * Please refer to the dso.c object code for each function and
285 * arguments documentation. Following text tries to explain the
286 * dso file descriptor caching.
288 * The dso__data* interface allows caching of opened file descriptors
289 * to speed up the dso data accesses. The idea is to leave the file
290 * descriptor opened ideally for the whole life of the dso object.
292 * The current usage of the dso__data_* interface is as follows:
295 * int fd = dso__data_get_fd(dso, machine);
298 * dso__data_put_fd(dso);
302 * n = dso__data_read_offset(dso_0, &machine, 0, buf, BUFSIZE);
303 * n = dso__data_read_addr(dso_0, &machine, 0, buf, BUFSIZE);
305 * Eventually close DSO's fd:
306 * dso__data_close(dso);
308 * It is not necessary to close the DSO object data file. Each time new
309 * DSO data file is opened, the limit (RLIMIT_NOFILE/2) is checked. Once
310 * it is crossed, the oldest opened DSO object is closed.
312 * The dso__delete function calls close_dso function to ensure the
313 * data file descriptor gets closed/unmapped before the dso object
318 int dso__data_get_fd(struct dso *dso, struct machine *machine);
319 void dso__data_put_fd(struct dso *dso);
320 void dso__data_close(struct dso *dso);
322 off_t dso__data_size(struct dso *dso, struct machine *machine);
323 ssize_t dso__data_read_offset(struct dso *dso, struct machine *machine,
324 u64 offset, u8 *data, ssize_t size);
325 ssize_t dso__data_read_addr(struct dso *dso, struct map *map,
326 struct machine *machine, u64 addr,
327 u8 *data, ssize_t size);
328 bool dso__data_status_seen(struct dso *dso, enum dso_data_status_seen by);
330 struct map *dso__new_map(const char *name);
331 struct dso *machine__findnew_kernel(struct machine *machine, const char *name,
332 const char *short_name, int dso_type);
334 void __dsos__add(struct dsos *dsos, struct dso *dso);
335 void dsos__add(struct dsos *dsos, struct dso *dso);
336 struct dso *__dsos__addnew(struct dsos *dsos, const char *name);
337 struct dso *__dsos__find(struct dsos *dsos, const char *name, bool cmp_short);
338 struct dso *dsos__find(struct dsos *dsos, const char *name, bool cmp_short);
339 struct dso *__dsos__findnew(struct dsos *dsos, const char *name);
340 struct dso *dsos__findnew(struct dsos *dsos, const char *name);
341 bool __dsos__read_build_ids(struct list_head *head, bool with_hits);
343 void dso__reset_find_symbol_cache(struct dso *dso);
345 size_t __dsos__fprintf_buildid(struct list_head *head, FILE *fp,
346 bool (skip)(struct dso *dso, int parm), int parm);
347 size_t __dsos__fprintf(struct list_head *head, FILE *fp);
349 size_t dso__fprintf_buildid(struct dso *dso, FILE *fp);
350 size_t dso__fprintf_symbols_by_name(struct dso *dso,
351 enum map_type type, FILE *fp);
352 size_t dso__fprintf(struct dso *dso, enum map_type type, FILE *fp);
354 static inline bool dso__is_vmlinux(struct dso *dso)
356 return dso->binary_type == DSO_BINARY_TYPE__VMLINUX ||
357 dso->binary_type == DSO_BINARY_TYPE__GUEST_VMLINUX;
360 static inline bool dso__is_kcore(struct dso *dso)
362 return dso->binary_type == DSO_BINARY_TYPE__KCORE ||
363 dso->binary_type == DSO_BINARY_TYPE__GUEST_KCORE;
366 static inline bool dso__is_kallsyms(struct dso *dso)
368 return dso->kernel && dso->long_name[0] != '/';
371 void dso__free_a2l(struct dso *dso);
373 enum dso_type dso__type(struct dso *dso, struct machine *machine);
375 int dso__strerror_load(struct dso *dso, char *buf, size_t buflen);
377 void reset_fd_limit(void);
379 #endif /* __PERF_DSO */