2 * Performance counters:
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
8 * Data type definitions, declarations, prototypes.
10 * Started by: Thomas Gleixner and Ingo Molnar
12 * For licencing details see kernel-base/COPYING
14 #ifndef _LINUX_PERF_COUNTER_H
15 #define _LINUX_PERF_COUNTER_H
17 #include <linux/types.h>
18 #include <linux/ioctl.h>
19 #include <asm/byteorder.h>
22 * User-space ABI bits:
29 PERF_TYPE_HARDWARE
= 0,
30 PERF_TYPE_SOFTWARE
= 1,
31 PERF_TYPE_TRACEPOINT
= 2,
32 PERF_TYPE_HW_CACHE
= 3,
35 PERF_TYPE_MAX
, /* non-ABI */
39 * Generalized performance counter event types, used by the
40 * attr.event_id parameter of the sys_perf_counter_open()
45 * Common hardware events, generalized by the kernel:
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,
55 PERF_COUNT_HW_MAX
, /* non-ABI */
59 * Generalized hardware cache counters:
61 * { L1-D, L1-I, LLC, ITLB, DTLB, BPU } x
62 * { read, write, prefetch } x
63 * { accesses, misses }
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,
73 PERF_COUNT_HW_CACHE_MAX
, /* non-ABI */
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,
81 PERF_COUNT_HW_CACHE_OP_MAX
, /* non-ABI */
84 enum perf_hw_cache_op_result_id
{
85 PERF_COUNT_HW_CACHE_RESULT_ACCESS
= 0,
86 PERF_COUNT_HW_CACHE_RESULT_MISS
= 1,
88 PERF_COUNT_HW_CACHE_RESULT_MAX
, /* non-ABI */
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
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,
106 PERF_COUNT_SW_MAX
, /* non-ABI */
110 * Bits that can be set in attr.sample_type to request information
111 * in the overflow packets.
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_READ
= 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 PERF_SAMPLE_STREAM_ID
= 1U << 9,
124 PERF_SAMPLE_RAW
= 1U << 10,
126 PERF_SAMPLE_MAX
= 1U << 11, /* non-ABI */
130 * The format of the data returned by read() on a perf counter fd,
131 * as specified by attr.read_format:
133 * struct read_format {
135 * { u64 time_enabled; } && PERF_FORMAT_ENABLED
136 * { u64 time_running; } && PERF_FORMAT_RUNNING
137 * { u64 id; } && PERF_FORMAT_ID
138 * } && !PERF_FORMAT_GROUP
141 * { u64 time_enabled; } && PERF_FORMAT_ENABLED
142 * { u64 time_running; } && PERF_FORMAT_RUNNING
144 * { u64 id; } && PERF_FORMAT_ID
146 * } && PERF_FORMAT_GROUP
149 enum perf_counter_read_format
{
150 PERF_FORMAT_TOTAL_TIME_ENABLED
= 1U << 0,
151 PERF_FORMAT_TOTAL_TIME_RUNNING
= 1U << 1,
152 PERF_FORMAT_ID
= 1U << 2,
153 PERF_FORMAT_GROUP
= 1U << 3,
155 PERF_FORMAT_MAX
= 1U << 4, /* non-ABI */
158 #define PERF_ATTR_SIZE_VER0 64 /* sizeof first published struct */
161 * Hardware event to monitor via a performance monitoring counter:
163 struct perf_counter_attr
{
166 * Major type: hardware/software/tracepoint/etc.
171 * Size of the attr structure, for fwd/bwd compat.
176 * Type specific configuration information.
188 __u64 disabled
: 1, /* off by default */
189 inherit
: 1, /* children inherit it */
190 pinned
: 1, /* must always be on PMU */
191 exclusive
: 1, /* only group on PMU */
192 exclude_user
: 1, /* don't count user */
193 exclude_kernel
: 1, /* ditto kernel */
194 exclude_hv
: 1, /* ditto hypervisor */
195 exclude_idle
: 1, /* don't count when idle */
196 mmap
: 1, /* include mmap data */
197 comm
: 1, /* include comm data */
198 freq
: 1, /* use freq, not period */
199 inherit_stat
: 1, /* per task counts */
200 enable_on_exec
: 1, /* next exec enables */
201 task
: 1, /* trace fork/exit */
205 __u32 wakeup_events
; /* wakeup every n events */
212 * Ioctls that can be done on a perf counter fd:
214 #define PERF_COUNTER_IOC_ENABLE _IO ('$', 0)
215 #define PERF_COUNTER_IOC_DISABLE _IO ('$', 1)
216 #define PERF_COUNTER_IOC_REFRESH _IO ('$', 2)
217 #define PERF_COUNTER_IOC_RESET _IO ('$', 3)
218 #define PERF_COUNTER_IOC_PERIOD _IOW('$', 4, u64)
219 #define PERF_COUNTER_IOC_SET_OUTPUT _IO ('$', 5)
221 enum perf_counter_ioc_flags
{
222 PERF_IOC_FLAG_GROUP
= 1U << 0,
226 * Structure of the page that can be mapped via mmap
228 struct perf_counter_mmap_page
{
229 __u32 version
; /* version number of this structure */
230 __u32 compat_version
; /* lowest version this is compat with */
233 * Bits needed to read the hw counters in user-space.
243 * count = pmc_read(pc->index - 1);
244 * count += pc->offset;
249 * } while (pc->lock != seq);
251 * NOTE: for obvious reason this only works on self-monitoring
254 __u32 lock
; /* seqlock for synchronization */
255 __u32 index
; /* hardware counter identifier */
256 __s64 offset
; /* add to hardware counter value */
257 __u64 time_enabled
; /* time counter active */
258 __u64 time_running
; /* time counter on cpu */
261 * Hole for extension of the self monitor capabilities
264 __u64 __reserved
[123]; /* align to 1k */
267 * Control data for the mmap() data buffer.
269 * User-space reading the @data_head value should issue an rmb(), on
270 * SMP capable platforms, after reading this value -- see
271 * perf_counter_wakeup().
273 * When the mapping is PROT_WRITE the @data_tail value should be
274 * written by userspace to reflect the last read data. In this case
275 * the kernel will not over-write unread data.
277 __u64 data_head
; /* head in the data section */
278 __u64 data_tail
; /* user-space written tail */
281 #define PERF_EVENT_MISC_CPUMODE_MASK (3 << 0)
282 #define PERF_EVENT_MISC_CPUMODE_UNKNOWN (0 << 0)
283 #define PERF_EVENT_MISC_KERNEL (1 << 0)
284 #define PERF_EVENT_MISC_USER (2 << 0)
285 #define PERF_EVENT_MISC_HYPERVISOR (3 << 0)
287 struct perf_event_header
{
293 enum perf_event_type
{
296 * The MMAP events record the PROT_EXEC mappings so that we can
297 * correlate userspace IPs to code. They have the following structure:
300 * struct perf_event_header header;
313 * struct perf_event_header header;
322 * struct perf_event_header header;
332 * struct perf_event_header header;
341 * struct perf_event_header header;
347 PERF_EVENT_THROTTLE
= 5,
348 PERF_EVENT_UNTHROTTLE
= 6,
352 * struct perf_event_header header;
361 * struct perf_event_header header;
364 * struct read_format values;
371 * struct perf_event_header header;
373 * { u64 ip; } && PERF_SAMPLE_IP
374 * { u32 pid, tid; } && PERF_SAMPLE_TID
375 * { u64 time; } && PERF_SAMPLE_TIME
376 * { u64 addr; } && PERF_SAMPLE_ADDR
377 * { u64 id; } && PERF_SAMPLE_ID
378 * { u64 stream_id;} && PERF_SAMPLE_STREAM_ID
379 * { u32 cpu, res; } && PERF_SAMPLE_CPU
380 * { u64 period; } && PERF_SAMPLE_PERIOD
382 * { struct read_format values; } && PERF_SAMPLE_READ
385 * u64 ips[nr]; } && PERF_SAMPLE_CALLCHAIN
388 * # The RAW record below is opaque data wrt the ABI
390 * # That is, the ABI doesn't make any promises wrt to
391 * # the stability of its content, it may vary depending
392 * # on event, hardware, kernel version and phase of
395 * # In other words, PERF_SAMPLE_RAW contents are not an ABI.
399 * char data[size];}&& PERF_SAMPLE_RAW
402 PERF_EVENT_SAMPLE
= 9,
404 PERF_EVENT_MAX
, /* non-ABI */
407 enum perf_callchain_context
{
408 PERF_CONTEXT_HV
= (__u64
)-32,
409 PERF_CONTEXT_KERNEL
= (__u64
)-128,
410 PERF_CONTEXT_USER
= (__u64
)-512,
412 PERF_CONTEXT_GUEST
= (__u64
)-2048,
413 PERF_CONTEXT_GUEST_KERNEL
= (__u64
)-2176,
414 PERF_CONTEXT_GUEST_USER
= (__u64
)-2560,
416 PERF_CONTEXT_MAX
= (__u64
)-4095,
419 #define PERF_FLAG_FD_NO_GROUP (1U << 0)
420 #define PERF_FLAG_FD_OUTPUT (1U << 1)
424 * Kernel-internal data types and definitions:
427 #ifdef CONFIG_PERF_COUNTERS
428 # include <asm/perf_counter.h>
431 #include <linux/list.h>
432 #include <linux/mutex.h>
433 #include <linux/rculist.h>
434 #include <linux/rcupdate.h>
435 #include <linux/spinlock.h>
436 #include <linux/hrtimer.h>
437 #include <linux/fs.h>
438 #include <linux/pid_namespace.h>
439 #include <asm/atomic.h>
441 #define PERF_MAX_STACK_DEPTH 255
443 struct perf_callchain_entry
{
445 __u64 ip
[PERF_MAX_STACK_DEPTH
];
448 struct perf_raw_record
{
456 * struct hw_perf_counter - performance counter hardware details:
458 struct hw_perf_counter
{
459 #ifdef CONFIG_PERF_COUNTERS
461 struct { /* hardware */
463 unsigned long config_base
;
464 unsigned long counter_base
;
467 union { /* software */
469 struct hrtimer hrtimer
;
472 atomic64_t prev_count
;
475 atomic64_t period_left
;
487 * struct pmu - generic performance monitoring unit
490 int (*enable
) (struct perf_counter
*counter
);
491 void (*disable
) (struct perf_counter
*counter
);
492 void (*read
) (struct perf_counter
*counter
);
493 void (*unthrottle
) (struct perf_counter
*counter
);
497 * enum perf_counter_active_state - the states of a counter
499 enum perf_counter_active_state
{
500 PERF_COUNTER_STATE_ERROR
= -2,
501 PERF_COUNTER_STATE_OFF
= -1,
502 PERF_COUNTER_STATE_INACTIVE
= 0,
503 PERF_COUNTER_STATE_ACTIVE
= 1,
508 struct perf_mmap_data
{
509 struct rcu_head rcu_head
;
510 int nr_pages
; /* nr of data pages */
511 int writable
; /* are we writable */
512 int nr_locked
; /* nr pages mlocked */
514 atomic_t poll
; /* POLL_ for wakeups */
515 atomic_t events
; /* event limit */
517 atomic_long_t head
; /* write position */
518 atomic_long_t done_head
; /* completed head */
520 atomic_t lock
; /* concurrent writes */
521 atomic_t wakeup
; /* needs a wakeup */
522 atomic_t lost
; /* nr records lost */
524 struct perf_counter_mmap_page
*user_page
;
528 struct perf_pending_entry
{
529 struct perf_pending_entry
*next
;
530 void (*func
)(struct perf_pending_entry
*);
534 * struct perf_counter - performance counter kernel representation:
536 struct perf_counter
{
537 #ifdef CONFIG_PERF_COUNTERS
538 struct list_head list_entry
;
539 struct list_head event_entry
;
540 struct list_head sibling_list
;
542 struct perf_counter
*group_leader
;
543 struct perf_counter
*output
;
544 const struct pmu
*pmu
;
546 enum perf_counter_active_state state
;
550 * These are the total time in nanoseconds that the counter
551 * has been enabled (i.e. eligible to run, and the task has
552 * been scheduled in, if this is a per-task counter)
553 * and running (scheduled onto the CPU), respectively.
555 * They are computed from tstamp_enabled, tstamp_running and
556 * tstamp_stopped when the counter is in INACTIVE or ACTIVE state.
558 u64 total_time_enabled
;
559 u64 total_time_running
;
562 * These are timestamps used for computing total_time_enabled
563 * and total_time_running when the counter is in INACTIVE or
564 * ACTIVE state, measured in nanoseconds from an arbitrary point
566 * tstamp_enabled: the notional time when the counter was enabled
567 * tstamp_running: the notional time when the counter was scheduled on
568 * tstamp_stopped: in INACTIVE state, the notional time when the
569 * counter was scheduled off.
575 struct perf_counter_attr attr
;
576 struct hw_perf_counter hw
;
578 struct perf_counter_context
*ctx
;
582 * These accumulate total time (in nanoseconds) that children
583 * counters have been enabled and running, respectively.
585 atomic64_t child_total_time_enabled
;
586 atomic64_t child_total_time_running
;
589 * Protect attach/detach and child_list:
591 struct mutex child_mutex
;
592 struct list_head child_list
;
593 struct perf_counter
*parent
;
598 struct list_head owner_entry
;
599 struct task_struct
*owner
;
602 struct mutex mmap_mutex
;
604 struct perf_mmap_data
*data
;
607 wait_queue_head_t waitq
;
608 struct fasync_struct
*fasync
;
610 /* delayed work for NMIs and such */
614 struct perf_pending_entry pending
;
616 atomic_t event_limit
;
618 void (*destroy
)(struct perf_counter
*);
619 struct rcu_head rcu_head
;
621 struct pid_namespace
*ns
;
627 * struct perf_counter_context - counter context structure
629 * Used as a container for task counters and CPU counters as well:
631 struct perf_counter_context
{
633 * Protect the states of the counters in the list,
634 * nr_active, and the list:
638 * Protect the list of counters. Locking either mutex or lock
639 * is sufficient to ensure the list doesn't change; to change
640 * the list you need to lock both the mutex and the spinlock.
644 struct list_head counter_list
;
645 struct list_head event_list
;
651 struct task_struct
*task
;
654 * Context clock, runs when context enabled.
660 * These fields let us detect when two contexts have both
661 * been cloned (inherited) from a common ancestor.
663 struct perf_counter_context
*parent_ctx
;
667 struct rcu_head rcu_head
;
671 * struct perf_counter_cpu_context - per cpu counter context structure
673 struct perf_cpu_context
{
674 struct perf_counter_context ctx
;
675 struct perf_counter_context
*task_ctx
;
681 * Recursion avoidance:
683 * task, softirq, irq, nmi context
688 #ifdef CONFIG_PERF_COUNTERS
691 * Set by architecture code:
693 extern int perf_max_counters
;
695 extern const struct pmu
*hw_perf_counter_init(struct perf_counter
*counter
);
697 extern void perf_counter_task_sched_in(struct task_struct
*task
, int cpu
);
698 extern void perf_counter_task_sched_out(struct task_struct
*task
,
699 struct task_struct
*next
, int cpu
);
700 extern void perf_counter_task_tick(struct task_struct
*task
, int cpu
);
701 extern int perf_counter_init_task(struct task_struct
*child
);
702 extern void perf_counter_exit_task(struct task_struct
*child
);
703 extern void perf_counter_free_task(struct task_struct
*task
);
704 extern void set_perf_counter_pending(void);
705 extern void perf_counter_do_pending(void);
706 extern void perf_counter_print_debug(void);
707 extern void __perf_disable(void);
708 extern bool __perf_enable(void);
709 extern void perf_disable(void);
710 extern void perf_enable(void);
711 extern int perf_counter_task_disable(void);
712 extern int perf_counter_task_enable(void);
713 extern int hw_perf_group_sched_in(struct perf_counter
*group_leader
,
714 struct perf_cpu_context
*cpuctx
,
715 struct perf_counter_context
*ctx
, int cpu
);
716 extern void perf_counter_update_userpage(struct perf_counter
*counter
);
718 struct perf_sample_data
{
719 struct pt_regs
*regs
;
722 struct perf_raw_record
*raw
;
725 extern int perf_counter_overflow(struct perf_counter
*counter
, int nmi
,
726 struct perf_sample_data
*data
);
727 extern void perf_counter_output(struct perf_counter
*counter
, int nmi
,
728 struct perf_sample_data
*data
);
731 * Return 1 for a software counter, 0 for a hardware counter
733 static inline int is_software_counter(struct perf_counter
*counter
)
735 return (counter
->attr
.type
!= PERF_TYPE_RAW
) &&
736 (counter
->attr
.type
!= PERF_TYPE_HARDWARE
) &&
737 (counter
->attr
.type
!= PERF_TYPE_HW_CACHE
);
740 extern atomic_t perf_swcounter_enabled
[PERF_COUNT_SW_MAX
];
742 extern void __perf_swcounter_event(u32
, u64
, int, struct pt_regs
*, u64
);
745 perf_swcounter_event(u32 event
, u64 nr
, int nmi
, struct pt_regs
*regs
, u64 addr
)
747 if (atomic_read(&perf_swcounter_enabled
[event
]))
748 __perf_swcounter_event(event
, nr
, nmi
, regs
, addr
);
751 extern void __perf_counter_mmap(struct vm_area_struct
*vma
);
753 static inline void perf_counter_mmap(struct vm_area_struct
*vma
)
755 if (vma
->vm_flags
& VM_EXEC
)
756 __perf_counter_mmap(vma
);
759 extern void perf_counter_comm(struct task_struct
*tsk
);
760 extern void perf_counter_fork(struct task_struct
*tsk
);
762 extern struct perf_callchain_entry
*perf_callchain(struct pt_regs
*regs
);
764 extern int sysctl_perf_counter_paranoid
;
765 extern int sysctl_perf_counter_mlock
;
766 extern int sysctl_perf_counter_sample_rate
;
768 extern void perf_counter_init(void);
769 extern void perf_tpcounter_event(int event_id
, u64 addr
, u64 count
,
770 void *record
, int entry_size
);
772 #ifndef perf_misc_flags
773 #define perf_misc_flags(regs) (user_mode(regs) ? PERF_EVENT_MISC_USER : \
774 PERF_EVENT_MISC_KERNEL)
775 #define perf_instruction_pointer(regs) instruction_pointer(regs)
780 perf_counter_task_sched_in(struct task_struct
*task
, int cpu
) { }
782 perf_counter_task_sched_out(struct task_struct
*task
,
783 struct task_struct
*next
, int cpu
) { }
785 perf_counter_task_tick(struct task_struct
*task
, int cpu
) { }
786 static inline int perf_counter_init_task(struct task_struct
*child
) { return 0; }
787 static inline void perf_counter_exit_task(struct task_struct
*child
) { }
788 static inline void perf_counter_free_task(struct task_struct
*task
) { }
789 static inline void perf_counter_do_pending(void) { }
790 static inline void perf_counter_print_debug(void) { }
791 static inline void perf_disable(void) { }
792 static inline void perf_enable(void) { }
793 static inline int perf_counter_task_disable(void) { return -EINVAL
; }
794 static inline int perf_counter_task_enable(void) { return -EINVAL
; }
797 perf_swcounter_event(u32 event
, u64 nr
, int nmi
,
798 struct pt_regs
*regs
, u64 addr
) { }
800 static inline void perf_counter_mmap(struct vm_area_struct
*vma
) { }
801 static inline void perf_counter_comm(struct task_struct
*tsk
) { }
802 static inline void perf_counter_fork(struct task_struct
*tsk
) { }
803 static inline void perf_counter_init(void) { }
806 #endif /* __KERNEL__ */
807 #endif /* _LINUX_PERF_COUNTER_H */