1 /* SPDX-License-Identifier: GPL-2.0 */
2 #ifndef __PERF_MACHINE_H
3 #define __PERF_MACHINE_H
4
5 #include <sys/types.h>
6 #include <linux/rbtree.h>
7 #include "maps.h"
8 #include "dsos.h"
9 #include "rwsem.h"
10
11 struct addr_location;
12 struct branch_stack;
13 struct dso;
14 struct dso_id;
15 struct evsel;
16 struct perf_sample;
17 struct symbol;
18 struct target;
19 struct thread;
20 union perf_event;
21 struct machines;
22
23 /* Native host kernel uses -1 as pid index in machine */
24 #define HOST_KERNEL_ID (-1)
25 #define DEFAULT_GUEST_KERNEL_ID (0)
26
27 extern const char *ref_reloc_sym_names[];
28
29 struct vdso_info;
30
31 #define THREADS__TABLE_BITS 8
32 #define THREADS__TABLE_SIZE (1 << THREADS__TABLE_BITS)
33
34 struct threads {
35 struct rb_root_cached entries;
36 struct rw_semaphore lock;
37 unsigned int nr;
38 struct list_head dead;
39 struct thread *last_match;
40 };
41
42 struct machine {
43 struct rb_node rb_node;
44 pid_t pid;
45 u16 id_hdr_size;
46 bool comm_exec;
47 bool kptr_restrict_warned;
48 bool single_address_space;
49 char *root_dir;
50 char *mmap_name;
51 char *kallsyms_filename;
52 struct threads threads[THREADS__TABLE_SIZE];
53 struct vdso_info *vdso_info;
54 struct perf_env *env;
55 struct dsos dsos;
56 struct maps *kmaps;
57 struct map *vmlinux_map;
58 u64 kernel_start;
59 struct {
60 u64 text_start;
61 u64 text_end;
62 } sched, lock;
63 pid_t *current_tid;
64 size_t current_tid_sz;
65 union { /* Tool specific area */
66 void *priv;
67 u64 db_id;
68 };
69 struct machines *machines;
70 bool trampolines_mapped;
71 };
72
machine__threads(struct machine * machine,pid_t tid)73 static inline struct threads *machine__threads(struct machine *machine, pid_t tid)
74 {
75 /* Cast it to handle tid == -1 */
76 return &machine->threads[(unsigned int)tid % THREADS__TABLE_SIZE];
77 }
78
79 /*
80 * The main kernel (vmlinux) map
81 */
82 static inline
machine__kernel_map(struct machine * machine)83 struct map *machine__kernel_map(struct machine *machine)
84 {
85 return machine->vmlinux_map;
86 }
87
88 /*
89 * kernel (the one returned by machine__kernel_map()) plus kernel modules maps
90 */
91 static inline
machine__kernel_maps(struct machine * machine)92 struct maps *machine__kernel_maps(struct machine *machine)
93 {
94 return machine->kmaps;
95 }
96
97 int machine__get_kernel_start(struct machine *machine);
98
machine__kernel_start(struct machine * machine)99 static inline u64 machine__kernel_start(struct machine *machine)
100 {
101 if (!machine->kernel_start)
102 machine__get_kernel_start(machine);
103 return machine->kernel_start;
104 }
105
machine__kernel_ip(struct machine * machine,u64 ip)106 static inline bool machine__kernel_ip(struct machine *machine, u64 ip)
107 {
108 u64 kernel_start = machine__kernel_start(machine);
109
110 return ip >= kernel_start;
111 }
112
113 u8 machine__addr_cpumode(struct machine *machine, u8 cpumode, u64 addr);
114
115 struct thread *machine__find_thread(struct machine *machine, pid_t pid,
116 pid_t tid);
117 struct thread *machine__idle_thread(struct machine *machine);
118 struct comm *machine__thread_exec_comm(struct machine *machine,
119 struct thread *thread);
120
121 int machine__process_comm_event(struct machine *machine, union perf_event *event,
122 struct perf_sample *sample);
123 int machine__process_exit_event(struct machine *machine, union perf_event *event,
124 struct perf_sample *sample);
125 int machine__process_fork_event(struct machine *machine, union perf_event *event,
126 struct perf_sample *sample);
127 int machine__process_lost_event(struct machine *machine, union perf_event *event,
128 struct perf_sample *sample);
129 int machine__process_lost_samples_event(struct machine *machine, union perf_event *event,
130 struct perf_sample *sample);
131 int machine__process_aux_event(struct machine *machine,
132 union perf_event *event);
133 int machine__process_itrace_start_event(struct machine *machine,
134 union perf_event *event);
135 int machine__process_aux_output_hw_id_event(struct machine *machine,
136 union perf_event *event);
137 int machine__process_switch_event(struct machine *machine,
138 union perf_event *event);
139 int machine__process_namespaces_event(struct machine *machine,
140 union perf_event *event,
141 struct perf_sample *sample);
142 int machine__process_cgroup_event(struct machine *machine,
143 union perf_event *event,
144 struct perf_sample *sample);
145 int machine__process_mmap_event(struct machine *machine, union perf_event *event,
146 struct perf_sample *sample);
147 int machine__process_mmap2_event(struct machine *machine, union perf_event *event,
148 struct perf_sample *sample);
149 int machine__process_ksymbol(struct machine *machine,
150 union perf_event *event,
151 struct perf_sample *sample);
152 int machine__process_text_poke(struct machine *machine,
153 union perf_event *event,
154 struct perf_sample *sample);
155 int machine__process_event(struct machine *machine, union perf_event *event,
156 struct perf_sample *sample);
157
158 typedef void (*machine__process_t)(struct machine *machine, void *data);
159
160 struct machines {
161 struct machine host;
162 struct rb_root_cached guests;
163 };
164
165 void machines__init(struct machines *machines);
166 void machines__exit(struct machines *machines);
167
168 void machines__process_guests(struct machines *machines,
169 machine__process_t process, void *data);
170
171 struct machine *machines__add(struct machines *machines, pid_t pid,
172 const char *root_dir);
173 struct machine *machines__find(struct machines *machines, pid_t pid);
174 struct machine *machines__findnew(struct machines *machines, pid_t pid);
175 struct machine *machines__find_guest(struct machines *machines, pid_t pid);
176 struct thread *machines__findnew_guest_code(struct machines *machines, pid_t pid);
177 struct thread *machine__findnew_guest_code(struct machine *machine, pid_t pid);
178
179 void machines__set_id_hdr_size(struct machines *machines, u16 id_hdr_size);
180 void machines__set_comm_exec(struct machines *machines, bool comm_exec);
181
182 struct machine *machine__new_host(void);
183 struct machine *machine__new_kallsyms(void);
184 int machine__init(struct machine *machine, const char *root_dir, pid_t pid);
185 void machine__exit(struct machine *machine);
186 void machine__delete_threads(struct machine *machine);
187 void machine__delete(struct machine *machine);
188 void machine__remove_thread(struct machine *machine, struct thread *th);
189
190 struct branch_info *sample__resolve_bstack(struct perf_sample *sample,
191 struct addr_location *al);
192 struct mem_info *sample__resolve_mem(struct perf_sample *sample,
193 struct addr_location *al);
194
195 struct callchain_cursor;
196
197 int thread__resolve_callchain(struct thread *thread,
198 struct callchain_cursor *cursor,
199 struct evsel *evsel,
200 struct perf_sample *sample,
201 struct symbol **parent,
202 struct addr_location *root_al,
203 int max_stack);
204
205 /*
206 * Default guest kernel is defined by parameter --guestkallsyms
207 * and --guestmodules
208 */
machine__is_default_guest(struct machine * machine)209 static inline bool machine__is_default_guest(struct machine *machine)
210 {
211 return machine ? machine->pid == DEFAULT_GUEST_KERNEL_ID : false;
212 }
213
machine__is_host(struct machine * machine)214 static inline bool machine__is_host(struct machine *machine)
215 {
216 return machine ? machine->pid == HOST_KERNEL_ID : false;
217 }
218
219 bool machine__is_lock_function(struct machine *machine, u64 addr);
220 bool machine__is(struct machine *machine, const char *arch);
221 bool machine__normalized_is(struct machine *machine, const char *arch);
222 int machine__nr_cpus_avail(struct machine *machine);
223
224 struct thread *__machine__findnew_thread(struct machine *machine, pid_t pid, pid_t tid);
225 struct thread *machine__findnew_thread(struct machine *machine, pid_t pid, pid_t tid);
226
227 struct dso *machine__findnew_dso_id(struct machine *machine, const char *filename, struct dso_id *id);
228 struct dso *machine__findnew_dso(struct machine *machine, const char *filename);
229
230 size_t machine__fprintf(struct machine *machine, FILE *fp);
231
232 static inline
machine__find_kernel_symbol(struct machine * machine,u64 addr,struct map ** mapp)233 struct symbol *machine__find_kernel_symbol(struct machine *machine, u64 addr,
234 struct map **mapp)
235 {
236 return maps__find_symbol(machine->kmaps, addr, mapp);
237 }
238
239 static inline
machine__find_kernel_symbol_by_name(struct machine * machine,const char * name,struct map ** mapp)240 struct symbol *machine__find_kernel_symbol_by_name(struct machine *machine,
241 const char *name,
242 struct map **mapp)
243 {
244 return maps__find_symbol_by_name(machine->kmaps, name, mapp);
245 }
246
247 int arch__fix_module_text_start(u64 *start, u64 *size, const char *name);
248
249 int machine__load_kallsyms(struct machine *machine, const char *filename);
250
251 int machine__load_vmlinux_path(struct machine *machine);
252
253 size_t machine__fprintf_dsos_buildid(struct machine *machine, FILE *fp,
254 bool (skip)(struct dso *dso, int parm), int parm);
255 size_t machines__fprintf_dsos(struct machines *machines, FILE *fp);
256 size_t machines__fprintf_dsos_buildid(struct machines *machines, FILE *fp,
257 bool (skip)(struct dso *dso, int parm), int parm);
258
259 void machine__destroy_kernel_maps(struct machine *machine);
260 int machine__create_kernel_maps(struct machine *machine);
261
262 int machines__create_kernel_maps(struct machines *machines, pid_t pid);
263 int machines__create_guest_kernel_maps(struct machines *machines);
264 void machines__destroy_kernel_maps(struct machines *machines);
265
266 size_t machine__fprintf_vmlinux_path(struct machine *machine, FILE *fp);
267
268 typedef int (*machine__dso_t)(struct dso *dso, struct machine *machine, void *priv);
269
270 int machine__for_each_dso(struct machine *machine, machine__dso_t fn,
271 void *priv);
272
273 typedef int (*machine__map_t)(struct map *map, void *priv);
274 int machine__for_each_kernel_map(struct machine *machine, machine__map_t fn,
275 void *priv);
276
277 int machine__for_each_thread(struct machine *machine,
278 int (*fn)(struct thread *thread, void *p),
279 void *priv);
280 int machines__for_each_thread(struct machines *machines,
281 int (*fn)(struct thread *thread, void *p),
282 void *priv);
283
284 pid_t machine__get_current_tid(struct machine *machine, int cpu);
285 int machine__set_current_tid(struct machine *machine, int cpu, pid_t pid,
286 pid_t tid);
287 /*
288 * For use with libtraceevent's tep_set_function_resolver()
289 */
290 char *machine__resolve_kernel_addr(void *vmachine, unsigned long long *addrp, char **modp);
291
292 void machine__get_kallsyms_filename(struct machine *machine, char *buf,
293 size_t bufsz);
294
295 int machine__create_extra_kernel_maps(struct machine *machine,
296 struct dso *kernel);
297
298 /* Kernel-space maps for symbols that are outside the main kernel map and module maps */
299 struct extra_kernel_map {
300 u64 start;
301 u64 end;
302 u64 pgoff;
303 char name[KMAP_NAME_LEN];
304 };
305
306 int machine__create_extra_kernel_map(struct machine *machine,
307 struct dso *kernel,
308 struct extra_kernel_map *xm);
309
310 int machine__map_x86_64_entry_trampolines(struct machine *machine,
311 struct dso *kernel);
312
313 int machine__resolve(struct machine *machine, struct addr_location *al,
314 struct perf_sample *sample);
315
316 #endif /* __PERF_MACHINE_H */
317