xref: /linux/tools/perf/util/map.h (revision 6bc51cbaa9d75c7c240282da5ff270815caccac0)
1 #ifndef __PERF_MAP_H
2 #define __PERF_MAP_H
3 
4 #include <linux/refcount.h>
5 #include <linux/compiler.h>
6 #include <linux/list.h>
7 #include <linux/rbtree.h>
8 #include <pthread.h>
9 #include <stdio.h>
10 #include <stdbool.h>
11 #include <linux/types.h>
12 
13 enum map_type {
14 	MAP__FUNCTION = 0,
15 	MAP__VARIABLE,
16 };
17 
18 #define MAP__NR_TYPES (MAP__VARIABLE + 1)
19 
20 extern const char *map_type__name[MAP__NR_TYPES];
21 
22 struct dso;
23 struct ip_callchain;
24 struct ref_reloc_sym;
25 struct map_groups;
26 struct machine;
27 struct perf_evsel;
28 
29 struct map {
30 	union {
31 		struct rb_node	rb_node;
32 		struct list_head node;
33 	};
34 	u64			start;
35 	u64			end;
36 	u8 /* enum map_type */	type;
37 	bool			erange_warned;
38 	u32			priv;
39 	u32			prot;
40 	u32			flags;
41 	u64			pgoff;
42 	u64			reloc;
43 	u32			maj, min; /* only valid for MMAP2 record */
44 	u64			ino;      /* only valid for MMAP2 record */
45 	u64			ino_generation;/* only valid for MMAP2 record */
46 
47 	/* ip -> dso rip */
48 	u64			(*map_ip)(struct map *, u64);
49 	/* dso rip -> ip */
50 	u64			(*unmap_ip)(struct map *, u64);
51 
52 	struct dso		*dso;
53 	struct map_groups	*groups;
54 	refcount_t		refcnt;
55 };
56 
57 struct kmap {
58 	struct ref_reloc_sym	*ref_reloc_sym;
59 	struct map_groups	*kmaps;
60 };
61 
62 struct maps {
63 	struct rb_root	 entries;
64 	pthread_rwlock_t lock;
65 };
66 
67 struct map_groups {
68 	struct maps	 maps[MAP__NR_TYPES];
69 	struct machine	 *machine;
70 	refcount_t	 refcnt;
71 };
72 
73 struct map_groups *map_groups__new(struct machine *machine);
74 void map_groups__delete(struct map_groups *mg);
75 bool map_groups__empty(struct map_groups *mg);
76 
77 static inline struct map_groups *map_groups__get(struct map_groups *mg)
78 {
79 	if (mg)
80 		refcount_inc(&mg->refcnt);
81 	return mg;
82 }
83 
84 void map_groups__put(struct map_groups *mg);
85 
86 struct kmap *map__kmap(struct map *map);
87 struct map_groups *map__kmaps(struct map *map);
88 
89 static inline u64 map__map_ip(struct map *map, u64 ip)
90 {
91 	return ip - map->start + map->pgoff;
92 }
93 
94 static inline u64 map__unmap_ip(struct map *map, u64 ip)
95 {
96 	return ip + map->start - map->pgoff;
97 }
98 
99 static inline u64 identity__map_ip(struct map *map __maybe_unused, u64 ip)
100 {
101 	return ip;
102 }
103 
104 
105 /* rip/ip <-> addr suitable for passing to `objdump --start-address=` */
106 u64 map__rip_2objdump(struct map *map, u64 rip);
107 
108 /* objdump address -> memory address */
109 u64 map__objdump_2mem(struct map *map, u64 ip);
110 
111 struct symbol;
112 struct thread;
113 
114 /* map__for_each_symbol - iterate over the symbols in the given map
115  *
116  * @map: the 'struct map *' in which symbols itereated
117  * @pos: the 'struct symbol *' to use as a loop cursor
118  * @n: the 'struct rb_node *' to use as a temporary storage
119  * Note: caller must ensure map->dso is not NULL (map is loaded).
120  */
121 #define map__for_each_symbol(map, pos, n)	\
122 	dso__for_each_symbol(map->dso, pos, n, map->type)
123 
124 /* map__for_each_symbol_with_name - iterate over the symbols in the given map
125  *                                  that have the given name
126  *
127  * @map: the 'struct map *' in which symbols itereated
128  * @sym_name: the symbol name
129  * @pos: the 'struct symbol *' to use as a loop cursor
130  */
131 #define __map__for_each_symbol_by_name(map, sym_name, pos)	\
132 	for (pos = map__find_symbol_by_name(map, sym_name);	\
133 	     pos &&						\
134 	     !symbol__match_symbol_name(pos->name, sym_name,	\
135 					SYMBOL_TAG_INCLUDE__DEFAULT_ONLY); \
136 	     pos = symbol__next_by_name(pos))
137 
138 #define map__for_each_symbol_by_name(map, sym_name, pos)		\
139 	__map__for_each_symbol_by_name(map, sym_name, (pos))
140 
141 void map__init(struct map *map, enum map_type type,
142 	       u64 start, u64 end, u64 pgoff, struct dso *dso);
143 struct map *map__new(struct machine *machine, u64 start, u64 len,
144 		     u64 pgoff, u32 pid, u32 d_maj, u32 d_min, u64 ino,
145 		     u64 ino_gen, u32 prot, u32 flags,
146 		     char *filename, enum map_type type, struct thread *thread);
147 struct map *map__new2(u64 start, struct dso *dso, enum map_type type);
148 void map__delete(struct map *map);
149 struct map *map__clone(struct map *map);
150 
151 static inline struct map *map__get(struct map *map)
152 {
153 	if (map)
154 		refcount_inc(&map->refcnt);
155 	return map;
156 }
157 
158 void map__put(struct map *map);
159 
160 static inline void __map__zput(struct map **map)
161 {
162 	map__put(*map);
163 	*map = NULL;
164 }
165 
166 #define map__zput(map) __map__zput(&map)
167 
168 int map__overlap(struct map *l, struct map *r);
169 size_t map__fprintf(struct map *map, FILE *fp);
170 size_t map__fprintf_dsoname(struct map *map, FILE *fp);
171 int map__fprintf_srcline(struct map *map, u64 addr, const char *prefix,
172 			 FILE *fp);
173 
174 int map__load(struct map *map);
175 struct symbol *map__find_symbol(struct map *map, u64 addr);
176 struct symbol *map__find_symbol_by_name(struct map *map, const char *name);
177 void map__fixup_start(struct map *map);
178 void map__fixup_end(struct map *map);
179 
180 void map__reloc_vmlinux(struct map *map);
181 
182 size_t __map_groups__fprintf_maps(struct map_groups *mg, enum map_type type,
183 				  FILE *fp);
184 void maps__insert(struct maps *maps, struct map *map);
185 void maps__remove(struct maps *maps, struct map *map);
186 struct map *maps__find(struct maps *maps, u64 addr);
187 struct map *maps__first(struct maps *maps);
188 struct map *map__next(struct map *map);
189 struct symbol *maps__find_symbol_by_name(struct maps *maps, const char *name,
190                                          struct map **mapp);
191 void map_groups__init(struct map_groups *mg, struct machine *machine);
192 void map_groups__exit(struct map_groups *mg);
193 int map_groups__clone(struct thread *thread,
194 		      struct map_groups *parent, enum map_type type);
195 size_t map_groups__fprintf(struct map_groups *mg, FILE *fp);
196 
197 int maps__set_kallsyms_ref_reloc_sym(struct map **maps, const char *symbol_name,
198 				     u64 addr);
199 
200 static inline void map_groups__insert(struct map_groups *mg, struct map *map)
201 {
202 	maps__insert(&mg->maps[map->type], map);
203 	map->groups = mg;
204 }
205 
206 static inline void map_groups__remove(struct map_groups *mg, struct map *map)
207 {
208 	maps__remove(&mg->maps[map->type], map);
209 }
210 
211 static inline struct map *map_groups__find(struct map_groups *mg,
212 					   enum map_type type, u64 addr)
213 {
214 	return maps__find(&mg->maps[type], addr);
215 }
216 
217 static inline struct map *map_groups__first(struct map_groups *mg,
218 					    enum map_type type)
219 {
220 	return maps__first(&mg->maps[type]);
221 }
222 
223 static inline struct map *map_groups__next(struct map *map)
224 {
225 	return map__next(map);
226 }
227 
228 struct symbol *map_groups__find_symbol(struct map_groups *mg,
229 				       enum map_type type, u64 addr,
230 				       struct map **mapp);
231 
232 struct symbol *map_groups__find_symbol_by_name(struct map_groups *mg,
233 					       enum map_type type,
234 					       const char *name,
235 					       struct map **mapp);
236 
237 struct addr_map_symbol;
238 
239 int map_groups__find_ams(struct addr_map_symbol *ams);
240 
241 static inline
242 struct symbol *map_groups__find_function_by_name(struct map_groups *mg,
243 						 const char *name, struct map **mapp)
244 {
245 	return map_groups__find_symbol_by_name(mg, MAP__FUNCTION, name, mapp);
246 }
247 
248 int map_groups__fixup_overlappings(struct map_groups *mg, struct map *map,
249 				   FILE *fp);
250 
251 struct map *map_groups__find_by_name(struct map_groups *mg,
252 				     enum map_type type, const char *name);
253 
254 bool __map__is_kernel(const struct map *map);
255 
256 static inline bool __map__is_kmodule(const struct map *map)
257 {
258 	return !__map__is_kernel(map);
259 }
260 
261 #endif /* __PERF_MAP_H */
262