xref: /openbmc/linux/tools/perf/util/event.h (revision 275876e2)
1 #ifndef __PERF_RECORD_H
2 #define __PERF_RECORD_H
3 
4 #include <limits.h>
5 #include <stdio.h>
6 
7 #include "../perf.h"
8 #include "map.h"
9 #include "build-id.h"
10 #include "perf_regs.h"
11 
12 struct mmap_event {
13 	struct perf_event_header header;
14 	u32 pid, tid;
15 	u64 start;
16 	u64 len;
17 	u64 pgoff;
18 	char filename[PATH_MAX];
19 };
20 
21 struct mmap2_event {
22 	struct perf_event_header header;
23 	u32 pid, tid;
24 	u64 start;
25 	u64 len;
26 	u64 pgoff;
27 	u32 maj;
28 	u32 min;
29 	u64 ino;
30 	u64 ino_generation;
31 	u32 prot;
32 	u32 flags;
33 	char filename[PATH_MAX];
34 };
35 
36 struct comm_event {
37 	struct perf_event_header header;
38 	u32 pid, tid;
39 	char comm[16];
40 };
41 
42 struct fork_event {
43 	struct perf_event_header header;
44 	u32 pid, ppid;
45 	u32 tid, ptid;
46 	u64 time;
47 };
48 
49 struct lost_event {
50 	struct perf_event_header header;
51 	u64 id;
52 	u64 lost;
53 };
54 
55 /*
56  * PERF_FORMAT_ENABLED | PERF_FORMAT_RUNNING | PERF_FORMAT_ID
57  */
58 struct read_event {
59 	struct perf_event_header header;
60 	u32 pid, tid;
61 	u64 value;
62 	u64 time_enabled;
63 	u64 time_running;
64 	u64 id;
65 };
66 
67 struct throttle_event {
68 	struct perf_event_header header;
69 	u64 time;
70 	u64 id;
71 	u64 stream_id;
72 };
73 
74 #define PERF_SAMPLE_MASK				\
75 	(PERF_SAMPLE_IP | PERF_SAMPLE_TID |		\
76 	 PERF_SAMPLE_TIME | PERF_SAMPLE_ADDR |		\
77 	PERF_SAMPLE_ID | PERF_SAMPLE_STREAM_ID |	\
78 	 PERF_SAMPLE_CPU | PERF_SAMPLE_PERIOD |		\
79 	 PERF_SAMPLE_IDENTIFIER)
80 
81 /* perf sample has 16 bits size limit */
82 #define PERF_SAMPLE_MAX_SIZE (1 << 16)
83 
84 struct sample_event {
85 	struct perf_event_header        header;
86 	u64 array[];
87 };
88 
89 struct regs_dump {
90 	u64 abi;
91 	u64 mask;
92 	u64 *regs;
93 
94 	/* Cached values/mask filled by first register access. */
95 	u64 cache_regs[PERF_REGS_MAX];
96 	u64 cache_mask;
97 };
98 
99 struct stack_dump {
100 	u16 offset;
101 	u64 size;
102 	char *data;
103 };
104 
105 struct sample_read_value {
106 	u64 value;
107 	u64 id;
108 };
109 
110 struct sample_read {
111 	u64 time_enabled;
112 	u64 time_running;
113 	union {
114 		struct {
115 			u64 nr;
116 			struct sample_read_value *values;
117 		} group;
118 		struct sample_read_value one;
119 	};
120 };
121 
122 struct ip_callchain {
123 	u64 nr;
124 	u64 ips[0];
125 };
126 
127 struct branch_flags {
128 	u64 mispred:1;
129 	u64 predicted:1;
130 	u64 in_tx:1;
131 	u64 abort:1;
132 	u64 reserved:60;
133 };
134 
135 struct branch_entry {
136 	u64			from;
137 	u64			to;
138 	struct branch_flags	flags;
139 };
140 
141 struct branch_stack {
142 	u64			nr;
143 	struct branch_entry	entries[0];
144 };
145 
146 struct perf_sample {
147 	u64 ip;
148 	u32 pid, tid;
149 	u64 time;
150 	u64 addr;
151 	u64 id;
152 	u64 stream_id;
153 	u64 period;
154 	u64 weight;
155 	u64 transaction;
156 	u32 cpu;
157 	u32 raw_size;
158 	u64 data_src;
159 	void *raw_data;
160 	struct ip_callchain *callchain;
161 	struct branch_stack *branch_stack;
162 	struct regs_dump  user_regs;
163 	struct stack_dump user_stack;
164 	struct sample_read read;
165 };
166 
167 #define PERF_MEM_DATA_SRC_NONE \
168 	(PERF_MEM_S(OP, NA) |\
169 	 PERF_MEM_S(LVL, NA) |\
170 	 PERF_MEM_S(SNOOP, NA) |\
171 	 PERF_MEM_S(LOCK, NA) |\
172 	 PERF_MEM_S(TLB, NA))
173 
174 struct build_id_event {
175 	struct perf_event_header header;
176 	pid_t			 pid;
177 	u8			 build_id[PERF_ALIGN(BUILD_ID_SIZE, sizeof(u64))];
178 	char			 filename[];
179 };
180 
181 enum perf_user_event_type { /* above any possible kernel type */
182 	PERF_RECORD_USER_TYPE_START		= 64,
183 	PERF_RECORD_HEADER_ATTR			= 64,
184 	PERF_RECORD_HEADER_EVENT_TYPE		= 65, /* depreceated */
185 	PERF_RECORD_HEADER_TRACING_DATA		= 66,
186 	PERF_RECORD_HEADER_BUILD_ID		= 67,
187 	PERF_RECORD_FINISHED_ROUND		= 68,
188 	PERF_RECORD_HEADER_MAX
189 };
190 
191 struct attr_event {
192 	struct perf_event_header header;
193 	struct perf_event_attr attr;
194 	u64 id[];
195 };
196 
197 #define MAX_EVENT_NAME 64
198 
199 struct perf_trace_event_type {
200 	u64	event_id;
201 	char	name[MAX_EVENT_NAME];
202 };
203 
204 struct event_type_event {
205 	struct perf_event_header header;
206 	struct perf_trace_event_type event_type;
207 };
208 
209 struct tracing_data_event {
210 	struct perf_event_header header;
211 	u32 size;
212 };
213 
214 union perf_event {
215 	struct perf_event_header	header;
216 	struct mmap_event		mmap;
217 	struct mmap2_event		mmap2;
218 	struct comm_event		comm;
219 	struct fork_event		fork;
220 	struct lost_event		lost;
221 	struct read_event		read;
222 	struct throttle_event		throttle;
223 	struct sample_event		sample;
224 	struct attr_event		attr;
225 	struct event_type_event		event_type;
226 	struct tracing_data_event	tracing_data;
227 	struct build_id_event		build_id;
228 };
229 
230 void perf_event__print_totals(void);
231 
232 struct perf_tool;
233 struct thread_map;
234 
235 typedef int (*perf_event__handler_t)(struct perf_tool *tool,
236 				     union perf_event *event,
237 				     struct perf_sample *sample,
238 				     struct machine *machine);
239 
240 int perf_event__synthesize_thread_map(struct perf_tool *tool,
241 				      struct thread_map *threads,
242 				      perf_event__handler_t process,
243 				      struct machine *machine, bool mmap_data);
244 int perf_event__synthesize_threads(struct perf_tool *tool,
245 				   perf_event__handler_t process,
246 				   struct machine *machine, bool mmap_data);
247 int perf_event__synthesize_kernel_mmap(struct perf_tool *tool,
248 				       perf_event__handler_t process,
249 				       struct machine *machine);
250 
251 int perf_event__synthesize_modules(struct perf_tool *tool,
252 				   perf_event__handler_t process,
253 				   struct machine *machine);
254 
255 int perf_event__process_comm(struct perf_tool *tool,
256 			     union perf_event *event,
257 			     struct perf_sample *sample,
258 			     struct machine *machine);
259 int perf_event__process_lost(struct perf_tool *tool,
260 			     union perf_event *event,
261 			     struct perf_sample *sample,
262 			     struct machine *machine);
263 int perf_event__process_mmap(struct perf_tool *tool,
264 			     union perf_event *event,
265 			     struct perf_sample *sample,
266 			     struct machine *machine);
267 int perf_event__process_mmap2(struct perf_tool *tool,
268 			     union perf_event *event,
269 			     struct perf_sample *sample,
270 			     struct machine *machine);
271 int perf_event__process_fork(struct perf_tool *tool,
272 			     union perf_event *event,
273 			     struct perf_sample *sample,
274 			     struct machine *machine);
275 int perf_event__process_exit(struct perf_tool *tool,
276 			     union perf_event *event,
277 			     struct perf_sample *sample,
278 			     struct machine *machine);
279 int perf_event__process(struct perf_tool *tool,
280 			union perf_event *event,
281 			struct perf_sample *sample,
282 			struct machine *machine);
283 
284 struct addr_location;
285 
286 int perf_event__preprocess_sample(const union perf_event *event,
287 				  struct machine *machine,
288 				  struct addr_location *al,
289 				  struct perf_sample *sample);
290 
291 struct thread;
292 
293 bool is_bts_event(struct perf_event_attr *attr);
294 bool sample_addr_correlates_sym(struct perf_event_attr *attr);
295 void perf_event__preprocess_sample_addr(union perf_event *event,
296 					struct perf_sample *sample,
297 					struct machine *machine,
298 					struct thread *thread,
299 					struct addr_location *al);
300 
301 const char *perf_event__name(unsigned int id);
302 
303 size_t perf_event__sample_event_size(const struct perf_sample *sample, u64 type,
304 				     u64 read_format);
305 int perf_event__synthesize_sample(union perf_event *event, u64 type,
306 				  u64 read_format,
307 				  const struct perf_sample *sample,
308 				  bool swapped);
309 
310 int perf_event__synthesize_mmap_events(struct perf_tool *tool,
311 				       union perf_event *event,
312 				       pid_t pid, pid_t tgid,
313 				       perf_event__handler_t process,
314 				       struct machine *machine,
315 				       bool mmap_data);
316 
317 size_t perf_event__fprintf_comm(union perf_event *event, FILE *fp);
318 size_t perf_event__fprintf_mmap(union perf_event *event, FILE *fp);
319 size_t perf_event__fprintf_mmap2(union perf_event *event, FILE *fp);
320 size_t perf_event__fprintf_task(union perf_event *event, FILE *fp);
321 size_t perf_event__fprintf(union perf_event *event, FILE *fp);
322 
323 u64 kallsyms__get_function_start(const char *kallsyms_filename,
324 				 const char *symbol_name);
325 
326 #endif /* __PERF_RECORD_H */
327