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
 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  */
 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,
 135         PERF_SAMPLE_WEIGHT                      = 1U << 14,
 136         PERF_SAMPLE_DATA_SRC                    = 1U << 15,
 137         PERF_SAMPLE_IDENTIFIER                  = 1U << 16,
 138
 139         PERF_SAMPLE_MAX = 1U << 17,             /* non-ABI */
 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  */
 152 enum 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 */
 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 */
 164
 165         PERF_SAMPLE_BRANCH_MAX          = 1U << 10, /* non-ABI */
 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  */
 176 enum 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  */
 202 enum 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  */
 220 struct 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 */
 279
 280                                 __reserved_1   : 41;
 281
 282         union {
 283                 __u32           wakeup_events;    /* wakeup every n events */
 284                 __u32           wakeup_watermark; /* bytes before wakeup   */
 285         };
 286
 287         __u32                   bp_type;
 288         union {
 289                 __u64           bp_addr;
 290                 __u64           config1; /* extension of config */
 291         };
 292         union {
 293                 __u64           bp_len;
 294                 __u64           config2; /* extension of config1 */
 295         };
 296         __u64   branch_sample_type; /* enum perf_branch_sample_type */
 297
 298         /*
 299          * Defines set of user regs to dump on samples.
 300          * See asm/perf_regs.h for details.
 301          */
 302         __u64   sample_regs_user;
 303
 304         /*
 305          * Defines size of the user stack to dump on samples.
 306          */
 307         __u32   sample_stack_user;
 308
 309         /* Align to u64. */
 310         __u32   __reserved_2;
 311 };
 312
 313 #define perf_flags(attr)        (*(&(attr)->read_format + 1))
 314
 315 /*
 316  * Ioctls that can be done on a perf event fd:
 317  */
 318 #define PERF_EVENT_IOC_ENABLE           _IO ('$', 0)
 319 #define PERF_EVENT_IOC_DISABLE          _IO ('$', 1)
 320 #define PERF_EVENT_IOC_REFRESH          _IO ('$', 2)
 321 #define PERF_EVENT_IOC_RESET            _IO ('$', 3)
 322 #define PERF_EVENT_IOC_PERIOD           _IOW('$', 4, __u64)
 323 #define PERF_EVENT_IOC_SET_OUTPUT       _IO ('$', 5)
 324 #define PERF_EVENT_IOC_SET_FILTER       _IOW('$', 6, char *)
 325 #define PERF_EVENT_IOC_ID               _IOR('$', 7, u64 *)
 326
 327 enum perf_event_ioc_flags {
 328         PERF_IOC_FLAG_GROUP             = 1U << 0,
 329 };
 330
 331 /*
 332  * Structure of the page that can be mapped via mmap
 333  */
 334 struct perf_event_mmap_page {
 335         __u32   version;                /* version number of this structure */
 336         __u32   compat_version;         /* lowest version this is compat with */
 337
 338         /*
 339          * Bits needed to read the hw events in user-space.
 340          *
 341          *   u32 seq, time_mult, time_shift, idx, width;
 342          *   u64 count, enabled, running;
 343          *   u64 cyc, time_offset;
 344          *   s64 pmc = 0;
 345          *
 346          *   do {
 347          *     seq = pc->lock;
 348          *     barrier()
 349          *
 350          *     enabled = pc->time_enabled;
 351          *     running = pc->time_running;
 352          *
 353          *     if (pc->cap_usr_time && enabled != running) {
 354          *       cyc = rdtsc();
 355          *       time_offset = pc->time_offset;
 356          *       time_mult   = pc->time_mult;
 357          *       time_shift  = pc->time_shift;
 358          *     }
 359          *
 360          *     idx = pc->index;
 361          *     count = pc->offset;
 362          *     if (pc->cap_usr_rdpmc && idx) {
 363          *       width = pc->pmc_width;
 364          *       pmc = rdpmc(idx - 1);
 365          *     }
 366          *
 367          *     barrier();
 368          *   } while (pc->lock != seq);
 369          *
 370          * NOTE: for obvious reason this only works on self-monitoring
 371          *       processes.
 372          */
 373         __u32   lock;                   /* seqlock for synchronization */
 374         __u32   index;                  /* hardware event identifier */
 375         __s64   offset;                 /* add to hardware event value */
 376         __u64   time_enabled;           /* time event active */
 377         __u64   time_running;           /* time event on cpu */
 378         union {
 379                 __u64   capabilities;
 380                 struct {
 381                         __u64   cap_usr_time            : 1,
 382                                 cap_usr_rdpmc           : 1,
 383                                 cap_usr_time_zero       : 1,
 384                                 cap_____res             : 61;
 385                 };
 386         };
 387
 388         /*
 389          * If cap_usr_rdpmc this field provides the bit-width of the value
 390          * read using the rdpmc() or equivalent instruction. This can be used
 391          * to sign extend the result like:
 392          *
 393          *   pmc <<= 64 - width;
 394          *   pmc >>= 64 - width; // signed shift right
 395          *   count += pmc;
 396          */
 397         __u16   pmc_width;
 398
 399         /*
 400          * If cap_usr_time the below fields can be used to compute the time
 401          * delta since time_enabled (in ns) using rdtsc or similar.
 402          *
 403          *   u64 quot, rem;
 404          *   u64 delta;
 405          *
 406          *   quot = (cyc >> time_shift);
 407          *   rem = cyc & ((1 << time_shift) - 1);
 408          *   delta = time_offset + quot * time_mult +
 409          *              ((rem * time_mult) >> time_shift);
 410          *
 411          * Where time_offset,time_mult,time_shift and cyc are read in the
 412          * seqcount loop described above. This delta can then be added to
 413          * enabled and possible running (if idx), improving the scaling:
 414          *
 415          *   enabled += delta;
 416          *   if (idx)
 417          *     running += delta;
 418          *
 419          *   quot = count / running;
 420          *   rem  = count % running;
 421          *   count = quot * enabled + (rem * enabled) / running;
 422          */
 423         __u16   time_shift;
 424         __u32   time_mult;
 425         __u64   time_offset;
 426         /*
 427          * If cap_usr_time_zero, the hardware clock (e.g. TSC) can be calculated
 428          * from sample timestamps.
 429          *
 430          *   time = timestamp - time_zero;
 431          *   quot = time / time_mult;
 432          *   rem  = time % time_mult;
 433          *   cyc = (quot << time_shift) + (rem << time_shift) / time_mult;
 434          *
 435          * And vice versa:
 436          *
 437          *   quot = cyc >> time_shift;
 438          *   rem  = cyc & ((1 << time_shift) - 1);
 439          *   timestamp = time_zero + quot * time_mult +
 440          *               ((rem * time_mult) >> time_shift);
 441          */
 442         __u64   time_zero;
 443
 444                 /*
 445                  * Hole for extension of the self monitor capabilities
 446                  */
 447
 448         __u64   __reserved[119];        /* align to 1k */
 449
 450         /*
 451          * Control data for the mmap() data buffer.
 452          *
 453          * User-space reading the @data_head value should issue an rmb(), on
 454          * SMP capable platforms, after reading this value -- see
 455          * perf_event_wakeup().
 456          *
 457          * When the mapping is PROT_WRITE the @data_tail value should be
 458          * written by userspace to reflect the last read data. In this case
 459          * the kernel will not over-write unread data.
 460          */
 461         __u64   data_head;              /* head in the data section */
 462         __u64   data_tail;              /* user-space written tail */
 463 };
 464
 465 #define PERF_RECORD_MISC_CPUMODE_MASK           (7 << 0)
 466 #define PERF_RECORD_MISC_CPUMODE_UNKNOWN        (0 << 0)
 467 #define PERF_RECORD_MISC_KERNEL                 (1 << 0)
 468 #define PERF_RECORD_MISC_USER                   (2 << 0)
 469 #define PERF_RECORD_MISC_HYPERVISOR             (3 << 0)
 470 #define PERF_RECORD_MISC_GUEST_KERNEL           (4 << 0)
 471 #define PERF_RECORD_MISC_GUEST_USER             (5 << 0)
 472
 473 #define PERF_RECORD_MISC_MMAP_DATA              (1 << 13)
 474 /*
 475  * Indicates that the content of PERF_SAMPLE_IP points to
 476  * the actual instruction that triggered the event. See also
 477  * perf_event_attr::precise_ip.
 478  */
 479 #define PERF_RECORD_MISC_EXACT_IP               (1 << 14)
 480 /*
 481  * Reserve the last bit to indicate some extended misc field
 482  */
 483 #define PERF_RECORD_MISC_EXT_RESERVED           (1 << 15)
 484
 485 struct perf_event_header {
 486         __u32   type;
 487         __u16   misc;
 488         __u16   size;
 489 };
 490
 491 enum perf_event_type {
 492
 493         /*
 494          * If perf_event_attr.sample_id_all is set then all event types will
 495          * have the sample_type selected fields related to where/when
 496          * (identity) an event took place (TID, TIME, ID, STREAM_ID, CPU,
 497          * IDENTIFIER) described in PERF_RECORD_SAMPLE below, it will be stashed
 498          * just after the perf_event_header and the fields already present for
 499          * the existing fields, i.e. at the end of the payload. That way a newer
 500          * perf.data file will be supported by older perf tools, with these new
 501          * optional fields being ignored.
 502          *
 503          * struct sample_id {
 504          *      { u32                   pid, tid; } && PERF_SAMPLE_TID
 505          *      { u64                   time;     } && PERF_SAMPLE_TIME
 506          *      { u64                   id;       } && PERF_SAMPLE_ID
 507          *      { u64                   stream_id;} && PERF_SAMPLE_STREAM_ID
 508          *      { u32                   cpu, res; } && PERF_SAMPLE_CPU
 509          *      { u64                   id;       } && PERF_SAMPLE_IDENTIFIER
 510          * } && perf_event_attr::sample_id_all
 511          *
 512          * Note that PERF_SAMPLE_IDENTIFIER duplicates PERF_SAMPLE_ID.  The
 513          * advantage of PERF_SAMPLE_IDENTIFIER is that its position is fixed
 514          * relative to header.size.
 515          */
 516
 517         /*
 518          * The MMAP events record the PROT_EXEC mappings so that we can
 519          * correlate userspace IPs to code. They have the following structure:
 520          *
 521          * struct {
 522          *      struct perf_event_header        header;
 523          *
 524          *      u32                             pid, tid;
 525          *      u64                             addr;
 526          *      u64                             len;
 527          *      u64                             pgoff;
 528          *      char                            filename[];
 529          * };
 530          */
 531         PERF_RECORD_MMAP                        = 1,
 532
 533         /*
 534          * struct {
 535          *      struct perf_event_header        header;
 536          *      u64                             id;
 537          *      u64                             lost;
 538          *      struct sample_id                sample_id;
 539          * };
 540          */
 541         PERF_RECORD_LOST                        = 2,
 542
 543         /*
 544          * struct {
 545          *      struct perf_event_header        header;
 546          *
 547          *      u32                             pid, tid;
 548          *      char                            comm[];
 549          *      struct sample_id                sample_id;
 550          * };
 551          */
 552         PERF_RECORD_COMM                        = 3,
 553
 554         /*
 555          * struct {
 556          *      struct perf_event_header        header;
 557          *      u32                             pid, ppid;
 558          *      u32                             tid, ptid;
 559          *      u64                             time;
 560          *      struct sample_id                sample_id;
 561          * };
 562          */
 563         PERF_RECORD_EXIT                        = 4,
 564
 565         /*
 566          * struct {
 567          *      struct perf_event_header        header;
 568          *      u64                             time;
 569          *      u64                             id;
 570          *      u64                             stream_id;
 571          *      struct sample_id                sample_id;
 572          * };
 573          */
 574         PERF_RECORD_THROTTLE                    = 5,
 575         PERF_RECORD_UNTHROTTLE                  = 6,
 576
 577         /*
 578          * struct {
 579          *      struct perf_event_header        header;
 580          *      u32                             pid, ppid;
 581          *      u32                             tid, ptid;
 582          *      u64                             time;
 583          *      struct sample_id                sample_id;
 584          * };
 585          */
 586         PERF_RECORD_FORK                        = 7,
 587
 588         /*
 589          * struct {
 590          *      struct perf_event_header        header;
 591          *      u32                             pid, tid;
 592          *
 593          *      struct read_format              values;
 594          *      struct sample_id                sample_id;
 595          * };
 596          */
 597         PERF_RECORD_READ                        = 8,
 598
 599         /*
 600          * struct {
 601          *      struct perf_event_header        header;
 602          *
 603          *      #
 604          *      # Note that PERF_SAMPLE_IDENTIFIER duplicates PERF_SAMPLE_ID.
 605          *      # The advantage of PERF_SAMPLE_IDENTIFIER is that its position
 606          *      # is fixed relative to header.
 607          *      #
 608          *
 609          *      { u64                   id;       } && PERF_SAMPLE_IDENTIFIER
 610          *      { u64                   ip;       } && PERF_SAMPLE_IP
 611          *      { u32                   pid, tid; } && PERF_SAMPLE_TID
 612          *      { u64                   time;     } && PERF_SAMPLE_TIME
 613          *      { u64                   addr;     } && PERF_SAMPLE_ADDR
 614          *      { u64                   id;       } && PERF_SAMPLE_ID
 615          *      { u64                   stream_id;} && PERF_SAMPLE_STREAM_ID
 616          *      { u32                   cpu, res; } && PERF_SAMPLE_CPU
 617          *      { u64                   period;   } && PERF_SAMPLE_PERIOD
 618          *
 619          *      { struct read_format    values;   } && PERF_SAMPLE_READ
 620          *
 621          *      { u64                   nr,
 622          *        u64                   ips[nr];  } && PERF_SAMPLE_CALLCHAIN
 623          *
 624          *      #
 625          *      # The RAW record below is opaque data wrt the ABI
 626          *      #
 627          *      # That is, the ABI doesn't make any promises wrt to
 628          *      # the stability of its content, it may vary depending
 629          *      # on event, hardware, kernel version and phase of
 630          *      # the moon.
 631          *      #
 632          *      # In other words, PERF_SAMPLE_RAW contents are not an ABI.
 633          *      #
 634          *
 635          *      { u32                   size;
 636          *        char                  data[size];}&& PERF_SAMPLE_RAW
 637          *
 638          *      { u64                   nr;
 639          *        { u64 from, to, flags } lbr[nr];} && PERF_SAMPLE_BRANCH_STACK
 640          *
 641          *      { u64                   abi; # enum perf_sample_regs_abi
 642          *        u64                   regs[weight(mask)]; } && PERF_SAMPLE_REGS_USER
 643          *
 644          *      { u64                   size;
 645          *        char                  data[size];
 646          *        u64                   dyn_size; } && PERF_SAMPLE_STACK_USER
 647          *
 648          *      { u64                   weight;   } && PERF_SAMPLE_WEIGHT
 649          *      { u64                   data_src; } && PERF_SAMPLE_DATA_SRC
 650          * };
 651          */
 652         PERF_RECORD_SAMPLE                      = 9,
 653
 654         PERF_RECORD_MAX,                        /* non-ABI */
 655 };
 656
 657 #define PERF_MAX_STACK_DEPTH            127
 658
 659 enum perf_callchain_context {
 660         PERF_CONTEXT_HV                 = (__u64)-32,
 661         PERF_CONTEXT_KERNEL             = (__u64)-128,
 662         PERF_CONTEXT_USER               = (__u64)-512,
 663
 664         PERF_CONTEXT_GUEST              = (__u64)-2048,
 665         PERF_CONTEXT_GUEST_KERNEL       = (__u64)-2176,
 666         PERF_CONTEXT_GUEST_USER         = (__u64)-2560,
 667
 668         PERF_CONTEXT_MAX                = (__u64)-4095,
 669 };
 670
 671 #define PERF_FLAG_FD_NO_GROUP           (1U << 0)
 672 #define PERF_FLAG_FD_OUTPUT             (1U << 1)
 673 #define PERF_FLAG_PID_CGROUP            (1U << 2) /* pid=cgroup id, per-cpu mode only */
 674
 675 union perf_mem_data_src {
 676         __u64 val;
 677         struct {
 678                 __u64   mem_op:5,       /* type of opcode */
 679                         mem_lvl:14,     /* memory hierarchy level */
 680                         mem_snoop:5,    /* snoop mode */
 681                         mem_lock:2,     /* lock instr */
 682                         mem_dtlb:7,     /* tlb access */
 683                         mem_rsvd:31;
 684         };
 685 };
 686
 687 /* type of opcode (load/store/prefetch,code) */
 688 #define PERF_MEM_OP_NA          0x01 /* not available */
 689 #define PERF_MEM_OP_LOAD        0x02 /* load instruction */
 690 #define PERF_MEM_OP_STORE       0x04 /* store instruction */
 691 #define PERF_MEM_OP_PFETCH      0x08 /* prefetch */
 692 #define PERF_MEM_OP_EXEC        0x10 /* code (execution) */
 693 #define PERF_MEM_OP_SHIFT       0
 694
 695 /* memory hierarchy (memory level, hit or miss) */
 696 #define PERF_MEM_LVL_NA         0x01  /* not available */
 697 #define PERF_MEM_LVL_HIT        0x02  /* hit level */
 698 #define PERF_MEM_LVL_MISS       0x04  /* miss level  */
 699 #define PERF_MEM_LVL_L1         0x08  /* L1 */
 700 #define PERF_MEM_LVL_LFB        0x10  /* Line Fill Buffer */
 701 #define PERF_MEM_LVL_L2         0x20  /* L2 */
 702 #define PERF_MEM_LVL_L3         0x40  /* L3 */
 703 #define PERF_MEM_LVL_LOC_RAM    0x80  /* Local DRAM */
 704 #define PERF_MEM_LVL_REM_RAM1   0x100 /* Remote DRAM (1 hop) */
 705 #define PERF_MEM_LVL_REM_RAM2   0x200 /* Remote DRAM (2 hops) */
 706 #define PERF_MEM_LVL_REM_CCE1   0x400 /* Remote Cache (1 hop) */
 707 #define PERF_MEM_LVL_REM_CCE2   0x800 /* Remote Cache (2 hops) */
 708 #define PERF_MEM_LVL_IO         0x1000 /* I/O memory */
 709 #define PERF_MEM_LVL_UNC        0x2000 /* Uncached memory */
 710 #define PERF_MEM_LVL_SHIFT      5
 711
 712 /* snoop mode */
 713 #define PERF_MEM_SNOOP_NA       0x01 /* not available */
 714 #define PERF_MEM_SNOOP_NONE     0x02 /* no snoop */
 715 #define PERF_MEM_SNOOP_HIT      0x04 /* snoop hit */
 716 #define PERF_MEM_SNOOP_MISS     0x08 /* snoop miss */
 717 #define PERF_MEM_SNOOP_HITM     0x10 /* snoop hit modified */
 718 #define PERF_MEM_SNOOP_SHIFT    19
 719
 720 /* locked instruction */
 721 #define PERF_MEM_LOCK_NA        0x01 /* not available */
 722 #define PERF_MEM_LOCK_LOCKED    0x02 /* locked transaction */
 723 #define PERF_MEM_LOCK_SHIFT     24
 724
 725 /* TLB access */
 726 #define PERF_MEM_TLB_NA         0x01 /* not available */
 727 #define PERF_MEM_TLB_HIT        0x02 /* hit level */
 728 #define PERF_MEM_TLB_MISS       0x04 /* miss level */
 729 #define PERF_MEM_TLB_L1         0x08 /* L1 */
 730 #define PERF_MEM_TLB_L2         0x10 /* L2 */
 731 #define PERF_MEM_TLB_WK         0x20 /* Hardware Walker*/
 732 #define PERF_MEM_TLB_OS         0x40 /* OS fault handler */
 733 #define PERF_MEM_TLB_SHIFT      26
 734
 735 #define PERF_MEM_S(a, s) \
 736         (((u64)PERF_MEM_##a##_##s) << PERF_MEM_##a##_SHIFT)
 737
 738 #endif /* _UAPI_LINUX_PERF_EVENT_H */