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