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