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
14struct dso;
15struct ip_callchain;
16struct ref_reloc_sym;
17struct map_groups;
18struct machine;
19struct evsel;
20
21struct map {
22 union {
23 struct rb_node rb_node;
24 struct list_head node;
25 };
26 struct rb_node rb_node_name;
27 u64 start;
28 u64 end;
29 bool erange_warned;
30 u32 priv;
31 u32 prot;
32 u32 flags;
33 u64 pgoff;
34 u64 reloc;
35 u32 maj, min; /* only valid for MMAP2 record */
36 u64 ino; /* only valid for MMAP2 record */
37 u64 ino_generation;/* only valid for MMAP2 record */
38
39 /* ip -> dso rip */
40 u64 (*map_ip)(struct map *, u64);
41 /* dso rip -> ip */
42 u64 (*unmap_ip)(struct map *, u64);
43
44 struct dso *dso;
45 struct map_groups *groups;
46 refcount_t refcnt;
47};
48
49struct kmap;
50
51struct kmap *__map__kmap(struct map *map);
52struct kmap *map__kmap(struct map *map);
53struct map_groups *map__kmaps(struct map *map);
54
55static inline u64 map__map_ip(struct map *map, u64 ip)
56{
57 return ip - map->start + map->pgoff;
58}
59
60static inline u64 map__unmap_ip(struct map *map, u64 ip)
61{
62 return ip + map->start - map->pgoff;
63}
64
65static inline u64 identity__map_ip(struct map *map __maybe_unused, u64 ip)
66{
67 return ip;
68}
69
70static inline size_t map__size(const struct map *map)
71{
72 return map->end - map->start;
73}
74
75/* rip/ip <-> addr suitable for passing to `objdump --start-address=` */
76u64 map__rip_2objdump(struct map *map, u64 rip);
77
78/* objdump address -> memory address */
79u64 map__objdump_2mem(struct map *map, u64 ip);
80
81struct symbol;
82struct thread;
83
84/* map__for_each_symbol - iterate over the symbols in the given map
85 *
86 * @map: the 'struct map *' in which symbols itereated
87 * @pos: the 'struct symbol *' to use as a loop cursor
88 * @n: the 'struct rb_node *' to use as a temporary storage
89 * Note: caller must ensure map->dso is not NULL (map is loaded).
90 */
91#define map__for_each_symbol(map, pos, n) \
92 dso__for_each_symbol(map->dso, pos, n)
93
94/* map__for_each_symbol_with_name - iterate over the symbols in the given map
95 * that have the given name
96 *
97 * @map: the 'struct map *' in which symbols itereated
98 * @sym_name: the symbol name
99 * @pos: the 'struct symbol *' to use as a loop cursor
100 */
101#define __map__for_each_symbol_by_name(map, sym_name, pos) \
102 for (pos = map__find_symbol_by_name(map, sym_name); \
103 pos && \
104 !symbol__match_symbol_name(pos->name, sym_name, \
105 SYMBOL_TAG_INCLUDE__DEFAULT_ONLY); \
106 pos = symbol__next_by_name(pos))
107
108#define map__for_each_symbol_by_name(map, sym_name, pos) \
109 __map__for_each_symbol_by_name(map, sym_name, (pos))
110
111void map__init(struct map *map,
112 u64 start, u64 end, u64 pgoff, struct dso *dso);
113struct map *map__new(struct machine *machine, u64 start, u64 len,
114 u64 pgoff, u32 d_maj, u32 d_min, u64 ino,
115 u64 ino_gen, u32 prot, u32 flags,
116 char *filename, struct thread *thread);
117struct map *map__new2(u64 start, struct dso *dso);
118void map__delete(struct map *map);
119struct map *map__clone(struct map *map);
120
121static inline struct map *map__get(struct map *map)
122{
123 if (map)
124 refcount_inc(&map->refcnt);
125 return map;
126}
127
128void map__put(struct map *map);
129
130static inline void __map__zput(struct map **map)
131{
132 map__put(*map);
133 *map = NULL;
134}
135
136#define map__zput(map) __map__zput(&map)
137
138size_t map__fprintf(struct map *map, FILE *fp);
139size_t map__fprintf_dsoname(struct map *map, FILE *fp);
140char *map__srcline(struct map *map, u64 addr, struct symbol *sym);
141int map__fprintf_srcline(struct map *map, u64 addr, const char *prefix,
142 FILE *fp);
143
144struct srccode_state;
145
146int map__fprintf_srccode(struct map *map, u64 addr,
147 FILE *fp, struct srccode_state *state);
148
149int map__load(struct map *map);
150struct symbol *map__find_symbol(struct map *map, u64 addr);
151struct symbol *map__find_symbol_by_name(struct map *map, const char *name);
152void map__fixup_start(struct map *map);
153void map__fixup_end(struct map *map);
154
155void map__reloc_vmlinux(struct map *map);
156
157int map__set_kallsyms_ref_reloc_sym(struct map *map, const char *symbol_name,
158 u64 addr);
159
160bool __map__is_kernel(const struct map *map);
161bool __map__is_extra_kernel_map(const struct map *map);
162bool __map__is_bpf_prog(const struct map *map);
163
164static inline bool __map__is_kmodule(const struct map *map)
165{
166 return !__map__is_kernel(map) && !__map__is_extra_kernel_map(map) &&
167 !__map__is_bpf_prog(map);
168}
169
170bool map__has_symbols(const struct map *map);
171
172#define ENTRY_TRAMPOLINE_NAME "__entry_SYSCALL_64_trampoline"
173
174static inline bool is_entry_trampoline(const char *name)
175{
176 return !strcmp(name, ENTRY_TRAMPOLINE_NAME);
177}
178
179#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 <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 */