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
11enum map_type {
12	MAP__FUNCTION = 0,
13	MAP__VARIABLE,
14};
15
16#define MAP__NR_TYPES (MAP__VARIABLE + 1)
17
18extern const char *map_type__name[MAP__NR_TYPES];
19
20struct dso;
21struct ip_callchain;
22struct ref_reloc_sym;
23struct map_groups;
24struct machine;
25struct perf_evsel;
26
27struct 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
55struct kmap {
56	struct ref_reloc_sym	*ref_reloc_sym;
57	struct map_groups	*kmaps;
58};
59
60struct 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
67struct map_groups *map_groups__new(struct machine *machine);
68void map_groups__delete(struct map_groups *mg);
69bool map_groups__empty(struct map_groups *mg);
70
71static inline struct map_groups *map_groups__get(struct map_groups *mg)
72{
73	++mg->refcnt;
74	return mg;
75}
76
77void map_groups__put(struct map_groups *mg);
78
79struct kmap *map__kmap(struct map *map);
80struct map_groups *map__kmaps(struct map *map);
81
82static inline u64 map__map_ip(struct map *map, u64 ip)
83{
84	return ip - map->start + map->pgoff;
85}
86
87static inline u64 map__unmap_ip(struct map *map, u64 ip)
88{
89	return ip + map->start - map->pgoff;
90}
91
92static 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=` */
99u64 map__rip_2objdump(struct map *map, u64 rip);
100
101/* objdump address -> memory address */
102u64 map__objdump_2mem(struct map *map, u64 ip);
103
104struct symbol;
105struct 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 && strcmp(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
133typedef int (*symbol_filter_t)(struct map *map, struct symbol *sym);
134
135void map__init(struct map *map, enum map_type type,
136	       u64 start, u64 end, u64 pgoff, struct dso *dso);
137struct map *map__new(struct machine *machine, u64 start, u64 len,
138		     u64 pgoff, u32 pid, u32 d_maj, u32 d_min, u64 ino,
139		     u64 ino_gen, u32 prot, u32 flags,
140		     char *filename, enum map_type type, struct thread *thread);
141struct map *map__new2(u64 start, struct dso *dso, enum map_type type);
142void map__delete(struct map *map);
143struct map *map__clone(struct map *map);
144int map__overlap(struct map *l, struct map *r);
145size_t map__fprintf(struct map *map, FILE *fp);
146size_t map__fprintf_dsoname(struct map *map, FILE *fp);
147int map__fprintf_srcline(struct map *map, u64 addr, const char *prefix,
148			 FILE *fp);
149
150int map__load(struct map *map, symbol_filter_t filter);
151struct symbol *map__find_symbol(struct map *map,
152				u64 addr, symbol_filter_t filter);
153struct symbol *map__find_symbol_by_name(struct map *map, const char *name,
154					symbol_filter_t filter);
155void map__fixup_start(struct map *map);
156void map__fixup_end(struct map *map);
157
158void map__reloc_vmlinux(struct map *map);
159
160size_t __map_groups__fprintf_maps(struct map_groups *mg, enum map_type type,
161				  FILE *fp);
162void maps__insert(struct rb_root *maps, struct map *map);
163void maps__remove(struct rb_root *maps, struct map *map);
164struct map *maps__find(struct rb_root *maps, u64 addr);
165struct map *maps__first(struct rb_root *maps);
166struct map *maps__next(struct map *map);
167void map_groups__init(struct map_groups *mg, struct machine *machine);
168void map_groups__exit(struct map_groups *mg);
169int map_groups__clone(struct map_groups *mg,
170		      struct map_groups *parent, enum map_type type);
171size_t map_groups__fprintf(struct map_groups *mg, FILE *fp);
172
173int maps__set_kallsyms_ref_reloc_sym(struct map **maps, const char *symbol_name,
174				     u64 addr);
175
176static inline void map_groups__insert(struct map_groups *mg, struct map *map)
177{
178	maps__insert(&mg->maps[map->type], map);
179	map->groups = mg;
180}
181
182static inline void map_groups__remove(struct map_groups *mg, struct map *map)
183{
184	maps__remove(&mg->maps[map->type], map);
185}
186
187static inline struct map *map_groups__find(struct map_groups *mg,
188					   enum map_type type, u64 addr)
189{
190	return maps__find(&mg->maps[type], addr);
191}
192
193static inline struct map *map_groups__first(struct map_groups *mg,
194					    enum map_type type)
195{
196	return maps__first(&mg->maps[type]);
197}
198
199static inline struct map *map_groups__next(struct map *map)
200{
201	return maps__next(map);
202}
203
204struct symbol *map_groups__find_symbol(struct map_groups *mg,
205				       enum map_type type, u64 addr,
206				       struct map **mapp,
207				       symbol_filter_t filter);
208
209struct symbol *map_groups__find_symbol_by_name(struct map_groups *mg,
210					       enum map_type type,
211					       const char *name,
212					       struct map **mapp,
213					       symbol_filter_t filter);
214
215struct addr_map_symbol;
216
217int map_groups__find_ams(struct addr_map_symbol *ams, symbol_filter_t filter);
218
219static inline
220struct symbol *map_groups__find_function_by_name(struct map_groups *mg,
221						 const char *name, struct map **mapp,
222						 symbol_filter_t filter)
223{
224	return map_groups__find_symbol_by_name(mg, MAP__FUNCTION, name, mapp, filter);
225}
226
227int map_groups__fixup_overlappings(struct map_groups *mg, struct map *map,
228				   FILE *fp);
229
230struct map *map_groups__find_by_name(struct map_groups *mg,
231				     enum map_type type, const char *name);
232
233void map_groups__flush(struct map_groups *mg);
234
235#endif /* __PERF_MAP_H */
236