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 <stdio.h>
10 #include <string.h>
11 #include <stdbool.h>
12 #include <linux/types.h>
13 #include <internal/rc_check.h>
14
15 struct dso;
16 struct maps;
17 struct machine;
18
19 enum mapping_type {
20 /* map__map_ip/map__unmap_ip are given as offsets in the DSO. */
21 MAPPING_TYPE__DSO,
22 /* map__map_ip/map__unmap_ip are just the given ip value. */
23 MAPPING_TYPE__IDENTITY,
24 };
25
26 DECLARE_RC_STRUCT(map) {
27 u64 start;
28 u64 end;
29 u64 pgoff;
30 u64 reloc;
31 struct dso *dso;
32 refcount_t refcnt;
33 u32 prot;
34 u32 flags;
35 enum mapping_type mapping_type:8;
36 bool erange_warned;
37 bool priv;
38 };
39
40 struct kmap;
41
42 struct kmap *__map__kmap(struct map *map);
43 struct kmap *map__kmap(struct map *map);
44 struct maps *map__kmaps(struct map *map);
45
46 static inline struct dso *map__dso(const struct map *map)
47 {
48 return RC_CHK_ACCESS(map)->dso;
49 }
50
51 static inline u64 map__start(const struct map *map)
52 {
53 return RC_CHK_ACCESS(map)->start;
54 }
55
56 static inline u64 map__end(const struct map *map)
57 {
58 return RC_CHK_ACCESS(map)->end;
59 }
60
61 static inline u64 map__pgoff(const struct map *map)
62 {
63 return RC_CHK_ACCESS(map)->pgoff;
64 }
65
66 static inline u64 map__reloc(const struct map *map)
67 {
68 return RC_CHK_ACCESS(map)->reloc;
69 }
70
71 static inline u32 map__flags(const struct map *map)
72 {
73 return RC_CHK_ACCESS(map)->flags;
74 }
75
76 static inline u32 map__prot(const struct map *map)
77 {
78 return RC_CHK_ACCESS(map)->prot;
79 }
80
81 static inline bool map__priv(const struct map *map)
82 {
83 return RC_CHK_ACCESS(map)->priv;
84 }
85
86 static inline refcount_t *map__refcnt(struct map *map)
87 {
88 return &RC_CHK_ACCESS(map)->refcnt;
89 }
90
91 static inline bool map__erange_warned(struct map *map)
92 {
93 return RC_CHK_ACCESS(map)->erange_warned;
94 }
95
96 static inline size_t map__size(const struct map *map)
97 {
98 return map__end(map) - map__start(map);
99 }
100
101 /* ip -> dso rip */
102 static inline u64 map__dso_map_ip(const struct map *map, u64 ip)
103 {
104 return ip - map__start(map) + map__pgoff(map);
105 }
106
107 /* dso rip -> ip */
108 static inline u64 map__dso_unmap_ip(const struct map *map, u64 rip)
109 {
110 return rip + map__start(map) - map__pgoff(map);
111 }
112
113 static inline u64 map__map_ip(const struct map *map, u64 ip_or_rip)
114 {
115 if ((RC_CHK_ACCESS(map)->mapping_type) == MAPPING_TYPE__DSO)
116 return map__dso_map_ip(map, ip_or_rip);
117 else
118 return ip_or_rip;
119 }
120
121 static inline u64 map__unmap_ip(const struct map *map, u64 ip_or_rip)
122 {
123 if ((RC_CHK_ACCESS(map)->mapping_type) == MAPPING_TYPE__DSO)
124 return map__dso_unmap_ip(map, ip_or_rip);
125 else
126 return ip_or_rip;
127 }
128
129 /* rip/ip <-> addr suitable for passing to `objdump --start-address=` */
130 u64 map__rip_2objdump(struct map *map, u64 rip);
131
132 /* objdump address -> memory address */
133 u64 map__objdump_2mem(struct map *map, u64 ip);
134
135 /* objdump address -> rip */
136 u64 map__objdump_2rip(struct map *map, u64 ip);
137
138 struct symbol;
139 struct thread;
140
141 /* map__for_each_symbol - iterate over the symbols in the given map
142 *
143 * @map: the 'struct map *' in which symbols are iterated
144 * @pos: the 'struct symbol *' to use as a loop cursor
145 * @n: the 'struct rb_node *' to use as a temporary storage
146 * Note: caller must ensure map->dso is not NULL (map is loaded).
147 */
148 #define map__for_each_symbol(map, pos, n) \
149 dso__for_each_symbol(map__dso(map), pos, n)
150
151 /* map__for_each_symbol_with_name - iterate over the symbols in the given map
152 * that have the given name
153 *
154 * @map: the 'struct map *' in which symbols are iterated
155 * @sym_name: the symbol name
156 * @pos: the 'struct symbol *' to use as a loop cursor
157 * @idx: the cursor index in the symbol names array
158 */
159 #define __map__for_each_symbol_by_name(map, sym_name, pos, idx) \
160 for (pos = map__find_symbol_by_name_idx(map, sym_name, &idx); \
161 pos && \
162 !symbol__match_symbol_name(pos->name, sym_name, \
163 SYMBOL_TAG_INCLUDE__DEFAULT_ONLY); \
164 pos = dso__next_symbol_by_name(map__dso(map), &idx))
165
166 #define map__for_each_symbol_by_name(map, sym_name, pos, idx) \
167 __map__for_each_symbol_by_name(map, sym_name, (pos), idx)
168
169 void map__init(struct map *map,
170 u64 start, u64 end, u64 pgoff, struct dso *dso);
171
172 struct dso_id;
173 struct build_id;
174
175 struct map *map__new(struct machine *machine, u64 start, u64 len,
176 u64 pgoff, struct dso_id *id, u32 prot, u32 flags,
177 struct build_id *bid, char *filename, struct thread *thread);
178 struct map *map__new2(u64 start, struct dso *dso);
179 void map__delete(struct map *map);
180 struct map *map__clone(struct map *map);
181
182 static inline struct map *map__get(struct map *map)
183 {
184 struct map *result;
185
186 if (RC_CHK_GET(result, map))
187 refcount_inc(map__refcnt(map));
188
189 return result;
190 }
191
192 void map__put(struct map *map);
193
194 static inline void __map__zput(struct map **map)
195 {
196 map__put(*map);
197 *map = NULL;
198 }
199
200 #define map__zput(map) __map__zput(&map)
201
202 size_t map__fprintf(struct map *map, FILE *fp);
203 size_t map__fprintf_dsoname(struct map *map, FILE *fp);
204 size_t map__fprintf_dsoname_dsoff(struct map *map, bool print_off, u64 addr, FILE *fp);
205 char *map__srcline(struct map *map, u64 addr, struct symbol *sym);
206 int map__fprintf_srcline(struct map *map, u64 addr, const char *prefix,
207 FILE *fp);
208
209 int map__load(struct map *map);
210 struct symbol *map__find_symbol(struct map *map, u64 addr);
211 struct symbol *map__find_symbol_by_name(struct map *map, const char *name);
212 struct symbol *map__find_symbol_by_name_idx(struct map *map, const char *name, size_t *idx);
213 void map__fixup_start(struct map *map);
214 void map__fixup_end(struct map *map);
215
216 int map__set_kallsyms_ref_reloc_sym(struct map *map, const char *symbol_name,
217 u64 addr);
218
219 bool __map__is_kernel(const struct map *map);
220 bool __map__is_extra_kernel_map(const struct map *map);
221 bool __map__is_bpf_prog(const struct map *map);
222 bool __map__is_bpf_image(const struct map *map);
223 bool __map__is_ool(const struct map *map);
224
225 static inline bool __map__is_kmodule(const struct map *map)
226 {
227 return !__map__is_kernel(map) && !__map__is_extra_kernel_map(map) &&
228 !__map__is_bpf_prog(map) && !__map__is_ool(map) &&
229 !__map__is_bpf_image(map);
230 }
231
232 bool map__has_symbols(const struct map *map);
233
234 bool map__contains_symbol(const struct map *map, const struct symbol *sym);
235
236 #define ENTRY_TRAMPOLINE_NAME "__entry_SYSCALL_64_trampoline"
237
238 static inline bool is_entry_trampoline(const char *name)
239 {
240 return !strcmp(name, ENTRY_TRAMPOLINE_NAME);
241 }
242
243 static inline bool is_bpf_image(const char *name)
244 {
245 return strncmp(name, "bpf_trampoline_", sizeof("bpf_trampoline_") - 1) == 0 ||
246 strncmp(name, "bpf_dispatcher_", sizeof("bpf_dispatcher_") - 1) == 0;
247 }
248
249 static inline int is_anon_memory(const char *filename)
250 {
251 return !strcmp(filename, "//anon") ||
252 !strncmp(filename, "/dev/zero", sizeof("/dev/zero") - 1) ||
253 !strncmp(filename, "/anon_hugepage", sizeof("/anon_hugepage") - 1);
254 }
255
256 static inline int is_no_dso_memory(const char *filename)
257 {
258 return !strncmp(filename, "[stack", 6) ||
259 !strncmp(filename, "/SYSV", 5) ||
260 !strcmp(filename, "[heap]");
261 }
262
263 static inline void map__set_start(struct map *map, u64 start)
264 {
265 RC_CHK_ACCESS(map)->start = start;
266 }
267
268 static inline void map__set_end(struct map *map, u64 end)
269 {
270 RC_CHK_ACCESS(map)->end = end;
271 }
272
273 static inline void map__set_pgoff(struct map *map, u64 pgoff)
274 {
275 RC_CHK_ACCESS(map)->pgoff = pgoff;
276 }
277
278 static inline void map__add_pgoff(struct map *map, u64 inc)
279 {
280 RC_CHK_ACCESS(map)->pgoff += inc;
281 }
282
283 static inline void map__set_reloc(struct map *map, u64 reloc)
284 {
285 RC_CHK_ACCESS(map)->reloc = reloc;
286 }
287
288 static inline void map__set_priv(struct map *map, int priv)
289 {
290 RC_CHK_ACCESS(map)->priv = priv;
291 }
292
293 static inline void map__set_erange_warned(struct map *map, bool erange_warned)
294 {
295 RC_CHK_ACCESS(map)->erange_warned = erange_warned;
296 }
297
298 static inline void map__set_dso(struct map *map, struct dso *dso)
299 {
300 RC_CHK_ACCESS(map)->dso = dso;
301 }
302
303 static inline void map__set_mapping_type(struct map *map, enum mapping_type type)
304 {
305 RC_CHK_ACCESS(map)->mapping_type = type;
306 }
307
308 static inline enum mapping_type map__mapping_type(struct map *map)
309 {
310 return RC_CHK_ACCESS(map)->mapping_type;
311 }
312 #endif /* __PERF_MAP_H */
313
Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.