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)
208 struct ip_callchain *callchain;
209 struct branch_stack *branch_stack;
210 struct regs_dump user_regs;
211 struct regs_dump intr_regs;
212 struct stack_dump user_stack;
213 struct sample_read read;
216 #define PERF_MEM_DATA_SRC_NONE \
217 (PERF_MEM_S(OP, NA) |\
218 PERF_MEM_S(LVL, NA) |\
219 PERF_MEM_S(SNOOP, NA) |\
220 PERF_MEM_S(LOCK, NA) |\
223 struct build_id_event {
224 struct perf_event_header header;
226 u8 build_id[PERF_ALIGN(BUILD_ID_SIZE, sizeof(u64))];
230 enum perf_user_event_type { /* above any possible kernel type */
231 PERF_RECORD_USER_TYPE_START = 64,
232 PERF_RECORD_HEADER_ATTR = 64,
233 PERF_RECORD_HEADER_EVENT_TYPE = 65, /* deprecated */
234 PERF_RECORD_HEADER_TRACING_DATA = 66,
235 PERF_RECORD_HEADER_BUILD_ID = 67,
236 PERF_RECORD_FINISHED_ROUND = 68,
237 PERF_RECORD_ID_INDEX = 69,
238 PERF_RECORD_AUXTRACE_INFO = 70,
239 PERF_RECORD_AUXTRACE = 71,
240 PERF_RECORD_AUXTRACE_ERROR = 72,
241 PERF_RECORD_THREAD_MAP = 73,
242 PERF_RECORD_CPU_MAP = 74,
243 PERF_RECORD_STAT_CONFIG = 75,
244 PERF_RECORD_STAT = 76,
245 PERF_RECORD_STAT_ROUND = 77,
246 PERF_RECORD_EVENT_UPDATE = 78,
247 PERF_RECORD_TIME_CONV = 79,
248 PERF_RECORD_HEADER_FEATURE = 80,
249 PERF_RECORD_HEADER_MAX
252 enum auxtrace_error_type {
253 PERF_AUXTRACE_ERROR_ITRACE = 1,
254 PERF_AUXTRACE_ERROR_MAX
257 /* Attribute type for custom synthesized events */
258 #define PERF_TYPE_SYNTH (INT_MAX + 1U)
260 /* Attribute config for custom synthesized events */
262 PERF_SYNTH_INTEL_PTWRITE,
263 PERF_SYNTH_INTEL_MWAIT,
264 PERF_SYNTH_INTEL_PWRE,
265 PERF_SYNTH_INTEL_EXSTOP,
266 PERF_SYNTH_INTEL_PWRX,
267 PERF_SYNTH_INTEL_CBR,
271 * Raw data formats for synthesized events. Note that 4 bytes of padding are
272 * present to match the 'size' member of PERF_SAMPLE_RAW data which is always
273 * 8-byte aligned. That means we must dereference raw_data with an offset of 4.
274 * Refer perf_sample__synth_ptr() and perf_synth__raw_data(). It also means the
275 * structure sizes are 4 bytes bigger than the raw_size, refer
276 * perf_synth__raw_size().
279 struct perf_synth_intel_ptwrite {
291 struct perf_synth_intel_mwait {
305 struct perf_synth_intel_pwre {
320 struct perf_synth_intel_exstop {
331 struct perf_synth_intel_pwrx {
336 u64 deepest_cstate : 4,
345 struct perf_synth_intel_cbr {
361 * raw_data is always 4 bytes from an 8-byte boundary, so subtract 4 to get
364 static inline void *perf_sample__synth_ptr(struct perf_sample *sample)
366 return sample->raw_data - 4;
369 static inline void *perf_synth__raw_data(void *p)
374 #define perf_synth__raw_size(d) (sizeof(d) - 4)
376 #define perf_sample__bad_synth_size(s, d) ((s)->raw_size < sizeof(d) - 4)
379 * The kernel collects the number of events it couldn't send in a stretch and
380 * when possible sends this number in a PERF_RECORD_LOST event. The number of
381 * such "chunks" of lost events is stored in .nr_events[PERF_EVENT_LOST] while
382 * total_lost tells exactly how many events the kernel in fact lost, i.e. it is
383 * the sum of all struct lost_event.lost fields reported.
385 * The kernel discards mixed up samples and sends the number in a
386 * PERF_RECORD_LOST_SAMPLES event. The number of lost-samples events is stored
387 * in .nr_events[PERF_RECORD_LOST_SAMPLES] while total_lost_samples tells
388 * exactly how many samples the kernel in fact dropped, i.e. it is the sum of
389 * all struct lost_samples_event.lost fields reported.
391 * The total_period is needed because by default auto-freq is used, so
392 * multipling nr_events[PERF_EVENT_SAMPLE] by a frequency isn't possible to get
393 * the total number of low level events, it is necessary to to sum all struct
394 * sample_event.period and stash the result in total_period.
396 struct events_stats {
398 u64 total_non_filtered_period;
400 u64 total_lost_samples;
402 u64 total_aux_partial;
403 u64 total_invalid_chains;
404 u32 nr_events[PERF_RECORD_HEADER_MAX];
405 u32 nr_non_filtered_samples;
407 u32 nr_unknown_events;
408 u32 nr_invalid_chains;
410 u32 nr_unprocessable_samples;
411 u32 nr_auxtrace_errors[PERF_AUXTRACE_ERROR_MAX];
412 u32 nr_proc_map_timeout;
416 PERF_CPU_MAP__CPUS = 0,
417 PERF_CPU_MAP__MASK = 1,
420 struct cpu_map_entries {
425 struct cpu_map_mask {
428 unsigned long mask[];
431 struct cpu_map_data {
436 struct cpu_map_event {
437 struct perf_event_header header;
438 struct cpu_map_data data;
442 struct perf_event_header header;
443 struct perf_event_attr attr;
448 PERF_EVENT_UPDATE__UNIT = 0,
449 PERF_EVENT_UPDATE__SCALE = 1,
450 PERF_EVENT_UPDATE__NAME = 2,
451 PERF_EVENT_UPDATE__CPUS = 3,
454 struct event_update_event_cpus {
455 struct cpu_map_data cpus;
458 struct event_update_event_scale {
462 struct event_update_event {
463 struct perf_event_header header;
470 #define MAX_EVENT_NAME 64
472 struct perf_trace_event_type {
474 char name[MAX_EVENT_NAME];
477 struct event_type_event {
478 struct perf_event_header header;
479 struct perf_trace_event_type event_type;
482 struct tracing_data_event {
483 struct perf_event_header header;
487 struct id_index_entry {
494 struct id_index_event {
495 struct perf_event_header header;
497 struct id_index_entry entries[0];
500 struct auxtrace_info_event {
501 struct perf_event_header header;
503 u32 reserved__; /* For alignment */
507 struct auxtrace_event {
508 struct perf_event_header header;
515 u32 reserved__; /* For alignment */
518 #define MAX_AUXTRACE_ERROR_MSG 64
520 struct auxtrace_error_event {
521 struct perf_event_header header;
527 u32 reserved__; /* For alignment */
529 char msg[MAX_AUXTRACE_ERROR_MSG];
533 struct perf_event_header header;
539 struct itrace_start_event {
540 struct perf_event_header header;
544 struct context_switch_event {
545 struct perf_event_header header;
550 struct thread_map_event_entry {
555 struct thread_map_event {
556 struct perf_event_header header;
558 struct thread_map_event_entry entries[];
562 PERF_STAT_CONFIG_TERM__AGGR_MODE = 0,
563 PERF_STAT_CONFIG_TERM__INTERVAL = 1,
564 PERF_STAT_CONFIG_TERM__SCALE = 2,
565 PERF_STAT_CONFIG_TERM__MAX = 3,
568 struct stat_config_event_entry {
573 struct stat_config_event {
574 struct perf_event_header header;
576 struct stat_config_event_entry data[];
580 struct perf_event_header header;
597 PERF_STAT_ROUND_TYPE__INTERVAL = 0,
598 PERF_STAT_ROUND_TYPE__FINAL = 1,
601 struct stat_round_event {
602 struct perf_event_header header;
607 struct time_conv_event {
608 struct perf_event_header header;
614 struct feature_event {
615 struct perf_event_header header;
621 struct perf_event_header header;
622 struct mmap_event mmap;
623 struct mmap2_event mmap2;
624 struct comm_event comm;
625 struct namespaces_event namespaces;
626 struct fork_event fork;
627 struct lost_event lost;
628 struct lost_samples_event lost_samples;
629 struct read_event read;
630 struct throttle_event throttle;
631 struct sample_event sample;
632 struct attr_event attr;
633 struct event_update_event event_update;
634 struct event_type_event event_type;
635 struct tracing_data_event tracing_data;
636 struct build_id_event build_id;
637 struct id_index_event id_index;
638 struct auxtrace_info_event auxtrace_info;
639 struct auxtrace_event auxtrace;
640 struct auxtrace_error_event auxtrace_error;
641 struct aux_event aux;
642 struct itrace_start_event itrace_start;
643 struct context_switch_event context_switch;
644 struct thread_map_event thread_map;
645 struct cpu_map_event cpu_map;
646 struct stat_config_event stat_config;
647 struct stat_event stat;
648 struct stat_round_event stat_round;
649 struct time_conv_event time_conv;
650 struct feature_event feat;
653 void perf_event__print_totals(void);
658 struct perf_stat_config;
659 struct perf_counts_values;
661 typedef int (*perf_event__handler_t)(struct perf_tool *tool,
662 union perf_event *event,
663 struct perf_sample *sample,
664 struct machine *machine);
666 int perf_event__synthesize_thread_map(struct perf_tool *tool,
667 struct thread_map *threads,
668 perf_event__handler_t process,
669 struct machine *machine, bool mmap_data,
670 unsigned int proc_map_timeout);
671 int perf_event__synthesize_thread_map2(struct perf_tool *tool,
672 struct thread_map *threads,
673 perf_event__handler_t process,
674 struct machine *machine);
675 int perf_event__synthesize_cpu_map(struct perf_tool *tool,
676 struct cpu_map *cpus,
677 perf_event__handler_t process,
678 struct machine *machine);
679 int perf_event__synthesize_threads(struct perf_tool *tool,
680 perf_event__handler_t process,
681 struct machine *machine, bool mmap_data,
682 unsigned int proc_map_timeout);
683 int perf_event__synthesize_kernel_mmap(struct perf_tool *tool,
684 perf_event__handler_t process,
685 struct machine *machine);
686 int perf_event__synthesize_stat_config(struct perf_tool *tool,
687 struct perf_stat_config *config,
688 perf_event__handler_t process,
689 struct machine *machine);
690 void perf_event__read_stat_config(struct perf_stat_config *config,
691 struct stat_config_event *event);
692 int perf_event__synthesize_stat(struct perf_tool *tool,
693 u32 cpu, u32 thread, u64 id,
694 struct perf_counts_values *count,
695 perf_event__handler_t process,
696 struct machine *machine);
697 int perf_event__synthesize_stat_round(struct perf_tool *tool,
699 perf_event__handler_t process,
700 struct machine *machine);
701 int perf_event__synthesize_modules(struct perf_tool *tool,
702 perf_event__handler_t process,
703 struct machine *machine);
705 int perf_event__process_comm(struct perf_tool *tool,
706 union perf_event *event,
707 struct perf_sample *sample,
708 struct machine *machine);
709 int perf_event__process_lost(struct perf_tool *tool,
710 union perf_event *event,
711 struct perf_sample *sample,
712 struct machine *machine);
713 int perf_event__process_lost_samples(struct perf_tool *tool,
714 union perf_event *event,
715 struct perf_sample *sample,
716 struct machine *machine);
717 int perf_event__process_aux(struct perf_tool *tool,
718 union perf_event *event,
719 struct perf_sample *sample,
720 struct machine *machine);
721 int perf_event__process_itrace_start(struct perf_tool *tool,
722 union perf_event *event,
723 struct perf_sample *sample,
724 struct machine *machine);
725 int perf_event__process_switch(struct perf_tool *tool,
726 union perf_event *event,
727 struct perf_sample *sample,
728 struct machine *machine);
729 int perf_event__process_namespaces(struct perf_tool *tool,
730 union perf_event *event,
731 struct perf_sample *sample,
732 struct machine *machine);
733 int perf_event__process_mmap(struct perf_tool *tool,
734 union perf_event *event,
735 struct perf_sample *sample,
736 struct machine *machine);
737 int perf_event__process_mmap2(struct perf_tool *tool,
738 union perf_event *event,
739 struct perf_sample *sample,
740 struct machine *machine);
741 int perf_event__process_fork(struct perf_tool *tool,
742 union perf_event *event,
743 struct perf_sample *sample,
744 struct machine *machine);
745 int perf_event__process_exit(struct perf_tool *tool,
746 union perf_event *event,
747 struct perf_sample *sample,
748 struct machine *machine);
749 int perf_event__process(struct perf_tool *tool,
750 union perf_event *event,
751 struct perf_sample *sample,
752 struct machine *machine);
754 struct addr_location;
756 int machine__resolve(struct machine *machine, struct addr_location *al,
757 struct perf_sample *sample);
759 void addr_location__put(struct addr_location *al);
763 bool is_bts_event(struct perf_event_attr *attr);
764 bool sample_addr_correlates_sym(struct perf_event_attr *attr);
765 void thread__resolve(struct thread *thread, struct addr_location *al,
766 struct perf_sample *sample);
768 const char *perf_event__name(unsigned int id);
770 size_t perf_event__sample_event_size(const struct perf_sample *sample, u64 type,
772 int perf_event__synthesize_sample(union perf_event *event, u64 type,
774 const struct perf_sample *sample,
777 pid_t perf_event__synthesize_comm(struct perf_tool *tool,
778 union perf_event *event, pid_t pid,
779 perf_event__handler_t process,
780 struct machine *machine);
782 int perf_event__synthesize_namespaces(struct perf_tool *tool,
783 union perf_event *event,
784 pid_t pid, pid_t tgid,
785 perf_event__handler_t process,
786 struct machine *machine);
788 int perf_event__synthesize_mmap_events(struct perf_tool *tool,
789 union perf_event *event,
790 pid_t pid, pid_t tgid,
791 perf_event__handler_t process,
792 struct machine *machine,
794 unsigned int proc_map_timeout);
796 size_t perf_event__fprintf_comm(union perf_event *event, FILE *fp);
797 size_t perf_event__fprintf_mmap(union perf_event *event, FILE *fp);
798 size_t perf_event__fprintf_mmap2(union perf_event *event, FILE *fp);
799 size_t perf_event__fprintf_task(union perf_event *event, FILE *fp);
800 size_t perf_event__fprintf_aux(union perf_event *event, FILE *fp);
801 size_t perf_event__fprintf_itrace_start(union perf_event *event, FILE *fp);
802 size_t perf_event__fprintf_switch(union perf_event *event, FILE *fp);
803 size_t perf_event__fprintf_thread_map(union perf_event *event, FILE *fp);
804 size_t perf_event__fprintf_cpu_map(union perf_event *event, FILE *fp);
805 size_t perf_event__fprintf_namespaces(union perf_event *event, FILE *fp);
806 size_t perf_event__fprintf(union perf_event *event, FILE *fp);
808 int kallsyms__get_function_start(const char *kallsyms_filename,
809 const char *symbol_name, u64 *addr);
811 void *cpu_map_data__alloc(struct cpu_map *map, size_t *size, u16 *type, int *max);
812 void cpu_map_data__synthesize(struct cpu_map_data *data, struct cpu_map *map,
815 void event_attr_init(struct perf_event_attr *attr);
817 int perf_event_paranoid(void);
819 extern int sysctl_perf_event_max_stack;
820 extern int sysctl_perf_event_max_contexts_per_stack;
822 #endif /* __PERF_RECORD_H */