xref: /openbmc/linux/tools/perf/util/machine.h (revision 78700c0a)
1 #ifndef __PERF_MACHINE_H
2 #define __PERF_MACHINE_H
3 
4 #include <sys/types.h>
5 #include <linux/rbtree.h>
6 #include "map.h"
7 #include "dso.h"
8 #include "event.h"
9 
10 struct addr_location;
11 struct branch_stack;
12 struct perf_evsel;
13 struct perf_sample;
14 struct symbol;
15 struct thread;
16 union perf_event;
17 
18 /* Native host kernel uses -1 as pid index in machine */
19 #define	HOST_KERNEL_ID			(-1)
20 #define	DEFAULT_GUEST_KERNEL_ID		(0)
21 
22 extern const char *ref_reloc_sym_names[];
23 
24 struct vdso_info;
25 
26 struct machine {
27 	struct rb_node	  rb_node;
28 	pid_t		  pid;
29 	u16		  id_hdr_size;
30 	bool		  comm_exec;
31 	bool		  kptr_restrict_warned;
32 	char		  *root_dir;
33 	struct rb_root	  threads;
34 	pthread_rwlock_t  threads_lock;
35 	unsigned int	  nr_threads;
36 	struct list_head  dead_threads;
37 	struct thread	  *last_match;
38 	struct vdso_info  *vdso_info;
39 	struct perf_env   *env;
40 	struct dsos	  dsos;
41 	struct map_groups kmaps;
42 	struct map	  *vmlinux_maps[MAP__NR_TYPES];
43 	u64		  kernel_start;
44 	symbol_filter_t	  symbol_filter;
45 	pid_t		  *current_tid;
46 	union { /* Tool specific area */
47 		void	  *priv;
48 		u64	  db_id;
49 	};
50 };
51 
52 static inline
53 struct map *__machine__kernel_map(struct machine *machine, enum map_type type)
54 {
55 	return machine->vmlinux_maps[type];
56 }
57 
58 static inline
59 struct map *machine__kernel_map(struct machine *machine)
60 {
61 	return __machine__kernel_map(machine, MAP__FUNCTION);
62 }
63 
64 int machine__get_kernel_start(struct machine *machine);
65 
66 static inline u64 machine__kernel_start(struct machine *machine)
67 {
68 	if (!machine->kernel_start)
69 		machine__get_kernel_start(machine);
70 	return machine->kernel_start;
71 }
72 
73 static inline bool machine__kernel_ip(struct machine *machine, u64 ip)
74 {
75 	u64 kernel_start = machine__kernel_start(machine);
76 
77 	return ip >= kernel_start;
78 }
79 
80 struct thread *machine__find_thread(struct machine *machine, pid_t pid,
81 				    pid_t tid);
82 struct comm *machine__thread_exec_comm(struct machine *machine,
83 				       struct thread *thread);
84 
85 int machine__process_comm_event(struct machine *machine, union perf_event *event,
86 				struct perf_sample *sample);
87 int machine__process_exit_event(struct machine *machine, union perf_event *event,
88 				struct perf_sample *sample);
89 int machine__process_fork_event(struct machine *machine, union perf_event *event,
90 				struct perf_sample *sample);
91 int machine__process_lost_event(struct machine *machine, union perf_event *event,
92 				struct perf_sample *sample);
93 int machine__process_lost_samples_event(struct machine *machine, union perf_event *event,
94 					struct perf_sample *sample);
95 int machine__process_aux_event(struct machine *machine,
96 			       union perf_event *event);
97 int machine__process_itrace_start_event(struct machine *machine,
98 					union perf_event *event);
99 int machine__process_switch_event(struct machine *machine,
100 				  union perf_event *event);
101 int machine__process_mmap_event(struct machine *machine, union perf_event *event,
102 				struct perf_sample *sample);
103 int machine__process_mmap2_event(struct machine *machine, union perf_event *event,
104 				 struct perf_sample *sample);
105 int machine__process_event(struct machine *machine, union perf_event *event,
106 				struct perf_sample *sample);
107 
108 typedef void (*machine__process_t)(struct machine *machine, void *data);
109 
110 struct machines {
111 	struct machine host;
112 	struct rb_root guests;
113 	symbol_filter_t symbol_filter;
114 };
115 
116 void machines__init(struct machines *machines);
117 void machines__exit(struct machines *machines);
118 
119 void machines__process_guests(struct machines *machines,
120 			      machine__process_t process, void *data);
121 
122 struct machine *machines__add(struct machines *machines, pid_t pid,
123 			      const char *root_dir);
124 struct machine *machines__find_host(struct machines *machines);
125 struct machine *machines__find(struct machines *machines, pid_t pid);
126 struct machine *machines__findnew(struct machines *machines, pid_t pid);
127 
128 void machines__set_id_hdr_size(struct machines *machines, u16 id_hdr_size);
129 char *machine__mmap_name(struct machine *machine, char *bf, size_t size);
130 
131 void machines__set_symbol_filter(struct machines *machines,
132 				 symbol_filter_t symbol_filter);
133 void machines__set_comm_exec(struct machines *machines, bool comm_exec);
134 
135 struct machine *machine__new_host(void);
136 int machine__init(struct machine *machine, const char *root_dir, pid_t pid);
137 void machine__exit(struct machine *machine);
138 void machine__delete_threads(struct machine *machine);
139 void machine__delete(struct machine *machine);
140 void machine__remove_thread(struct machine *machine, struct thread *th);
141 
142 struct branch_info *sample__resolve_bstack(struct perf_sample *sample,
143 					   struct addr_location *al);
144 struct mem_info *sample__resolve_mem(struct perf_sample *sample,
145 				     struct addr_location *al);
146 
147 struct callchain_cursor;
148 
149 int thread__resolve_callchain(struct thread *thread,
150 			      struct callchain_cursor *cursor,
151 			      struct perf_evsel *evsel,
152 			      struct perf_sample *sample,
153 			      struct symbol **parent,
154 			      struct addr_location *root_al,
155 			      int max_stack);
156 
157 /*
158  * Default guest kernel is defined by parameter --guestkallsyms
159  * and --guestmodules
160  */
161 static inline bool machine__is_default_guest(struct machine *machine)
162 {
163 	return machine ? machine->pid == DEFAULT_GUEST_KERNEL_ID : false;
164 }
165 
166 static inline bool machine__is_host(struct machine *machine)
167 {
168 	return machine ? machine->pid == HOST_KERNEL_ID : false;
169 }
170 
171 struct thread *__machine__findnew_thread(struct machine *machine, pid_t pid, pid_t tid);
172 struct thread *machine__findnew_thread(struct machine *machine, pid_t pid, pid_t tid);
173 
174 struct dso *machine__findnew_dso(struct machine *machine, const char *filename);
175 
176 size_t machine__fprintf(struct machine *machine, FILE *fp);
177 
178 static inline
179 struct symbol *machine__find_kernel_symbol(struct machine *machine,
180 					   enum map_type type, u64 addr,
181 					   struct map **mapp,
182 					   symbol_filter_t filter)
183 {
184 	return map_groups__find_symbol(&machine->kmaps, type, addr,
185 				       mapp, filter);
186 }
187 
188 static inline
189 struct symbol *machine__find_kernel_symbol_by_name(struct machine *machine,
190 						   enum map_type type, const char *name,
191 						   struct map **mapp,
192 						   symbol_filter_t filter)
193 {
194 	return map_groups__find_symbol_by_name(&machine->kmaps, type, name,
195 					       mapp, filter);
196 }
197 
198 static inline
199 struct symbol *machine__find_kernel_function(struct machine *machine, u64 addr,
200 					     struct map **mapp,
201 					     symbol_filter_t filter)
202 {
203 	return machine__find_kernel_symbol(machine, MAP__FUNCTION, addr,
204 					   mapp, filter);
205 }
206 
207 static inline
208 struct symbol *machine__find_kernel_function_by_name(struct machine *machine,
209 						     const char *name,
210 						     struct map **mapp,
211 						     symbol_filter_t filter)
212 {
213 	return map_groups__find_function_by_name(&machine->kmaps, name, mapp,
214 						 filter);
215 }
216 
217 struct map *machine__findnew_module_map(struct machine *machine, u64 start,
218 					const char *filename);
219 
220 int __machine__load_kallsyms(struct machine *machine, const char *filename,
221 			     enum map_type type, bool no_kcore, symbol_filter_t filter);
222 int machine__load_kallsyms(struct machine *machine, const char *filename,
223 			   enum map_type type, symbol_filter_t filter);
224 int machine__load_vmlinux_path(struct machine *machine, enum map_type type,
225 			       symbol_filter_t filter);
226 
227 size_t machine__fprintf_dsos_buildid(struct machine *machine, FILE *fp,
228 				     bool (skip)(struct dso *dso, int parm), int parm);
229 size_t machines__fprintf_dsos(struct machines *machines, FILE *fp);
230 size_t machines__fprintf_dsos_buildid(struct machines *machines, FILE *fp,
231 				     bool (skip)(struct dso *dso, int parm), int parm);
232 
233 void machine__destroy_kernel_maps(struct machine *machine);
234 int __machine__create_kernel_maps(struct machine *machine, struct dso *kernel);
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 proc_map_timeout);
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 proc_map_timeout)
258 {
259 	return __machine__synthesize_threads(machine, NULL, target, threads,
260 					     perf_event__process, data_mmap,
261 					     proc_map_timeout);
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 pevent_set_function_resolver()
269  */
270 char *machine__resolve_kernel_addr(void *vmachine, unsigned long long *addrp, char **modp);
271 
272 #endif /* __PERF_MACHINE_H */
273