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,
45 DSO_BINARY_TYPE__NOT_FOUND,
48 enum dso_kernel_type {
60 enum dso_data_status {
61 DSO_DATA_STATUS_ERROR = -1,
62 DSO_DATA_STATUS_UNKNOWN = 0,
63 DSO_DATA_STATUS_OK = 1,
66 enum dso_data_status_seen {
67 DSO_DATA_STATUS_SEEN_ITRACE,
78 DSO_LOAD_ERRNO__SUCCESS = 0,
81 * Choose an arbitrary negative big number not to clash with standard
82 * errno since SUS requires the errno has distinct positive values.
83 * See 'Issue 6' in the link below.
85 * http://pubs.opengroup.org/onlinepubs/9699919799/basedefs/errno.h.html
87 __DSO_LOAD_ERRNO__START = -10000,
89 DSO_LOAD_ERRNO__INTERNAL_ERROR = __DSO_LOAD_ERRNO__START,
91 /* for symsrc__init() */
92 DSO_LOAD_ERRNO__INVALID_ELF,
93 DSO_LOAD_ERRNO__CANNOT_READ_BUILDID,
94 DSO_LOAD_ERRNO__MISMATCHING_BUILDID,
96 /* for decompress_kmodule */
97 DSO_LOAD_ERRNO__DECOMPRESSION_FAILURE,
99 __DSO_LOAD_ERRNO__END,
102 #define DSO__SWAP(dso, type, val) \
105 BUG_ON(dso->needs_swap == DSO_SWAP__UNSET); \
106 if (dso->needs_swap == DSO_SWAP__YES) { \
107 switch (sizeof(____r)) { \
109 ____r = bswap_16(val); \
112 ____r = bswap_32(val); \
115 ____r = bswap_64(val); \
124 #define DSO__DATA_CACHE_SIZE 4096
125 #define DSO__DATA_CACHE_MASK ~(DSO__DATA_CACHE_SIZE - 1)
128 * Data about backing storage DSO, comes from PERF_RECORD_MMAP2 meta events
138 struct rb_node rb_node;
144 struct auxtrace_cache;
147 pthread_mutex_t lock;
148 struct list_head node;
149 struct rb_node rb_node; /* rbtree node sorted by long name */
150 struct rb_root *root; /* root of rbtree that rb_node is in */
151 struct rb_root_cached symbols;
152 struct rb_root_cached symbol_names;
153 struct rb_root_cached inlined_nodes;
154 struct rb_root_cached srclines;
157 struct symbol *symbol;
160 char *symsrc_filename;
161 unsigned int a2l_fails;
162 enum dso_kernel_type kernel;
163 enum dso_swap_type needs_swap;
164 enum dso_binary_type symtab_type;
165 enum dso_binary_type binary_type;
166 enum dso_load_errno load_errno;
171 u8 annotate_warned:1;
172 u8 short_name_allocated:1;
173 u8 long_name_allocated:1;
178 u8 build_id[BUILD_ID_SIZE];
180 const char *short_name;
181 const char *long_name;
184 void *dwfl; /* DWARF debug info */
185 struct auxtrace_cache *auxtrace_cache;
190 struct rb_root cache;
195 struct list_head open_entry;
196 u64 debug_frame_offset;
197 u64 eh_frame_hdr_offset;
199 /* bpf prog information */
203 struct perf_env *env;
206 union { /* Tool specific area */
210 struct nsinfo *nsinfo;
216 /* dso__for_each_symbol - iterate over the symbols of given type
218 * @dso: the 'struct dso *' in which symbols itereated
219 * @pos: the 'struct symbol *' to use as a loop cursor
220 * @n: the 'struct rb_node *' to use as a temporary storage
222 #define dso__for_each_symbol(dso, pos, n) \
223 symbols__for_each_entry(&(dso)->symbols, pos, n)
225 static inline void dso__set_loaded(struct dso *dso)
230 struct dso *dso__new_id(const char *name, struct dso_id *id);
231 struct dso *dso__new(const char *name);
232 void dso__delete(struct dso *dso);
234 int dso__cmp_id(struct dso *a, struct dso *b);
235 void dso__set_short_name(struct dso *dso, const char *name, bool name_allocated);
236 void dso__set_long_name(struct dso *dso, const char *name, bool name_allocated);
238 int dso__name_len(const struct dso *dso);
240 struct dso *dso__get(struct dso *dso);
241 void dso__put(struct dso *dso);
243 static inline void __dso__zput(struct dso **dso)
249 #define dso__zput(dso) __dso__zput(&dso)
251 bool dso__loaded(const struct dso *dso);
253 static inline bool dso__has_symbols(const struct dso *dso)
255 return !RB_EMPTY_ROOT(&dso->symbols.rb_root);
258 bool dso__sorted_by_name(const struct dso *dso);
259 void dso__set_sorted_by_name(struct dso *dso);
260 void dso__sort_by_name(struct dso *dso);
262 void dso__set_build_id(struct dso *dso, void *build_id);
263 bool dso__build_id_equal(const struct dso *dso, u8 *build_id);
264 void dso__read_running_kernel_build_id(struct dso *dso,
265 struct machine *machine);
266 int dso__kernel_module_get_build_id(struct dso *dso, const char *root_dir);
268 char dso__symtab_origin(const struct dso *dso);
269 int dso__read_binary_type_filename(const struct dso *dso, enum dso_binary_type type,
270 char *root_dir, char *filename, size_t size);
271 bool is_kernel_module(const char *pathname, int cpumode);
272 bool dso__needs_decompress(struct dso *dso);
273 int dso__decompress_kmodule_fd(struct dso *dso, const char *name);
274 int dso__decompress_kmodule_path(struct dso *dso, const char *name,
275 char *pathname, size_t len);
277 #define KMOD_DECOMP_NAME "/tmp/perf-kmod-XXXXXX"
278 #define KMOD_DECOMP_LEN sizeof(KMOD_DECOMP_NAME)
286 int __kmod_path__parse(struct kmod_path *m, const char *path,
289 #define kmod_path__parse(__m, __p) __kmod_path__parse(__m, __p, false)
290 #define kmod_path__parse_name(__m, __p) __kmod_path__parse(__m, __p, true)
292 void dso__set_module_info(struct dso *dso, struct kmod_path *m,
293 struct machine *machine);
296 * The dso__data_* external interface provides following functions:
301 * dso__data_read_offset
302 * dso__data_read_addr
303 * dso__data_write_cache_offs
304 * dso__data_write_cache_addr
306 * Please refer to the dso.c object code for each function and
307 * arguments documentation. Following text tries to explain the
308 * dso file descriptor caching.
310 * The dso__data* interface allows caching of opened file descriptors
311 * to speed up the dso data accesses. The idea is to leave the file
312 * descriptor opened ideally for the whole life of the dso object.
314 * The current usage of the dso__data_* interface is as follows:
317 * int fd = dso__data_get_fd(dso, machine);
320 * dso__data_put_fd(dso);
324 * n = dso__data_read_offset(dso_0, &machine, 0, buf, BUFSIZE);
325 * n = dso__data_read_addr(dso_0, &machine, 0, buf, BUFSIZE);
327 * Eventually close DSO's fd:
328 * dso__data_close(dso);
330 * It is not necessary to close the DSO object data file. Each time new
331 * DSO data file is opened, the limit (RLIMIT_NOFILE/2) is checked. Once
332 * it is crossed, the oldest opened DSO object is closed.
334 * The dso__delete function calls close_dso function to ensure the
335 * data file descriptor gets closed/unmapped before the dso object
340 int dso__data_get_fd(struct dso *dso, struct machine *machine);
341 void dso__data_put_fd(struct dso *dso);
342 void dso__data_close(struct dso *dso);
344 int dso__data_file_size(struct dso *dso, struct machine *machine);
345 off_t dso__data_size(struct dso *dso, struct machine *machine);
346 ssize_t dso__data_read_offset(struct dso *dso, struct machine *machine,
347 u64 offset, u8 *data, ssize_t size);
348 ssize_t dso__data_read_addr(struct dso *dso, struct map *map,
349 struct machine *machine, u64 addr,
350 u8 *data, ssize_t size);
351 bool dso__data_status_seen(struct dso *dso, enum dso_data_status_seen by);
352 ssize_t dso__data_write_cache_offs(struct dso *dso, struct machine *machine,
353 u64 offset, const u8 *data, ssize_t size);
354 ssize_t dso__data_write_cache_addr(struct dso *dso, struct map *map,
355 struct machine *machine, u64 addr,
356 const u8 *data, ssize_t size);
358 struct map *dso__new_map(const char *name);
359 struct dso *machine__findnew_kernel(struct machine *machine, const char *name,
360 const char *short_name, int dso_type);
362 void dso__reset_find_symbol_cache(struct dso *dso);
364 size_t dso__fprintf_buildid(struct dso *dso, FILE *fp);
365 size_t dso__fprintf_symbols_by_name(struct dso *dso, FILE *fp);
366 size_t dso__fprintf(struct dso *dso, FILE *fp);
368 static inline bool dso__is_vmlinux(struct dso *dso)
370 return dso->binary_type == DSO_BINARY_TYPE__VMLINUX ||
371 dso->binary_type == DSO_BINARY_TYPE__GUEST_VMLINUX;
374 static inline bool dso__is_kcore(struct dso *dso)
376 return dso->binary_type == DSO_BINARY_TYPE__KCORE ||
377 dso->binary_type == DSO_BINARY_TYPE__GUEST_KCORE;
380 static inline bool dso__is_kallsyms(struct dso *dso)
382 return dso->kernel && dso->long_name[0] != '/';
385 void dso__free_a2l(struct dso *dso);
387 enum dso_type dso__type(struct dso *dso, struct machine *machine);
389 int dso__strerror_load(struct dso *dso, char *buf, size_t buflen);
391 void reset_fd_limit(void);
393 #endif /* __PERF_DSO */