perf tools: Use __maybe_used for unused variables
[GitHub/mt8127/android_kernel_alcatel_ttab.git] / tools / perf / util / map.h
CommitLineData
4a58e611
ACM
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>
4b8cf846 7#include <stdio.h>
23346f21 8#include <stdbool.h>
4b8cf846 9#include "types.h"
4a58e611
ACM
10
11enum map_type {
12 MAP__FUNCTION = 0,
13 MAP__VARIABLE,
14};
15
16#define MAP__NR_TYPES (MAP__VARIABLE + 1)
17
3846df2e
ACM
18extern const char *map_type__name[MAP__NR_TYPES];
19
4a58e611 20struct dso;
743eb868 21struct ip_callchain;
9de89fe7
ACM
22struct ref_reloc_sym;
23struct map_groups;
23346f21 24struct machine;
743eb868 25struct perf_evsel;
4a58e611
ACM
26
27struct map {
28 union {
29 struct rb_node rb_node;
30 struct list_head node;
31 };
32 u64 start;
33 u64 end;
0a1eae39
ACM
34 u8 /* enum map_type */ type;
35 bool referenced;
31d68e7b 36 bool erange_warned;
5c0541d5 37 u32 priv;
4a58e611 38 u64 pgoff;
7a2b6209
KS
39
40 /* ip -> dso rip */
4a58e611 41 u64 (*map_ip)(struct map *, u64);
7a2b6209 42 /* dso rip -> ip */
4a58e611 43 u64 (*unmap_ip)(struct map *, u64);
7a2b6209 44
4a58e611 45 struct dso *dso;
a1645ce1 46 struct map_groups *groups;
4a58e611
ACM
47};
48
9de89fe7
ACM
49struct kmap {
50 struct ref_reloc_sym *ref_reloc_sym;
51 struct map_groups *kmaps;
52};
53
a1645ce1 54struct map_groups {
23346f21
ACM
55 struct rb_root maps[MAP__NR_TYPES];
56 struct list_head removed_maps[MAP__NR_TYPES];
57 struct machine *machine;
a1645ce1
ZY
58};
59
23346f21 60/* Native host kernel uses -1 as pid index in machine */
a1645ce1
ZY
61#define HOST_KERNEL_ID (-1)
62#define DEFAULT_GUEST_KERNEL_ID (0)
63
23346f21
ACM
64struct machine {
65 struct rb_node rb_node;
66 pid_t pid;
743eb868 67 u16 id_hdr_size;
23346f21 68 char *root_dir;
b424eba2
ACM
69 struct rb_root threads;
70 struct list_head dead_threads;
71 struct thread *last_match;
23346f21
ACM
72 struct list_head user_dsos;
73 struct list_head kernel_dsos;
a1645ce1 74 struct map_groups kmaps;
23346f21 75 struct map *vmlinux_maps[MAP__NR_TYPES];
a1645ce1
ZY
76};
77
5c0541d5
ACM
78static inline
79struct map *machine__kernel_map(struct machine *self, enum map_type type)
80{
81 return self->vmlinux_maps[type];
82}
83
9de89fe7
ACM
84static inline struct kmap *map__kmap(struct map *self)
85{
86 return (struct kmap *)(self + 1);
87}
88
4a58e611
ACM
89static inline u64 map__map_ip(struct map *map, u64 ip)
90{
91 return ip - map->start + map->pgoff;
92}
93
94static inline u64 map__unmap_ip(struct map *map, u64 ip)
95{
96 return ip + map->start - map->pgoff;
97}
98
1d037ca1 99static inline u64 identity__map_ip(struct map *map __maybe_unused, u64 ip)
4a58e611
ACM
100{
101 return ip;
102}
103
7a2b6209 104
ee11b90b 105/* rip/ip <-> addr suitable for passing to `objdump --start-address=` */
7a2b6209 106u64 map__rip_2objdump(struct map *map, u64 rip);
7a2b6209 107
4a58e611 108struct symbol;
4a58e611
ACM
109
110typedef int (*symbol_filter_t)(struct map *map, struct symbol *sym);
111
112void map__init(struct map *self, enum map_type type,
113 u64 start, u64 end, u64 pgoff, struct dso *dso);
a1645ce1
ZY
114struct map *map__new(struct list_head *dsos__list, u64 start, u64 len,
115 u64 pgoff, u32 pid, char *filename,
361d1346 116 enum map_type type);
e5a1845f 117struct map *map__new2(u64 start, struct dso *dso, enum map_type type);
4a58e611
ACM
118void map__delete(struct map *self);
119struct map *map__clone(struct map *self);
120int map__overlap(struct map *l, struct map *r);
121size_t map__fprintf(struct map *self, FILE *fp);
547a92e0 122size_t map__fprintf_dsoname(struct map *map, FILE *fp);
4a58e611 123
9de89fe7
ACM
124int map__load(struct map *self, symbol_filter_t filter);
125struct symbol *map__find_symbol(struct map *self,
4a58e611
ACM
126 u64 addr, symbol_filter_t filter);
127struct symbol *map__find_symbol_by_name(struct map *self, const char *name,
4a58e611
ACM
128 symbol_filter_t filter);
129void map__fixup_start(struct map *self);
130void map__fixup_end(struct map *self);
131
9de89fe7
ACM
132void map__reloc_vmlinux(struct map *self);
133
98dfd55d 134size_t __map_groups__fprintf_maps(struct map_groups *mg,
c6e718ff 135 enum map_type type, int verbose, FILE *fp);
4b8cf846 136void maps__insert(struct rb_root *maps, struct map *map);
98dfd55d 137void maps__remove(struct rb_root *maps, struct map *map);
4b8cf846 138struct map *maps__find(struct rb_root *maps, u64 addr);
98dfd55d
ACM
139void map_groups__init(struct map_groups *mg);
140void map_groups__exit(struct map_groups *mg);
141int map_groups__clone(struct map_groups *mg,
c6e718ff 142 struct map_groups *parent, enum map_type type);
98dfd55d
ACM
143size_t map_groups__fprintf(struct map_groups *mg, int verbose, FILE *fp);
144size_t map_groups__fprintf_maps(struct map_groups *mg, int verbose, FILE *fp);
4b8cf846 145
23346f21
ACM
146typedef void (*machine__process_t)(struct machine *self, void *data);
147
148void machines__process(struct rb_root *self, machine__process_t process, void *data);
149struct machine *machines__add(struct rb_root *self, pid_t pid,
150 const char *root_dir);
151struct machine *machines__find_host(struct rb_root *self);
152struct machine *machines__find(struct rb_root *self, pid_t pid);
153struct machine *machines__findnew(struct rb_root *self, pid_t pid);
adb5d2a4 154void machines__set_id_hdr_size(struct rb_root *self, u16 id_hdr_size);
48ea8f54 155char *machine__mmap_name(struct machine *self, char *bf, size_t size);
d28c6223 156int machine__init(struct machine *self, const char *root_dir, pid_t pid);
d65a458b 157void machine__exit(struct machine *self);
076c6e45 158void machine__delete(struct machine *self);
a1645ce1 159
71ad0f5e
JO
160struct perf_evsel;
161struct perf_sample;
743eb868 162int machine__resolve_callchain(struct machine *machine,
71ad0f5e 163 struct perf_evsel *evsel,
a9c34a9f 164 struct thread *thread,
71ad0f5e 165 struct perf_sample *sample,
743eb868
ACM
166 struct symbol **parent);
167int maps__set_kallsyms_ref_reloc_sym(struct map **maps, const char *symbol_name,
168 u64 addr);
169
a1645ce1
ZY
170/*
171 * Default guest kernel is defined by parameter --guestkallsyms
172 * and --guestmodules
173 */
23346f21 174static inline bool machine__is_default_guest(struct machine *self)
a1645ce1 175{
23346f21 176 return self ? self->pid == DEFAULT_GUEST_KERNEL_ID : false;
a1645ce1
ZY
177}
178
23346f21 179static inline bool machine__is_host(struct machine *self)
a1645ce1 180{
23346f21 181 return self ? self->pid == HOST_KERNEL_ID : false;
a1645ce1
ZY
182}
183
98dfd55d 184static inline void map_groups__insert(struct map_groups *mg, struct map *map)
4b8cf846 185{
98dfd55d
ACM
186 maps__insert(&mg->maps[map->type], map);
187 map->groups = mg;
4b8cf846
ACM
188}
189
98dfd55d 190static inline void map_groups__remove(struct map_groups *mg, struct map *map)
076c6e45 191{
98dfd55d 192 maps__remove(&mg->maps[map->type], map);
076c6e45
ACM
193}
194
98dfd55d 195static inline struct map *map_groups__find(struct map_groups *mg,
4b8cf846
ACM
196 enum map_type type, u64 addr)
197{
98dfd55d 198 return maps__find(&mg->maps[type], addr);
4b8cf846
ACM
199}
200
98dfd55d 201struct symbol *map_groups__find_symbol(struct map_groups *mg,
4b8cf846 202 enum map_type type, u64 addr,
7e5e1b14 203 struct map **mapp,
4b8cf846
ACM
204 symbol_filter_t filter);
205
98dfd55d 206struct symbol *map_groups__find_symbol_by_name(struct map_groups *mg,
7e5e1b14
ACM
207 enum map_type type,
208 const char *name,
209 struct map **mapp,
210 symbol_filter_t filter);
211
b424eba2
ACM
212
213struct thread *machine__findnew_thread(struct machine *machine, pid_t pid);
214void machine__remove_thread(struct machine *machine, struct thread *th);
215
216size_t machine__fprintf(struct machine *machine, FILE *fp);
217
5c0541d5
ACM
218static inline
219struct symbol *machine__find_kernel_symbol(struct machine *self,
220 enum map_type type, u64 addr,
221 struct map **mapp,
222 symbol_filter_t filter)
223{
224 return map_groups__find_symbol(&self->kmaps, type, addr, mapp, filter);
225}
226
227static inline
228struct symbol *machine__find_kernel_function(struct machine *self, u64 addr,
229 struct map **mapp,
230 symbol_filter_t filter)
7e5e1b14 231{
5c0541d5 232 return machine__find_kernel_symbol(self, MAP__FUNCTION, addr, mapp, filter);
7e5e1b14
ACM
233}
234
235static inline
98dfd55d 236struct symbol *map_groups__find_function_by_name(struct map_groups *mg,
7e5e1b14
ACM
237 const char *name, struct map **mapp,
238 symbol_filter_t filter)
4b8cf846 239{
98dfd55d 240 return map_groups__find_symbol_by_name(mg, MAP__FUNCTION, name, mapp, filter);
4b8cf846
ACM
241}
242
469b9b88
MH
243static inline
244struct symbol *machine__find_kernel_function_by_name(struct machine *self,
245 const char *name,
246 struct map **mapp,
247 symbol_filter_t filter)
248{
249 return map_groups__find_function_by_name(&self->kmaps, name, mapp,
250 filter);
251}
252
98dfd55d 253int map_groups__fixup_overlappings(struct map_groups *mg, struct map *map,
c6e718ff
ACM
254 int verbose, FILE *fp);
255
98dfd55d 256struct map *map_groups__find_by_name(struct map_groups *mg,
4b8cf846 257 enum map_type type, const char *name);
d28c6223 258struct map *machine__new_module(struct machine *self, u64 start, const char *filename);
a1645ce1 259
98dfd55d 260void map_groups__flush(struct map_groups *mg);
4b8cf846 261
4a58e611 262#endif /* __PERF_MAP_H */