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)
211 struct ip_callchain *callchain;
212 struct branch_stack *branch_stack;
213 struct regs_dump user_regs;
214 struct regs_dump intr_regs;
215 struct stack_dump user_stack;
216 struct sample_read read;
219 #define PERF_MEM_DATA_SRC_NONE \
220 (PERF_MEM_S(OP, NA) |\
221 PERF_MEM_S(LVL, NA) |\
222 PERF_MEM_S(SNOOP, NA) |\
223 PERF_MEM_S(LOCK, NA) |\
226 struct build_id_event {
227 struct perf_event_header header;
229 u8 build_id[PERF_ALIGN(BUILD_ID_SIZE, sizeof(u64))];
233 enum perf_user_event_type { /* above any possible kernel type */
234 PERF_RECORD_USER_TYPE_START = 64,
235 PERF_RECORD_HEADER_ATTR = 64,
236 PERF_RECORD_HEADER_EVENT_TYPE = 65, /* deprecated */
237 PERF_RECORD_HEADER_TRACING_DATA = 66,
238 PERF_RECORD_HEADER_BUILD_ID = 67,
239 PERF_RECORD_FINISHED_ROUND = 68,
240 PERF_RECORD_ID_INDEX = 69,
241 PERF_RECORD_AUXTRACE_INFO = 70,
242 PERF_RECORD_AUXTRACE = 71,
243 PERF_RECORD_AUXTRACE_ERROR = 72,
244 PERF_RECORD_THREAD_MAP = 73,
245 PERF_RECORD_CPU_MAP = 74,
246 PERF_RECORD_STAT_CONFIG = 75,
247 PERF_RECORD_STAT = 76,
248 PERF_RECORD_STAT_ROUND = 77,
249 PERF_RECORD_EVENT_UPDATE = 78,
250 PERF_RECORD_TIME_CONV = 79,
251 PERF_RECORD_HEADER_FEATURE = 80,
252 PERF_RECORD_HEADER_MAX
255 enum auxtrace_error_type {
256 PERF_AUXTRACE_ERROR_ITRACE = 1,
257 PERF_AUXTRACE_ERROR_MAX
260 /* Attribute type for custom synthesized events */
261 #define PERF_TYPE_SYNTH (INT_MAX + 1U)
263 /* Attribute config for custom synthesized events */
265 PERF_SYNTH_INTEL_PTWRITE,
266 PERF_SYNTH_INTEL_MWAIT,
267 PERF_SYNTH_INTEL_PWRE,
268 PERF_SYNTH_INTEL_EXSTOP,
269 PERF_SYNTH_INTEL_PWRX,
270 PERF_SYNTH_INTEL_CBR,
274 * Raw data formats for synthesized events. Note that 4 bytes of padding are
275 * present to match the 'size' member of PERF_SAMPLE_RAW data which is always
276 * 8-byte aligned. That means we must dereference raw_data with an offset of 4.
277 * Refer perf_sample__synth_ptr() and perf_synth__raw_data(). It also means the
278 * structure sizes are 4 bytes bigger than the raw_size, refer
279 * perf_synth__raw_size().
282 struct perf_synth_intel_ptwrite {
294 struct perf_synth_intel_mwait {
308 struct perf_synth_intel_pwre {
323 struct perf_synth_intel_exstop {
334 struct perf_synth_intel_pwrx {
339 u64 deepest_cstate : 4,
348 struct perf_synth_intel_cbr {
364 * raw_data is always 4 bytes from an 8-byte boundary, so subtract 4 to get
367 static inline void *perf_sample__synth_ptr(struct perf_sample *sample)
369 return sample->raw_data - 4;
372 static inline void *perf_synth__raw_data(void *p)
377 #define perf_synth__raw_size(d) (sizeof(d) - 4)
379 #define perf_sample__bad_synth_size(s, d) ((s)->raw_size < sizeof(d) - 4)
382 * The kernel collects the number of events it couldn't send in a stretch and
383 * when possible sends this number in a PERF_RECORD_LOST event. The number of
384 * such "chunks" of lost events is stored in .nr_events[PERF_EVENT_LOST] while
385 * total_lost tells exactly how many events the kernel in fact lost, i.e. it is
386 * the sum of all struct lost_event.lost fields reported.
388 * The kernel discards mixed up samples and sends the number in a
389 * PERF_RECORD_LOST_SAMPLES event. The number of lost-samples events is stored
390 * in .nr_events[PERF_RECORD_LOST_SAMPLES] while total_lost_samples tells
391 * exactly how many samples the kernel in fact dropped, i.e. it is the sum of
392 * all struct lost_samples_event.lost fields reported.
394 * The total_period is needed because by default auto-freq is used, so
395 * multipling nr_events[PERF_EVENT_SAMPLE] by a frequency isn't possible to get
396 * the total number of low level events, it is necessary to to sum all struct
397 * sample_event.period and stash the result in total_period.
399 struct events_stats {
401 u64 total_non_filtered_period;
403 u64 total_lost_samples;
405 u64 total_aux_partial;
406 u64 total_invalid_chains;
407 u32 nr_events[PERF_RECORD_HEADER_MAX];
408 u32 nr_non_filtered_samples;
410 u32 nr_unknown_events;
411 u32 nr_invalid_chains;
413 u32 nr_unprocessable_samples;
414 u32 nr_auxtrace_errors[PERF_AUXTRACE_ERROR_MAX];
415 u32 nr_proc_map_timeout;
419 PERF_CPU_MAP__CPUS = 0,
420 PERF_CPU_MAP__MASK = 1,
423 struct cpu_map_entries {
428 struct cpu_map_mask {
431 unsigned long mask[];
434 struct cpu_map_data {
439 struct cpu_map_event {
440 struct perf_event_header header;
441 struct cpu_map_data data;
445 struct perf_event_header header;
446 struct perf_event_attr attr;
451 PERF_EVENT_UPDATE__UNIT = 0,
452 PERF_EVENT_UPDATE__SCALE = 1,
453 PERF_EVENT_UPDATE__NAME = 2,
454 PERF_EVENT_UPDATE__CPUS = 3,
457 struct event_update_event_cpus {
458 struct cpu_map_data cpus;
461 struct event_update_event_scale {
465 struct event_update_event {
466 struct perf_event_header header;
473 #define MAX_EVENT_NAME 64
475 struct perf_trace_event_type {
477 char name[MAX_EVENT_NAME];
480 struct event_type_event {
481 struct perf_event_header header;
482 struct perf_trace_event_type event_type;
485 struct tracing_data_event {
486 struct perf_event_header header;
490 struct id_index_entry {
497 struct id_index_event {
498 struct perf_event_header header;
500 struct id_index_entry entries[0];
503 struct auxtrace_info_event {
504 struct perf_event_header header;
506 u32 reserved__; /* For alignment */
510 struct auxtrace_event {
511 struct perf_event_header header;
518 u32 reserved__; /* For alignment */
521 #define MAX_AUXTRACE_ERROR_MSG 64
523 struct auxtrace_error_event {
524 struct perf_event_header header;
530 u32 reserved__; /* For alignment */
532 char msg[MAX_AUXTRACE_ERROR_MSG];
536 struct perf_event_header header;
542 struct itrace_start_event {
543 struct perf_event_header header;
547 struct context_switch_event {
548 struct perf_event_header header;
553 struct thread_map_event_entry {
558 struct thread_map_event {
559 struct perf_event_header header;
561 struct thread_map_event_entry entries[];
565 PERF_STAT_CONFIG_TERM__AGGR_MODE = 0,
566 PERF_STAT_CONFIG_TERM__INTERVAL = 1,
567 PERF_STAT_CONFIG_TERM__SCALE = 2,
568 PERF_STAT_CONFIG_TERM__MAX = 3,
571 struct stat_config_event_entry {
576 struct stat_config_event {
577 struct perf_event_header header;
579 struct stat_config_event_entry data[];
583 struct perf_event_header header;
600 PERF_STAT_ROUND_TYPE__INTERVAL = 0,
601 PERF_STAT_ROUND_TYPE__FINAL = 1,
604 struct stat_round_event {
605 struct perf_event_header header;
610 struct time_conv_event {
611 struct perf_event_header header;
617 struct feature_event {
618 struct perf_event_header header;
624 struct perf_event_header header;
625 struct mmap_event mmap;
626 struct mmap2_event mmap2;
627 struct comm_event comm;
628 struct namespaces_event namespaces;
629 struct fork_event fork;
630 struct lost_event lost;
631 struct lost_samples_event lost_samples;
632 struct read_event read;
633 struct throttle_event throttle;
634 struct sample_event sample;
635 struct attr_event attr;
636 struct event_update_event event_update;
637 struct event_type_event event_type;
638 struct tracing_data_event tracing_data;
639 struct build_id_event build_id;
640 struct id_index_event id_index;
641 struct auxtrace_info_event auxtrace_info;
642 struct auxtrace_event auxtrace;
643 struct auxtrace_error_event auxtrace_error;
644 struct aux_event aux;
645 struct itrace_start_event itrace_start;
646 struct context_switch_event context_switch;
647 struct thread_map_event thread_map;
648 struct cpu_map_event cpu_map;
649 struct stat_config_event stat_config;
650 struct stat_event stat;
651 struct stat_round_event stat_round;
652 struct time_conv_event time_conv;
653 struct feature_event feat;
656 void perf_event__print_totals(void);
661 struct perf_stat_config;
662 struct perf_counts_values;
664 typedef int (*perf_event__handler_t)(struct perf_tool *tool,
665 union perf_event *event,
666 struct perf_sample *sample,
667 struct machine *machine);
669 int perf_event__synthesize_thread_map(struct perf_tool *tool,
670 struct thread_map *threads,
671 perf_event__handler_t process,
672 struct machine *machine, bool mmap_data,
673 unsigned int proc_map_timeout);
674 int perf_event__synthesize_thread_map2(struct perf_tool *tool,
675 struct thread_map *threads,
676 perf_event__handler_t process,
677 struct machine *machine);
678 int perf_event__synthesize_cpu_map(struct perf_tool *tool,
679 struct cpu_map *cpus,
680 perf_event__handler_t process,
681 struct machine *machine);
682 int perf_event__synthesize_threads(struct perf_tool *tool,
683 perf_event__handler_t process,
684 struct machine *machine, bool mmap_data,
685 unsigned int proc_map_timeout,
686 unsigned int nr_threads_synthesize);
687 int perf_event__synthesize_kernel_mmap(struct perf_tool *tool,
688 perf_event__handler_t process,
689 struct machine *machine);
690 int perf_event__synthesize_stat_config(struct perf_tool *tool,
691 struct perf_stat_config *config,
692 perf_event__handler_t process,
693 struct machine *machine);
694 void perf_event__read_stat_config(struct perf_stat_config *config,
695 struct stat_config_event *event);
696 int perf_event__synthesize_stat(struct perf_tool *tool,
697 u32 cpu, u32 thread, u64 id,
698 struct perf_counts_values *count,
699 perf_event__handler_t process,
700 struct machine *machine);
701 int perf_event__synthesize_stat_round(struct perf_tool *tool,
703 perf_event__handler_t process,
704 struct machine *machine);
705 int perf_event__synthesize_modules(struct perf_tool *tool,
706 perf_event__handler_t process,
707 struct machine *machine);
709 int perf_event__process_comm(struct perf_tool *tool,
710 union perf_event *event,
711 struct perf_sample *sample,
712 struct machine *machine);
713 int perf_event__process_lost(struct perf_tool *tool,
714 union perf_event *event,
715 struct perf_sample *sample,
716 struct machine *machine);
717 int perf_event__process_lost_samples(struct perf_tool *tool,
718 union perf_event *event,
719 struct perf_sample *sample,
720 struct machine *machine);
721 int perf_event__process_aux(struct perf_tool *tool,
722 union perf_event *event,
723 struct perf_sample *sample,
724 struct machine *machine);
725 int perf_event__process_itrace_start(struct perf_tool *tool,
726 union perf_event *event,
727 struct perf_sample *sample,
728 struct machine *machine);
729 int perf_event__process_switch(struct perf_tool *tool,
730 union perf_event *event,
731 struct perf_sample *sample,
732 struct machine *machine);
733 int perf_event__process_namespaces(struct perf_tool *tool,
734 union perf_event *event,
735 struct perf_sample *sample,
736 struct machine *machine);
737 int perf_event__process_mmap(struct perf_tool *tool,
738 union perf_event *event,
739 struct perf_sample *sample,
740 struct machine *machine);
741 int perf_event__process_mmap2(struct perf_tool *tool,
742 union perf_event *event,
743 struct perf_sample *sample,
744 struct machine *machine);
745 int perf_event__process_fork(struct perf_tool *tool,
746 union perf_event *event,
747 struct perf_sample *sample,
748 struct machine *machine);
749 int perf_event__process_exit(struct perf_tool *tool,
750 union perf_event *event,
751 struct perf_sample *sample,
752 struct machine *machine);
753 int perf_tool__process_synth_event(struct perf_tool *tool,
754 union perf_event *event,
755 struct machine *machine,
756 perf_event__handler_t process);
757 int perf_event__process(struct perf_tool *tool,
758 union perf_event *event,
759 struct perf_sample *sample,
760 struct machine *machine);
762 struct addr_location;
764 int machine__resolve(struct machine *machine, struct addr_location *al,
765 struct perf_sample *sample);
767 void addr_location__put(struct addr_location *al);
771 bool is_bts_event(struct perf_event_attr *attr);
772 bool sample_addr_correlates_sym(struct perf_event_attr *attr);
773 void thread__resolve(struct thread *thread, struct addr_location *al,
774 struct perf_sample *sample);
776 const char *perf_event__name(unsigned int id);
778 size_t perf_event__sample_event_size(const struct perf_sample *sample, u64 type,
780 int perf_event__synthesize_sample(union perf_event *event, u64 type,
782 const struct perf_sample *sample);
784 pid_t perf_event__synthesize_comm(struct perf_tool *tool,
785 union perf_event *event, pid_t pid,
786 perf_event__handler_t process,
787 struct machine *machine);
789 int perf_event__synthesize_namespaces(struct perf_tool *tool,
790 union perf_event *event,
791 pid_t pid, pid_t tgid,
792 perf_event__handler_t process,
793 struct machine *machine);
795 int perf_event__synthesize_mmap_events(struct perf_tool *tool,
796 union perf_event *event,
797 pid_t pid, pid_t tgid,
798 perf_event__handler_t process,
799 struct machine *machine,
801 unsigned int proc_map_timeout);
803 int perf_event__synthesize_extra_kmaps(struct perf_tool *tool,
804 perf_event__handler_t process,
805 struct machine *machine);
807 size_t perf_event__fprintf_comm(union perf_event *event, FILE *fp);
808 size_t perf_event__fprintf_mmap(union perf_event *event, FILE *fp);
809 size_t perf_event__fprintf_mmap2(union perf_event *event, FILE *fp);
810 size_t perf_event__fprintf_task(union perf_event *event, FILE *fp);
811 size_t perf_event__fprintf_aux(union perf_event *event, FILE *fp);
812 size_t perf_event__fprintf_itrace_start(union perf_event *event, FILE *fp);
813 size_t perf_event__fprintf_switch(union perf_event *event, FILE *fp);
814 size_t perf_event__fprintf_thread_map(union perf_event *event, FILE *fp);
815 size_t perf_event__fprintf_cpu_map(union perf_event *event, FILE *fp);
816 size_t perf_event__fprintf_namespaces(union perf_event *event, FILE *fp);
817 size_t perf_event__fprintf(union perf_event *event, FILE *fp);
819 int kallsyms__get_function_start(const char *kallsyms_filename,
820 const char *symbol_name, u64 *addr);
822 void *cpu_map_data__alloc(struct cpu_map *map, size_t *size, u16 *type, int *max);
823 void cpu_map_data__synthesize(struct cpu_map_data *data, struct cpu_map *map,
826 void event_attr_init(struct perf_event_attr *attr);
828 int perf_event_paranoid(void);
830 extern int sysctl_perf_event_max_stack;
831 extern int sysctl_perf_event_max_contexts_per_stack;
833 #endif /* __PERF_RECORD_H */