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