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