xref: /openbmc/linux/tools/perf/util/dso.h (revision 5104d265)
1 #ifndef __PERF_DSO
2 #define __PERF_DSO
3 
4 #include <linux/types.h>
5 #include <linux/rbtree.h>
6 #include "types.h"
7 #include "map.h"
8 
9 enum dso_binary_type {
10 	DSO_BINARY_TYPE__KALLSYMS = 0,
11 	DSO_BINARY_TYPE__GUEST_KALLSYMS,
12 	DSO_BINARY_TYPE__VMLINUX,
13 	DSO_BINARY_TYPE__GUEST_VMLINUX,
14 	DSO_BINARY_TYPE__JAVA_JIT,
15 	DSO_BINARY_TYPE__DEBUGLINK,
16 	DSO_BINARY_TYPE__BUILD_ID_CACHE,
17 	DSO_BINARY_TYPE__FEDORA_DEBUGINFO,
18 	DSO_BINARY_TYPE__UBUNTU_DEBUGINFO,
19 	DSO_BINARY_TYPE__BUILDID_DEBUGINFO,
20 	DSO_BINARY_TYPE__SYSTEM_PATH_DSO,
21 	DSO_BINARY_TYPE__GUEST_KMODULE,
22 	DSO_BINARY_TYPE__SYSTEM_PATH_KMODULE,
23 	DSO_BINARY_TYPE__NOT_FOUND,
24 };
25 
26 enum dso_kernel_type {
27 	DSO_TYPE_USER = 0,
28 	DSO_TYPE_KERNEL,
29 	DSO_TYPE_GUEST_KERNEL
30 };
31 
32 enum dso_swap_type {
33 	DSO_SWAP__UNSET,
34 	DSO_SWAP__NO,
35 	DSO_SWAP__YES,
36 };
37 
38 #define DSO__SWAP(dso, type, val)			\
39 ({							\
40 	type ____r = val;				\
41 	BUG_ON(dso->needs_swap == DSO_SWAP__UNSET);	\
42 	if (dso->needs_swap == DSO_SWAP__YES) {		\
43 		switch (sizeof(____r)) {		\
44 		case 2:					\
45 			____r = bswap_16(val);		\
46 			break;				\
47 		case 4:					\
48 			____r = bswap_32(val);		\
49 			break;				\
50 		case 8:					\
51 			____r = bswap_64(val);		\
52 			break;				\
53 		default:				\
54 			BUG_ON(1);			\
55 		}					\
56 	}						\
57 	____r;						\
58 })
59 
60 #define DSO__DATA_CACHE_SIZE 4096
61 #define DSO__DATA_CACHE_MASK ~(DSO__DATA_CACHE_SIZE - 1)
62 
63 struct dso_cache {
64 	struct rb_node	rb_node;
65 	u64 offset;
66 	u64 size;
67 	char data[0];
68 };
69 
70 struct dso {
71 	struct list_head node;
72 	struct rb_root	 symbols[MAP__NR_TYPES];
73 	struct rb_root	 symbol_names[MAP__NR_TYPES];
74 	struct rb_root	 cache;
75 	enum dso_kernel_type	kernel;
76 	enum dso_swap_type	needs_swap;
77 	enum dso_binary_type	symtab_type;
78 	enum dso_binary_type	data_type;
79 	u8		 adjust_symbols:1;
80 	u8		 has_build_id:1;
81 	u8		 hit:1;
82 	u8		 annotate_warned:1;
83 	u8		 sname_alloc:1;
84 	u8		 lname_alloc:1;
85 	u8		 sorted_by_name;
86 	u8		 loaded;
87 	u8		 build_id[BUILD_ID_SIZE];
88 	const char	 *short_name;
89 	char		 *long_name;
90 	u16		 long_name_len;
91 	u16		 short_name_len;
92 	char		 name[0];
93 };
94 
95 static inline void dso__set_loaded(struct dso *dso, enum map_type type)
96 {
97 	dso->loaded |= (1 << type);
98 }
99 
100 struct dso *dso__new(const char *name);
101 void dso__delete(struct dso *dso);
102 
103 void dso__set_short_name(struct dso *dso, const char *name);
104 void dso__set_long_name(struct dso *dso, char *name);
105 
106 int dso__name_len(const struct dso *dso);
107 
108 bool dso__loaded(const struct dso *dso, enum map_type type);
109 
110 bool dso__sorted_by_name(const struct dso *dso, enum map_type type);
111 void dso__set_sorted_by_name(struct dso *dso, enum map_type type);
112 void dso__sort_by_name(struct dso *dso, enum map_type type);
113 
114 void dso__set_build_id(struct dso *dso, void *build_id);
115 bool dso__build_id_equal(const struct dso *dso, u8 *build_id);
116 void dso__read_running_kernel_build_id(struct dso *dso,
117 				       struct machine *machine);
118 int dso__kernel_module_get_build_id(struct dso *dso, const char *root_dir);
119 
120 char dso__symtab_origin(const struct dso *dso);
121 int dso__binary_type_file(struct dso *dso, enum dso_binary_type type,
122 			  char *root_dir, char *file, size_t size);
123 
124 int dso__data_fd(struct dso *dso, struct machine *machine);
125 ssize_t dso__data_read_offset(struct dso *dso, struct machine *machine,
126 			      u64 offset, u8 *data, ssize_t size);
127 ssize_t dso__data_read_addr(struct dso *dso, struct map *map,
128 			    struct machine *machine, u64 addr,
129 			    u8 *data, ssize_t size);
130 
131 struct map *dso__new_map(const char *name);
132 struct dso *dso__kernel_findnew(struct machine *machine, const char *name,
133 				const char *short_name, int dso_type);
134 
135 void dsos__add(struct list_head *head, struct dso *dso);
136 struct dso *dsos__find(struct list_head *head, const char *name,
137 		       bool cmp_short);
138 struct dso *__dsos__findnew(struct list_head *head, const char *name);
139 bool __dsos__read_build_ids(struct list_head *head, bool with_hits);
140 
141 size_t __dsos__fprintf_buildid(struct list_head *head, FILE *fp,
142 			       bool (skip)(struct dso *dso, int parm), int parm);
143 size_t __dsos__fprintf(struct list_head *head, FILE *fp);
144 
145 size_t dso__fprintf_buildid(struct dso *dso, FILE *fp);
146 size_t dso__fprintf_symbols_by_name(struct dso *dso,
147 				    enum map_type type, FILE *fp);
148 size_t dso__fprintf(struct dso *dso, enum map_type type, FILE *fp);
149 #endif /* __PERF_DSO */
150