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)(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
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
47 /* ip -> dso rip */
48 u64 map__map_ip(const struct map *map, u64 ip);
49 /* dso rip -> ip */
50 u64 map__unmap_ip(const struct map *map, u64 ip);
51 /* Returns ip */
52 u64 identity__map_ip(const struct map *map __maybe_unused, u64 ip);
53
map__size(const struct map * map)54 static 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=` */
60 u64 map__rip_2objdump(struct map *map, u64 rip);
61
62 /* objdump address -> memory address */
63 u64 map__objdump_2mem(struct map *map, u64 ip);
64
65 struct symbol;
66 struct 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
95 void map__init(struct map *map,
96 u64 start, u64 end, u64 pgoff, struct dso *dso);
97
98 struct dso_id;
99 struct build_id;
100
101 struct 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);
104 struct map *map__new2(u64 start, struct dso *dso);
105 void map__delete(struct map *map);
106 struct map *map__clone(struct map *map);
107
map__get(struct map * map)108 static inline struct map *map__get(struct map *map)
109 {
110 if (map)
111 refcount_inc(&map->refcnt);
112 return map;
113 }
114
115 void map__put(struct map *map);
116
__map__zput(struct map ** map)117 static 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
125 size_t map__fprintf(struct map *map, FILE *fp);
126 size_t map__fprintf_dsoname(struct map *map, FILE *fp);
127 char *map__srcline(struct map *map, u64 addr, struct symbol *sym);
128 int map__fprintf_srcline(struct map *map, u64 addr, const char *prefix,
129 FILE *fp);
130
131 int map__load(struct map *map);
132 struct symbol *map__find_symbol(struct map *map, u64 addr);
133 struct symbol *map__find_symbol_by_name(struct map *map, const char *name);
134 void map__fixup_start(struct map *map);
135 void map__fixup_end(struct map *map);
136
137 int map__set_kallsyms_ref_reloc_sym(struct map *map, const char *symbol_name,
138 u64 addr);
139
140 bool __map__is_kernel(const struct map *map);
141 bool __map__is_extra_kernel_map(const struct map *map);
142 bool __map__is_bpf_prog(const struct map *map);
143 bool __map__is_bpf_image(const struct map *map);
144 bool __map__is_ool(const struct map *map);
145
__map__is_kmodule(const struct map * map)146 static 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
153 bool map__has_symbols(const struct map *map);
154
155 bool map__contains_symbol(const struct map *map, const struct symbol *sym);
156
157 #define ENTRY_TRAMPOLINE_NAME "__entry_SYSCALL_64_trampoline"
158
is_entry_trampoline(const char * name)159 static inline bool is_entry_trampoline(const char *name)
160 {
161 return !strcmp(name, ENTRY_TRAMPOLINE_NAME);
162 }
163
is_bpf_image(const char * name)164 static 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
is_anon_memory(const char * filename)170 static 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
is_no_dso_memory(const char * filename)177 static 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 */
184