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