5311b79fe62cc2d684425e27447f7722592bdb38
[~shefty/rdma-dev.git] / include / 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 _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         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
133         PERF_SAMPLE_MAX = 1U << 11,             /* non-ABI */
134 };
135
136 /*
137  * The format of the data returned by read() on a perf event fd,
138  * as specified by attr.read_format:
139  *
140  * struct read_format {
141  *      { u64           value;
142  *        { u64         time_enabled; } && PERF_FORMAT_TOTAL_TIME_ENABLED
143  *        { u64         time_running; } && PERF_FORMAT_TOTAL_TIME_RUNNING
144  *        { u64         id;           } && PERF_FORMAT_ID
145  *      } && !PERF_FORMAT_GROUP
146  *
147  *      { u64           nr;
148  *        { u64         time_enabled; } && PERF_FORMAT_TOTAL_TIME_ENABLED
149  *        { u64         time_running; } && PERF_FORMAT_TOTAL_TIME_RUNNING
150  *        { u64         value;
151  *          { u64       id;           } && PERF_FORMAT_ID
152  *        }             cntr[nr];
153  *      } && PERF_FORMAT_GROUP
154  * };
155  */
156 enum perf_event_read_format {
157         PERF_FORMAT_TOTAL_TIME_ENABLED          = 1U << 0,
158         PERF_FORMAT_TOTAL_TIME_RUNNING          = 1U << 1,
159         PERF_FORMAT_ID                          = 1U << 2,
160         PERF_FORMAT_GROUP                       = 1U << 3,
161
162         PERF_FORMAT_MAX = 1U << 4,              /* non-ABI */
163 };
164
165 #define PERF_ATTR_SIZE_VER0     64      /* sizeof first published struct */
166
167 /*
168  * Hardware event_id to monitor via a performance monitoring event:
169  */
170 struct perf_event_attr {
171
172         /*
173          * Major type: hardware/software/tracepoint/etc.
174          */
175         __u32                   type;
176
177         /*
178          * Size of the attr structure, for fwd/bwd compat.
179          */
180         __u32                   size;
181
182         /*
183          * Type specific configuration information.
184          */
185         __u64                   config;
186
187         union {
188                 __u64           sample_period;
189                 __u64           sample_freq;
190         };
191
192         __u64                   sample_type;
193         __u64                   read_format;
194
195         __u64                   disabled       :  1, /* off by default        */
196                                 inherit        :  1, /* children inherit it   */
197                                 pinned         :  1, /* must always be on PMU */
198                                 exclusive      :  1, /* only group on PMU     */
199                                 exclude_user   :  1, /* don't count user      */
200                                 exclude_kernel :  1, /* ditto kernel          */
201                                 exclude_hv     :  1, /* ditto hypervisor      */
202                                 exclude_idle   :  1, /* don't count when idle */
203                                 mmap           :  1, /* include mmap data     */
204                                 comm           :  1, /* include comm data     */
205                                 freq           :  1, /* use freq, not period  */
206                                 inherit_stat   :  1, /* per task counts       */
207                                 enable_on_exec :  1, /* next exec enables     */
208                                 task           :  1, /* trace fork/exit       */
209                                 watermark      :  1, /* wakeup_watermark      */
210                                 /*
211                                  * precise_ip:
212                                  *
213                                  *  0 - SAMPLE_IP can have arbitrary skid
214                                  *  1 - SAMPLE_IP must have constant skid
215                                  *  2 - SAMPLE_IP requested to have 0 skid
216                                  *  3 - SAMPLE_IP must have 0 skid
217                                  *
218                                  *  See also PERF_RECORD_MISC_EXACT_IP
219                                  */
220                                 precise_ip     :  2, /* skid constraint       */
221                                 mmap_data      :  1, /* non-exec mmap data    */
222                                 sample_id_all  :  1, /* sample_type all events */
223
224                                 exclude_host   :  1, /* don't count in host   */
225                                 exclude_guest  :  1, /* don't count in guest  */
226
227                                 __reserved_1   : 43;
228
229         union {
230                 __u32           wakeup_events;    /* wakeup every n events */
231                 __u32           wakeup_watermark; /* bytes before wakeup   */
232         };
233
234         __u32                   bp_type;
235         union {
236                 __u64           bp_addr;
237                 __u64           config1; /* extension of config */
238         };
239         union {
240                 __u64           bp_len;
241                 __u64           config2; /* extension of config1 */
242         };
243 };
244
245 /*
246  * Ioctls that can be done on a perf event fd:
247  */
248 #define PERF_EVENT_IOC_ENABLE           _IO ('$', 0)
249 #define PERF_EVENT_IOC_DISABLE          _IO ('$', 1)
250 #define PERF_EVENT_IOC_REFRESH          _IO ('$', 2)
251 #define PERF_EVENT_IOC_RESET            _IO ('$', 3)
252 #define PERF_EVENT_IOC_PERIOD           _IOW('$', 4, __u64)
253 #define PERF_EVENT_IOC_SET_OUTPUT       _IO ('$', 5)
254 #define PERF_EVENT_IOC_SET_FILTER       _IOW('$', 6, char *)
255
256 enum perf_event_ioc_flags {
257         PERF_IOC_FLAG_GROUP             = 1U << 0,
258 };
259
260 /*
261  * Structure of the page that can be mapped via mmap
262  */
263 struct perf_event_mmap_page {
264         __u32   version;                /* version number of this structure */
265         __u32   compat_version;         /* lowest version this is compat with */
266
267         /*
268          * Bits needed to read the hw events in user-space.
269          *
270          *   u32 seq;
271          *   s64 count;
272          *
273          *   do {
274          *     seq = pc->lock;
275          *
276          *     barrier()
277          *     if (pc->index) {
278          *       count = pmc_read(pc->index - 1);
279          *       count += pc->offset;
280          *     } else
281          *       goto regular_read;
282          *
283          *     barrier();
284          *   } while (pc->lock != seq);
285          *
286          * NOTE: for obvious reason this only works on self-monitoring
287          *       processes.
288          */
289         __u32   lock;                   /* seqlock for synchronization */
290         __u32   index;                  /* hardware event identifier */
291         __s64   offset;                 /* add to hardware event value */
292         __u64   time_enabled;           /* time event active */
293         __u64   time_running;           /* time event on cpu */
294
295                 /*
296                  * Hole for extension of the self monitor capabilities
297                  */
298
299         __u64   __reserved[123];        /* align to 1k */
300
301         /*
302          * Control data for the mmap() data buffer.
303          *
304          * User-space reading the @data_head value should issue an rmb(), on
305          * SMP capable platforms, after reading this value -- see
306          * perf_event_wakeup().
307          *
308          * When the mapping is PROT_WRITE the @data_tail value should be
309          * written by userspace to reflect the last read data. In this case
310          * the kernel will not over-write unread data.
311          */
312         __u64   data_head;              /* head in the data section */
313         __u64   data_tail;              /* user-space written tail */
314 };
315
316 #define PERF_RECORD_MISC_CPUMODE_MASK           (7 << 0)
317 #define PERF_RECORD_MISC_CPUMODE_UNKNOWN        (0 << 0)
318 #define PERF_RECORD_MISC_KERNEL                 (1 << 0)
319 #define PERF_RECORD_MISC_USER                   (2 << 0)
320 #define PERF_RECORD_MISC_HYPERVISOR             (3 << 0)
321 #define PERF_RECORD_MISC_GUEST_KERNEL           (4 << 0)
322 #define PERF_RECORD_MISC_GUEST_USER             (5 << 0)
323
324 /*
325  * Indicates that the content of PERF_SAMPLE_IP points to
326  * the actual instruction that triggered the event. See also
327  * perf_event_attr::precise_ip.
328  */
329 #define PERF_RECORD_MISC_EXACT_IP               (1 << 14)
330 /*
331  * Reserve the last bit to indicate some extended misc field
332  */
333 #define PERF_RECORD_MISC_EXT_RESERVED           (1 << 15)
334
335 struct perf_event_header {
336         __u32   type;
337         __u16   misc;
338         __u16   size;
339 };
340
341 enum perf_event_type {
342
343         /*
344          * If perf_event_attr.sample_id_all is set then all event types will
345          * have the sample_type selected fields related to where/when
346          * (identity) an event took place (TID, TIME, ID, CPU, STREAM_ID)
347          * described in PERF_RECORD_SAMPLE below, it will be stashed just after
348          * the perf_event_header and the fields already present for the existing
349          * fields, i.e. at the end of the payload. That way a newer perf.data
350          * file will be supported by older perf tools, with these new optional
351          * fields being ignored.
352          *
353          * The MMAP events record the PROT_EXEC mappings so that we can
354          * correlate userspace IPs to code. They have the following structure:
355          *
356          * struct {
357          *      struct perf_event_header        header;
358          *
359          *      u32                             pid, tid;
360          *      u64                             addr;
361          *      u64                             len;
362          *      u64                             pgoff;
363          *      char                            filename[];
364          * };
365          */
366         PERF_RECORD_MMAP                        = 1,
367
368         /*
369          * struct {
370          *      struct perf_event_header        header;
371          *      u64                             id;
372          *      u64                             lost;
373          * };
374          */
375         PERF_RECORD_LOST                        = 2,
376
377         /*
378          * struct {
379          *      struct perf_event_header        header;
380          *
381          *      u32                             pid, tid;
382          *      char                            comm[];
383          * };
384          */
385         PERF_RECORD_COMM                        = 3,
386
387         /*
388          * struct {
389          *      struct perf_event_header        header;
390          *      u32                             pid, ppid;
391          *      u32                             tid, ptid;
392          *      u64                             time;
393          * };
394          */
395         PERF_RECORD_EXIT                        = 4,
396
397         /*
398          * struct {
399          *      struct perf_event_header        header;
400          *      u64                             time;
401          *      u64                             id;
402          *      u64                             stream_id;
403          * };
404          */
405         PERF_RECORD_THROTTLE                    = 5,
406         PERF_RECORD_UNTHROTTLE                  = 6,
407
408         /*
409          * struct {
410          *      struct perf_event_header        header;
411          *      u32                             pid, ppid;
412          *      u32                             tid, ptid;
413          *      u64                             time;
414          * };
415          */
416         PERF_RECORD_FORK                        = 7,
417
418         /*
419          * struct {
420          *      struct perf_event_header        header;
421          *      u32                             pid, tid;
422          *
423          *      struct read_format              values;
424          * };
425          */
426         PERF_RECORD_READ                        = 8,
427
428         /*
429          * struct {
430          *      struct perf_event_header        header;
431          *
432          *      { u64                   ip;       } && PERF_SAMPLE_IP
433          *      { u32                   pid, tid; } && PERF_SAMPLE_TID
434          *      { u64                   time;     } && PERF_SAMPLE_TIME
435          *      { u64                   addr;     } && PERF_SAMPLE_ADDR
436          *      { u64                   id;       } && PERF_SAMPLE_ID
437          *      { u64                   stream_id;} && PERF_SAMPLE_STREAM_ID
438          *      { u32                   cpu, res; } && PERF_SAMPLE_CPU
439          *      { u64                   period;   } && PERF_SAMPLE_PERIOD
440          *
441          *      { struct read_format    values;   } && PERF_SAMPLE_READ
442          *
443          *      { u64                   nr,
444          *        u64                   ips[nr];  } && PERF_SAMPLE_CALLCHAIN
445          *
446          *      #
447          *      # The RAW record below is opaque data wrt the ABI
448          *      #
449          *      # That is, the ABI doesn't make any promises wrt to
450          *      # the stability of its content, it may vary depending
451          *      # on event, hardware, kernel version and phase of
452          *      # the moon.
453          *      #
454          *      # In other words, PERF_SAMPLE_RAW contents are not an ABI.
455          *      #
456          *
457          *      { u32                   size;
458          *        char                  data[size];}&& PERF_SAMPLE_RAW
459          * };
460          */
461         PERF_RECORD_SAMPLE                      = 9,
462
463         PERF_RECORD_MAX,                        /* non-ABI */
464 };
465
466 enum perf_callchain_context {
467         PERF_CONTEXT_HV                 = (__u64)-32,
468         PERF_CONTEXT_KERNEL             = (__u64)-128,
469         PERF_CONTEXT_USER               = (__u64)-512,
470
471         PERF_CONTEXT_GUEST              = (__u64)-2048,
472         PERF_CONTEXT_GUEST_KERNEL       = (__u64)-2176,
473         PERF_CONTEXT_GUEST_USER         = (__u64)-2560,
474
475         PERF_CONTEXT_MAX                = (__u64)-4095,
476 };
477
478 #define PERF_FLAG_FD_NO_GROUP           (1U << 0)
479 #define PERF_FLAG_FD_OUTPUT             (1U << 1)
480 #define PERF_FLAG_PID_CGROUP            (1U << 2) /* pid=cgroup id, per-cpu mode only */
481
482 #ifdef __KERNEL__
483 /*
484  * Kernel-internal data types and definitions:
485  */
486
487 #ifdef CONFIG_PERF_EVENTS
488 # include <linux/cgroup.h>
489 # include <asm/perf_event.h>
490 # include <asm/local64.h>
491 #endif
492
493 struct perf_guest_info_callbacks {
494         int                             (*is_in_guest)(void);
495         int                             (*is_user_mode)(void);
496         unsigned long                   (*get_guest_ip)(void);
497 };
498
499 #ifdef CONFIG_HAVE_HW_BREAKPOINT
500 #include <asm/hw_breakpoint.h>
501 #endif
502
503 #include <linux/list.h>
504 #include <linux/mutex.h>
505 #include <linux/rculist.h>
506 #include <linux/rcupdate.h>
507 #include <linux/spinlock.h>
508 #include <linux/hrtimer.h>
509 #include <linux/fs.h>
510 #include <linux/pid_namespace.h>
511 #include <linux/workqueue.h>
512 #include <linux/ftrace.h>
513 #include <linux/cpu.h>
514 #include <linux/irq_work.h>
515 #include <linux/jump_label.h>
516 #include <linux/atomic.h>
517 #include <asm/local.h>
518
519 #define PERF_MAX_STACK_DEPTH            255
520
521 struct perf_callchain_entry {
522         __u64                           nr;
523         __u64                           ip[PERF_MAX_STACK_DEPTH];
524 };
525
526 struct perf_raw_record {
527         u32                             size;
528         void                            *data;
529 };
530
531 struct perf_branch_entry {
532         __u64                           from;
533         __u64                           to;
534         __u64                           flags;
535 };
536
537 struct perf_branch_stack {
538         __u64                           nr;
539         struct perf_branch_entry        entries[0];
540 };
541
542 struct task_struct;
543
544 /*
545  * extra PMU register associated with an event
546  */
547 struct hw_perf_event_extra {
548         u64             config; /* register value */
549         unsigned int    reg;    /* register address or index */
550         int             alloc;  /* extra register already allocated */
551         int             idx;    /* index in shared_regs->regs[] */
552 };
553
554 /**
555  * struct hw_perf_event - performance event hardware details:
556  */
557 struct hw_perf_event {
558 #ifdef CONFIG_PERF_EVENTS
559         union {
560                 struct { /* hardware */
561                         u64             config;
562                         u64             last_tag;
563                         unsigned long   config_base;
564                         unsigned long   event_base;
565                         int             idx;
566                         int             last_cpu;
567                         struct hw_perf_event_extra extra_reg;
568                 };
569                 struct { /* software */
570                         struct hrtimer  hrtimer;
571                 };
572 #ifdef CONFIG_HAVE_HW_BREAKPOINT
573                 struct { /* breakpoint */
574                         struct arch_hw_breakpoint       info;
575                         struct list_head                bp_list;
576                         /*
577                          * Crufty hack to avoid the chicken and egg
578                          * problem hw_breakpoint has with context
579                          * creation and event initalization.
580                          */
581                         struct task_struct              *bp_target;
582                 };
583 #endif
584         };
585         int                             state;
586         local64_t                       prev_count;
587         u64                             sample_period;
588         u64                             last_period;
589         local64_t                       period_left;
590         u64                             interrupts;
591
592         u64                             freq_time_stamp;
593         u64                             freq_count_stamp;
594 #endif
595 };
596
597 /*
598  * hw_perf_event::state flags
599  */
600 #define PERF_HES_STOPPED        0x01 /* the counter is stopped */
601 #define PERF_HES_UPTODATE       0x02 /* event->count up-to-date */
602 #define PERF_HES_ARCH           0x04
603
604 struct perf_event;
605
606 /*
607  * Common implementation detail of pmu::{start,commit,cancel}_txn
608  */
609 #define PERF_EVENT_TXN 0x1
610
611 /**
612  * struct pmu - generic performance monitoring unit
613  */
614 struct pmu {
615         struct list_head                entry;
616
617         struct device                   *dev;
618         const struct attribute_group    **attr_groups;
619         char                            *name;
620         int                             type;
621
622         int * __percpu                  pmu_disable_count;
623         struct perf_cpu_context * __percpu pmu_cpu_context;
624         int                             task_ctx_nr;
625
626         /*
627          * Fully disable/enable this PMU, can be used to protect from the PMI
628          * as well as for lazy/batch writing of the MSRs.
629          */
630         void (*pmu_enable)              (struct pmu *pmu); /* optional */
631         void (*pmu_disable)             (struct pmu *pmu); /* optional */
632
633         /*
634          * Try and initialize the event for this PMU.
635          * Should return -ENOENT when the @event doesn't match this PMU.
636          */
637         int (*event_init)               (struct perf_event *event);
638
639 #define PERF_EF_START   0x01            /* start the counter when adding    */
640 #define PERF_EF_RELOAD  0x02            /* reload the counter when starting */
641 #define PERF_EF_UPDATE  0x04            /* update the counter when stopping */
642
643         /*
644          * Adds/Removes a counter to/from the PMU, can be done inside
645          * a transaction, see the ->*_txn() methods.
646          */
647         int  (*add)                     (struct perf_event *event, int flags);
648         void (*del)                     (struct perf_event *event, int flags);
649
650         /*
651          * Starts/Stops a counter present on the PMU. The PMI handler
652          * should stop the counter when perf_event_overflow() returns
653          * !0. ->start() will be used to continue.
654          */
655         void (*start)                   (struct perf_event *event, int flags);
656         void (*stop)                    (struct perf_event *event, int flags);
657
658         /*
659          * Updates the counter value of the event.
660          */
661         void (*read)                    (struct perf_event *event);
662
663         /*
664          * Group events scheduling is treated as a transaction, add
665          * group events as a whole and perform one schedulability test.
666          * If the test fails, roll back the whole group
667          *
668          * Start the transaction, after this ->add() doesn't need to
669          * do schedulability tests.
670          */
671         void (*start_txn)               (struct pmu *pmu); /* optional */
672         /*
673          * If ->start_txn() disabled the ->add() schedulability test
674          * then ->commit_txn() is required to perform one. On success
675          * the transaction is closed. On error the transaction is kept
676          * open until ->cancel_txn() is called.
677          */
678         int  (*commit_txn)              (struct pmu *pmu); /* optional */
679         /*
680          * Will cancel the transaction, assumes ->del() is called
681          * for each successful ->add() during the transaction.
682          */
683         void (*cancel_txn)              (struct pmu *pmu); /* optional */
684
685         /*
686          * Will return the value for perf_event_mmap_page::index for this event,
687          * if no implementation is provided it will default to: event->hw.idx + 1.
688          */
689         int (*event_idx)                (struct perf_event *event); /*optional */
690 };
691
692 /**
693  * enum perf_event_active_state - the states of a event
694  */
695 enum perf_event_active_state {
696         PERF_EVENT_STATE_ERROR          = -2,
697         PERF_EVENT_STATE_OFF            = -1,
698         PERF_EVENT_STATE_INACTIVE       =  0,
699         PERF_EVENT_STATE_ACTIVE         =  1,
700 };
701
702 struct file;
703 struct perf_sample_data;
704
705 typedef void (*perf_overflow_handler_t)(struct perf_event *,
706                                         struct perf_sample_data *,
707                                         struct pt_regs *regs);
708
709 enum perf_group_flag {
710         PERF_GROUP_SOFTWARE             = 0x1,
711 };
712
713 #define SWEVENT_HLIST_BITS              8
714 #define SWEVENT_HLIST_SIZE              (1 << SWEVENT_HLIST_BITS)
715
716 struct swevent_hlist {
717         struct hlist_head               heads[SWEVENT_HLIST_SIZE];
718         struct rcu_head                 rcu_head;
719 };
720
721 #define PERF_ATTACH_CONTEXT     0x01
722 #define PERF_ATTACH_GROUP       0x02
723 #define PERF_ATTACH_TASK        0x04
724
725 #ifdef CONFIG_CGROUP_PERF
726 /*
727  * perf_cgroup_info keeps track of time_enabled for a cgroup.
728  * This is a per-cpu dynamically allocated data structure.
729  */
730 struct perf_cgroup_info {
731         u64                             time;
732         u64                             timestamp;
733 };
734
735 struct perf_cgroup {
736         struct                          cgroup_subsys_state css;
737         struct                          perf_cgroup_info *info; /* timing info, one per cpu */
738 };
739 #endif
740
741 struct ring_buffer;
742
743 /**
744  * struct perf_event - performance event kernel representation:
745  */
746 struct perf_event {
747 #ifdef CONFIG_PERF_EVENTS
748         struct list_head                group_entry;
749         struct list_head                event_entry;
750         struct list_head                sibling_list;
751         struct hlist_node               hlist_entry;
752         int                             nr_siblings;
753         int                             group_flags;
754         struct perf_event               *group_leader;
755         struct pmu                      *pmu;
756
757         enum perf_event_active_state    state;
758         unsigned int                    attach_state;
759         local64_t                       count;
760         atomic64_t                      child_count;
761
762         /*
763          * These are the total time in nanoseconds that the event
764          * has been enabled (i.e. eligible to run, and the task has
765          * been scheduled in, if this is a per-task event)
766          * and running (scheduled onto the CPU), respectively.
767          *
768          * They are computed from tstamp_enabled, tstamp_running and
769          * tstamp_stopped when the event is in INACTIVE or ACTIVE state.
770          */
771         u64                             total_time_enabled;
772         u64                             total_time_running;
773
774         /*
775          * These are timestamps used for computing total_time_enabled
776          * and total_time_running when the event is in INACTIVE or
777          * ACTIVE state, measured in nanoseconds from an arbitrary point
778          * in time.
779          * tstamp_enabled: the notional time when the event was enabled
780          * tstamp_running: the notional time when the event was scheduled on
781          * tstamp_stopped: in INACTIVE state, the notional time when the
782          *      event was scheduled off.
783          */
784         u64                             tstamp_enabled;
785         u64                             tstamp_running;
786         u64                             tstamp_stopped;
787
788         /*
789          * timestamp shadows the actual context timing but it can
790          * be safely used in NMI interrupt context. It reflects the
791          * context time as it was when the event was last scheduled in.
792          *
793          * ctx_time already accounts for ctx->timestamp. Therefore to
794          * compute ctx_time for a sample, simply add perf_clock().
795          */
796         u64                             shadow_ctx_time;
797
798         struct perf_event_attr          attr;
799         u16                             header_size;
800         u16                             id_header_size;
801         u16                             read_size;
802         struct hw_perf_event            hw;
803
804         struct perf_event_context       *ctx;
805         struct file                     *filp;
806
807         /*
808          * These accumulate total time (in nanoseconds) that children
809          * events have been enabled and running, respectively.
810          */
811         atomic64_t                      child_total_time_enabled;
812         atomic64_t                      child_total_time_running;
813
814         /*
815          * Protect attach/detach and child_list:
816          */
817         struct mutex                    child_mutex;
818         struct list_head                child_list;
819         struct perf_event               *parent;
820
821         int                             oncpu;
822         int                             cpu;
823
824         struct list_head                owner_entry;
825         struct task_struct              *owner;
826
827         /* mmap bits */
828         struct mutex                    mmap_mutex;
829         atomic_t                        mmap_count;
830         int                             mmap_locked;
831         struct user_struct              *mmap_user;
832         struct ring_buffer              *rb;
833         struct list_head                rb_entry;
834
835         /* poll related */
836         wait_queue_head_t               waitq;
837         struct fasync_struct            *fasync;
838
839         /* delayed work for NMIs and such */
840         int                             pending_wakeup;
841         int                             pending_kill;
842         int                             pending_disable;
843         struct irq_work                 pending;
844
845         atomic_t                        event_limit;
846
847         void (*destroy)(struct perf_event *);
848         struct rcu_head                 rcu_head;
849
850         struct pid_namespace            *ns;
851         u64                             id;
852
853         perf_overflow_handler_t         overflow_handler;
854         void                            *overflow_handler_context;
855
856 #ifdef CONFIG_EVENT_TRACING
857         struct ftrace_event_call        *tp_event;
858         struct event_filter             *filter;
859 #endif
860
861 #ifdef CONFIG_CGROUP_PERF
862         struct perf_cgroup              *cgrp; /* cgroup event is attach to */
863         int                             cgrp_defer_enabled;
864 #endif
865
866 #endif /* CONFIG_PERF_EVENTS */
867 };
868
869 enum perf_event_context_type {
870         task_context,
871         cpu_context,
872 };
873
874 /**
875  * struct perf_event_context - event context structure
876  *
877  * Used as a container for task events and CPU events as well:
878  */
879 struct perf_event_context {
880         struct pmu                      *pmu;
881         enum perf_event_context_type    type;
882         /*
883          * Protect the states of the events in the list,
884          * nr_active, and the list:
885          */
886         raw_spinlock_t                  lock;
887         /*
888          * Protect the list of events.  Locking either mutex or lock
889          * is sufficient to ensure the list doesn't change; to change
890          * the list you need to lock both the mutex and the spinlock.
891          */
892         struct mutex                    mutex;
893
894         struct list_head                pinned_groups;
895         struct list_head                flexible_groups;
896         struct list_head                event_list;
897         int                             nr_events;
898         int                             nr_active;
899         int                             is_active;
900         int                             nr_stat;
901         int                             nr_freq;
902         int                             rotate_disable;
903         atomic_t                        refcount;
904         struct task_struct              *task;
905
906         /*
907          * Context clock, runs when context enabled.
908          */
909         u64                             time;
910         u64                             timestamp;
911
912         /*
913          * These fields let us detect when two contexts have both
914          * been cloned (inherited) from a common ancestor.
915          */
916         struct perf_event_context       *parent_ctx;
917         u64                             parent_gen;
918         u64                             generation;
919         int                             pin_count;
920         int                             nr_cgroups; /* cgroup events present */
921         struct rcu_head                 rcu_head;
922 };
923
924 /*
925  * Number of contexts where an event can trigger:
926  *      task, softirq, hardirq, nmi.
927  */
928 #define PERF_NR_CONTEXTS        4
929
930 /**
931  * struct perf_event_cpu_context - per cpu event context structure
932  */
933 struct perf_cpu_context {
934         struct perf_event_context       ctx;
935         struct perf_event_context       *task_ctx;
936         int                             active_oncpu;
937         int                             exclusive;
938         struct list_head                rotation_list;
939         int                             jiffies_interval;
940         struct pmu                      *active_pmu;
941         struct perf_cgroup              *cgrp;
942 };
943
944 struct perf_output_handle {
945         struct perf_event               *event;
946         struct ring_buffer              *rb;
947         unsigned long                   wakeup;
948         unsigned long                   size;
949         void                            *addr;
950         int                             page;
951 };
952
953 #ifdef CONFIG_PERF_EVENTS
954
955 extern int perf_pmu_register(struct pmu *pmu, char *name, int type);
956 extern void perf_pmu_unregister(struct pmu *pmu);
957
958 extern int perf_num_counters(void);
959 extern const char *perf_pmu_name(void);
960 extern void __perf_event_task_sched_in(struct task_struct *prev,
961                                        struct task_struct *task);
962 extern void __perf_event_task_sched_out(struct task_struct *prev,
963                                         struct task_struct *next);
964 extern int perf_event_init_task(struct task_struct *child);
965 extern void perf_event_exit_task(struct task_struct *child);
966 extern void perf_event_free_task(struct task_struct *task);
967 extern void perf_event_delayed_put(struct task_struct *task);
968 extern void perf_event_print_debug(void);
969 extern void perf_pmu_disable(struct pmu *pmu);
970 extern void perf_pmu_enable(struct pmu *pmu);
971 extern int perf_event_task_disable(void);
972 extern int perf_event_task_enable(void);
973 extern int perf_event_refresh(struct perf_event *event, int refresh);
974 extern void perf_event_update_userpage(struct perf_event *event);
975 extern int perf_event_release_kernel(struct perf_event *event);
976 extern struct perf_event *
977 perf_event_create_kernel_counter(struct perf_event_attr *attr,
978                                 int cpu,
979                                 struct task_struct *task,
980                                 perf_overflow_handler_t callback,
981                                 void *context);
982 extern u64 perf_event_read_value(struct perf_event *event,
983                                  u64 *enabled, u64 *running);
984
985 struct perf_sample_data {
986         u64                             type;
987
988         u64                             ip;
989         struct {
990                 u32     pid;
991                 u32     tid;
992         }                               tid_entry;
993         u64                             time;
994         u64                             addr;
995         u64                             id;
996         u64                             stream_id;
997         struct {
998                 u32     cpu;
999                 u32     reserved;
1000         }                               cpu_entry;
1001         u64                             period;
1002         struct perf_callchain_entry     *callchain;
1003         struct perf_raw_record          *raw;
1004 };
1005
1006 static inline void perf_sample_data_init(struct perf_sample_data *data, u64 addr)
1007 {
1008         data->addr = addr;
1009         data->raw  = NULL;
1010 }
1011
1012 extern void perf_output_sample(struct perf_output_handle *handle,
1013                                struct perf_event_header *header,
1014                                struct perf_sample_data *data,
1015                                struct perf_event *event);
1016 extern void perf_prepare_sample(struct perf_event_header *header,
1017                                 struct perf_sample_data *data,
1018                                 struct perf_event *event,
1019                                 struct pt_regs *regs);
1020
1021 extern int perf_event_overflow(struct perf_event *event,
1022                                  struct perf_sample_data *data,
1023                                  struct pt_regs *regs);
1024
1025 static inline bool is_sampling_event(struct perf_event *event)
1026 {
1027         return event->attr.sample_period != 0;
1028 }
1029
1030 /*
1031  * Return 1 for a software event, 0 for a hardware event
1032  */
1033 static inline int is_software_event(struct perf_event *event)
1034 {
1035         return event->pmu->task_ctx_nr == perf_sw_context;
1036 }
1037
1038 extern struct jump_label_key perf_swevent_enabled[PERF_COUNT_SW_MAX];
1039
1040 extern void __perf_sw_event(u32, u64, struct pt_regs *, u64);
1041
1042 #ifndef perf_arch_fetch_caller_regs
1043 static inline void perf_arch_fetch_caller_regs(struct pt_regs *regs, unsigned long ip) { }
1044 #endif
1045
1046 /*
1047  * Take a snapshot of the regs. Skip ip and frame pointer to
1048  * the nth caller. We only need a few of the regs:
1049  * - ip for PERF_SAMPLE_IP
1050  * - cs for user_mode() tests
1051  * - bp for callchains
1052  * - eflags, for future purposes, just in case
1053  */
1054 static inline void perf_fetch_caller_regs(struct pt_regs *regs)
1055 {
1056         memset(regs, 0, sizeof(*regs));
1057
1058         perf_arch_fetch_caller_regs(regs, CALLER_ADDR0);
1059 }
1060
1061 static __always_inline void
1062 perf_sw_event(u32 event_id, u64 nr, struct pt_regs *regs, u64 addr)
1063 {
1064         struct pt_regs hot_regs;
1065
1066         if (static_branch(&perf_swevent_enabled[event_id])) {
1067                 if (!regs) {
1068                         perf_fetch_caller_regs(&hot_regs);
1069                         regs = &hot_regs;
1070                 }
1071                 __perf_sw_event(event_id, nr, regs, addr);
1072         }
1073 }
1074
1075 extern struct jump_label_key_deferred perf_sched_events;
1076
1077 static inline void perf_event_task_sched_in(struct task_struct *prev,
1078                                             struct task_struct *task)
1079 {
1080         if (static_branch(&perf_sched_events.key))
1081                 __perf_event_task_sched_in(prev, task);
1082 }
1083
1084 static inline void perf_event_task_sched_out(struct task_struct *prev,
1085                                              struct task_struct *next)
1086 {
1087         perf_sw_event(PERF_COUNT_SW_CONTEXT_SWITCHES, 1, NULL, 0);
1088
1089         if (static_branch(&perf_sched_events.key))
1090                 __perf_event_task_sched_out(prev, next);
1091 }
1092
1093 extern void perf_event_mmap(struct vm_area_struct *vma);
1094 extern struct perf_guest_info_callbacks *perf_guest_cbs;
1095 extern int perf_register_guest_info_callbacks(struct perf_guest_info_callbacks *callbacks);
1096 extern int perf_unregister_guest_info_callbacks(struct perf_guest_info_callbacks *callbacks);
1097
1098 extern void perf_event_comm(struct task_struct *tsk);
1099 extern void perf_event_fork(struct task_struct *tsk);
1100
1101 /* Callchains */
1102 DECLARE_PER_CPU(struct perf_callchain_entry, perf_callchain_entry);
1103
1104 extern void perf_callchain_user(struct perf_callchain_entry *entry, struct pt_regs *regs);
1105 extern void perf_callchain_kernel(struct perf_callchain_entry *entry, struct pt_regs *regs);
1106
1107 static inline void perf_callchain_store(struct perf_callchain_entry *entry, u64 ip)
1108 {
1109         if (entry->nr < PERF_MAX_STACK_DEPTH)
1110                 entry->ip[entry->nr++] = ip;
1111 }
1112
1113 extern int sysctl_perf_event_paranoid;
1114 extern int sysctl_perf_event_mlock;
1115 extern int sysctl_perf_event_sample_rate;
1116
1117 extern int perf_proc_update_handler(struct ctl_table *table, int write,
1118                 void __user *buffer, size_t *lenp,
1119                 loff_t *ppos);
1120
1121 static inline bool perf_paranoid_tracepoint_raw(void)
1122 {
1123         return sysctl_perf_event_paranoid > -1;
1124 }
1125
1126 static inline bool perf_paranoid_cpu(void)
1127 {
1128         return sysctl_perf_event_paranoid > 0;
1129 }
1130
1131 static inline bool perf_paranoid_kernel(void)
1132 {
1133         return sysctl_perf_event_paranoid > 1;
1134 }
1135
1136 extern void perf_event_init(void);
1137 extern void perf_tp_event(u64 addr, u64 count, void *record,
1138                           int entry_size, struct pt_regs *regs,
1139                           struct hlist_head *head, int rctx);
1140 extern void perf_bp_event(struct perf_event *event, void *data);
1141
1142 #ifndef perf_misc_flags
1143 # define perf_misc_flags(regs) \
1144                 (user_mode(regs) ? PERF_RECORD_MISC_USER : PERF_RECORD_MISC_KERNEL)
1145 # define perf_instruction_pointer(regs) instruction_pointer(regs)
1146 #endif
1147
1148 extern int perf_output_begin(struct perf_output_handle *handle,
1149                              struct perf_event *event, unsigned int size);
1150 extern void perf_output_end(struct perf_output_handle *handle);
1151 extern void perf_output_copy(struct perf_output_handle *handle,
1152                              const void *buf, unsigned int len);
1153 extern int perf_swevent_get_recursion_context(void);
1154 extern void perf_swevent_put_recursion_context(int rctx);
1155 extern void perf_event_enable(struct perf_event *event);
1156 extern void perf_event_disable(struct perf_event *event);
1157 extern void perf_event_task_tick(void);
1158 #else
1159 static inline void
1160 perf_event_task_sched_in(struct task_struct *prev,
1161                          struct task_struct *task)                      { }
1162 static inline void
1163 perf_event_task_sched_out(struct task_struct *prev,
1164                           struct task_struct *next)                     { }
1165 static inline int perf_event_init_task(struct task_struct *child)       { return 0; }
1166 static inline void perf_event_exit_task(struct task_struct *child)      { }
1167 static inline void perf_event_free_task(struct task_struct *task)       { }
1168 static inline void perf_event_delayed_put(struct task_struct *task)     { }
1169 static inline void perf_event_print_debug(void)                         { }
1170 static inline int perf_event_task_disable(void)                         { return -EINVAL; }
1171 static inline int perf_event_task_enable(void)                          { return -EINVAL; }
1172 static inline int perf_event_refresh(struct perf_event *event, int refresh)
1173 {
1174         return -EINVAL;
1175 }
1176
1177 static inline void
1178 perf_sw_event(u32 event_id, u64 nr, struct pt_regs *regs, u64 addr)     { }
1179 static inline void
1180 perf_bp_event(struct perf_event *event, void *data)                     { }
1181
1182 static inline int perf_register_guest_info_callbacks
1183 (struct perf_guest_info_callbacks *callbacks)                           { return 0; }
1184 static inline int perf_unregister_guest_info_callbacks
1185 (struct perf_guest_info_callbacks *callbacks)                           { return 0; }
1186
1187 static inline void perf_event_mmap(struct vm_area_struct *vma)          { }
1188 static inline void perf_event_comm(struct task_struct *tsk)             { }
1189 static inline void perf_event_fork(struct task_struct *tsk)             { }
1190 static inline void perf_event_init(void)                                { }
1191 static inline int  perf_swevent_get_recursion_context(void)             { return -1; }
1192 static inline void perf_swevent_put_recursion_context(int rctx)         { }
1193 static inline void perf_event_enable(struct perf_event *event)          { }
1194 static inline void perf_event_disable(struct perf_event *event)         { }
1195 static inline void perf_event_task_tick(void)                           { }
1196 #endif
1197
1198 #define perf_output_put(handle, x) perf_output_copy((handle), &(x), sizeof(x))
1199
1200 /*
1201  * This has to have a higher priority than migration_notifier in sched.c.
1202  */
1203 #define perf_cpu_notifier(fn)                                           \
1204 do {                                                                    \
1205         static struct notifier_block fn##_nb __cpuinitdata =            \
1206                 { .notifier_call = fn, .priority = CPU_PRI_PERF };      \
1207         fn(&fn##_nb, (unsigned long)CPU_UP_PREPARE,                     \
1208                 (void *)(unsigned long)smp_processor_id());             \
1209         fn(&fn##_nb, (unsigned long)CPU_STARTING,                       \
1210                 (void *)(unsigned long)smp_processor_id());             \
1211         fn(&fn##_nb, (unsigned long)CPU_ONLINE,                         \
1212                 (void *)(unsigned long)smp_processor_id());             \
1213         register_cpu_notifier(&fn##_nb);                                \
1214 } while (0)
1215
1216 #endif /* __KERNEL__ */
1217 #endif /* _LINUX_PERF_EVENT_H */