xref: /openbmc/linux/tools/perf/util/machine.h (revision ecd25094)
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_groups.h"
8 #include "dsos.h"
9 #include "event.h"
10 #include "rwsem.h"
11 
12 struct addr_location;
13 struct branch_stack;
14 struct dso;
15 struct evsel;
16 struct perf_sample;
17 struct symbol;
18 struct target;
19 struct thread;
20 union 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 
26 extern const char *ref_reloc_sym_names[];
27 
28 struct vdso_info;
29 
30 #define THREADS__TABLE_BITS	8
31 #define THREADS__TABLE_SIZE	(1 << THREADS__TABLE_BITS)
32 
33 struct 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 
41 struct 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 map_groups 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 
65 static 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  */
74 static inline
75 struct 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  */
83 static inline
84 struct maps *machine__kernel_maps(struct machine *machine)
85 {
86 	return &machine->kmaps.maps;
87 }
88 
89 int machine__get_kernel_start(struct machine *machine);
90 
91 static 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 
98 static 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 
105 u8 machine__addr_cpumode(struct machine *machine, u8 cpumode, u64 addr);
106 
107 struct thread *machine__find_thread(struct machine *machine, pid_t pid,
108 				    pid_t tid);
109 struct comm *machine__thread_exec_comm(struct machine *machine,
110 				       struct thread *thread);
111 
112 int machine__process_comm_event(struct machine *machine, union perf_event *event,
113 				struct perf_sample *sample);
114 int machine__process_exit_event(struct machine *machine, union perf_event *event,
115 				struct perf_sample *sample);
116 int machine__process_fork_event(struct machine *machine, union perf_event *event,
117 				struct perf_sample *sample);
118 int machine__process_lost_event(struct machine *machine, union perf_event *event,
119 				struct perf_sample *sample);
120 int machine__process_lost_samples_event(struct machine *machine, union perf_event *event,
121 					struct perf_sample *sample);
122 int machine__process_aux_event(struct machine *machine,
123 			       union perf_event *event);
124 int machine__process_itrace_start_event(struct machine *machine,
125 					union perf_event *event);
126 int machine__process_switch_event(struct machine *machine,
127 				  union perf_event *event);
128 int machine__process_namespaces_event(struct machine *machine,
129 				      union perf_event *event,
130 				      struct perf_sample *sample);
131 int machine__process_mmap_event(struct machine *machine, union perf_event *event,
132 				struct perf_sample *sample);
133 int machine__process_mmap2_event(struct machine *machine, union perf_event *event,
134 				 struct perf_sample *sample);
135 int machine__process_ksymbol(struct machine *machine,
136 			     union perf_event *event,
137 			     struct perf_sample *sample);
138 int machine__process_event(struct machine *machine, union perf_event *event,
139 				struct perf_sample *sample);
140 
141 typedef void (*machine__process_t)(struct machine *machine, void *data);
142 
143 struct machines {
144 	struct machine host;
145 	struct rb_root_cached guests;
146 };
147 
148 void machines__init(struct machines *machines);
149 void machines__exit(struct machines *machines);
150 
151 void machines__process_guests(struct machines *machines,
152 			      machine__process_t process, void *data);
153 
154 struct machine *machines__add(struct machines *machines, pid_t pid,
155 			      const char *root_dir);
156 struct machine *machines__find_host(struct machines *machines);
157 struct machine *machines__find(struct machines *machines, pid_t pid);
158 struct machine *machines__findnew(struct machines *machines, pid_t pid);
159 
160 void machines__set_id_hdr_size(struct machines *machines, u16 id_hdr_size);
161 void machines__set_comm_exec(struct machines *machines, bool comm_exec);
162 
163 struct machine *machine__new_host(void);
164 struct machine *machine__new_kallsyms(void);
165 int machine__init(struct machine *machine, const char *root_dir, pid_t pid);
166 void machine__exit(struct machine *machine);
167 void machine__delete_threads(struct machine *machine);
168 void machine__delete(struct machine *machine);
169 void machine__remove_thread(struct machine *machine, struct thread *th);
170 
171 struct branch_info *sample__resolve_bstack(struct perf_sample *sample,
172 					   struct addr_location *al);
173 struct mem_info *sample__resolve_mem(struct perf_sample *sample,
174 				     struct addr_location *al);
175 
176 struct callchain_cursor;
177 
178 int thread__resolve_callchain(struct thread *thread,
179 			      struct callchain_cursor *cursor,
180 			      struct evsel *evsel,
181 			      struct perf_sample *sample,
182 			      struct symbol **parent,
183 			      struct addr_location *root_al,
184 			      int max_stack);
185 
186 /*
187  * Default guest kernel is defined by parameter --guestkallsyms
188  * and --guestmodules
189  */
190 static inline bool machine__is_default_guest(struct machine *machine)
191 {
192 	return machine ? machine->pid == DEFAULT_GUEST_KERNEL_ID : false;
193 }
194 
195 static inline bool machine__is_host(struct machine *machine)
196 {
197 	return machine ? machine->pid == HOST_KERNEL_ID : false;
198 }
199 
200 bool machine__is(struct machine *machine, const char *arch);
201 int machine__nr_cpus_avail(struct machine *machine);
202 
203 struct thread *__machine__findnew_thread(struct machine *machine, pid_t pid, pid_t tid);
204 struct thread *machine__findnew_thread(struct machine *machine, pid_t pid, pid_t tid);
205 
206 struct dso *machine__findnew_dso(struct machine *machine, const char *filename);
207 
208 size_t machine__fprintf(struct machine *machine, FILE *fp);
209 
210 static inline
211 struct symbol *machine__find_kernel_symbol(struct machine *machine, u64 addr,
212 					   struct map **mapp)
213 {
214 	return map_groups__find_symbol(&machine->kmaps, addr, mapp);
215 }
216 
217 static inline
218 struct symbol *machine__find_kernel_symbol_by_name(struct machine *machine,
219 						   const char *name,
220 						   struct map **mapp)
221 {
222 	return map_groups__find_symbol_by_name(&machine->kmaps, name, mapp);
223 }
224 
225 struct map *machine__findnew_module_map(struct machine *machine, u64 start,
226 					const char *filename);
227 int arch__fix_module_text_start(u64 *start, u64 *size, const char *name);
228 
229 int machine__load_kallsyms(struct machine *machine, const char *filename);
230 
231 int machine__load_vmlinux_path(struct machine *machine);
232 
233 size_t machine__fprintf_dsos_buildid(struct machine *machine, FILE *fp,
234 				     bool (skip)(struct dso *dso, int parm), int parm);
235 size_t machines__fprintf_dsos(struct machines *machines, FILE *fp);
236 size_t machines__fprintf_dsos_buildid(struct machines *machines, FILE *fp,
237 				     bool (skip)(struct dso *dso, int parm), int parm);
238 
239 void machine__destroy_kernel_maps(struct machine *machine);
240 int machine__create_kernel_maps(struct machine *machine);
241 
242 int machines__create_kernel_maps(struct machines *machines, pid_t pid);
243 int machines__create_guest_kernel_maps(struct machines *machines);
244 void machines__destroy_kernel_maps(struct machines *machines);
245 
246 size_t machine__fprintf_vmlinux_path(struct machine *machine, FILE *fp);
247 
248 int machine__for_each_thread(struct machine *machine,
249 			     int (*fn)(struct thread *thread, void *p),
250 			     void *priv);
251 int machines__for_each_thread(struct machines *machines,
252 			      int (*fn)(struct thread *thread, void *p),
253 			      void *priv);
254 
255 int __machine__synthesize_threads(struct machine *machine, struct perf_tool *tool,
256 				  struct target *target, struct perf_thread_map *threads,
257 				  perf_event__handler_t process, bool data_mmap,
258 				  unsigned int nr_threads_synthesize);
259 static inline
260 int machine__synthesize_threads(struct machine *machine, struct target *target,
261 				struct perf_thread_map *threads, bool data_mmap,
262 				unsigned int nr_threads_synthesize)
263 {
264 	return __machine__synthesize_threads(machine, NULL, target, threads,
265 					     perf_event__process, data_mmap,
266 					     nr_threads_synthesize);
267 }
268 
269 pid_t machine__get_current_tid(struct machine *machine, int cpu);
270 int machine__set_current_tid(struct machine *machine, int cpu, pid_t pid,
271 			     pid_t tid);
272 /*
273  * For use with libtraceevent's tep_set_function_resolver()
274  */
275 char *machine__resolve_kernel_addr(void *vmachine, unsigned long long *addrp, char **modp);
276 
277 void machine__get_kallsyms_filename(struct machine *machine, char *buf,
278 				    size_t bufsz);
279 
280 int machine__create_extra_kernel_maps(struct machine *machine,
281 				      struct dso *kernel);
282 
283 /* Kernel-space maps for symbols that are outside the main kernel map and module maps */
284 struct extra_kernel_map {
285 	u64 start;
286 	u64 end;
287 	u64 pgoff;
288 	char name[KMAP_NAME_LEN];
289 };
290 
291 int machine__create_extra_kernel_map(struct machine *machine,
292 				     struct dso *kernel,
293 				     struct extra_kernel_map *xm);
294 
295 int machine__map_x86_64_entry_trampolines(struct machine *machine,
296 					  struct dso *kernel);
297 
298 #endif /* __PERF_MACHINE_H */
299