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