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 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 */