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 {
148 struct branch_entry {
151 struct branch_flags flags;
154 struct branch_stack {
156 struct branch_entry entries[0];
160 PERF_IP_FLAG_BRANCH = 1ULL << 0,
161 PERF_IP_FLAG_CALL = 1ULL << 1,
162 PERF_IP_FLAG_RETURN = 1ULL << 2,
163 PERF_IP_FLAG_CONDITIONAL = 1ULL << 3,
164 PERF_IP_FLAG_SYSCALLRET = 1ULL << 4,
165 PERF_IP_FLAG_ASYNC = 1ULL << 5,
166 PERF_IP_FLAG_INTERRUPT = 1ULL << 6,
167 PERF_IP_FLAG_TX_ABORT = 1ULL << 7,
168 PERF_IP_FLAG_TRACE_BEGIN = 1ULL << 8,
169 PERF_IP_FLAG_TRACE_END = 1ULL << 9,
170 PERF_IP_FLAG_IN_TX = 1ULL << 10,
173 #define PERF_IP_FLAG_CHARS "bcrosyiABEx"
175 #define PERF_BRANCH_MASK (\
176 PERF_IP_FLAG_BRANCH |\
178 PERF_IP_FLAG_RETURN |\
179 PERF_IP_FLAG_CONDITIONAL |\
180 PERF_IP_FLAG_SYSCALLRET |\
181 PERF_IP_FLAG_ASYNC |\
182 PERF_IP_FLAG_INTERRUPT |\
183 PERF_IP_FLAG_TX_ABORT |\
184 PERF_IP_FLAG_TRACE_BEGIN |\
185 PERF_IP_FLAG_TRACE_END)
207 struct ip_callchain *callchain;
208 struct branch_stack *branch_stack;
209 struct regs_dump user_regs;
210 struct regs_dump intr_regs;
211 struct stack_dump user_stack;
212 struct sample_read read;
215 #define PERF_MEM_DATA_SRC_NONE \
216 (PERF_MEM_S(OP, NA) |\
217 PERF_MEM_S(LVL, NA) |\
218 PERF_MEM_S(SNOOP, NA) |\
219 PERF_MEM_S(LOCK, NA) |\
222 struct build_id_event {
223 struct perf_event_header header;
225 u8 build_id[PERF_ALIGN(BUILD_ID_SIZE, sizeof(u64))];
229 enum perf_user_event_type { /* above any possible kernel type */
230 PERF_RECORD_USER_TYPE_START = 64,
231 PERF_RECORD_HEADER_ATTR = 64,
232 PERF_RECORD_HEADER_EVENT_TYPE = 65, /* deprecated */
233 PERF_RECORD_HEADER_TRACING_DATA = 66,
234 PERF_RECORD_HEADER_BUILD_ID = 67,
235 PERF_RECORD_FINISHED_ROUND = 68,
236 PERF_RECORD_ID_INDEX = 69,
237 PERF_RECORD_AUXTRACE_INFO = 70,
238 PERF_RECORD_AUXTRACE = 71,
239 PERF_RECORD_AUXTRACE_ERROR = 72,
240 PERF_RECORD_THREAD_MAP = 73,
241 PERF_RECORD_CPU_MAP = 74,
242 PERF_RECORD_STAT_CONFIG = 75,
243 PERF_RECORD_STAT = 76,
244 PERF_RECORD_STAT_ROUND = 77,
245 PERF_RECORD_EVENT_UPDATE = 78,
246 PERF_RECORD_TIME_CONV = 79,
247 PERF_RECORD_HEADER_MAX
250 enum auxtrace_error_type {
251 PERF_AUXTRACE_ERROR_ITRACE = 1,
252 PERF_AUXTRACE_ERROR_MAX
255 /* Attribute type for custom synthesized events */
256 #define PERF_TYPE_SYNTH (INT_MAX + 1U)
258 /* Attribute config for custom synthesized events */
260 PERF_SYNTH_INTEL_PTWRITE,
261 PERF_SYNTH_INTEL_MWAIT,
262 PERF_SYNTH_INTEL_PWRE,
263 PERF_SYNTH_INTEL_EXSTOP,
264 PERF_SYNTH_INTEL_PWRX,
265 PERF_SYNTH_INTEL_CBR,
269 * Raw data formats for synthesized events. Note that 4 bytes of padding are
270 * present to match the 'size' member of PERF_SAMPLE_RAW data which is always
271 * 8-byte aligned. That means we must dereference raw_data with an offset of 4.
272 * Refer perf_sample__synth_ptr() and perf_synth__raw_data(). It also means the
273 * structure sizes are 4 bytes bigger than the raw_size, refer
274 * perf_synth__raw_size().
277 struct perf_synth_intel_ptwrite {
289 struct perf_synth_intel_mwait {
303 struct perf_synth_intel_pwre {
318 struct perf_synth_intel_exstop {
329 struct perf_synth_intel_pwrx {
334 u64 deepest_cstate : 4,
343 struct perf_synth_intel_cbr {
359 * raw_data is always 4 bytes from an 8-byte boundary, so subtract 4 to get
362 static inline void *perf_sample__synth_ptr(struct perf_sample *sample)
364 return sample->raw_data - 4;
367 static inline void *perf_synth__raw_data(void *p)
372 #define perf_synth__raw_size(d) (sizeof(d) - 4)
374 #define perf_sample__bad_synth_size(s, d) ((s)->raw_size < sizeof(d) - 4)
377 * The kernel collects the number of events it couldn't send in a stretch and
378 * when possible sends this number in a PERF_RECORD_LOST event. The number of
379 * such "chunks" of lost events is stored in .nr_events[PERF_EVENT_LOST] while
380 * total_lost tells exactly how many events the kernel in fact lost, i.e. it is
381 * the sum of all struct lost_event.lost fields reported.
383 * The kernel discards mixed up samples and sends the number in a
384 * PERF_RECORD_LOST_SAMPLES event. The number of lost-samples events is stored
385 * in .nr_events[PERF_RECORD_LOST_SAMPLES] while total_lost_samples tells
386 * exactly how many samples the kernel in fact dropped, i.e. it is the sum of
387 * all struct lost_samples_event.lost fields reported.
389 * The total_period is needed because by default auto-freq is used, so
390 * multipling nr_events[PERF_EVENT_SAMPLE] by a frequency isn't possible to get
391 * the total number of low level events, it is necessary to to sum all struct
392 * sample_event.period and stash the result in total_period.
394 struct events_stats {
396 u64 total_non_filtered_period;
398 u64 total_lost_samples;
400 u64 total_aux_partial;
401 u64 total_invalid_chains;
402 u32 nr_events[PERF_RECORD_HEADER_MAX];
403 u32 nr_non_filtered_samples;
405 u32 nr_unknown_events;
406 u32 nr_invalid_chains;
408 u32 nr_unprocessable_samples;
409 u32 nr_auxtrace_errors[PERF_AUXTRACE_ERROR_MAX];
410 u32 nr_proc_map_timeout;
414 PERF_CPU_MAP__CPUS = 0,
415 PERF_CPU_MAP__MASK = 1,
418 struct cpu_map_entries {
423 struct cpu_map_mask {
426 unsigned long mask[];
429 struct cpu_map_data {
434 struct cpu_map_event {
435 struct perf_event_header header;
436 struct cpu_map_data data;
440 struct perf_event_header header;
441 struct perf_event_attr attr;
446 PERF_EVENT_UPDATE__UNIT = 0,
447 PERF_EVENT_UPDATE__SCALE = 1,
448 PERF_EVENT_UPDATE__NAME = 2,
449 PERF_EVENT_UPDATE__CPUS = 3,
452 struct event_update_event_cpus {
453 struct cpu_map_data cpus;
456 struct event_update_event_scale {
460 struct event_update_event {
461 struct perf_event_header header;
468 #define MAX_EVENT_NAME 64
470 struct perf_trace_event_type {
472 char name[MAX_EVENT_NAME];
475 struct event_type_event {
476 struct perf_event_header header;
477 struct perf_trace_event_type event_type;
480 struct tracing_data_event {
481 struct perf_event_header header;
485 struct id_index_entry {
492 struct id_index_event {
493 struct perf_event_header header;
495 struct id_index_entry entries[0];
498 struct auxtrace_info_event {
499 struct perf_event_header header;
501 u32 reserved__; /* For alignment */
505 struct auxtrace_event {
506 struct perf_event_header header;
513 u32 reserved__; /* For alignment */
516 #define MAX_AUXTRACE_ERROR_MSG 64
518 struct auxtrace_error_event {
519 struct perf_event_header header;
525 u32 reserved__; /* For alignment */
527 char msg[MAX_AUXTRACE_ERROR_MSG];
531 struct perf_event_header header;
537 struct itrace_start_event {
538 struct perf_event_header header;
542 struct context_switch_event {
543 struct perf_event_header header;
548 struct thread_map_event_entry {
553 struct thread_map_event {
554 struct perf_event_header header;
556 struct thread_map_event_entry entries[];
560 PERF_STAT_CONFIG_TERM__AGGR_MODE = 0,
561 PERF_STAT_CONFIG_TERM__INTERVAL = 1,
562 PERF_STAT_CONFIG_TERM__SCALE = 2,
563 PERF_STAT_CONFIG_TERM__MAX = 3,
566 struct stat_config_event_entry {
571 struct stat_config_event {
572 struct perf_event_header header;
574 struct stat_config_event_entry data[];
578 struct perf_event_header header;
595 PERF_STAT_ROUND_TYPE__INTERVAL = 0,
596 PERF_STAT_ROUND_TYPE__FINAL = 1,
599 struct stat_round_event {
600 struct perf_event_header header;
605 struct time_conv_event {
606 struct perf_event_header header;
613 struct perf_event_header header;
614 struct mmap_event mmap;
615 struct mmap2_event mmap2;
616 struct comm_event comm;
617 struct namespaces_event namespaces;
618 struct fork_event fork;
619 struct lost_event lost;
620 struct lost_samples_event lost_samples;
621 struct read_event read;
622 struct throttle_event throttle;
623 struct sample_event sample;
624 struct attr_event attr;
625 struct event_update_event event_update;
626 struct event_type_event event_type;
627 struct tracing_data_event tracing_data;
628 struct build_id_event build_id;
629 struct id_index_event id_index;
630 struct auxtrace_info_event auxtrace_info;
631 struct auxtrace_event auxtrace;
632 struct auxtrace_error_event auxtrace_error;
633 struct aux_event aux;
634 struct itrace_start_event itrace_start;
635 struct context_switch_event context_switch;
636 struct thread_map_event thread_map;
637 struct cpu_map_event cpu_map;
638 struct stat_config_event stat_config;
639 struct stat_event stat;
640 struct stat_round_event stat_round;
641 struct time_conv_event time_conv;
644 void perf_event__print_totals(void);
649 struct perf_stat_config;
650 struct perf_counts_values;
652 typedef int (*perf_event__handler_t)(struct perf_tool *tool,
653 union perf_event *event,
654 struct perf_sample *sample,
655 struct machine *machine);
657 int perf_event__synthesize_thread_map(struct perf_tool *tool,
658 struct thread_map *threads,
659 perf_event__handler_t process,
660 struct machine *machine, bool mmap_data,
661 unsigned int proc_map_timeout);
662 int perf_event__synthesize_thread_map2(struct perf_tool *tool,
663 struct thread_map *threads,
664 perf_event__handler_t process,
665 struct machine *machine);
666 int perf_event__synthesize_cpu_map(struct perf_tool *tool,
667 struct cpu_map *cpus,
668 perf_event__handler_t process,
669 struct machine *machine);
670 int perf_event__synthesize_threads(struct perf_tool *tool,
671 perf_event__handler_t process,
672 struct machine *machine, bool mmap_data,
673 unsigned int proc_map_timeout);
674 int perf_event__synthesize_kernel_mmap(struct perf_tool *tool,
675 perf_event__handler_t process,
676 struct machine *machine);
677 int perf_event__synthesize_stat_config(struct perf_tool *tool,
678 struct perf_stat_config *config,
679 perf_event__handler_t process,
680 struct machine *machine);
681 void perf_event__read_stat_config(struct perf_stat_config *config,
682 struct stat_config_event *event);
683 int perf_event__synthesize_stat(struct perf_tool *tool,
684 u32 cpu, u32 thread, u64 id,
685 struct perf_counts_values *count,
686 perf_event__handler_t process,
687 struct machine *machine);
688 int perf_event__synthesize_stat_round(struct perf_tool *tool,
690 perf_event__handler_t process,
691 struct machine *machine);
692 int perf_event__synthesize_modules(struct perf_tool *tool,
693 perf_event__handler_t process,
694 struct machine *machine);
696 int perf_event__process_comm(struct perf_tool *tool,
697 union perf_event *event,
698 struct perf_sample *sample,
699 struct machine *machine);
700 int perf_event__process_lost(struct perf_tool *tool,
701 union perf_event *event,
702 struct perf_sample *sample,
703 struct machine *machine);
704 int perf_event__process_lost_samples(struct perf_tool *tool,
705 union perf_event *event,
706 struct perf_sample *sample,
707 struct machine *machine);
708 int perf_event__process_aux(struct perf_tool *tool,
709 union perf_event *event,
710 struct perf_sample *sample,
711 struct machine *machine);
712 int perf_event__process_itrace_start(struct perf_tool *tool,
713 union perf_event *event,
714 struct perf_sample *sample,
715 struct machine *machine);
716 int perf_event__process_switch(struct perf_tool *tool,
717 union perf_event *event,
718 struct perf_sample *sample,
719 struct machine *machine);
720 int perf_event__process_namespaces(struct perf_tool *tool,
721 union perf_event *event,
722 struct perf_sample *sample,
723 struct machine *machine);
724 int perf_event__process_mmap(struct perf_tool *tool,
725 union perf_event *event,
726 struct perf_sample *sample,
727 struct machine *machine);
728 int perf_event__process_mmap2(struct perf_tool *tool,
729 union perf_event *event,
730 struct perf_sample *sample,
731 struct machine *machine);
732 int perf_event__process_fork(struct perf_tool *tool,
733 union perf_event *event,
734 struct perf_sample *sample,
735 struct machine *machine);
736 int perf_event__process_exit(struct perf_tool *tool,
737 union perf_event *event,
738 struct perf_sample *sample,
739 struct machine *machine);
740 int perf_event__process(struct perf_tool *tool,
741 union perf_event *event,
742 struct perf_sample *sample,
743 struct machine *machine);
745 struct addr_location;
747 int machine__resolve(struct machine *machine, struct addr_location *al,
748 struct perf_sample *sample);
750 void addr_location__put(struct addr_location *al);
754 bool is_bts_event(struct perf_event_attr *attr);
755 bool sample_addr_correlates_sym(struct perf_event_attr *attr);
756 void thread__resolve(struct thread *thread, struct addr_location *al,
757 struct perf_sample *sample);
759 const char *perf_event__name(unsigned int id);
761 size_t perf_event__sample_event_size(const struct perf_sample *sample, u64 type,
763 int perf_event__synthesize_sample(union perf_event *event, u64 type,
765 const struct perf_sample *sample,
768 pid_t perf_event__synthesize_comm(struct perf_tool *tool,
769 union perf_event *event, pid_t pid,
770 perf_event__handler_t process,
771 struct machine *machine);
773 int perf_event__synthesize_namespaces(struct perf_tool *tool,
774 union perf_event *event,
775 pid_t pid, pid_t tgid,
776 perf_event__handler_t process,
777 struct machine *machine);
779 int perf_event__synthesize_mmap_events(struct perf_tool *tool,
780 union perf_event *event,
781 pid_t pid, pid_t tgid,
782 perf_event__handler_t process,
783 struct machine *machine,
785 unsigned int proc_map_timeout);
787 size_t perf_event__fprintf_comm(union perf_event *event, FILE *fp);
788 size_t perf_event__fprintf_mmap(union perf_event *event, FILE *fp);
789 size_t perf_event__fprintf_mmap2(union perf_event *event, FILE *fp);
790 size_t perf_event__fprintf_task(union perf_event *event, FILE *fp);
791 size_t perf_event__fprintf_aux(union perf_event *event, FILE *fp);
792 size_t perf_event__fprintf_itrace_start(union perf_event *event, FILE *fp);
793 size_t perf_event__fprintf_switch(union perf_event *event, FILE *fp);
794 size_t perf_event__fprintf_thread_map(union perf_event *event, FILE *fp);
795 size_t perf_event__fprintf_cpu_map(union perf_event *event, FILE *fp);
796 size_t perf_event__fprintf_namespaces(union perf_event *event, FILE *fp);
797 size_t perf_event__fprintf(union perf_event *event, FILE *fp);
799 int kallsyms__get_function_start(const char *kallsyms_filename,
800 const char *symbol_name, u64 *addr);
802 void *cpu_map_data__alloc(struct cpu_map *map, size_t *size, u16 *type, int *max);
803 void cpu_map_data__synthesize(struct cpu_map_data *data, struct cpu_map *map,
806 void event_attr_init(struct perf_event_attr *attr);
808 int perf_event_paranoid(void);
810 extern int sysctl_perf_event_max_stack;
811 extern int sysctl_perf_event_max_contexts_per_stack;
813 #endif /* __PERF_RECORD_H */