perf tools: Get rid of dso__data_fd() from dso__data_size()
[linux-2.6-block.git] / tools / perf / util / dso.h
CommitLineData
cdd059d7
JO
1#ifndef __PERF_DSO
2#define __PERF_DSO
3
4#include <linux/types.h>
5#include <linux/rbtree.h>
39b12f78 6#include <stdbool.h>
d944c4ee 7#include <linux/types.h>
2b5b8bb2 8#include <linux/bitops.h>
cdd059d7 9#include "map.h"
86c98cab 10#include "build-id.h"
cdd059d7
JO
11
12enum 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,
c00c48fc 25 DSO_BINARY_TYPE__GUEST_KMODULE_COMP,
cdd059d7 26 DSO_BINARY_TYPE__SYSTEM_PATH_KMODULE,
c00c48fc 27 DSO_BINARY_TYPE__SYSTEM_PATH_KMODULE_COMP,
8e0cf965
AH
28 DSO_BINARY_TYPE__KCORE,
29 DSO_BINARY_TYPE__GUEST_KCORE,
9cd00941 30 DSO_BINARY_TYPE__OPENEMBEDDED_DEBUGINFO,
cdd059d7
JO
31 DSO_BINARY_TYPE__NOT_FOUND,
32};
33
34enum dso_kernel_type {
35 DSO_TYPE_USER = 0,
36 DSO_TYPE_KERNEL,
37 DSO_TYPE_GUEST_KERNEL
38};
39
40enum dso_swap_type {
41 DSO_SWAP__UNSET,
42 DSO_SWAP__NO,
43 DSO_SWAP__YES,
44};
45
c27697d6
AH
46enum dso_data_status {
47 DSO_DATA_STATUS_ERROR = -1,
48 DSO_DATA_STATUS_UNKNOWN = 0,
49 DSO_DATA_STATUS_OK = 1,
50};
51
288be943
AH
52enum dso_data_status_seen {
53 DSO_DATA_STATUS_SEEN_ITRACE,
54};
55
2b5b8bb2
AH
56enum dso_type {
57 DSO__TYPE_UNKNOWN,
58 DSO__TYPE_64BIT,
59 DSO__TYPE_32BIT,
60 DSO__TYPE_X32BIT,
61};
62
18425f13
ACM
63enum 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
cdd059d7
JO
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
113struct dso_cache {
114 struct rb_node rb_node;
115 u64 offset;
116 u64 size;
117 char data[0];
118};
119
8fa7d87f 120/*
4598a0a6
WL
121 * DSOs are put into both a list for fast iteration and rbtree for fast
122 * long name lookup.
8fa7d87f
WL
123 */
124struct dsos {
125 struct list_head head;
4598a0a6 126 struct rb_root root; /* rbtree root sorted by long name */
8fa7d87f
WL
127};
128
cfe9174f
AH
129struct auxtrace_cache;
130
cdd059d7 131struct dso {
4a936edc 132 pthread_mutex_t lock;
cdd059d7 133 struct list_head node;
4598a0a6 134 struct rb_node rb_node; /* rbtree node sorted by long name */
cdd059d7
JO
135 struct rb_root symbols[MAP__NR_TYPES];
136 struct rb_root symbol_names[MAP__NR_TYPES];
454ff00f 137 void *a2l;
0058aef6 138 char *symsrc_filename;
906049c8 139 unsigned int a2l_fails;
cdd059d7
JO
140 enum dso_kernel_type kernel;
141 enum dso_swap_type needs_swap;
142 enum dso_binary_type symtab_type;
5f70619d 143 enum dso_binary_type binary_type;
18425f13 144 enum dso_load_errno load_errno;
cdd059d7
JO
145 u8 adjust_symbols:1;
146 u8 has_build_id:1;
2cc9d0ef 147 u8 has_srcline:1;
cdd059d7
JO
148 u8 hit:1;
149 u8 annotate_warned:1;
c7282f2e
ACM
150 u8 short_name_allocated:1;
151 u8 long_name_allocated:1;
c6d8f2a4 152 u8 is_64_bit:1;
cdd059d7
JO
153 u8 sorted_by_name;
154 u8 loaded;
0131c4ec 155 u8 rel;
cdd059d7
JO
156 u8 build_id[BUILD_ID_SIZE];
157 const char *short_name;
bf4414ae 158 const char *long_name;
cdd059d7
JO
159 u16 long_name_len;
160 u16 short_name_len;
7d073b33 161 void *dwfl; /* DWARF debug info */
cfe9174f 162 struct auxtrace_cache *auxtrace_cache;
ca40e2af
JO
163
164 /* dso data file */
165 struct {
166 struct rb_root cache;
53fa8eaa 167 int fd;
c27697d6 168 int status;
288be943 169 u32 status_seen;
c3fbd2a6 170 size_t file_size;
eba5102d 171 struct list_head open_entry;
303cb89a
WN
172 u64 debug_frame_offset;
173 u64 eh_frame_hdr_offset;
ca40e2af
JO
174 } data;
175
0db15b1e
AH
176 union { /* Tool specific area */
177 void *priv;
178 u64 db_id;
179 };
180
cdd059d7
JO
181 char name[0];
182};
183
eb948e50
MH
184/* dso__for_each_symbol - iterate over the symbols of given type
185 *
186 * @dso: the 'struct dso *' in which symbols itereated
187 * @pos: the 'struct symbol *' to use as a loop cursor
188 * @n: the 'struct rb_node *' to use as a temporary storage
189 * @type: the 'enum map_type' type of symbols
190 */
191#define dso__for_each_symbol(dso, pos, n, type) \
192 symbols__for_each_entry(&(dso)->symbols[(type)], pos, n)
193
cdd059d7
JO
194static inline void dso__set_loaded(struct dso *dso, enum map_type type)
195{
196 dso->loaded |= (1 << type);
197}
198
199struct dso *dso__new(const char *name);
200void dso__delete(struct dso *dso);
201
58a98c9c 202void dso__set_short_name(struct dso *dso, const char *name, bool name_allocated);
bf4414ae 203void dso__set_long_name(struct dso *dso, const char *name, bool name_allocated);
cdd059d7
JO
204
205int dso__name_len(const struct dso *dso);
206
207bool dso__loaded(const struct dso *dso, enum map_type type);
208
209bool dso__sorted_by_name(const struct dso *dso, enum map_type type);
210void dso__set_sorted_by_name(struct dso *dso, enum map_type type);
211void dso__sort_by_name(struct dso *dso, enum map_type type);
212
213void dso__set_build_id(struct dso *dso, void *build_id);
214bool dso__build_id_equal(const struct dso *dso, u8 *build_id);
215void dso__read_running_kernel_build_id(struct dso *dso,
216 struct machine *machine);
217int dso__kernel_module_get_build_id(struct dso *dso, const char *root_dir);
218
219char dso__symtab_origin(const struct dso *dso);
ee4e9625
ACM
220int dso__read_binary_type_filename(const struct dso *dso, enum dso_binary_type type,
221 char *root_dir, char *filename, size_t size);
c00c48fc 222bool is_supported_compression(const char *ext);
e746b3ea 223bool is_kernel_module(const char *pathname);
c00c48fc
NK
224bool decompress_to_file(const char *ext, const char *filename, int output_fd);
225bool dso__needs_decompress(struct dso *dso);
cdd059d7 226
3c8a67f5
JO
227struct kmod_path {
228 char *name;
229 char *ext;
230 bool comp;
231 bool kmod;
232};
233
234int __kmod_path__parse(struct kmod_path *m, const char *path,
235 bool alloc_name, bool alloc_ext);
236
237#define kmod_path__parse(__m, __p) __kmod_path__parse(__m, __p, false, false)
238#define kmod_path__parse_name(__m, __p) __kmod_path__parse(__m, __p, true , false)
239#define kmod_path__parse_ext(__m, __p) __kmod_path__parse(__m, __p, false, true)
240
c1f9aa0a
JO
241/*
242 * The dso__data_* external interface provides following functions:
243 * dso__data_fd
244 * dso__data_close
6d363459 245 * dso__data_size
c1f9aa0a
JO
246 * dso__data_read_offset
247 * dso__data_read_addr
248 *
249 * Please refer to the dso.c object code for each function and
250 * arguments documentation. Following text tries to explain the
251 * dso file descriptor caching.
252 *
253 * The dso__data* interface allows caching of opened file descriptors
254 * to speed up the dso data accesses. The idea is to leave the file
255 * descriptor opened ideally for the whole life of the dso object.
256 *
257 * The current usage of the dso__data_* interface is as follows:
258 *
259 * Get DSO's fd:
260 * int fd = dso__data_fd(dso, machine);
261 * USE 'fd' SOMEHOW
262 *
263 * Read DSO's data:
264 * n = dso__data_read_offset(dso_0, &machine, 0, buf, BUFSIZE);
265 * n = dso__data_read_addr(dso_0, &machine, 0, buf, BUFSIZE);
266 *
267 * Eventually close DSO's fd:
268 * dso__data_close(dso);
269 *
270 * It is not necessary to close the DSO object data file. Each time new
271 * DSO data file is opened, the limit (RLIMIT_NOFILE/2) is checked. Once
272 * it is crossed, the oldest opened DSO object is closed.
273 *
274 * The dso__delete function calls close_dso function to ensure the
275 * data file descriptor gets closed/unmapped before the dso object
276 * is freed.
277 *
278 * TODO
279*/
cdd059d7 280int dso__data_fd(struct dso *dso, struct machine *machine);
53fa8eaa
JO
281void dso__data_close(struct dso *dso);
282
6d363459 283off_t dso__data_size(struct dso *dso, struct machine *machine);
cdd059d7
JO
284ssize_t dso__data_read_offset(struct dso *dso, struct machine *machine,
285 u64 offset, u8 *data, ssize_t size);
286ssize_t dso__data_read_addr(struct dso *dso, struct map *map,
287 struct machine *machine, u64 addr,
288 u8 *data, ssize_t size);
288be943 289bool dso__data_status_seen(struct dso *dso, enum dso_data_status_seen by);
cdd059d7
JO
290
291struct map *dso__new_map(const char *name);
292struct dso *dso__kernel_findnew(struct machine *machine, const char *name,
293 const char *short_name, int dso_type);
294
8fa7d87f 295void dsos__add(struct dsos *dsos, struct dso *dso);
701d8d7f 296struct dso *dsos__addnew(struct dsos *dsos, const char *name);
8fa7d87f 297struct dso *dsos__find(const struct dsos *dsos, const char *name,
f9ceffb6 298 bool cmp_short);
8fa7d87f 299struct dso *__dsos__findnew(struct dsos *dsos, const char *name);
cdd059d7
JO
300bool __dsos__read_build_ids(struct list_head *head, bool with_hits);
301
302size_t __dsos__fprintf_buildid(struct list_head *head, FILE *fp,
417c2ff6 303 bool (skip)(struct dso *dso, int parm), int parm);
cdd059d7
JO
304size_t __dsos__fprintf(struct list_head *head, FILE *fp);
305
306size_t dso__fprintf_buildid(struct dso *dso, FILE *fp);
307size_t dso__fprintf_symbols_by_name(struct dso *dso,
308 enum map_type type, FILE *fp);
309size_t dso__fprintf(struct dso *dso, enum map_type type, FILE *fp);
39b12f78
AH
310
311static inline bool dso__is_vmlinux(struct dso *dso)
312{
5f70619d
ACM
313 return dso->binary_type == DSO_BINARY_TYPE__VMLINUX ||
314 dso->binary_type == DSO_BINARY_TYPE__GUEST_VMLINUX;
39b12f78
AH
315}
316
8e0cf965
AH
317static inline bool dso__is_kcore(struct dso *dso)
318{
5f70619d
ACM
319 return dso->binary_type == DSO_BINARY_TYPE__KCORE ||
320 dso->binary_type == DSO_BINARY_TYPE__GUEST_KCORE;
8e0cf965
AH
321}
322
454ff00f
AH
323void dso__free_a2l(struct dso *dso);
324
2b5b8bb2
AH
325enum dso_type dso__type(struct dso *dso, struct machine *machine);
326
18425f13
ACM
327int dso__strerror_load(struct dso *dso, char *buf, size_t buflen);
328
cdd059d7 329#endif /* __PERF_DSO */