include/uapi/linux/perf_event.h

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