Loading...
1#ifndef __PERF_MAP_H
2#define __PERF_MAP_H
3
4#include <linux/compiler.h>
5#include <linux/list.h>
6#include <linux/rbtree.h>
7#include <stdio.h>
8#include <stdbool.h>
9#include "types.h"
10
11enum map_type {
12 MAP__FUNCTION = 0,
13 MAP__VARIABLE,
14};
15
16#define MAP__NR_TYPES (MAP__VARIABLE + 1)
17
18extern const char *map_type__name[MAP__NR_TYPES];
19
20struct dso;
21struct ref_reloc_sym;
22struct map_groups;
23struct machine;
24
25struct map {
26 union {
27 struct rb_node rb_node;
28 struct list_head node;
29 };
30 u64 start;
31 u64 end;
32 u8 /* enum map_type */ type;
33 bool referenced;
34 u32 priv;
35 u64 pgoff;
36
37 /* ip -> dso rip */
38 u64 (*map_ip)(struct map *, u64);
39 /* dso rip -> ip */
40 u64 (*unmap_ip)(struct map *, u64);
41
42 struct dso *dso;
43 struct map_groups *groups;
44};
45
46struct kmap {
47 struct ref_reloc_sym *ref_reloc_sym;
48 struct map_groups *kmaps;
49};
50
51struct map_groups {
52 struct rb_root maps[MAP__NR_TYPES];
53 struct list_head removed_maps[MAP__NR_TYPES];
54 struct machine *machine;
55};
56
57/* Native host kernel uses -1 as pid index in machine */
58#define HOST_KERNEL_ID (-1)
59#define DEFAULT_GUEST_KERNEL_ID (0)
60
61struct machine {
62 struct rb_node rb_node;
63 pid_t pid;
64 char *root_dir;
65 struct list_head user_dsos;
66 struct list_head kernel_dsos;
67 struct map_groups kmaps;
68 struct map *vmlinux_maps[MAP__NR_TYPES];
69};
70
71static inline
72struct map *machine__kernel_map(struct machine *self, enum map_type type)
73{
74 return self->vmlinux_maps[type];
75}
76
77static inline struct kmap *map__kmap(struct map *self)
78{
79 return (struct kmap *)(self + 1);
80}
81
82static inline u64 map__map_ip(struct map *map, u64 ip)
83{
84 return ip - map->start + map->pgoff;
85}
86
87static inline u64 map__unmap_ip(struct map *map, u64 ip)
88{
89 return ip + map->start - map->pgoff;
90}
91
92static inline u64 identity__map_ip(struct map *map __used, u64 ip)
93{
94 return ip;
95}
96
97
98/* rip/ip <-> addr suitable for passing to `objdump --start-address=` */
99u64 map__rip_2objdump(struct map *map, u64 rip);
100u64 map__objdump_2ip(struct map *map, u64 addr);
101
102struct symbol;
103
104typedef int (*symbol_filter_t)(struct map *map, struct symbol *sym);
105
106void map__init(struct map *self, enum map_type type,
107 u64 start, u64 end, u64 pgoff, struct dso *dso);
108struct map *map__new(struct list_head *dsos__list, u64 start, u64 len,
109 u64 pgoff, u32 pid, char *filename,
110 enum map_type type);
111void map__delete(struct map *self);
112struct map *map__clone(struct map *self);
113int map__overlap(struct map *l, struct map *r);
114size_t map__fprintf(struct map *self, FILE *fp);
115
116int map__load(struct map *self, symbol_filter_t filter);
117struct symbol *map__find_symbol(struct map *self,
118 u64 addr, symbol_filter_t filter);
119struct symbol *map__find_symbol_by_name(struct map *self, const char *name,
120 symbol_filter_t filter);
121void map__fixup_start(struct map *self);
122void map__fixup_end(struct map *self);
123
124void map__reloc_vmlinux(struct map *self);
125
126size_t __map_groups__fprintf_maps(struct map_groups *self,
127 enum map_type type, int verbose, FILE *fp);
128void maps__insert(struct rb_root *maps, struct map *map);
129void maps__remove(struct rb_root *self, struct map *map);
130struct map *maps__find(struct rb_root *maps, u64 addr);
131void map_groups__init(struct map_groups *self);
132void map_groups__exit(struct map_groups *self);
133int map_groups__clone(struct map_groups *self,
134 struct map_groups *parent, enum map_type type);
135size_t map_groups__fprintf(struct map_groups *self, int verbose, FILE *fp);
136size_t map_groups__fprintf_maps(struct map_groups *self, int verbose, FILE *fp);
137
138typedef void (*machine__process_t)(struct machine *self, void *data);
139
140void machines__process(struct rb_root *self, machine__process_t process, void *data);
141struct machine *machines__add(struct rb_root *self, pid_t pid,
142 const char *root_dir);
143struct machine *machines__find_host(struct rb_root *self);
144struct machine *machines__find(struct rb_root *self, pid_t pid);
145struct machine *machines__findnew(struct rb_root *self, pid_t pid);
146char *machine__mmap_name(struct machine *self, char *bf, size_t size);
147int machine__init(struct machine *self, const char *root_dir, pid_t pid);
148void machine__exit(struct machine *self);
149void machine__delete(struct machine *self);
150
151/*
152 * Default guest kernel is defined by parameter --guestkallsyms
153 * and --guestmodules
154 */
155static inline bool machine__is_default_guest(struct machine *self)
156{
157 return self ? self->pid == DEFAULT_GUEST_KERNEL_ID : false;
158}
159
160static inline bool machine__is_host(struct machine *self)
161{
162 return self ? self->pid == HOST_KERNEL_ID : false;
163}
164
165static inline void map_groups__insert(struct map_groups *self, struct map *map)
166{
167 maps__insert(&self->maps[map->type], map);
168 map->groups = self;
169}
170
171static inline void map_groups__remove(struct map_groups *self, struct map *map)
172{
173 maps__remove(&self->maps[map->type], map);
174}
175
176static inline struct map *map_groups__find(struct map_groups *self,
177 enum map_type type, u64 addr)
178{
179 return maps__find(&self->maps[type], addr);
180}
181
182struct symbol *map_groups__find_symbol(struct map_groups *self,
183 enum map_type type, u64 addr,
184 struct map **mapp,
185 symbol_filter_t filter);
186
187struct symbol *map_groups__find_symbol_by_name(struct map_groups *self,
188 enum map_type type,
189 const char *name,
190 struct map **mapp,
191 symbol_filter_t filter);
192
193static inline
194struct symbol *machine__find_kernel_symbol(struct machine *self,
195 enum map_type type, u64 addr,
196 struct map **mapp,
197 symbol_filter_t filter)
198{
199 return map_groups__find_symbol(&self->kmaps, type, addr, mapp, filter);
200}
201
202static inline
203struct symbol *machine__find_kernel_function(struct machine *self, u64 addr,
204 struct map **mapp,
205 symbol_filter_t filter)
206{
207 return machine__find_kernel_symbol(self, MAP__FUNCTION, addr, mapp, filter);
208}
209
210static inline
211struct symbol *map_groups__find_function_by_name(struct map_groups *self,
212 const char *name, struct map **mapp,
213 symbol_filter_t filter)
214{
215 return map_groups__find_symbol_by_name(self, MAP__FUNCTION, name, mapp, filter);
216}
217
218static inline
219struct symbol *machine__find_kernel_function_by_name(struct machine *self,
220 const char *name,
221 struct map **mapp,
222 symbol_filter_t filter)
223{
224 return map_groups__find_function_by_name(&self->kmaps, name, mapp,
225 filter);
226}
227
228int map_groups__fixup_overlappings(struct map_groups *self, struct map *map,
229 int verbose, FILE *fp);
230
231struct map *map_groups__find_by_name(struct map_groups *self,
232 enum map_type type, const char *name);
233struct map *machine__new_module(struct machine *self, u64 start, const char *filename);
234
235void map_groups__flush(struct map_groups *self);
236
237#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#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 */