xref: /linux/tools/perf/util/machine.h (revision 9402e23f90c5a672db7170e4c0f1fc80ca8c009a)
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 dsos	  user_dsos;
38 	struct dsos	  kernel_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 int machine__get_kernel_start(struct machine *machine);
57 
58 static inline u64 machine__kernel_start(struct machine *machine)
59 {
60 	if (!machine->kernel_start)
61 		machine__get_kernel_start(machine);
62 	return machine->kernel_start;
63 }
64 
65 static inline bool machine__kernel_ip(struct machine *machine, u64 ip)
66 {
67 	u64 kernel_start = machine__kernel_start(machine);
68 
69 	return ip >= kernel_start;
70 }
71 
72 struct thread *machine__find_thread(struct machine *machine, pid_t pid,
73 				    pid_t tid);
74 struct comm *machine__thread_exec_comm(struct machine *machine,
75 				       struct thread *thread);
76 
77 int machine__process_comm_event(struct machine *machine, union perf_event *event,
78 				struct perf_sample *sample);
79 int machine__process_exit_event(struct machine *machine, union perf_event *event,
80 				struct perf_sample *sample);
81 int machine__process_fork_event(struct machine *machine, union perf_event *event,
82 				struct perf_sample *sample);
83 int machine__process_lost_event(struct machine *machine, union perf_event *event,
84 				struct perf_sample *sample);
85 int machine__process_aux_event(struct machine *machine,
86 			       union perf_event *event);
87 int machine__process_itrace_start_event(struct machine *machine,
88 					union perf_event *event);
89 int machine__process_mmap_event(struct machine *machine, union perf_event *event,
90 				struct perf_sample *sample);
91 int machine__process_mmap2_event(struct machine *machine, union perf_event *event,
92 				 struct perf_sample *sample);
93 int machine__process_event(struct machine *machine, union perf_event *event,
94 				struct perf_sample *sample);
95 
96 typedef void (*machine__process_t)(struct machine *machine, void *data);
97 
98 struct machines {
99 	struct machine host;
100 	struct rb_root guests;
101 	symbol_filter_t symbol_filter;
102 };
103 
104 void machines__init(struct machines *machines);
105 void machines__exit(struct machines *machines);
106 
107 void machines__process_guests(struct machines *machines,
108 			      machine__process_t process, void *data);
109 
110 struct machine *machines__add(struct machines *machines, pid_t pid,
111 			      const char *root_dir);
112 struct machine *machines__find_host(struct machines *machines);
113 struct machine *machines__find(struct machines *machines, pid_t pid);
114 struct machine *machines__findnew(struct machines *machines, pid_t pid);
115 
116 void machines__set_id_hdr_size(struct machines *machines, u16 id_hdr_size);
117 char *machine__mmap_name(struct machine *machine, char *bf, size_t size);
118 
119 void machines__set_symbol_filter(struct machines *machines,
120 				 symbol_filter_t symbol_filter);
121 void machines__set_comm_exec(struct machines *machines, bool comm_exec);
122 
123 struct machine *machine__new_host(void);
124 int machine__init(struct machine *machine, const char *root_dir, pid_t pid);
125 void machine__exit(struct machine *machine);
126 void machine__delete_threads(struct machine *machine);
127 void machine__delete(struct machine *machine);
128 void machine__remove_thread(struct machine *machine, struct thread *th);
129 
130 struct branch_info *sample__resolve_bstack(struct perf_sample *sample,
131 					   struct addr_location *al);
132 struct mem_info *sample__resolve_mem(struct perf_sample *sample,
133 				     struct addr_location *al);
134 int thread__resolve_callchain(struct thread *thread,
135 			      struct perf_evsel *evsel,
136 			      struct perf_sample *sample,
137 			      struct symbol **parent,
138 			      struct addr_location *root_al,
139 			      int max_stack);
140 
141 /*
142  * Default guest kernel is defined by parameter --guestkallsyms
143  * and --guestmodules
144  */
145 static inline bool machine__is_default_guest(struct machine *machine)
146 {
147 	return machine ? machine->pid == DEFAULT_GUEST_KERNEL_ID : false;
148 }
149 
150 static inline bool machine__is_host(struct machine *machine)
151 {
152 	return machine ? machine->pid == HOST_KERNEL_ID : false;
153 }
154 
155 struct thread *__machine__findnew_thread(struct machine *machine, pid_t pid, pid_t tid);
156 struct thread *machine__findnew_thread(struct machine *machine, pid_t pid, pid_t tid);
157 
158 size_t machine__fprintf(struct machine *machine, FILE *fp);
159 
160 static inline
161 struct symbol *machine__find_kernel_symbol(struct machine *machine,
162 					   enum map_type type, u64 addr,
163 					   struct map **mapp,
164 					   symbol_filter_t filter)
165 {
166 	return map_groups__find_symbol(&machine->kmaps, type, addr,
167 				       mapp, filter);
168 }
169 
170 static inline
171 struct symbol *machine__find_kernel_function(struct machine *machine, u64 addr,
172 					     struct map **mapp,
173 					     symbol_filter_t filter)
174 {
175 	return machine__find_kernel_symbol(machine, MAP__FUNCTION, addr,
176 					   mapp, filter);
177 }
178 
179 static inline
180 struct symbol *machine__find_kernel_function_by_name(struct machine *machine,
181 						     const char *name,
182 						     struct map **mapp,
183 						     symbol_filter_t filter)
184 {
185 	return map_groups__find_function_by_name(&machine->kmaps, name, mapp,
186 						 filter);
187 }
188 
189 struct map *machine__new_module(struct machine *machine, u64 start,
190 				const char *filename);
191 
192 int machine__load_kallsyms(struct machine *machine, const char *filename,
193 			   enum map_type type, symbol_filter_t filter);
194 int machine__load_vmlinux_path(struct machine *machine, enum map_type type,
195 			       symbol_filter_t filter);
196 
197 size_t machine__fprintf_dsos_buildid(struct machine *machine, FILE *fp,
198 				     bool (skip)(struct dso *dso, int parm), int parm);
199 size_t machines__fprintf_dsos(struct machines *machines, FILE *fp);
200 size_t machines__fprintf_dsos_buildid(struct machines *machines, FILE *fp,
201 				     bool (skip)(struct dso *dso, int parm), int parm);
202 
203 void machine__destroy_kernel_maps(struct machine *machine);
204 int __machine__create_kernel_maps(struct machine *machine, struct dso *kernel);
205 int machine__create_kernel_maps(struct machine *machine);
206 
207 int machines__create_kernel_maps(struct machines *machines, pid_t pid);
208 int machines__create_guest_kernel_maps(struct machines *machines);
209 void machines__destroy_kernel_maps(struct machines *machines);
210 
211 size_t machine__fprintf_vmlinux_path(struct machine *machine, FILE *fp);
212 
213 int machine__for_each_thread(struct machine *machine,
214 			     int (*fn)(struct thread *thread, void *p),
215 			     void *priv);
216 
217 int __machine__synthesize_threads(struct machine *machine, struct perf_tool *tool,
218 				  struct target *target, struct thread_map *threads,
219 				  perf_event__handler_t process, bool data_mmap);
220 static inline
221 int machine__synthesize_threads(struct machine *machine, struct target *target,
222 				struct thread_map *threads, bool data_mmap)
223 {
224 	return __machine__synthesize_threads(machine, NULL, target, threads,
225 					     perf_event__process, data_mmap);
226 }
227 
228 pid_t machine__get_current_tid(struct machine *machine, int cpu);
229 int machine__set_current_tid(struct machine *machine, int cpu, pid_t pid,
230 			     pid_t tid);
231 
232 #endif /* __PERF_MACHINE_H */
233