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