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