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