xref: /openbmc/linux/tools/perf/util/machine.h (revision 82e6fdd6)
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 	char		  *root_dir;
46 	char		  *mmap_name;
47 	struct threads    threads[THREADS__TABLE_SIZE];
48 	struct vdso_info  *vdso_info;
49 	struct perf_env   *env;
50 	struct dsos	  dsos;
51 	struct map_groups kmaps;
52 	struct map	  *vmlinux_maps[MAP__NR_TYPES];
53 	u64		  kernel_start;
54 	pid_t		  *current_tid;
55 	union { /* Tool specific area */
56 		void	  *priv;
57 		u64	  db_id;
58 	};
59 };
60 
61 static inline struct threads *machine__threads(struct machine *machine, pid_t tid)
62 {
63 	/* Cast it to handle tid == -1 */
64 	return &machine->threads[(unsigned int)tid % THREADS__TABLE_SIZE];
65 }
66 
67 static inline
68 struct map *__machine__kernel_map(struct machine *machine, enum map_type type)
69 {
70 	return machine->vmlinux_maps[type];
71 }
72 
73 static inline
74 struct map *machine__kernel_map(struct machine *machine)
75 {
76 	return __machine__kernel_map(machine, MAP__FUNCTION);
77 }
78 
79 int machine__get_kernel_start(struct machine *machine);
80 
81 static inline u64 machine__kernel_start(struct machine *machine)
82 {
83 	if (!machine->kernel_start)
84 		machine__get_kernel_start(machine);
85 	return machine->kernel_start;
86 }
87 
88 static inline bool machine__kernel_ip(struct machine *machine, u64 ip)
89 {
90 	u64 kernel_start = machine__kernel_start(machine);
91 
92 	return ip >= kernel_start;
93 }
94 
95 struct thread *machine__find_thread(struct machine *machine, pid_t pid,
96 				    pid_t tid);
97 struct comm *machine__thread_exec_comm(struct machine *machine,
98 				       struct thread *thread);
99 
100 int machine__process_comm_event(struct machine *machine, union perf_event *event,
101 				struct perf_sample *sample);
102 int machine__process_exit_event(struct machine *machine, union perf_event *event,
103 				struct perf_sample *sample);
104 int machine__process_fork_event(struct machine *machine, union perf_event *event,
105 				struct perf_sample *sample);
106 int machine__process_lost_event(struct machine *machine, union perf_event *event,
107 				struct perf_sample *sample);
108 int machine__process_lost_samples_event(struct machine *machine, union perf_event *event,
109 					struct perf_sample *sample);
110 int machine__process_aux_event(struct machine *machine,
111 			       union perf_event *event);
112 int machine__process_itrace_start_event(struct machine *machine,
113 					union perf_event *event);
114 int machine__process_switch_event(struct machine *machine,
115 				  union perf_event *event);
116 int machine__process_namespaces_event(struct machine *machine,
117 				      union perf_event *event,
118 				      struct perf_sample *sample);
119 int machine__process_mmap_event(struct machine *machine, union perf_event *event,
120 				struct perf_sample *sample);
121 int machine__process_mmap2_event(struct machine *machine, union perf_event *event,
122 				 struct perf_sample *sample);
123 int machine__process_event(struct machine *machine, union perf_event *event,
124 				struct perf_sample *sample);
125 
126 typedef void (*machine__process_t)(struct machine *machine, void *data);
127 
128 struct machines {
129 	struct machine host;
130 	struct rb_root guests;
131 };
132 
133 void machines__init(struct machines *machines);
134 void machines__exit(struct machines *machines);
135 
136 void machines__process_guests(struct machines *machines,
137 			      machine__process_t process, void *data);
138 
139 struct machine *machines__add(struct machines *machines, pid_t pid,
140 			      const char *root_dir);
141 struct machine *machines__find_host(struct machines *machines);
142 struct machine *machines__find(struct machines *machines, pid_t pid);
143 struct machine *machines__findnew(struct machines *machines, pid_t pid);
144 
145 void machines__set_id_hdr_size(struct machines *machines, u16 id_hdr_size);
146 void machines__set_comm_exec(struct machines *machines, bool comm_exec);
147 
148 struct machine *machine__new_host(void);
149 struct machine *machine__new_kallsyms(void);
150 int machine__init(struct machine *machine, const char *root_dir, pid_t pid);
151 void machine__exit(struct machine *machine);
152 void machine__delete_threads(struct machine *machine);
153 void machine__delete(struct machine *machine);
154 void machine__remove_thread(struct machine *machine, struct thread *th);
155 
156 struct branch_info *sample__resolve_bstack(struct perf_sample *sample,
157 					   struct addr_location *al);
158 struct mem_info *sample__resolve_mem(struct perf_sample *sample,
159 				     struct addr_location *al);
160 
161 struct callchain_cursor;
162 
163 int thread__resolve_callchain(struct thread *thread,
164 			      struct callchain_cursor *cursor,
165 			      struct perf_evsel *evsel,
166 			      struct perf_sample *sample,
167 			      struct symbol **parent,
168 			      struct addr_location *root_al,
169 			      int max_stack);
170 
171 /*
172  * Default guest kernel is defined by parameter --guestkallsyms
173  * and --guestmodules
174  */
175 static inline bool machine__is_default_guest(struct machine *machine)
176 {
177 	return machine ? machine->pid == DEFAULT_GUEST_KERNEL_ID : false;
178 }
179 
180 static inline bool machine__is_host(struct machine *machine)
181 {
182 	return machine ? machine->pid == HOST_KERNEL_ID : false;
183 }
184 
185 struct thread *__machine__findnew_thread(struct machine *machine, pid_t pid, pid_t tid);
186 struct thread *machine__findnew_thread(struct machine *machine, pid_t pid, pid_t tid);
187 
188 struct dso *machine__findnew_dso(struct machine *machine, const char *filename);
189 
190 size_t machine__fprintf(struct machine *machine, FILE *fp);
191 
192 static inline
193 struct symbol *machine__find_kernel_symbol(struct machine *machine,
194 					   enum map_type type, u64 addr,
195 					   struct map **mapp)
196 {
197 	return map_groups__find_symbol(&machine->kmaps, type, addr, mapp);
198 }
199 
200 static inline
201 struct symbol *machine__find_kernel_symbol_by_name(struct machine *machine,
202 						   enum map_type type, const char *name,
203 						   struct map **mapp)
204 {
205 	return map_groups__find_symbol_by_name(&machine->kmaps, type, name, mapp);
206 }
207 
208 static inline
209 struct symbol *machine__find_kernel_function(struct machine *machine, u64 addr,
210 					     struct map **mapp)
211 {
212 	return machine__find_kernel_symbol(machine, MAP__FUNCTION, addr,
213 					   mapp);
214 }
215 
216 static inline
217 struct symbol *machine__find_kernel_function_by_name(struct machine *machine,
218 						     const char *name,
219 						     struct map **mapp)
220 {
221 	return map_groups__find_function_by_name(&machine->kmaps, name, mapp);
222 }
223 
224 struct map *machine__findnew_module_map(struct machine *machine, u64 start,
225 					const char *filename);
226 int arch__fix_module_text_start(u64 *start, const char *name);
227 
228 int machine__load_kallsyms(struct machine *machine, const char *filename,
229 			   enum map_type type);
230 int machine__load_vmlinux_path(struct machine *machine, enum map_type type);
231 
232 size_t machine__fprintf_dsos_buildid(struct machine *machine, FILE *fp,
233 				     bool (skip)(struct dso *dso, int parm), int parm);
234 size_t machines__fprintf_dsos(struct machines *machines, FILE *fp);
235 size_t machines__fprintf_dsos_buildid(struct machines *machines, FILE *fp,
236 				     bool (skip)(struct dso *dso, int parm), int parm);
237 
238 void machine__destroy_kernel_maps(struct machine *machine);
239 int machine__create_kernel_maps(struct machine *machine);
240 
241 int machines__create_kernel_maps(struct machines *machines, pid_t pid);
242 int machines__create_guest_kernel_maps(struct machines *machines);
243 void machines__destroy_kernel_maps(struct machines *machines);
244 
245 size_t machine__fprintf_vmlinux_path(struct machine *machine, FILE *fp);
246 
247 int machine__for_each_thread(struct machine *machine,
248 			     int (*fn)(struct thread *thread, void *p),
249 			     void *priv);
250 int machines__for_each_thread(struct machines *machines,
251 			      int (*fn)(struct thread *thread, void *p),
252 			      void *priv);
253 
254 int __machine__synthesize_threads(struct machine *machine, struct perf_tool *tool,
255 				  struct target *target, struct thread_map *threads,
256 				  perf_event__handler_t process, bool data_mmap,
257 				  unsigned int proc_map_timeout,
258 				  unsigned int nr_threads_synthesize);
259 static inline
260 int machine__synthesize_threads(struct machine *machine, struct target *target,
261 				struct thread_map *threads, bool data_mmap,
262 				unsigned int proc_map_timeout,
263 				unsigned int nr_threads_synthesize)
264 {
265 	return __machine__synthesize_threads(machine, NULL, target, threads,
266 					     perf_event__process, data_mmap,
267 					     proc_map_timeout,
268 					     nr_threads_synthesize);
269 }
270 
271 pid_t machine__get_current_tid(struct machine *machine, int cpu);
272 int machine__set_current_tid(struct machine *machine, int cpu, pid_t pid,
273 			     pid_t tid);
274 /*
275  * For use with libtraceevent's pevent_set_function_resolver()
276  */
277 char *machine__resolve_kernel_addr(void *vmachine, unsigned long long *addrp, char **modp);
278 
279 #endif /* __PERF_MACHINE_H */
280