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