4 * Copyright (C) 2008-2009, Thomas Gleixner <tglx@linutronix.de>
5 * Copyright (C) 2008-2011, Red Hat, Inc., Ingo Molnar
6 * Copyright (C) 2008-2011, Red Hat, Inc., Peter Zijlstra
8 * Data type definitions, declarations, prototypes.
10 * Started by: Thomas Gleixner and Ingo Molnar
12 * For licencing details see kernel-base/COPYING
14 #ifndef _UAPI_LINUX_PERF_EVENT_H
15 #define _UAPI_LINUX_PERF_EVENT_H
17 #include <linux/types.h>
18 #include <linux/ioctl.h>
19 #include <asm/byteorder.h>
22 * User-space ABI bits:
29 PERF_TYPE_HARDWARE = 0,
30 PERF_TYPE_SOFTWARE = 1,
31 PERF_TYPE_TRACEPOINT = 2,
32 PERF_TYPE_HW_CACHE = 3,
34 PERF_TYPE_BREAKPOINT = 5,
36 PERF_TYPE_MAX, /* non-ABI */
40 * Generalized performance event event_id types, used by the
41 * attr.event_id parameter of the sys_perf_event_open()
46 * Common hardware events, generalized by the kernel:
48 PERF_COUNT_HW_CPU_CYCLES = 0,
49 PERF_COUNT_HW_INSTRUCTIONS = 1,
50 PERF_COUNT_HW_CACHE_REFERENCES = 2,
51 PERF_COUNT_HW_CACHE_MISSES = 3,
52 PERF_COUNT_HW_BRANCH_INSTRUCTIONS = 4,
53 PERF_COUNT_HW_BRANCH_MISSES = 5,
54 PERF_COUNT_HW_BUS_CYCLES = 6,
55 PERF_COUNT_HW_STALLED_CYCLES_FRONTEND = 7,
56 PERF_COUNT_HW_STALLED_CYCLES_BACKEND = 8,
57 PERF_COUNT_HW_REF_CPU_CYCLES = 9,
59 PERF_COUNT_HW_MAX, /* non-ABI */
63 * Generalized hardware cache events:
65 * { L1-D, L1-I, LLC, ITLB, DTLB, BPU, NODE } x
66 * { read, write, prefetch } x
67 * { accesses, misses }
69 enum perf_hw_cache_id {
70 PERF_COUNT_HW_CACHE_L1D = 0,
71 PERF_COUNT_HW_CACHE_L1I = 1,
72 PERF_COUNT_HW_CACHE_LL = 2,
73 PERF_COUNT_HW_CACHE_DTLB = 3,
74 PERF_COUNT_HW_CACHE_ITLB = 4,
75 PERF_COUNT_HW_CACHE_BPU = 5,
76 PERF_COUNT_HW_CACHE_NODE = 6,
78 PERF_COUNT_HW_CACHE_MAX, /* non-ABI */
81 enum perf_hw_cache_op_id {
82 PERF_COUNT_HW_CACHE_OP_READ = 0,
83 PERF_COUNT_HW_CACHE_OP_WRITE = 1,
84 PERF_COUNT_HW_CACHE_OP_PREFETCH = 2,
86 PERF_COUNT_HW_CACHE_OP_MAX, /* non-ABI */
89 enum perf_hw_cache_op_result_id {
90 PERF_COUNT_HW_CACHE_RESULT_ACCESS = 0,
91 PERF_COUNT_HW_CACHE_RESULT_MISS = 1,
93 PERF_COUNT_HW_CACHE_RESULT_MAX, /* non-ABI */
97 * Special "software" events provided by the kernel, even if the hardware
98 * does not support performance events. These events measure various
99 * physical and sw events of the kernel (and allow the profiling of them as
103 PERF_COUNT_SW_CPU_CLOCK = 0,
104 PERF_COUNT_SW_TASK_CLOCK = 1,
105 PERF_COUNT_SW_PAGE_FAULTS = 2,
106 PERF_COUNT_SW_CONTEXT_SWITCHES = 3,
107 PERF_COUNT_SW_CPU_MIGRATIONS = 4,
108 PERF_COUNT_SW_PAGE_FAULTS_MIN = 5,
109 PERF_COUNT_SW_PAGE_FAULTS_MAJ = 6,
110 PERF_COUNT_SW_ALIGNMENT_FAULTS = 7,
111 PERF_COUNT_SW_EMULATION_FAULTS = 8,
113 PERF_COUNT_SW_MAX, /* non-ABI */
117 * Bits that can be set in attr.sample_type to request information
118 * in the overflow packets.
120 enum perf_event_sample_format {
121 PERF_SAMPLE_IP = 1U << 0,
122 PERF_SAMPLE_TID = 1U << 1,
123 PERF_SAMPLE_TIME = 1U << 2,
124 PERF_SAMPLE_ADDR = 1U << 3,
125 PERF_SAMPLE_READ = 1U << 4,
126 PERF_SAMPLE_CALLCHAIN = 1U << 5,
127 PERF_SAMPLE_ID = 1U << 6,
128 PERF_SAMPLE_CPU = 1U << 7,
129 PERF_SAMPLE_PERIOD = 1U << 8,
130 PERF_SAMPLE_STREAM_ID = 1U << 9,
131 PERF_SAMPLE_RAW = 1U << 10,
132 PERF_SAMPLE_BRANCH_STACK = 1U << 11,
133 PERF_SAMPLE_REGS_USER = 1U << 12,
134 PERF_SAMPLE_STACK_USER = 1U << 13,
136 PERF_SAMPLE_MAX = 1U << 14, /* non-ABI */
140 * values to program into branch_sample_type when PERF_SAMPLE_BRANCH is set
142 * If the user does not pass priv level information via branch_sample_type,
143 * the kernel uses the event's priv level. Branch and event priv levels do
144 * not have to match. Branch priv level is checked for permissions.
146 * The branch types can be combined, however BRANCH_ANY covers all types
147 * of branches and therefore it supersedes all the other types.
149 enum perf_branch_sample_type {
150 PERF_SAMPLE_BRANCH_USER = 1U << 0, /* user branches */
151 PERF_SAMPLE_BRANCH_KERNEL = 1U << 1, /* kernel branches */
152 PERF_SAMPLE_BRANCH_HV = 1U << 2, /* hypervisor branches */
154 PERF_SAMPLE_BRANCH_ANY = 1U << 3, /* any branch types */
155 PERF_SAMPLE_BRANCH_ANY_CALL = 1U << 4, /* any call branch */
156 PERF_SAMPLE_BRANCH_ANY_RETURN = 1U << 5, /* any return branch */
157 PERF_SAMPLE_BRANCH_IND_CALL = 1U << 6, /* indirect calls */
159 PERF_SAMPLE_BRANCH_MAX = 1U << 7, /* non-ABI */
162 #define PERF_SAMPLE_BRANCH_PLM_ALL \
163 (PERF_SAMPLE_BRANCH_USER|\
164 PERF_SAMPLE_BRANCH_KERNEL|\
165 PERF_SAMPLE_BRANCH_HV)
168 * Values to determine ABI of the registers dump.
170 enum perf_sample_regs_abi {
171 PERF_SAMPLE_REGS_ABI_NONE = 0,
172 PERF_SAMPLE_REGS_ABI_32 = 1,
173 PERF_SAMPLE_REGS_ABI_64 = 2,
177 * The format of the data returned by read() on a perf event fd,
178 * as specified by attr.read_format:
180 * struct read_format {
182 * { u64 time_enabled; } && PERF_FORMAT_TOTAL_TIME_ENABLED
183 * { u64 time_running; } && PERF_FORMAT_TOTAL_TIME_RUNNING
184 * { u64 id; } && PERF_FORMAT_ID
185 * } && !PERF_FORMAT_GROUP
188 * { u64 time_enabled; } && PERF_FORMAT_TOTAL_TIME_ENABLED
189 * { u64 time_running; } && PERF_FORMAT_TOTAL_TIME_RUNNING
191 * { u64 id; } && PERF_FORMAT_ID
193 * } && PERF_FORMAT_GROUP
196 enum perf_event_read_format {
197 PERF_FORMAT_TOTAL_TIME_ENABLED = 1U << 0,
198 PERF_FORMAT_TOTAL_TIME_RUNNING = 1U << 1,
199 PERF_FORMAT_ID = 1U << 2,
200 PERF_FORMAT_GROUP = 1U << 3,
202 PERF_FORMAT_MAX = 1U << 4, /* non-ABI */
205 #define PERF_ATTR_SIZE_VER0 64 /* sizeof first published struct */
206 #define PERF_ATTR_SIZE_VER1 72 /* add: config2 */
207 #define PERF_ATTR_SIZE_VER2 80 /* add: branch_sample_type */
208 #define PERF_ATTR_SIZE_VER3 96 /* add: sample_regs_user */
209 /* add: sample_stack_user */
212 * Hardware event_id to monitor via a performance monitoring event:
214 struct perf_event_attr {
217 * Major type: hardware/software/tracepoint/etc.
222 * Size of the attr structure, for fwd/bwd compat.
227 * Type specific configuration information.
239 __u64 disabled : 1, /* off by default */
240 inherit : 1, /* children inherit it */
241 pinned : 1, /* must always be on PMU */
242 exclusive : 1, /* only group on PMU */
243 exclude_user : 1, /* don't count user */
244 exclude_kernel : 1, /* ditto kernel */
245 exclude_hv : 1, /* ditto hypervisor */
246 exclude_idle : 1, /* don't count when idle */
247 mmap : 1, /* include mmap data */
248 comm : 1, /* include comm data */
249 freq : 1, /* use freq, not period */
250 inherit_stat : 1, /* per task counts */
251 enable_on_exec : 1, /* next exec enables */
252 task : 1, /* trace fork/exit */
253 watermark : 1, /* wakeup_watermark */
257 * 0 - SAMPLE_IP can have arbitrary skid
258 * 1 - SAMPLE_IP must have constant skid
259 * 2 - SAMPLE_IP requested to have 0 skid
260 * 3 - SAMPLE_IP must have 0 skid
262 * See also PERF_RECORD_MISC_EXACT_IP
264 precise_ip : 2, /* skid constraint */
265 mmap_data : 1, /* non-exec mmap data */
266 sample_id_all : 1, /* sample_type all events */
268 exclude_host : 1, /* don't count in host */
269 exclude_guest : 1, /* don't count in guest */
271 exclude_callchain_kernel : 1, /* exclude kernel callchains */
272 exclude_callchain_user : 1, /* exclude user callchains */
277 __u32 wakeup_events; /* wakeup every n events */
278 __u32 wakeup_watermark; /* bytes before wakeup */
284 __u64 config1; /* extension of config */
288 __u64 config2; /* extension of config1 */
290 __u64 branch_sample_type; /* enum perf_branch_sample_type */
293 * Defines set of user regs to dump on samples.
294 * See asm/perf_regs.h for details.
296 __u64 sample_regs_user;
299 * Defines size of the user stack to dump on samples.
301 __u32 sample_stack_user;
307 #define perf_flags(attr) (*(&(attr)->read_format + 1))
310 * Ioctls that can be done on a perf event fd:
312 #define PERF_EVENT_IOC_ENABLE _IO ('$', 0)
313 #define PERF_EVENT_IOC_DISABLE _IO ('$', 1)
314 #define PERF_EVENT_IOC_REFRESH _IO ('$', 2)
315 #define PERF_EVENT_IOC_RESET _IO ('$', 3)
316 #define PERF_EVENT_IOC_PERIOD _IOW('$', 4, __u64)
317 #define PERF_EVENT_IOC_SET_OUTPUT _IO ('$', 5)
318 #define PERF_EVENT_IOC_SET_FILTER _IOW('$', 6, char *)
320 enum perf_event_ioc_flags {
321 PERF_IOC_FLAG_GROUP = 1U << 0,
325 * Structure of the page that can be mapped via mmap
327 struct perf_event_mmap_page {
328 __u32 version; /* version number of this structure */
329 __u32 compat_version; /* lowest version this is compat with */
332 * Bits needed to read the hw events in user-space.
334 * u32 seq, time_mult, time_shift, idx, width;
335 * u64 count, enabled, running;
336 * u64 cyc, time_offset;
343 * enabled = pc->time_enabled;
344 * running = pc->time_running;
346 * if (pc->cap_usr_time && enabled != running) {
348 * time_offset = pc->time_offset;
349 * time_mult = pc->time_mult;
350 * time_shift = pc->time_shift;
354 * count = pc->offset;
355 * if (pc->cap_usr_rdpmc && idx) {
356 * width = pc->pmc_width;
357 * pmc = rdpmc(idx - 1);
361 * } while (pc->lock != seq);
363 * NOTE: for obvious reason this only works on self-monitoring
366 __u32 lock; /* seqlock for synchronization */
367 __u32 index; /* hardware event identifier */
368 __s64 offset; /* add to hardware event value */
369 __u64 time_enabled; /* time event active */
370 __u64 time_running; /* time event on cpu */
373 __u64 cap_usr_time : 1,
379 * If cap_usr_rdpmc this field provides the bit-width of the value
380 * read using the rdpmc() or equivalent instruction. This can be used
381 * to sign extend the result like:
383 * pmc <<= 64 - width;
384 * pmc >>= 64 - width; // signed shift right
390 * If cap_usr_time the below fields can be used to compute the time
391 * delta since time_enabled (in ns) using rdtsc or similar.
396 * quot = (cyc >> time_shift);
397 * rem = cyc & ((1 << time_shift) - 1);
398 * delta = time_offset + quot * time_mult +
399 * ((rem * time_mult) >> time_shift);
401 * Where time_offset,time_mult,time_shift and cyc are read in the
402 * seqcount loop described above. This delta can then be added to
403 * enabled and possible running (if idx), improving the scaling:
409 * quot = count / running;
410 * rem = count % running;
411 * count = quot * enabled + (rem * enabled) / running;
418 * Hole for extension of the self monitor capabilities
421 __u64 __reserved[120]; /* align to 1k */
424 * Control data for the mmap() data buffer.
426 * User-space reading the @data_head value should issue an rmb(), on
427 * SMP capable platforms, after reading this value -- see
428 * perf_event_wakeup().
430 * When the mapping is PROT_WRITE the @data_tail value should be
431 * written by userspace to reflect the last read data. In this case
432 * the kernel will not over-write unread data.
434 __u64 data_head; /* head in the data section */
435 __u64 data_tail; /* user-space written tail */
438 #define PERF_RECORD_MISC_CPUMODE_MASK (7 << 0)
439 #define PERF_RECORD_MISC_CPUMODE_UNKNOWN (0 << 0)
440 #define PERF_RECORD_MISC_KERNEL (1 << 0)
441 #define PERF_RECORD_MISC_USER (2 << 0)
442 #define PERF_RECORD_MISC_HYPERVISOR (3 << 0)
443 #define PERF_RECORD_MISC_GUEST_KERNEL (4 << 0)
444 #define PERF_RECORD_MISC_GUEST_USER (5 << 0)
447 * Indicates that the content of PERF_SAMPLE_IP points to
448 * the actual instruction that triggered the event. See also
449 * perf_event_attr::precise_ip.
451 #define PERF_RECORD_MISC_EXACT_IP (1 << 14)
453 * Reserve the last bit to indicate some extended misc field
455 #define PERF_RECORD_MISC_EXT_RESERVED (1 << 15)
457 struct perf_event_header {
463 enum perf_event_type {
466 * If perf_event_attr.sample_id_all is set then all event types will
467 * have the sample_type selected fields related to where/when
468 * (identity) an event took place (TID, TIME, ID, CPU, STREAM_ID)
469 * described in PERF_RECORD_SAMPLE below, it will be stashed just after
470 * the perf_event_header and the fields already present for the existing
471 * fields, i.e. at the end of the payload. That way a newer perf.data
472 * file will be supported by older perf tools, with these new optional
473 * fields being ignored.
475 * The MMAP events record the PROT_EXEC mappings so that we can
476 * correlate userspace IPs to code. They have the following structure:
479 * struct perf_event_header header;
488 PERF_RECORD_MMAP = 1,
492 * struct perf_event_header header;
497 PERF_RECORD_LOST = 2,
501 * struct perf_event_header header;
507 PERF_RECORD_COMM = 3,
511 * struct perf_event_header header;
517 PERF_RECORD_EXIT = 4,
521 * struct perf_event_header header;
527 PERF_RECORD_THROTTLE = 5,
528 PERF_RECORD_UNTHROTTLE = 6,
532 * struct perf_event_header header;
538 PERF_RECORD_FORK = 7,
542 * struct perf_event_header header;
545 * struct read_format values;
548 PERF_RECORD_READ = 8,
552 * struct perf_event_header header;
554 * { u64 ip; } && PERF_SAMPLE_IP
555 * { u32 pid, tid; } && PERF_SAMPLE_TID
556 * { u64 time; } && PERF_SAMPLE_TIME
557 * { u64 addr; } && PERF_SAMPLE_ADDR
558 * { u64 id; } && PERF_SAMPLE_ID
559 * { u64 stream_id;} && PERF_SAMPLE_STREAM_ID
560 * { u32 cpu, res; } && PERF_SAMPLE_CPU
561 * { u64 period; } && PERF_SAMPLE_PERIOD
563 * { struct read_format values; } && PERF_SAMPLE_READ
566 * u64 ips[nr]; } && PERF_SAMPLE_CALLCHAIN
569 * # The RAW record below is opaque data wrt the ABI
571 * # That is, the ABI doesn't make any promises wrt to
572 * # the stability of its content, it may vary depending
573 * # on event, hardware, kernel version and phase of
576 * # In other words, PERF_SAMPLE_RAW contents are not an ABI.
580 * char data[size];}&& PERF_SAMPLE_RAW
582 * { u64 from, to, flags } lbr[nr];} && PERF_SAMPLE_BRANCH_STACK
584 * { u64 abi; # enum perf_sample_regs_abi
585 * u64 regs[weight(mask)]; } && PERF_SAMPLE_REGS_USER
589 * u64 dyn_size; } && PERF_SAMPLE_STACK_USER
592 PERF_RECORD_SAMPLE = 9,
594 PERF_RECORD_MAX, /* non-ABI */
597 #define PERF_MAX_STACK_DEPTH 127
599 enum perf_callchain_context {
600 PERF_CONTEXT_HV = (__u64)-32,
601 PERF_CONTEXT_KERNEL = (__u64)-128,
602 PERF_CONTEXT_USER = (__u64)-512,
604 PERF_CONTEXT_GUEST = (__u64)-2048,
605 PERF_CONTEXT_GUEST_KERNEL = (__u64)-2176,
606 PERF_CONTEXT_GUEST_USER = (__u64)-2560,
608 PERF_CONTEXT_MAX = (__u64)-4095,
611 #define PERF_FLAG_FD_NO_GROUP (1U << 0)
612 #define PERF_FLAG_FD_OUTPUT (1U << 1)
613 #define PERF_FLAG_PID_CGROUP (1U << 2) /* pid=cgroup id, per-cpu mode only */
615 #endif /* _UAPI_LINUX_PERF_EVENT_H */