Linux Perf
dso.h
Go to the documentation of this file.
1 /* SPDX-License-Identifier: GPL-2.0 */
2 #ifndef __PERF_DSO
3 #define __PERF_DSO
4 
5 #include <linux/refcount.h>
6 #include <linux/types.h>
7 #include <linux/rbtree.h>
8 #include <sys/types.h>
9 #include <stdbool.h>
10 #include "rwsem.h"
11 #include <linux/types.h>
12 #include <linux/bitops.h>
13 #include "map.h"
14 #include "namespaces.h"
15 #include "build-id.h"
16 
38 };
39 
44 };
45 
50 };
51 
56 };
57 
60 };
61 
62 enum dso_type {
67 };
68 
71 
72  /*
73  * Choose an arbitrary negative big number not to clash with standard
74  * errno since SUS requires the errno has distinct positive values.
75  * See 'Issue 6' in the link below.
76  *
77  * http://pubs.opengroup.org/onlinepubs/9699919799/basedefs/errno.h.html
78  */
80 
82 
83  /* for symsrc__init() */
87 
88  /* for decompress_kmodule */
90 
92 };
93 
94 #define DSO__SWAP(dso, type, val) \
95 ({ \
96  type ____r = val; \
97  BUG_ON(dso->needs_swap == DSO_SWAP__UNSET); \
98  if (dso->needs_swap == DSO_SWAP__YES) { \
99  switch (sizeof(____r)) { \
100  case 2: \
101  ____r = bswap_16(val); \
102  break; \
103  case 4: \
104  ____r = bswap_32(val); \
105  break; \
106  case 8: \
107  ____r = bswap_64(val); \
108  break; \
109  default: \
110  BUG_ON(1); \
111  } \
112  } \
113  ____r; \
114 })
115 
116 #define DSO__DATA_CACHE_SIZE 4096
117 #define DSO__DATA_CACHE_MASK ~(DSO__DATA_CACHE_SIZE - 1)
118 
119 struct dso_cache {
120  struct rb_node rb_node;
121  u64 offset;
122  u64 size;
123  char data[0];
124 };
125 
126 /*
127  * DSOs are put into both a list for fast iteration and rbtree for fast
128  * long name lookup.
129  */
130 struct dsos {
131  struct list_head head;
132  struct rb_root root; /* rbtree root sorted by long name */
134 };
135 
136 struct auxtrace_cache;
137 
138 struct dso {
139  pthread_mutex_t lock;
140  struct list_head node;
141  struct rb_node rb_node; /* rbtree node sorted by long name */
142  struct rb_root *root; /* root of rbtree that rb_node is in */
143  struct rb_root symbols;
144  struct rb_root symbol_names;
145  struct rb_root inlined_nodes;
146  struct rb_root srclines;
147  struct {
148  u64 addr;
149  struct symbol *symbol;
150  } last_find_result;
151  void *a2l;
153  unsigned int a2l_fails;
154  enum dso_kernel_type kernel;
155  enum dso_swap_type needs_swap;
156  enum dso_binary_type symtab_type;
157  enum dso_binary_type binary_type;
158  enum dso_load_errno load_errno;
162  u8 hit:1;
166  u8 is_64_bit:1;
168  bool loaded;
169  u8 rel;
170  u8 build_id[BUILD_ID_SIZE];
172  const char *short_name;
173  const char *long_name;
176  void *dwfl; /* DWARF debug info */
178 
179  /* dso data file */
180  struct {
181  struct rb_root cache;
182  int fd;
183  int status;
185  size_t file_size;
186  struct list_head open_entry;
189  } data;
190 
191  union { /* Tool specific area */
192  void *priv;
193  u64 db_id;
194  };
195  struct nsinfo *nsinfo;
196  refcount_t refcnt;
197  char name[0];
198 };
199 
200 /* dso__for_each_symbol - iterate over the symbols of given type
201  *
202  * @dso: the 'struct dso *' in which symbols itereated
203  * @pos: the 'struct symbol *' to use as a loop cursor
204  * @n: the 'struct rb_node *' to use as a temporary storage
205  */
206 #define dso__for_each_symbol(dso, pos, n) \
207  symbols__for_each_entry(&(dso)->symbols, pos, n)
208 
209 static inline void dso__set_loaded(struct dso *dso)
210 {
211  dso->loaded = true;
212 }
213 
214 struct dso *dso__new(const char *name);
215 void dso__delete(struct dso *dso);
216 
217 void dso__set_short_name(struct dso *dso, const char *name, bool name_allocated);
218 void dso__set_long_name(struct dso *dso, const char *name, bool name_allocated);
219 
220 int dso__name_len(const struct dso *dso);
221 
222 struct dso *dso__get(struct dso *dso);
223 void dso__put(struct dso *dso);
224 
225 static inline void __dso__zput(struct dso **dso)
226 {
227  dso__put(*dso);
228  *dso = NULL;
229 }
230 
231 #define dso__zput(dso) __dso__zput(&dso)
232 
233 bool dso__loaded(const struct dso *dso);
234 
235 static inline bool dso__has_symbols(const struct dso *dso)
236 {
237  return !RB_EMPTY_ROOT(&dso->symbols);
238 }
239 
240 bool dso__sorted_by_name(const struct dso *dso);
241 void dso__set_sorted_by_name(struct dso *dso);
242 void dso__sort_by_name(struct dso *dso);
243 
244 void dso__set_build_id(struct dso *dso, void *build_id);
245 bool dso__build_id_equal(const struct dso *dso, u8 *build_id);
246 void dso__read_running_kernel_build_id(struct dso *dso,
247  struct machine *machine);
248 int dso__kernel_module_get_build_id(struct dso *dso, const char *root_dir);
249 
250 char dso__symtab_origin(const struct dso *dso);
251 int dso__read_binary_type_filename(const struct dso *dso, enum dso_binary_type type,
252  char *root_dir, char *filename, size_t size);
253 bool is_supported_compression(const char *ext);
254 bool is_kernel_module(const char *pathname, int cpumode);
255 bool decompress_to_file(const char *ext, const char *filename, int output_fd);
256 bool dso__needs_decompress(struct dso *dso);
257 int dso__decompress_kmodule_fd(struct dso *dso, const char *name);
258 int dso__decompress_kmodule_path(struct dso *dso, const char *name,
259  char *pathname, size_t len);
260 
261 #define KMOD_DECOMP_NAME "/tmp/perf-kmod-XXXXXX"
262 #define KMOD_DECOMP_LEN sizeof(KMOD_DECOMP_NAME)
263 
264 struct kmod_path {
265  char *name;
266  char *ext;
267  bool comp;
268  bool kmod;
269 };
270 
271 int __kmod_path__parse(struct kmod_path *m, const char *path,
272  bool alloc_name, bool alloc_ext);
273 
274 #define kmod_path__parse(__m, __p) __kmod_path__parse(__m, __p, false, false)
275 #define kmod_path__parse_name(__m, __p) __kmod_path__parse(__m, __p, true , false)
276 #define kmod_path__parse_ext(__m, __p) __kmod_path__parse(__m, __p, false, true)
277 
278 void dso__set_module_info(struct dso *dso, struct kmod_path *m,
279  struct machine *machine);
280 
281 /*
282  * The dso__data_* external interface provides following functions:
283  * dso__data_get_fd
284  * dso__data_put_fd
285  * dso__data_close
286  * dso__data_size
287  * dso__data_read_offset
288  * dso__data_read_addr
289  *
290  * Please refer to the dso.c object code for each function and
291  * arguments documentation. Following text tries to explain the
292  * dso file descriptor caching.
293  *
294  * The dso__data* interface allows caching of opened file descriptors
295  * to speed up the dso data accesses. The idea is to leave the file
296  * descriptor opened ideally for the whole life of the dso object.
297  *
298  * The current usage of the dso__data_* interface is as follows:
299  *
300  * Get DSO's fd:
301  * int fd = dso__data_get_fd(dso, machine);
302  * if (fd >= 0) {
303  * USE 'fd' SOMEHOW
304  * dso__data_put_fd(dso);
305  * }
306  *
307  * Read DSO's data:
308  * n = dso__data_read_offset(dso_0, &machine, 0, buf, BUFSIZE);
309  * n = dso__data_read_addr(dso_0, &machine, 0, buf, BUFSIZE);
310  *
311  * Eventually close DSO's fd:
312  * dso__data_close(dso);
313  *
314  * It is not necessary to close the DSO object data file. Each time new
315  * DSO data file is opened, the limit (RLIMIT_NOFILE/2) is checked. Once
316  * it is crossed, the oldest opened DSO object is closed.
317  *
318  * The dso__delete function calls close_dso function to ensure the
319  * data file descriptor gets closed/unmapped before the dso object
320  * is freed.
321  *
322  * TODO
323 */
324 int dso__data_get_fd(struct dso *dso, struct machine *machine);
325 void dso__data_put_fd(struct dso *dso);
326 void dso__data_close(struct dso *dso);
327 
328 off_t dso__data_size(struct dso *dso, struct machine *machine);
329 ssize_t dso__data_read_offset(struct dso *dso, struct machine *machine,
330  u64 offset, u8 *data, ssize_t size);
331 ssize_t dso__data_read_addr(struct dso *dso, struct map *map,
332  struct machine *machine, u64 addr,
333  u8 *data, ssize_t size);
334 bool dso__data_status_seen(struct dso *dso, enum dso_data_status_seen by);
335 
336 struct map *dso__new_map(const char *name);
337 struct dso *machine__findnew_kernel(struct machine *machine, const char *name,
338  const char *short_name, int dso_type);
339 
340 void __dsos__add(struct dsos *dsos, struct dso *dso);
341 void dsos__add(struct dsos *dsos, struct dso *dso);
342 struct dso *__dsos__addnew(struct dsos *dsos, const char *name);
343 struct dso *__dsos__find(struct dsos *dsos, const char *name, bool cmp_short);
344 struct dso *dsos__find(struct dsos *dsos, const char *name, bool cmp_short);
345 struct dso *__dsos__findnew(struct dsos *dsos, const char *name);
346 struct dso *dsos__findnew(struct dsos *dsos, const char *name);
347 bool __dsos__read_build_ids(struct list_head *head, bool with_hits);
348 
349 void dso__reset_find_symbol_cache(struct dso *dso);
350 
351 size_t __dsos__fprintf_buildid(struct list_head *head, FILE *fp,
352  bool (skip)(struct dso *dso, int parm), int parm);
353 size_t __dsos__fprintf(struct list_head *head, FILE *fp);
354 
355 size_t dso__fprintf_buildid(struct dso *dso, FILE *fp);
356 size_t dso__fprintf_symbols_by_name(struct dso *dso, FILE *fp);
357 size_t dso__fprintf(struct dso *dso, FILE *fp);
358 
359 static inline bool dso__is_vmlinux(struct dso *dso)
360 {
361  return dso->binary_type == DSO_BINARY_TYPE__VMLINUX ||
363 }
364 
365 static inline bool dso__is_kcore(struct dso *dso)
366 {
367  return dso->binary_type == DSO_BINARY_TYPE__KCORE ||
369 }
370 
371 static inline bool dso__is_kallsyms(struct dso *dso)
372 {
373  return dso->kernel && dso->long_name[0] != '/';
374 }
375 
376 void dso__free_a2l(struct dso *dso);
377 
378 enum dso_type dso__type(struct dso *dso, struct machine *machine);
379 
380 int dso__strerror_load(struct dso *dso, char *buf, size_t buflen);
381 
382 void reset_fd_limit(void);
383 
384 #endif /* __PERF_DSO */
dso_swap_type
Definition: dso.h:46
u8 is_64_bit
Definition: dso.h:166
u8 adjust_symbols
Definition: dso.h:159
struct dso * __dsos__findnew(struct dsos *dsos, const char *name)
Definition: dso.c:1414
Definition: mem2node.c:7
static bool dso__is_vmlinux(struct dso *dso)
Definition: dso.h:359
static int output_fd
Definition: builtin-stat.c:177
bool decompress_to_file(const char *ext, const char *filename, int output_fd)
Definition: dso.c:242
int dso__read_binary_type_filename(const struct dso *dso, enum dso_binary_type type, char *root_dir, char *filename, size_t size)
Definition: dso.c:57
static void dso__set_loaded(struct dso *dso)
Definition: dso.h:209
u8 has_build_id
Definition: dso.h:160
refcount_t refcnt
Definition: dso.h:196
void * priv
Definition: dso.h:192
struct dso * dsos__find(struct dsos *dsos, const char *name, bool cmp_short)
Definition: dso.c:1392
int dso__decompress_kmodule_fd(struct dso *dso, const char *name)
Definition: dso.c:291
struct dso * dso__new(const char *name)
Definition: dso.c:1196
int __kmod_path__parse(struct kmod_path *m, const char *path, bool alloc_name, bool alloc_ext)
Definition: dso.c:334
pthread_rwlock_t lock
Definition: rwsem.h:7
u64 eh_frame_hdr_offset
Definition: dso.h:188
static void skip(int size)
struct rb_root * root
Definition: dso.h:142
size_t __dsos__fprintf_buildid(struct list_head *head, FILE *fp, bool(skip)(struct dso *dso, int parm), int parm)
Definition: dso.c:1430
ssize_t dso__data_read_addr(struct dso *dso, struct map *map, struct machine *machine, u64 addr, u8 *data, ssize_t size)
Definition: dso.c:1005
const char * filename
Definition: hists_common.c:26
int fd
Definition: dso.h:182
struct rb_root root
Definition: block-range.c:6
struct dso * machine__findnew_kernel(struct machine *machine, const char *name, const char *short_name, int dso_type)
Definition: dso.c:1024
bool dso__data_status_seen(struct dso *dso, enum dso_data_status_seen by)
Definition: dso.c:699
void dso__set_module_info(struct dso *dso, struct kmod_path *m, struct machine *machine)
Definition: dso.c:407
struct symbol * symbol
Definition: dso.h:149
dso_data_status
Definition: dso.h:52
bool sorted_by_name
Definition: dso.h:167
bool dso__loaded(const struct dso *dso)
Definition: dso.c:1181
const char * long_name
Definition: dso.h:173
enum dso_type dso__type(struct dso *dso, struct machine *machine)
Definition: dso.c:1483
u8 annotate_warned
Definition: dso.h:163
u8 hit
Definition: dso.h:162
u64 text_offset
Definition: dso.h:171
struct dso * __dsos__addnew(struct dsos *dsos, const char *name)
Definition: dso.c:1401
char * ext
Definition: dso.h:266
void dso__data_put_fd(struct dso *dso)
void dso__set_short_name(struct dso *dso, const char *name, bool name_allocated)
Definition: dso.c:1132
char * symsrc_filename
Definition: dso.h:152
off_t dso__data_size(struct dso *dso, struct machine *machine)
Definition: dso.c:950
u8 rel
Definition: dso.h:169
const char * name
bool is_supported_compression(const char *ext)
Definition: dso.c:205
void * a2l
Definition: dso.h:151
u64 size
Definition: dso.h:122
void dso__read_running_kernel_build_id(struct dso *dso, struct machine *machine)
Definition: dso.c:1287
char dso__symtab_origin(const struct dso *dso)
Definition: dso.c:30
u64 debug_frame_offset
Definition: dso.h:187
Definition: dso.h:264
void reset_fd_limit(void)
Definition: dso.c:595
void dso__sort_by_name(struct dso *dso)
Definition: symbol.c:542
pthread_mutex_t lock
Definition: dso.h:139
u8 short_name_allocated
Definition: dso.h:164
size_t dso__fprintf_symbols_by_name(struct dso *dso, FILE *fp)
dso_type
Definition: dso.h:62
int dso__decompress_kmodule_path(struct dso *dso, const char *name, char *pathname, size_t len)
Definition: dso.c:301
Definition: dso.h:119
bool comp
Definition: dso.h:267
dso_data_status_seen
Definition: dso.h:58
void dso__set_build_id(struct dso *dso, void *build_id)
Definition: dso.c:1276
static bool dso__is_kallsyms(struct dso *dso)
Definition: dso.h:371
u16 short_name_len
Definition: dso.h:175
bool dso__build_id_equal(const struct dso *dso, u8 *build_id)
Definition: dso.c:1282
static bool dso__is_kcore(struct dso *dso)
Definition: dso.h:365
Definition: dso.h:138
u64 db_id
Definition: dso.h:193
u8 has_srcline
Definition: dso.h:161
char data[0]
Definition: dso.h:123
enum dso_kernel_type kernel
Definition: dso.h:154
bool is_kernel_module(const char *pathname, int cpumode)
Definition: dso.c:216
bool loaded
Definition: dso.h:168
struct rb_node rb_node
Definition: dso.h:120
void dso__set_sorted_by_name(struct dso *dso)
Definition: dso.c:1191
int dso__data_get_fd(struct dso *dso, struct machine *machine)
Definition: dso.c:678
ssize_t dso__data_read_offset(struct dso *dso, struct machine *machine, u64 offset, u8 *data, ssize_t size)
Definition: dso.c:986
u64 offset
Definition: dso.h:121
void dso__data_close(struct dso *dso)
Definition: dso.c:630
struct map * dso__new_map(const char *name)
Definition: dso.c:1013
struct rb_root symbols
Definition: dso.h:143
struct dso * dsos__findnew(struct dsos *dsos, const char *name)
Definition: dso.c:1421
void __dsos__add(struct dsos *dsos, struct dso *dso)
Definition: dso.c:1345
bool dso__needs_decompress(struct dso *dso)
Definition: dso.c:254
struct auxtrace_cache * auxtrace_cache
Definition: dso.h:177
u8 long_name_allocated
Definition: dso.h:165
static void __dso__zput(struct dso **dso)
Definition: dso.h:225
void dso__reset_find_symbol_cache(struct dso *dso)
Definition: symbol.c:478
char * name
Definition: dso.h:265
Definition: jevents.c:228
Definition: dso.h:130
u8 build_id[BUILD_ID_SIZE]
Definition: dso.h:170
int status
Definition: dso.h:183
size_t file_size
Definition: dso.h:185
void dso__put(struct dso *dso)
Definition: dso.c:1270
void * dwfl
Definition: dso.h:176
struct nsinfo * nsinfo
Definition: dso.h:195
int dso__kernel_module_get_build_id(struct dso *dso, const char *root_dir)
Definition: dso.c:1299
void dso__free_a2l(struct dso *dso)
static bool dso__has_symbols(const struct dso *dso)
Definition: dso.h:235
struct dso * __dsos__find(struct dsos *dsos, const char *name, bool cmp_short)
Definition: dso.c:1379
int dso__name_len(const struct dso *dso)
Definition: dso.c:1171
unsigned int a2l_fails
Definition: dso.h:153
u64 addr
Definition: dso.h:148
dso_load_errno
Definition: dso.h:69
u32 status_seen
Definition: dso.h:184
bool __dsos__read_build_ids(struct list_head *head, bool with_hits)
Definition: dso.c:1320
dso_kernel_type
Definition: dso.h:40
Definition: symbol.h:55
size_t __dsos__fprintf(struct list_head *head, FILE *fp)
Definition: dso.c:1445
size_t dso__fprintf_buildid(struct dso *dso, FILE *fp)
Definition: dso.c:1457
size_t dso__fprintf(struct dso *dso, FILE *fp)
Definition: dso.c:1465
enum dso_binary_type binary_type
Definition: dso.h:157
void dsos__add(struct dsos *dsos, struct dso *dso)
Definition: dso.c:1372
#define BUILD_ID_SIZE
Definition: build-id.h:5
struct dso * dso__get(struct dso *dso)
Definition: dso.c:1263
void dso__delete(struct dso *dso)
Definition: dso.c:1232
const char * short_name
Definition: dso.h:172
dso_binary_type
Definition: dso.h:17
int dso__strerror_load(struct dso *dso, char *buf, size_t buflen)
Definition: dso.c:1497
void dso__set_long_name(struct dso *dso, const char *name, bool name_allocated)
Definition: dso.c:1104
u16 long_name_len
Definition: dso.h:174
bool kmod
Definition: dso.h:268
bool dso__sorted_by_name(const struct dso *dso)
Definition: dso.c:1186