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
14 struct dso;
15 struct maps;
16 struct machine;
17
18 struct 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)(struct map *, u64);
33 /* dso rip -> ip */
34 u64 (*unmap_ip)(struct map *, u64);
35
36 struct dso *dso;
37 refcount_t refcnt;
38 u32 flags;
39 };
40
41 struct kmap;
42
43 struct kmap *__map__kmap(struct map *map);
44 struct kmap *map__kmap(struct map *map);
45 struct maps *map__kmaps(struct map *map);
46
map__map_ip(struct map * map,u64 ip)47 static inline u64 map__map_ip(struct map *map, u64 ip)
48 {
49 return ip - map->start + map->pgoff;
50 }
51
map__unmap_ip(struct map * map,u64 ip)52 static inline u64 map__unmap_ip(struct map *map, u64 ip)
53 {
54 return ip + map->start - map->pgoff;
55 }
56
identity__map_ip(struct map * map __maybe_unused,u64 ip)57 static inline u64 identity__map_ip(struct map *map __maybe_unused, u64 ip)
58 {
59 return ip;
60 }
61
map__size(const struct map * map)62 static inline size_t map__size(const struct map *map)
63 {
64 return map->end - map->start;
65 }
66
67 /* rip/ip <-> addr suitable for passing to `objdump --start-address=` */
68 u64 map__rip_2objdump(struct map *map, u64 rip);
69
70 /* objdump address -> memory address */
71 u64 map__objdump_2mem(struct map *map, u64 ip);
72
73 struct symbol;
74 struct thread;
75
76 /* map__for_each_symbol - iterate over the symbols in the given map
77 *
78 * @map: the 'struct map *' in which symbols itereated
79 * @pos: the 'struct symbol *' to use as a loop cursor
80 * @n: the 'struct rb_node *' to use as a temporary storage
81 * Note: caller must ensure map->dso is not NULL (map is loaded).
82 */
83 #define map__for_each_symbol(map, pos, n) \
84 dso__for_each_symbol(map->dso, pos, n)
85
86 /* map__for_each_symbol_with_name - iterate over the symbols in the given map
87 * that have the given name
88 *
89 * @map: the 'struct map *' in which symbols itereated
90 * @sym_name: the symbol name
91 * @pos: the 'struct symbol *' to use as a loop cursor
92 */
93 #define __map__for_each_symbol_by_name(map, sym_name, pos) \
94 for (pos = map__find_symbol_by_name(map, sym_name); \
95 pos && \
96 !symbol__match_symbol_name(pos->name, sym_name, \
97 SYMBOL_TAG_INCLUDE__DEFAULT_ONLY); \
98 pos = symbol__next_by_name(pos))
99
100 #define map__for_each_symbol_by_name(map, sym_name, pos) \
101 __map__for_each_symbol_by_name(map, sym_name, (pos))
102
103 void map__init(struct map *map,
104 u64 start, u64 end, u64 pgoff, struct dso *dso);
105
106 struct dso_id;
107
108 struct map *map__new(struct machine *machine, u64 start, u64 len,
109 u64 pgoff, struct dso_id *id, u32 prot, u32 flags,
110 char *filename, struct thread *thread);
111 struct map *map__new2(u64 start, struct dso *dso);
112 void map__delete(struct map *map);
113 struct map *map__clone(struct map *map);
114
map__get(struct map * map)115 static inline struct map *map__get(struct map *map)
116 {
117 if (map)
118 refcount_inc(&map->refcnt);
119 return map;
120 }
121
122 void map__put(struct map *map);
123
__map__zput(struct map ** map)124 static inline void __map__zput(struct map **map)
125 {
126 map__put(*map);
127 *map = NULL;
128 }
129
130 #define map__zput(map) __map__zput(&map)
131
132 size_t map__fprintf(struct map *map, FILE *fp);
133 size_t map__fprintf_dsoname(struct map *map, FILE *fp);
134 char *map__srcline(struct map *map, u64 addr, struct symbol *sym);
135 int map__fprintf_srcline(struct map *map, u64 addr, const char *prefix,
136 FILE *fp);
137
138 int map__load(struct map *map);
139 struct symbol *map__find_symbol(struct map *map, u64 addr);
140 struct symbol *map__find_symbol_by_name(struct map *map, const char *name);
141 void map__fixup_start(struct map *map);
142 void map__fixup_end(struct map *map);
143
144 int map__set_kallsyms_ref_reloc_sym(struct map *map, const char *symbol_name,
145 u64 addr);
146
147 bool __map__is_kernel(const struct map *map);
148 bool __map__is_extra_kernel_map(const struct map *map);
149 bool __map__is_bpf_prog(const struct map *map);
150 bool __map__is_bpf_image(const struct map *map);
151 bool __map__is_ool(const struct map *map);
152
__map__is_kmodule(const struct map * map)153 static inline bool __map__is_kmodule(const struct map *map)
154 {
155 return !__map__is_kernel(map) && !__map__is_extra_kernel_map(map) &&
156 !__map__is_bpf_prog(map) && !__map__is_ool(map) &&
157 !__map__is_bpf_image(map);
158 }
159
160 bool map__has_symbols(const struct map *map);
161
162 #define ENTRY_TRAMPOLINE_NAME "__entry_SYSCALL_64_trampoline"
163
is_entry_trampoline(const char * name)164 static inline bool is_entry_trampoline(const char *name)
165 {
166 return !strcmp(name, ENTRY_TRAMPOLINE_NAME);
167 }
168
is_bpf_image(const char * name)169 static inline bool is_bpf_image(const char *name)
170 {
171 return strncmp(name, "bpf_trampoline_", sizeof("bpf_trampoline_") - 1) == 0 ||
172 strncmp(name, "bpf_dispatcher_", sizeof("bpf_dispatcher_") - 1) == 0;
173 }
174
is_anon_memory(const char * filename)175 static inline int is_anon_memory(const char *filename)
176 {
177 return !strcmp(filename, "//anon") ||
178 !strncmp(filename, "/dev/zero", sizeof("/dev/zero") - 1) ||
179 !strncmp(filename, "/anon_hugepage", sizeof("/anon_hugepage") - 1);
180 }
181
is_no_dso_memory(const char * filename)182 static inline int is_no_dso_memory(const char *filename)
183 {
184 return !strncmp(filename, "[stack", 6) ||
185 !strncmp(filename, "/SYSV", 5) ||
186 !strcmp(filename, "[heap]");
187 }
188 #endif /* __PERF_MAP_H */
189
