xref: /openbmc/linux/tools/perf/util/dso.h (revision 206a81c1)
1 #ifndef __PERF_DSO
2 #define __PERF_DSO
3 
4 #include <linux/types.h>
5 #include <linux/rbtree.h>
6 #include <stdbool.h>
7 #include <linux/types.h>
8 #include "map.h"
9 #include "build-id.h"
10 
11 enum dso_binary_type {
12 	DSO_BINARY_TYPE__KALLSYMS = 0,
13 	DSO_BINARY_TYPE__GUEST_KALLSYMS,
14 	DSO_BINARY_TYPE__VMLINUX,
15 	DSO_BINARY_TYPE__GUEST_VMLINUX,
16 	DSO_BINARY_TYPE__JAVA_JIT,
17 	DSO_BINARY_TYPE__DEBUGLINK,
18 	DSO_BINARY_TYPE__BUILD_ID_CACHE,
19 	DSO_BINARY_TYPE__FEDORA_DEBUGINFO,
20 	DSO_BINARY_TYPE__UBUNTU_DEBUGINFO,
21 	DSO_BINARY_TYPE__BUILDID_DEBUGINFO,
22 	DSO_BINARY_TYPE__SYSTEM_PATH_DSO,
23 	DSO_BINARY_TYPE__GUEST_KMODULE,
24 	DSO_BINARY_TYPE__SYSTEM_PATH_KMODULE,
25 	DSO_BINARY_TYPE__KCORE,
26 	DSO_BINARY_TYPE__GUEST_KCORE,
27 	DSO_BINARY_TYPE__OPENEMBEDDED_DEBUGINFO,
28 	DSO_BINARY_TYPE__NOT_FOUND,
29 };
30 
31 enum dso_kernel_type {
32 	DSO_TYPE_USER = 0,
33 	DSO_TYPE_KERNEL,
34 	DSO_TYPE_GUEST_KERNEL
35 };
36 
37 enum dso_swap_type {
38 	DSO_SWAP__UNSET,
39 	DSO_SWAP__NO,
40 	DSO_SWAP__YES,
41 };
42 
43 #define DSO__SWAP(dso, type, val)			\
44 ({							\
45 	type ____r = val;				\
46 	BUG_ON(dso->needs_swap == DSO_SWAP__UNSET);	\
47 	if (dso->needs_swap == DSO_SWAP__YES) {		\
48 		switch (sizeof(____r)) {		\
49 		case 2:					\
50 			____r = bswap_16(val);		\
51 			break;				\
52 		case 4:					\
53 			____r = bswap_32(val);		\
54 			break;				\
55 		case 8:					\
56 			____r = bswap_64(val);		\
57 			break;				\
58 		default:				\
59 			BUG_ON(1);			\
60 		}					\
61 	}						\
62 	____r;						\
63 })
64 
65 #define DSO__DATA_CACHE_SIZE 4096
66 #define DSO__DATA_CACHE_MASK ~(DSO__DATA_CACHE_SIZE - 1)
67 
68 struct dso_cache {
69 	struct rb_node	rb_node;
70 	u64 offset;
71 	u64 size;
72 	char data[0];
73 };
74 
75 struct dso {
76 	struct list_head node;
77 	struct rb_root	 symbols[MAP__NR_TYPES];
78 	struct rb_root	 symbol_names[MAP__NR_TYPES];
79 	struct rb_root	 cache;
80 	void		 *a2l;
81 	char		 *symsrc_filename;
82 	unsigned int	 a2l_fails;
83 	enum dso_kernel_type	kernel;
84 	enum dso_swap_type	needs_swap;
85 	enum dso_binary_type	symtab_type;
86 	enum dso_binary_type	binary_type;
87 	u8		 adjust_symbols:1;
88 	u8		 has_build_id:1;
89 	u8		 has_srcline:1;
90 	u8		 hit:1;
91 	u8		 annotate_warned:1;
92 	u8		 short_name_allocated:1;
93 	u8		 long_name_allocated:1;
94 	u8		 sorted_by_name;
95 	u8		 loaded;
96 	u8		 rel;
97 	u8		 build_id[BUILD_ID_SIZE];
98 	const char	 *short_name;
99 	const char	 *long_name;
100 	u16		 long_name_len;
101 	u16		 short_name_len;
102 	char		 name[0];
103 };
104 
105 /* dso__for_each_symbol - iterate over the symbols of given type
106  *
107  * @dso: the 'struct dso *' in which symbols itereated
108  * @pos: the 'struct symbol *' to use as a loop cursor
109  * @n: the 'struct rb_node *' to use as a temporary storage
110  * @type: the 'enum map_type' type of symbols
111  */
112 #define dso__for_each_symbol(dso, pos, n, type)	\
113 	symbols__for_each_entry(&(dso)->symbols[(type)], pos, n)
114 
115 static inline void dso__set_loaded(struct dso *dso, enum map_type type)
116 {
117 	dso->loaded |= (1 << type);
118 }
119 
120 struct dso *dso__new(const char *name);
121 void dso__delete(struct dso *dso);
122 
123 void dso__set_short_name(struct dso *dso, const char *name, bool name_allocated);
124 void dso__set_long_name(struct dso *dso, const char *name, bool name_allocated);
125 
126 int dso__name_len(const struct dso *dso);
127 
128 bool dso__loaded(const struct dso *dso, enum map_type type);
129 
130 bool dso__sorted_by_name(const struct dso *dso, enum map_type type);
131 void dso__set_sorted_by_name(struct dso *dso, enum map_type type);
132 void dso__sort_by_name(struct dso *dso, enum map_type type);
133 
134 void dso__set_build_id(struct dso *dso, void *build_id);
135 bool dso__build_id_equal(const struct dso *dso, u8 *build_id);
136 void dso__read_running_kernel_build_id(struct dso *dso,
137 				       struct machine *machine);
138 int dso__kernel_module_get_build_id(struct dso *dso, const char *root_dir);
139 
140 char dso__symtab_origin(const struct dso *dso);
141 int dso__read_binary_type_filename(const struct dso *dso, enum dso_binary_type type,
142 				   char *root_dir, char *filename, size_t size);
143 
144 int dso__data_fd(struct dso *dso, struct machine *machine);
145 ssize_t dso__data_read_offset(struct dso *dso, struct machine *machine,
146 			      u64 offset, u8 *data, ssize_t size);
147 ssize_t dso__data_read_addr(struct dso *dso, struct map *map,
148 			    struct machine *machine, u64 addr,
149 			    u8 *data, ssize_t size);
150 
151 struct map *dso__new_map(const char *name);
152 struct dso *dso__kernel_findnew(struct machine *machine, const char *name,
153 				const char *short_name, int dso_type);
154 
155 void dsos__add(struct list_head *head, struct dso *dso);
156 struct dso *dsos__find(const struct list_head *head, const char *name,
157 		       bool cmp_short);
158 struct dso *__dsos__findnew(struct list_head *head, const char *name);
159 bool __dsos__read_build_ids(struct list_head *head, bool with_hits);
160 
161 size_t __dsos__fprintf_buildid(struct list_head *head, FILE *fp,
162 			       bool (skip)(struct dso *dso, int parm), int parm);
163 size_t __dsos__fprintf(struct list_head *head, FILE *fp);
164 
165 size_t dso__fprintf_buildid(struct dso *dso, FILE *fp);
166 size_t dso__fprintf_symbols_by_name(struct dso *dso,
167 				    enum map_type type, FILE *fp);
168 size_t dso__fprintf(struct dso *dso, enum map_type type, FILE *fp);
169 
170 static inline bool dso__is_vmlinux(struct dso *dso)
171 {
172 	return dso->binary_type == DSO_BINARY_TYPE__VMLINUX ||
173 	       dso->binary_type == DSO_BINARY_TYPE__GUEST_VMLINUX;
174 }
175 
176 static inline bool dso__is_kcore(struct dso *dso)
177 {
178 	return dso->binary_type == DSO_BINARY_TYPE__KCORE ||
179 	       dso->binary_type == DSO_BINARY_TYPE__GUEST_KCORE;
180 }
181 
182 void dso__free_a2l(struct dso *dso);
183 
184 #endif /* __PERF_DSO */
185