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