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