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