1 /* SPDX-License-Identifier: GPL-2.0 */
2 #ifndef __PERF_RECORD_H
3 #define __PERF_RECORD_H
7 #include <linux/kernel.h>
11 #include "perf_regs.h"
14 struct perf_event_header header
;
19 char filename
[PATH_MAX
];
23 struct perf_event_header header
;
34 char filename
[PATH_MAX
];
38 struct perf_event_header header
;
43 struct namespaces_event
{
44 struct perf_event_header header
;
47 struct perf_ns_link_info link_info
[];
51 struct perf_event_header header
;
58 struct perf_event_header header
;
63 struct lost_samples_event
{
64 struct perf_event_header header
;
69 * PERF_FORMAT_ENABLED | PERF_FORMAT_RUNNING | PERF_FORMAT_ID
72 struct perf_event_header header
;
80 struct throttle_event
{
81 struct perf_event_header header
;
87 #define PERF_SAMPLE_MASK \
88 (PERF_SAMPLE_IP | PERF_SAMPLE_TID | \
89 PERF_SAMPLE_TIME | PERF_SAMPLE_ADDR | \
90 PERF_SAMPLE_ID | PERF_SAMPLE_STREAM_ID | \
91 PERF_SAMPLE_CPU | PERF_SAMPLE_PERIOD | \
92 PERF_SAMPLE_IDENTIFIER)
94 /* perf sample has 16 bits size limit */
95 #define PERF_SAMPLE_MAX_SIZE (1 << 16)
98 struct perf_event_header header
;
107 /* Cached values/mask filled by first register access. */
108 u64 cache_regs
[PERF_REGS_MAX
];
118 struct sample_read_value
{
129 struct sample_read_value
*values
;
131 struct sample_read_value one
;
135 struct ip_callchain
{
140 struct branch_flags
{
150 struct branch_entry
{
153 struct branch_flags flags
;
156 struct branch_stack
{
158 struct branch_entry entries
[0];
162 PERF_IP_FLAG_BRANCH
= 1ULL << 0,
163 PERF_IP_FLAG_CALL
= 1ULL << 1,
164 PERF_IP_FLAG_RETURN
= 1ULL << 2,
165 PERF_IP_FLAG_CONDITIONAL
= 1ULL << 3,
166 PERF_IP_FLAG_SYSCALLRET
= 1ULL << 4,
167 PERF_IP_FLAG_ASYNC
= 1ULL << 5,
168 PERF_IP_FLAG_INTERRUPT
= 1ULL << 6,
169 PERF_IP_FLAG_TX_ABORT
= 1ULL << 7,
170 PERF_IP_FLAG_TRACE_BEGIN
= 1ULL << 8,
171 PERF_IP_FLAG_TRACE_END
= 1ULL << 9,
172 PERF_IP_FLAG_IN_TX
= 1ULL << 10,
175 #define PERF_IP_FLAG_CHARS "bcrosyiABEx"
177 #define PERF_BRANCH_MASK (\
178 PERF_IP_FLAG_BRANCH |\
180 PERF_IP_FLAG_RETURN |\
181 PERF_IP_FLAG_CONDITIONAL |\
182 PERF_IP_FLAG_SYSCALLRET |\
183 PERF_IP_FLAG_ASYNC |\
184 PERF_IP_FLAG_INTERRUPT |\
185 PERF_IP_FLAG_TX_ABORT |\
186 PERF_IP_FLAG_TRACE_BEGIN |\
187 PERF_IP_FLAG_TRACE_END)
210 struct ip_callchain
*callchain
;
211 struct branch_stack
*branch_stack
;
212 struct regs_dump user_regs
;
213 struct regs_dump intr_regs
;
214 struct stack_dump user_stack
;
215 struct sample_read read
;
218 #define PERF_MEM_DATA_SRC_NONE \
219 (PERF_MEM_S(OP, NA) |\
220 PERF_MEM_S(LVL, NA) |\
221 PERF_MEM_S(SNOOP, NA) |\
222 PERF_MEM_S(LOCK, NA) |\
225 struct build_id_event
{
226 struct perf_event_header header
;
228 u8 build_id
[PERF_ALIGN(BUILD_ID_SIZE
, sizeof(u64
))];
232 enum perf_user_event_type
{ /* above any possible kernel type */
233 PERF_RECORD_USER_TYPE_START
= 64,
234 PERF_RECORD_HEADER_ATTR
= 64,
235 PERF_RECORD_HEADER_EVENT_TYPE
= 65, /* deprecated */
236 PERF_RECORD_HEADER_TRACING_DATA
= 66,
237 PERF_RECORD_HEADER_BUILD_ID
= 67,
238 PERF_RECORD_FINISHED_ROUND
= 68,
239 PERF_RECORD_ID_INDEX
= 69,
240 PERF_RECORD_AUXTRACE_INFO
= 70,
241 PERF_RECORD_AUXTRACE
= 71,
242 PERF_RECORD_AUXTRACE_ERROR
= 72,
243 PERF_RECORD_THREAD_MAP
= 73,
244 PERF_RECORD_CPU_MAP
= 74,
245 PERF_RECORD_STAT_CONFIG
= 75,
246 PERF_RECORD_STAT
= 76,
247 PERF_RECORD_STAT_ROUND
= 77,
248 PERF_RECORD_EVENT_UPDATE
= 78,
249 PERF_RECORD_TIME_CONV
= 79,
250 PERF_RECORD_HEADER_FEATURE
= 80,
251 PERF_RECORD_HEADER_MAX
254 enum auxtrace_error_type
{
255 PERF_AUXTRACE_ERROR_ITRACE
= 1,
256 PERF_AUXTRACE_ERROR_MAX
259 /* Attribute type for custom synthesized events */
260 #define PERF_TYPE_SYNTH (INT_MAX + 1U)
262 /* Attribute config for custom synthesized events */
264 PERF_SYNTH_INTEL_PTWRITE
,
265 PERF_SYNTH_INTEL_MWAIT
,
266 PERF_SYNTH_INTEL_PWRE
,
267 PERF_SYNTH_INTEL_EXSTOP
,
268 PERF_SYNTH_INTEL_PWRX
,
269 PERF_SYNTH_INTEL_CBR
,
273 * Raw data formats for synthesized events. Note that 4 bytes of padding are
274 * present to match the 'size' member of PERF_SAMPLE_RAW data which is always
275 * 8-byte aligned. That means we must dereference raw_data with an offset of 4.
276 * Refer perf_sample__synth_ptr() and perf_synth__raw_data(). It also means the
277 * structure sizes are 4 bytes bigger than the raw_size, refer
278 * perf_synth__raw_size().
281 struct perf_synth_intel_ptwrite
{
293 struct perf_synth_intel_mwait
{
307 struct perf_synth_intel_pwre
{
322 struct perf_synth_intel_exstop
{
333 struct perf_synth_intel_pwrx
{
338 u64 deepest_cstate
: 4,
347 struct perf_synth_intel_cbr
{
363 * raw_data is always 4 bytes from an 8-byte boundary, so subtract 4 to get
366 static inline void *perf_sample__synth_ptr(struct perf_sample
*sample
)
368 return sample
->raw_data
- 4;
371 static inline void *perf_synth__raw_data(void *p
)
376 #define perf_synth__raw_size(d) (sizeof(d) - 4)
378 #define perf_sample__bad_synth_size(s, d) ((s)->raw_size < sizeof(d) - 4)
381 * The kernel collects the number of events it couldn't send in a stretch and
382 * when possible sends this number in a PERF_RECORD_LOST event. The number of
383 * such "chunks" of lost events is stored in .nr_events[PERF_EVENT_LOST] while
384 * total_lost tells exactly how many events the kernel in fact lost, i.e. it is
385 * the sum of all struct lost_event.lost fields reported.
387 * The kernel discards mixed up samples and sends the number in a
388 * PERF_RECORD_LOST_SAMPLES event. The number of lost-samples events is stored
389 * in .nr_events[PERF_RECORD_LOST_SAMPLES] while total_lost_samples tells
390 * exactly how many samples the kernel in fact dropped, i.e. it is the sum of
391 * all struct lost_samples_event.lost fields reported.
393 * The total_period is needed because by default auto-freq is used, so
394 * multipling nr_events[PERF_EVENT_SAMPLE] by a frequency isn't possible to get
395 * the total number of low level events, it is necessary to to sum all struct
396 * sample_event.period and stash the result in total_period.
398 struct events_stats
{
400 u64 total_non_filtered_period
;
402 u64 total_lost_samples
;
404 u64 total_aux_partial
;
405 u64 total_invalid_chains
;
406 u32 nr_events
[PERF_RECORD_HEADER_MAX
];
407 u32 nr_non_filtered_samples
;
409 u32 nr_unknown_events
;
410 u32 nr_invalid_chains
;
412 u32 nr_unprocessable_samples
;
413 u32 nr_auxtrace_errors
[PERF_AUXTRACE_ERROR_MAX
];
414 u32 nr_proc_map_timeout
;
418 PERF_CPU_MAP__CPUS
= 0,
419 PERF_CPU_MAP__MASK
= 1,
422 struct cpu_map_entries
{
427 struct cpu_map_mask
{
430 unsigned long mask
[];
433 struct cpu_map_data
{
438 struct cpu_map_event
{
439 struct perf_event_header header
;
440 struct cpu_map_data data
;
444 struct perf_event_header header
;
445 struct perf_event_attr attr
;
450 PERF_EVENT_UPDATE__UNIT
= 0,
451 PERF_EVENT_UPDATE__SCALE
= 1,
452 PERF_EVENT_UPDATE__NAME
= 2,
453 PERF_EVENT_UPDATE__CPUS
= 3,
456 struct event_update_event_cpus
{
457 struct cpu_map_data cpus
;
460 struct event_update_event_scale
{
464 struct event_update_event
{
465 struct perf_event_header header
;
472 #define MAX_EVENT_NAME 64
474 struct perf_trace_event_type
{
476 char name
[MAX_EVENT_NAME
];
479 struct event_type_event
{
480 struct perf_event_header header
;
481 struct perf_trace_event_type event_type
;
484 struct tracing_data_event
{
485 struct perf_event_header header
;
489 struct id_index_entry
{
496 struct id_index_event
{
497 struct perf_event_header header
;
499 struct id_index_entry entries
[0];
502 struct auxtrace_info_event
{
503 struct perf_event_header header
;
505 u32 reserved__
; /* For alignment */
509 struct auxtrace_event
{
510 struct perf_event_header header
;
517 u32 reserved__
; /* For alignment */
520 #define MAX_AUXTRACE_ERROR_MSG 64
522 struct auxtrace_error_event
{
523 struct perf_event_header header
;
529 u32 reserved__
; /* For alignment */
531 char msg
[MAX_AUXTRACE_ERROR_MSG
];
535 struct perf_event_header header
;
541 struct itrace_start_event
{
542 struct perf_event_header header
;
546 struct context_switch_event
{
547 struct perf_event_header header
;
552 struct thread_map_event_entry
{
557 struct thread_map_event
{
558 struct perf_event_header header
;
560 struct thread_map_event_entry entries
[];
564 PERF_STAT_CONFIG_TERM__AGGR_MODE
= 0,
565 PERF_STAT_CONFIG_TERM__INTERVAL
= 1,
566 PERF_STAT_CONFIG_TERM__SCALE
= 2,
567 PERF_STAT_CONFIG_TERM__MAX
= 3,
570 struct stat_config_event_entry
{
575 struct stat_config_event
{
576 struct perf_event_header header
;
578 struct stat_config_event_entry data
[];
582 struct perf_event_header header
;
599 PERF_STAT_ROUND_TYPE__INTERVAL
= 0,
600 PERF_STAT_ROUND_TYPE__FINAL
= 1,
603 struct stat_round_event
{
604 struct perf_event_header header
;
609 struct time_conv_event
{
610 struct perf_event_header header
;
616 struct feature_event
{
617 struct perf_event_header header
;
623 struct perf_event_header header
;
624 struct mmap_event mmap
;
625 struct mmap2_event mmap2
;
626 struct comm_event comm
;
627 struct namespaces_event namespaces
;
628 struct fork_event fork
;
629 struct lost_event lost
;
630 struct lost_samples_event lost_samples
;
631 struct read_event read
;
632 struct throttle_event throttle
;
633 struct sample_event sample
;
634 struct attr_event attr
;
635 struct event_update_event event_update
;
636 struct event_type_event event_type
;
637 struct tracing_data_event tracing_data
;
638 struct build_id_event build_id
;
639 struct id_index_event id_index
;
640 struct auxtrace_info_event auxtrace_info
;
641 struct auxtrace_event auxtrace
;
642 struct auxtrace_error_event auxtrace_error
;
643 struct aux_event aux
;
644 struct itrace_start_event itrace_start
;
645 struct context_switch_event context_switch
;
646 struct thread_map_event thread_map
;
647 struct cpu_map_event cpu_map
;
648 struct stat_config_event stat_config
;
649 struct stat_event stat
;
650 struct stat_round_event stat_round
;
651 struct time_conv_event time_conv
;
652 struct feature_event feat
;
655 void perf_event__print_totals(void);
660 struct perf_stat_config
;
661 struct perf_counts_values
;
663 typedef int (*perf_event__handler_t
)(struct perf_tool
*tool
,
664 union perf_event
*event
,
665 struct perf_sample
*sample
,
666 struct machine
*machine
);
668 int perf_event__synthesize_thread_map(struct perf_tool
*tool
,
669 struct thread_map
*threads
,
670 perf_event__handler_t process
,
671 struct machine
*machine
, bool mmap_data
,
672 unsigned int proc_map_timeout
);
673 int perf_event__synthesize_thread_map2(struct perf_tool
*tool
,
674 struct thread_map
*threads
,
675 perf_event__handler_t process
,
676 struct machine
*machine
);
677 int perf_event__synthesize_cpu_map(struct perf_tool
*tool
,
678 struct cpu_map
*cpus
,
679 perf_event__handler_t process
,
680 struct machine
*machine
);
681 int perf_event__synthesize_threads(struct perf_tool
*tool
,
682 perf_event__handler_t process
,
683 struct machine
*machine
, bool mmap_data
,
684 unsigned int proc_map_timeout
);
685 int perf_event__synthesize_kernel_mmap(struct perf_tool
*tool
,
686 perf_event__handler_t process
,
687 struct machine
*machine
);
688 int perf_event__synthesize_stat_config(struct perf_tool
*tool
,
689 struct perf_stat_config
*config
,
690 perf_event__handler_t process
,
691 struct machine
*machine
);
692 void perf_event__read_stat_config(struct perf_stat_config
*config
,
693 struct stat_config_event
*event
);
694 int perf_event__synthesize_stat(struct perf_tool
*tool
,
695 u32 cpu
, u32 thread
, u64 id
,
696 struct perf_counts_values
*count
,
697 perf_event__handler_t process
,
698 struct machine
*machine
);
699 int perf_event__synthesize_stat_round(struct perf_tool
*tool
,
701 perf_event__handler_t process
,
702 struct machine
*machine
);
703 int perf_event__synthesize_modules(struct perf_tool
*tool
,
704 perf_event__handler_t process
,
705 struct machine
*machine
);
707 int perf_event__process_comm(struct perf_tool
*tool
,
708 union perf_event
*event
,
709 struct perf_sample
*sample
,
710 struct machine
*machine
);
711 int perf_event__process_lost(struct perf_tool
*tool
,
712 union perf_event
*event
,
713 struct perf_sample
*sample
,
714 struct machine
*machine
);
715 int perf_event__process_lost_samples(struct perf_tool
*tool
,
716 union perf_event
*event
,
717 struct perf_sample
*sample
,
718 struct machine
*machine
);
719 int perf_event__process_aux(struct perf_tool
*tool
,
720 union perf_event
*event
,
721 struct perf_sample
*sample
,
722 struct machine
*machine
);
723 int perf_event__process_itrace_start(struct perf_tool
*tool
,
724 union perf_event
*event
,
725 struct perf_sample
*sample
,
726 struct machine
*machine
);
727 int perf_event__process_switch(struct perf_tool
*tool
,
728 union perf_event
*event
,
729 struct perf_sample
*sample
,
730 struct machine
*machine
);
731 int perf_event__process_namespaces(struct perf_tool
*tool
,
732 union perf_event
*event
,
733 struct perf_sample
*sample
,
734 struct machine
*machine
);
735 int perf_event__process_mmap(struct perf_tool
*tool
,
736 union perf_event
*event
,
737 struct perf_sample
*sample
,
738 struct machine
*machine
);
739 int perf_event__process_mmap2(struct perf_tool
*tool
,
740 union perf_event
*event
,
741 struct perf_sample
*sample
,
742 struct machine
*machine
);
743 int perf_event__process_fork(struct perf_tool
*tool
,
744 union perf_event
*event
,
745 struct perf_sample
*sample
,
746 struct machine
*machine
);
747 int perf_event__process_exit(struct perf_tool
*tool
,
748 union perf_event
*event
,
749 struct perf_sample
*sample
,
750 struct machine
*machine
);
751 int perf_event__process(struct perf_tool
*tool
,
752 union perf_event
*event
,
753 struct perf_sample
*sample
,
754 struct machine
*machine
);
756 struct addr_location
;
758 int machine__resolve(struct machine
*machine
, struct addr_location
*al
,
759 struct perf_sample
*sample
);
761 void addr_location__put(struct addr_location
*al
);
765 bool is_bts_event(struct perf_event_attr
*attr
);
766 bool sample_addr_correlates_sym(struct perf_event_attr
*attr
);
767 void thread__resolve(struct thread
*thread
, struct addr_location
*al
,
768 struct perf_sample
*sample
);
770 const char *perf_event__name(unsigned int id
);
772 size_t perf_event__sample_event_size(const struct perf_sample
*sample
, u64 type
,
774 int perf_event__synthesize_sample(union perf_event
*event
, u64 type
,
776 const struct perf_sample
*sample
,
779 pid_t
perf_event__synthesize_comm(struct perf_tool
*tool
,
780 union perf_event
*event
, pid_t pid
,
781 perf_event__handler_t process
,
782 struct machine
*machine
);
784 int perf_event__synthesize_namespaces(struct perf_tool
*tool
,
785 union perf_event
*event
,
786 pid_t pid
, pid_t tgid
,
787 perf_event__handler_t process
,
788 struct machine
*machine
);
790 int perf_event__synthesize_mmap_events(struct perf_tool
*tool
,
791 union perf_event
*event
,
792 pid_t pid
, pid_t tgid
,
793 perf_event__handler_t process
,
794 struct machine
*machine
,
796 unsigned int proc_map_timeout
);
798 size_t perf_event__fprintf_comm(union perf_event
*event
, FILE *fp
);
799 size_t perf_event__fprintf_mmap(union perf_event
*event
, FILE *fp
);
800 size_t perf_event__fprintf_mmap2(union perf_event
*event
, FILE *fp
);
801 size_t perf_event__fprintf_task(union perf_event
*event
, FILE *fp
);
802 size_t perf_event__fprintf_aux(union perf_event
*event
, FILE *fp
);
803 size_t perf_event__fprintf_itrace_start(union perf_event
*event
, FILE *fp
);
804 size_t perf_event__fprintf_switch(union perf_event
*event
, FILE *fp
);
805 size_t perf_event__fprintf_thread_map(union perf_event
*event
, FILE *fp
);
806 size_t perf_event__fprintf_cpu_map(union perf_event
*event
, FILE *fp
);
807 size_t perf_event__fprintf_namespaces(union perf_event
*event
, FILE *fp
);
808 size_t perf_event__fprintf(union perf_event
*event
, FILE *fp
);
810 int kallsyms__get_function_start(const char *kallsyms_filename
,
811 const char *symbol_name
, u64
*addr
);
813 void *cpu_map_data__alloc(struct cpu_map
*map
, size_t *size
, u16
*type
, int *max
);
814 void cpu_map_data__synthesize(struct cpu_map_data
*data
, struct cpu_map
*map
,
817 void event_attr_init(struct perf_event_attr
*attr
);
819 int perf_event_paranoid(void);
821 extern int sysctl_perf_event_max_stack
;
822 extern int sysctl_perf_event_max_contexts_per_stack
;
824 #endif /* __PERF_RECORD_H */