1 /* SPDX-License-Identifier: GPL-2.0 WITH Linux-syscall-note */
5 * Copyright (C) 2008-2009, Thomas Gleixner <tglx@linutronix.de>
6 * Copyright (C) 2008-2011, Red Hat, Inc., Ingo Molnar
7 * Copyright (C) 2008-2011, Red Hat, Inc., Peter Zijlstra
9 * Data type definitions, declarations, prototypes.
11 * Started by: Thomas Gleixner and Ingo Molnar
13 * For licencing details see kernel-base/COPYING
15 #ifndef _UAPI_LINUX_PERF_EVENT_H
16 #define _UAPI_LINUX_PERF_EVENT_H
18 #include <linux/types.h>
19 #include <linux/ioctl.h>
20 #include <asm/byteorder.h>
23 * User-space ABI bits:
30 PERF_TYPE_HARDWARE = 0,
31 PERF_TYPE_SOFTWARE = 1,
32 PERF_TYPE_TRACEPOINT = 2,
33 PERF_TYPE_HW_CACHE = 3,
35 PERF_TYPE_BREAKPOINT = 5,
37 PERF_TYPE_MAX, /* non-ABI */
41 * Generalized performance event event_id types, used by the
42 * attr.event_id parameter of the sys_perf_event_open()
47 * Common hardware events, generalized by the kernel:
49 PERF_COUNT_HW_CPU_CYCLES = 0,
50 PERF_COUNT_HW_INSTRUCTIONS = 1,
51 PERF_COUNT_HW_CACHE_REFERENCES = 2,
52 PERF_COUNT_HW_CACHE_MISSES = 3,
53 PERF_COUNT_HW_BRANCH_INSTRUCTIONS = 4,
54 PERF_COUNT_HW_BRANCH_MISSES = 5,
55 PERF_COUNT_HW_BUS_CYCLES = 6,
56 PERF_COUNT_HW_STALLED_CYCLES_FRONTEND = 7,
57 PERF_COUNT_HW_STALLED_CYCLES_BACKEND = 8,
58 PERF_COUNT_HW_REF_CPU_CYCLES = 9,
60 PERF_COUNT_HW_MAX, /* non-ABI */
64 * Generalized hardware cache events:
66 * { L1-D, L1-I, LLC, ITLB, DTLB, BPU, NODE } x
67 * { read, write, prefetch } x
68 * { accesses, misses }
70 enum perf_hw_cache_id {
71 PERF_COUNT_HW_CACHE_L1D = 0,
72 PERF_COUNT_HW_CACHE_L1I = 1,
73 PERF_COUNT_HW_CACHE_LL = 2,
74 PERF_COUNT_HW_CACHE_DTLB = 3,
75 PERF_COUNT_HW_CACHE_ITLB = 4,
76 PERF_COUNT_HW_CACHE_BPU = 5,
77 PERF_COUNT_HW_CACHE_NODE = 6,
79 PERF_COUNT_HW_CACHE_MAX, /* non-ABI */
82 enum perf_hw_cache_op_id {
83 PERF_COUNT_HW_CACHE_OP_READ = 0,
84 PERF_COUNT_HW_CACHE_OP_WRITE = 1,
85 PERF_COUNT_HW_CACHE_OP_PREFETCH = 2,
87 PERF_COUNT_HW_CACHE_OP_MAX, /* non-ABI */
90 enum perf_hw_cache_op_result_id {
91 PERF_COUNT_HW_CACHE_RESULT_ACCESS = 0,
92 PERF_COUNT_HW_CACHE_RESULT_MISS = 1,
94 PERF_COUNT_HW_CACHE_RESULT_MAX, /* non-ABI */
98 * Special "software" events provided by the kernel, even if the hardware
99 * does not support performance events. These events measure various
100 * physical and sw events of the kernel (and allow the profiling of them as
104 PERF_COUNT_SW_CPU_CLOCK = 0,
105 PERF_COUNT_SW_TASK_CLOCK = 1,
106 PERF_COUNT_SW_PAGE_FAULTS = 2,
107 PERF_COUNT_SW_CONTEXT_SWITCHES = 3,
108 PERF_COUNT_SW_CPU_MIGRATIONS = 4,
109 PERF_COUNT_SW_PAGE_FAULTS_MIN = 5,
110 PERF_COUNT_SW_PAGE_FAULTS_MAJ = 6,
111 PERF_COUNT_SW_ALIGNMENT_FAULTS = 7,
112 PERF_COUNT_SW_EMULATION_FAULTS = 8,
113 PERF_COUNT_SW_DUMMY = 9,
114 PERF_COUNT_SW_BPF_OUTPUT = 10,
116 PERF_COUNT_SW_MAX, /* non-ABI */
120 * Bits that can be set in attr.sample_type to request information
121 * in the overflow packets.
123 enum perf_event_sample_format {
124 PERF_SAMPLE_IP = 1U << 0,
125 PERF_SAMPLE_TID = 1U << 1,
126 PERF_SAMPLE_TIME = 1U << 2,
127 PERF_SAMPLE_ADDR = 1U << 3,
128 PERF_SAMPLE_READ = 1U << 4,
129 PERF_SAMPLE_CALLCHAIN = 1U << 5,
130 PERF_SAMPLE_ID = 1U << 6,
131 PERF_SAMPLE_CPU = 1U << 7,
132 PERF_SAMPLE_PERIOD = 1U << 8,
133 PERF_SAMPLE_STREAM_ID = 1U << 9,
134 PERF_SAMPLE_RAW = 1U << 10,
135 PERF_SAMPLE_BRANCH_STACK = 1U << 11,
136 PERF_SAMPLE_REGS_USER = 1U << 12,
137 PERF_SAMPLE_STACK_USER = 1U << 13,
138 PERF_SAMPLE_WEIGHT = 1U << 14,
139 PERF_SAMPLE_DATA_SRC = 1U << 15,
140 PERF_SAMPLE_IDENTIFIER = 1U << 16,
141 PERF_SAMPLE_TRANSACTION = 1U << 17,
142 PERF_SAMPLE_REGS_INTR = 1U << 18,
143 PERF_SAMPLE_PHYS_ADDR = 1U << 19,
144 PERF_SAMPLE_AUX = 1U << 20,
145 PERF_SAMPLE_CGROUP = 1U << 21,
147 PERF_SAMPLE_MAX = 1U << 22, /* non-ABI */
149 __PERF_SAMPLE_CALLCHAIN_EARLY = 1ULL << 63, /* non-ABI; internal use */
153 * values to program into branch_sample_type when PERF_SAMPLE_BRANCH is set
155 * If the user does not pass priv level information via branch_sample_type,
156 * the kernel uses the event's priv level. Branch and event priv levels do
157 * not have to match. Branch priv level is checked for permissions.
159 * The branch types can be combined, however BRANCH_ANY covers all types
160 * of branches and therefore it supersedes all the other types.
162 enum perf_branch_sample_type_shift {
163 PERF_SAMPLE_BRANCH_USER_SHIFT = 0, /* user branches */
164 PERF_SAMPLE_BRANCH_KERNEL_SHIFT = 1, /* kernel branches */
165 PERF_SAMPLE_BRANCH_HV_SHIFT = 2, /* hypervisor branches */
167 PERF_SAMPLE_BRANCH_ANY_SHIFT = 3, /* any branch types */
168 PERF_SAMPLE_BRANCH_ANY_CALL_SHIFT = 4, /* any call branch */
169 PERF_SAMPLE_BRANCH_ANY_RETURN_SHIFT = 5, /* any return branch */
170 PERF_SAMPLE_BRANCH_IND_CALL_SHIFT = 6, /* indirect calls */
171 PERF_SAMPLE_BRANCH_ABORT_TX_SHIFT = 7, /* transaction aborts */
172 PERF_SAMPLE_BRANCH_IN_TX_SHIFT = 8, /* in transaction */
173 PERF_SAMPLE_BRANCH_NO_TX_SHIFT = 9, /* not in transaction */
174 PERF_SAMPLE_BRANCH_COND_SHIFT = 10, /* conditional branches */
176 PERF_SAMPLE_BRANCH_CALL_STACK_SHIFT = 11, /* call/ret stack */
177 PERF_SAMPLE_BRANCH_IND_JUMP_SHIFT = 12, /* indirect jumps */
178 PERF_SAMPLE_BRANCH_CALL_SHIFT = 13, /* direct call */
180 PERF_SAMPLE_BRANCH_NO_FLAGS_SHIFT = 14, /* no flags */
181 PERF_SAMPLE_BRANCH_NO_CYCLES_SHIFT = 15, /* no cycles */
183 PERF_SAMPLE_BRANCH_TYPE_SAVE_SHIFT = 16, /* save branch type */
185 PERF_SAMPLE_BRANCH_HW_INDEX_SHIFT = 17, /* save low level index of raw branch records */
187 PERF_SAMPLE_BRANCH_MAX_SHIFT /* non-ABI */
190 enum perf_branch_sample_type {
191 PERF_SAMPLE_BRANCH_USER = 1U << PERF_SAMPLE_BRANCH_USER_SHIFT,
192 PERF_SAMPLE_BRANCH_KERNEL = 1U << PERF_SAMPLE_BRANCH_KERNEL_SHIFT,
193 PERF_SAMPLE_BRANCH_HV = 1U << PERF_SAMPLE_BRANCH_HV_SHIFT,
195 PERF_SAMPLE_BRANCH_ANY = 1U << PERF_SAMPLE_BRANCH_ANY_SHIFT,
196 PERF_SAMPLE_BRANCH_ANY_CALL = 1U << PERF_SAMPLE_BRANCH_ANY_CALL_SHIFT,
197 PERF_SAMPLE_BRANCH_ANY_RETURN = 1U << PERF_SAMPLE_BRANCH_ANY_RETURN_SHIFT,
198 PERF_SAMPLE_BRANCH_IND_CALL = 1U << PERF_SAMPLE_BRANCH_IND_CALL_SHIFT,
199 PERF_SAMPLE_BRANCH_ABORT_TX = 1U << PERF_SAMPLE_BRANCH_ABORT_TX_SHIFT,
200 PERF_SAMPLE_BRANCH_IN_TX = 1U << PERF_SAMPLE_BRANCH_IN_TX_SHIFT,
201 PERF_SAMPLE_BRANCH_NO_TX = 1U << PERF_SAMPLE_BRANCH_NO_TX_SHIFT,
202 PERF_SAMPLE_BRANCH_COND = 1U << PERF_SAMPLE_BRANCH_COND_SHIFT,
204 PERF_SAMPLE_BRANCH_CALL_STACK = 1U << PERF_SAMPLE_BRANCH_CALL_STACK_SHIFT,
205 PERF_SAMPLE_BRANCH_IND_JUMP = 1U << PERF_SAMPLE_BRANCH_IND_JUMP_SHIFT,
206 PERF_SAMPLE_BRANCH_CALL = 1U << PERF_SAMPLE_BRANCH_CALL_SHIFT,
208 PERF_SAMPLE_BRANCH_NO_FLAGS = 1U << PERF_SAMPLE_BRANCH_NO_FLAGS_SHIFT,
209 PERF_SAMPLE_BRANCH_NO_CYCLES = 1U << PERF_SAMPLE_BRANCH_NO_CYCLES_SHIFT,
211 PERF_SAMPLE_BRANCH_TYPE_SAVE =
212 1U << PERF_SAMPLE_BRANCH_TYPE_SAVE_SHIFT,
214 PERF_SAMPLE_BRANCH_HW_INDEX = 1U << PERF_SAMPLE_BRANCH_HW_INDEX_SHIFT,
216 PERF_SAMPLE_BRANCH_MAX = 1U << PERF_SAMPLE_BRANCH_MAX_SHIFT,
220 * Common flow change classification
223 PERF_BR_UNKNOWN = 0, /* unknown */
224 PERF_BR_COND = 1, /* conditional */
225 PERF_BR_UNCOND = 2, /* unconditional */
226 PERF_BR_IND = 3, /* indirect */
227 PERF_BR_CALL = 4, /* function call */
228 PERF_BR_IND_CALL = 5, /* indirect function call */
229 PERF_BR_RET = 6, /* function return */
230 PERF_BR_SYSCALL = 7, /* syscall */
231 PERF_BR_SYSRET = 8, /* syscall return */
232 PERF_BR_COND_CALL = 9, /* conditional function call */
233 PERF_BR_COND_RET = 10, /* conditional function return */
237 #define PERF_SAMPLE_BRANCH_PLM_ALL \
238 (PERF_SAMPLE_BRANCH_USER|\
239 PERF_SAMPLE_BRANCH_KERNEL|\
240 PERF_SAMPLE_BRANCH_HV)
243 * Values to determine ABI of the registers dump.
245 enum perf_sample_regs_abi {
246 PERF_SAMPLE_REGS_ABI_NONE = 0,
247 PERF_SAMPLE_REGS_ABI_32 = 1,
248 PERF_SAMPLE_REGS_ABI_64 = 2,
252 * Values for the memory transaction event qualifier, mostly for
253 * abort events. Multiple bits can be set.
256 PERF_TXN_ELISION = (1 << 0), /* From elision */
257 PERF_TXN_TRANSACTION = (1 << 1), /* From transaction */
258 PERF_TXN_SYNC = (1 << 2), /* Instruction is related */
259 PERF_TXN_ASYNC = (1 << 3), /* Instruction not related */
260 PERF_TXN_RETRY = (1 << 4), /* Retry possible */
261 PERF_TXN_CONFLICT = (1 << 5), /* Conflict abort */
262 PERF_TXN_CAPACITY_WRITE = (1 << 6), /* Capacity write abort */
263 PERF_TXN_CAPACITY_READ = (1 << 7), /* Capacity read abort */
265 PERF_TXN_MAX = (1 << 8), /* non-ABI */
267 /* bits 32..63 are reserved for the abort code */
269 PERF_TXN_ABORT_MASK = (0xffffffffULL << 32),
270 PERF_TXN_ABORT_SHIFT = 32,
274 * The format of the data returned by read() on a perf event fd,
275 * as specified by attr.read_format:
277 * struct read_format {
279 * { u64 time_enabled; } && PERF_FORMAT_TOTAL_TIME_ENABLED
280 * { u64 time_running; } && PERF_FORMAT_TOTAL_TIME_RUNNING
281 * { u64 id; } && PERF_FORMAT_ID
282 * { u64 lost; } && PERF_FORMAT_LOST
283 * } && !PERF_FORMAT_GROUP
286 * { u64 time_enabled; } && PERF_FORMAT_TOTAL_TIME_ENABLED
287 * { u64 time_running; } && PERF_FORMAT_TOTAL_TIME_RUNNING
289 * { u64 id; } && PERF_FORMAT_ID
290 * { u64 lost; } && PERF_FORMAT_LOST
292 * } && PERF_FORMAT_GROUP
295 enum perf_event_read_format {
296 PERF_FORMAT_TOTAL_TIME_ENABLED = 1U << 0,
297 PERF_FORMAT_TOTAL_TIME_RUNNING = 1U << 1,
298 PERF_FORMAT_ID = 1U << 2,
299 PERF_FORMAT_GROUP = 1U << 3,
300 PERF_FORMAT_LOST = 1U << 4,
302 PERF_FORMAT_MAX = 1U << 5, /* non-ABI */
305 #define PERF_ATTR_SIZE_VER0 64 /* sizeof first published struct */
306 #define PERF_ATTR_SIZE_VER1 72 /* add: config2 */
307 #define PERF_ATTR_SIZE_VER2 80 /* add: branch_sample_type */
308 #define PERF_ATTR_SIZE_VER3 96 /* add: sample_regs_user */
309 /* add: sample_stack_user */
310 #define PERF_ATTR_SIZE_VER4 104 /* add: sample_regs_intr */
311 #define PERF_ATTR_SIZE_VER5 112 /* add: aux_watermark */
312 #define PERF_ATTR_SIZE_VER6 120 /* add: aux_sample_size */
315 * Hardware event_id to monitor via a performance monitoring event:
317 * @sample_max_stack: Max number of frame pointers in a callchain,
318 * should be < /proc/sys/kernel/perf_event_max_stack
320 struct perf_event_attr {
323 * Major type: hardware/software/tracepoint/etc.
328 * Size of the attr structure, for fwd/bwd compat.
333 * Type specific configuration information.
345 __u64 disabled : 1, /* off by default */
346 inherit : 1, /* children inherit it */
347 pinned : 1, /* must always be on PMU */
348 exclusive : 1, /* only group on PMU */
349 exclude_user : 1, /* don't count user */
350 exclude_kernel : 1, /* ditto kernel */
351 exclude_hv : 1, /* ditto hypervisor */
352 exclude_idle : 1, /* don't count when idle */
353 mmap : 1, /* include mmap data */
354 comm : 1, /* include comm data */
355 freq : 1, /* use freq, not period */
356 inherit_stat : 1, /* per task counts */
357 enable_on_exec : 1, /* next exec enables */
358 task : 1, /* trace fork/exit */
359 watermark : 1, /* wakeup_watermark */
363 * 0 - SAMPLE_IP can have arbitrary skid
364 * 1 - SAMPLE_IP must have constant skid
365 * 2 - SAMPLE_IP requested to have 0 skid
366 * 3 - SAMPLE_IP must have 0 skid
368 * See also PERF_RECORD_MISC_EXACT_IP
370 precise_ip : 2, /* skid constraint */
371 mmap_data : 1, /* non-exec mmap data */
372 sample_id_all : 1, /* sample_type all events */
374 exclude_host : 1, /* don't count in host */
375 exclude_guest : 1, /* don't count in guest */
377 exclude_callchain_kernel : 1, /* exclude kernel callchains */
378 exclude_callchain_user : 1, /* exclude user callchains */
379 mmap2 : 1, /* include mmap with inode data */
380 comm_exec : 1, /* flag comm events that are due to an exec */
381 use_clockid : 1, /* use @clockid for time fields */
382 context_switch : 1, /* context switch data */
383 write_backward : 1, /* Write ring buffer from end to beginning */
384 namespaces : 1, /* include namespaces data */
385 ksymbol : 1, /* include ksymbol events */
386 bpf_event : 1, /* include bpf events */
387 aux_output : 1, /* generate AUX records instead of events */
388 cgroup : 1, /* include cgroup events */
389 text_poke : 1, /* include text poke events */
393 __u32 wakeup_events; /* wakeup every n events */
394 __u32 wakeup_watermark; /* bytes before wakeup */
400 __u64 kprobe_func; /* for perf_kprobe */
401 __u64 uprobe_path; /* for perf_uprobe */
402 __u64 config1; /* extension of config */
406 __u64 kprobe_addr; /* when kprobe_func == NULL */
407 __u64 probe_offset; /* for perf_[k,u]probe */
408 __u64 config2; /* extension of config1 */
410 __u64 branch_sample_type; /* enum perf_branch_sample_type */
413 * Defines set of user regs to dump on samples.
414 * See asm/perf_regs.h for details.
416 __u64 sample_regs_user;
419 * Defines size of the user stack to dump on samples.
421 __u32 sample_stack_user;
425 * Defines set of regs to dump for each sample
427 * - precise = 0: PMU interrupt
428 * - precise > 0: sampled instruction
430 * See asm/perf_regs.h for details.
432 __u64 sample_regs_intr;
435 * Wakeup watermark for AUX area
438 __u16 sample_max_stack;
440 __u32 aux_sample_size;
445 * Structure used by below PERF_EVENT_IOC_QUERY_BPF command
446 * to query bpf programs attached to the same perf tracepoint
447 * as the given perf event.
449 struct perf_event_query_bpf {
451 * The below ids array length
455 * Set by the kernel to indicate the number of
460 * User provided buffer to store program ids
466 * Ioctls that can be done on a perf event fd:
468 #define PERF_EVENT_IOC_ENABLE _IO ('$', 0)
469 #define PERF_EVENT_IOC_DISABLE _IO ('$', 1)
470 #define PERF_EVENT_IOC_REFRESH _IO ('$', 2)
471 #define PERF_EVENT_IOC_RESET _IO ('$', 3)
472 #define PERF_EVENT_IOC_PERIOD _IOW('$', 4, __u64)
473 #define PERF_EVENT_IOC_SET_OUTPUT _IO ('$', 5)
474 #define PERF_EVENT_IOC_SET_FILTER _IOW('$', 6, char *)
475 #define PERF_EVENT_IOC_ID _IOR('$', 7, __u64 *)
476 #define PERF_EVENT_IOC_SET_BPF _IOW('$', 8, __u32)
477 #define PERF_EVENT_IOC_PAUSE_OUTPUT _IOW('$', 9, __u32)
478 #define PERF_EVENT_IOC_QUERY_BPF _IOWR('$', 10, struct perf_event_query_bpf *)
479 #define PERF_EVENT_IOC_MODIFY_ATTRIBUTES _IOW('$', 11, struct perf_event_attr *)
481 enum perf_event_ioc_flags {
482 PERF_IOC_FLAG_GROUP = 1U << 0,
486 * Structure of the page that can be mapped via mmap
488 struct perf_event_mmap_page {
489 __u32 version; /* version number of this structure */
490 __u32 compat_version; /* lowest version this is compat with */
493 * Bits needed to read the hw events in user-space.
495 * u32 seq, time_mult, time_shift, index, width;
496 * u64 count, enabled, running;
497 * u64 cyc, time_offset;
504 * enabled = pc->time_enabled;
505 * running = pc->time_running;
507 * if (pc->cap_usr_time && enabled != running) {
509 * time_offset = pc->time_offset;
510 * time_mult = pc->time_mult;
511 * time_shift = pc->time_shift;
515 * count = pc->offset;
516 * if (pc->cap_user_rdpmc && index) {
517 * width = pc->pmc_width;
518 * pmc = rdpmc(index - 1);
522 * } while (pc->lock != seq);
524 * NOTE: for obvious reason this only works on self-monitoring
527 __u32 lock; /* seqlock for synchronization */
528 __u32 index; /* hardware event identifier */
529 __s64 offset; /* add to hardware event value */
530 __u64 time_enabled; /* time event active */
531 __u64 time_running; /* time event on cpu */
535 __u64 cap_bit0 : 1, /* Always 0, deprecated, see commit 860f085b74e9 */
536 cap_bit0_is_deprecated : 1, /* Always 1, signals that bit 0 is zero */
538 cap_user_rdpmc : 1, /* The RDPMC instruction can be used to read counts */
539 cap_user_time : 1, /* The time_{shift,mult,offset} fields are used */
540 cap_user_time_zero : 1, /* The time_zero field is used */
541 cap_user_time_short : 1, /* the time_{cycle,mask} fields are used */
547 * If cap_user_rdpmc this field provides the bit-width of the value
548 * read using the rdpmc() or equivalent instruction. This can be used
549 * to sign extend the result like:
551 * pmc <<= 64 - width;
552 * pmc >>= 64 - width; // signed shift right
558 * If cap_usr_time the below fields can be used to compute the time
559 * delta since time_enabled (in ns) using rdtsc or similar.
564 * quot = (cyc >> time_shift);
565 * rem = cyc & (((u64)1 << time_shift) - 1);
566 * delta = time_offset + quot * time_mult +
567 * ((rem * time_mult) >> time_shift);
569 * Where time_offset,time_mult,time_shift and cyc are read in the
570 * seqcount loop described above. This delta can then be added to
571 * enabled and possible running (if index), improving the scaling:
577 * quot = count / running;
578 * rem = count % running;
579 * count = quot * enabled + (rem * enabled) / running;
585 * If cap_usr_time_zero, the hardware clock (e.g. TSC) can be calculated
586 * from sample timestamps.
588 * time = timestamp - time_zero;
589 * quot = time / time_mult;
590 * rem = time % time_mult;
591 * cyc = (quot << time_shift) + (rem << time_shift) / time_mult;
595 * quot = cyc >> time_shift;
596 * rem = cyc & (((u64)1 << time_shift) - 1);
597 * timestamp = time_zero + quot * time_mult +
598 * ((rem * time_mult) >> time_shift);
602 __u32 size; /* Header size up to __reserved[] fields. */
606 * If cap_usr_time_short, the hardware clock is less than 64bit wide
607 * and we must compute the 'cyc' value, as used by cap_usr_time, as:
609 * cyc = time_cycles + ((cyc - time_cycles) & time_mask)
611 * NOTE: this form is explicitly chosen such that cap_usr_time_short
612 * is a correction on top of cap_usr_time, and code that doesn't
613 * know about cap_usr_time_short still works under the assumption
614 * the counter doesn't wrap.
620 * Hole for extension of the self monitor capabilities
623 __u8 __reserved[116*8]; /* align to 1k. */
626 * Control data for the mmap() data buffer.
628 * User-space reading the @data_head value should issue an smp_rmb(),
629 * after reading this value.
631 * When the mapping is PROT_WRITE the @data_tail value should be
632 * written by userspace to reflect the last read data, after issueing
633 * an smp_mb() to separate the data read from the ->data_tail store.
634 * In this case the kernel will not over-write unread data.
636 * See perf_output_put_handle() for the data ordering.
638 * data_{offset,size} indicate the location and size of the perf record
639 * buffer within the mmapped area.
641 __u64 data_head; /* head in the data section */
642 __u64 data_tail; /* user-space written tail */
643 __u64 data_offset; /* where the buffer starts */
644 __u64 data_size; /* data buffer size */
647 * AUX area is defined by aux_{offset,size} fields that should be set
648 * by the userspace, so that
650 * aux_offset >= data_offset + data_size
652 * prior to mmap()ing it. Size of the mmap()ed area should be aux_size.
654 * Ring buffer pointers aux_{head,tail} have the same semantics as
655 * data_{head,tail} and same ordering rules apply.
663 #define PERF_RECORD_MISC_CPUMODE_MASK (7 << 0)
664 #define PERF_RECORD_MISC_CPUMODE_UNKNOWN (0 << 0)
665 #define PERF_RECORD_MISC_KERNEL (1 << 0)
666 #define PERF_RECORD_MISC_USER (2 << 0)
667 #define PERF_RECORD_MISC_HYPERVISOR (3 << 0)
668 #define PERF_RECORD_MISC_GUEST_KERNEL (4 << 0)
669 #define PERF_RECORD_MISC_GUEST_USER (5 << 0)
672 * Indicates that /proc/PID/maps parsing are truncated by time out.
674 #define PERF_RECORD_MISC_PROC_MAP_PARSE_TIMEOUT (1 << 12)
676 * Following PERF_RECORD_MISC_* are used on different
677 * events, so can reuse the same bit position:
679 * PERF_RECORD_MISC_MMAP_DATA - PERF_RECORD_MMAP* events
680 * PERF_RECORD_MISC_COMM_EXEC - PERF_RECORD_COMM event
681 * PERF_RECORD_MISC_FORK_EXEC - PERF_RECORD_FORK event (perf internal)
682 * PERF_RECORD_MISC_SWITCH_OUT - PERF_RECORD_SWITCH* events
684 #define PERF_RECORD_MISC_MMAP_DATA (1 << 13)
685 #define PERF_RECORD_MISC_COMM_EXEC (1 << 13)
686 #define PERF_RECORD_MISC_FORK_EXEC (1 << 13)
687 #define PERF_RECORD_MISC_SWITCH_OUT (1 << 13)
689 * These PERF_RECORD_MISC_* flags below are safely reused
690 * for the following events:
692 * PERF_RECORD_MISC_EXACT_IP - PERF_RECORD_SAMPLE of precise events
693 * PERF_RECORD_MISC_SWITCH_OUT_PREEMPT - PERF_RECORD_SWITCH* events
696 * PERF_RECORD_MISC_EXACT_IP:
697 * Indicates that the content of PERF_SAMPLE_IP points to
698 * the actual instruction that triggered the event. See also
699 * perf_event_attr::precise_ip.
701 * PERF_RECORD_MISC_SWITCH_OUT_PREEMPT:
702 * Indicates that thread was preempted in TASK_RUNNING state.
704 #define PERF_RECORD_MISC_EXACT_IP (1 << 14)
705 #define PERF_RECORD_MISC_SWITCH_OUT_PREEMPT (1 << 14)
707 * Reserve the last bit to indicate some extended misc field
709 #define PERF_RECORD_MISC_EXT_RESERVED (1 << 15)
711 struct perf_event_header {
717 struct perf_ns_link_info {
731 NR_NAMESPACES, /* number of available namespaces */
734 enum perf_event_type {
737 * If perf_event_attr.sample_id_all is set then all event types will
738 * have the sample_type selected fields related to where/when
739 * (identity) an event took place (TID, TIME, ID, STREAM_ID, CPU,
740 * IDENTIFIER) described in PERF_RECORD_SAMPLE below, it will be stashed
741 * just after the perf_event_header and the fields already present for
742 * the existing fields, i.e. at the end of the payload. That way a newer
743 * perf.data file will be supported by older perf tools, with these new
744 * optional fields being ignored.
747 * { u32 pid, tid; } && PERF_SAMPLE_TID
748 * { u64 time; } && PERF_SAMPLE_TIME
749 * { u64 id; } && PERF_SAMPLE_ID
750 * { u64 stream_id;} && PERF_SAMPLE_STREAM_ID
751 * { u32 cpu, res; } && PERF_SAMPLE_CPU
752 * { u64 id; } && PERF_SAMPLE_IDENTIFIER
753 * } && perf_event_attr::sample_id_all
755 * Note that PERF_SAMPLE_IDENTIFIER duplicates PERF_SAMPLE_ID. The
756 * advantage of PERF_SAMPLE_IDENTIFIER is that its position is fixed
757 * relative to header.size.
761 * The MMAP events record the PROT_EXEC mappings so that we can
762 * correlate userspace IPs to code. They have the following structure:
765 * struct perf_event_header header;
772 * struct sample_id sample_id;
775 PERF_RECORD_MMAP = 1,
779 * struct perf_event_header header;
782 * struct sample_id sample_id;
785 PERF_RECORD_LOST = 2,
789 * struct perf_event_header header;
793 * struct sample_id sample_id;
796 PERF_RECORD_COMM = 3,
800 * struct perf_event_header header;
804 * struct sample_id sample_id;
807 PERF_RECORD_EXIT = 4,
811 * struct perf_event_header header;
815 * struct sample_id sample_id;
818 PERF_RECORD_THROTTLE = 5,
819 PERF_RECORD_UNTHROTTLE = 6,
823 * struct perf_event_header header;
827 * struct sample_id sample_id;
830 PERF_RECORD_FORK = 7,
834 * struct perf_event_header header;
837 * struct read_format values;
838 * struct sample_id sample_id;
841 PERF_RECORD_READ = 8,
845 * struct perf_event_header header;
848 * # Note that PERF_SAMPLE_IDENTIFIER duplicates PERF_SAMPLE_ID.
849 * # The advantage of PERF_SAMPLE_IDENTIFIER is that its position
850 * # is fixed relative to header.
853 * { u64 id; } && PERF_SAMPLE_IDENTIFIER
854 * { u64 ip; } && PERF_SAMPLE_IP
855 * { u32 pid, tid; } && PERF_SAMPLE_TID
856 * { u64 time; } && PERF_SAMPLE_TIME
857 * { u64 addr; } && PERF_SAMPLE_ADDR
858 * { u64 id; } && PERF_SAMPLE_ID
859 * { u64 stream_id;} && PERF_SAMPLE_STREAM_ID
860 * { u32 cpu, res; } && PERF_SAMPLE_CPU
861 * { u64 period; } && PERF_SAMPLE_PERIOD
863 * { struct read_format values; } && PERF_SAMPLE_READ
866 * u64 ips[nr]; } && PERF_SAMPLE_CALLCHAIN
869 * # The RAW record below is opaque data wrt the ABI
871 * # That is, the ABI doesn't make any promises wrt to
872 * # the stability of its content, it may vary depending
873 * # on event, hardware, kernel version and phase of
876 * # In other words, PERF_SAMPLE_RAW contents are not an ABI.
880 * char data[size];}&& PERF_SAMPLE_RAW
883 * { u64 hw_idx; } && PERF_SAMPLE_BRANCH_HW_INDEX
884 * { u64 from, to, flags } lbr[nr];
885 * } && PERF_SAMPLE_BRANCH_STACK
887 * { u64 abi; # enum perf_sample_regs_abi
888 * u64 regs[weight(mask)]; } && PERF_SAMPLE_REGS_USER
892 * u64 dyn_size; } && PERF_SAMPLE_STACK_USER
894 * { u64 weight; } && PERF_SAMPLE_WEIGHT
895 * { u64 data_src; } && PERF_SAMPLE_DATA_SRC
896 * { u64 transaction; } && PERF_SAMPLE_TRANSACTION
897 * { u64 abi; # enum perf_sample_regs_abi
898 * u64 regs[weight(mask)]; } && PERF_SAMPLE_REGS_INTR
899 * { u64 phys_addr;} && PERF_SAMPLE_PHYS_ADDR
901 * char data[size]; } && PERF_SAMPLE_AUX
904 PERF_RECORD_SAMPLE = 9,
907 * The MMAP2 records are an augmented version of MMAP, they add
908 * maj, min, ino numbers to be used to uniquely identify each mapping
911 * struct perf_event_header header;
920 * u64 ino_generation;
923 * struct sample_id sample_id;
926 PERF_RECORD_MMAP2 = 10,
929 * Records that new data landed in the AUX buffer part.
932 * struct perf_event_header header;
937 * struct sample_id sample_id;
940 PERF_RECORD_AUX = 11,
943 * Indicates that instruction trace has started
946 * struct perf_event_header header;
949 * struct sample_id sample_id;
952 PERF_RECORD_ITRACE_START = 12,
955 * Records the dropped/lost sample number.
958 * struct perf_event_header header;
961 * struct sample_id sample_id;
964 PERF_RECORD_LOST_SAMPLES = 13,
967 * Records a context switch in or out (flagged by
968 * PERF_RECORD_MISC_SWITCH_OUT). See also
969 * PERF_RECORD_SWITCH_CPU_WIDE.
972 * struct perf_event_header header;
973 * struct sample_id sample_id;
976 PERF_RECORD_SWITCH = 14,
979 * CPU-wide version of PERF_RECORD_SWITCH with next_prev_pid and
980 * next_prev_tid that are the next (switching out) or previous
981 * (switching in) pid/tid.
984 * struct perf_event_header header;
987 * struct sample_id sample_id;
990 PERF_RECORD_SWITCH_CPU_WIDE = 15,
994 * struct perf_event_header header;
998 * { u64 dev, inode; } [nr_namespaces];
999 * struct sample_id sample_id;
1002 PERF_RECORD_NAMESPACES = 16,
1005 * Record ksymbol register/unregister events:
1008 * struct perf_event_header header;
1014 * struct sample_id sample_id;
1017 PERF_RECORD_KSYMBOL = 17,
1020 * Record bpf events:
1021 * enum perf_bpf_event_type {
1022 * PERF_BPF_EVENT_UNKNOWN = 0,
1023 * PERF_BPF_EVENT_PROG_LOAD = 1,
1024 * PERF_BPF_EVENT_PROG_UNLOAD = 2,
1028 * struct perf_event_header header;
1032 * u8 tag[BPF_TAG_SIZE];
1033 * struct sample_id sample_id;
1036 PERF_RECORD_BPF_EVENT = 18,
1040 * struct perf_event_header header;
1043 * struct sample_id sample_id;
1046 PERF_RECORD_CGROUP = 19,
1049 * Records changes to kernel text i.e. self-modified code. 'old_len' is
1050 * the number of old bytes, 'new_len' is the number of new bytes. Either
1051 * 'old_len' or 'new_len' may be zero to indicate, for example, the
1052 * addition or removal of a trampoline. 'bytes' contains the old bytes
1053 * followed immediately by the new bytes.
1056 * struct perf_event_header header;
1061 * struct sample_id sample_id;
1064 PERF_RECORD_TEXT_POKE = 20,
1066 PERF_RECORD_MAX, /* non-ABI */
1069 enum perf_record_ksymbol_type {
1070 PERF_RECORD_KSYMBOL_TYPE_UNKNOWN = 0,
1071 PERF_RECORD_KSYMBOL_TYPE_BPF = 1,
1073 * Out of line code such as kprobe-replaced instructions or optimized
1074 * kprobes or ftrace trampolines.
1076 PERF_RECORD_KSYMBOL_TYPE_OOL = 2,
1077 PERF_RECORD_KSYMBOL_TYPE_MAX /* non-ABI */
1080 #define PERF_RECORD_KSYMBOL_FLAGS_UNREGISTER (1 << 0)
1082 enum perf_bpf_event_type {
1083 PERF_BPF_EVENT_UNKNOWN = 0,
1084 PERF_BPF_EVENT_PROG_LOAD = 1,
1085 PERF_BPF_EVENT_PROG_UNLOAD = 2,
1086 PERF_BPF_EVENT_MAX, /* non-ABI */
1089 #define PERF_MAX_STACK_DEPTH 127
1090 #define PERF_MAX_CONTEXTS_PER_STACK 8
1092 enum perf_callchain_context {
1093 PERF_CONTEXT_HV = (__u64)-32,
1094 PERF_CONTEXT_KERNEL = (__u64)-128,
1095 PERF_CONTEXT_USER = (__u64)-512,
1097 PERF_CONTEXT_GUEST = (__u64)-2048,
1098 PERF_CONTEXT_GUEST_KERNEL = (__u64)-2176,
1099 PERF_CONTEXT_GUEST_USER = (__u64)-2560,
1101 PERF_CONTEXT_MAX = (__u64)-4095,
1105 * PERF_RECORD_AUX::flags bits
1107 #define PERF_AUX_FLAG_TRUNCATED 0x01 /* record was truncated to fit */
1108 #define PERF_AUX_FLAG_OVERWRITE 0x02 /* snapshot from overwrite mode */
1109 #define PERF_AUX_FLAG_PARTIAL 0x04 /* record contains gaps */
1110 #define PERF_AUX_FLAG_COLLISION 0x08 /* sample collided with another */
1112 #define PERF_FLAG_FD_NO_GROUP (1UL << 0)
1113 #define PERF_FLAG_FD_OUTPUT (1UL << 1)
1114 #define PERF_FLAG_PID_CGROUP (1UL << 2) /* pid=cgroup id, per-cpu mode only */
1115 #define PERF_FLAG_FD_CLOEXEC (1UL << 3) /* O_CLOEXEC */
1117 #if defined(__LITTLE_ENDIAN_BITFIELD)
1118 union perf_mem_data_src {
1121 __u64 mem_op:5, /* type of opcode */
1122 mem_lvl:14, /* memory hierarchy level */
1123 mem_snoop:5, /* snoop mode */
1124 mem_lock:2, /* lock instr */
1125 mem_dtlb:7, /* tlb access */
1126 mem_lvl_num:4, /* memory hierarchy level number */
1127 mem_remote:1, /* remote */
1128 mem_snoopx:2, /* snoop mode, ext */
1132 #elif defined(__BIG_ENDIAN_BITFIELD)
1133 union perf_mem_data_src {
1137 mem_snoopx:2, /* snoop mode, ext */
1138 mem_remote:1, /* remote */
1139 mem_lvl_num:4, /* memory hierarchy level number */
1140 mem_dtlb:7, /* tlb access */
1141 mem_lock:2, /* lock instr */
1142 mem_snoop:5, /* snoop mode */
1143 mem_lvl:14, /* memory hierarchy level */
1144 mem_op:5; /* type of opcode */
1148 #error "Unknown endianness"
1151 /* type of opcode (load/store/prefetch,code) */
1152 #define PERF_MEM_OP_NA 0x01 /* not available */
1153 #define PERF_MEM_OP_LOAD 0x02 /* load instruction */
1154 #define PERF_MEM_OP_STORE 0x04 /* store instruction */
1155 #define PERF_MEM_OP_PFETCH 0x08 /* prefetch */
1156 #define PERF_MEM_OP_EXEC 0x10 /* code (execution) */
1157 #define PERF_MEM_OP_SHIFT 0
1159 /* memory hierarchy (memory level, hit or miss) */
1160 #define PERF_MEM_LVL_NA 0x01 /* not available */
1161 #define PERF_MEM_LVL_HIT 0x02 /* hit level */
1162 #define PERF_MEM_LVL_MISS 0x04 /* miss level */
1163 #define PERF_MEM_LVL_L1 0x08 /* L1 */
1164 #define PERF_MEM_LVL_LFB 0x10 /* Line Fill Buffer */
1165 #define PERF_MEM_LVL_L2 0x20 /* L2 */
1166 #define PERF_MEM_LVL_L3 0x40 /* L3 */
1167 #define PERF_MEM_LVL_LOC_RAM 0x80 /* Local DRAM */
1168 #define PERF_MEM_LVL_REM_RAM1 0x100 /* Remote DRAM (1 hop) */
1169 #define PERF_MEM_LVL_REM_RAM2 0x200 /* Remote DRAM (2 hops) */
1170 #define PERF_MEM_LVL_REM_CCE1 0x400 /* Remote Cache (1 hop) */
1171 #define PERF_MEM_LVL_REM_CCE2 0x800 /* Remote Cache (2 hops) */
1172 #define PERF_MEM_LVL_IO 0x1000 /* I/O memory */
1173 #define PERF_MEM_LVL_UNC 0x2000 /* Uncached memory */
1174 #define PERF_MEM_LVL_SHIFT 5
1176 #define PERF_MEM_REMOTE_REMOTE 0x01 /* Remote */
1177 #define PERF_MEM_REMOTE_SHIFT 37
1179 #define PERF_MEM_LVLNUM_L1 0x01 /* L1 */
1180 #define PERF_MEM_LVLNUM_L2 0x02 /* L2 */
1181 #define PERF_MEM_LVLNUM_L3 0x03 /* L3 */
1182 #define PERF_MEM_LVLNUM_L4 0x04 /* L4 */
1183 /* 5-0xa available */
1184 #define PERF_MEM_LVLNUM_ANY_CACHE 0x0b /* Any cache */
1185 #define PERF_MEM_LVLNUM_LFB 0x0c /* LFB */
1186 #define PERF_MEM_LVLNUM_RAM 0x0d /* RAM */
1187 #define PERF_MEM_LVLNUM_PMEM 0x0e /* PMEM */
1188 #define PERF_MEM_LVLNUM_NA 0x0f /* N/A */
1190 #define PERF_MEM_LVLNUM_SHIFT 33
1193 #define PERF_MEM_SNOOP_NA 0x01 /* not available */
1194 #define PERF_MEM_SNOOP_NONE 0x02 /* no snoop */
1195 #define PERF_MEM_SNOOP_HIT 0x04 /* snoop hit */
1196 #define PERF_MEM_SNOOP_MISS 0x08 /* snoop miss */
1197 #define PERF_MEM_SNOOP_HITM 0x10 /* snoop hit modified */
1198 #define PERF_MEM_SNOOP_SHIFT 19
1200 #define PERF_MEM_SNOOPX_FWD 0x01 /* forward */
1202 #define PERF_MEM_SNOOPX_SHIFT 38
1204 /* locked instruction */
1205 #define PERF_MEM_LOCK_NA 0x01 /* not available */
1206 #define PERF_MEM_LOCK_LOCKED 0x02 /* locked transaction */
1207 #define PERF_MEM_LOCK_SHIFT 24
1210 #define PERF_MEM_TLB_NA 0x01 /* not available */
1211 #define PERF_MEM_TLB_HIT 0x02 /* hit level */
1212 #define PERF_MEM_TLB_MISS 0x04 /* miss level */
1213 #define PERF_MEM_TLB_L1 0x08 /* L1 */
1214 #define PERF_MEM_TLB_L2 0x10 /* L2 */
1215 #define PERF_MEM_TLB_WK 0x20 /* Hardware Walker*/
1216 #define PERF_MEM_TLB_OS 0x40 /* OS fault handler */
1217 #define PERF_MEM_TLB_SHIFT 26
1219 #define PERF_MEM_S(a, s) \
1220 (((__u64)PERF_MEM_##a##_##s) << PERF_MEM_##a##_SHIFT)
1223 * single taken branch record layout:
1225 * from: source instruction (may not always be a branch insn)
1227 * mispred: branch target was mispredicted
1228 * predicted: branch target was predicted
1230 * support for mispred, predicted is optional. In case it
1231 * is not supported mispred = predicted = 0.
1233 * in_tx: running in a hardware transaction
1234 * abort: aborting a hardware transaction
1235 * cycles: cycles from last branch (or 0 if not supported)
1238 struct perf_branch_entry {
1241 __u64 mispred:1, /* target mispredicted */
1242 predicted:1,/* target predicted */
1243 in_tx:1, /* in transaction */
1244 abort:1, /* transaction abort */
1245 cycles:16, /* cycle count to last branch */
1246 type:4, /* branch type */
1250 #endif /* _UAPI_LINUX_PERF_EVENT_H */