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 maps;
16struct machine;
17
18struct map {
19 union {
20 struct rb_node rb_node;
21 struct list_head node;
22 };
23 u64 start;
24 u64 end;
25 bool erange_warned:1;
26 bool priv:1;
27 u32 prot;
28 u64 pgoff;
29 u64 reloc;
30
31 /* ip -> dso rip */
32 u64 (*map_ip)(const struct map *, u64);
33 /* dso rip -> ip */
34 u64 (*unmap_ip)(const struct map *, u64);
35
36 struct dso *dso;
37 refcount_t refcnt;
38 u32 flags;
39};
40
41struct kmap;
42
43struct kmap *__map__kmap(struct map *map);
44struct kmap *map__kmap(struct map *map);
45struct maps *map__kmaps(struct map *map);
46
47/* ip -> dso rip */
48u64 map__map_ip(const struct map *map, u64 ip);
49/* dso rip -> ip */
50u64 map__unmap_ip(const struct map *map, u64 ip);
51/* Returns ip */
52u64 identity__map_ip(const struct map *map __maybe_unused, u64 ip);
53
54static inline size_t map__size(const struct map *map)
55{
56 return map->end - map->start;
57}
58
59/* rip/ip <-> addr suitable for passing to `objdump --start-address=` */
60u64 map__rip_2objdump(struct map *map, u64 rip);
61
62/* objdump address -> memory address */
63u64 map__objdump_2mem(struct map *map, u64 ip);
64
65struct symbol;
66struct thread;
67
68/* map__for_each_symbol - iterate over the symbols in the given map
69 *
70 * @map: the 'struct map *' in which symbols are iterated
71 * @pos: the 'struct symbol *' to use as a loop cursor
72 * @n: the 'struct rb_node *' to use as a temporary storage
73 * Note: caller must ensure map->dso is not NULL (map is loaded).
74 */
75#define map__for_each_symbol(map, pos, n) \
76 dso__for_each_symbol(map->dso, pos, n)
77
78/* map__for_each_symbol_with_name - iterate over the symbols in the given map
79 * that have the given name
80 *
81 * @map: the 'struct map *' in which symbols are iterated
82 * @sym_name: the symbol name
83 * @pos: the 'struct symbol *' to use as a loop cursor
84 */
85#define __map__for_each_symbol_by_name(map, sym_name, pos) \
86 for (pos = map__find_symbol_by_name(map, sym_name); \
87 pos && \
88 !symbol__match_symbol_name(pos->name, sym_name, \
89 SYMBOL_TAG_INCLUDE__DEFAULT_ONLY); \
90 pos = symbol__next_by_name(pos))
91
92#define map__for_each_symbol_by_name(map, sym_name, pos) \
93 __map__for_each_symbol_by_name(map, sym_name, (pos))
94
95void map__init(struct map *map,
96 u64 start, u64 end, u64 pgoff, struct dso *dso);
97
98struct dso_id;
99struct build_id;
100
101struct map *map__new(struct machine *machine, u64 start, u64 len,
102 u64 pgoff, struct dso_id *id, u32 prot, u32 flags,
103 struct build_id *bid, char *filename, struct thread *thread);
104struct map *map__new2(u64 start, struct dso *dso);
105void map__delete(struct map *map);
106struct map *map__clone(struct map *map);
107
108static inline struct map *map__get(struct map *map)
109{
110 if (map)
111 refcount_inc(&map->refcnt);
112 return map;
113}
114
115void map__put(struct map *map);
116
117static inline void __map__zput(struct map **map)
118{
119 map__put(*map);
120 *map = NULL;
121}
122
123#define map__zput(map) __map__zput(&map)
124
125size_t map__fprintf(struct map *map, FILE *fp);
126size_t map__fprintf_dsoname(struct map *map, FILE *fp);
127char *map__srcline(struct map *map, u64 addr, struct symbol *sym);
128int map__fprintf_srcline(struct map *map, u64 addr, const char *prefix,
129 FILE *fp);
130
131int map__load(struct map *map);
132struct symbol *map__find_symbol(struct map *map, u64 addr);
133struct symbol *map__find_symbol_by_name(struct map *map, const char *name);
134void map__fixup_start(struct map *map);
135void map__fixup_end(struct map *map);
136
137int map__set_kallsyms_ref_reloc_sym(struct map *map, const char *symbol_name,
138 u64 addr);
139
140bool __map__is_kernel(const struct map *map);
141bool __map__is_extra_kernel_map(const struct map *map);
142bool __map__is_bpf_prog(const struct map *map);
143bool __map__is_bpf_image(const struct map *map);
144bool __map__is_ool(const struct map *map);
145
146static inline bool __map__is_kmodule(const struct map *map)
147{
148 return !__map__is_kernel(map) && !__map__is_extra_kernel_map(map) &&
149 !__map__is_bpf_prog(map) && !__map__is_ool(map) &&
150 !__map__is_bpf_image(map);
151}
152
153bool map__has_symbols(const struct map *map);
154
155bool map__contains_symbol(const struct map *map, const struct symbol *sym);
156
157#define ENTRY_TRAMPOLINE_NAME "__entry_SYSCALL_64_trampoline"
158
159static inline bool is_entry_trampoline(const char *name)
160{
161 return !strcmp(name, ENTRY_TRAMPOLINE_NAME);
162}
163
164static inline bool is_bpf_image(const char *name)
165{
166 return strncmp(name, "bpf_trampoline_", sizeof("bpf_trampoline_") - 1) == 0 ||
167 strncmp(name, "bpf_dispatcher_", sizeof("bpf_dispatcher_") - 1) == 0;
168}
169
170static inline int is_anon_memory(const char *filename)
171{
172 return !strcmp(filename, "//anon") ||
173 !strncmp(filename, "/dev/zero", sizeof("/dev/zero") - 1) ||
174 !strncmp(filename, "/anon_hugepage", sizeof("/anon_hugepage") - 1);
175}
176
177static inline int is_no_dso_memory(const char *filename)
178{
179 return !strncmp(filename, "[stack", 6) ||
180 !strncmp(filename, "/SYSV", 5) ||
181 !strcmp(filename, "[heap]");
182}
183#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 u64 reloc;
40 u32 maj, min; /* only valid for MMAP2 record */
41 u64 ino; /* only valid for MMAP2 record */
42 u64 ino_generation;/* only valid for MMAP2 record */
43
44 /* ip -> dso rip */
45 u64 (*map_ip)(struct map *, u64);
46 /* dso rip -> ip */
47 u64 (*unmap_ip)(struct map *, u64);
48
49 struct dso *dso;
50 struct map_groups *groups;
51};
52
53struct kmap {
54 struct ref_reloc_sym *ref_reloc_sym;
55 struct map_groups *kmaps;
56};
57
58struct map_groups {
59 struct rb_root maps[MAP__NR_TYPES];
60 struct list_head removed_maps[MAP__NR_TYPES];
61 struct machine *machine;
62};
63
64static inline struct kmap *map__kmap(struct map *map)
65{
66 return (struct kmap *)(map + 1);
67}
68
69static inline u64 map__map_ip(struct map *map, u64 ip)
70{
71 return ip - map->start + map->pgoff;
72}
73
74static inline u64 map__unmap_ip(struct map *map, u64 ip)
75{
76 return ip + map->start - map->pgoff;
77}
78
79static inline u64 identity__map_ip(struct map *map __maybe_unused, u64 ip)
80{
81 return ip;
82}
83
84
85/* rip/ip <-> addr suitable for passing to `objdump --start-address=` */
86u64 map__rip_2objdump(struct map *map, u64 rip);
87
88/* objdump address -> memory address */
89u64 map__objdump_2mem(struct map *map, u64 ip);
90
91struct symbol;
92
93/* map__for_each_symbol - iterate over the symbols in the given map
94 *
95 * @map: the 'struct map *' in which symbols itereated
96 * @pos: the 'struct symbol *' to use as a loop cursor
97 * @n: the 'struct rb_node *' to use as a temporary storage
98 * Note: caller must ensure map->dso is not NULL (map is loaded).
99 */
100#define map__for_each_symbol(map, pos, n) \
101 dso__for_each_symbol(map->dso, pos, n, map->type)
102
103typedef int (*symbol_filter_t)(struct map *map, struct symbol *sym);
104
105void map__init(struct map *map, enum map_type type,
106 u64 start, u64 end, u64 pgoff, struct dso *dso);
107struct map *map__new(struct list_head *dsos__list, u64 start, u64 len,
108 u64 pgoff, u32 pid, u32 d_maj, u32 d_min, u64 ino,
109 u64 ino_gen,
110 char *filename, enum map_type type);
111struct map *map__new2(u64 start, struct dso *dso, enum map_type type);
112void map__delete(struct map *map);
113struct map *map__clone(struct map *map);
114int map__overlap(struct map *l, struct map *r);
115size_t map__fprintf(struct map *map, FILE *fp);
116size_t map__fprintf_dsoname(struct map *map, FILE *fp);
117int map__fprintf_srcline(struct map *map, u64 addr, const char *prefix,
118 FILE *fp);
119
120int map__load(struct map *map, symbol_filter_t filter);
121struct symbol *map__find_symbol(struct map *map,
122 u64 addr, symbol_filter_t filter);
123struct symbol *map__find_symbol_by_name(struct map *map, const char *name,
124 symbol_filter_t filter);
125void map__fixup_start(struct map *map);
126void map__fixup_end(struct map *map);
127
128void map__reloc_vmlinux(struct map *map);
129
130size_t __map_groups__fprintf_maps(struct map_groups *mg,
131 enum map_type type, int verbose, FILE *fp);
132void maps__insert(struct rb_root *maps, struct map *map);
133void maps__remove(struct rb_root *maps, struct map *map);
134struct map *maps__find(struct rb_root *maps, u64 addr);
135struct map *maps__first(struct rb_root *maps);
136struct map *maps__next(struct map *map);
137void map_groups__init(struct map_groups *mg);
138void map_groups__exit(struct map_groups *mg);
139int map_groups__clone(struct map_groups *mg,
140 struct map_groups *parent, enum map_type type);
141size_t map_groups__fprintf(struct map_groups *mg, int verbose, FILE *fp);
142size_t map_groups__fprintf_maps(struct map_groups *mg, int verbose, FILE *fp);
143
144int maps__set_kallsyms_ref_reloc_sym(struct map **maps, const char *symbol_name,
145 u64 addr);
146
147static inline void map_groups__insert(struct map_groups *mg, struct map *map)
148{
149 maps__insert(&mg->maps[map->type], map);
150 map->groups = mg;
151}
152
153static inline void map_groups__remove(struct map_groups *mg, struct map *map)
154{
155 maps__remove(&mg->maps[map->type], map);
156}
157
158static inline struct map *map_groups__find(struct map_groups *mg,
159 enum map_type type, u64 addr)
160{
161 return maps__find(&mg->maps[type], addr);
162}
163
164static inline struct map *map_groups__first(struct map_groups *mg,
165 enum map_type type)
166{
167 return maps__first(&mg->maps[type]);
168}
169
170static inline struct map *map_groups__next(struct map *map)
171{
172 return maps__next(map);
173}
174
175struct symbol *map_groups__find_symbol(struct map_groups *mg,
176 enum map_type type, u64 addr,
177 struct map **mapp,
178 symbol_filter_t filter);
179
180struct symbol *map_groups__find_symbol_by_name(struct map_groups *mg,
181 enum map_type type,
182 const char *name,
183 struct map **mapp,
184 symbol_filter_t filter);
185
186struct addr_map_symbol;
187
188int map_groups__find_ams(struct addr_map_symbol *ams, symbol_filter_t filter);
189
190static inline
191struct symbol *map_groups__find_function_by_name(struct map_groups *mg,
192 const char *name, struct map **mapp,
193 symbol_filter_t filter)
194{
195 return map_groups__find_symbol_by_name(mg, MAP__FUNCTION, name, mapp, filter);
196}
197
198int map_groups__fixup_overlappings(struct map_groups *mg, struct map *map,
199 int verbose, FILE *fp);
200
201struct map *map_groups__find_by_name(struct map_groups *mg,
202 enum map_type type, const char *name);
203
204void map_groups__flush(struct map_groups *mg);
205
206#endif /* __PERF_MAP_H */