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)
219 struct ip_callchain *callchain;
220 struct branch_stack *branch_stack;
221 struct regs_dump user_regs;
222 struct regs_dump intr_regs;
223 struct stack_dump user_stack;
224 struct sample_read read;
227 #define PERF_MEM_DATA_SRC_NONE \
228 (PERF_MEM_S(OP, NA) |\
229 PERF_MEM_S(LVL, NA) |\
230 PERF_MEM_S(SNOOP, NA) |\
231 PERF_MEM_S(LOCK, NA) |\
234 struct build_id_event {
235 struct perf_event_header header;
237 u8 build_id[PERF_ALIGN(BUILD_ID_SIZE, sizeof(u64))];
241 enum perf_user_event_type { /* above any possible kernel type */
242 PERF_RECORD_USER_TYPE_START = 64,
243 PERF_RECORD_HEADER_ATTR = 64,
244 PERF_RECORD_HEADER_EVENT_TYPE = 65, /* deprecated */
245 PERF_RECORD_HEADER_TRACING_DATA = 66,
246 PERF_RECORD_HEADER_BUILD_ID = 67,
247 PERF_RECORD_FINISHED_ROUND = 68,
248 PERF_RECORD_ID_INDEX = 69,
249 PERF_RECORD_AUXTRACE_INFO = 70,
250 PERF_RECORD_AUXTRACE = 71,
251 PERF_RECORD_AUXTRACE_ERROR = 72,
252 PERF_RECORD_THREAD_MAP = 73,
253 PERF_RECORD_CPU_MAP = 74,
254 PERF_RECORD_STAT_CONFIG = 75,
255 PERF_RECORD_STAT = 76,
256 PERF_RECORD_STAT_ROUND = 77,
257 PERF_RECORD_EVENT_UPDATE = 78,
258 PERF_RECORD_TIME_CONV = 79,
259 PERF_RECORD_HEADER_FEATURE = 80,
260 PERF_RECORD_COMPRESSED = 81,
261 PERF_RECORD_HEADER_MAX
264 enum auxtrace_error_type {
265 PERF_AUXTRACE_ERROR_ITRACE = 1,
266 PERF_AUXTRACE_ERROR_MAX
269 /* Attribute type for custom synthesized events */
270 #define PERF_TYPE_SYNTH (INT_MAX + 1U)
272 /* Attribute config for custom synthesized events */
274 PERF_SYNTH_INTEL_PTWRITE,
275 PERF_SYNTH_INTEL_MWAIT,
276 PERF_SYNTH_INTEL_PWRE,
277 PERF_SYNTH_INTEL_EXSTOP,
278 PERF_SYNTH_INTEL_PWRX,
279 PERF_SYNTH_INTEL_CBR,
283 * Raw data formats for synthesized events. Note that 4 bytes of padding are
284 * present to match the 'size' member of PERF_SAMPLE_RAW data which is always
285 * 8-byte aligned. That means we must dereference raw_data with an offset of 4.
286 * Refer perf_sample__synth_ptr() and perf_synth__raw_data(). It also means the
287 * structure sizes are 4 bytes bigger than the raw_size, refer
288 * perf_synth__raw_size().
291 struct perf_synth_intel_ptwrite {
303 struct perf_synth_intel_mwait {
317 struct perf_synth_intel_pwre {
332 struct perf_synth_intel_exstop {
343 struct perf_synth_intel_pwrx {
348 u64 deepest_cstate : 4,
357 struct perf_synth_intel_cbr {
373 * raw_data is always 4 bytes from an 8-byte boundary, so subtract 4 to get
376 static inline void *perf_sample__synth_ptr(struct perf_sample *sample)
378 return sample->raw_data - 4;
381 static inline void *perf_synth__raw_data(void *p)
386 #define perf_synth__raw_size(d) (sizeof(d) - 4)
388 #define perf_sample__bad_synth_size(s, d) ((s)->raw_size < sizeof(d) - 4)
391 * The kernel collects the number of events it couldn't send in a stretch and
392 * when possible sends this number in a PERF_RECORD_LOST event. The number of
393 * such "chunks" of lost events is stored in .nr_events[PERF_EVENT_LOST] while
394 * total_lost tells exactly how many events the kernel in fact lost, i.e. it is
395 * the sum of all struct lost_event.lost fields reported.
397 * The kernel discards mixed up samples and sends the number in a
398 * PERF_RECORD_LOST_SAMPLES event. The number of lost-samples events is stored
399 * in .nr_events[PERF_RECORD_LOST_SAMPLES] while total_lost_samples tells
400 * exactly how many samples the kernel in fact dropped, i.e. it is the sum of
401 * all struct lost_samples_event.lost fields reported.
403 * The total_period is needed because by default auto-freq is used, so
404 * multipling nr_events[PERF_EVENT_SAMPLE] by a frequency isn't possible to get
405 * the total number of low level events, it is necessary to to sum all struct
406 * sample_event.period and stash the result in total_period.
408 struct events_stats {
410 u64 total_non_filtered_period;
412 u64 total_lost_samples;
414 u64 total_aux_partial;
415 u64 total_invalid_chains;
416 u32 nr_events[PERF_RECORD_HEADER_MAX];
417 u32 nr_non_filtered_samples;
419 u32 nr_unknown_events;
420 u32 nr_invalid_chains;
422 u32 nr_unprocessable_samples;
423 u32 nr_auxtrace_errors[PERF_AUXTRACE_ERROR_MAX];
424 u32 nr_proc_map_timeout;
428 PERF_CPU_MAP__CPUS = 0,
429 PERF_CPU_MAP__MASK = 1,
432 struct cpu_map_entries {
437 struct cpu_map_mask {
440 unsigned long mask[];
443 struct cpu_map_data {
448 struct cpu_map_event {
449 struct perf_event_header header;
450 struct cpu_map_data data;
454 struct perf_event_header header;
455 struct perf_event_attr attr;
460 PERF_EVENT_UPDATE__UNIT = 0,
461 PERF_EVENT_UPDATE__SCALE = 1,
462 PERF_EVENT_UPDATE__NAME = 2,
463 PERF_EVENT_UPDATE__CPUS = 3,
466 struct event_update_event_cpus {
467 struct cpu_map_data cpus;
470 struct event_update_event_scale {
474 struct event_update_event {
475 struct perf_event_header header;
482 #define MAX_EVENT_NAME 64
484 struct perf_trace_event_type {
486 char name[MAX_EVENT_NAME];
489 struct event_type_event {
490 struct perf_event_header header;
491 struct perf_trace_event_type event_type;
494 struct tracing_data_event {
495 struct perf_event_header header;
499 struct id_index_entry {
506 struct id_index_event {
507 struct perf_event_header header;
509 struct id_index_entry entries[0];
512 struct auxtrace_info_event {
513 struct perf_event_header header;
515 u32 reserved__; /* For alignment */
519 struct auxtrace_event {
520 struct perf_event_header header;
527 u32 reserved__; /* For alignment */
530 #define MAX_AUXTRACE_ERROR_MSG 64
532 struct auxtrace_error_event {
533 struct perf_event_header header;
542 char msg[MAX_AUXTRACE_ERROR_MSG];
546 struct perf_event_header header;
552 struct itrace_start_event {
553 struct perf_event_header header;
557 struct context_switch_event {
558 struct perf_event_header header;
563 struct thread_map_event_entry {
568 struct thread_map_event {
569 struct perf_event_header header;
571 struct thread_map_event_entry entries[];
575 PERF_STAT_CONFIG_TERM__AGGR_MODE = 0,
576 PERF_STAT_CONFIG_TERM__INTERVAL = 1,
577 PERF_STAT_CONFIG_TERM__SCALE = 2,
578 PERF_STAT_CONFIG_TERM__MAX = 3,
581 struct stat_config_event_entry {
586 struct stat_config_event {
587 struct perf_event_header header;
589 struct stat_config_event_entry data[];
593 struct perf_event_header header;
610 PERF_STAT_ROUND_TYPE__INTERVAL = 0,
611 PERF_STAT_ROUND_TYPE__FINAL = 1,
614 struct stat_round_event {
615 struct perf_event_header header;
620 struct time_conv_event {
621 struct perf_event_header header;
627 struct feature_event {
628 struct perf_event_header header;
633 struct compressed_event {
634 struct perf_event_header header;
639 struct perf_event_header header;
640 struct mmap_event mmap;
641 struct mmap2_event mmap2;
642 struct comm_event comm;
643 struct namespaces_event namespaces;
644 struct fork_event fork;
645 struct lost_event lost;
646 struct lost_samples_event lost_samples;
647 struct read_event read;
648 struct throttle_event throttle;
649 struct sample_event sample;
650 struct attr_event attr;
651 struct event_update_event event_update;
652 struct event_type_event event_type;
653 struct tracing_data_event tracing_data;
654 struct build_id_event build_id;
655 struct id_index_event id_index;
656 struct auxtrace_info_event auxtrace_info;
657 struct auxtrace_event auxtrace;
658 struct auxtrace_error_event auxtrace_error;
659 struct aux_event aux;
660 struct itrace_start_event itrace_start;
661 struct context_switch_event context_switch;
662 struct thread_map_event thread_map;
663 struct cpu_map_event cpu_map;
664 struct stat_config_event stat_config;
665 struct stat_event stat;
666 struct stat_round_event stat_round;
667 struct time_conv_event time_conv;
668 struct feature_event feat;
669 struct ksymbol_event ksymbol_event;
670 struct bpf_event bpf_event;
671 struct compressed_event pack;
674 void perf_event__print_totals(void);
679 struct perf_stat_config;
680 struct perf_counts_values;
682 typedef int (*perf_event__handler_t)(struct perf_tool *tool,
683 union perf_event *event,
684 struct perf_sample *sample,
685 struct machine *machine);
687 int perf_event__synthesize_thread_map(struct perf_tool *tool,
688 struct thread_map *threads,
689 perf_event__handler_t process,
690 struct machine *machine, bool mmap_data);
691 int perf_event__synthesize_thread_map2(struct perf_tool *tool,
692 struct thread_map *threads,
693 perf_event__handler_t process,
694 struct machine *machine);
695 int perf_event__synthesize_cpu_map(struct perf_tool *tool,
696 struct perf_cpu_map *cpus,
697 perf_event__handler_t process,
698 struct machine *machine);
699 int perf_event__synthesize_threads(struct perf_tool *tool,
700 perf_event__handler_t process,
701 struct machine *machine, bool mmap_data,
702 unsigned int nr_threads_synthesize);
703 int perf_event__synthesize_kernel_mmap(struct perf_tool *tool,
704 perf_event__handler_t process,
705 struct machine *machine);
706 int perf_event__synthesize_stat_config(struct perf_tool *tool,
707 struct perf_stat_config *config,
708 perf_event__handler_t process,
709 struct machine *machine);
710 void perf_event__read_stat_config(struct perf_stat_config *config,
711 struct stat_config_event *event);
712 int perf_event__synthesize_stat(struct perf_tool *tool,
713 u32 cpu, u32 thread, u64 id,
714 struct perf_counts_values *count,
715 perf_event__handler_t process,
716 struct machine *machine);
717 int perf_event__synthesize_stat_round(struct perf_tool *tool,
719 perf_event__handler_t process,
720 struct machine *machine);
721 int perf_event__synthesize_modules(struct perf_tool *tool,
722 perf_event__handler_t process,
723 struct machine *machine);
725 int perf_event__process_comm(struct perf_tool *tool,
726 union perf_event *event,
727 struct perf_sample *sample,
728 struct machine *machine);
729 int perf_event__process_lost(struct perf_tool *tool,
730 union perf_event *event,
731 struct perf_sample *sample,
732 struct machine *machine);
733 int perf_event__process_lost_samples(struct perf_tool *tool,
734 union perf_event *event,
735 struct perf_sample *sample,
736 struct machine *machine);
737 int perf_event__process_aux(struct perf_tool *tool,
738 union perf_event *event,
739 struct perf_sample *sample,
740 struct machine *machine);
741 int perf_event__process_itrace_start(struct perf_tool *tool,
742 union perf_event *event,
743 struct perf_sample *sample,
744 struct machine *machine);
745 int perf_event__process_switch(struct perf_tool *tool,
746 union perf_event *event,
747 struct perf_sample *sample,
748 struct machine *machine);
749 int perf_event__process_namespaces(struct perf_tool *tool,
750 union perf_event *event,
751 struct perf_sample *sample,
752 struct machine *machine);
753 int perf_event__process_mmap(struct perf_tool *tool,
754 union perf_event *event,
755 struct perf_sample *sample,
756 struct machine *machine);
757 int perf_event__process_mmap2(struct perf_tool *tool,
758 union perf_event *event,
759 struct perf_sample *sample,
760 struct machine *machine);
761 int perf_event__process_fork(struct perf_tool *tool,
762 union perf_event *event,
763 struct perf_sample *sample,
764 struct machine *machine);
765 int perf_event__process_exit(struct perf_tool *tool,
766 union perf_event *event,
767 struct perf_sample *sample,
768 struct machine *machine);
769 int perf_event__process_ksymbol(struct perf_tool *tool,
770 union perf_event *event,
771 struct perf_sample *sample,
772 struct machine *machine);
773 int perf_event__process_bpf_event(struct perf_tool *tool,
774 union perf_event *event,
775 struct perf_sample *sample,
776 struct machine *machine);
777 int perf_tool__process_synth_event(struct perf_tool *tool,
778 union perf_event *event,
779 struct machine *machine,
780 perf_event__handler_t process);
781 int perf_event__process(struct perf_tool *tool,
782 union perf_event *event,
783 struct perf_sample *sample,
784 struct machine *machine);
786 struct addr_location;
788 int machine__resolve(struct machine *machine, struct addr_location *al,
789 struct perf_sample *sample);
791 void addr_location__put(struct addr_location *al);
795 bool is_bts_event(struct perf_event_attr *attr);
796 bool sample_addr_correlates_sym(struct perf_event_attr *attr);
797 void thread__resolve(struct thread *thread, struct addr_location *al,
798 struct perf_sample *sample);
800 const char *perf_event__name(unsigned int id);
802 size_t perf_event__sample_event_size(const struct perf_sample *sample, u64 type,
804 int perf_event__synthesize_sample(union perf_event *event, u64 type,
806 const struct perf_sample *sample);
808 pid_t perf_event__synthesize_comm(struct perf_tool *tool,
809 union perf_event *event, pid_t pid,
810 perf_event__handler_t process,
811 struct machine *machine);
813 int perf_event__synthesize_namespaces(struct perf_tool *tool,
814 union perf_event *event,
815 pid_t pid, pid_t tgid,
816 perf_event__handler_t process,
817 struct machine *machine);
819 int perf_event__synthesize_mmap_events(struct perf_tool *tool,
820 union perf_event *event,
821 pid_t pid, pid_t tgid,
822 perf_event__handler_t process,
823 struct machine *machine,
826 int perf_event__synthesize_extra_kmaps(struct perf_tool *tool,
827 perf_event__handler_t process,
828 struct machine *machine);
830 size_t perf_event__fprintf_comm(union perf_event *event, FILE *fp);
831 size_t perf_event__fprintf_mmap(union perf_event *event, FILE *fp);
832 size_t perf_event__fprintf_mmap2(union perf_event *event, FILE *fp);
833 size_t perf_event__fprintf_task(union perf_event *event, FILE *fp);
834 size_t perf_event__fprintf_aux(union perf_event *event, FILE *fp);
835 size_t perf_event__fprintf_itrace_start(union perf_event *event, FILE *fp);
836 size_t perf_event__fprintf_switch(union perf_event *event, FILE *fp);
837 size_t perf_event__fprintf_thread_map(union perf_event *event, FILE *fp);
838 size_t perf_event__fprintf_cpu_map(union perf_event *event, FILE *fp);
839 size_t perf_event__fprintf_namespaces(union perf_event *event, FILE *fp);
840 size_t perf_event__fprintf_ksymbol(union perf_event *event, FILE *fp);
841 size_t perf_event__fprintf_bpf_event(union perf_event *event, FILE *fp);
842 size_t perf_event__fprintf(union perf_event *event, FILE *fp);
844 int kallsyms__get_function_start(const char *kallsyms_filename,
845 const char *symbol_name, u64 *addr);
847 void *cpu_map_data__alloc(struct perf_cpu_map *map, size_t *size, u16 *type, int *max);
848 void cpu_map_data__synthesize(struct cpu_map_data *data, struct perf_cpu_map *map,
851 void event_attr_init(struct perf_event_attr *attr);
853 int perf_event_paranoid(void);
855 extern int sysctl_perf_event_max_stack;
856 extern int sysctl_perf_event_max_contexts_per_stack;
857 extern unsigned int proc_map_timeout;
859 #endif /* __PERF_RECORD_H */