xref: /linux/tools/perf/util/machine.h (revision 9be95bdc53c12ada23e39027237fd05e1393d893)
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 #include "rwsem.h"
10 
11 struct addr_location;
12 struct branch_stack;
13 struct perf_evsel;
14 struct perf_sample;
15 struct symbol;
16 struct thread;
17 union perf_event;
18 
19 /* Native host kernel uses -1 as pid index in machine */
20 #define	HOST_KERNEL_ID			(-1)
21 #define	DEFAULT_GUEST_KERNEL_ID		(0)
22 
23 extern const char *ref_reloc_sym_names[];
24 
25 struct vdso_info;
26 
27 #define THREADS__TABLE_BITS	8
28 #define THREADS__TABLE_SIZE	(1 << THREADS__TABLE_BITS)
29 
30 struct threads {
31 	struct rb_root	  entries;
32 	struct rw_semaphore lock;
33 	unsigned int	  nr;
34 	struct list_head  dead;
35 	struct thread	  *last_match;
36 };
37 
38 struct machine {
39 	struct rb_node	  rb_node;
40 	pid_t		  pid;
41 	u16		  id_hdr_size;
42 	bool		  comm_exec;
43 	bool		  kptr_restrict_warned;
44 	char		  *root_dir;
45 	struct threads    threads[THREADS__TABLE_SIZE];
46 	struct vdso_info  *vdso_info;
47 	struct perf_env   *env;
48 	struct dsos	  dsos;
49 	struct map_groups kmaps;
50 	struct map	  *vmlinux_maps[MAP__NR_TYPES];
51 	u64		  kernel_start;
52 	pid_t		  *current_tid;
53 	union { /* Tool specific area */
54 		void	  *priv;
55 		u64	  db_id;
56 	};
57 };
58 
59 static inline struct threads *machine__threads(struct machine *machine, pid_t tid)
60 {
61 	/* Cast it to handle tid == -1 */
62 	return &machine->threads[(unsigned int)tid % THREADS__TABLE_SIZE];
63 }
64 
65 static inline
66 struct map *__machine__kernel_map(struct machine *machine, enum map_type type)
67 {
68 	return machine->vmlinux_maps[type];
69 }
70 
71 static inline
72 struct map *machine__kernel_map(struct machine *machine)
73 {
74 	return __machine__kernel_map(machine, MAP__FUNCTION);
75 }
76 
77 int machine__get_kernel_start(struct machine *machine);
78 
79 static inline u64 machine__kernel_start(struct machine *machine)
80 {
81 	if (!machine->kernel_start)
82 		machine__get_kernel_start(machine);
83 	return machine->kernel_start;
84 }
85 
86 static inline bool machine__kernel_ip(struct machine *machine, u64 ip)
87 {
88 	u64 kernel_start = machine__kernel_start(machine);
89 
90 	return ip >= kernel_start;
91 }
92 
93 struct thread *machine__find_thread(struct machine *machine, pid_t pid,
94 				    pid_t tid);
95 struct comm *machine__thread_exec_comm(struct machine *machine,
96 				       struct thread *thread);
97 
98 int machine__process_comm_event(struct machine *machine, union perf_event *event,
99 				struct perf_sample *sample);
100 int machine__process_exit_event(struct machine *machine, union perf_event *event,
101 				struct perf_sample *sample);
102 int machine__process_fork_event(struct machine *machine, union perf_event *event,
103 				struct perf_sample *sample);
104 int machine__process_lost_event(struct machine *machine, union perf_event *event,
105 				struct perf_sample *sample);
106 int machine__process_lost_samples_event(struct machine *machine, union perf_event *event,
107 					struct perf_sample *sample);
108 int machine__process_aux_event(struct machine *machine,
109 			       union perf_event *event);
110 int machine__process_itrace_start_event(struct machine *machine,
111 					union perf_event *event);
112 int machine__process_switch_event(struct machine *machine,
113 				  union perf_event *event);
114 int machine__process_namespaces_event(struct machine *machine,
115 				      union perf_event *event,
116 				      struct perf_sample *sample);
117 int machine__process_mmap_event(struct machine *machine, union perf_event *event,
118 				struct perf_sample *sample);
119 int machine__process_mmap2_event(struct machine *machine, union perf_event *event,
120 				 struct perf_sample *sample);
121 int machine__process_event(struct machine *machine, union perf_event *event,
122 				struct perf_sample *sample);
123 
124 typedef void (*machine__process_t)(struct machine *machine, void *data);
125 
126 struct machines {
127 	struct machine host;
128 	struct rb_root guests;
129 };
130 
131 void machines__init(struct machines *machines);
132 void machines__exit(struct machines *machines);
133 
134 void machines__process_guests(struct machines *machines,
135 			      machine__process_t process, void *data);
136 
137 struct machine *machines__add(struct machines *machines, pid_t pid,
138 			      const char *root_dir);
139 struct machine *machines__find_host(struct machines *machines);
140 struct machine *machines__find(struct machines *machines, pid_t pid);
141 struct machine *machines__findnew(struct machines *machines, pid_t pid);
142 
143 void machines__set_id_hdr_size(struct machines *machines, u16 id_hdr_size);
144 char *machine__mmap_name(struct machine *machine, char *bf, size_t size);
145 
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, bool no_kcore);
230 int machine__load_kallsyms(struct machine *machine, const char *filename,
231 			   enum map_type type);
232 int machine__load_vmlinux_path(struct machine *machine, enum map_type type);
233 
234 size_t machine__fprintf_dsos_buildid(struct machine *machine, FILE *fp,
235 				     bool (skip)(struct dso *dso, int parm), int parm);
236 size_t machines__fprintf_dsos(struct machines *machines, FILE *fp);
237 size_t machines__fprintf_dsos_buildid(struct machines *machines, FILE *fp,
238 				     bool (skip)(struct dso *dso, int parm), int parm);
239 
240 void machine__destroy_kernel_maps(struct machine *machine);
241 int __machine__create_kernel_maps(struct machine *machine, struct dso *kernel);
242 int machine__create_kernel_maps(struct machine *machine);
243 
244 int machines__create_kernel_maps(struct machines *machines, pid_t pid);
245 int machines__create_guest_kernel_maps(struct machines *machines);
246 void machines__destroy_kernel_maps(struct machines *machines);
247 
248 size_t machine__fprintf_vmlinux_path(struct machine *machine, FILE *fp);
249 
250 int machine__for_each_thread(struct machine *machine,
251 			     int (*fn)(struct thread *thread, void *p),
252 			     void *priv);
253 int machines__for_each_thread(struct machines *machines,
254 			      int (*fn)(struct thread *thread, void *p),
255 			      void *priv);
256 
257 int __machine__synthesize_threads(struct machine *machine, struct perf_tool *tool,
258 				  struct target *target, struct thread_map *threads,
259 				  perf_event__handler_t process, bool data_mmap,
260 				  unsigned int proc_map_timeout,
261 				  unsigned int nr_threads_synthesize);
262 static inline
263 int machine__synthesize_threads(struct machine *machine, struct target *target,
264 				struct thread_map *threads, bool data_mmap,
265 				unsigned int proc_map_timeout,
266 				unsigned int nr_threads_synthesize)
267 {
268 	return __machine__synthesize_threads(machine, NULL, target, threads,
269 					     perf_event__process, data_mmap,
270 					     proc_map_timeout,
271 					     nr_threads_synthesize);
272 }
273 
274 pid_t machine__get_current_tid(struct machine *machine, int cpu);
275 int machine__set_current_tid(struct machine *machine, int cpu, pid_t pid,
276 			     pid_t tid);
277 /*
278  * For use with libtraceevent's pevent_set_function_resolver()
279  */
280 char *machine__resolve_kernel_addr(void *vmachine, unsigned long long *addrp, char **modp);
281 
282 #endif /* __PERF_MACHINE_H */
283