xref: /openbmc/linux/tools/perf/util/map.h (revision afc98d90)
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 typedef int (*symbol_filter_t)(struct map *map, struct symbol *sym);
94 
95 void map__init(struct map *map, enum map_type type,
96 	       u64 start, u64 end, u64 pgoff, struct dso *dso);
97 struct map *map__new(struct list_head *dsos__list, u64 start, u64 len,
98 		     u64 pgoff, u32 pid, u32 d_maj, u32 d_min, u64 ino,
99 		     u64 ino_gen,
100 		     char *filename, enum map_type type);
101 struct map *map__new2(u64 start, struct dso *dso, enum map_type type);
102 void map__delete(struct map *map);
103 struct map *map__clone(struct map *map);
104 int map__overlap(struct map *l, struct map *r);
105 size_t map__fprintf(struct map *map, FILE *fp);
106 size_t map__fprintf_dsoname(struct map *map, FILE *fp);
107 int map__fprintf_srcline(struct map *map, u64 addr, const char *prefix,
108 			 FILE *fp);
109 
110 int map__load(struct map *map, symbol_filter_t filter);
111 struct symbol *map__find_symbol(struct map *map,
112 				u64 addr, symbol_filter_t filter);
113 struct symbol *map__find_symbol_by_name(struct map *map, const char *name,
114 					symbol_filter_t filter);
115 void map__fixup_start(struct map *map);
116 void map__fixup_end(struct map *map);
117 
118 void map__reloc_vmlinux(struct map *map);
119 
120 size_t __map_groups__fprintf_maps(struct map_groups *mg,
121 				  enum map_type type, int verbose, FILE *fp);
122 void maps__insert(struct rb_root *maps, struct map *map);
123 void maps__remove(struct rb_root *maps, struct map *map);
124 struct map *maps__find(struct rb_root *maps, u64 addr);
125 struct map *maps__first(struct rb_root *maps);
126 struct map *maps__next(struct map *map);
127 void map_groups__init(struct map_groups *mg);
128 void map_groups__exit(struct map_groups *mg);
129 int map_groups__clone(struct map_groups *mg,
130 		      struct map_groups *parent, enum map_type type);
131 size_t map_groups__fprintf(struct map_groups *mg, int verbose, FILE *fp);
132 size_t map_groups__fprintf_maps(struct map_groups *mg, int verbose, FILE *fp);
133 
134 int maps__set_kallsyms_ref_reloc_sym(struct map **maps, const char *symbol_name,
135 				     u64 addr);
136 
137 static inline void map_groups__insert(struct map_groups *mg, struct map *map)
138 {
139 	maps__insert(&mg->maps[map->type], map);
140 	map->groups = mg;
141 }
142 
143 static inline void map_groups__remove(struct map_groups *mg, struct map *map)
144 {
145 	maps__remove(&mg->maps[map->type], map);
146 }
147 
148 static inline struct map *map_groups__find(struct map_groups *mg,
149 					   enum map_type type, u64 addr)
150 {
151 	return maps__find(&mg->maps[type], addr);
152 }
153 
154 static inline struct map *map_groups__first(struct map_groups *mg,
155 					    enum map_type type)
156 {
157 	return maps__first(&mg->maps[type]);
158 }
159 
160 static inline struct map *map_groups__next(struct map *map)
161 {
162 	return maps__next(map);
163 }
164 
165 struct symbol *map_groups__find_symbol(struct map_groups *mg,
166 				       enum map_type type, u64 addr,
167 				       struct map **mapp,
168 				       symbol_filter_t filter);
169 
170 struct symbol *map_groups__find_symbol_by_name(struct map_groups *mg,
171 					       enum map_type type,
172 					       const char *name,
173 					       struct map **mapp,
174 					       symbol_filter_t filter);
175 
176 struct addr_map_symbol;
177 
178 int map_groups__find_ams(struct addr_map_symbol *ams, symbol_filter_t filter);
179 
180 static inline
181 struct symbol *map_groups__find_function_by_name(struct map_groups *mg,
182 						 const char *name, struct map **mapp,
183 						 symbol_filter_t filter)
184 {
185 	return map_groups__find_symbol_by_name(mg, MAP__FUNCTION, name, mapp, filter);
186 }
187 
188 int map_groups__fixup_overlappings(struct map_groups *mg, struct map *map,
189 				   int verbose, FILE *fp);
190 
191 struct map *map_groups__find_by_name(struct map_groups *mg,
192 				     enum map_type type, const char *name);
193 
194 void map_groups__flush(struct map_groups *mg);
195 
196 #endif /* __PERF_MAP_H */
197