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>
20 * User-space ABI bits:
24 * Generalized performance counter event types, used by the hw_event.type
25 * parameter of the sys_perf_counter_open() syscall:
29 * Common hardware events, generalized by the kernel:
31 PERF_COUNT_CPU_CYCLES = 0,
32 PERF_COUNT_INSTRUCTIONS = 1,
33 PERF_COUNT_CACHE_REFERENCES = 2,
34 PERF_COUNT_CACHE_MISSES = 3,
35 PERF_COUNT_BRANCH_INSTRUCTIONS = 4,
36 PERF_COUNT_BRANCH_MISSES = 5,
37 PERF_COUNT_BUS_CYCLES = 6,
39 PERF_HW_EVENTS_MAX = 7,
42 * Special "software" counters provided by the kernel, even if
43 * the hardware does not support performance counters. These
44 * counters measure various physical and sw events of the
45 * kernel (and allow the profiling of them as well):
47 PERF_COUNT_CPU_CLOCK = -1,
48 PERF_COUNT_TASK_CLOCK = -2,
49 PERF_COUNT_PAGE_FAULTS = -3,
50 PERF_COUNT_CONTEXT_SWITCHES = -4,
51 PERF_COUNT_CPU_MIGRATIONS = -5,
53 PERF_SW_EVENTS_MIN = -6,
57 * IRQ-notification data record type:
59 enum perf_counter_record_type {
60 PERF_RECORD_SIMPLE = 0,
62 PERF_RECORD_GROUP = 2,
66 * Hardware event to monitor via a performance monitoring counter:
68 struct perf_counter_hw_event {
75 __u64 disabled : 1, /* off by default */
76 nmi : 1, /* NMI sampling */
77 raw : 1, /* raw event type */
78 inherit : 1, /* children inherit it */
79 pinned : 1, /* must always be on PMU */
80 exclusive : 1, /* only group on PMU */
81 exclude_user : 1, /* don't count user */
82 exclude_kernel : 1, /* ditto kernel */
83 exclude_hv : 1, /* ditto hypervisor */
84 exclude_idle : 1, /* don't count when idle */
88 __u32 extra_config_len;
96 * Ioctls that can be done on a perf counter fd:
98 #define PERF_COUNTER_IOC_ENABLE _IO('$', 0)
99 #define PERF_COUNTER_IOC_DISABLE _IO('$', 1)
103 * Kernel-internal data types and definitions:
106 #ifdef CONFIG_PERF_COUNTERS
107 # include <asm/perf_counter.h>
110 #include <linux/list.h>
111 #include <linux/mutex.h>
112 #include <linux/rculist.h>
113 #include <linux/rcupdate.h>
114 #include <linux/spinlock.h>
115 #include <asm/atomic.h>
120 * struct hw_perf_counter - performance counter hardware details:
122 struct hw_perf_counter {
123 #ifdef CONFIG_PERF_COUNTERS
125 unsigned long config_base;
126 unsigned long counter_base;
129 atomic64_t prev_count;
131 atomic64_t period_left;
136 * Hardcoded buffer length limit for now, for IRQ-fed events:
138 #define PERF_DATA_BUFLEN 2048
141 * struct perf_data - performance counter IRQ data sampling ...
147 u8 data[PERF_DATA_BUFLEN];
153 * struct hw_perf_counter_ops - performance counter hw ops
155 struct hw_perf_counter_ops {
156 int (*enable) (struct perf_counter *counter);
157 void (*disable) (struct perf_counter *counter);
158 void (*read) (struct perf_counter *counter);
162 * enum perf_counter_active_state - the states of a counter
164 enum perf_counter_active_state {
165 PERF_COUNTER_STATE_ERROR = -2,
166 PERF_COUNTER_STATE_OFF = -1,
167 PERF_COUNTER_STATE_INACTIVE = 0,
168 PERF_COUNTER_STATE_ACTIVE = 1,
174 * struct perf_counter - performance counter kernel representation:
176 struct perf_counter {
177 #ifdef CONFIG_PERF_COUNTERS
178 struct list_head list_entry;
179 struct list_head sibling_list;
180 struct perf_counter *group_leader;
181 const struct hw_perf_counter_ops *hw_ops;
183 enum perf_counter_active_state state;
184 enum perf_counter_active_state prev_state;
187 struct perf_counter_hw_event hw_event;
188 struct hw_perf_counter hw;
190 struct perf_counter_context *ctx;
191 struct task_struct *task;
194 struct perf_counter *parent;
195 struct list_head child_list;
198 * Protect attach/detach and child_list:
205 /* read() / irq related data */
206 wait_queue_head_t waitq;
207 /* optional: for NMIs */
209 struct perf_data *irqdata;
210 struct perf_data *usrdata;
211 struct perf_data data[2];
216 * struct perf_counter_context - counter context structure
218 * Used as a container for task counters and CPU counters as well:
220 struct perf_counter_context {
221 #ifdef CONFIG_PERF_COUNTERS
223 * Protect the states of the counters in the list,
224 * nr_active, and the list:
228 * Protect the list of counters. Locking either mutex or lock
229 * is sufficient to ensure the list doesn't change; to change
230 * the list you need to lock both the mutex and the spinlock.
234 struct list_head counter_list;
238 struct task_struct *task;
243 * struct perf_counter_cpu_context - per cpu counter context structure
245 struct perf_cpu_context {
246 struct perf_counter_context ctx;
247 struct perf_counter_context *task_ctx;
254 * Set by architecture code:
256 extern int perf_max_counters;
258 #ifdef CONFIG_PERF_COUNTERS
259 extern const struct hw_perf_counter_ops *
260 hw_perf_counter_init(struct perf_counter *counter);
262 extern void perf_counter_task_sched_in(struct task_struct *task, int cpu);
263 extern void perf_counter_task_sched_out(struct task_struct *task, int cpu);
264 extern void perf_counter_task_tick(struct task_struct *task, int cpu);
265 extern void perf_counter_init_task(struct task_struct *child);
266 extern void perf_counter_exit_task(struct task_struct *child);
267 extern void perf_counter_notify(struct pt_regs *regs);
268 extern void perf_counter_print_debug(void);
269 extern void perf_counter_unthrottle(void);
270 extern u64 hw_perf_save_disable(void);
271 extern void hw_perf_restore(u64 ctrl);
272 extern int perf_counter_task_disable(void);
273 extern int perf_counter_task_enable(void);
274 extern int hw_perf_group_sched_in(struct perf_counter *group_leader,
275 struct perf_cpu_context *cpuctx,
276 struct perf_counter_context *ctx, int cpu);
279 * Return 1 for a software counter, 0 for a hardware counter
281 static inline int is_software_counter(struct perf_counter *counter)
283 return !counter->hw_event.raw && counter->hw_event.type < 0;
288 perf_counter_task_sched_in(struct task_struct *task, int cpu) { }
290 perf_counter_task_sched_out(struct task_struct *task, int cpu) { }
292 perf_counter_task_tick(struct task_struct *task, int cpu) { }
293 static inline void perf_counter_init_task(struct task_struct *child) { }
294 static inline void perf_counter_exit_task(struct task_struct *child) { }
295 static inline void perf_counter_notify(struct pt_regs *regs) { }
296 static inline void perf_counter_print_debug(void) { }
297 static inline void perf_counter_unthrottle(void) { }
298 static inline void hw_perf_restore(u64 ctrl) { }
299 static inline u64 hw_perf_save_disable(void) { return 0; }
300 static inline int perf_counter_task_disable(void) { return -EINVAL; }
301 static inline int perf_counter_task_enable(void) { return -EINVAL; }
304 #endif /* __KERNEL__ */
305 #endif /* _LINUX_PERF_COUNTER_H */