include/linux/perf_event.h

   1 /*
   2  * Performance events:
   3  *
   4  *    Copyright (C) 2008-2009, Thomas Gleixner <tglx@linutronix.de>
   5  *    Copyright (C) 2008-2009, Red Hat, Inc., Ingo Molnar
   6  *    Copyright (C) 2008-2009, 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 _LINUX_PERF_EVENT_H
  15 #define _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
  56         PERF_COUNT_HW_MAX,                      /* non-ABI */
  57 };
  58
  59 /*
  60  * Generalized hardware cache events:
  61  *
  62  *       { L1-D, L1-I, LLC, ITLB, DTLB, BPU } x
  63  *       { read, write, prefetch } x
  64  *       { accesses, misses }
  65  */
  66 enum perf_hw_cache_id {
  67         PERF_COUNT_HW_CACHE_L1D                 = 0,
  68         PERF_COUNT_HW_CACHE_L1I                 = 1,
  69         PERF_COUNT_HW_CACHE_LL                  = 2,
  70         PERF_COUNT_HW_CACHE_DTLB                = 3,
  71         PERF_COUNT_HW_CACHE_ITLB                = 4,
  72         PERF_COUNT_HW_CACHE_BPU                 = 5,
  73
  74         PERF_COUNT_HW_CACHE_MAX,                /* non-ABI */
  75 };
  76
  77 enum perf_hw_cache_op_id {
  78         PERF_COUNT_HW_CACHE_OP_READ             = 0,
  79         PERF_COUNT_HW_CACHE_OP_WRITE            = 1,
  80         PERF_COUNT_HW_CACHE_OP_PREFETCH         = 2,
  81
  82         PERF_COUNT_HW_CACHE_OP_MAX,             /* non-ABI */
  83 };
  84
  85 enum perf_hw_cache_op_result_id {
  86         PERF_COUNT_HW_CACHE_RESULT_ACCESS       = 0,
  87         PERF_COUNT_HW_CACHE_RESULT_MISS         = 1,
  88
  89         PERF_COUNT_HW_CACHE_RESULT_MAX,         /* non-ABI */
  90 };
  91
  92 /*
  93  * Special "software" events provided by the kernel, even if the hardware
  94  * does not support performance events. These events measure various
  95  * physical and sw events of the kernel (and allow the profiling of them as
  96  * well):
  97  */
  98 enum perf_sw_ids {
  99         PERF_COUNT_SW_CPU_CLOCK                 = 0,
 100         PERF_COUNT_SW_TASK_CLOCK                = 1,
 101         PERF_COUNT_SW_PAGE_FAULTS               = 2,
 102         PERF_COUNT_SW_CONTEXT_SWITCHES          = 3,
 103         PERF_COUNT_SW_CPU_MIGRATIONS            = 4,
 104         PERF_COUNT_SW_PAGE_FAULTS_MIN           = 5,
 105         PERF_COUNT_SW_PAGE_FAULTS_MAJ           = 6,
 106         PERF_COUNT_SW_ALIGNMENT_FAULTS          = 7,
 107         PERF_COUNT_SW_EMULATION_FAULTS          = 8,
 108
 109         PERF_COUNT_SW_MAX,                      /* non-ABI */
 110 };
 111
 112 /*
 113  * Bits that can be set in attr.sample_type to request information
 114  * in the overflow packets.
 115  */
 116 enum perf_event_sample_format {
 117         PERF_SAMPLE_IP                          = 1U << 0,
 118         PERF_SAMPLE_TID                         = 1U << 1,
 119         PERF_SAMPLE_TIME                        = 1U << 2,
 120         PERF_SAMPLE_ADDR                        = 1U << 3,
 121         PERF_SAMPLE_READ                        = 1U << 4,
 122         PERF_SAMPLE_CALLCHAIN                   = 1U << 5,
 123         PERF_SAMPLE_ID                          = 1U << 6,
 124         PERF_SAMPLE_CPU                         = 1U << 7,
 125         PERF_SAMPLE_PERIOD                      = 1U << 8,
 126         PERF_SAMPLE_STREAM_ID                   = 1U << 9,
 127         PERF_SAMPLE_RAW                         = 1U << 10,
 128
 129         PERF_SAMPLE_MAX = 1U << 11,             /* non-ABI */
 130 };
 131
 132 /*
 133  * The format of the data returned by read() on a perf event fd,
 134  * as specified by attr.read_format:
 135  *
 136  * struct read_format {
 137  *      { u64           value;
 138  *        { u64         time_enabled; } && PERF_FORMAT_ENABLED
 139  *        { u64         time_running; } && PERF_FORMAT_RUNNING
 140  *        { u64         id;           } && PERF_FORMAT_ID
 141  *      } && !PERF_FORMAT_GROUP
 142  *
 143  *      { u64           nr;
 144  *        { u64         time_enabled; } && PERF_FORMAT_ENABLED
 145  *        { u64         time_running; } && PERF_FORMAT_RUNNING
 146  *        { u64         value;
 147  *          { u64       id;           } && PERF_FORMAT_ID
 148  *        }             cntr[nr];
 149  *      } && PERF_FORMAT_GROUP
 150  * };
 151  */
 152 enum perf_event_read_format {
 153         PERF_FORMAT_TOTAL_TIME_ENABLED          = 1U << 0,
 154         PERF_FORMAT_TOTAL_TIME_RUNNING          = 1U << 1,
 155         PERF_FORMAT_ID                          = 1U << 2,
 156         PERF_FORMAT_GROUP                       = 1U << 3,
 157
 158         PERF_FORMAT_MAX = 1U << 4,              /* non-ABI */
 159 };
 160
 161 #define PERF_ATTR_SIZE_VER0     64      /* sizeof first published struct */
 162
 163 /*
 164  * Hardware event_id to monitor via a performance monitoring event:
 165  */
 166 struct perf_event_attr {
 167
 168         /*
 169          * Major type: hardware/software/tracepoint/etc.
 170          */
 171         __u32                   type;
 172
 173         /*
 174          * Size of the attr structure, for fwd/bwd compat.
 175          */
 176         __u32                   size;
 177
 178         /*
 179          * Type specific configuration information.
 180          */
 181         __u64                   config;
 182
 183         union {
 184                 __u64           sample_period;
 185                 __u64           sample_freq;
 186         };
 187
 188         __u64                   sample_type;
 189         __u64                   read_format;
 190
 191         __u64                   disabled       :  1, /* off by default        */
 192                                 inherit        :  1, /* children inherit it   */
 193                                 pinned         :  1, /* must always be on PMU */
 194                                 exclusive      :  1, /* only group on PMU     */
 195                                 exclude_user   :  1, /* don't count user      */
 196                                 exclude_kernel :  1, /* ditto kernel          */
 197                                 exclude_hv     :  1, /* ditto hypervisor      */
 198                                 exclude_idle   :  1, /* don't count when idle */
 199                                 mmap           :  1, /* include mmap data     */
 200                                 comm           :  1, /* include comm data     */
 201                                 freq           :  1, /* use freq, not period  */
 202                                 inherit_stat   :  1, /* per task counts       */
 203                                 enable_on_exec :  1, /* next exec enables     */
 204                                 task           :  1, /* trace fork/exit       */
 205                                 watermark      :  1, /* wakeup_watermark      */
 206                                 /*
 207                                  * precise_ip:
 208                                  *
 209                                  *  0 - SAMPLE_IP can have arbitrary skid
 210                                  *  1 - SAMPLE_IP must have constant skid
 211                                  *  2 - SAMPLE_IP requested to have 0 skid
 212                                  *  3 - SAMPLE_IP must have 0 skid
 213                                  *
 214                                  *  See also PERF_RECORD_MISC_EXACT_IP
 215                                  */
 216                                 precise_ip     :  2, /* skid constraint       */
 217                                 mmap_data      :  1, /* non-exec mmap data    */
 218
 219                                 __reserved_1   : 46;
 220
 221         union {
 222                 __u32           wakeup_events;    /* wakeup every n events */
 223                 __u32           wakeup_watermark; /* bytes before wakeup   */
 224         };
 225
 226         __u32                   bp_type;
 227         __u64                   bp_addr;
 228         __u64                   bp_len;
 229 };
 230
 231 /*
 232  * Ioctls that can be done on a perf event fd:
 233  */
 234 #define PERF_EVENT_IOC_ENABLE           _IO ('$', 0)
 235 #define PERF_EVENT_IOC_DISABLE          _IO ('$', 1)
 236 #define PERF_EVENT_IOC_REFRESH          _IO ('$', 2)
 237 #define PERF_EVENT_IOC_RESET            _IO ('$', 3)
 238 #define PERF_EVENT_IOC_PERIOD           _IOW('$', 4, __u64)
 239 #define PERF_EVENT_IOC_SET_OUTPUT       _IO ('$', 5)
 240 #define PERF_EVENT_IOC_SET_FILTER       _IOW('$', 6, char *)
 241
 242 enum perf_event_ioc_flags {
 243         PERF_IOC_FLAG_GROUP             = 1U << 0,
 244 };
 245
 246 /*
 247  * Structure of the page that can be mapped via mmap
 248  */
 249 struct perf_event_mmap_page {
 250         __u32   version;                /* version number of this structure */
 251         __u32   compat_version;         /* lowest version this is compat with */
 252
 253         /*
 254          * Bits needed to read the hw events in user-space.
 255          *
 256          *   u32 seq;
 257          *   s64 count;
 258          *
 259          *   do {
 260          *     seq = pc->lock;
 261          *
 262          *     barrier()
 263          *     if (pc->index) {
 264          *       count = pmc_read(pc->index - 1);
 265          *       count += pc->offset;
 266          *     } else
 267          *       goto regular_read;
 268          *
 269          *     barrier();
 270          *   } while (pc->lock != seq);
 271          *
 272          * NOTE: for obvious reason this only works on self-monitoring
 273          *       processes.
 274          */
 275         __u32   lock;                   /* seqlock for synchronization */
 276         __u32   index;                  /* hardware event identifier */
 277         __s64   offset;                 /* add to hardware event value */
 278         __u64   time_enabled;           /* time event active */
 279         __u64   time_running;           /* time event on cpu */
 280
 281                 /*
 282                  * Hole for extension of the self monitor capabilities
 283                  */
 284
 285         __u64   __reserved[123];        /* align to 1k */
 286
 287         /*
 288          * Control data for the mmap() data buffer.
 289          *
 290          * User-space reading the @data_head value should issue an rmb(), on
 291          * SMP capable platforms, after reading this value -- see
 292          * perf_event_wakeup().
 293          *
 294          * When the mapping is PROT_WRITE the @data_tail value should be
 295          * written by userspace to reflect the last read data. In this case
 296          * the kernel will not over-write unread data.
 297          */
 298         __u64   data_head;              /* head in the data section */
 299         __u64   data_tail;              /* user-space written tail */
 300 };
 301
 302 #define PERF_RECORD_MISC_CPUMODE_MASK           (7 << 0)
 303 #define PERF_RECORD_MISC_CPUMODE_UNKNOWN        (0 << 0)
 304 #define PERF_RECORD_MISC_KERNEL                 (1 << 0)
 305 #define PERF_RECORD_MISC_USER                   (2 << 0)
 306 #define PERF_RECORD_MISC_HYPERVISOR             (3 << 0)
 307 #define PERF_RECORD_MISC_GUEST_KERNEL           (4 << 0)
 308 #define PERF_RECORD_MISC_GUEST_USER             (5 << 0)
 309
 310 /*
 311  * Indicates that the content of PERF_SAMPLE_IP points to
 312  * the actual instruction that triggered the event. See also
 313  * perf_event_attr::precise_ip.
 314  */
 315 #define PERF_RECORD_MISC_EXACT_IP               (1 << 14)
 316 /*
 317  * Reserve the last bit to indicate some extended misc field
 318  */
 319 #define PERF_RECORD_MISC_EXT_RESERVED           (1 << 15)
 320
 321 struct perf_event_header {
 322         __u32   type;
 323         __u16   misc;
 324         __u16   size;
 325 };
 326
 327 enum perf_event_type {
 328
 329         /*
 330          * The MMAP events record the PROT_EXEC mappings so that we can
 331          * correlate userspace IPs to code. They have the following structure:
 332          *
 333          * struct {
 334          *      struct perf_event_header        header;
 335          *
 336          *      u32                             pid, tid;
 337          *      u64                             addr;
 338          *      u64                             len;
 339          *      u64                             pgoff;
 340          *      char                            filename[];
 341          * };
 342          */
 343         PERF_RECORD_MMAP                        = 1,
 344
 345         /*
 346          * struct {
 347          *      struct perf_event_header        header;
 348          *      u64                             id;
 349          *      u64                             lost;
 350          * };
 351          */
 352         PERF_RECORD_LOST                        = 2,
 353
 354         /*
 355          * struct {
 356          *      struct perf_event_header        header;
 357          *
 358          *      u32                             pid, tid;
 359          *      char                            comm[];
 360          * };
 361          */
 362         PERF_RECORD_COMM                        = 3,
 363
 364         /*
 365          * struct {
 366          *      struct perf_event_header        header;
 367          *      u32                             pid, ppid;
 368          *      u32                             tid, ptid;
 369          *      u64                             time;
 370          * };
 371          */
 372         PERF_RECORD_EXIT                        = 4,
 373
 374         /*
 375          * struct {
 376          *      struct perf_event_header        header;
 377          *      u64                             time;
 378          *      u64                             id;
 379          *      u64                             stream_id;
 380          * };
 381          */
 382         PERF_RECORD_THROTTLE                    = 5,
 383         PERF_RECORD_UNTHROTTLE                  = 6,
 384
 385         /*
 386          * struct {
 387          *      struct perf_event_header        header;
 388          *      u32                             pid, ppid;
 389          *      u32                             tid, ptid;
 390          *      u64                             time;
 391          * };
 392          */
 393         PERF_RECORD_FORK                        = 7,
 394
 395         /*
 396          * struct {
 397          *      struct perf_event_header        header;
 398          *      u32                             pid, tid;
 399          *
 400          *      struct read_format              values;
 401          * };
 402          */
 403         PERF_RECORD_READ                        = 8,
 404
 405         /*
 406          * struct {
 407          *      struct perf_event_header        header;
 408          *
 409          *      { u64                   ip;       } && PERF_SAMPLE_IP
 410          *      { u32                   pid, tid; } && PERF_SAMPLE_TID
 411          *      { u64                   time;     } && PERF_SAMPLE_TIME
 412          *      { u64                   addr;     } && PERF_SAMPLE_ADDR
 413          *      { u64                   id;       } && PERF_SAMPLE_ID
 414          *      { u64                   stream_id;} && PERF_SAMPLE_STREAM_ID
 415          *      { u32                   cpu, res; } && PERF_SAMPLE_CPU
 416          *      { u64                   period;   } && PERF_SAMPLE_PERIOD
 417          *
 418          *      { struct read_format    values;   } && PERF_SAMPLE_READ
 419          *
 420          *      { u64                   nr,
 421          *        u64                   ips[nr];  } && PERF_SAMPLE_CALLCHAIN
 422          *
 423          *      #
 424          *      # The RAW record below is opaque data wrt the ABI
 425          *      #
 426          *      # That is, the ABI doesn't make any promises wrt to
 427          *      # the stability of its content, it may vary depending
 428          *      # on event, hardware, kernel version and phase of
 429          *      # the moon.
 430          *      #
 431          *      # In other words, PERF_SAMPLE_RAW contents are not an ABI.
 432          *      #
 433          *
 434          *      { u32                   size;
 435          *        char                  data[size];}&& PERF_SAMPLE_RAW
 436          * };
 437          */
 438         PERF_RECORD_SAMPLE                      = 9,
 439
 440         PERF_RECORD_MAX,                        /* non-ABI */
 441 };
 442
 443 enum perf_callchain_context {
 444         PERF_CONTEXT_HV                 = (__u64)-32,
 445         PERF_CONTEXT_KERNEL             = (__u64)-128,
 446         PERF_CONTEXT_USER               = (__u64)-512,
 447
 448         PERF_CONTEXT_GUEST              = (__u64)-2048,
 449         PERF_CONTEXT_GUEST_KERNEL       = (__u64)-2176,
 450         PERF_CONTEXT_GUEST_USER         = (__u64)-2560,
 451
 452         PERF_CONTEXT_MAX                = (__u64)-4095,
 453 };
 454
 455 #define PERF_FLAG_FD_NO_GROUP   (1U << 0)
 456 #define PERF_FLAG_FD_OUTPUT     (1U << 1)
 457
 458 #ifdef __KERNEL__
 459 /*
 460  * Kernel-internal data types and definitions:
 461  */
 462
 463 #ifdef CONFIG_PERF_EVENTS
 464 # include <asm/perf_event.h>
 465 #endif
 466
 467 struct perf_guest_info_callbacks {
 468         int (*is_in_guest) (void);
 469         int (*is_user_mode) (void);
 470         unsigned long (*get_guest_ip) (void);
 471 };
 472
 473 #ifdef CONFIG_HAVE_HW_BREAKPOINT
 474 #include <asm/hw_breakpoint.h>
 475 #endif
 476
 477 #include <linux/list.h>
 478 #include <linux/mutex.h>
 479 #include <linux/rculist.h>
 480 #include <linux/rcupdate.h>
 481 #include <linux/spinlock.h>
 482 #include <linux/hrtimer.h>
 483 #include <linux/fs.h>
 484 #include <linux/pid_namespace.h>
 485 #include <linux/workqueue.h>
 486 #include <linux/ftrace.h>
 487 #include <linux/cpu.h>
 488 #include <asm/atomic.h>
 489 #include <asm/local.h>
 490
 491 #define PERF_MAX_STACK_DEPTH            255
 492
 493 struct perf_callchain_entry {
 494         __u64                           nr;
 495         __u64                           ip[PERF_MAX_STACK_DEPTH];
 496 };
 497
 498 struct perf_raw_record {
 499         u32                             size;
 500         void                            *data;
 501 };
 502
 503 struct perf_branch_entry {
 504         __u64                           from;
 505         __u64                           to;
 506         __u64                           flags;
 507 };
 508
 509 struct perf_branch_stack {
 510         __u64                           nr;
 511         struct perf_branch_entry        entries[0];
 512 };
 513
 514 struct task_struct;
 515
 516 /**
 517  * struct hw_perf_event - performance event hardware details:
 518  */
 519 struct hw_perf_event {
 520 #ifdef CONFIG_PERF_EVENTS
 521         union {
 522                 struct { /* hardware */
 523                         u64             config;
 524                         u64             last_tag;
 525                         unsigned long   config_base;
 526                         unsigned long   event_base;
 527                         int             idx;
 528                         int             last_cpu;
 529                 };
 530                 struct { /* software */
 531                         s64             remaining;
 532                         struct hrtimer  hrtimer;
 533                 };
 534 #ifdef CONFIG_HAVE_HW_BREAKPOINT
 535                 /* breakpoint */
 536                 struct arch_hw_breakpoint       info;
 537 #endif
 538         };
 539         atomic64_t                      prev_count;
 540         u64                             sample_period;
 541         u64                             last_period;
 542         atomic64_t                      period_left;
 543         u64                             interrupts;
 544
 545         u64                             freq_time_stamp;
 546         u64                             freq_count_stamp;
 547 #endif
 548 };
 549
 550 struct perf_event;
 551
 552 /*
 553  * Common implementation detail of pmu::{start,commit,cancel}_txn
 554  */
 555 #define PERF_EVENT_TXN 0x1
 556
 557 /**
 558  * struct pmu - generic performance monitoring unit
 559  */
 560 struct pmu {
 561         int (*enable)                   (struct perf_event *event);
 562         void (*disable)                 (struct perf_event *event);
 563         int (*start)                    (struct perf_event *event);
 564         void (*stop)                    (struct perf_event *event);
 565         void (*read)                    (struct perf_event *event);
 566         void (*unthrottle)              (struct perf_event *event);
 567
 568         /*
 569          * Group events scheduling is treated as a transaction, add group
 570          * events as a whole and perform one schedulability test. If the test
 571          * fails, roll back the whole group
 572          */
 573
 574         /*
 575          * Start the transaction, after this ->enable() doesn't need
 576          * to do schedulability tests.
 577          */
 578         void (*start_txn)       (const struct pmu *pmu);
 579         /*
 580          * If ->start_txn() disabled the ->enable() schedulability test
 581          * then ->commit_txn() is required to perform one. On success
 582          * the transaction is closed. On error the transaction is kept
 583          * open until ->cancel_txn() is called.
 584          */
 585         int  (*commit_txn)      (const struct pmu *pmu);
 586         /*
 587          * Will cancel the transaction, assumes ->disable() is called for
 588          * each successfull ->enable() during the transaction.
 589          */
 590         void (*cancel_txn)      (const struct pmu *pmu);
 591 };
 592
 593 /**
 594  * enum perf_event_active_state - the states of a event
 595  */
 596 enum perf_event_active_state {
 597         PERF_EVENT_STATE_ERROR          = -2,
 598         PERF_EVENT_STATE_OFF            = -1,
 599         PERF_EVENT_STATE_INACTIVE       =  0,
 600         PERF_EVENT_STATE_ACTIVE         =  1,
 601 };
 602
 603 struct file;
 604
 605 struct perf_mmap_data {
 606         atomic_t                        refcount;
 607         struct rcu_head                 rcu_head;
 608 #ifdef CONFIG_PERF_USE_VMALLOC
 609         struct work_struct              work;
 610         int                             page_order;     /* allocation order  */
 611 #endif
 612         int                             nr_pages;       /* nr of data pages  */
 613         int                             writable;       /* are we writable   */
 614
 615         atomic_t                        poll;           /* POLL_ for wakeups */
 616
 617         local_t                         head;           /* write position    */
 618         local_t                         nest;           /* nested writers    */
 619         local_t                         events;         /* event limit       */
 620         local_t                         wakeup;         /* wakeup stamp      */
 621         local_t                         lost;           /* nr records lost   */
 622
 623         long                            watermark;      /* wakeup watermark  */
 624
 625         struct perf_event_mmap_page     *user_page;
 626         void                            *data_pages[0];
 627 };
 628
 629 struct perf_pending_entry {
 630         struct perf_pending_entry *next;
 631         void (*func)(struct perf_pending_entry *);
 632 };
 633
 634 struct perf_sample_data;
 635
 636 typedef void (*perf_overflow_handler_t)(struct perf_event *, int,
 637                                         struct perf_sample_data *,
 638                                         struct pt_regs *regs);
 639
 640 enum perf_group_flag {
 641         PERF_GROUP_SOFTWARE = 0x1,
 642 };
 643
 644 #define SWEVENT_HLIST_BITS      8
 645 #define SWEVENT_HLIST_SIZE      (1 << SWEVENT_HLIST_BITS)
 646
 647 struct swevent_hlist {
 648         struct hlist_head       heads[SWEVENT_HLIST_SIZE];
 649         struct rcu_head         rcu_head;
 650 };
 651
 652 #define PERF_ATTACH_CONTEXT     0x01
 653 #define PERF_ATTACH_GROUP       0x02
 654
 655 /**
 656  * struct perf_event - performance event kernel representation:
 657  */
 658 struct perf_event {
 659 #ifdef CONFIG_PERF_EVENTS
 660         struct list_head                group_entry;
 661         struct list_head                event_entry;
 662         struct list_head                sibling_list;
 663         struct hlist_node               hlist_entry;
 664         int                             nr_siblings;
 665         int                             group_flags;
 666         struct perf_event               *group_leader;
 667         const struct pmu                *pmu;
 668
 669         enum perf_event_active_state    state;
 670         unsigned int                    attach_state;
 671         atomic64_t                      count;
 672
 673         /*
 674          * These are the total time in nanoseconds that the event
 675          * has been enabled (i.e. eligible to run, and the task has
 676          * been scheduled in, if this is a per-task event)
 677          * and running (scheduled onto the CPU), respectively.
 678          *
 679          * They are computed from tstamp_enabled, tstamp_running and
 680          * tstamp_stopped when the event is in INACTIVE or ACTIVE state.
 681          */
 682         u64                             total_time_enabled;
 683         u64                             total_time_running;
 684
 685         /*
 686          * These are timestamps used for computing total_time_enabled
 687          * and total_time_running when the event is in INACTIVE or
 688          * ACTIVE state, measured in nanoseconds from an arbitrary point
 689          * in time.
 690          * tstamp_enabled: the notional time when the event was enabled
 691          * tstamp_running: the notional time when the event was scheduled on
 692          * tstamp_stopped: in INACTIVE state, the notional time when the
 693          *      event was scheduled off.
 694          */
 695         u64                             tstamp_enabled;
 696         u64                             tstamp_running;
 697         u64                             tstamp_stopped;
 698
 699         struct perf_event_attr          attr;
 700         struct hw_perf_event            hw;
 701
 702         struct perf_event_context       *ctx;
 703         struct file                     *filp;
 704
 705         /*
 706          * These accumulate total time (in nanoseconds) that children
 707          * events have been enabled and running, respectively.
 708          */
 709         atomic64_t                      child_total_time_enabled;
 710         atomic64_t                      child_total_time_running;
 711
 712         /*
 713          * Protect attach/detach and child_list:
 714          */
 715         struct mutex                    child_mutex;
 716         struct list_head                child_list;
 717         struct perf_event               *parent;
 718
 719         int                             oncpu;
 720         int                             cpu;
 721
 722         struct list_head                owner_entry;
 723         struct task_struct              *owner;
 724
 725         /* mmap bits */
 726         struct mutex                    mmap_mutex;
 727         atomic_t                        mmap_count;
 728         int                             mmap_locked;
 729         struct user_struct              *mmap_user;
 730         struct perf_mmap_data           *data;
 731
 732         /* poll related */
 733         wait_queue_head_t               waitq;
 734         struct fasync_struct            *fasync;
 735
 736         /* delayed work for NMIs and such */
 737         int                             pending_wakeup;
 738         int                             pending_kill;
 739         int                             pending_disable;
 740         struct perf_pending_entry       pending;
 741
 742         atomic_t                        event_limit;
 743
 744         void (*destroy)(struct perf_event *);
 745         struct rcu_head                 rcu_head;
 746
 747         struct pid_namespace            *ns;
 748         u64                             id;
 749
 750         perf_overflow_handler_t         overflow_handler;
 751
 752 #ifdef CONFIG_EVENT_TRACING
 753         struct ftrace_event_call        *tp_event;
 754         struct event_filter             *filter;
 755 #endif
 756
 757 #endif /* CONFIG_PERF_EVENTS */
 758 };
 759
 760 /**
 761  * struct perf_event_context - event context structure
 762  *
 763  * Used as a container for task events and CPU events as well:
 764  */
 765 struct perf_event_context {
 766         /*
 767          * Protect the states of the events in the list,
 768          * nr_active, and the list:
 769          */
 770         raw_spinlock_t                  lock;
 771         /*
 772          * Protect the list of events.  Locking either mutex or lock
 773          * is sufficient to ensure the list doesn't change; to change
 774          * the list you need to lock both the mutex and the spinlock.
 775          */
 776         struct mutex                    mutex;
 777
 778         struct list_head                pinned_groups;
 779         struct list_head                flexible_groups;
 780         struct list_head                event_list;
 781         int                             nr_events;
 782         int                             nr_active;
 783         int                             is_active;
 784         int                             nr_stat;
 785         atomic_t                        refcount;
 786         struct task_struct              *task;
 787
 788         /*
 789          * Context clock, runs when context enabled.
 790          */
 791         u64                             time;
 792         u64                             timestamp;
 793
 794         /*
 795          * These fields let us detect when two contexts have both
 796          * been cloned (inherited) from a common ancestor.
 797          */
 798         struct perf_event_context       *parent_ctx;
 799         u64                             parent_gen;
 800         u64                             generation;
 801         int                             pin_count;
 802         struct rcu_head                 rcu_head;
 803 };
 804
 805 /**
 806  * struct perf_event_cpu_context - per cpu event context structure
 807  */
 808 struct perf_cpu_context {
 809         struct perf_event_context       ctx;
 810         struct perf_event_context       *task_ctx;
 811         int                             active_oncpu;
 812         int                             max_pertask;
 813         int                             exclusive;
 814         struct swevent_hlist            *swevent_hlist;
 815         struct mutex                    hlist_mutex;
 816         int                             hlist_refcount;
 817
 818         /*
 819          * Recursion avoidance:
 820          *
 821          * task, softirq, irq, nmi context
 822          */
 823         int                             recursion[4];
 824 };
 825
 826 struct perf_output_handle {
 827         struct perf_event               *event;
 828         struct perf_mmap_data           *data;
 829         unsigned long                   wakeup;
 830         unsigned long                   size;
 831         void                            *addr;
 832         int                             page;
 833         int                             nmi;
 834         int                             sample;
 835 };
 836
 837 #ifdef CONFIG_PERF_EVENTS
 838
 839 /*
 840  * Set by architecture code:
 841  */
 842 extern int perf_max_events;
 843
 844 extern const struct pmu *hw_perf_event_init(struct perf_event *event);
 845
 846 extern void perf_event_task_sched_in(struct task_struct *task);
 847 extern void perf_event_task_sched_out(struct task_struct *task, struct task_struct *next);
 848 extern void perf_event_task_tick(struct task_struct *task);
 849 extern int perf_event_init_task(struct task_struct *child);
 850 extern void perf_event_exit_task(struct task_struct *child);
 851 extern void perf_event_free_task(struct task_struct *task);
 852 extern void set_perf_event_pending(void);
 853 extern void perf_event_do_pending(void);
 854 extern void perf_event_print_debug(void);
 855 extern void __perf_disable(void);
 856 extern bool __perf_enable(void);
 857 extern void perf_disable(void);
 858 extern void perf_enable(void);
 859 extern int perf_event_task_disable(void);
 860 extern int perf_event_task_enable(void);
 861 extern void perf_event_update_userpage(struct perf_event *event);
 862 extern int perf_event_release_kernel(struct perf_event *event);
 863 extern struct perf_event *
 864 perf_event_create_kernel_counter(struct perf_event_attr *attr,
 865                                 int cpu,
 866                                 pid_t pid,
 867                                 perf_overflow_handler_t callback);
 868 extern u64 perf_event_read_value(struct perf_event *event,
 869                                  u64 *enabled, u64 *running);
 870
 871 struct perf_sample_data {
 872         u64                             type;
 873
 874         u64                             ip;
 875         struct {
 876                 u32     pid;
 877                 u32     tid;
 878         }                               tid_entry;
 879         u64                             time;
 880         u64                             addr;
 881         u64                             id;
 882         u64                             stream_id;
 883         struct {
 884                 u32     cpu;
 885                 u32     reserved;
 886         }                               cpu_entry;
 887         u64                             period;
 888         struct perf_callchain_entry     *callchain;
 889         struct perf_raw_record          *raw;
 890 };
 891
 892 static inline
 893 void perf_sample_data_init(struct perf_sample_data *data, u64 addr)
 894 {
 895         data->addr = addr;
 896         data->raw  = NULL;
 897 }
 898
 899 extern void perf_output_sample(struct perf_output_handle *handle,
 900                                struct perf_event_header *header,
 901                                struct perf_sample_data *data,
 902                                struct perf_event *event);
 903 extern void perf_prepare_sample(struct perf_event_header *header,
 904                                 struct perf_sample_data *data,
 905                                 struct perf_event *event,
 906                                 struct pt_regs *regs);
 907
 908 extern int perf_event_overflow(struct perf_event *event, int nmi,
 909                                  struct perf_sample_data *data,
 910                                  struct pt_regs *regs);
 911
 912 /*
 913  * Return 1 for a software event, 0 for a hardware event
 914  */
 915 static inline int is_software_event(struct perf_event *event)
 916 {
 917         switch (event->attr.type) {
 918         case PERF_TYPE_SOFTWARE:
 919         case PERF_TYPE_TRACEPOINT:
 920         /* for now the breakpoint stuff also works as software event */
 921         case PERF_TYPE_BREAKPOINT:
 922                 return 1;
 923         }
 924         return 0;
 925 }
 926
 927 extern atomic_t perf_swevent_enabled[PERF_COUNT_SW_MAX];
 928
 929 extern void __perf_sw_event(u32, u64, int, struct pt_regs *, u64);
 930
 931 extern void
 932 perf_arch_fetch_caller_regs(struct pt_regs *regs, unsigned long ip, int skip);
 933
 934 /*
 935  * Take a snapshot of the regs. Skip ip and frame pointer to
 936  * the nth caller. We only need a few of the regs:
 937  * - ip for PERF_SAMPLE_IP
 938  * - cs for user_mode() tests
 939  * - bp for callchains
 940  * - eflags, for future purposes, just in case
 941  */
 942 static inline void perf_fetch_caller_regs(struct pt_regs *regs, int skip)
 943 {
 944         unsigned long ip;
 945
 946         memset(regs, 0, sizeof(*regs));
 947
 948         switch (skip) {
 949         case 1 :
 950                 ip = CALLER_ADDR0;
 951                 break;
 952         case 2 :
 953                 ip = CALLER_ADDR1;
 954                 break;
 955         case 3 :
 956                 ip = CALLER_ADDR2;
 957                 break;
 958         case 4:
 959                 ip = CALLER_ADDR3;
 960                 break;
 961         /* No need to support further for now */
 962         default:
 963                 ip = 0;
 964         }
 965
 966         return perf_arch_fetch_caller_regs(regs, ip, skip);
 967 }
 968
 969 static inline void
 970 perf_sw_event(u32 event_id, u64 nr, int nmi, struct pt_regs *regs, u64 addr)
 971 {
 972         if (atomic_read(&perf_swevent_enabled[event_id])) {
 973                 struct pt_regs hot_regs;
 974
 975                 if (!regs) {
 976                         perf_fetch_caller_regs(&hot_regs, 1);
 977                         regs = &hot_regs;
 978                 }
 979                 __perf_sw_event(event_id, nr, nmi, regs, addr);
 980         }
 981 }
 982
 983 extern void perf_event_mmap(struct vm_area_struct *vma);
 984 extern struct perf_guest_info_callbacks *perf_guest_cbs;
 985 extern int perf_register_guest_info_callbacks(struct perf_guest_info_callbacks *callbacks);
 986 extern int perf_unregister_guest_info_callbacks(struct perf_guest_info_callbacks *callbacks);
 987
 988 extern void perf_event_comm(struct task_struct *tsk);
 989 extern void perf_event_fork(struct task_struct *tsk);
 990
 991 extern struct perf_callchain_entry *perf_callchain(struct pt_regs *regs);
 992
 993 extern int sysctl_perf_event_paranoid;
 994 extern int sysctl_perf_event_mlock;
 995 extern int sysctl_perf_event_sample_rate;
 996
 997 static inline bool perf_paranoid_tracepoint_raw(void)
 998 {
 999         return sysctl_perf_event_paranoid > -1;
1000 }
1001
1002 static inline bool perf_paranoid_cpu(void)
1003 {
1004         return sysctl_perf_event_paranoid > 0;
1005 }
1006
1007 static inline bool perf_paranoid_kernel(void)
1008 {
1009         return sysctl_perf_event_paranoid > 1;
1010 }
1011
1012 extern void perf_event_init(void);
1013 extern void perf_tp_event(u64 addr, u64 count, void *record,
1014                           int entry_size, struct pt_regs *regs,
1015                           struct hlist_head *head, int rctx);
1016 extern void perf_bp_event(struct perf_event *event, void *data);
1017
1018 #ifndef perf_misc_flags
1019 #define perf_misc_flags(regs)   (user_mode(regs) ? PERF_RECORD_MISC_USER : \
1020                                  PERF_RECORD_MISC_KERNEL)
1021 #define perf_instruction_pointer(regs)  instruction_pointer(regs)
1022 #endif
1023
1024 extern int perf_output_begin(struct perf_output_handle *handle,
1025                              struct perf_event *event, unsigned int size,
1026                              int nmi, int sample);
1027 extern void perf_output_end(struct perf_output_handle *handle);
1028 extern void perf_output_copy(struct perf_output_handle *handle,
1029                              const void *buf, unsigned int len);
1030 extern int perf_swevent_get_recursion_context(void);
1031 extern void perf_swevent_put_recursion_context(int rctx);
1032 extern void perf_event_enable(struct perf_event *event);
1033 extern void perf_event_disable(struct perf_event *event);
1034 #else
1035 static inline void
1036 perf_event_task_sched_in(struct task_struct *task)                      { }
1037 static inline void
1038 perf_event_task_sched_out(struct task_struct *task,
1039                             struct task_struct *next)                   { }
1040 static inline void
1041 perf_event_task_tick(struct task_struct *task)                          { }
1042 static inline int perf_event_init_task(struct task_struct *child)       { return 0; }
1043 static inline void perf_event_exit_task(struct task_struct *child)      { }
1044 static inline void perf_event_free_task(struct task_struct *task)       { }
1045 static inline void perf_event_do_pending(void)                          { }
1046 static inline void perf_event_print_debug(void)                         { }
1047 static inline void perf_disable(void)                                   { }
1048 static inline void perf_enable(void)                                    { }
1049 static inline int perf_event_task_disable(void)                         { return -EINVAL; }
1050 static inline int perf_event_task_enable(void)                          { return -EINVAL; }
1051
1052 static inline void
1053 perf_sw_event(u32 event_id, u64 nr, int nmi,
1054                      struct pt_regs *regs, u64 addr)                    { }
1055 static inline void
1056 perf_bp_event(struct perf_event *event, void *data)                     { }
1057
1058 static inline int perf_register_guest_info_callbacks
1059 (struct perf_guest_info_callbacks *callbacks) { return 0; }
1060 static inline int perf_unregister_guest_info_callbacks
1061 (struct perf_guest_info_callbacks *callbacks) { return 0; }
1062
1063 static inline void perf_event_mmap(struct vm_area_struct *vma)          { }
1064 static inline void perf_event_comm(struct task_struct *tsk)             { }
1065 static inline void perf_event_fork(struct task_struct *tsk)             { }
1066 static inline void perf_event_init(void)                                { }
1067 static inline int  perf_swevent_get_recursion_context(void)             { return -1; }
1068 static inline void perf_swevent_put_recursion_context(int rctx)         { }
1069 static inline void perf_event_enable(struct perf_event *event)          { }
1070 static inline void perf_event_disable(struct perf_event *event)         { }
1071 #endif
1072
1073 #define perf_output_put(handle, x) \
1074         perf_output_copy((handle), &(x), sizeof(x))
1075
1076 /*
1077  * This has to have a higher priority than migration_notifier in sched.c.
1078  */
1079 #define perf_cpu_notifier(fn)                                   \
1080 do {                                                            \
1081         static struct notifier_block fn##_nb __cpuinitdata =    \
1082                 { .notifier_call = fn, .priority = 20 };        \
1083         fn(&fn##_nb, (unsigned long)CPU_UP_PREPARE,             \
1084                 (void *)(unsigned long)smp_processor_id());     \
1085         fn(&fn##_nb, (unsigned long)CPU_STARTING,               \
1086                 (void *)(unsigned long)smp_processor_id());     \
1087         fn(&fn##_nb, (unsigned long)CPU_ONLINE,                 \
1088                 (void *)(unsigned long)smp_processor_id());     \
1089         register_cpu_notifier(&fn##_nb);                        \
1090 } while (0)
1091
1092 #endif /* __KERNEL__ */
1093 #endif /* _LINUX_PERF_EVENT_H */