perf: Add attr->mmap2 attribute to an event
[linux-2.6-block.git] / include / uapi / linux / perf_event.h
CommitLineData
607ca46e
DH
1/*
2 * Performance events:
3 *
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
7 *
8 * Data type definitions, declarations, prototypes.
9 *
10 * Started by: Thomas Gleixner and Ingo Molnar
11 *
12 * For licencing details see kernel-base/COPYING
13 */
14#ifndef _UAPI_LINUX_PERF_EVENT_H
15#define _UAPI_LINUX_PERF_EVENT_H
16
17#include <linux/types.h>
18#include <linux/ioctl.h>
19#include <asm/byteorder.h>
20
21/*
22 * User-space ABI bits:
23 */
24
25/*
26 * attr.type
27 */
28enum perf_type_id {
29 PERF_TYPE_HARDWARE = 0,
30 PERF_TYPE_SOFTWARE = 1,
31 PERF_TYPE_TRACEPOINT = 2,
32 PERF_TYPE_HW_CACHE = 3,
33 PERF_TYPE_RAW = 4,
34 PERF_TYPE_BREAKPOINT = 5,
35
36 PERF_TYPE_MAX, /* non-ABI */
37};
38
39/*
40 * Generalized performance event event_id types, used by the
41 * attr.event_id parameter of the sys_perf_event_open()
42 * syscall:
43 */
44enum perf_hw_id {
45 /*
46 * Common hardware events, generalized by the kernel:
47 */
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,
58
59 PERF_COUNT_HW_MAX, /* non-ABI */
60};
61
62/*
63 * Generalized hardware cache events:
64 *
65 * { L1-D, L1-I, LLC, ITLB, DTLB, BPU, NODE } x
66 * { read, write, prefetch } x
67 * { accesses, misses }
68 */
69enum 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,
77
78 PERF_COUNT_HW_CACHE_MAX, /* non-ABI */
79};
80
81enum 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,
85
86 PERF_COUNT_HW_CACHE_OP_MAX, /* non-ABI */
87};
88
89enum perf_hw_cache_op_result_id {
90 PERF_COUNT_HW_CACHE_RESULT_ACCESS = 0,
91 PERF_COUNT_HW_CACHE_RESULT_MISS = 1,
92
93 PERF_COUNT_HW_CACHE_RESULT_MAX, /* non-ABI */
94};
95
96/*
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
100 * well):
101 */
102enum perf_sw_ids {
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,
112
113 PERF_COUNT_SW_MAX, /* non-ABI */
114};
115
116/*
117 * Bits that can be set in attr.sample_type to request information
118 * in the overflow packets.
119 */
120enum 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,
c3feedf2 135 PERF_SAMPLE_WEIGHT = 1U << 14,
d6be9ad6 136 PERF_SAMPLE_DATA_SRC = 1U << 15,
ff3d527c 137 PERF_SAMPLE_IDENTIFIER = 1U << 16,
c3feedf2 138
ff3d527c 139 PERF_SAMPLE_MAX = 1U << 17, /* non-ABI */
607ca46e
DH
140};
141
142/*
143 * values to program into branch_sample_type when PERF_SAMPLE_BRANCH is set
144 *
145 * If the user does not pass priv level information via branch_sample_type,
146 * the kernel uses the event's priv level. Branch and event priv levels do
147 * not have to match. Branch priv level is checked for permissions.
148 *
149 * The branch types can be combined, however BRANCH_ANY covers all types
150 * of branches and therefore it supersedes all the other types.
151 */
152enum perf_branch_sample_type {
153 PERF_SAMPLE_BRANCH_USER = 1U << 0, /* user branches */
154 PERF_SAMPLE_BRANCH_KERNEL = 1U << 1, /* kernel branches */
155 PERF_SAMPLE_BRANCH_HV = 1U << 2, /* hypervisor branches */
156
157 PERF_SAMPLE_BRANCH_ANY = 1U << 3, /* any branch types */
158 PERF_SAMPLE_BRANCH_ANY_CALL = 1U << 4, /* any call branch */
159 PERF_SAMPLE_BRANCH_ANY_RETURN = 1U << 5, /* any return branch */
160 PERF_SAMPLE_BRANCH_IND_CALL = 1U << 6, /* indirect calls */
135c5612
AK
161 PERF_SAMPLE_BRANCH_ABORT_TX = 1U << 7, /* transaction aborts */
162 PERF_SAMPLE_BRANCH_IN_TX = 1U << 8, /* in transaction */
163 PERF_SAMPLE_BRANCH_NO_TX = 1U << 9, /* not in transaction */
607ca46e 164
135c5612 165 PERF_SAMPLE_BRANCH_MAX = 1U << 10, /* non-ABI */
607ca46e
DH
166};
167
168#define PERF_SAMPLE_BRANCH_PLM_ALL \
169 (PERF_SAMPLE_BRANCH_USER|\
170 PERF_SAMPLE_BRANCH_KERNEL|\
171 PERF_SAMPLE_BRANCH_HV)
172
173/*
174 * Values to determine ABI of the registers dump.
175 */
176enum perf_sample_regs_abi {
177 PERF_SAMPLE_REGS_ABI_NONE = 0,
178 PERF_SAMPLE_REGS_ABI_32 = 1,
179 PERF_SAMPLE_REGS_ABI_64 = 2,
180};
181
182/*
183 * The format of the data returned by read() on a perf event fd,
184 * as specified by attr.read_format:
185 *
186 * struct read_format {
187 * { u64 value;
188 * { u64 time_enabled; } && PERF_FORMAT_TOTAL_TIME_ENABLED
189 * { u64 time_running; } && PERF_FORMAT_TOTAL_TIME_RUNNING
190 * { u64 id; } && PERF_FORMAT_ID
191 * } && !PERF_FORMAT_GROUP
192 *
193 * { u64 nr;
194 * { u64 time_enabled; } && PERF_FORMAT_TOTAL_TIME_ENABLED
195 * { u64 time_running; } && PERF_FORMAT_TOTAL_TIME_RUNNING
196 * { u64 value;
197 * { u64 id; } && PERF_FORMAT_ID
198 * } cntr[nr];
199 * } && PERF_FORMAT_GROUP
200 * };
201 */
202enum perf_event_read_format {
203 PERF_FORMAT_TOTAL_TIME_ENABLED = 1U << 0,
204 PERF_FORMAT_TOTAL_TIME_RUNNING = 1U << 1,
205 PERF_FORMAT_ID = 1U << 2,
206 PERF_FORMAT_GROUP = 1U << 3,
207
208 PERF_FORMAT_MAX = 1U << 4, /* non-ABI */
209};
210
211#define PERF_ATTR_SIZE_VER0 64 /* sizeof first published struct */
212#define PERF_ATTR_SIZE_VER1 72 /* add: config2 */
213#define PERF_ATTR_SIZE_VER2 80 /* add: branch_sample_type */
214#define PERF_ATTR_SIZE_VER3 96 /* add: sample_regs_user */
215 /* add: sample_stack_user */
216
217/*
218 * Hardware event_id to monitor via a performance monitoring event:
219 */
220struct perf_event_attr {
221
222 /*
223 * Major type: hardware/software/tracepoint/etc.
224 */
225 __u32 type;
226
227 /*
228 * Size of the attr structure, for fwd/bwd compat.
229 */
230 __u32 size;
231
232 /*
233 * Type specific configuration information.
234 */
235 __u64 config;
236
237 union {
238 __u64 sample_period;
239 __u64 sample_freq;
240 };
241
242 __u64 sample_type;
243 __u64 read_format;
244
245 __u64 disabled : 1, /* off by default */
246 inherit : 1, /* children inherit it */
247 pinned : 1, /* must always be on PMU */
248 exclusive : 1, /* only group on PMU */
249 exclude_user : 1, /* don't count user */
250 exclude_kernel : 1, /* ditto kernel */
251 exclude_hv : 1, /* ditto hypervisor */
252 exclude_idle : 1, /* don't count when idle */
253 mmap : 1, /* include mmap data */
254 comm : 1, /* include comm data */
255 freq : 1, /* use freq, not period */
256 inherit_stat : 1, /* per task counts */
257 enable_on_exec : 1, /* next exec enables */
258 task : 1, /* trace fork/exit */
259 watermark : 1, /* wakeup_watermark */
260 /*
261 * precise_ip:
262 *
263 * 0 - SAMPLE_IP can have arbitrary skid
264 * 1 - SAMPLE_IP must have constant skid
265 * 2 - SAMPLE_IP requested to have 0 skid
266 * 3 - SAMPLE_IP must have 0 skid
267 *
268 * See also PERF_RECORD_MISC_EXACT_IP
269 */
270 precise_ip : 2, /* skid constraint */
271 mmap_data : 1, /* non-exec mmap data */
272 sample_id_all : 1, /* sample_type all events */
273
274 exclude_host : 1, /* don't count in host */
275 exclude_guest : 1, /* don't count in guest */
276
277 exclude_callchain_kernel : 1, /* exclude kernel callchains */
278 exclude_callchain_user : 1, /* exclude user callchains */
13d7a241 279 mmap2 : 1, /* include mmap with inode data */
607ca46e 280
13d7a241 281 __reserved_1 : 40;
607ca46e
DH
282
283 union {
284 __u32 wakeup_events; /* wakeup every n events */
285 __u32 wakeup_watermark; /* bytes before wakeup */
286 };
287
288 __u32 bp_type;
289 union {
290 __u64 bp_addr;
291 __u64 config1; /* extension of config */
292 };
293 union {
294 __u64 bp_len;
295 __u64 config2; /* extension of config1 */
296 };
297 __u64 branch_sample_type; /* enum perf_branch_sample_type */
298
299 /*
300 * Defines set of user regs to dump on samples.
301 * See asm/perf_regs.h for details.
302 */
303 __u64 sample_regs_user;
304
305 /*
306 * Defines size of the user stack to dump on samples.
307 */
308 __u32 sample_stack_user;
309
310 /* Align to u64. */
311 __u32 __reserved_2;
312};
313
314#define perf_flags(attr) (*(&(attr)->read_format + 1))
315
316/*
317 * Ioctls that can be done on a perf event fd:
318 */
319#define PERF_EVENT_IOC_ENABLE _IO ('$', 0)
320#define PERF_EVENT_IOC_DISABLE _IO ('$', 1)
321#define PERF_EVENT_IOC_REFRESH _IO ('$', 2)
322#define PERF_EVENT_IOC_RESET _IO ('$', 3)
323#define PERF_EVENT_IOC_PERIOD _IOW('$', 4, __u64)
324#define PERF_EVENT_IOC_SET_OUTPUT _IO ('$', 5)
325#define PERF_EVENT_IOC_SET_FILTER _IOW('$', 6, char *)
cf4957f1 326#define PERF_EVENT_IOC_ID _IOR('$', 7, u64 *)
607ca46e
DH
327
328enum perf_event_ioc_flags {
329 PERF_IOC_FLAG_GROUP = 1U << 0,
330};
331
332/*
333 * Structure of the page that can be mapped via mmap
334 */
335struct perf_event_mmap_page {
336 __u32 version; /* version number of this structure */
337 __u32 compat_version; /* lowest version this is compat with */
338
339 /*
340 * Bits needed to read the hw events in user-space.
341 *
342 * u32 seq, time_mult, time_shift, idx, width;
343 * u64 count, enabled, running;
344 * u64 cyc, time_offset;
345 * s64 pmc = 0;
346 *
347 * do {
348 * seq = pc->lock;
349 * barrier()
350 *
351 * enabled = pc->time_enabled;
352 * running = pc->time_running;
353 *
354 * if (pc->cap_usr_time && enabled != running) {
355 * cyc = rdtsc();
356 * time_offset = pc->time_offset;
357 * time_mult = pc->time_mult;
358 * time_shift = pc->time_shift;
359 * }
360 *
361 * idx = pc->index;
362 * count = pc->offset;
363 * if (pc->cap_usr_rdpmc && idx) {
364 * width = pc->pmc_width;
365 * pmc = rdpmc(idx - 1);
366 * }
367 *
368 * barrier();
369 * } while (pc->lock != seq);
370 *
371 * NOTE: for obvious reason this only works on self-monitoring
372 * processes.
373 */
374 __u32 lock; /* seqlock for synchronization */
375 __u32 index; /* hardware event identifier */
376 __s64 offset; /* add to hardware event value */
377 __u64 time_enabled; /* time event active */
378 __u64 time_running; /* time event on cpu */
379 union {
380 __u64 capabilities;
860f085b
AH
381 struct {
382 __u64 cap_usr_time : 1,
383 cap_usr_rdpmc : 1,
c73deb6a
AH
384 cap_usr_time_zero : 1,
385 cap_____res : 61;
860f085b 386 };
607ca46e
DH
387 };
388
389 /*
390 * If cap_usr_rdpmc this field provides the bit-width of the value
391 * read using the rdpmc() or equivalent instruction. This can be used
392 * to sign extend the result like:
393 *
394 * pmc <<= 64 - width;
395 * pmc >>= 64 - width; // signed shift right
396 * count += pmc;
397 */
398 __u16 pmc_width;
399
400 /*
401 * If cap_usr_time the below fields can be used to compute the time
402 * delta since time_enabled (in ns) using rdtsc or similar.
403 *
404 * u64 quot, rem;
405 * u64 delta;
406 *
407 * quot = (cyc >> time_shift);
408 * rem = cyc & ((1 << time_shift) - 1);
409 * delta = time_offset + quot * time_mult +
410 * ((rem * time_mult) >> time_shift);
411 *
412 * Where time_offset,time_mult,time_shift and cyc are read in the
413 * seqcount loop described above. This delta can then be added to
414 * enabled and possible running (if idx), improving the scaling:
415 *
416 * enabled += delta;
417 * if (idx)
418 * running += delta;
419 *
420 * quot = count / running;
421 * rem = count % running;
422 * count = quot * enabled + (rem * enabled) / running;
423 */
424 __u16 time_shift;
425 __u32 time_mult;
426 __u64 time_offset;
c73deb6a
AH
427 /*
428 * If cap_usr_time_zero, the hardware clock (e.g. TSC) can be calculated
429 * from sample timestamps.
430 *
431 * time = timestamp - time_zero;
432 * quot = time / time_mult;
433 * rem = time % time_mult;
434 * cyc = (quot << time_shift) + (rem << time_shift) / time_mult;
435 *
436 * And vice versa:
437 *
438 * quot = cyc >> time_shift;
439 * rem = cyc & ((1 << time_shift) - 1);
440 * timestamp = time_zero + quot * time_mult +
441 * ((rem * time_mult) >> time_shift);
442 */
443 __u64 time_zero;
607ca46e
DH
444
445 /*
446 * Hole for extension of the self monitor capabilities
447 */
448
c73deb6a 449 __u64 __reserved[119]; /* align to 1k */
607ca46e
DH
450
451 /*
452 * Control data for the mmap() data buffer.
453 *
454 * User-space reading the @data_head value should issue an rmb(), on
455 * SMP capable platforms, after reading this value -- see
456 * perf_event_wakeup().
457 *
458 * When the mapping is PROT_WRITE the @data_tail value should be
459 * written by userspace to reflect the last read data. In this case
460 * the kernel will not over-write unread data.
461 */
462 __u64 data_head; /* head in the data section */
463 __u64 data_tail; /* user-space written tail */
464};
465
466#define PERF_RECORD_MISC_CPUMODE_MASK (7 << 0)
467#define PERF_RECORD_MISC_CPUMODE_UNKNOWN (0 << 0)
468#define PERF_RECORD_MISC_KERNEL (1 << 0)
469#define PERF_RECORD_MISC_USER (2 << 0)
470#define PERF_RECORD_MISC_HYPERVISOR (3 << 0)
471#define PERF_RECORD_MISC_GUEST_KERNEL (4 << 0)
472#define PERF_RECORD_MISC_GUEST_USER (5 << 0)
473
2fe85427 474#define PERF_RECORD_MISC_MMAP_DATA (1 << 13)
607ca46e
DH
475/*
476 * Indicates that the content of PERF_SAMPLE_IP points to
477 * the actual instruction that triggered the event. See also
478 * perf_event_attr::precise_ip.
479 */
480#define PERF_RECORD_MISC_EXACT_IP (1 << 14)
481/*
482 * Reserve the last bit to indicate some extended misc field
483 */
484#define PERF_RECORD_MISC_EXT_RESERVED (1 << 15)
485
486struct perf_event_header {
487 __u32 type;
488 __u16 misc;
489 __u16 size;
490};
491
492enum perf_event_type {
493
494 /*
495 * If perf_event_attr.sample_id_all is set then all event types will
496 * have the sample_type selected fields related to where/when
ff3d527c
AH
497 * (identity) an event took place (TID, TIME, ID, STREAM_ID, CPU,
498 * IDENTIFIER) described in PERF_RECORD_SAMPLE below, it will be stashed
499 * just after the perf_event_header and the fields already present for
500 * the existing fields, i.e. at the end of the payload. That way a newer
501 * perf.data file will be supported by older perf tools, with these new
502 * optional fields being ignored.
607ca46e 503 *
a5cdd40c
PZ
504 * struct sample_id {
505 * { u32 pid, tid; } && PERF_SAMPLE_TID
506 * { u64 time; } && PERF_SAMPLE_TIME
507 * { u64 id; } && PERF_SAMPLE_ID
508 * { u64 stream_id;} && PERF_SAMPLE_STREAM_ID
509 * { u32 cpu, res; } && PERF_SAMPLE_CPU
ff3d527c 510 * { u64 id; } && PERF_SAMPLE_IDENTIFIER
a5cdd40c 511 * } && perf_event_attr::sample_id_all
ff3d527c
AH
512 *
513 * Note that PERF_SAMPLE_IDENTIFIER duplicates PERF_SAMPLE_ID. The
514 * advantage of PERF_SAMPLE_IDENTIFIER is that its position is fixed
515 * relative to header.size.
a5cdd40c
PZ
516 */
517
518 /*
607ca46e
DH
519 * The MMAP events record the PROT_EXEC mappings so that we can
520 * correlate userspace IPs to code. They have the following structure:
521 *
522 * struct {
523 * struct perf_event_header header;
524 *
525 * u32 pid, tid;
526 * u64 addr;
527 * u64 len;
528 * u64 pgoff;
529 * char filename[];
530 * };
531 */
532 PERF_RECORD_MMAP = 1,
533
534 /*
535 * struct {
536 * struct perf_event_header header;
537 * u64 id;
538 * u64 lost;
a5cdd40c 539 * struct sample_id sample_id;
607ca46e
DH
540 * };
541 */
542 PERF_RECORD_LOST = 2,
543
544 /*
545 * struct {
546 * struct perf_event_header header;
547 *
548 * u32 pid, tid;
549 * char comm[];
a5cdd40c 550 * struct sample_id sample_id;
607ca46e
DH
551 * };
552 */
553 PERF_RECORD_COMM = 3,
554
555 /*
556 * struct {
557 * struct perf_event_header header;
558 * u32 pid, ppid;
559 * u32 tid, ptid;
560 * u64 time;
a5cdd40c 561 * struct sample_id sample_id;
607ca46e
DH
562 * };
563 */
564 PERF_RECORD_EXIT = 4,
565
566 /*
567 * struct {
568 * struct perf_event_header header;
569 * u64 time;
570 * u64 id;
571 * u64 stream_id;
a5cdd40c 572 * struct sample_id sample_id;
607ca46e
DH
573 * };
574 */
575 PERF_RECORD_THROTTLE = 5,
576 PERF_RECORD_UNTHROTTLE = 6,
577
578 /*
579 * struct {
580 * struct perf_event_header header;
581 * u32 pid, ppid;
582 * u32 tid, ptid;
583 * u64 time;
a5cdd40c 584 * struct sample_id sample_id;
607ca46e
DH
585 * };
586 */
587 PERF_RECORD_FORK = 7,
588
589 /*
590 * struct {
591 * struct perf_event_header header;
592 * u32 pid, tid;
593 *
594 * struct read_format values;
a5cdd40c 595 * struct sample_id sample_id;
607ca46e
DH
596 * };
597 */
598 PERF_RECORD_READ = 8,
599
600 /*
601 * struct {
602 * struct perf_event_header header;
603 *
ff3d527c
AH
604 * #
605 * # Note that PERF_SAMPLE_IDENTIFIER duplicates PERF_SAMPLE_ID.
606 * # The advantage of PERF_SAMPLE_IDENTIFIER is that its position
607 * # is fixed relative to header.
608 * #
609 *
610 * { u64 id; } && PERF_SAMPLE_IDENTIFIER
607ca46e
DH
611 * { u64 ip; } && PERF_SAMPLE_IP
612 * { u32 pid, tid; } && PERF_SAMPLE_TID
613 * { u64 time; } && PERF_SAMPLE_TIME
614 * { u64 addr; } && PERF_SAMPLE_ADDR
615 * { u64 id; } && PERF_SAMPLE_ID
616 * { u64 stream_id;} && PERF_SAMPLE_STREAM_ID
617 * { u32 cpu, res; } && PERF_SAMPLE_CPU
618 * { u64 period; } && PERF_SAMPLE_PERIOD
619 *
620 * { struct read_format values; } && PERF_SAMPLE_READ
621 *
622 * { u64 nr,
623 * u64 ips[nr]; } && PERF_SAMPLE_CALLCHAIN
624 *
625 * #
626 * # The RAW record below is opaque data wrt the ABI
627 * #
628 * # That is, the ABI doesn't make any promises wrt to
629 * # the stability of its content, it may vary depending
630 * # on event, hardware, kernel version and phase of
631 * # the moon.
632 * #
633 * # In other words, PERF_SAMPLE_RAW contents are not an ABI.
634 * #
635 *
636 * { u32 size;
637 * char data[size];}&& PERF_SAMPLE_RAW
638 *
b878e7fb
VW
639 * { u64 nr;
640 * { u64 from, to, flags } lbr[nr];} && PERF_SAMPLE_BRANCH_STACK
607ca46e
DH
641 *
642 * { u64 abi; # enum perf_sample_regs_abi
643 * u64 regs[weight(mask)]; } && PERF_SAMPLE_REGS_USER
644 *
645 * { u64 size;
646 * char data[size];
647 * u64 dyn_size; } && PERF_SAMPLE_STACK_USER
c3feedf2
AK
648 *
649 * { u64 weight; } && PERF_SAMPLE_WEIGHT
a5cdd40c 650 * { u64 data_src; } && PERF_SAMPLE_DATA_SRC
607ca46e
DH
651 * };
652 */
653 PERF_RECORD_SAMPLE = 9,
654
13d7a241
SE
655 /*
656 * The MMAP2 records are an augmented version of MMAP, they add
657 * maj, min, ino numbers to be used to uniquely identify each mapping
658 *
659 * struct {
660 * struct perf_event_header header;
661 *
662 * u32 pid, tid;
663 * u64 addr;
664 * u64 len;
665 * u64 pgoff;
666 * u32 maj;
667 * u32 min;
668 * u64 ino;
669 * u64 ino_generation;
670 * char filename[];
671 * struct sample_id sample_id;
672 * };
673 */
674 PERF_RECORD_MMAP2 = 10,
675
607ca46e
DH
676 PERF_RECORD_MAX, /* non-ABI */
677};
678
679#define PERF_MAX_STACK_DEPTH 127
680
681enum perf_callchain_context {
682 PERF_CONTEXT_HV = (__u64)-32,
683 PERF_CONTEXT_KERNEL = (__u64)-128,
684 PERF_CONTEXT_USER = (__u64)-512,
685
686 PERF_CONTEXT_GUEST = (__u64)-2048,
687 PERF_CONTEXT_GUEST_KERNEL = (__u64)-2176,
688 PERF_CONTEXT_GUEST_USER = (__u64)-2560,
689
690 PERF_CONTEXT_MAX = (__u64)-4095,
691};
692
693#define PERF_FLAG_FD_NO_GROUP (1U << 0)
694#define PERF_FLAG_FD_OUTPUT (1U << 1)
695#define PERF_FLAG_PID_CGROUP (1U << 2) /* pid=cgroup id, per-cpu mode only */
696
d6be9ad6
SE
697union perf_mem_data_src {
698 __u64 val;
699 struct {
700 __u64 mem_op:5, /* type of opcode */
701 mem_lvl:14, /* memory hierarchy level */
702 mem_snoop:5, /* snoop mode */
703 mem_lock:2, /* lock instr */
704 mem_dtlb:7, /* tlb access */
705 mem_rsvd:31;
706 };
707};
708
709/* type of opcode (load/store/prefetch,code) */
710#define PERF_MEM_OP_NA 0x01 /* not available */
711#define PERF_MEM_OP_LOAD 0x02 /* load instruction */
712#define PERF_MEM_OP_STORE 0x04 /* store instruction */
713#define PERF_MEM_OP_PFETCH 0x08 /* prefetch */
714#define PERF_MEM_OP_EXEC 0x10 /* code (execution) */
715#define PERF_MEM_OP_SHIFT 0
716
717/* memory hierarchy (memory level, hit or miss) */
718#define PERF_MEM_LVL_NA 0x01 /* not available */
719#define PERF_MEM_LVL_HIT 0x02 /* hit level */
720#define PERF_MEM_LVL_MISS 0x04 /* miss level */
721#define PERF_MEM_LVL_L1 0x08 /* L1 */
722#define PERF_MEM_LVL_LFB 0x10 /* Line Fill Buffer */
cc2f5a8a
SE
723#define PERF_MEM_LVL_L2 0x20 /* L2 */
724#define PERF_MEM_LVL_L3 0x40 /* L3 */
d6be9ad6
SE
725#define PERF_MEM_LVL_LOC_RAM 0x80 /* Local DRAM */
726#define PERF_MEM_LVL_REM_RAM1 0x100 /* Remote DRAM (1 hop) */
727#define PERF_MEM_LVL_REM_RAM2 0x200 /* Remote DRAM (2 hops) */
728#define PERF_MEM_LVL_REM_CCE1 0x400 /* Remote Cache (1 hop) */
729#define PERF_MEM_LVL_REM_CCE2 0x800 /* Remote Cache (2 hops) */
730#define PERF_MEM_LVL_IO 0x1000 /* I/O memory */
731#define PERF_MEM_LVL_UNC 0x2000 /* Uncached memory */
732#define PERF_MEM_LVL_SHIFT 5
733
734/* snoop mode */
735#define PERF_MEM_SNOOP_NA 0x01 /* not available */
736#define PERF_MEM_SNOOP_NONE 0x02 /* no snoop */
737#define PERF_MEM_SNOOP_HIT 0x04 /* snoop hit */
738#define PERF_MEM_SNOOP_MISS 0x08 /* snoop miss */
739#define PERF_MEM_SNOOP_HITM 0x10 /* snoop hit modified */
740#define PERF_MEM_SNOOP_SHIFT 19
741
742/* locked instruction */
743#define PERF_MEM_LOCK_NA 0x01 /* not available */
744#define PERF_MEM_LOCK_LOCKED 0x02 /* locked transaction */
745#define PERF_MEM_LOCK_SHIFT 24
746
747/* TLB access */
748#define PERF_MEM_TLB_NA 0x01 /* not available */
749#define PERF_MEM_TLB_HIT 0x02 /* hit level */
750#define PERF_MEM_TLB_MISS 0x04 /* miss level */
751#define PERF_MEM_TLB_L1 0x08 /* L1 */
752#define PERF_MEM_TLB_L2 0x10 /* L2 */
753#define PERF_MEM_TLB_WK 0x20 /* Hardware Walker*/
754#define PERF_MEM_TLB_OS 0x40 /* OS fault handler */
755#define PERF_MEM_TLB_SHIFT 26
756
757#define PERF_MEM_S(a, s) \
758 (((u64)PERF_MEM_##a##_##s) << PERF_MEM_##a##_SHIFT)
759
607ca46e 760#endif /* _UAPI_LINUX_PERF_EVENT_H */