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