1 /* SPDX-License-Identifier: GPL-2.0 */
2 #ifndef __PERF_RECORD_H
3 #define __PERF_RECORD_H
7 #include <linux/kernel.h>
9 #include <linux/perf_event.h>
13 #include "perf_regs.h"
16 struct perf_event_header header;
21 char filename[PATH_MAX];
25 struct perf_event_header header;
36 char filename[PATH_MAX];
40 struct perf_event_header header;
45 struct namespaces_event {
46 struct perf_event_header header;
49 struct perf_ns_link_info link_info[];
53 struct perf_event_header header;
60 struct perf_event_header header;
65 struct lost_samples_event {
66 struct perf_event_header header;
71 * PERF_FORMAT_ENABLED | PERF_FORMAT_RUNNING | PERF_FORMAT_ID
74 struct perf_event_header header;
82 struct throttle_event {
83 struct perf_event_header header;
90 #define KSYM_NAME_LEN 256
93 struct ksymbol_event {
94 struct perf_event_header header;
99 char name[KSYM_NAME_LEN];
103 struct perf_event_header header;
108 /* for bpf_prog types */
109 u8 tag[BPF_TAG_SIZE]; // prog tag
112 #define PERF_SAMPLE_MASK \
113 (PERF_SAMPLE_IP | PERF_SAMPLE_TID | \
114 PERF_SAMPLE_TIME | PERF_SAMPLE_ADDR | \
115 PERF_SAMPLE_ID | PERF_SAMPLE_STREAM_ID | \
116 PERF_SAMPLE_CPU | PERF_SAMPLE_PERIOD | \
117 PERF_SAMPLE_IDENTIFIER)
119 /* perf sample has 16 bits size limit */
120 #define PERF_SAMPLE_MAX_SIZE (1 << 16)
122 struct sample_event {
123 struct perf_event_header header;
132 /* Cached values/mask filled by first register access. */
133 u64 cache_regs[PERF_REGS_MAX];
143 struct sample_read_value {
154 struct sample_read_value *values;
156 struct sample_read_value one;
160 struct ip_callchain {
168 PERF_IP_FLAG_BRANCH = 1ULL << 0,
169 PERF_IP_FLAG_CALL = 1ULL << 1,
170 PERF_IP_FLAG_RETURN = 1ULL << 2,
171 PERF_IP_FLAG_CONDITIONAL = 1ULL << 3,
172 PERF_IP_FLAG_SYSCALLRET = 1ULL << 4,
173 PERF_IP_FLAG_ASYNC = 1ULL << 5,
174 PERF_IP_FLAG_INTERRUPT = 1ULL << 6,
175 PERF_IP_FLAG_TX_ABORT = 1ULL << 7,
176 PERF_IP_FLAG_TRACE_BEGIN = 1ULL << 8,
177 PERF_IP_FLAG_TRACE_END = 1ULL << 9,
178 PERF_IP_FLAG_IN_TX = 1ULL << 10,
181 #define PERF_IP_FLAG_CHARS "bcrosyiABEx"
183 #define PERF_BRANCH_MASK (\
184 PERF_IP_FLAG_BRANCH |\
186 PERF_IP_FLAG_RETURN |\
187 PERF_IP_FLAG_CONDITIONAL |\
188 PERF_IP_FLAG_SYSCALLRET |\
189 PERF_IP_FLAG_ASYNC |\
190 PERF_IP_FLAG_INTERRUPT |\
191 PERF_IP_FLAG_TX_ABORT |\
192 PERF_IP_FLAG_TRACE_BEGIN |\
193 PERF_IP_FLAG_TRACE_END)
217 struct ip_callchain *callchain;
218 struct branch_stack *branch_stack;
219 struct regs_dump user_regs;
220 struct regs_dump intr_regs;
221 struct stack_dump user_stack;
222 struct sample_read read;
225 #define PERF_MEM_DATA_SRC_NONE \
226 (PERF_MEM_S(OP, NA) |\
227 PERF_MEM_S(LVL, NA) |\
228 PERF_MEM_S(SNOOP, NA) |\
229 PERF_MEM_S(LOCK, NA) |\
232 struct build_id_event {
233 struct perf_event_header header;
235 u8 build_id[PERF_ALIGN(BUILD_ID_SIZE, sizeof(u64))];
239 enum perf_user_event_type { /* above any possible kernel type */
240 PERF_RECORD_USER_TYPE_START = 64,
241 PERF_RECORD_HEADER_ATTR = 64,
242 PERF_RECORD_HEADER_EVENT_TYPE = 65, /* deprecated */
243 PERF_RECORD_HEADER_TRACING_DATA = 66,
244 PERF_RECORD_HEADER_BUILD_ID = 67,
245 PERF_RECORD_FINISHED_ROUND = 68,
246 PERF_RECORD_ID_INDEX = 69,
247 PERF_RECORD_AUXTRACE_INFO = 70,
248 PERF_RECORD_AUXTRACE = 71,
249 PERF_RECORD_AUXTRACE_ERROR = 72,
250 PERF_RECORD_THREAD_MAP = 73,
251 PERF_RECORD_CPU_MAP = 74,
252 PERF_RECORD_STAT_CONFIG = 75,
253 PERF_RECORD_STAT = 76,
254 PERF_RECORD_STAT_ROUND = 77,
255 PERF_RECORD_EVENT_UPDATE = 78,
256 PERF_RECORD_TIME_CONV = 79,
257 PERF_RECORD_HEADER_FEATURE = 80,
258 PERF_RECORD_COMPRESSED = 81,
259 PERF_RECORD_HEADER_MAX
262 enum auxtrace_error_type {
263 PERF_AUXTRACE_ERROR_ITRACE = 1,
264 PERF_AUXTRACE_ERROR_MAX
267 /* Attribute type for custom synthesized events */
268 #define PERF_TYPE_SYNTH (INT_MAX + 1U)
270 /* Attribute config for custom synthesized events */
272 PERF_SYNTH_INTEL_PTWRITE,
273 PERF_SYNTH_INTEL_MWAIT,
274 PERF_SYNTH_INTEL_PWRE,
275 PERF_SYNTH_INTEL_EXSTOP,
276 PERF_SYNTH_INTEL_PWRX,
277 PERF_SYNTH_INTEL_CBR,
281 * Raw data formats for synthesized events. Note that 4 bytes of padding are
282 * present to match the 'size' member of PERF_SAMPLE_RAW data which is always
283 * 8-byte aligned. That means we must dereference raw_data with an offset of 4.
284 * Refer perf_sample__synth_ptr() and perf_synth__raw_data(). It also means the
285 * structure sizes are 4 bytes bigger than the raw_size, refer
286 * perf_synth__raw_size().
289 struct perf_synth_intel_ptwrite {
301 struct perf_synth_intel_mwait {
315 struct perf_synth_intel_pwre {
330 struct perf_synth_intel_exstop {
341 struct perf_synth_intel_pwrx {
346 u64 deepest_cstate : 4,
355 struct perf_synth_intel_cbr {
371 * raw_data is always 4 bytes from an 8-byte boundary, so subtract 4 to get
374 static inline void *perf_sample__synth_ptr(struct perf_sample *sample)
376 return sample->raw_data - 4;
379 static inline void *perf_synth__raw_data(void *p)
384 #define perf_synth__raw_size(d) (sizeof(d) - 4)
386 #define perf_sample__bad_synth_size(s, d) ((s)->raw_size < sizeof(d) - 4)
389 * The kernel collects the number of events it couldn't send in a stretch and
390 * when possible sends this number in a PERF_RECORD_LOST event. The number of
391 * such "chunks" of lost events is stored in .nr_events[PERF_EVENT_LOST] while
392 * total_lost tells exactly how many events the kernel in fact lost, i.e. it is
393 * the sum of all struct lost_event.lost fields reported.
395 * The kernel discards mixed up samples and sends the number in a
396 * PERF_RECORD_LOST_SAMPLES event. The number of lost-samples events is stored
397 * in .nr_events[PERF_RECORD_LOST_SAMPLES] while total_lost_samples tells
398 * exactly how many samples the kernel in fact dropped, i.e. it is the sum of
399 * all struct lost_samples_event.lost fields reported.
401 * The total_period is needed because by default auto-freq is used, so
402 * multipling nr_events[PERF_EVENT_SAMPLE] by a frequency isn't possible to get
403 * the total number of low level events, it is necessary to to sum all struct
404 * sample_event.period and stash the result in total_period.
406 struct events_stats {
408 u64 total_non_filtered_period;
410 u64 total_lost_samples;
412 u64 total_aux_partial;
413 u64 total_invalid_chains;
414 u32 nr_events[PERF_RECORD_HEADER_MAX];
415 u32 nr_non_filtered_samples;
417 u32 nr_unknown_events;
418 u32 nr_invalid_chains;
420 u32 nr_unprocessable_samples;
421 u32 nr_auxtrace_errors[PERF_AUXTRACE_ERROR_MAX];
422 u32 nr_proc_map_timeout;
426 PERF_CPU_MAP__CPUS = 0,
427 PERF_CPU_MAP__MASK = 1,
430 struct cpu_map_entries {
435 struct cpu_map_mask {
438 unsigned long mask[];
441 struct cpu_map_data {
446 struct cpu_map_event {
447 struct perf_event_header header;
448 struct cpu_map_data data;
452 struct perf_event_header header;
453 struct perf_event_attr attr;
458 PERF_EVENT_UPDATE__UNIT = 0,
459 PERF_EVENT_UPDATE__SCALE = 1,
460 PERF_EVENT_UPDATE__NAME = 2,
461 PERF_EVENT_UPDATE__CPUS = 3,
464 struct event_update_event_cpus {
465 struct cpu_map_data cpus;
468 struct event_update_event_scale {
472 struct event_update_event {
473 struct perf_event_header header;
480 #define MAX_EVENT_NAME 64
482 struct perf_trace_event_type {
484 char name[MAX_EVENT_NAME];
487 struct event_type_event {
488 struct perf_event_header header;
489 struct perf_trace_event_type event_type;
492 struct tracing_data_event {
493 struct perf_event_header header;
497 struct id_index_entry {
504 struct id_index_event {
505 struct perf_event_header header;
507 struct id_index_entry entries[0];
510 struct auxtrace_info_event {
511 struct perf_event_header header;
513 u32 reserved__; /* For alignment */
517 struct auxtrace_event {
518 struct perf_event_header header;
525 u32 reserved__; /* For alignment */
528 #define MAX_AUXTRACE_ERROR_MSG 64
530 struct auxtrace_error_event {
531 struct perf_event_header header;
540 char msg[MAX_AUXTRACE_ERROR_MSG];
544 struct perf_event_header header;
550 struct itrace_start_event {
551 struct perf_event_header header;
555 struct context_switch_event {
556 struct perf_event_header header;
561 struct thread_map_event_entry {
566 struct thread_map_event {
567 struct perf_event_header header;
569 struct thread_map_event_entry entries[];
573 PERF_STAT_CONFIG_TERM__AGGR_MODE = 0,
574 PERF_STAT_CONFIG_TERM__INTERVAL = 1,
575 PERF_STAT_CONFIG_TERM__SCALE = 2,
576 PERF_STAT_CONFIG_TERM__MAX = 3,
579 struct stat_config_event_entry {
584 struct stat_config_event {
585 struct perf_event_header header;
587 struct stat_config_event_entry data[];
591 struct perf_event_header header;
608 PERF_STAT_ROUND_TYPE__INTERVAL = 0,
609 PERF_STAT_ROUND_TYPE__FINAL = 1,
612 struct stat_round_event {
613 struct perf_event_header header;
618 struct time_conv_event {
619 struct perf_event_header header;
625 struct feature_event {
626 struct perf_event_header header;
631 struct compressed_event {
632 struct perf_event_header header;
637 struct perf_event_header header;
638 struct mmap_event mmap;
639 struct mmap2_event mmap2;
640 struct comm_event comm;
641 struct namespaces_event namespaces;
642 struct fork_event fork;
643 struct lost_event lost;
644 struct lost_samples_event lost_samples;
645 struct read_event read;
646 struct throttle_event throttle;
647 struct sample_event sample;
648 struct attr_event attr;
649 struct event_update_event event_update;
650 struct event_type_event event_type;
651 struct tracing_data_event tracing_data;
652 struct build_id_event build_id;
653 struct id_index_event id_index;
654 struct auxtrace_info_event auxtrace_info;
655 struct auxtrace_event auxtrace;
656 struct auxtrace_error_event auxtrace_error;
657 struct aux_event aux;
658 struct itrace_start_event itrace_start;
659 struct context_switch_event context_switch;
660 struct thread_map_event thread_map;
661 struct cpu_map_event cpu_map;
662 struct stat_config_event stat_config;
663 struct stat_event stat;
664 struct stat_round_event stat_round;
665 struct time_conv_event time_conv;
666 struct feature_event feat;
667 struct ksymbol_event ksymbol_event;
668 struct bpf_event bpf_event;
669 struct compressed_event pack;
672 void perf_event__print_totals(void);
677 struct perf_stat_config;
678 struct perf_counts_values;
680 typedef int (*perf_event__handler_t)(struct perf_tool *tool,
681 union perf_event *event,
682 struct perf_sample *sample,
683 struct machine *machine);
685 int perf_event__synthesize_thread_map(struct perf_tool *tool,
686 struct thread_map *threads,
687 perf_event__handler_t process,
688 struct machine *machine, bool mmap_data);
689 int perf_event__synthesize_thread_map2(struct perf_tool *tool,
690 struct thread_map *threads,
691 perf_event__handler_t process,
692 struct machine *machine);
693 int perf_event__synthesize_cpu_map(struct perf_tool *tool,
694 struct cpu_map *cpus,
695 perf_event__handler_t process,
696 struct machine *machine);
697 int perf_event__synthesize_threads(struct perf_tool *tool,
698 perf_event__handler_t process,
699 struct machine *machine, bool mmap_data,
700 unsigned int nr_threads_synthesize);
701 int perf_event__synthesize_kernel_mmap(struct perf_tool *tool,
702 perf_event__handler_t process,
703 struct machine *machine);
704 int perf_event__synthesize_stat_config(struct perf_tool *tool,
705 struct perf_stat_config *config,
706 perf_event__handler_t process,
707 struct machine *machine);
708 void perf_event__read_stat_config(struct perf_stat_config *config,
709 struct stat_config_event *event);
710 int perf_event__synthesize_stat(struct perf_tool *tool,
711 u32 cpu, u32 thread, u64 id,
712 struct perf_counts_values *count,
713 perf_event__handler_t process,
714 struct machine *machine);
715 int perf_event__synthesize_stat_round(struct perf_tool *tool,
717 perf_event__handler_t process,
718 struct machine *machine);
719 int perf_event__synthesize_modules(struct perf_tool *tool,
720 perf_event__handler_t process,
721 struct machine *machine);
723 int perf_event__process_comm(struct perf_tool *tool,
724 union perf_event *event,
725 struct perf_sample *sample,
726 struct machine *machine);
727 int perf_event__process_lost(struct perf_tool *tool,
728 union perf_event *event,
729 struct perf_sample *sample,
730 struct machine *machine);
731 int perf_event__process_lost_samples(struct perf_tool *tool,
732 union perf_event *event,
733 struct perf_sample *sample,
734 struct machine *machine);
735 int perf_event__process_aux(struct perf_tool *tool,
736 union perf_event *event,
737 struct perf_sample *sample,
738 struct machine *machine);
739 int perf_event__process_itrace_start(struct perf_tool *tool,
740 union perf_event *event,
741 struct perf_sample *sample,
742 struct machine *machine);
743 int perf_event__process_switch(struct perf_tool *tool,
744 union perf_event *event,
745 struct perf_sample *sample,
746 struct machine *machine);
747 int perf_event__process_namespaces(struct perf_tool *tool,
748 union perf_event *event,
749 struct perf_sample *sample,
750 struct machine *machine);
751 int perf_event__process_mmap(struct perf_tool *tool,
752 union perf_event *event,
753 struct perf_sample *sample,
754 struct machine *machine);
755 int perf_event__process_mmap2(struct perf_tool *tool,
756 union perf_event *event,
757 struct perf_sample *sample,
758 struct machine *machine);
759 int perf_event__process_fork(struct perf_tool *tool,
760 union perf_event *event,
761 struct perf_sample *sample,
762 struct machine *machine);
763 int perf_event__process_exit(struct perf_tool *tool,
764 union perf_event *event,
765 struct perf_sample *sample,
766 struct machine *machine);
767 int perf_event__process_ksymbol(struct perf_tool *tool,
768 union perf_event *event,
769 struct perf_sample *sample,
770 struct machine *machine);
771 int perf_event__process_bpf_event(struct perf_tool *tool,
772 union perf_event *event,
773 struct perf_sample *sample,
774 struct machine *machine);
775 int perf_tool__process_synth_event(struct perf_tool *tool,
776 union perf_event *event,
777 struct machine *machine,
778 perf_event__handler_t process);
779 int perf_event__process(struct perf_tool *tool,
780 union perf_event *event,
781 struct perf_sample *sample,
782 struct machine *machine);
784 struct addr_location;
786 int machine__resolve(struct machine *machine, struct addr_location *al,
787 struct perf_sample *sample);
789 void addr_location__put(struct addr_location *al);
793 bool is_bts_event(struct perf_event_attr *attr);
794 bool sample_addr_correlates_sym(struct perf_event_attr *attr);
795 void thread__resolve(struct thread *thread, struct addr_location *al,
796 struct perf_sample *sample);
798 const char *perf_event__name(unsigned int id);
800 size_t perf_event__sample_event_size(const struct perf_sample *sample, u64 type,
802 int perf_event__synthesize_sample(union perf_event *event, u64 type,
804 const struct perf_sample *sample);
806 pid_t perf_event__synthesize_comm(struct perf_tool *tool,
807 union perf_event *event, pid_t pid,
808 perf_event__handler_t process,
809 struct machine *machine);
811 int perf_event__synthesize_namespaces(struct perf_tool *tool,
812 union perf_event *event,
813 pid_t pid, pid_t tgid,
814 perf_event__handler_t process,
815 struct machine *machine);
817 int perf_event__synthesize_mmap_events(struct perf_tool *tool,
818 union perf_event *event,
819 pid_t pid, pid_t tgid,
820 perf_event__handler_t process,
821 struct machine *machine,
824 int perf_event__synthesize_extra_kmaps(struct perf_tool *tool,
825 perf_event__handler_t process,
826 struct machine *machine);
828 size_t perf_event__fprintf_comm(union perf_event *event, FILE *fp);
829 size_t perf_event__fprintf_mmap(union perf_event *event, FILE *fp);
830 size_t perf_event__fprintf_mmap2(union perf_event *event, FILE *fp);
831 size_t perf_event__fprintf_task(union perf_event *event, FILE *fp);
832 size_t perf_event__fprintf_aux(union perf_event *event, FILE *fp);
833 size_t perf_event__fprintf_itrace_start(union perf_event *event, FILE *fp);
834 size_t perf_event__fprintf_switch(union perf_event *event, FILE *fp);
835 size_t perf_event__fprintf_thread_map(union perf_event *event, FILE *fp);
836 size_t perf_event__fprintf_cpu_map(union perf_event *event, FILE *fp);
837 size_t perf_event__fprintf_namespaces(union perf_event *event, FILE *fp);
838 size_t perf_event__fprintf_ksymbol(union perf_event *event, FILE *fp);
839 size_t perf_event__fprintf_bpf_event(union perf_event *event, FILE *fp);
840 size_t perf_event__fprintf(union perf_event *event, FILE *fp);
842 int kallsyms__get_function_start(const char *kallsyms_filename,
843 const char *symbol_name, u64 *addr);
845 void *cpu_map_data__alloc(struct cpu_map *map, size_t *size, u16 *type, int *max);
846 void cpu_map_data__synthesize(struct cpu_map_data *data, struct cpu_map *map,
849 void event_attr_init(struct perf_event_attr *attr);
851 int perf_event_paranoid(void);
853 extern int sysctl_perf_event_max_stack;
854 extern int sysctl_perf_event_max_contexts_per_stack;
855 extern unsigned int proc_map_timeout;
857 #endif /* __PERF_RECORD_H */