xref: /openbmc/linux/tools/perf/util/map.h (revision 6774def6)
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(void);
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 static inline struct kmap *map__kmap(struct map *map)
80 {
81 	return (struct kmap *)(map + 1);
82 }
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 typedef int (*symbol_filter_t)(struct map *map, struct symbol *sym);
120 
121 void map__init(struct map *map, enum map_type type,
122 	       u64 start, u64 end, u64 pgoff, struct dso *dso);
123 struct map *map__new(struct machine *machine, u64 start, u64 len,
124 		     u64 pgoff, u32 pid, u32 d_maj, u32 d_min, u64 ino,
125 		     u64 ino_gen, u32 prot, u32 flags,
126 		     char *filename, enum map_type type, struct thread *thread);
127 struct map *map__new2(u64 start, struct dso *dso, enum map_type type);
128 void map__delete(struct map *map);
129 struct map *map__clone(struct map *map);
130 int map__overlap(struct map *l, struct map *r);
131 size_t map__fprintf(struct map *map, FILE *fp);
132 size_t map__fprintf_dsoname(struct map *map, FILE *fp);
133 int map__fprintf_srcline(struct map *map, u64 addr, const char *prefix,
134 			 FILE *fp);
135 
136 int map__load(struct map *map, symbol_filter_t filter);
137 struct symbol *map__find_symbol(struct map *map,
138 				u64 addr, symbol_filter_t filter);
139 struct symbol *map__find_symbol_by_name(struct map *map, const char *name,
140 					symbol_filter_t filter);
141 void map__fixup_start(struct map *map);
142 void map__fixup_end(struct map *map);
143 
144 void map__reloc_vmlinux(struct map *map);
145 
146 size_t __map_groups__fprintf_maps(struct map_groups *mg, enum map_type type,
147 				  FILE *fp);
148 void maps__insert(struct rb_root *maps, struct map *map);
149 void maps__remove(struct rb_root *maps, struct map *map);
150 struct map *maps__find(struct rb_root *maps, u64 addr);
151 struct map *maps__first(struct rb_root *maps);
152 struct map *maps__next(struct map *map);
153 void map_groups__init(struct map_groups *mg);
154 void map_groups__exit(struct map_groups *mg);
155 int map_groups__clone(struct map_groups *mg,
156 		      struct map_groups *parent, enum map_type type);
157 size_t map_groups__fprintf(struct map_groups *mg, FILE *fp);
158 
159 int maps__set_kallsyms_ref_reloc_sym(struct map **maps, const char *symbol_name,
160 				     u64 addr);
161 
162 static inline void map_groups__insert(struct map_groups *mg, struct map *map)
163 {
164 	maps__insert(&mg->maps[map->type], map);
165 	map->groups = mg;
166 }
167 
168 static inline void map_groups__remove(struct map_groups *mg, struct map *map)
169 {
170 	maps__remove(&mg->maps[map->type], map);
171 }
172 
173 static inline struct map *map_groups__find(struct map_groups *mg,
174 					   enum map_type type, u64 addr)
175 {
176 	return maps__find(&mg->maps[type], addr);
177 }
178 
179 static inline struct map *map_groups__first(struct map_groups *mg,
180 					    enum map_type type)
181 {
182 	return maps__first(&mg->maps[type]);
183 }
184 
185 static inline struct map *map_groups__next(struct map *map)
186 {
187 	return maps__next(map);
188 }
189 
190 struct symbol *map_groups__find_symbol(struct map_groups *mg,
191 				       enum map_type type, u64 addr,
192 				       struct map **mapp,
193 				       symbol_filter_t filter);
194 
195 struct symbol *map_groups__find_symbol_by_name(struct map_groups *mg,
196 					       enum map_type type,
197 					       const char *name,
198 					       struct map **mapp,
199 					       symbol_filter_t filter);
200 
201 struct addr_map_symbol;
202 
203 int map_groups__find_ams(struct addr_map_symbol *ams, symbol_filter_t filter);
204 
205 static inline
206 struct symbol *map_groups__find_function_by_name(struct map_groups *mg,
207 						 const char *name, struct map **mapp,
208 						 symbol_filter_t filter)
209 {
210 	return map_groups__find_symbol_by_name(mg, MAP__FUNCTION, name, mapp, filter);
211 }
212 
213 int map_groups__fixup_overlappings(struct map_groups *mg, struct map *map,
214 				   FILE *fp);
215 
216 struct map *map_groups__find_by_name(struct map_groups *mg,
217 				     enum map_type type, const char *name);
218 
219 void map_groups__flush(struct map_groups *mg);
220 
221 #endif /* __PERF_MAP_H */
222