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#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 ip_callchain;
22struct ref_reloc_sym;
23struct map_groups;
24struct machine;
25struct perf_evsel;
26
27struct map {
28 union {
29 struct rb_node rb_node;
30 struct list_head node;
31 };
32 u64 start;
33 u64 end;
34 u8 /* enum map_type */ type;
35 bool referenced;
36 bool erange_warned;
37 u32 priv;
38 u64 pgoff;
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};
48
49struct kmap {
50 struct ref_reloc_sym *ref_reloc_sym;
51 struct map_groups *kmaps;
52};
53
54struct map_groups {
55 struct rb_root maps[MAP__NR_TYPES];
56 struct list_head removed_maps[MAP__NR_TYPES];
57 struct machine *machine;
58};
59
60/* Native host kernel uses -1 as pid index in machine */
61#define HOST_KERNEL_ID (-1)
62#define DEFAULT_GUEST_KERNEL_ID (0)
63
64struct machine {
65 struct rb_node rb_node;
66 pid_t pid;
67 u16 id_hdr_size;
68 char *root_dir;
69 struct rb_root threads;
70 struct list_head dead_threads;
71 struct thread *last_match;
72 struct list_head user_dsos;
73 struct list_head kernel_dsos;
74 struct map_groups kmaps;
75 struct map *vmlinux_maps[MAP__NR_TYPES];
76};
77
78static inline
79struct map *machine__kernel_map(struct machine *self, enum map_type type)
80{
81 return self->vmlinux_maps[type];
82}
83
84static inline struct kmap *map__kmap(struct map *self)
85{
86 return (struct kmap *)(self + 1);
87}
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 __used, 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);
107u64 map__objdump_2ip(struct map *map, u64 addr);
108
109struct symbol;
110
111typedef int (*symbol_filter_t)(struct map *map, struct symbol *sym);
112
113void map__init(struct map *self, enum map_type type,
114 u64 start, u64 end, u64 pgoff, struct dso *dso);
115struct map *map__new(struct list_head *dsos__list, u64 start, u64 len,
116 u64 pgoff, u32 pid, char *filename,
117 enum map_type type);
118void map__delete(struct map *self);
119struct map *map__clone(struct map *self);
120int map__overlap(struct map *l, struct map *r);
121size_t map__fprintf(struct map *self, FILE *fp);
122size_t map__fprintf_dsoname(struct map *map, FILE *fp);
123
124int map__load(struct map *self, symbol_filter_t filter);
125struct symbol *map__find_symbol(struct map *self,
126 u64 addr, symbol_filter_t filter);
127struct symbol *map__find_symbol_by_name(struct map *self, const char *name,
128 symbol_filter_t filter);
129void map__fixup_start(struct map *self);
130void map__fixup_end(struct map *self);
131
132void map__reloc_vmlinux(struct map *self);
133
134size_t __map_groups__fprintf_maps(struct map_groups *mg,
135 enum map_type type, int verbose, FILE *fp);
136void maps__insert(struct rb_root *maps, struct map *map);
137void maps__remove(struct rb_root *maps, struct map *map);
138struct map *maps__find(struct rb_root *maps, u64 addr);
139void map_groups__init(struct map_groups *mg);
140void map_groups__exit(struct map_groups *mg);
141int map_groups__clone(struct map_groups *mg,
142 struct map_groups *parent, enum map_type type);
143size_t map_groups__fprintf(struct map_groups *mg, int verbose, FILE *fp);
144size_t map_groups__fprintf_maps(struct map_groups *mg, int verbose, FILE *fp);
145
146typedef void (*machine__process_t)(struct machine *self, void *data);
147
148void machines__process(struct rb_root *self, machine__process_t process, void *data);
149struct machine *machines__add(struct rb_root *self, pid_t pid,
150 const char *root_dir);
151struct machine *machines__find_host(struct rb_root *self);
152struct machine *machines__find(struct rb_root *self, pid_t pid);
153struct machine *machines__findnew(struct rb_root *self, pid_t pid);
154char *machine__mmap_name(struct machine *self, char *bf, size_t size);
155int machine__init(struct machine *self, const char *root_dir, pid_t pid);
156void machine__exit(struct machine *self);
157void machine__delete(struct machine *self);
158
159int machine__resolve_callchain(struct machine *machine,
160 struct perf_evsel *evsel, struct thread *thread,
161 struct ip_callchain *chain,
162 struct symbol **parent);
163int maps__set_kallsyms_ref_reloc_sym(struct map **maps, const char *symbol_name,
164 u64 addr);
165
166/*
167 * Default guest kernel is defined by parameter --guestkallsyms
168 * and --guestmodules
169 */
170static inline bool machine__is_default_guest(struct machine *self)
171{
172 return self ? self->pid == DEFAULT_GUEST_KERNEL_ID : false;
173}
174
175static inline bool machine__is_host(struct machine *self)
176{
177 return self ? self->pid == HOST_KERNEL_ID : false;
178}
179
180static inline void map_groups__insert(struct map_groups *mg, struct map *map)
181{
182 maps__insert(&mg->maps[map->type], map);
183 map->groups = mg;
184}
185
186static inline void map_groups__remove(struct map_groups *mg, struct map *map)
187{
188 maps__remove(&mg->maps[map->type], map);
189}
190
191static inline struct map *map_groups__find(struct map_groups *mg,
192 enum map_type type, u64 addr)
193{
194 return maps__find(&mg->maps[type], addr);
195}
196
197struct symbol *map_groups__find_symbol(struct map_groups *mg,
198 enum map_type type, u64 addr,
199 struct map **mapp,
200 symbol_filter_t filter);
201
202struct symbol *map_groups__find_symbol_by_name(struct map_groups *mg,
203 enum map_type type,
204 const char *name,
205 struct map **mapp,
206 symbol_filter_t filter);
207
208
209struct thread *machine__findnew_thread(struct machine *machine, pid_t pid);
210void machine__remove_thread(struct machine *machine, struct thread *th);
211
212size_t machine__fprintf(struct machine *machine, FILE *fp);
213
214static inline
215struct symbol *machine__find_kernel_symbol(struct machine *self,
216 enum map_type type, u64 addr,
217 struct map **mapp,
218 symbol_filter_t filter)
219{
220 return map_groups__find_symbol(&self->kmaps, type, addr, mapp, filter);
221}
222
223static inline
224struct symbol *machine__find_kernel_function(struct machine *self, u64 addr,
225 struct map **mapp,
226 symbol_filter_t filter)
227{
228 return machine__find_kernel_symbol(self, MAP__FUNCTION, addr, mapp, filter);
229}
230
231static inline
232struct symbol *map_groups__find_function_by_name(struct map_groups *mg,
233 const char *name, struct map **mapp,
234 symbol_filter_t filter)
235{
236 return map_groups__find_symbol_by_name(mg, MAP__FUNCTION, name, mapp, filter);
237}
238
239static inline
240struct symbol *machine__find_kernel_function_by_name(struct machine *self,
241 const char *name,
242 struct map **mapp,
243 symbol_filter_t filter)
244{
245 return map_groups__find_function_by_name(&self->kmaps, name, mapp,
246 filter);
247}
248
249int map_groups__fixup_overlappings(struct map_groups *mg, struct map *map,
250 int verbose, FILE *fp);
251
252struct map *map_groups__find_by_name(struct map_groups *mg,
253 enum map_type type, const char *name);
254struct map *machine__new_module(struct machine *self, u64 start, const char *filename);
255
256void map_groups__flush(struct map_groups *mg);
257
258#endif /* __PERF_MAP_H */