xref: /openbmc/linux/tools/perf/util/event.h (revision bb0eb050)
1 #ifndef __PERF_RECORD_H
2 #define __PERF_RECORD_H
3 
4 #include <limits.h>
5 #include <stdio.h>
6 #include <linux/kernel.h>
7 
8 #include "../perf.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 namespaces_event {
43 	struct perf_event_header header;
44 	u32 pid, tid;
45 	u64 nr_namespaces;
46 	struct perf_ns_link_info link_info[];
47 };
48 
49 struct fork_event {
50 	struct perf_event_header header;
51 	u32 pid, ppid;
52 	u32 tid, ptid;
53 	u64 time;
54 };
55 
56 struct lost_event {
57 	struct perf_event_header header;
58 	u64 id;
59 	u64 lost;
60 };
61 
62 struct lost_samples_event {
63 	struct perf_event_header header;
64 	u64 lost;
65 };
66 
67 /*
68  * PERF_FORMAT_ENABLED | PERF_FORMAT_RUNNING | PERF_FORMAT_ID
69  */
70 struct read_event {
71 	struct perf_event_header header;
72 	u32 pid, tid;
73 	u64 value;
74 	u64 time_enabled;
75 	u64 time_running;
76 	u64 id;
77 };
78 
79 struct throttle_event {
80 	struct perf_event_header header;
81 	u64 time;
82 	u64 id;
83 	u64 stream_id;
84 };
85 
86 #define PERF_SAMPLE_MASK				\
87 	(PERF_SAMPLE_IP | PERF_SAMPLE_TID |		\
88 	 PERF_SAMPLE_TIME | PERF_SAMPLE_ADDR |		\
89 	PERF_SAMPLE_ID | PERF_SAMPLE_STREAM_ID |	\
90 	 PERF_SAMPLE_CPU | PERF_SAMPLE_PERIOD |		\
91 	 PERF_SAMPLE_IDENTIFIER)
92 
93 /* perf sample has 16 bits size limit */
94 #define PERF_SAMPLE_MAX_SIZE (1 << 16)
95 
96 struct sample_event {
97 	struct perf_event_header        header;
98 	u64 array[];
99 };
100 
101 struct regs_dump {
102 	u64 abi;
103 	u64 mask;
104 	u64 *regs;
105 
106 	/* Cached values/mask filled by first register access. */
107 	u64 cache_regs[PERF_REGS_MAX];
108 	u64 cache_mask;
109 };
110 
111 struct stack_dump {
112 	u16 offset;
113 	u64 size;
114 	char *data;
115 };
116 
117 struct sample_read_value {
118 	u64 value;
119 	u64 id;
120 };
121 
122 struct sample_read {
123 	u64 time_enabled;
124 	u64 time_running;
125 	union {
126 		struct {
127 			u64 nr;
128 			struct sample_read_value *values;
129 		} group;
130 		struct sample_read_value one;
131 	};
132 };
133 
134 struct ip_callchain {
135 	u64 nr;
136 	u64 ips[0];
137 };
138 
139 struct branch_flags {
140 	u64 mispred:1;
141 	u64 predicted:1;
142 	u64 in_tx:1;
143 	u64 abort:1;
144 	u64 cycles:16;
145 	u64 reserved:44;
146 };
147 
148 struct branch_entry {
149 	u64			from;
150 	u64			to;
151 	struct branch_flags	flags;
152 };
153 
154 struct branch_stack {
155 	u64			nr;
156 	struct branch_entry	entries[0];
157 };
158 
159 enum {
160 	PERF_IP_FLAG_BRANCH		= 1ULL << 0,
161 	PERF_IP_FLAG_CALL		= 1ULL << 1,
162 	PERF_IP_FLAG_RETURN		= 1ULL << 2,
163 	PERF_IP_FLAG_CONDITIONAL	= 1ULL << 3,
164 	PERF_IP_FLAG_SYSCALLRET		= 1ULL << 4,
165 	PERF_IP_FLAG_ASYNC		= 1ULL << 5,
166 	PERF_IP_FLAG_INTERRUPT		= 1ULL << 6,
167 	PERF_IP_FLAG_TX_ABORT		= 1ULL << 7,
168 	PERF_IP_FLAG_TRACE_BEGIN	= 1ULL << 8,
169 	PERF_IP_FLAG_TRACE_END		= 1ULL << 9,
170 	PERF_IP_FLAG_IN_TX		= 1ULL << 10,
171 };
172 
173 #define PERF_IP_FLAG_CHARS "bcrosyiABEx"
174 
175 #define PERF_BRANCH_MASK		(\
176 	PERF_IP_FLAG_BRANCH		|\
177 	PERF_IP_FLAG_CALL		|\
178 	PERF_IP_FLAG_RETURN		|\
179 	PERF_IP_FLAG_CONDITIONAL	|\
180 	PERF_IP_FLAG_SYSCALLRET		|\
181 	PERF_IP_FLAG_ASYNC		|\
182 	PERF_IP_FLAG_INTERRUPT		|\
183 	PERF_IP_FLAG_TX_ABORT		|\
184 	PERF_IP_FLAG_TRACE_BEGIN	|\
185 	PERF_IP_FLAG_TRACE_END)
186 
187 #define MAX_INSN 16
188 
189 struct perf_sample {
190 	u64 ip;
191 	u32 pid, tid;
192 	u64 time;
193 	u64 addr;
194 	u64 id;
195 	u64 stream_id;
196 	u64 period;
197 	u64 weight;
198 	u64 transaction;
199 	u32 cpu;
200 	u32 raw_size;
201 	u64 data_src;
202 	u32 flags;
203 	u16 insn_len;
204 	u8  cpumode;
205 	char insn[MAX_INSN];
206 	void *raw_data;
207 	struct ip_callchain *callchain;
208 	struct branch_stack *branch_stack;
209 	struct regs_dump  user_regs;
210 	struct regs_dump  intr_regs;
211 	struct stack_dump user_stack;
212 	struct sample_read read;
213 };
214 
215 #define PERF_MEM_DATA_SRC_NONE \
216 	(PERF_MEM_S(OP, NA) |\
217 	 PERF_MEM_S(LVL, NA) |\
218 	 PERF_MEM_S(SNOOP, NA) |\
219 	 PERF_MEM_S(LOCK, NA) |\
220 	 PERF_MEM_S(TLB, NA))
221 
222 struct build_id_event {
223 	struct perf_event_header header;
224 	pid_t			 pid;
225 	u8			 build_id[PERF_ALIGN(BUILD_ID_SIZE, sizeof(u64))];
226 	char			 filename[];
227 };
228 
229 enum perf_user_event_type { /* above any possible kernel type */
230 	PERF_RECORD_USER_TYPE_START		= 64,
231 	PERF_RECORD_HEADER_ATTR			= 64,
232 	PERF_RECORD_HEADER_EVENT_TYPE		= 65, /* deprecated */
233 	PERF_RECORD_HEADER_TRACING_DATA		= 66,
234 	PERF_RECORD_HEADER_BUILD_ID		= 67,
235 	PERF_RECORD_FINISHED_ROUND		= 68,
236 	PERF_RECORD_ID_INDEX			= 69,
237 	PERF_RECORD_AUXTRACE_INFO		= 70,
238 	PERF_RECORD_AUXTRACE			= 71,
239 	PERF_RECORD_AUXTRACE_ERROR		= 72,
240 	PERF_RECORD_THREAD_MAP			= 73,
241 	PERF_RECORD_CPU_MAP			= 74,
242 	PERF_RECORD_STAT_CONFIG			= 75,
243 	PERF_RECORD_STAT			= 76,
244 	PERF_RECORD_STAT_ROUND			= 77,
245 	PERF_RECORD_EVENT_UPDATE		= 78,
246 	PERF_RECORD_TIME_CONV			= 79,
247 	PERF_RECORD_HEADER_MAX
248 };
249 
250 enum auxtrace_error_type {
251 	PERF_AUXTRACE_ERROR_ITRACE  = 1,
252 	PERF_AUXTRACE_ERROR_MAX
253 };
254 
255 /*
256  * The kernel collects the number of events it couldn't send in a stretch and
257  * when possible sends this number in a PERF_RECORD_LOST event. The number of
258  * such "chunks" of lost events is stored in .nr_events[PERF_EVENT_LOST] while
259  * total_lost tells exactly how many events the kernel in fact lost, i.e. it is
260  * the sum of all struct lost_event.lost fields reported.
261  *
262  * The kernel discards mixed up samples and sends the number in a
263  * PERF_RECORD_LOST_SAMPLES event. The number of lost-samples events is stored
264  * in .nr_events[PERF_RECORD_LOST_SAMPLES] while total_lost_samples tells
265  * exactly how many samples the kernel in fact dropped, i.e. it is the sum of
266  * all struct lost_samples_event.lost fields reported.
267  *
268  * The total_period is needed because by default auto-freq is used, so
269  * multipling nr_events[PERF_EVENT_SAMPLE] by a frequency isn't possible to get
270  * the total number of low level events, it is necessary to to sum all struct
271  * sample_event.period and stash the result in total_period.
272  */
273 struct events_stats {
274 	u64 total_period;
275 	u64 total_non_filtered_period;
276 	u64 total_lost;
277 	u64 total_lost_samples;
278 	u64 total_aux_lost;
279 	u64 total_aux_partial;
280 	u64 total_invalid_chains;
281 	u32 nr_events[PERF_RECORD_HEADER_MAX];
282 	u32 nr_non_filtered_samples;
283 	u32 nr_lost_warned;
284 	u32 nr_unknown_events;
285 	u32 nr_invalid_chains;
286 	u32 nr_unknown_id;
287 	u32 nr_unprocessable_samples;
288 	u32 nr_auxtrace_errors[PERF_AUXTRACE_ERROR_MAX];
289 	u32 nr_proc_map_timeout;
290 };
291 
292 enum {
293 	PERF_CPU_MAP__CPUS = 0,
294 	PERF_CPU_MAP__MASK = 1,
295 };
296 
297 struct cpu_map_entries {
298 	u16	nr;
299 	u16	cpu[];
300 };
301 
302 struct cpu_map_mask {
303 	u16	nr;
304 	u16	long_size;
305 	unsigned long mask[];
306 };
307 
308 struct cpu_map_data {
309 	u16	type;
310 	char	data[];
311 };
312 
313 struct cpu_map_event {
314 	struct perf_event_header	header;
315 	struct cpu_map_data		data;
316 };
317 
318 struct attr_event {
319 	struct perf_event_header header;
320 	struct perf_event_attr attr;
321 	u64 id[];
322 };
323 
324 enum {
325 	PERF_EVENT_UPDATE__UNIT  = 0,
326 	PERF_EVENT_UPDATE__SCALE = 1,
327 	PERF_EVENT_UPDATE__NAME  = 2,
328 	PERF_EVENT_UPDATE__CPUS  = 3,
329 };
330 
331 struct event_update_event_cpus {
332 	struct cpu_map_data cpus;
333 };
334 
335 struct event_update_event_scale {
336 	double scale;
337 };
338 
339 struct event_update_event {
340 	struct perf_event_header header;
341 	u64 type;
342 	u64 id;
343 
344 	char data[];
345 };
346 
347 #define MAX_EVENT_NAME 64
348 
349 struct perf_trace_event_type {
350 	u64	event_id;
351 	char	name[MAX_EVENT_NAME];
352 };
353 
354 struct event_type_event {
355 	struct perf_event_header header;
356 	struct perf_trace_event_type event_type;
357 };
358 
359 struct tracing_data_event {
360 	struct perf_event_header header;
361 	u32 size;
362 };
363 
364 struct id_index_entry {
365 	u64 id;
366 	u64 idx;
367 	u64 cpu;
368 	u64 tid;
369 };
370 
371 struct id_index_event {
372 	struct perf_event_header header;
373 	u64 nr;
374 	struct id_index_entry entries[0];
375 };
376 
377 struct auxtrace_info_event {
378 	struct perf_event_header header;
379 	u32 type;
380 	u32 reserved__; /* For alignment */
381 	u64 priv[];
382 };
383 
384 struct auxtrace_event {
385 	struct perf_event_header header;
386 	u64 size;
387 	u64 offset;
388 	u64 reference;
389 	u32 idx;
390 	u32 tid;
391 	u32 cpu;
392 	u32 reserved__; /* For alignment */
393 };
394 
395 #define MAX_AUXTRACE_ERROR_MSG 64
396 
397 struct auxtrace_error_event {
398 	struct perf_event_header header;
399 	u32 type;
400 	u32 code;
401 	u32 cpu;
402 	u32 pid;
403 	u32 tid;
404 	u32 reserved__; /* For alignment */
405 	u64 ip;
406 	char msg[MAX_AUXTRACE_ERROR_MSG];
407 };
408 
409 struct aux_event {
410 	struct perf_event_header header;
411 	u64	aux_offset;
412 	u64	aux_size;
413 	u64	flags;
414 };
415 
416 struct itrace_start_event {
417 	struct perf_event_header header;
418 	u32 pid, tid;
419 };
420 
421 struct context_switch_event {
422 	struct perf_event_header header;
423 	u32 next_prev_pid;
424 	u32 next_prev_tid;
425 };
426 
427 struct thread_map_event_entry {
428 	u64	pid;
429 	char	comm[16];
430 };
431 
432 struct thread_map_event {
433 	struct perf_event_header	header;
434 	u64				nr;
435 	struct thread_map_event_entry	entries[];
436 };
437 
438 enum {
439 	PERF_STAT_CONFIG_TERM__AGGR_MODE	= 0,
440 	PERF_STAT_CONFIG_TERM__INTERVAL		= 1,
441 	PERF_STAT_CONFIG_TERM__SCALE		= 2,
442 	PERF_STAT_CONFIG_TERM__MAX		= 3,
443 };
444 
445 struct stat_config_event_entry {
446 	u64	tag;
447 	u64	val;
448 };
449 
450 struct stat_config_event {
451 	struct perf_event_header	header;
452 	u64				nr;
453 	struct stat_config_event_entry	data[];
454 };
455 
456 struct stat_event {
457 	struct perf_event_header	header;
458 
459 	u64	id;
460 	u32	cpu;
461 	u32	thread;
462 
463 	union {
464 		struct {
465 			u64 val;
466 			u64 ena;
467 			u64 run;
468 		};
469 		u64 values[3];
470 	};
471 };
472 
473 enum {
474 	PERF_STAT_ROUND_TYPE__INTERVAL	= 0,
475 	PERF_STAT_ROUND_TYPE__FINAL	= 1,
476 };
477 
478 struct stat_round_event {
479 	struct perf_event_header	header;
480 	u64				type;
481 	u64				time;
482 };
483 
484 struct time_conv_event {
485 	struct perf_event_header header;
486 	u64 time_shift;
487 	u64 time_mult;
488 	u64 time_zero;
489 };
490 
491 union perf_event {
492 	struct perf_event_header	header;
493 	struct mmap_event		mmap;
494 	struct mmap2_event		mmap2;
495 	struct comm_event		comm;
496 	struct namespaces_event		namespaces;
497 	struct fork_event		fork;
498 	struct lost_event		lost;
499 	struct lost_samples_event	lost_samples;
500 	struct read_event		read;
501 	struct throttle_event		throttle;
502 	struct sample_event		sample;
503 	struct attr_event		attr;
504 	struct event_update_event	event_update;
505 	struct event_type_event		event_type;
506 	struct tracing_data_event	tracing_data;
507 	struct build_id_event		build_id;
508 	struct id_index_event		id_index;
509 	struct auxtrace_info_event	auxtrace_info;
510 	struct auxtrace_event		auxtrace;
511 	struct auxtrace_error_event	auxtrace_error;
512 	struct aux_event		aux;
513 	struct itrace_start_event	itrace_start;
514 	struct context_switch_event	context_switch;
515 	struct thread_map_event		thread_map;
516 	struct cpu_map_event		cpu_map;
517 	struct stat_config_event	stat_config;
518 	struct stat_event		stat;
519 	struct stat_round_event		stat_round;
520 	struct time_conv_event		time_conv;
521 };
522 
523 void perf_event__print_totals(void);
524 
525 struct perf_tool;
526 struct thread_map;
527 struct cpu_map;
528 struct perf_stat_config;
529 struct perf_counts_values;
530 
531 typedef int (*perf_event__handler_t)(struct perf_tool *tool,
532 				     union perf_event *event,
533 				     struct perf_sample *sample,
534 				     struct machine *machine);
535 
536 int perf_event__synthesize_thread_map(struct perf_tool *tool,
537 				      struct thread_map *threads,
538 				      perf_event__handler_t process,
539 				      struct machine *machine, bool mmap_data,
540 				      unsigned int proc_map_timeout);
541 int perf_event__synthesize_thread_map2(struct perf_tool *tool,
542 				      struct thread_map *threads,
543 				      perf_event__handler_t process,
544 				      struct machine *machine);
545 int perf_event__synthesize_cpu_map(struct perf_tool *tool,
546 				   struct cpu_map *cpus,
547 				   perf_event__handler_t process,
548 				   struct machine *machine);
549 int perf_event__synthesize_threads(struct perf_tool *tool,
550 				   perf_event__handler_t process,
551 				   struct machine *machine, bool mmap_data,
552 				   unsigned int proc_map_timeout);
553 int perf_event__synthesize_kernel_mmap(struct perf_tool *tool,
554 				       perf_event__handler_t process,
555 				       struct machine *machine);
556 int perf_event__synthesize_stat_config(struct perf_tool *tool,
557 				       struct perf_stat_config *config,
558 				       perf_event__handler_t process,
559 				       struct machine *machine);
560 void perf_event__read_stat_config(struct perf_stat_config *config,
561 				  struct stat_config_event *event);
562 int perf_event__synthesize_stat(struct perf_tool *tool,
563 				u32 cpu, u32 thread, u64 id,
564 				struct perf_counts_values *count,
565 				perf_event__handler_t process,
566 				struct machine *machine);
567 int perf_event__synthesize_stat_round(struct perf_tool *tool,
568 				      u64 time, u64 type,
569 				      perf_event__handler_t process,
570 				      struct machine *machine);
571 int perf_event__synthesize_modules(struct perf_tool *tool,
572 				   perf_event__handler_t process,
573 				   struct machine *machine);
574 
575 int perf_event__process_comm(struct perf_tool *tool,
576 			     union perf_event *event,
577 			     struct perf_sample *sample,
578 			     struct machine *machine);
579 int perf_event__process_lost(struct perf_tool *tool,
580 			     union perf_event *event,
581 			     struct perf_sample *sample,
582 			     struct machine *machine);
583 int perf_event__process_lost_samples(struct perf_tool *tool,
584 				     union perf_event *event,
585 				     struct perf_sample *sample,
586 				     struct machine *machine);
587 int perf_event__process_aux(struct perf_tool *tool,
588 			    union perf_event *event,
589 			    struct perf_sample *sample,
590 			    struct machine *machine);
591 int perf_event__process_itrace_start(struct perf_tool *tool,
592 				     union perf_event *event,
593 				     struct perf_sample *sample,
594 				     struct machine *machine);
595 int perf_event__process_switch(struct perf_tool *tool,
596 			       union perf_event *event,
597 			       struct perf_sample *sample,
598 			       struct machine *machine);
599 int perf_event__process_namespaces(struct perf_tool *tool,
600 				   union perf_event *event,
601 				   struct perf_sample *sample,
602 				   struct machine *machine);
603 int perf_event__process_mmap(struct perf_tool *tool,
604 			     union perf_event *event,
605 			     struct perf_sample *sample,
606 			     struct machine *machine);
607 int perf_event__process_mmap2(struct perf_tool *tool,
608 			     union perf_event *event,
609 			     struct perf_sample *sample,
610 			     struct machine *machine);
611 int perf_event__process_fork(struct perf_tool *tool,
612 			     union perf_event *event,
613 			     struct perf_sample *sample,
614 			     struct machine *machine);
615 int perf_event__process_exit(struct perf_tool *tool,
616 			     union perf_event *event,
617 			     struct perf_sample *sample,
618 			     struct machine *machine);
619 int perf_event__process(struct perf_tool *tool,
620 			union perf_event *event,
621 			struct perf_sample *sample,
622 			struct machine *machine);
623 
624 struct addr_location;
625 
626 int machine__resolve(struct machine *machine, struct addr_location *al,
627 		     struct perf_sample *sample);
628 
629 void addr_location__put(struct addr_location *al);
630 
631 struct thread;
632 
633 bool is_bts_event(struct perf_event_attr *attr);
634 bool sample_addr_correlates_sym(struct perf_event_attr *attr);
635 void thread__resolve(struct thread *thread, struct addr_location *al,
636 		     struct perf_sample *sample);
637 
638 const char *perf_event__name(unsigned int id);
639 
640 size_t perf_event__sample_event_size(const struct perf_sample *sample, u64 type,
641 				     u64 read_format);
642 int perf_event__synthesize_sample(union perf_event *event, u64 type,
643 				  u64 read_format,
644 				  const struct perf_sample *sample,
645 				  bool swapped);
646 
647 pid_t perf_event__synthesize_comm(struct perf_tool *tool,
648 				  union perf_event *event, pid_t pid,
649 				  perf_event__handler_t process,
650 				  struct machine *machine);
651 
652 int perf_event__synthesize_namespaces(struct perf_tool *tool,
653 				      union perf_event *event,
654 				      pid_t pid, pid_t tgid,
655 				      perf_event__handler_t process,
656 				      struct machine *machine);
657 
658 int perf_event__synthesize_mmap_events(struct perf_tool *tool,
659 				       union perf_event *event,
660 				       pid_t pid, pid_t tgid,
661 				       perf_event__handler_t process,
662 				       struct machine *machine,
663 				       bool mmap_data,
664 				       unsigned int proc_map_timeout);
665 
666 size_t perf_event__fprintf_comm(union perf_event *event, FILE *fp);
667 size_t perf_event__fprintf_mmap(union perf_event *event, FILE *fp);
668 size_t perf_event__fprintf_mmap2(union perf_event *event, FILE *fp);
669 size_t perf_event__fprintf_task(union perf_event *event, FILE *fp);
670 size_t perf_event__fprintf_aux(union perf_event *event, FILE *fp);
671 size_t perf_event__fprintf_itrace_start(union perf_event *event, FILE *fp);
672 size_t perf_event__fprintf_switch(union perf_event *event, FILE *fp);
673 size_t perf_event__fprintf_thread_map(union perf_event *event, FILE *fp);
674 size_t perf_event__fprintf_cpu_map(union perf_event *event, FILE *fp);
675 size_t perf_event__fprintf_namespaces(union perf_event *event, FILE *fp);
676 size_t perf_event__fprintf(union perf_event *event, FILE *fp);
677 
678 int kallsyms__get_function_start(const char *kallsyms_filename,
679 				 const char *symbol_name, u64 *addr);
680 
681 void *cpu_map_data__alloc(struct cpu_map *map, size_t *size, u16 *type, int *max);
682 void  cpu_map_data__synthesize(struct cpu_map_data *data, struct cpu_map *map,
683 			       u16 type, int max);
684 
685 void event_attr_init(struct perf_event_attr *attr);
686 
687 int perf_event_paranoid(void);
688 
689 extern int sysctl_perf_event_max_stack;
690 extern int sysctl_perf_event_max_contexts_per_stack;
691 
692 #endif /* __PERF_RECORD_H */
693