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