4 #include <linux/types.h>
5 #include <linux/rbtree.h>
7 #include <linux/types.h>
8 #include <linux/bitops.h>
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,
34 enum dso_kernel_type {
46 enum dso_data_status {
47 DSO_DATA_STATUS_ERROR = -1,
48 DSO_DATA_STATUS_UNKNOWN = 0,
49 DSO_DATA_STATUS_OK = 1,
52 enum dso_data_status_seen {
53 DSO_DATA_STATUS_SEEN_ITRACE,
63 #define DSO__SWAP(dso, type, val) \
66 BUG_ON(dso->needs_swap == DSO_SWAP__UNSET); \
67 if (dso->needs_swap == DSO_SWAP__YES) { \
68 switch (sizeof(____r)) { \
70 ____r = bswap_16(val); \
73 ____r = bswap_32(val); \
76 ____r = bswap_64(val); \
85 #define DSO__DATA_CACHE_SIZE 4096
86 #define DSO__DATA_CACHE_MASK ~(DSO__DATA_CACHE_SIZE - 1)
89 struct rb_node rb_node;
96 * DSOs are put into both a list for fast iteration and rbtree for fast
100 struct list_head head;
101 struct rb_root root; /* rbtree root sorted by long name */
105 struct list_head node;
106 struct rb_node rb_node; /* rbtree node sorted by long name */
107 struct rb_root symbols[MAP__NR_TYPES];
108 struct rb_root symbol_names[MAP__NR_TYPES];
110 char *symsrc_filename;
111 unsigned int a2l_fails;
112 enum dso_kernel_type kernel;
113 enum dso_swap_type needs_swap;
114 enum dso_binary_type symtab_type;
115 enum dso_binary_type binary_type;
120 u8 annotate_warned:1;
121 u8 short_name_allocated:1;
122 u8 long_name_allocated:1;
127 u8 build_id[BUILD_ID_SIZE];
128 const char *short_name;
129 const char *long_name;
132 void *dwfl; /* DWARF debug info */
136 struct rb_root cache;
141 struct list_head open_entry;
144 union { /* Tool specific area */
152 /* dso__for_each_symbol - iterate over the symbols of given type
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
159 #define dso__for_each_symbol(dso, pos, n, type) \
160 symbols__for_each_entry(&(dso)->symbols[(type)], pos, n)
162 static inline void dso__set_loaded(struct dso *dso, enum map_type type)
164 dso->loaded |= (1 << type);
167 struct dso *dso__new(const char *name);
168 void dso__delete(struct dso *dso);
170 void dso__set_short_name(struct dso *dso, const char *name, bool name_allocated);
171 void dso__set_long_name(struct dso *dso, const char *name, bool name_allocated);
173 int dso__name_len(const struct dso *dso);
175 bool dso__loaded(const struct dso *dso, enum map_type type);
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);
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);
187 char dso__symtab_origin(const struct dso *dso);
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);
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);
197 * The dso__data_* external interface provides following functions:
201 * dso__data_read_offset
202 * dso__data_read_addr
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.
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.
212 * The current usage of the dso__data_* interface is as follows:
215 * int fd = dso__data_fd(dso, machine);
219 * n = dso__data_read_offset(dso_0, &machine, 0, buf, BUFSIZE);
220 * n = dso__data_read_addr(dso_0, &machine, 0, buf, BUFSIZE);
222 * Eventually close DSO's fd:
223 * dso__data_close(dso);
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.
229 * The dso__delete function calls close_dso function to ensure the
230 * data file descriptor gets closed/unmapped before the dso object
235 int dso__data_fd(struct dso *dso, struct machine *machine);
236 void dso__data_close(struct dso *dso);
238 off_t dso__data_size(struct dso *dso, struct machine *machine);
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);
244 bool dso__data_status_seen(struct dso *dso, enum dso_data_status_seen by);
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);
250 void dsos__add(struct dsos *dsos, struct dso *dso);
251 struct dso *dsos__find(const struct dsos *dsos, const char *name,
253 struct dso *__dsos__findnew(struct dsos *dsos, const char *name);
254 bool __dsos__read_build_ids(struct list_head *head, bool with_hits);
256 size_t __dsos__fprintf_buildid(struct list_head *head, FILE *fp,
257 bool (skip)(struct dso *dso, int parm), int parm);
258 size_t __dsos__fprintf(struct list_head *head, FILE *fp);
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);
265 static inline bool dso__is_vmlinux(struct dso *dso)
267 return dso->binary_type == DSO_BINARY_TYPE__VMLINUX ||
268 dso->binary_type == DSO_BINARY_TYPE__GUEST_VMLINUX;
271 static inline bool dso__is_kcore(struct dso *dso)
273 return dso->binary_type == DSO_BINARY_TYPE__KCORE ||
274 dso->binary_type == DSO_BINARY_TYPE__GUEST_KCORE;
277 void dso__free_a2l(struct dso *dso);
279 enum dso_type dso__type(struct dso *dso, struct machine *machine);
281 #endif /* __PERF_DSO */