perf report: Add validation of call-chain entries
[safe/jmp/linux-2.6] / include / linux / perf_counter.h
1 /*
2  *  Performance counters:
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_COUNTER_H
15 #define _LINUX_PERF_COUNTER_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
35         PERF_TYPE_MAX,                          /* non-ABI */
36 };
37
38 /*
39  * Generalized performance counter event types, used by the
40  * attr.event_id parameter of the sys_perf_counter_open()
41  * syscall:
42  */
43 enum perf_hw_id {
44         /*
45          * Common hardware events, generalized by the kernel:
46          */
47         PERF_COUNT_HW_CPU_CYCLES                = 0,
48         PERF_COUNT_HW_INSTRUCTIONS              = 1,
49         PERF_COUNT_HW_CACHE_REFERENCES          = 2,
50         PERF_COUNT_HW_CACHE_MISSES              = 3,
51         PERF_COUNT_HW_BRANCH_INSTRUCTIONS       = 4,
52         PERF_COUNT_HW_BRANCH_MISSES             = 5,
53         PERF_COUNT_HW_BUS_CYCLES                = 6,
54
55         PERF_COUNT_HW_MAX,                      /* non-ABI */
56 };
57
58 /*
59  * Generalized hardware cache counters:
60  *
61  *       { L1-D, L1-I, LLC, ITLB, DTLB, BPU } x
62  *       { read, write, prefetch } x
63  *       { accesses, misses }
64  */
65 enum perf_hw_cache_id {
66         PERF_COUNT_HW_CACHE_L1D                 = 0,
67         PERF_COUNT_HW_CACHE_L1I                 = 1,
68         PERF_COUNT_HW_CACHE_LL                  = 2,
69         PERF_COUNT_HW_CACHE_DTLB                = 3,
70         PERF_COUNT_HW_CACHE_ITLB                = 4,
71         PERF_COUNT_HW_CACHE_BPU                 = 5,
72
73         PERF_COUNT_HW_CACHE_MAX,                /* non-ABI */
74 };
75
76 enum perf_hw_cache_op_id {
77         PERF_COUNT_HW_CACHE_OP_READ             = 0,
78         PERF_COUNT_HW_CACHE_OP_WRITE            = 1,
79         PERF_COUNT_HW_CACHE_OP_PREFETCH         = 2,
80
81         PERF_COUNT_HW_CACHE_OP_MAX,             /* non-ABI */
82 };
83
84 enum perf_hw_cache_op_result_id {
85         PERF_COUNT_HW_CACHE_RESULT_ACCESS       = 0,
86         PERF_COUNT_HW_CACHE_RESULT_MISS         = 1,
87
88         PERF_COUNT_HW_CACHE_RESULT_MAX,         /* non-ABI */
89 };
90
91 /*
92  * Special "software" counters provided by the kernel, even if the hardware
93  * does not support performance counters. These counters measure various
94  * physical and sw events of the kernel (and allow the profiling of them as
95  * well):
96  */
97 enum perf_sw_ids {
98         PERF_COUNT_SW_CPU_CLOCK                 = 0,
99         PERF_COUNT_SW_TASK_CLOCK                = 1,
100         PERF_COUNT_SW_PAGE_FAULTS               = 2,
101         PERF_COUNT_SW_CONTEXT_SWITCHES          = 3,
102         PERF_COUNT_SW_CPU_MIGRATIONS            = 4,
103         PERF_COUNT_SW_PAGE_FAULTS_MIN           = 5,
104         PERF_COUNT_SW_PAGE_FAULTS_MAJ           = 6,
105
106         PERF_COUNT_SW_MAX,                      /* non-ABI */
107 };
108
109 /*
110  * Bits that can be set in attr.sample_type to request information
111  * in the overflow packets.
112  */
113 enum perf_counter_sample_format {
114         PERF_SAMPLE_IP                          = 1U << 0,
115         PERF_SAMPLE_TID                         = 1U << 1,
116         PERF_SAMPLE_TIME                        = 1U << 2,
117         PERF_SAMPLE_ADDR                        = 1U << 3,
118         PERF_SAMPLE_GROUP                       = 1U << 4,
119         PERF_SAMPLE_CALLCHAIN                   = 1U << 5,
120         PERF_SAMPLE_ID                          = 1U << 6,
121         PERF_SAMPLE_CPU                         = 1U << 7,
122         PERF_SAMPLE_PERIOD                      = 1U << 8,
123
124         PERF_SAMPLE_MAX = 1U << 9,              /* non-ABI */
125 };
126
127 /*
128  * Bits that can be set in attr.read_format to request that
129  * reads on the counter should return the indicated quantities,
130  * in increasing order of bit value, after the counter value.
131  */
132 enum perf_counter_read_format {
133         PERF_FORMAT_TOTAL_TIME_ENABLED          = 1U << 0,
134         PERF_FORMAT_TOTAL_TIME_RUNNING          = 1U << 1,
135         PERF_FORMAT_ID                          = 1U << 2,
136
137         PERF_FORMAT_MAX = 1U << 3,              /* non-ABI */
138 };
139
140 #define PERF_ATTR_SIZE_VER0     64      /* sizeof first published struct */
141
142 /*
143  * Hardware event to monitor via a performance monitoring counter:
144  */
145 struct perf_counter_attr {
146
147         /*
148          * Major type: hardware/software/tracepoint/etc.
149          */
150         __u32                   type;
151
152         /*
153          * Size of the attr structure, for fwd/bwd compat.
154          */
155         __u32                   size;
156
157         /*
158          * Type specific configuration information.
159          */
160         __u64                   config;
161
162         union {
163                 __u64           sample_period;
164                 __u64           sample_freq;
165         };
166
167         __u64                   sample_type;
168         __u64                   read_format;
169
170         __u64                   disabled       :  1, /* off by default        */
171                                 inherit        :  1, /* children inherit it   */
172                                 pinned         :  1, /* must always be on PMU */
173                                 exclusive      :  1, /* only group on PMU     */
174                                 exclude_user   :  1, /* don't count user      */
175                                 exclude_kernel :  1, /* ditto kernel          */
176                                 exclude_hv     :  1, /* ditto hypervisor      */
177                                 exclude_idle   :  1, /* don't count when idle */
178                                 mmap           :  1, /* include mmap data     */
179                                 comm           :  1, /* include comm data     */
180                                 freq           :  1, /* use freq, not period  */
181
182                                 __reserved_1   : 53;
183
184         __u32                   wakeup_events;  /* wakeup every n events */
185         __u32                   __reserved_2;
186
187         __u64                   __reserved_3;
188 };
189
190 /*
191  * Ioctls that can be done on a perf counter fd:
192  */
193 #define PERF_COUNTER_IOC_ENABLE         _IO ('$', 0)
194 #define PERF_COUNTER_IOC_DISABLE        _IO ('$', 1)
195 #define PERF_COUNTER_IOC_REFRESH        _IO ('$', 2)
196 #define PERF_COUNTER_IOC_RESET          _IO ('$', 3)
197 #define PERF_COUNTER_IOC_PERIOD         _IOW('$', 4, u64)
198
199 enum perf_counter_ioc_flags {
200         PERF_IOC_FLAG_GROUP             = 1U << 0,
201 };
202
203 /*
204  * Structure of the page that can be mapped via mmap
205  */
206 struct perf_counter_mmap_page {
207         __u32   version;                /* version number of this structure */
208         __u32   compat_version;         /* lowest version this is compat with */
209
210         /*
211          * Bits needed to read the hw counters in user-space.
212          *
213          *   u32 seq;
214          *   s64 count;
215          *
216          *   do {
217          *     seq = pc->lock;
218          *
219          *     barrier()
220          *     if (pc->index) {
221          *       count = pmc_read(pc->index - 1);
222          *       count += pc->offset;
223          *     } else
224          *       goto regular_read;
225          *
226          *     barrier();
227          *   } while (pc->lock != seq);
228          *
229          * NOTE: for obvious reason this only works on self-monitoring
230          *       processes.
231          */
232         __u32   lock;                   /* seqlock for synchronization */
233         __u32   index;                  /* hardware counter identifier */
234         __s64   offset;                 /* add to hardware counter value */
235
236         /*
237          * Control data for the mmap() data buffer.
238          *
239          * User-space reading this value should issue an rmb(), on SMP capable
240          * platforms, after reading this value -- see perf_counter_wakeup().
241          */
242         __u64   data_head;              /* head in the data section */
243 };
244
245 #define PERF_EVENT_MISC_CPUMODE_MASK            (3 << 0)
246 #define PERF_EVENT_MISC_CPUMODE_UNKNOWN         (0 << 0)
247 #define PERF_EVENT_MISC_KERNEL                  (1 << 0)
248 #define PERF_EVENT_MISC_USER                    (2 << 0)
249 #define PERF_EVENT_MISC_HYPERVISOR              (3 << 0)
250 #define PERF_EVENT_MISC_OVERFLOW                (1 << 2)
251
252 struct perf_event_header {
253         __u32   type;
254         __u16   misc;
255         __u16   size;
256 };
257
258 enum perf_event_type {
259
260         /*
261          * The MMAP events record the PROT_EXEC mappings so that we can
262          * correlate userspace IPs to code. They have the following structure:
263          *
264          * struct {
265          *      struct perf_event_header        header;
266          *
267          *      u32                             pid, tid;
268          *      u64                             addr;
269          *      u64                             len;
270          *      u64                             pgoff;
271          *      char                            filename[];
272          * };
273          */
274         PERF_EVENT_MMAP                 = 1,
275
276         /*
277          * struct {
278          *      struct perf_event_header        header;
279          *
280          *      u32                             pid, tid;
281          *      char                            comm[];
282          * };
283          */
284         PERF_EVENT_COMM                 = 3,
285
286         /*
287          * struct {
288          *      struct perf_event_header        header;
289          *      u64                             time;
290          *      u64                             id;
291          *      u64                             sample_period;
292          * };
293          */
294         PERF_EVENT_PERIOD               = 4,
295
296         /*
297          * struct {
298          *      struct perf_event_header        header;
299          *      u64                             time;
300          *      u64                             id;
301          * };
302          */
303         PERF_EVENT_THROTTLE             = 5,
304         PERF_EVENT_UNTHROTTLE           = 6,
305
306         /*
307          * struct {
308          *      struct perf_event_header        header;
309          *      u32                             pid, ppid;
310          * };
311          */
312         PERF_EVENT_FORK                 = 7,
313
314         /*
315          * When header.misc & PERF_EVENT_MISC_OVERFLOW the event_type field
316          * will be PERF_RECORD_*
317          *
318          * struct {
319          *      struct perf_event_header        header;
320          *
321          *      { u64                   ip;       } && PERF_RECORD_IP
322          *      { u32                   pid, tid; } && PERF_RECORD_TID
323          *      { u64                   time;     } && PERF_RECORD_TIME
324          *      { u64                   addr;     } && PERF_RECORD_ADDR
325          *      { u64                   config;   } && PERF_RECORD_CONFIG
326          *      { u32                   cpu, res; } && PERF_RECORD_CPU
327          *
328          *      { u64                   nr;
329          *        { u64 id, val; }      cnt[nr];  } && PERF_RECORD_GROUP
330          *
331          *      { u16                   nr,
332          *                              hv,
333          *                              kernel,
334          *                              user;
335          *        u64                   ips[nr];  } && PERF_RECORD_CALLCHAIN
336          * };
337          */
338 };
339
340 #define MAX_STACK_DEPTH                 255
341
342 struct perf_callchain_entry {
343         __u16                           nr;
344         __u16                           hv;
345         __u16                           kernel;
346         __u16                           user;
347         __u64                           ip[MAX_STACK_DEPTH];
348 };
349
350 #ifdef __KERNEL__
351 /*
352  * Kernel-internal data types and definitions:
353  */
354
355 #ifdef CONFIG_PERF_COUNTERS
356 # include <asm/perf_counter.h>
357 #endif
358
359 #include <linux/list.h>
360 #include <linux/mutex.h>
361 #include <linux/rculist.h>
362 #include <linux/rcupdate.h>
363 #include <linux/spinlock.h>
364 #include <linux/hrtimer.h>
365 #include <linux/fs.h>
366 #include <linux/pid_namespace.h>
367 #include <asm/atomic.h>
368
369 struct task_struct;
370
371 /**
372  * struct hw_perf_counter - performance counter hardware details:
373  */
374 struct hw_perf_counter {
375 #ifdef CONFIG_PERF_COUNTERS
376         union {
377                 struct { /* hardware */
378                         u64             config;
379                         unsigned long   config_base;
380                         unsigned long   counter_base;
381                         int             idx;
382                 };
383                 union { /* software */
384                         atomic64_t      count;
385                         struct hrtimer  hrtimer;
386                 };
387         };
388         atomic64_t                      prev_count;
389         u64                             sample_period;
390         u64                             last_period;
391         atomic64_t                      period_left;
392         u64                             interrupts;
393
394         u64                             freq_count;
395         u64                             freq_interrupts;
396         u64                             freq_stamp;
397 #endif
398 };
399
400 struct perf_counter;
401
402 /**
403  * struct pmu - generic performance monitoring unit
404  */
405 struct pmu {
406         int (*enable)                   (struct perf_counter *counter);
407         void (*disable)                 (struct perf_counter *counter);
408         void (*read)                    (struct perf_counter *counter);
409         void (*unthrottle)              (struct perf_counter *counter);
410 };
411
412 /**
413  * enum perf_counter_active_state - the states of a counter
414  */
415 enum perf_counter_active_state {
416         PERF_COUNTER_STATE_ERROR        = -2,
417         PERF_COUNTER_STATE_OFF          = -1,
418         PERF_COUNTER_STATE_INACTIVE     =  0,
419         PERF_COUNTER_STATE_ACTIVE       =  1,
420 };
421
422 struct file;
423
424 struct perf_mmap_data {
425         struct rcu_head                 rcu_head;
426         int                             nr_pages;       /* nr of data pages  */
427         int                             nr_locked;      /* nr pages mlocked  */
428
429         atomic_t                        poll;           /* POLL_ for wakeups */
430         atomic_t                        events;         /* event limit       */
431
432         atomic_long_t                   head;           /* write position    */
433         atomic_long_t                   done_head;      /* completed head    */
434
435         atomic_t                        lock;           /* concurrent writes */
436
437         atomic_t                        wakeup;         /* needs a wakeup    */
438
439         struct perf_counter_mmap_page   *user_page;
440         void                            *data_pages[0];
441 };
442
443 struct perf_pending_entry {
444         struct perf_pending_entry *next;
445         void (*func)(struct perf_pending_entry *);
446 };
447
448 /**
449  * struct perf_counter - performance counter kernel representation:
450  */
451 struct perf_counter {
452 #ifdef CONFIG_PERF_COUNTERS
453         struct list_head                list_entry;
454         struct list_head                event_entry;
455         struct list_head                sibling_list;
456         int                             nr_siblings;
457         struct perf_counter             *group_leader;
458         const struct pmu                *pmu;
459
460         enum perf_counter_active_state  state;
461         atomic64_t                      count;
462
463         /*
464          * These are the total time in nanoseconds that the counter
465          * has been enabled (i.e. eligible to run, and the task has
466          * been scheduled in, if this is a per-task counter)
467          * and running (scheduled onto the CPU), respectively.
468          *
469          * They are computed from tstamp_enabled, tstamp_running and
470          * tstamp_stopped when the counter is in INACTIVE or ACTIVE state.
471          */
472         u64                             total_time_enabled;
473         u64                             total_time_running;
474
475         /*
476          * These are timestamps used for computing total_time_enabled
477          * and total_time_running when the counter is in INACTIVE or
478          * ACTIVE state, measured in nanoseconds from an arbitrary point
479          * in time.
480          * tstamp_enabled: the notional time when the counter was enabled
481          * tstamp_running: the notional time when the counter was scheduled on
482          * tstamp_stopped: in INACTIVE state, the notional time when the
483          *      counter was scheduled off.
484          */
485         u64                             tstamp_enabled;
486         u64                             tstamp_running;
487         u64                             tstamp_stopped;
488
489         struct perf_counter_attr        attr;
490         struct hw_perf_counter          hw;
491
492         struct perf_counter_context     *ctx;
493         struct file                     *filp;
494
495         /*
496          * These accumulate total time (in nanoseconds) that children
497          * counters have been enabled and running, respectively.
498          */
499         atomic64_t                      child_total_time_enabled;
500         atomic64_t                      child_total_time_running;
501
502         /*
503          * Protect attach/detach and child_list:
504          */
505         struct mutex                    child_mutex;
506         struct list_head                child_list;
507         struct perf_counter             *parent;
508
509         int                             oncpu;
510         int                             cpu;
511
512         struct list_head                owner_entry;
513         struct task_struct              *owner;
514
515         /* mmap bits */
516         struct mutex                    mmap_mutex;
517         atomic_t                        mmap_count;
518         struct perf_mmap_data           *data;
519
520         /* poll related */
521         wait_queue_head_t               waitq;
522         struct fasync_struct            *fasync;
523
524         /* delayed work for NMIs and such */
525         int                             pending_wakeup;
526         int                             pending_kill;
527         int                             pending_disable;
528         struct perf_pending_entry       pending;
529
530         atomic_t                        event_limit;
531
532         void (*destroy)(struct perf_counter *);
533         struct rcu_head                 rcu_head;
534
535         struct pid_namespace            *ns;
536         u64                             id;
537 #endif
538 };
539
540 /**
541  * struct perf_counter_context - counter context structure
542  *
543  * Used as a container for task counters and CPU counters as well:
544  */
545 struct perf_counter_context {
546         /*
547          * Protect the states of the counters in the list,
548          * nr_active, and the list:
549          */
550         spinlock_t                      lock;
551         /*
552          * Protect the list of counters.  Locking either mutex or lock
553          * is sufficient to ensure the list doesn't change; to change
554          * the list you need to lock both the mutex and the spinlock.
555          */
556         struct mutex                    mutex;
557
558         struct list_head                counter_list;
559         struct list_head                event_list;
560         int                             nr_counters;
561         int                             nr_active;
562         int                             is_active;
563         atomic_t                        refcount;
564         struct task_struct              *task;
565
566         /*
567          * Context clock, runs when context enabled.
568          */
569         u64                             time;
570         u64                             timestamp;
571
572         /*
573          * These fields let us detect when two contexts have both
574          * been cloned (inherited) from a common ancestor.
575          */
576         struct perf_counter_context     *parent_ctx;
577         u64                             parent_gen;
578         u64                             generation;
579         int                             pin_count;
580         struct rcu_head                 rcu_head;
581 };
582
583 /**
584  * struct perf_counter_cpu_context - per cpu counter context structure
585  */
586 struct perf_cpu_context {
587         struct perf_counter_context     ctx;
588         struct perf_counter_context     *task_ctx;
589         int                             active_oncpu;
590         int                             max_pertask;
591         int                             exclusive;
592
593         /*
594          * Recursion avoidance:
595          *
596          * task, softirq, irq, nmi context
597          */
598         int                             recursion[4];
599 };
600
601 #ifdef CONFIG_PERF_COUNTERS
602
603 /*
604  * Set by architecture code:
605  */
606 extern int perf_max_counters;
607
608 extern const struct pmu *hw_perf_counter_init(struct perf_counter *counter);
609
610 extern void perf_counter_task_sched_in(struct task_struct *task, int cpu);
611 extern void perf_counter_task_sched_out(struct task_struct *task,
612                                         struct task_struct *next, int cpu);
613 extern void perf_counter_task_tick(struct task_struct *task, int cpu);
614 extern int perf_counter_init_task(struct task_struct *child);
615 extern void perf_counter_exit_task(struct task_struct *child);
616 extern void perf_counter_free_task(struct task_struct *task);
617 extern void set_perf_counter_pending(void);
618 extern void perf_counter_do_pending(void);
619 extern void perf_counter_print_debug(void);
620 extern void __perf_disable(void);
621 extern bool __perf_enable(void);
622 extern void perf_disable(void);
623 extern void perf_enable(void);
624 extern int perf_counter_task_disable(void);
625 extern int perf_counter_task_enable(void);
626 extern int hw_perf_group_sched_in(struct perf_counter *group_leader,
627                struct perf_cpu_context *cpuctx,
628                struct perf_counter_context *ctx, int cpu);
629 extern void perf_counter_update_userpage(struct perf_counter *counter);
630
631 struct perf_sample_data {
632         struct pt_regs                  *regs;
633         u64                             addr;
634         u64                             period;
635 };
636
637 extern int perf_counter_overflow(struct perf_counter *counter, int nmi,
638                                  struct perf_sample_data *data);
639
640 /*
641  * Return 1 for a software counter, 0 for a hardware counter
642  */
643 static inline int is_software_counter(struct perf_counter *counter)
644 {
645         return (counter->attr.type != PERF_TYPE_RAW) &&
646                 (counter->attr.type != PERF_TYPE_HARDWARE) &&
647                 (counter->attr.type != PERF_TYPE_HW_CACHE);
648 }
649
650 extern void perf_swcounter_event(u32, u64, int, struct pt_regs *, u64);
651
652 extern void __perf_counter_mmap(struct vm_area_struct *vma);
653
654 static inline void perf_counter_mmap(struct vm_area_struct *vma)
655 {
656         if (vma->vm_flags & VM_EXEC)
657                 __perf_counter_mmap(vma);
658 }
659
660 extern void perf_counter_comm(struct task_struct *tsk);
661 extern void perf_counter_fork(struct task_struct *tsk);
662
663 extern void perf_counter_task_migration(struct task_struct *task, int cpu);
664
665 extern struct perf_callchain_entry *perf_callchain(struct pt_regs *regs);
666
667 extern int sysctl_perf_counter_paranoid;
668 extern int sysctl_perf_counter_mlock;
669 extern int sysctl_perf_counter_sample_rate;
670
671 extern void perf_counter_init(void);
672
673 #ifndef perf_misc_flags
674 #define perf_misc_flags(regs)   (user_mode(regs) ? PERF_EVENT_MISC_USER : \
675                                  PERF_EVENT_MISC_KERNEL)
676 #define perf_instruction_pointer(regs)  instruction_pointer(regs)
677 #endif
678
679 #else
680 static inline void
681 perf_counter_task_sched_in(struct task_struct *task, int cpu)           { }
682 static inline void
683 perf_counter_task_sched_out(struct task_struct *task,
684                             struct task_struct *next, int cpu)          { }
685 static inline void
686 perf_counter_task_tick(struct task_struct *task, int cpu)               { }
687 static inline int perf_counter_init_task(struct task_struct *child)     { return 0; }
688 static inline void perf_counter_exit_task(struct task_struct *child)    { }
689 static inline void perf_counter_free_task(struct task_struct *task)     { }
690 static inline void perf_counter_do_pending(void)                        { }
691 static inline void perf_counter_print_debug(void)                       { }
692 static inline void perf_disable(void)                                   { }
693 static inline void perf_enable(void)                                    { }
694 static inline int perf_counter_task_disable(void)       { return -EINVAL; }
695 static inline int perf_counter_task_enable(void)        { return -EINVAL; }
696
697 static inline void
698 perf_swcounter_event(u32 event, u64 nr, int nmi,
699                      struct pt_regs *regs, u64 addr)                    { }
700
701 static inline void perf_counter_mmap(struct vm_area_struct *vma)        { }
702 static inline void perf_counter_comm(struct task_struct *tsk)           { }
703 static inline void perf_counter_fork(struct task_struct *tsk)           { }
704 static inline void perf_counter_init(void)                              { }
705 static inline void perf_counter_task_migration(struct task_struct *task,
706                                                int cpu)                 { }
707 #endif
708
709 #endif /* __KERNEL__ */
710 #endif /* _LINUX_PERF_COUNTER_H */