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