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