2 * Performance counters:
4 * Copyright(C) 2008, Thomas Gleixner <tglx@linutronix.de>
5 * Copyright(C) 2008, Red Hat, Inc., Ingo Molnar
7 * Data type definitions, declarations, prototypes.
9 * Started by: Thomas Gleixner and Ingo Molnar
11 * For licencing details see kernel-base/COPYING
13 #ifndef _LINUX_PERF_COUNTER_H
14 #define _LINUX_PERF_COUNTER_H
16 #include <linux/types.h>
17 #include <linux/ioctl.h>
18 #include <asm/byteorder.h>
21 * User-space ABI bits:
27 enum perf_event_types {
28 PERF_TYPE_HARDWARE = 0,
29 PERF_TYPE_SOFTWARE = 1,
30 PERF_TYPE_TRACEPOINT = 2,
33 * available TYPE space, raw is the max value.
40 * Generalized performance counter event types, used by the hw_event.event_id
41 * parameter of the sys_perf_counter_open() syscall:
45 * Common hardware events, generalized by the kernel:
47 PERF_COUNT_CPU_CYCLES = 0,
48 PERF_COUNT_INSTRUCTIONS = 1,
49 PERF_COUNT_CACHE_REFERENCES = 2,
50 PERF_COUNT_CACHE_MISSES = 3,
51 PERF_COUNT_BRANCH_INSTRUCTIONS = 4,
52 PERF_COUNT_BRANCH_MISSES = 5,
53 PERF_COUNT_BUS_CYCLES = 6,
55 PERF_HW_EVENTS_MAX = 7,
59 * Special "software" counters provided by the kernel, even if the hardware
60 * does not support performance counters. These counters measure various
61 * physical and sw events of the kernel (and allow the profiling of them as
65 PERF_COUNT_CPU_CLOCK = 0,
66 PERF_COUNT_TASK_CLOCK = 1,
67 PERF_COUNT_PAGE_FAULTS = 2,
68 PERF_COUNT_CONTEXT_SWITCHES = 3,
69 PERF_COUNT_CPU_MIGRATIONS = 4,
70 PERF_COUNT_PAGE_FAULTS_MIN = 5,
71 PERF_COUNT_PAGE_FAULTS_MAJ = 6,
73 PERF_SW_EVENTS_MAX = 7,
76 #define __PERF_COUNTER_MASK(name) \
77 (((1ULL << PERF_COUNTER_##name##_BITS) - 1) << \
78 PERF_COUNTER_##name##_SHIFT)
80 #define PERF_COUNTER_RAW_BITS 1
81 #define PERF_COUNTER_RAW_SHIFT 63
82 #define PERF_COUNTER_RAW_MASK __PERF_COUNTER_MASK(RAW)
84 #define PERF_COUNTER_CONFIG_BITS 63
85 #define PERF_COUNTER_CONFIG_SHIFT 0
86 #define PERF_COUNTER_CONFIG_MASK __PERF_COUNTER_MASK(CONFIG)
88 #define PERF_COUNTER_TYPE_BITS 7
89 #define PERF_COUNTER_TYPE_SHIFT 56
90 #define PERF_COUNTER_TYPE_MASK __PERF_COUNTER_MASK(TYPE)
92 #define PERF_COUNTER_EVENT_BITS 56
93 #define PERF_COUNTER_EVENT_SHIFT 0
94 #define PERF_COUNTER_EVENT_MASK __PERF_COUNTER_MASK(EVENT)
97 * Bits that can be set in hw_event.record_type to request information
98 * in the overflow packets.
100 enum perf_counter_record_format {
101 PERF_RECORD_IP = 1U << 0,
102 PERF_RECORD_TID = 1U << 1,
103 PERF_RECORD_TIME = 1U << 2,
104 PERF_RECORD_ADDR = 1U << 3,
105 PERF_RECORD_GROUP = 1U << 4,
106 PERF_RECORD_CALLCHAIN = 1U << 5,
107 PERF_RECORD_CONFIG = 1U << 6,
108 PERF_RECORD_CPU = 1U << 7,
112 * Bits that can be set in hw_event.read_format to request that
113 * reads on the counter should return the indicated quantities,
114 * in increasing order of bit value, after the counter value.
116 enum perf_counter_read_format {
117 PERF_FORMAT_TOTAL_TIME_ENABLED = 1,
118 PERF_FORMAT_TOTAL_TIME_RUNNING = 2,
122 * Hardware event to monitor via a performance monitoring counter:
124 struct perf_counter_hw_event {
126 * The MSB of the config word signifies if the rest contains cpu
127 * specific (raw) counter configuration data, if unset, the next
128 * 7 bits are an event type and the rest of the bits are the event
141 __u64 disabled : 1, /* off by default */
142 nmi : 1, /* NMI sampling */
143 inherit : 1, /* children inherit it */
144 pinned : 1, /* must always be on PMU */
145 exclusive : 1, /* only group on PMU */
146 exclude_user : 1, /* don't count user */
147 exclude_kernel : 1, /* ditto kernel */
148 exclude_hv : 1, /* ditto hypervisor */
149 exclude_idle : 1, /* don't count when idle */
150 mmap : 1, /* include mmap data */
151 munmap : 1, /* include munmap data */
152 comm : 1, /* include comm data */
153 freq : 1, /* use freq, not period */
157 __u32 extra_config_len;
158 __u32 wakeup_events; /* wakeup every n events */
165 * Ioctls that can be done on a perf counter fd:
167 #define PERF_COUNTER_IOC_ENABLE _IOW('$', 0, u32)
168 #define PERF_COUNTER_IOC_DISABLE _IOW('$', 1, u32)
169 #define PERF_COUNTER_IOC_REFRESH _IOW('$', 2, u32)
170 #define PERF_COUNTER_IOC_RESET _IOW('$', 3, u32)
172 enum perf_counter_ioc_flags {
173 PERF_IOC_FLAG_GROUP = 1U << 0,
177 * Structure of the page that can be mapped via mmap
179 struct perf_counter_mmap_page {
180 __u32 version; /* version number of this structure */
181 __u32 compat_version; /* lowest version this is compat with */
184 * Bits needed to read the hw counters in user-space.
194 * count = pmc_read(pc->index - 1);
195 * count += pc->offset;
200 * } while (pc->lock != seq);
202 * NOTE: for obvious reason this only works on self-monitoring
205 __u32 lock; /* seqlock for synchronization */
206 __u32 index; /* hardware counter identifier */
207 __s64 offset; /* add to hardware counter value */
210 * Control data for the mmap() data buffer.
212 * User-space reading this value should issue an rmb(), on SMP capable
213 * platforms, after reading this value -- see perf_counter_wakeup().
215 __u32 data_head; /* head in the data section */
218 #define PERF_EVENT_MISC_KERNEL (1 << 0)
219 #define PERF_EVENT_MISC_USER (1 << 1)
220 #define PERF_EVENT_MISC_OVERFLOW (1 << 2)
222 struct perf_event_header {
228 enum perf_event_type {
231 * The MMAP events record the PROT_EXEC mappings so that we can
232 * correlate userspace IPs to code. They have the following structure:
235 * struct perf_event_header header;
245 PERF_EVENT_MUNMAP = 2,
249 * struct perf_event_header header;
258 * When header.misc & PERF_EVENT_MISC_OVERFLOW the event_type field
259 * will be PERF_RECORD_*
262 * struct perf_event_header header;
264 * { u64 ip; } && PERF_RECORD_IP
265 * { u32 pid, tid; } && PERF_RECORD_TID
266 * { u64 time; } && PERF_RECORD_TIME
267 * { u64 addr; } && PERF_RECORD_ADDR
268 * { u64 config; } && PERF_RECORD_CONFIG
269 * { u32 cpu, res; } && PERF_RECORD_CPU
272 * { u64 event, val; } cnt[nr]; } && PERF_RECORD_GROUP
278 * u64 ips[nr]; } && PERF_RECORD_CALLCHAIN
285 * Kernel-internal data types and definitions:
288 #ifdef CONFIG_PERF_COUNTERS
289 # include <asm/perf_counter.h>
292 #include <linux/list.h>
293 #include <linux/mutex.h>
294 #include <linux/rculist.h>
295 #include <linux/rcupdate.h>
296 #include <linux/spinlock.h>
297 #include <linux/hrtimer.h>
298 #include <linux/fs.h>
299 #include <asm/atomic.h>
303 static inline u64 perf_event_raw(struct perf_counter_hw_event *hw_event)
305 return hw_event->config & PERF_COUNTER_RAW_MASK;
308 static inline u64 perf_event_config(struct perf_counter_hw_event *hw_event)
310 return hw_event->config & PERF_COUNTER_CONFIG_MASK;
313 static inline u64 perf_event_type(struct perf_counter_hw_event *hw_event)
315 return (hw_event->config & PERF_COUNTER_TYPE_MASK) >>
316 PERF_COUNTER_TYPE_SHIFT;
319 static inline u64 perf_event_id(struct perf_counter_hw_event *hw_event)
321 return hw_event->config & PERF_COUNTER_EVENT_MASK;
325 * struct hw_perf_counter - performance counter hardware details:
327 struct hw_perf_counter {
328 #ifdef CONFIG_PERF_COUNTERS
330 struct { /* hardware */
332 unsigned long config_base;
333 unsigned long counter_base;
337 union { /* software */
339 struct hrtimer hrtimer;
342 atomic64_t prev_count;
344 atomic64_t period_left;
352 * struct pmu - generic performance monitoring unit
355 int (*enable) (struct perf_counter *counter);
356 void (*disable) (struct perf_counter *counter);
357 void (*read) (struct perf_counter *counter);
361 * enum perf_counter_active_state - the states of a counter
363 enum perf_counter_active_state {
364 PERF_COUNTER_STATE_ERROR = -2,
365 PERF_COUNTER_STATE_OFF = -1,
366 PERF_COUNTER_STATE_INACTIVE = 0,
367 PERF_COUNTER_STATE_ACTIVE = 1,
372 struct perf_mmap_data {
373 struct rcu_head rcu_head;
374 int nr_pages; /* nr of data pages */
375 int nr_locked; /* nr pages mlocked */
377 atomic_t poll; /* POLL_ for wakeups */
378 atomic_t head; /* write position */
379 atomic_t events; /* event limit */
381 atomic_t done_head; /* completed head */
382 atomic_t lock; /* concurrent writes */
384 atomic_t wakeup; /* needs a wakeup */
386 struct perf_counter_mmap_page *user_page;
390 struct perf_pending_entry {
391 struct perf_pending_entry *next;
392 void (*func)(struct perf_pending_entry *);
396 * struct perf_counter - performance counter kernel representation:
398 struct perf_counter {
399 #ifdef CONFIG_PERF_COUNTERS
400 struct list_head list_entry;
401 struct list_head event_entry;
402 struct list_head sibling_list;
404 struct perf_counter *group_leader;
405 const struct pmu *pmu;
407 enum perf_counter_active_state state;
408 enum perf_counter_active_state prev_state;
412 * These are the total time in nanoseconds that the counter
413 * has been enabled (i.e. eligible to run, and the task has
414 * been scheduled in, if this is a per-task counter)
415 * and running (scheduled onto the CPU), respectively.
417 * They are computed from tstamp_enabled, tstamp_running and
418 * tstamp_stopped when the counter is in INACTIVE or ACTIVE state.
420 u64 total_time_enabled;
421 u64 total_time_running;
424 * These are timestamps used for computing total_time_enabled
425 * and total_time_running when the counter is in INACTIVE or
426 * ACTIVE state, measured in nanoseconds from an arbitrary point
428 * tstamp_enabled: the notional time when the counter was enabled
429 * tstamp_running: the notional time when the counter was scheduled on
430 * tstamp_stopped: in INACTIVE state, the notional time when the
431 * counter was scheduled off.
437 struct perf_counter_hw_event hw_event;
438 struct hw_perf_counter hw;
440 struct perf_counter_context *ctx;
441 struct task_struct *task;
444 struct perf_counter *parent;
445 struct list_head child_list;
448 * These accumulate total time (in nanoseconds) that children
449 * counters have been enabled and running, respectively.
451 atomic64_t child_total_time_enabled;
452 atomic64_t child_total_time_running;
455 * Protect attach/detach and child_list:
463 struct mutex mmap_mutex;
465 struct perf_mmap_data *data;
468 wait_queue_head_t waitq;
469 struct fasync_struct *fasync;
471 /* delayed work for NMIs and such */
475 struct perf_pending_entry pending;
477 atomic_t event_limit;
479 void (*destroy)(struct perf_counter *);
480 struct rcu_head rcu_head;
485 * struct perf_counter_context - counter context structure
487 * Used as a container for task counters and CPU counters as well:
489 struct perf_counter_context {
490 #ifdef CONFIG_PERF_COUNTERS
492 * Protect the states of the counters in the list,
493 * nr_active, and the list:
497 * Protect the list of counters. Locking either mutex or lock
498 * is sufficient to ensure the list doesn't change; to change
499 * the list you need to lock both the mutex and the spinlock.
503 struct list_head counter_list;
504 struct list_head event_list;
508 struct task_struct *task;
511 * Context clock, runs when context enabled.
519 * struct perf_counter_cpu_context - per cpu counter context structure
521 struct perf_cpu_context {
522 struct perf_counter_context ctx;
523 struct perf_counter_context *task_ctx;
529 * Recursion avoidance:
531 * task, softirq, irq, nmi context
536 #ifdef CONFIG_PERF_COUNTERS
539 * Set by architecture code:
541 extern int perf_max_counters;
543 extern const struct pmu *hw_perf_counter_init(struct perf_counter *counter);
545 extern void perf_counter_task_sched_in(struct task_struct *task, int cpu);
546 extern void perf_counter_task_sched_out(struct task_struct *task, int cpu);
547 extern void perf_counter_task_tick(struct task_struct *task, int cpu);
548 extern void perf_counter_init_task(struct task_struct *child);
549 extern void perf_counter_exit_task(struct task_struct *child);
550 extern void perf_counter_do_pending(void);
551 extern void perf_counter_print_debug(void);
552 extern void perf_counter_unthrottle(void);
553 extern void __perf_disable(void);
554 extern bool __perf_enable(void);
555 extern void perf_disable(void);
556 extern void perf_enable(void);
557 extern int perf_counter_task_disable(void);
558 extern int perf_counter_task_enable(void);
559 extern int hw_perf_group_sched_in(struct perf_counter *group_leader,
560 struct perf_cpu_context *cpuctx,
561 struct perf_counter_context *ctx, int cpu);
562 extern void perf_counter_update_userpage(struct perf_counter *counter);
564 extern int perf_counter_overflow(struct perf_counter *counter,
565 int nmi, struct pt_regs *regs, u64 addr);
567 * Return 1 for a software counter, 0 for a hardware counter
569 static inline int is_software_counter(struct perf_counter *counter)
571 return !perf_event_raw(&counter->hw_event) &&
572 perf_event_type(&counter->hw_event) != PERF_TYPE_HARDWARE;
575 extern void perf_swcounter_event(u32, u64, int, struct pt_regs *, u64);
577 extern void perf_counter_mmap(unsigned long addr, unsigned long len,
578 unsigned long pgoff, struct file *file);
580 extern void perf_counter_munmap(unsigned long addr, unsigned long len,
581 unsigned long pgoff, struct file *file);
583 extern void perf_counter_comm(struct task_struct *tsk);
585 #define MAX_STACK_DEPTH 255
587 struct perf_callchain_entry {
588 u16 nr, hv, kernel, user;
589 u64 ip[MAX_STACK_DEPTH];
592 extern struct perf_callchain_entry *perf_callchain(struct pt_regs *regs);
594 extern int sysctl_perf_counter_priv;
595 extern int sysctl_perf_counter_mlock;
597 extern void perf_counter_init(void);
601 perf_counter_task_sched_in(struct task_struct *task, int cpu) { }
603 perf_counter_task_sched_out(struct task_struct *task, int cpu) { }
605 perf_counter_task_tick(struct task_struct *task, int cpu) { }
606 static inline void perf_counter_init_task(struct task_struct *child) { }
607 static inline void perf_counter_exit_task(struct task_struct *child) { }
608 static inline void perf_counter_do_pending(void) { }
609 static inline void perf_counter_print_debug(void) { }
610 static inline void perf_counter_unthrottle(void) { }
611 static inline void perf_disable(void) { }
612 static inline void perf_enable(void) { }
613 static inline int perf_counter_task_disable(void) { return -EINVAL; }
614 static inline int perf_counter_task_enable(void) { return -EINVAL; }
617 perf_swcounter_event(u32 event, u64 nr, int nmi,
618 struct pt_regs *regs, u64 addr) { }
621 perf_counter_mmap(unsigned long addr, unsigned long len,
622 unsigned long pgoff, struct file *file) { }
625 perf_counter_munmap(unsigned long addr, unsigned long len,
626 unsigned long pgoff, struct file *file) { }
628 static inline void perf_counter_comm(struct task_struct *tsk) { }
629 static inline void perf_counter_init(void) { }
632 #endif /* __KERNEL__ */
633 #endif /* _LINUX_PERF_COUNTER_H */