xref: /openbmc/linux/tools/perf/util/map.h (revision 0da85d1e)
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 <linux/types.h>
10 
11 enum map_type {
12 	MAP__FUNCTION = 0,
13 	MAP__VARIABLE,
14 };
15 
16 #define MAP__NR_TYPES (MAP__VARIABLE + 1)
17 
18 extern const char *map_type__name[MAP__NR_TYPES];
19 
20 struct dso;
21 struct ip_callchain;
22 struct ref_reloc_sym;
23 struct map_groups;
24 struct machine;
25 struct perf_evsel;
26 
27 struct 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 	u32			prot;
39 	u32			flags;
40 	u64			pgoff;
41 	u64			reloc;
42 	u32			maj, min; /* only valid for MMAP2 record */
43 	u64			ino;      /* only valid for MMAP2 record */
44 	u64			ino_generation;/* only valid for MMAP2 record */
45 
46 	/* ip -> dso rip */
47 	u64			(*map_ip)(struct map *, u64);
48 	/* dso rip -> ip */
49 	u64			(*unmap_ip)(struct map *, u64);
50 
51 	struct dso		*dso;
52 	struct map_groups	*groups;
53 };
54 
55 struct kmap {
56 	struct ref_reloc_sym	*ref_reloc_sym;
57 	struct map_groups	*kmaps;
58 };
59 
60 struct map_groups {
61 	struct rb_root	 maps[MAP__NR_TYPES];
62 	struct list_head removed_maps[MAP__NR_TYPES];
63 	struct machine	 *machine;
64 	int		 refcnt;
65 };
66 
67 struct map_groups *map_groups__new(struct machine *machine);
68 void map_groups__delete(struct map_groups *mg);
69 bool map_groups__empty(struct map_groups *mg);
70 
71 static inline struct map_groups *map_groups__get(struct map_groups *mg)
72 {
73 	++mg->refcnt;
74 	return mg;
75 }
76 
77 void map_groups__put(struct map_groups *mg);
78 
79 struct kmap *map__kmap(struct map *map);
80 struct map_groups *map__kmaps(struct map *map);
81 
82 static inline u64 map__map_ip(struct map *map, u64 ip)
83 {
84 	return ip - map->start + map->pgoff;
85 }
86 
87 static inline u64 map__unmap_ip(struct map *map, u64 ip)
88 {
89 	return ip + map->start - map->pgoff;
90 }
91 
92 static inline u64 identity__map_ip(struct map *map __maybe_unused, u64 ip)
93 {
94 	return ip;
95 }
96 
97 
98 /* rip/ip <-> addr suitable for passing to `objdump --start-address=` */
99 u64 map__rip_2objdump(struct map *map, u64 rip);
100 
101 /* objdump address -> memory address */
102 u64 map__objdump_2mem(struct map *map, u64 ip);
103 
104 struct symbol;
105 struct thread;
106 
107 /* map__for_each_symbol - iterate over the symbols in the given map
108  *
109  * @map: the 'struct map *' in which symbols itereated
110  * @pos: the 'struct symbol *' to use as a loop cursor
111  * @n: the 'struct rb_node *' to use as a temporary storage
112  * Note: caller must ensure map->dso is not NULL (map is loaded).
113  */
114 #define map__for_each_symbol(map, pos, n)	\
115 	dso__for_each_symbol(map->dso, pos, n, map->type)
116 
117 /* map__for_each_symbol_with_name - iterate over the symbols in the given map
118  *                                  that have the given name
119  *
120  * @map: the 'struct map *' in which symbols itereated
121  * @sym_name: the symbol name
122  * @pos: the 'struct symbol *' to use as a loop cursor
123  * @filter: to use when loading the DSO
124  */
125 #define __map__for_each_symbol_by_name(map, sym_name, pos, filter)	\
126 	for (pos = map__find_symbol_by_name(map, sym_name, filter);	\
127 	     pos && arch__compare_symbol_names(pos->name, sym_name) == 0;	\
128 	     pos = symbol__next_by_name(pos))
129 
130 #define map__for_each_symbol_by_name(map, sym_name, pos)		\
131 	__map__for_each_symbol_by_name(map, sym_name, (pos), NULL)
132 
133 typedef int (*symbol_filter_t)(struct map *map, struct symbol *sym);
134 
135 int arch__compare_symbol_names(const char *namea, const char *nameb);
136 void map__init(struct map *map, enum map_type type,
137 	       u64 start, u64 end, u64 pgoff, struct dso *dso);
138 struct map *map__new(struct machine *machine, u64 start, u64 len,
139 		     u64 pgoff, u32 pid, u32 d_maj, u32 d_min, u64 ino,
140 		     u64 ino_gen, u32 prot, u32 flags,
141 		     char *filename, enum map_type type, struct thread *thread);
142 struct map *map__new2(u64 start, struct dso *dso, enum map_type type);
143 void map__delete(struct map *map);
144 struct map *map__clone(struct map *map);
145 int map__overlap(struct map *l, struct map *r);
146 size_t map__fprintf(struct map *map, FILE *fp);
147 size_t map__fprintf_dsoname(struct map *map, FILE *fp);
148 int map__fprintf_srcline(struct map *map, u64 addr, const char *prefix,
149 			 FILE *fp);
150 
151 int map__load(struct map *map, symbol_filter_t filter);
152 struct symbol *map__find_symbol(struct map *map,
153 				u64 addr, symbol_filter_t filter);
154 struct symbol *map__find_symbol_by_name(struct map *map, const char *name,
155 					symbol_filter_t filter);
156 void map__fixup_start(struct map *map);
157 void map__fixup_end(struct map *map);
158 
159 void map__reloc_vmlinux(struct map *map);
160 
161 size_t __map_groups__fprintf_maps(struct map_groups *mg, enum map_type type,
162 				  FILE *fp);
163 void maps__insert(struct rb_root *maps, struct map *map);
164 void maps__remove(struct rb_root *maps, struct map *map);
165 struct map *maps__find(struct rb_root *maps, u64 addr);
166 struct map *maps__first(struct rb_root *maps);
167 struct map *maps__next(struct map *map);
168 void map_groups__init(struct map_groups *mg, struct machine *machine);
169 void map_groups__exit(struct map_groups *mg);
170 int map_groups__clone(struct map_groups *mg,
171 		      struct map_groups *parent, enum map_type type);
172 size_t map_groups__fprintf(struct map_groups *mg, FILE *fp);
173 
174 int maps__set_kallsyms_ref_reloc_sym(struct map **maps, const char *symbol_name,
175 				     u64 addr);
176 
177 static inline void map_groups__insert(struct map_groups *mg, struct map *map)
178 {
179 	maps__insert(&mg->maps[map->type], map);
180 	map->groups = mg;
181 }
182 
183 static inline void map_groups__remove(struct map_groups *mg, struct map *map)
184 {
185 	maps__remove(&mg->maps[map->type], map);
186 }
187 
188 static inline struct map *map_groups__find(struct map_groups *mg,
189 					   enum map_type type, u64 addr)
190 {
191 	return maps__find(&mg->maps[type], addr);
192 }
193 
194 static inline struct map *map_groups__first(struct map_groups *mg,
195 					    enum map_type type)
196 {
197 	return maps__first(&mg->maps[type]);
198 }
199 
200 static inline struct map *map_groups__next(struct map *map)
201 {
202 	return maps__next(map);
203 }
204 
205 struct symbol *map_groups__find_symbol(struct map_groups *mg,
206 				       enum map_type type, u64 addr,
207 				       struct map **mapp,
208 				       symbol_filter_t filter);
209 
210 struct symbol *map_groups__find_symbol_by_name(struct map_groups *mg,
211 					       enum map_type type,
212 					       const char *name,
213 					       struct map **mapp,
214 					       symbol_filter_t filter);
215 
216 struct addr_map_symbol;
217 
218 int map_groups__find_ams(struct addr_map_symbol *ams, symbol_filter_t filter);
219 
220 static inline
221 struct symbol *map_groups__find_function_by_name(struct map_groups *mg,
222 						 const char *name, struct map **mapp,
223 						 symbol_filter_t filter)
224 {
225 	return map_groups__find_symbol_by_name(mg, MAP__FUNCTION, name, mapp, filter);
226 }
227 
228 int map_groups__fixup_overlappings(struct map_groups *mg, struct map *map,
229 				   FILE *fp);
230 
231 struct map *map_groups__find_by_name(struct map_groups *mg,
232 				     enum map_type type, const char *name);
233 
234 void map_groups__flush(struct map_groups *mg);
235 
236 #endif /* __PERF_MAP_H */
237