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