1 #ifndef __PERF_RECORD_H
2 #define __PERF_RECORD_H
6 #include <linux/kernel.h>
10 #include "perf_regs.h"
13 struct perf_event_header header;
18 char filename[PATH_MAX];
22 struct perf_event_header header;
33 char filename[PATH_MAX];
37 struct perf_event_header header;
42 struct namespaces_event {
43 struct perf_event_header header;
46 struct perf_ns_link_info link_info[];
50 struct perf_event_header header;
57 struct perf_event_header header;
62 struct lost_samples_event {
63 struct perf_event_header header;
68 * PERF_FORMAT_ENABLED | PERF_FORMAT_RUNNING | PERF_FORMAT_ID
71 struct perf_event_header header;
79 struct throttle_event {
80 struct perf_event_header header;
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)
93 /* perf sample has 16 bits size limit */
94 #define PERF_SAMPLE_MAX_SIZE (1 << 16)
97 struct perf_event_header header;
106 /* Cached values/mask filled by first register access. */
107 u64 cache_regs[PERF_REGS_MAX];
117 struct sample_read_value {
128 struct sample_read_value *values;
130 struct sample_read_value one;
134 struct ip_callchain {
139 struct branch_flags {
149 struct branch_entry {
152 struct branch_flags flags;
155 struct branch_stack {
157 struct branch_entry entries[0];
161 PERF_IP_FLAG_BRANCH = 1ULL << 0,
162 PERF_IP_FLAG_CALL = 1ULL << 1,
163 PERF_IP_FLAG_RETURN = 1ULL << 2,
164 PERF_IP_FLAG_CONDITIONAL = 1ULL << 3,
165 PERF_IP_FLAG_SYSCALLRET = 1ULL << 4,
166 PERF_IP_FLAG_ASYNC = 1ULL << 5,
167 PERF_IP_FLAG_INTERRUPT = 1ULL << 6,
168 PERF_IP_FLAG_TX_ABORT = 1ULL << 7,
169 PERF_IP_FLAG_TRACE_BEGIN = 1ULL << 8,
170 PERF_IP_FLAG_TRACE_END = 1ULL << 9,
171 PERF_IP_FLAG_IN_TX = 1ULL << 10,
174 #define PERF_IP_FLAG_CHARS "bcrosyiABEx"
176 #define PERF_BRANCH_MASK (\
177 PERF_IP_FLAG_BRANCH |\
179 PERF_IP_FLAG_RETURN |\
180 PERF_IP_FLAG_CONDITIONAL |\
181 PERF_IP_FLAG_SYSCALLRET |\
182 PERF_IP_FLAG_ASYNC |\
183 PERF_IP_FLAG_INTERRUPT |\
184 PERF_IP_FLAG_TX_ABORT |\
185 PERF_IP_FLAG_TRACE_BEGIN |\
186 PERF_IP_FLAG_TRACE_END)
209 struct ip_callchain *callchain;
210 struct branch_stack *branch_stack;
211 struct regs_dump user_regs;
212 struct regs_dump intr_regs;
213 struct stack_dump user_stack;
214 struct sample_read read;
217 #define PERF_MEM_DATA_SRC_NONE \
218 (PERF_MEM_S(OP, NA) |\
219 PERF_MEM_S(LVL, NA) |\
220 PERF_MEM_S(SNOOP, NA) |\
221 PERF_MEM_S(LOCK, NA) |\
224 struct build_id_event {
225 struct perf_event_header header;
227 u8 build_id[PERF_ALIGN(BUILD_ID_SIZE, sizeof(u64))];
231 enum perf_user_event_type { /* above any possible kernel type */
232 PERF_RECORD_USER_TYPE_START = 64,
233 PERF_RECORD_HEADER_ATTR = 64,
234 PERF_RECORD_HEADER_EVENT_TYPE = 65, /* deprecated */
235 PERF_RECORD_HEADER_TRACING_DATA = 66,
236 PERF_RECORD_HEADER_BUILD_ID = 67,
237 PERF_RECORD_FINISHED_ROUND = 68,
238 PERF_RECORD_ID_INDEX = 69,
239 PERF_RECORD_AUXTRACE_INFO = 70,
240 PERF_RECORD_AUXTRACE = 71,
241 PERF_RECORD_AUXTRACE_ERROR = 72,
242 PERF_RECORD_THREAD_MAP = 73,
243 PERF_RECORD_CPU_MAP = 74,
244 PERF_RECORD_STAT_CONFIG = 75,
245 PERF_RECORD_STAT = 76,
246 PERF_RECORD_STAT_ROUND = 77,
247 PERF_RECORD_EVENT_UPDATE = 78,
248 PERF_RECORD_TIME_CONV = 79,
249 PERF_RECORD_HEADER_FEATURE = 80,
250 PERF_RECORD_HEADER_MAX
253 enum auxtrace_error_type {
254 PERF_AUXTRACE_ERROR_ITRACE = 1,
255 PERF_AUXTRACE_ERROR_MAX
258 /* Attribute type for custom synthesized events */
259 #define PERF_TYPE_SYNTH (INT_MAX + 1U)
261 /* Attribute config for custom synthesized events */
263 PERF_SYNTH_INTEL_PTWRITE,
264 PERF_SYNTH_INTEL_MWAIT,
265 PERF_SYNTH_INTEL_PWRE,
266 PERF_SYNTH_INTEL_EXSTOP,
267 PERF_SYNTH_INTEL_PWRX,
268 PERF_SYNTH_INTEL_CBR,
272 * Raw data formats for synthesized events. Note that 4 bytes of padding are
273 * present to match the 'size' member of PERF_SAMPLE_RAW data which is always
274 * 8-byte aligned. That means we must dereference raw_data with an offset of 4.
275 * Refer perf_sample__synth_ptr() and perf_synth__raw_data(). It also means the
276 * structure sizes are 4 bytes bigger than the raw_size, refer
277 * perf_synth__raw_size().
280 struct perf_synth_intel_ptwrite {
292 struct perf_synth_intel_mwait {
306 struct perf_synth_intel_pwre {
321 struct perf_synth_intel_exstop {
332 struct perf_synth_intel_pwrx {
337 u64 deepest_cstate : 4,
346 struct perf_synth_intel_cbr {
362 * raw_data is always 4 bytes from an 8-byte boundary, so subtract 4 to get
365 static inline void *perf_sample__synth_ptr(struct perf_sample *sample)
367 return sample->raw_data - 4;
370 static inline void *perf_synth__raw_data(void *p)
375 #define perf_synth__raw_size(d) (sizeof(d) - 4)
377 #define perf_sample__bad_synth_size(s, d) ((s)->raw_size < sizeof(d) - 4)
380 * The kernel collects the number of events it couldn't send in a stretch and
381 * when possible sends this number in a PERF_RECORD_LOST event. The number of
382 * such "chunks" of lost events is stored in .nr_events[PERF_EVENT_LOST] while
383 * total_lost tells exactly how many events the kernel in fact lost, i.e. it is
384 * the sum of all struct lost_event.lost fields reported.
386 * The kernel discards mixed up samples and sends the number in a
387 * PERF_RECORD_LOST_SAMPLES event. The number of lost-samples events is stored
388 * in .nr_events[PERF_RECORD_LOST_SAMPLES] while total_lost_samples tells
389 * exactly how many samples the kernel in fact dropped, i.e. it is the sum of
390 * all struct lost_samples_event.lost fields reported.
392 * The total_period is needed because by default auto-freq is used, so
393 * multipling nr_events[PERF_EVENT_SAMPLE] by a frequency isn't possible to get
394 * the total number of low level events, it is necessary to to sum all struct
395 * sample_event.period and stash the result in total_period.
397 struct events_stats {
399 u64 total_non_filtered_period;
401 u64 total_lost_samples;
403 u64 total_aux_partial;
404 u64 total_invalid_chains;
405 u32 nr_events[PERF_RECORD_HEADER_MAX];
406 u32 nr_non_filtered_samples;
408 u32 nr_unknown_events;
409 u32 nr_invalid_chains;
411 u32 nr_unprocessable_samples;
412 u32 nr_auxtrace_errors[PERF_AUXTRACE_ERROR_MAX];
413 u32 nr_proc_map_timeout;
417 PERF_CPU_MAP__CPUS = 0,
418 PERF_CPU_MAP__MASK = 1,
421 struct cpu_map_entries {
426 struct cpu_map_mask {
429 unsigned long mask[];
432 struct cpu_map_data {
437 struct cpu_map_event {
438 struct perf_event_header header;
439 struct cpu_map_data data;
443 struct perf_event_header header;
444 struct perf_event_attr attr;
449 PERF_EVENT_UPDATE__UNIT = 0,
450 PERF_EVENT_UPDATE__SCALE = 1,
451 PERF_EVENT_UPDATE__NAME = 2,
452 PERF_EVENT_UPDATE__CPUS = 3,
455 struct event_update_event_cpus {
456 struct cpu_map_data cpus;
459 struct event_update_event_scale {
463 struct event_update_event {
464 struct perf_event_header header;
471 #define MAX_EVENT_NAME 64
473 struct perf_trace_event_type {
475 char name[MAX_EVENT_NAME];
478 struct event_type_event {
479 struct perf_event_header header;
480 struct perf_trace_event_type event_type;
483 struct tracing_data_event {
484 struct perf_event_header header;
488 struct id_index_entry {
495 struct id_index_event {
496 struct perf_event_header header;
498 struct id_index_entry entries[0];
501 struct auxtrace_info_event {
502 struct perf_event_header header;
504 u32 reserved__; /* For alignment */
508 struct auxtrace_event {
509 struct perf_event_header header;
516 u32 reserved__; /* For alignment */
519 #define MAX_AUXTRACE_ERROR_MSG 64
521 struct auxtrace_error_event {
522 struct perf_event_header header;
528 u32 reserved__; /* For alignment */
530 char msg[MAX_AUXTRACE_ERROR_MSG];
534 struct perf_event_header header;
540 struct itrace_start_event {
541 struct perf_event_header header;
545 struct context_switch_event {
546 struct perf_event_header header;
551 struct thread_map_event_entry {
556 struct thread_map_event {
557 struct perf_event_header header;
559 struct thread_map_event_entry entries[];
563 PERF_STAT_CONFIG_TERM__AGGR_MODE = 0,
564 PERF_STAT_CONFIG_TERM__INTERVAL = 1,
565 PERF_STAT_CONFIG_TERM__SCALE = 2,
566 PERF_STAT_CONFIG_TERM__MAX = 3,
569 struct stat_config_event_entry {
574 struct stat_config_event {
575 struct perf_event_header header;
577 struct stat_config_event_entry data[];
581 struct perf_event_header header;
598 PERF_STAT_ROUND_TYPE__INTERVAL = 0,
599 PERF_STAT_ROUND_TYPE__FINAL = 1,
602 struct stat_round_event {
603 struct perf_event_header header;
608 struct time_conv_event {
609 struct perf_event_header header;
615 struct feature_event {
616 struct perf_event_header header;
622 struct perf_event_header header;
623 struct mmap_event mmap;
624 struct mmap2_event mmap2;
625 struct comm_event comm;
626 struct namespaces_event namespaces;
627 struct fork_event fork;
628 struct lost_event lost;
629 struct lost_samples_event lost_samples;
630 struct read_event read;
631 struct throttle_event throttle;
632 struct sample_event sample;
633 struct attr_event attr;
634 struct event_update_event event_update;
635 struct event_type_event event_type;
636 struct tracing_data_event tracing_data;
637 struct build_id_event build_id;
638 struct id_index_event id_index;
639 struct auxtrace_info_event auxtrace_info;
640 struct auxtrace_event auxtrace;
641 struct auxtrace_error_event auxtrace_error;
642 struct aux_event aux;
643 struct itrace_start_event itrace_start;
644 struct context_switch_event context_switch;
645 struct thread_map_event thread_map;
646 struct cpu_map_event cpu_map;
647 struct stat_config_event stat_config;
648 struct stat_event stat;
649 struct stat_round_event stat_round;
650 struct time_conv_event time_conv;
651 struct feature_event feat;
654 void perf_event__print_totals(void);
659 struct perf_stat_config;
660 struct perf_counts_values;
662 typedef int (*perf_event__handler_t)(struct perf_tool *tool,
663 union perf_event *event,
664 struct perf_sample *sample,
665 struct machine *machine);
667 int perf_event__synthesize_thread_map(struct perf_tool *tool,
668 struct thread_map *threads,
669 perf_event__handler_t process,
670 struct machine *machine, bool mmap_data,
671 unsigned int proc_map_timeout);
672 int perf_event__synthesize_thread_map2(struct perf_tool *tool,
673 struct thread_map *threads,
674 perf_event__handler_t process,
675 struct machine *machine);
676 int perf_event__synthesize_cpu_map(struct perf_tool *tool,
677 struct cpu_map *cpus,
678 perf_event__handler_t process,
679 struct machine *machine);
680 int perf_event__synthesize_threads(struct perf_tool *tool,
681 perf_event__handler_t process,
682 struct machine *machine, bool mmap_data,
683 unsigned int proc_map_timeout);
684 int perf_event__synthesize_kernel_mmap(struct perf_tool *tool,
685 perf_event__handler_t process,
686 struct machine *machine);
687 int perf_event__synthesize_stat_config(struct perf_tool *tool,
688 struct perf_stat_config *config,
689 perf_event__handler_t process,
690 struct machine *machine);
691 void perf_event__read_stat_config(struct perf_stat_config *config,
692 struct stat_config_event *event);
693 int perf_event__synthesize_stat(struct perf_tool *tool,
694 u32 cpu, u32 thread, u64 id,
695 struct perf_counts_values *count,
696 perf_event__handler_t process,
697 struct machine *machine);
698 int perf_event__synthesize_stat_round(struct perf_tool *tool,
700 perf_event__handler_t process,
701 struct machine *machine);
702 int perf_event__synthesize_modules(struct perf_tool *tool,
703 perf_event__handler_t process,
704 struct machine *machine);
706 int perf_event__process_comm(struct perf_tool *tool,
707 union perf_event *event,
708 struct perf_sample *sample,
709 struct machine *machine);
710 int perf_event__process_lost(struct perf_tool *tool,
711 union perf_event *event,
712 struct perf_sample *sample,
713 struct machine *machine);
714 int perf_event__process_lost_samples(struct perf_tool *tool,
715 union perf_event *event,
716 struct perf_sample *sample,
717 struct machine *machine);
718 int perf_event__process_aux(struct perf_tool *tool,
719 union perf_event *event,
720 struct perf_sample *sample,
721 struct machine *machine);
722 int perf_event__process_itrace_start(struct perf_tool *tool,
723 union perf_event *event,
724 struct perf_sample *sample,
725 struct machine *machine);
726 int perf_event__process_switch(struct perf_tool *tool,
727 union perf_event *event,
728 struct perf_sample *sample,
729 struct machine *machine);
730 int perf_event__process_namespaces(struct perf_tool *tool,
731 union perf_event *event,
732 struct perf_sample *sample,
733 struct machine *machine);
734 int perf_event__process_mmap(struct perf_tool *tool,
735 union perf_event *event,
736 struct perf_sample *sample,
737 struct machine *machine);
738 int perf_event__process_mmap2(struct perf_tool *tool,
739 union perf_event *event,
740 struct perf_sample *sample,
741 struct machine *machine);
742 int perf_event__process_fork(struct perf_tool *tool,
743 union perf_event *event,
744 struct perf_sample *sample,
745 struct machine *machine);
746 int perf_event__process_exit(struct perf_tool *tool,
747 union perf_event *event,
748 struct perf_sample *sample,
749 struct machine *machine);
750 int perf_event__process(struct perf_tool *tool,
751 union perf_event *event,
752 struct perf_sample *sample,
753 struct machine *machine);
755 struct addr_location;
757 int machine__resolve(struct machine *machine, struct addr_location *al,
758 struct perf_sample *sample);
760 void addr_location__put(struct addr_location *al);
764 bool is_bts_event(struct perf_event_attr *attr);
765 bool sample_addr_correlates_sym(struct perf_event_attr *attr);
766 void thread__resolve(struct thread *thread, struct addr_location *al,
767 struct perf_sample *sample);
769 const char *perf_event__name(unsigned int id);
771 size_t perf_event__sample_event_size(const struct perf_sample *sample, u64 type,
773 int perf_event__synthesize_sample(union perf_event *event, u64 type,
775 const struct perf_sample *sample,
778 pid_t perf_event__synthesize_comm(struct perf_tool *tool,
779 union perf_event *event, pid_t pid,
780 perf_event__handler_t process,
781 struct machine *machine);
783 int perf_event__synthesize_namespaces(struct perf_tool *tool,
784 union perf_event *event,
785 pid_t pid, pid_t tgid,
786 perf_event__handler_t process,
787 struct machine *machine);
789 int perf_event__synthesize_mmap_events(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 unsigned int proc_map_timeout);
797 size_t perf_event__fprintf_comm(union perf_event *event, FILE *fp);
798 size_t perf_event__fprintf_mmap(union perf_event *event, FILE *fp);
799 size_t perf_event__fprintf_mmap2(union perf_event *event, FILE *fp);
800 size_t perf_event__fprintf_task(union perf_event *event, FILE *fp);
801 size_t perf_event__fprintf_aux(union perf_event *event, FILE *fp);
802 size_t perf_event__fprintf_itrace_start(union perf_event *event, FILE *fp);
803 size_t perf_event__fprintf_switch(union perf_event *event, FILE *fp);
804 size_t perf_event__fprintf_thread_map(union perf_event *event, FILE *fp);
805 size_t perf_event__fprintf_cpu_map(union perf_event *event, FILE *fp);
806 size_t perf_event__fprintf_namespaces(union perf_event *event, FILE *fp);
807 size_t perf_event__fprintf(union perf_event *event, FILE *fp);
809 int kallsyms__get_function_start(const char *kallsyms_filename,
810 const char *symbol_name, u64 *addr);
812 void *cpu_map_data__alloc(struct cpu_map *map, size_t *size, u16 *type, int *max);
813 void cpu_map_data__synthesize(struct cpu_map_data *data, struct cpu_map *map,
816 void event_attr_init(struct perf_event_attr *attr);
818 int perf_event_paranoid(void);
820 extern int sysctl_perf_event_max_stack;
821 extern int sysctl_perf_event_max_contexts_per_stack;
823 #endif /* __PERF_RECORD_H */