xref: /linux/tools/perf/util/map.h (revision 4d7696f1b05f4aeb586c74868fe3da2731daca4b)
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 
40 	/* ip -> dso rip */
41 	u64			(*map_ip)(struct map *, u64);
42 	/* dso rip -> ip */
43 	u64			(*unmap_ip)(struct map *, u64);
44 
45 	struct dso		*dso;
46 	struct map_groups	*groups;
47 };
48 
49 struct kmap {
50 	struct ref_reloc_sym	*ref_reloc_sym;
51 	struct map_groups	*kmaps;
52 };
53 
54 struct map_groups {
55 	struct rb_root	 maps[MAP__NR_TYPES];
56 	struct list_head removed_maps[MAP__NR_TYPES];
57 	struct machine	 *machine;
58 };
59 
60 static inline struct kmap *map__kmap(struct map *map)
61 {
62 	return (struct kmap *)(map + 1);
63 }
64 
65 static inline u64 map__map_ip(struct map *map, u64 ip)
66 {
67 	return ip - map->start + map->pgoff;
68 }
69 
70 static inline u64 map__unmap_ip(struct map *map, u64 ip)
71 {
72 	return ip + map->start - map->pgoff;
73 }
74 
75 static inline u64 identity__map_ip(struct map *map __maybe_unused, u64 ip)
76 {
77 	return ip;
78 }
79 
80 
81 /* rip/ip <-> addr suitable for passing to `objdump --start-address=` */
82 u64 map__rip_2objdump(struct map *map, u64 rip);
83 
84 struct symbol;
85 
86 typedef int (*symbol_filter_t)(struct map *map, struct symbol *sym);
87 
88 void map__init(struct map *map, enum map_type type,
89 	       u64 start, u64 end, u64 pgoff, struct dso *dso);
90 struct map *map__new(struct list_head *dsos__list, u64 start, u64 len,
91 		     u64 pgoff, u32 pid, char *filename,
92 		     enum map_type type);
93 struct map *map__new2(u64 start, struct dso *dso, enum map_type type);
94 void map__delete(struct map *map);
95 struct map *map__clone(struct map *map);
96 int map__overlap(struct map *l, struct map *r);
97 size_t map__fprintf(struct map *map, FILE *fp);
98 size_t map__fprintf_dsoname(struct map *map, FILE *fp);
99 
100 int map__load(struct map *map, symbol_filter_t filter);
101 struct symbol *map__find_symbol(struct map *map,
102 				u64 addr, symbol_filter_t filter);
103 struct symbol *map__find_symbol_by_name(struct map *map, const char *name,
104 					symbol_filter_t filter);
105 void map__fixup_start(struct map *map);
106 void map__fixup_end(struct map *map);
107 
108 void map__reloc_vmlinux(struct map *map);
109 
110 size_t __map_groups__fprintf_maps(struct map_groups *mg,
111 				  enum map_type type, int verbose, FILE *fp);
112 void maps__insert(struct rb_root *maps, struct map *map);
113 void maps__remove(struct rb_root *maps, struct map *map);
114 struct map *maps__find(struct rb_root *maps, u64 addr);
115 struct map *maps__first(struct rb_root *maps);
116 struct map *maps__next(struct map *map);
117 void map_groups__init(struct map_groups *mg);
118 void map_groups__exit(struct map_groups *mg);
119 int map_groups__clone(struct map_groups *mg,
120 		      struct map_groups *parent, enum map_type type);
121 size_t map_groups__fprintf(struct map_groups *mg, int verbose, FILE *fp);
122 size_t map_groups__fprintf_maps(struct map_groups *mg, int verbose, FILE *fp);
123 
124 int maps__set_kallsyms_ref_reloc_sym(struct map **maps, const char *symbol_name,
125 				     u64 addr);
126 
127 static inline void map_groups__insert(struct map_groups *mg, struct map *map)
128 {
129 	maps__insert(&mg->maps[map->type], map);
130 	map->groups = mg;
131 }
132 
133 static inline void map_groups__remove(struct map_groups *mg, struct map *map)
134 {
135 	maps__remove(&mg->maps[map->type], map);
136 }
137 
138 static inline struct map *map_groups__find(struct map_groups *mg,
139 					   enum map_type type, u64 addr)
140 {
141 	return maps__find(&mg->maps[type], addr);
142 }
143 
144 static inline struct map *map_groups__first(struct map_groups *mg,
145 					    enum map_type type)
146 {
147 	return maps__first(&mg->maps[type]);
148 }
149 
150 static inline struct map *map_groups__next(struct map *map)
151 {
152 	return maps__next(map);
153 }
154 
155 struct symbol *map_groups__find_symbol(struct map_groups *mg,
156 				       enum map_type type, u64 addr,
157 				       struct map **mapp,
158 				       symbol_filter_t filter);
159 
160 struct symbol *map_groups__find_symbol_by_name(struct map_groups *mg,
161 					       enum map_type type,
162 					       const char *name,
163 					       struct map **mapp,
164 					       symbol_filter_t filter);
165 
166 static inline
167 struct symbol *map_groups__find_function_by_name(struct map_groups *mg,
168 						 const char *name, struct map **mapp,
169 						 symbol_filter_t filter)
170 {
171 	return map_groups__find_symbol_by_name(mg, MAP__FUNCTION, name, mapp, filter);
172 }
173 
174 int map_groups__fixup_overlappings(struct map_groups *mg, struct map *map,
175 				   int verbose, FILE *fp);
176 
177 struct map *map_groups__find_by_name(struct map_groups *mg,
178 				     enum map_type type, const char *name);
179 
180 void map_groups__flush(struct map_groups *mg);
181 
182 #endif /* __PERF_MAP_H */
183