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