xref: /openbmc/linux/tools/perf/util/map.h (revision b595076a)
1 #ifndef __PERF_MAP_H
2 #define __PERF_MAP_H
3 
4 #include <linux/compiler.h>
5 #include <linux/list.h>
6 #include <linux/rbtree.h>
7 #include <stdio.h>
8 #include <stdbool.h>
9 #include "types.h"
10 
11 enum map_type {
12 	MAP__FUNCTION = 0,
13 	MAP__VARIABLE,
14 };
15 
16 #define MAP__NR_TYPES (MAP__VARIABLE + 1)
17 
18 extern const char *map_type__name[MAP__NR_TYPES];
19 
20 struct dso;
21 struct ref_reloc_sym;
22 struct map_groups;
23 struct machine;
24 
25 struct map {
26 	union {
27 		struct rb_node	rb_node;
28 		struct list_head node;
29 	};
30 	u64			start;
31 	u64			end;
32 	u8 /* enum map_type */	type;
33 	bool			referenced;
34 	u32			priv;
35 	u64			pgoff;
36 
37 	/* ip -> dso rip */
38 	u64			(*map_ip)(struct map *, u64);
39 	/* dso rip -> ip */
40 	u64			(*unmap_ip)(struct map *, u64);
41 
42 	struct dso		*dso;
43 	struct map_groups	*groups;
44 };
45 
46 struct kmap {
47 	struct ref_reloc_sym	*ref_reloc_sym;
48 	struct map_groups	*kmaps;
49 };
50 
51 struct map_groups {
52 	struct rb_root	 maps[MAP__NR_TYPES];
53 	struct list_head removed_maps[MAP__NR_TYPES];
54 	struct machine	 *machine;
55 };
56 
57 /* Native host kernel uses -1 as pid index in machine */
58 #define	HOST_KERNEL_ID			(-1)
59 #define	DEFAULT_GUEST_KERNEL_ID		(0)
60 
61 struct machine {
62 	struct rb_node	  rb_node;
63 	pid_t		  pid;
64 	char		  *root_dir;
65 	struct list_head  user_dsos;
66 	struct list_head  kernel_dsos;
67 	struct map_groups kmaps;
68 	struct map	  *vmlinux_maps[MAP__NR_TYPES];
69 };
70 
71 static inline
72 struct map *machine__kernel_map(struct machine *self, enum map_type type)
73 {
74 	return self->vmlinux_maps[type];
75 }
76 
77 static inline struct kmap *map__kmap(struct map *self)
78 {
79 	return (struct kmap *)(self + 1);
80 }
81 
82 static inline u64 map__map_ip(struct map *map, u64 ip)
83 {
84 	return ip - map->start + map->pgoff;
85 }
86 
87 static inline u64 map__unmap_ip(struct map *map, u64 ip)
88 {
89 	return ip + map->start - map->pgoff;
90 }
91 
92 static inline u64 identity__map_ip(struct map *map __used, u64 ip)
93 {
94 	return ip;
95 }
96 
97 
98 /* rip/ip <-> addr suitable for passing to `objdump --start-address=` */
99 u64 map__rip_2objdump(struct map *map, u64 rip);
100 u64 map__objdump_2ip(struct map *map, u64 addr);
101 
102 struct symbol;
103 
104 typedef int (*symbol_filter_t)(struct map *map, struct symbol *sym);
105 
106 void map__init(struct map *self, enum map_type type,
107 	       u64 start, u64 end, u64 pgoff, struct dso *dso);
108 struct map *map__new(struct list_head *dsos__list, u64 start, u64 len,
109 		     u64 pgoff, u32 pid, char *filename,
110 		     enum map_type type);
111 void map__delete(struct map *self);
112 struct map *map__clone(struct map *self);
113 int map__overlap(struct map *l, struct map *r);
114 size_t map__fprintf(struct map *self, FILE *fp);
115 
116 int map__load(struct map *self, symbol_filter_t filter);
117 struct symbol *map__find_symbol(struct map *self,
118 				u64 addr, symbol_filter_t filter);
119 struct symbol *map__find_symbol_by_name(struct map *self, const char *name,
120 					symbol_filter_t filter);
121 void map__fixup_start(struct map *self);
122 void map__fixup_end(struct map *self);
123 
124 void map__reloc_vmlinux(struct map *self);
125 
126 size_t __map_groups__fprintf_maps(struct map_groups *self,
127 				  enum map_type type, int verbose, FILE *fp);
128 void maps__insert(struct rb_root *maps, struct map *map);
129 void maps__remove(struct rb_root *self, struct map *map);
130 struct map *maps__find(struct rb_root *maps, u64 addr);
131 void map_groups__init(struct map_groups *self);
132 void map_groups__exit(struct map_groups *self);
133 int map_groups__clone(struct map_groups *self,
134 		      struct map_groups *parent, enum map_type type);
135 size_t map_groups__fprintf(struct map_groups *self, int verbose, FILE *fp);
136 size_t map_groups__fprintf_maps(struct map_groups *self, int verbose, FILE *fp);
137 
138 typedef void (*machine__process_t)(struct machine *self, void *data);
139 
140 void machines__process(struct rb_root *self, machine__process_t process, void *data);
141 struct machine *machines__add(struct rb_root *self, pid_t pid,
142 			      const char *root_dir);
143 struct machine *machines__find_host(struct rb_root *self);
144 struct machine *machines__find(struct rb_root *self, pid_t pid);
145 struct machine *machines__findnew(struct rb_root *self, pid_t pid);
146 char *machine__mmap_name(struct machine *self, char *bf, size_t size);
147 int machine__init(struct machine *self, const char *root_dir, pid_t pid);
148 void machine__exit(struct machine *self);
149 void machine__delete(struct machine *self);
150 
151 /*
152  * Default guest kernel is defined by parameter --guestkallsyms
153  * and --guestmodules
154  */
155 static inline bool machine__is_default_guest(struct machine *self)
156 {
157 	return self ? self->pid == DEFAULT_GUEST_KERNEL_ID : false;
158 }
159 
160 static inline bool machine__is_host(struct machine *self)
161 {
162 	return self ? self->pid == HOST_KERNEL_ID : false;
163 }
164 
165 static inline void map_groups__insert(struct map_groups *self, struct map *map)
166 {
167 	maps__insert(&self->maps[map->type], map);
168 	map->groups = self;
169 }
170 
171 static inline void map_groups__remove(struct map_groups *self, struct map *map)
172 {
173 	maps__remove(&self->maps[map->type], map);
174 }
175 
176 static inline struct map *map_groups__find(struct map_groups *self,
177 					   enum map_type type, u64 addr)
178 {
179 	return maps__find(&self->maps[type], addr);
180 }
181 
182 struct symbol *map_groups__find_symbol(struct map_groups *self,
183 				       enum map_type type, u64 addr,
184 				       struct map **mapp,
185 				       symbol_filter_t filter);
186 
187 struct symbol *map_groups__find_symbol_by_name(struct map_groups *self,
188 					       enum map_type type,
189 					       const char *name,
190 					       struct map **mapp,
191 					       symbol_filter_t filter);
192 
193 static inline
194 struct symbol *machine__find_kernel_symbol(struct machine *self,
195 					   enum map_type type, u64 addr,
196 					   struct map **mapp,
197 					   symbol_filter_t filter)
198 {
199 	return map_groups__find_symbol(&self->kmaps, type, addr, mapp, filter);
200 }
201 
202 static inline
203 struct symbol *machine__find_kernel_function(struct machine *self, u64 addr,
204 					     struct map **mapp,
205 					     symbol_filter_t filter)
206 {
207 	return machine__find_kernel_symbol(self, MAP__FUNCTION, addr, mapp, filter);
208 }
209 
210 static inline
211 struct symbol *map_groups__find_function_by_name(struct map_groups *self,
212 						 const char *name, struct map **mapp,
213 						 symbol_filter_t filter)
214 {
215 	return map_groups__find_symbol_by_name(self, MAP__FUNCTION, name, mapp, filter);
216 }
217 
218 static inline
219 struct symbol *machine__find_kernel_function_by_name(struct machine *self,
220 						     const char *name,
221 						     struct map **mapp,
222 						     symbol_filter_t filter)
223 {
224 	return map_groups__find_function_by_name(&self->kmaps, name, mapp,
225 						 filter);
226 }
227 
228 int map_groups__fixup_overlappings(struct map_groups *self, struct map *map,
229 				   int verbose, FILE *fp);
230 
231 struct map *map_groups__find_by_name(struct map_groups *self,
232 				     enum map_type type, const char *name);
233 struct map *machine__new_module(struct machine *self, u64 start, const char *filename);
234 
235 void map_groups__flush(struct map_groups *self);
236 
237 #endif /* __PERF_MAP_H */
238