Commit | Line | Data |
---|---|---|
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 | |
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, | |
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 | ||
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 | ||
c27697d6 AH |
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 | ||
288be943 AH |
52 | enum dso_data_status_seen { |
53 | DSO_DATA_STATUS_SEEN_ITRACE, | |
54 | }; | |
55 | ||
2b5b8bb2 AH |
56 | enum dso_type { |
57 | DSO__TYPE_UNKNOWN, | |
58 | DSO__TYPE_64BIT, | |
59 | DSO__TYPE_32BIT, | |
60 | DSO__TYPE_X32BIT, | |
61 | }; | |
62 | ||
cdd059d7 JO |
63 | #define DSO__SWAP(dso, type, val) \ |
64 | ({ \ | |
65 | type ____r = val; \ | |
66 | BUG_ON(dso->needs_swap == DSO_SWAP__UNSET); \ | |
67 | if (dso->needs_swap == DSO_SWAP__YES) { \ | |
68 | switch (sizeof(____r)) { \ | |
69 | case 2: \ | |
70 | ____r = bswap_16(val); \ | |
71 | break; \ | |
72 | case 4: \ | |
73 | ____r = bswap_32(val); \ | |
74 | break; \ | |
75 | case 8: \ | |
76 | ____r = bswap_64(val); \ | |
77 | break; \ | |
78 | default: \ | |
79 | BUG_ON(1); \ | |
80 | } \ | |
81 | } \ | |
82 | ____r; \ | |
83 | }) | |
84 | ||
85 | #define DSO__DATA_CACHE_SIZE 4096 | |
86 | #define DSO__DATA_CACHE_MASK ~(DSO__DATA_CACHE_SIZE - 1) | |
87 | ||
88 | struct dso_cache { | |
89 | struct rb_node rb_node; | |
90 | u64 offset; | |
91 | u64 size; | |
92 | char data[0]; | |
93 | }; | |
94 | ||
8fa7d87f | 95 | /* |
4598a0a6 WL |
96 | * DSOs are put into both a list for fast iteration and rbtree for fast |
97 | * long name lookup. | |
8fa7d87f WL |
98 | */ |
99 | struct dsos { | |
100 | struct list_head head; | |
4598a0a6 | 101 | struct rb_root root; /* rbtree root sorted by long name */ |
8fa7d87f WL |
102 | }; |
103 | ||
cdd059d7 JO |
104 | struct dso { |
105 | struct list_head node; | |
4598a0a6 | 106 | struct rb_node rb_node; /* rbtree node sorted by long name */ |
cdd059d7 JO |
107 | struct rb_root symbols[MAP__NR_TYPES]; |
108 | struct rb_root symbol_names[MAP__NR_TYPES]; | |
454ff00f | 109 | void *a2l; |
0058aef6 | 110 | char *symsrc_filename; |
906049c8 | 111 | unsigned int a2l_fails; |
cdd059d7 JO |
112 | enum dso_kernel_type kernel; |
113 | enum dso_swap_type needs_swap; | |
114 | enum dso_binary_type symtab_type; | |
5f70619d | 115 | enum dso_binary_type binary_type; |
cdd059d7 JO |
116 | u8 adjust_symbols:1; |
117 | u8 has_build_id:1; | |
2cc9d0ef | 118 | u8 has_srcline:1; |
cdd059d7 JO |
119 | u8 hit:1; |
120 | u8 annotate_warned:1; | |
c7282f2e ACM |
121 | u8 short_name_allocated:1; |
122 | u8 long_name_allocated:1; | |
c6d8f2a4 | 123 | u8 is_64_bit:1; |
cdd059d7 JO |
124 | u8 sorted_by_name; |
125 | u8 loaded; | |
0131c4ec | 126 | u8 rel; |
cdd059d7 JO |
127 | u8 build_id[BUILD_ID_SIZE]; |
128 | const char *short_name; | |
bf4414ae | 129 | const char *long_name; |
cdd059d7 JO |
130 | u16 long_name_len; |
131 | u16 short_name_len; | |
7d073b33 | 132 | void *dwfl; /* DWARF debug info */ |
ca40e2af JO |
133 | |
134 | /* dso data file */ | |
135 | struct { | |
136 | struct rb_root cache; | |
53fa8eaa | 137 | int fd; |
c27697d6 | 138 | int status; |
288be943 | 139 | u32 status_seen; |
c3fbd2a6 | 140 | size_t file_size; |
eba5102d | 141 | struct list_head open_entry; |
ca40e2af JO |
142 | } data; |
143 | ||
0db15b1e AH |
144 | union { /* Tool specific area */ |
145 | void *priv; | |
146 | u64 db_id; | |
147 | }; | |
148 | ||
cdd059d7 JO |
149 | char name[0]; |
150 | }; | |
151 | ||
eb948e50 MH |
152 | /* dso__for_each_symbol - iterate over the symbols of given type |
153 | * | |
154 | * @dso: the 'struct dso *' in which symbols itereated | |
155 | * @pos: the 'struct symbol *' to use as a loop cursor | |
156 | * @n: the 'struct rb_node *' to use as a temporary storage | |
157 | * @type: the 'enum map_type' type of symbols | |
158 | */ | |
159 | #define dso__for_each_symbol(dso, pos, n, type) \ | |
160 | symbols__for_each_entry(&(dso)->symbols[(type)], pos, n) | |
161 | ||
cdd059d7 JO |
162 | static inline void dso__set_loaded(struct dso *dso, enum map_type type) |
163 | { | |
164 | dso->loaded |= (1 << type); | |
165 | } | |
166 | ||
167 | struct dso *dso__new(const char *name); | |
168 | void dso__delete(struct dso *dso); | |
169 | ||
58a98c9c | 170 | void dso__set_short_name(struct dso *dso, const char *name, bool name_allocated); |
bf4414ae | 171 | void dso__set_long_name(struct dso *dso, const char *name, bool name_allocated); |
cdd059d7 JO |
172 | |
173 | int dso__name_len(const struct dso *dso); | |
174 | ||
175 | bool dso__loaded(const struct dso *dso, enum map_type type); | |
176 | ||
177 | bool dso__sorted_by_name(const struct dso *dso, enum map_type type); | |
178 | void dso__set_sorted_by_name(struct dso *dso, enum map_type type); | |
179 | void dso__sort_by_name(struct dso *dso, enum map_type type); | |
180 | ||
181 | void dso__set_build_id(struct dso *dso, void *build_id); | |
182 | bool dso__build_id_equal(const struct dso *dso, u8 *build_id); | |
183 | void dso__read_running_kernel_build_id(struct dso *dso, | |
184 | struct machine *machine); | |
185 | int dso__kernel_module_get_build_id(struct dso *dso, const char *root_dir); | |
186 | ||
187 | char dso__symtab_origin(const struct dso *dso); | |
ee4e9625 ACM |
188 | int dso__read_binary_type_filename(const struct dso *dso, enum dso_binary_type type, |
189 | char *root_dir, char *filename, size_t size); | |
c00c48fc NK |
190 | bool is_supported_compression(const char *ext); |
191 | bool is_kmodule_extension(const char *ext); | |
192 | bool is_kernel_module(const char *pathname, bool *compressed); | |
193 | bool decompress_to_file(const char *ext, const char *filename, int output_fd); | |
194 | bool dso__needs_decompress(struct dso *dso); | |
cdd059d7 | 195 | |
c1f9aa0a JO |
196 | /* |
197 | * The dso__data_* external interface provides following functions: | |
198 | * dso__data_fd | |
199 | * dso__data_close | |
6d363459 | 200 | * dso__data_size |
c1f9aa0a JO |
201 | * dso__data_read_offset |
202 | * dso__data_read_addr | |
203 | * | |
204 | * Please refer to the dso.c object code for each function and | |
205 | * arguments documentation. Following text tries to explain the | |
206 | * dso file descriptor caching. | |
207 | * | |
208 | * The dso__data* interface allows caching of opened file descriptors | |
209 | * to speed up the dso data accesses. The idea is to leave the file | |
210 | * descriptor opened ideally for the whole life of the dso object. | |
211 | * | |
212 | * The current usage of the dso__data_* interface is as follows: | |
213 | * | |
214 | * Get DSO's fd: | |
215 | * int fd = dso__data_fd(dso, machine); | |
216 | * USE 'fd' SOMEHOW | |
217 | * | |
218 | * Read DSO's data: | |
219 | * n = dso__data_read_offset(dso_0, &machine, 0, buf, BUFSIZE); | |
220 | * n = dso__data_read_addr(dso_0, &machine, 0, buf, BUFSIZE); | |
221 | * | |
222 | * Eventually close DSO's fd: | |
223 | * dso__data_close(dso); | |
224 | * | |
225 | * It is not necessary to close the DSO object data file. Each time new | |
226 | * DSO data file is opened, the limit (RLIMIT_NOFILE/2) is checked. Once | |
227 | * it is crossed, the oldest opened DSO object is closed. | |
228 | * | |
229 | * The dso__delete function calls close_dso function to ensure the | |
230 | * data file descriptor gets closed/unmapped before the dso object | |
231 | * is freed. | |
232 | * | |
233 | * TODO | |
234 | */ | |
cdd059d7 | 235 | int dso__data_fd(struct dso *dso, struct machine *machine); |
53fa8eaa JO |
236 | void dso__data_close(struct dso *dso); |
237 | ||
6d363459 | 238 | off_t dso__data_size(struct dso *dso, struct machine *machine); |
cdd059d7 JO |
239 | ssize_t dso__data_read_offset(struct dso *dso, struct machine *machine, |
240 | u64 offset, u8 *data, ssize_t size); | |
241 | ssize_t dso__data_read_addr(struct dso *dso, struct map *map, | |
242 | struct machine *machine, u64 addr, | |
243 | u8 *data, ssize_t size); | |
288be943 | 244 | bool dso__data_status_seen(struct dso *dso, enum dso_data_status_seen by); |
cdd059d7 JO |
245 | |
246 | struct map *dso__new_map(const char *name); | |
247 | struct dso *dso__kernel_findnew(struct machine *machine, const char *name, | |
248 | const char *short_name, int dso_type); | |
249 | ||
8fa7d87f WL |
250 | void dsos__add(struct dsos *dsos, struct dso *dso); |
251 | struct dso *dsos__find(const struct dsos *dsos, const char *name, | |
f9ceffb6 | 252 | bool cmp_short); |
8fa7d87f | 253 | struct dso *__dsos__findnew(struct dsos *dsos, const char *name); |
cdd059d7 JO |
254 | bool __dsos__read_build_ids(struct list_head *head, bool with_hits); |
255 | ||
256 | size_t __dsos__fprintf_buildid(struct list_head *head, FILE *fp, | |
417c2ff6 | 257 | bool (skip)(struct dso *dso, int parm), int parm); |
cdd059d7 JO |
258 | size_t __dsos__fprintf(struct list_head *head, FILE *fp); |
259 | ||
260 | size_t dso__fprintf_buildid(struct dso *dso, FILE *fp); | |
261 | size_t dso__fprintf_symbols_by_name(struct dso *dso, | |
262 | enum map_type type, FILE *fp); | |
263 | size_t dso__fprintf(struct dso *dso, enum map_type type, FILE *fp); | |
39b12f78 AH |
264 | |
265 | static inline bool dso__is_vmlinux(struct dso *dso) | |
266 | { | |
5f70619d ACM |
267 | return dso->binary_type == DSO_BINARY_TYPE__VMLINUX || |
268 | dso->binary_type == DSO_BINARY_TYPE__GUEST_VMLINUX; | |
39b12f78 AH |
269 | } |
270 | ||
8e0cf965 AH |
271 | static inline bool dso__is_kcore(struct dso *dso) |
272 | { | |
5f70619d ACM |
273 | return dso->binary_type == DSO_BINARY_TYPE__KCORE || |
274 | dso->binary_type == DSO_BINARY_TYPE__GUEST_KCORE; | |
8e0cf965 AH |
275 | } |
276 | ||
454ff00f AH |
277 | void dso__free_a2l(struct dso *dso); |
278 | ||
2b5b8bb2 AH |
279 | enum dso_type dso__type(struct dso *dso, struct machine *machine); |
280 | ||
cdd059d7 | 281 | #endif /* __PERF_DSO */ |