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