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 <string.h>
12 #include <stdbool.h>
13 #include <linux/types.h>
14 #include "rwsem.h"
15
16 struct dso;
17 struct ip_callchain;
18 struct ref_reloc_sym;
19 struct map_groups;
20 struct machine;
21 struct perf_evsel;
22
23 struct map {
24 union {
25 struct rb_node rb_node;
26 struct list_head node;
27 };
28 u64 start;
29 u64 end;
30 bool erange_warned;
31 u32 priv;
32 u32 prot;
33 u32 flags;
34 u64 pgoff;
35 u64 reloc;
36 u32 maj, min; /* only valid for MMAP2 record */
37 u64 ino; /* only valid for MMAP2 record */
38 u64 ino_generation;/* only valid for MMAP2 record */
39
40 /* ip -> dso rip */
41 u64 (*map_ip)(struct map *, u64);
42 /* dso rip -> ip */
43 u64 (*unmap_ip)(struct map *, u64);
44
45 struct dso *dso;
46 struct map_groups *groups;
47 refcount_t refcnt;
48 };
49
50 #define KMAP_NAME_LEN 256
51
52 struct kmap {
53 struct ref_reloc_sym *ref_reloc_sym;
54 struct map_groups *kmaps;
55 char name[KMAP_NAME_LEN];
56 };
57
58 struct maps {
59 struct rb_root entries;
60 struct rw_semaphore lock;
61 };
62
63 struct map_groups {
64 struct maps maps;
65 struct machine *machine;
66 refcount_t refcnt;
67 };
68
69 struct map_groups *map_groups__new(struct machine *machine);
70 void map_groups__delete(struct map_groups *mg);
71 bool map_groups__empty(struct map_groups *mg);
72
map_groups__get(struct map_groups * mg)73 static inline struct map_groups *map_groups__get(struct map_groups *mg)
74 {
75 if (mg)
76 refcount_inc(&mg->refcnt);
77 return mg;
78 }
79
80 void map_groups__put(struct map_groups *mg);
81
82 struct kmap *__map__kmap(struct map *map);
83 struct kmap *map__kmap(struct map *map);
84 struct map_groups *map__kmaps(struct map *map);
85
map__map_ip(struct map * map,u64 ip)86 static inline u64 map__map_ip(struct map *map, u64 ip)
87 {
88 return ip - map->start + map->pgoff;
89 }
90
map__unmap_ip(struct map * map,u64 ip)91 static inline u64 map__unmap_ip(struct map *map, u64 ip)
92 {
93 return ip + map->start - map->pgoff;
94 }
95
identity__map_ip(struct map * map __maybe_unused,u64 ip)96 static inline u64 identity__map_ip(struct map *map __maybe_unused, u64 ip)
97 {
98 return ip;
99 }
100
map__size(const struct map * map)101 static inline size_t map__size(const struct map *map)
102 {
103 return map->end - map->start;
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)
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,
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, struct thread *thread);
148 struct map *map__new2(u64 start, struct dso *dso);
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 size_t map__fprintf(struct map *map, FILE *fp);
170 size_t map__fprintf_dsoname(struct map *map, FILE *fp);
171 char *map__srcline(struct map *map, u64 addr, struct symbol *sym);
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 void maps__insert(struct maps *maps, struct map *map);
184 void maps__remove(struct maps *maps, struct map *map);
185 struct map *maps__find(struct maps *maps, u64 addr);
186 struct map *maps__first(struct maps *maps);
187 struct map *map__next(struct map *map);
188 struct symbol *maps__find_symbol_by_name(struct maps *maps, const char *name,
189 struct map **mapp);
190 void map_groups__init(struct map_groups *mg, struct machine *machine);
191 void map_groups__exit(struct map_groups *mg);
192 int map_groups__clone(struct thread *thread,
193 struct map_groups *parent);
194 size_t map_groups__fprintf(struct map_groups *mg, FILE *fp);
195
196 int map__set_kallsyms_ref_reloc_sym(struct map *map, const char *symbol_name,
197 u64 addr);
198
map_groups__insert(struct map_groups * mg,struct map * map)199 static inline void map_groups__insert(struct map_groups *mg, struct map *map)
200 {
201 maps__insert(&mg->maps, map);
202 map->groups = mg;
203 }
204
map_groups__remove(struct map_groups * mg,struct map * map)205 static inline void map_groups__remove(struct map_groups *mg, struct map *map)
206 {
207 maps__remove(&mg->maps, map);
208 }
209
map_groups__find(struct map_groups * mg,u64 addr)210 static inline struct map *map_groups__find(struct map_groups *mg, u64 addr)
211 {
212 return maps__find(&mg->maps, addr);
213 }
214
215 struct map *map_groups__first(struct map_groups *mg);
216
map_groups__next(struct map * map)217 static inline struct map *map_groups__next(struct map *map)
218 {
219 return map__next(map);
220 }
221
222 struct symbol *map_groups__find_symbol(struct map_groups *mg,
223 u64 addr, struct map **mapp);
224
225 struct symbol *map_groups__find_symbol_by_name(struct map_groups *mg,
226 const char *name,
227 struct map **mapp);
228
229 struct addr_map_symbol;
230
231 int map_groups__find_ams(struct addr_map_symbol *ams);
232
233 int map_groups__fixup_overlappings(struct map_groups *mg, struct map *map,
234 FILE *fp);
235
236 struct map *map_groups__find_by_name(struct map_groups *mg, const char *name);
237
238 bool __map__is_kernel(const struct map *map);
239 bool __map__is_extra_kernel_map(const struct map *map);
240
__map__is_kmodule(const struct map * map)241 static inline bool __map__is_kmodule(const struct map *map)
242 {
243 return !__map__is_kernel(map) && !__map__is_extra_kernel_map(map);
244 }
245
246 bool map__has_symbols(const struct map *map);
247
248 #define ENTRY_TRAMPOLINE_NAME "__entry_SYSCALL_64_trampoline"
249
is_entry_trampoline(const char * name)250 static inline bool is_entry_trampoline(const char *name)
251 {
252 return !strcmp(name, ENTRY_TRAMPOLINE_NAME);
253 }
254
255 #endif /* __PERF_MAP_H */
256
