1 #ifndef __PERF_RECORD_H
2 #define __PERF_RECORD_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;
43 struct perf_event_header header;
50 struct perf_event_header header;
55 struct lost_samples_event {
56 struct perf_event_header header;
61 * PERF_FORMAT_ENABLED | PERF_FORMAT_RUNNING | PERF_FORMAT_ID
64 struct perf_event_header header;
72 struct throttle_event {
73 struct perf_event_header header;
79 #define PERF_SAMPLE_MASK \
80 (PERF_SAMPLE_IP | PERF_SAMPLE_TID | \
81 PERF_SAMPLE_TIME | PERF_SAMPLE_ADDR | \
82 PERF_SAMPLE_ID | PERF_SAMPLE_STREAM_ID | \
83 PERF_SAMPLE_CPU | PERF_SAMPLE_PERIOD | \
84 PERF_SAMPLE_IDENTIFIER)
86 /* perf sample has 16 bits size limit */
87 #define PERF_SAMPLE_MAX_SIZE (1 << 16)
90 struct perf_event_header header;
99 /* Cached values/mask filled by first register access. */
100 u64 cache_regs[PERF_REGS_MAX];
110 struct sample_read_value {
121 struct sample_read_value *values;
123 struct sample_read_value one;
127 struct ip_callchain {
132 struct branch_flags {
141 struct branch_entry {
144 struct branch_flags flags;
147 struct branch_stack {
149 struct branch_entry entries[0];
153 PERF_IP_FLAG_BRANCH = 1ULL << 0,
154 PERF_IP_FLAG_CALL = 1ULL << 1,
155 PERF_IP_FLAG_RETURN = 1ULL << 2,
156 PERF_IP_FLAG_CONDITIONAL = 1ULL << 3,
157 PERF_IP_FLAG_SYSCALLRET = 1ULL << 4,
158 PERF_IP_FLAG_ASYNC = 1ULL << 5,
159 PERF_IP_FLAG_INTERRUPT = 1ULL << 6,
160 PERF_IP_FLAG_TX_ABORT = 1ULL << 7,
161 PERF_IP_FLAG_TRACE_BEGIN = 1ULL << 8,
162 PERF_IP_FLAG_TRACE_END = 1ULL << 9,
163 PERF_IP_FLAG_IN_TX = 1ULL << 10,
166 #define PERF_IP_FLAG_CHARS "bcrosyiABEx"
168 #define PERF_BRANCH_MASK (\
169 PERF_IP_FLAG_BRANCH |\
171 PERF_IP_FLAG_RETURN |\
172 PERF_IP_FLAG_CONDITIONAL |\
173 PERF_IP_FLAG_SYSCALLRET |\
174 PERF_IP_FLAG_ASYNC |\
175 PERF_IP_FLAG_INTERRUPT |\
176 PERF_IP_FLAG_TX_ABORT |\
177 PERF_IP_FLAG_TRACE_BEGIN |\
178 PERF_IP_FLAG_TRACE_END)
196 struct ip_callchain *callchain;
197 struct branch_stack *branch_stack;
198 struct regs_dump user_regs;
199 struct regs_dump intr_regs;
200 struct stack_dump user_stack;
201 struct sample_read read;
204 #define PERF_MEM_DATA_SRC_NONE \
205 (PERF_MEM_S(OP, NA) |\
206 PERF_MEM_S(LVL, NA) |\
207 PERF_MEM_S(SNOOP, NA) |\
208 PERF_MEM_S(LOCK, NA) |\
211 struct build_id_event {
212 struct perf_event_header header;
214 u8 build_id[PERF_ALIGN(BUILD_ID_SIZE, sizeof(u64))];
218 enum perf_user_event_type { /* above any possible kernel type */
219 PERF_RECORD_USER_TYPE_START = 64,
220 PERF_RECORD_HEADER_ATTR = 64,
221 PERF_RECORD_HEADER_EVENT_TYPE = 65, /* depreceated */
222 PERF_RECORD_HEADER_TRACING_DATA = 66,
223 PERF_RECORD_HEADER_BUILD_ID = 67,
224 PERF_RECORD_FINISHED_ROUND = 68,
225 PERF_RECORD_ID_INDEX = 69,
226 PERF_RECORD_AUXTRACE_INFO = 70,
227 PERF_RECORD_AUXTRACE = 71,
228 PERF_RECORD_AUXTRACE_ERROR = 72,
229 PERF_RECORD_THREAD_MAP = 73,
230 PERF_RECORD_CPU_MAP = 74,
231 PERF_RECORD_STAT_CONFIG = 75,
232 PERF_RECORD_HEADER_MAX
235 enum auxtrace_error_type {
236 PERF_AUXTRACE_ERROR_ITRACE = 1,
237 PERF_AUXTRACE_ERROR_MAX
241 * The kernel collects the number of events it couldn't send in a stretch and
242 * when possible sends this number in a PERF_RECORD_LOST event. The number of
243 * such "chunks" of lost events is stored in .nr_events[PERF_EVENT_LOST] while
244 * total_lost tells exactly how many events the kernel in fact lost, i.e. it is
245 * the sum of all struct lost_event.lost fields reported.
247 * The kernel discards mixed up samples and sends the number in a
248 * PERF_RECORD_LOST_SAMPLES event. The number of lost-samples events is stored
249 * in .nr_events[PERF_RECORD_LOST_SAMPLES] while total_lost_samples tells
250 * exactly how many samples the kernel in fact dropped, i.e. it is the sum of
251 * all struct lost_samples_event.lost fields reported.
253 * The total_period is needed because by default auto-freq is used, so
254 * multipling nr_events[PERF_EVENT_SAMPLE] by a frequency isn't possible to get
255 * the total number of low level events, it is necessary to to sum all struct
256 * sample_event.period and stash the result in total_period.
258 struct events_stats {
260 u64 total_non_filtered_period;
262 u64 total_lost_samples;
264 u64 total_invalid_chains;
265 u32 nr_events[PERF_RECORD_HEADER_MAX];
266 u32 nr_non_filtered_samples;
268 u32 nr_unknown_events;
269 u32 nr_invalid_chains;
271 u32 nr_unprocessable_samples;
272 u32 nr_auxtrace_errors[PERF_AUXTRACE_ERROR_MAX];
273 u32 nr_proc_map_timeout;
277 PERF_CPU_MAP__CPUS = 0,
278 PERF_CPU_MAP__MASK = 1,
281 struct cpu_map_entries {
286 struct cpu_map_mask {
289 unsigned long mask[];
292 struct cpu_map_data {
297 struct cpu_map_event {
298 struct perf_event_header header;
299 struct cpu_map_data data;
303 struct perf_event_header header;
304 struct perf_event_attr attr;
308 #define MAX_EVENT_NAME 64
310 struct perf_trace_event_type {
312 char name[MAX_EVENT_NAME];
315 struct event_type_event {
316 struct perf_event_header header;
317 struct perf_trace_event_type event_type;
320 struct tracing_data_event {
321 struct perf_event_header header;
325 struct id_index_entry {
332 struct id_index_event {
333 struct perf_event_header header;
335 struct id_index_entry entries[0];
338 struct auxtrace_info_event {
339 struct perf_event_header header;
341 u32 reserved__; /* For alignment */
345 struct auxtrace_event {
346 struct perf_event_header header;
353 u32 reserved__; /* For alignment */
356 #define MAX_AUXTRACE_ERROR_MSG 64
358 struct auxtrace_error_event {
359 struct perf_event_header header;
365 u32 reserved__; /* For alignment */
367 char msg[MAX_AUXTRACE_ERROR_MSG];
371 struct perf_event_header header;
377 struct itrace_start_event {
378 struct perf_event_header header;
382 struct context_switch_event {
383 struct perf_event_header header;
388 struct thread_map_event_entry {
393 struct thread_map_event {
394 struct perf_event_header header;
396 struct thread_map_event_entry entries[];
400 PERF_STAT_CONFIG_TERM__AGGR_MODE = 0,
401 PERF_STAT_CONFIG_TERM__INTERVAL = 1,
402 PERF_STAT_CONFIG_TERM__SCALE = 2,
403 PERF_STAT_CONFIG_TERM__MAX = 3,
406 struct stat_config_event_entry {
411 struct stat_config_event {
412 struct perf_event_header header;
414 struct stat_config_event_entry data[];
418 struct perf_event_header header;
419 struct mmap_event mmap;
420 struct mmap2_event mmap2;
421 struct comm_event comm;
422 struct fork_event fork;
423 struct lost_event lost;
424 struct lost_samples_event lost_samples;
425 struct read_event read;
426 struct throttle_event throttle;
427 struct sample_event sample;
428 struct attr_event attr;
429 struct event_type_event event_type;
430 struct tracing_data_event tracing_data;
431 struct build_id_event build_id;
432 struct id_index_event id_index;
433 struct auxtrace_info_event auxtrace_info;
434 struct auxtrace_event auxtrace;
435 struct auxtrace_error_event auxtrace_error;
436 struct aux_event aux;
437 struct itrace_start_event itrace_start;
438 struct context_switch_event context_switch;
439 struct thread_map_event thread_map;
440 struct cpu_map_event cpu_map;
441 struct stat_config_event stat_config;
444 void perf_event__print_totals(void);
449 struct perf_stat_config;
451 typedef int (*perf_event__handler_t)(struct perf_tool *tool,
452 union perf_event *event,
453 struct perf_sample *sample,
454 struct machine *machine);
456 int perf_event__synthesize_thread_map(struct perf_tool *tool,
457 struct thread_map *threads,
458 perf_event__handler_t process,
459 struct machine *machine, bool mmap_data,
460 unsigned int proc_map_timeout);
461 int perf_event__synthesize_thread_map2(struct perf_tool *tool,
462 struct thread_map *threads,
463 perf_event__handler_t process,
464 struct machine *machine);
465 int perf_event__synthesize_cpu_map(struct perf_tool *tool,
466 struct cpu_map *cpus,
467 perf_event__handler_t process,
468 struct machine *machine);
469 int perf_event__synthesize_threads(struct perf_tool *tool,
470 perf_event__handler_t process,
471 struct machine *machine, bool mmap_data,
472 unsigned int proc_map_timeout);
473 int perf_event__synthesize_kernel_mmap(struct perf_tool *tool,
474 perf_event__handler_t process,
475 struct machine *machine);
476 int perf_event__synthesize_stat_config(struct perf_tool *tool,
477 struct perf_stat_config *config,
478 perf_event__handler_t process,
479 struct machine *machine);
480 void perf_event__read_stat_config(struct perf_stat_config *config,
481 struct stat_config_event *event);
483 int perf_event__synthesize_modules(struct perf_tool *tool,
484 perf_event__handler_t process,
485 struct machine *machine);
487 int perf_event__process_comm(struct perf_tool *tool,
488 union perf_event *event,
489 struct perf_sample *sample,
490 struct machine *machine);
491 int perf_event__process_lost(struct perf_tool *tool,
492 union perf_event *event,
493 struct perf_sample *sample,
494 struct machine *machine);
495 int perf_event__process_lost_samples(struct perf_tool *tool,
496 union perf_event *event,
497 struct perf_sample *sample,
498 struct machine *machine);
499 int perf_event__process_aux(struct perf_tool *tool,
500 union perf_event *event,
501 struct perf_sample *sample,
502 struct machine *machine);
503 int perf_event__process_itrace_start(struct perf_tool *tool,
504 union perf_event *event,
505 struct perf_sample *sample,
506 struct machine *machine);
507 int perf_event__process_switch(struct perf_tool *tool,
508 union perf_event *event,
509 struct perf_sample *sample,
510 struct machine *machine);
511 int perf_event__process_mmap(struct perf_tool *tool,
512 union perf_event *event,
513 struct perf_sample *sample,
514 struct machine *machine);
515 int perf_event__process_mmap2(struct perf_tool *tool,
516 union perf_event *event,
517 struct perf_sample *sample,
518 struct machine *machine);
519 int perf_event__process_fork(struct perf_tool *tool,
520 union perf_event *event,
521 struct perf_sample *sample,
522 struct machine *machine);
523 int perf_event__process_exit(struct perf_tool *tool,
524 union perf_event *event,
525 struct perf_sample *sample,
526 struct machine *machine);
527 int perf_event__process(struct perf_tool *tool,
528 union perf_event *event,
529 struct perf_sample *sample,
530 struct machine *machine);
532 struct addr_location;
534 int perf_event__preprocess_sample(const union perf_event *event,
535 struct machine *machine,
536 struct addr_location *al,
537 struct perf_sample *sample);
539 void addr_location__put(struct addr_location *al);
543 bool is_bts_event(struct perf_event_attr *attr);
544 bool sample_addr_correlates_sym(struct perf_event_attr *attr);
545 void perf_event__preprocess_sample_addr(union perf_event *event,
546 struct perf_sample *sample,
547 struct thread *thread,
548 struct addr_location *al);
550 const char *perf_event__name(unsigned int id);
552 size_t perf_event__sample_event_size(const struct perf_sample *sample, u64 type,
554 int perf_event__synthesize_sample(union perf_event *event, u64 type,
556 const struct perf_sample *sample,
559 pid_t perf_event__synthesize_comm(struct perf_tool *tool,
560 union perf_event *event, pid_t pid,
561 perf_event__handler_t process,
562 struct machine *machine);
564 int perf_event__synthesize_mmap_events(struct perf_tool *tool,
565 union perf_event *event,
566 pid_t pid, pid_t tgid,
567 perf_event__handler_t process,
568 struct machine *machine,
570 unsigned int proc_map_timeout);
572 size_t perf_event__fprintf_comm(union perf_event *event, FILE *fp);
573 size_t perf_event__fprintf_mmap(union perf_event *event, FILE *fp);
574 size_t perf_event__fprintf_mmap2(union perf_event *event, FILE *fp);
575 size_t perf_event__fprintf_task(union perf_event *event, FILE *fp);
576 size_t perf_event__fprintf_aux(union perf_event *event, FILE *fp);
577 size_t perf_event__fprintf_itrace_start(union perf_event *event, FILE *fp);
578 size_t perf_event__fprintf_switch(union perf_event *event, FILE *fp);
579 size_t perf_event__fprintf_thread_map(union perf_event *event, FILE *fp);
580 size_t perf_event__fprintf_cpu_map(union perf_event *event, FILE *fp);
581 size_t perf_event__fprintf(union perf_event *event, FILE *fp);
583 u64 kallsyms__get_function_start(const char *kallsyms_filename,
584 const char *symbol_name);
586 void *cpu_map_data__alloc(struct cpu_map *map, size_t *size, u16 *type, int *max);
587 void cpu_map_data__synthesize(struct cpu_map_data *data, struct cpu_map *map,
589 #endif /* __PERF_RECORD_H */