1 /* SPDX-License-Identifier: GPL-2.0 */
2 #ifndef __PERF_DSO
3 #define __PERF_DSO
4
5 #include <pthread.h>
6 #include <linux/refcount.h>
7 #include <linux/types.h>
8 #include <linux/rbtree.h>
9 #include <sys/types.h>
10 #include <stdbool.h>
11 #include <stdio.h>
12 #include <linux/bitops.h>
13 #include "build-id.h"
14
15 struct machine;
16 struct map;
17 struct perf_env;
18
19 #define DSO__NAME_KALLSYMS "[kernel.kallsyms]"
20 #define DSO__NAME_KCORE "[kernel.kcore]"
21
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__OOL,
46 DSO_BINARY_TYPE__NOT_FOUND,
47 };
48
49 enum dso_space_type {
50 DSO_SPACE__USER = 0,
51 DSO_SPACE__KERNEL,
52 DSO_SPACE__KERNEL_GUEST
53 };
54
55 enum dso_swap_type {
56 DSO_SWAP__UNSET,
57 DSO_SWAP__NO,
58 DSO_SWAP__YES,
59 };
60
61 enum dso_data_status {
62 DSO_DATA_STATUS_ERROR = -1,
63 DSO_DATA_STATUS_UNKNOWN = 0,
64 DSO_DATA_STATUS_OK = 1,
65 };
66
67 enum dso_data_status_seen {
68 DSO_DATA_STATUS_SEEN_ITRACE,
69 };
70
71 enum dso_type {
72 DSO__TYPE_UNKNOWN,
73 DSO__TYPE_64BIT,
74 DSO__TYPE_32BIT,
75 DSO__TYPE_X32BIT,
76 };
77
78 enum 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 */
131 struct dso_id {
132 u32 maj;
133 u32 min;
134 u64 ino;
135 u64 ino_generation;
136 };
137
138 struct dso_cache {
139 struct rb_node rb_node;
140 u64 offset;
141 u64 size;
142 char data[];
143 };
144
145 struct auxtrace_cache;
146
147 struct dso {
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;
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 has_srcline:1;
171 u8 hit:1;
172 u8 annotate_warned:1;
173 u8 short_name_allocated:1;
174 u8 long_name_allocated:1;
175 u8 is_64_bit:1;
176 bool sorted_by_name;
177 bool loaded;
178 u8 rel;
179 struct build_id bid;
180 u64 text_offset;
181 const char *short_name;
182 const char *long_name;
183 u16 long_name_len;
184 u16 short_name_len;
185 void *dwfl; /* DWARF debug info */
186 struct auxtrace_cache *auxtrace_cache;
187 int comp;
188
189 /* dso data file */
190 struct {
191 struct rb_root cache;
192 int fd;
193 int status;
194 u32 status_seen;
195 size_t file_size;
196 struct list_head open_entry;
197 u64 debug_frame_offset;
198 u64 eh_frame_hdr_offset;
199 } data;
200 /* bpf prog information */
201 struct {
202 u32 id;
203 u32 sub_id;
204 struct perf_env *env;
205 } bpf_prog;
206
207 union { /* Tool specific area */
208 void *priv;
209 u64 db_id;
210 };
211 struct nsinfo *nsinfo;
212 struct dso_id id;
213 refcount_t refcnt;
214 char name[];
215 };
216
217 /* dso__for_each_symbol - iterate over the symbols of given type
218 *
219 * @dso: the 'struct dso *' in which symbols are iterated
220 * @pos: the 'struct symbol *' to use as a loop cursor
221 * @n: the 'struct rb_node *' to use as a temporary storage
222 */
223 #define dso__for_each_symbol(dso, pos, n) \
224 symbols__for_each_entry(&(dso)->symbols, pos, n)
225
dso__set_loaded(struct dso * dso)226 static inline void dso__set_loaded(struct dso *dso)
227 {
228 dso->loaded = true;
229 }
230
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);
234
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);
238
239 int dso__name_len(const struct dso *dso);
240
241 struct dso *dso__get(struct dso *dso);
242 void dso__put(struct dso *dso);
243
__dso__zput(struct dso ** dso)244 static inline void __dso__zput(struct dso **dso)
245 {
246 dso__put(*dso);
247 *dso = NULL;
248 }
249
250 #define dso__zput(dso) __dso__zput(&dso)
251
252 bool dso__loaded(const struct dso *dso);
253
dso__has_symbols(const struct dso * dso)254 static inline bool dso__has_symbols(const struct dso *dso)
255 {
256 return !RB_EMPTY_ROOT(&dso->symbols.rb_root);
257 }
258
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);
262
263 void dso__set_build_id(struct dso *dso, struct build_id *bid);
264 bool dso__build_id_equal(const struct dso *dso, struct build_id *bid);
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);
268
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);
277 int filename__decompress(const char *name, char *pathname,
278 size_t len, int comp, int *err);
279
280 #define KMOD_DECOMP_NAME "/tmp/perf-kmod-XXXXXX"
281 #define KMOD_DECOMP_LEN sizeof(KMOD_DECOMP_NAME)
282
283 struct kmod_path {
284 char *name;
285 int comp;
286 bool kmod;
287 };
288
289 int __kmod_path__parse(struct kmod_path *m, const char *path,
290 bool alloc_name);
291
292 #define kmod_path__parse(__m, __p) __kmod_path__parse(__m, __p, false)
293 #define kmod_path__parse_name(__m, __p) __kmod_path__parse(__m, __p, true)
294
295 void dso__set_module_info(struct dso *dso, struct kmod_path *m,
296 struct machine *machine);
297
298 /*
299 * The dso__data_* external interface provides following functions:
300 * dso__data_get_fd
301 * dso__data_put_fd
302 * dso__data_close
303 * dso__data_size
304 * dso__data_read_offset
305 * dso__data_read_addr
306 * dso__data_write_cache_offs
307 * dso__data_write_cache_addr
308 *
309 * Please refer to the dso.c object code for each function and
310 * arguments documentation. Following text tries to explain the
311 * dso file descriptor caching.
312 *
313 * The dso__data* interface allows caching of opened file descriptors
314 * to speed up the dso data accesses. The idea is to leave the file
315 * descriptor opened ideally for the whole life of the dso object.
316 *
317 * The current usage of the dso__data_* interface is as follows:
318 *
319 * Get DSO's fd:
320 * int fd = dso__data_get_fd(dso, machine);
321 * if (fd >= 0) {
322 * USE 'fd' SOMEHOW
323 * dso__data_put_fd(dso);
324 * }
325 *
326 * Read DSO's data:
327 * n = dso__data_read_offset(dso_0, &machine, 0, buf, BUFSIZE);
328 * n = dso__data_read_addr(dso_0, &machine, 0, buf, BUFSIZE);
329 *
330 * Eventually close DSO's fd:
331 * dso__data_close(dso);
332 *
333 * It is not necessary to close the DSO object data file. Each time new
334 * DSO data file is opened, the limit (RLIMIT_NOFILE/2) is checked. Once
335 * it is crossed, the oldest opened DSO object is closed.
336 *
337 * The dso__delete function calls close_dso function to ensure the
338 * data file descriptor gets closed/unmapped before the dso object
339 * is freed.
340 *
341 * TODO
342 */
343 int dso__data_get_fd(struct dso *dso, struct machine *machine);
344 void dso__data_put_fd(struct dso *dso);
345 void dso__data_close(struct dso *dso);
346
347 int dso__data_file_size(struct dso *dso, struct machine *machine);
348 off_t dso__data_size(struct dso *dso, struct machine *machine);
349 ssize_t dso__data_read_offset(struct dso *dso, struct machine *machine,
350 u64 offset, u8 *data, ssize_t size);
351 ssize_t dso__data_read_addr(struct dso *dso, struct map *map,
352 struct machine *machine, u64 addr,
353 u8 *data, ssize_t size);
354 bool dso__data_status_seen(struct dso *dso, enum dso_data_status_seen by);
355 ssize_t dso__data_write_cache_offs(struct dso *dso, struct machine *machine,
356 u64 offset, const u8 *data, ssize_t size);
357 ssize_t dso__data_write_cache_addr(struct dso *dso, struct map *map,
358 struct machine *machine, u64 addr,
359 const u8 *data, ssize_t size);
360
361 struct map *dso__new_map(const char *name);
362 struct dso *machine__findnew_kernel(struct machine *machine, const char *name,
363 const char *short_name, int dso_type);
364
365 void dso__reset_find_symbol_cache(struct dso *dso);
366
367 size_t dso__fprintf_symbols_by_name(struct dso *dso, FILE *fp);
368 size_t dso__fprintf(struct dso *dso, FILE *fp);
369
dso__is_vmlinux(struct dso * dso)370 static inline bool dso__is_vmlinux(struct dso *dso)
371 {
372 return dso->binary_type == DSO_BINARY_TYPE__VMLINUX ||
373 dso->binary_type == DSO_BINARY_TYPE__GUEST_VMLINUX;
374 }
375
dso__is_kcore(struct dso * dso)376 static inline bool dso__is_kcore(struct dso *dso)
377 {
378 return dso->binary_type == DSO_BINARY_TYPE__KCORE ||
379 dso->binary_type == DSO_BINARY_TYPE__GUEST_KCORE;
380 }
381
dso__is_kallsyms(struct dso * dso)382 static inline bool dso__is_kallsyms(struct dso *dso)
383 {
384 return dso->kernel && dso->long_name[0] != '/';
385 }
386
387 void dso__free_a2l(struct dso *dso);
388
389 enum dso_type dso__type(struct dso *dso, struct machine *machine);
390
391 int dso__strerror_load(struct dso *dso, char *buf, size_t buflen);
392
393 void reset_fd_limit(void);
394
395 #endif /* __PERF_DSO */
396