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