]> bbs.cooldavid.org Git - net-next-2.6.git/blame - include/linux/perf_counter.h
perf_counter: more elaborate write API
[net-next-2.6.git] / include / linux / perf_counter.h
CommitLineData
0793a61d
TG
1/*
2 * Performance counters:
3 *
4 * Copyright(C) 2008, Thomas Gleixner <tglx@linutronix.de>
5 * Copyright(C) 2008, Red Hat, Inc., Ingo Molnar
6 *
7 * Data type definitions, declarations, prototypes.
8 *
9 * Started by: Thomas Gleixner and Ingo Molnar
10 *
11 * For licencing details see kernel-base/COPYING
12 */
13#ifndef _LINUX_PERF_COUNTER_H
14#define _LINUX_PERF_COUNTER_H
15
f3dfd265
PM
16#include <linux/types.h>
17#include <linux/ioctl.h>
9aaa131a 18#include <asm/byteorder.h>
0793a61d
TG
19
20/*
9f66a381
IM
21 * User-space ABI bits:
22 */
23
24/*
b8e83514 25 * hw_event.type
0793a61d 26 */
b8e83514
PZ
27enum perf_event_types {
28 PERF_TYPE_HARDWARE = 0,
29 PERF_TYPE_SOFTWARE = 1,
30 PERF_TYPE_TRACEPOINT = 2,
31
0793a61d 32 /*
b8e83514 33 * available TYPE space, raw is the max value.
0793a61d 34 */
9f66a381 35
b8e83514
PZ
36 PERF_TYPE_RAW = 128,
37};
6c594c21 38
b8e83514
PZ
39/*
40 * Generalized performance counter event types, used by the hw_event.event_id
41 * parameter of the sys_perf_counter_open() syscall:
42 */
43enum hw_event_ids {
9f66a381 44 /*
b8e83514 45 * Common hardware events, generalized by the kernel:
9f66a381 46 */
b8e83514
PZ
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,
54
55 PERF_HW_EVENTS_MAX = 7,
56};
e077df4f 57
b8e83514
PZ
58/*
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
62 * well):
63 */
64enum sw_event_ids {
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,
72
73 PERF_SW_EVENTS_MAX = 7,
0793a61d
TG
74};
75
76/*
77 * IRQ-notification data record type:
78 */
9f66a381 79enum perf_counter_record_type {
b8e83514
PZ
80 PERF_RECORD_SIMPLE = 0,
81 PERF_RECORD_IRQ = 1,
82 PERF_RECORD_GROUP = 2,
0793a61d
TG
83};
84
f4a2deb4
PZ
85#define __PERF_COUNTER_MASK(name) \
86 (((1ULL << PERF_COUNTER_##name##_BITS) - 1) << \
87 PERF_COUNTER_##name##_SHIFT)
88
89#define PERF_COUNTER_RAW_BITS 1
90#define PERF_COUNTER_RAW_SHIFT 63
91#define PERF_COUNTER_RAW_MASK __PERF_COUNTER_MASK(RAW)
92
93#define PERF_COUNTER_CONFIG_BITS 63
94#define PERF_COUNTER_CONFIG_SHIFT 0
95#define PERF_COUNTER_CONFIG_MASK __PERF_COUNTER_MASK(CONFIG)
96
97#define PERF_COUNTER_TYPE_BITS 7
98#define PERF_COUNTER_TYPE_SHIFT 56
99#define PERF_COUNTER_TYPE_MASK __PERF_COUNTER_MASK(TYPE)
100
101#define PERF_COUNTER_EVENT_BITS 56
102#define PERF_COUNTER_EVENT_SHIFT 0
103#define PERF_COUNTER_EVENT_MASK __PERF_COUNTER_MASK(EVENT)
104
9f66a381
IM
105/*
106 * Hardware event to monitor via a performance monitoring counter:
107 */
108struct perf_counter_hw_event {
f4a2deb4
PZ
109 /*
110 * The MSB of the config word signifies if the rest contains cpu
111 * specific (raw) counter configuration data, if unset, the next
112 * 7 bits are an event type and the rest of the bits are the event
113 * identifier.
114 */
115 __u64 config;
9f66a381 116
f3dfd265 117 __u64 irq_period;
2743a5b0
PM
118 __u64 record_type;
119 __u64 read_format;
9f66a381 120
2743a5b0 121 __u64 disabled : 1, /* off by default */
0475f9ea 122 nmi : 1, /* NMI sampling */
0475f9ea
PM
123 inherit : 1, /* children inherit it */
124 pinned : 1, /* must always be on PMU */
125 exclusive : 1, /* only group on PMU */
126 exclude_user : 1, /* don't count user */
127 exclude_kernel : 1, /* ditto kernel */
128 exclude_hv : 1, /* ditto hypervisor */
2743a5b0 129 exclude_idle : 1, /* don't count when idle */
0475f9ea 130
b8e83514 131 __reserved_1 : 55;
2743a5b0
PM
132
133 __u32 extra_config_len;
134 __u32 __reserved_4;
9f66a381 135
f3dfd265 136 __u64 __reserved_2;
2743a5b0 137 __u64 __reserved_3;
eab656ae
TG
138};
139
d859e29f
PM
140/*
141 * Ioctls that can be done on a perf counter fd:
142 */
143#define PERF_COUNTER_IOC_ENABLE _IO('$', 0)
144#define PERF_COUNTER_IOC_DISABLE _IO('$', 1)
145
37d81828
PM
146/*
147 * Structure of the page that can be mapped via mmap
148 */
149struct perf_counter_mmap_page {
150 __u32 version; /* version number of this structure */
151 __u32 compat_version; /* lowest version this is compat with */
152 __u32 lock; /* seqlock for synchronization */
153 __u32 index; /* hardware counter identifier */
154 __s64 offset; /* add to hardware counter value */
7b732a75
PZ
155
156 __u32 data_head; /* head in the data section */
37d81828
PM
157};
158
f3dfd265 159#ifdef __KERNEL__
9f66a381 160/*
f3dfd265 161 * Kernel-internal data types and definitions:
9f66a381
IM
162 */
163
f3dfd265
PM
164#ifdef CONFIG_PERF_COUNTERS
165# include <asm/perf_counter.h>
166#endif
167
168#include <linux/list.h>
169#include <linux/mutex.h>
170#include <linux/rculist.h>
171#include <linux/rcupdate.h>
172#include <linux/spinlock.h>
d6d020e9 173#include <linux/hrtimer.h>
f3dfd265
PM
174#include <asm/atomic.h>
175
176struct task_struct;
177
f4a2deb4
PZ
178static inline u64 perf_event_raw(struct perf_counter_hw_event *hw_event)
179{
180 return hw_event->config & PERF_COUNTER_RAW_MASK;
181}
182
183static inline u64 perf_event_config(struct perf_counter_hw_event *hw_event)
184{
185 return hw_event->config & PERF_COUNTER_CONFIG_MASK;
186}
187
188static inline u64 perf_event_type(struct perf_counter_hw_event *hw_event)
189{
190 return (hw_event->config & PERF_COUNTER_TYPE_MASK) >>
191 PERF_COUNTER_TYPE_SHIFT;
192}
193
194static inline u64 perf_event_id(struct perf_counter_hw_event *hw_event)
195{
196 return hw_event->config & PERF_COUNTER_EVENT_MASK;
197}
198
0793a61d 199/**
9f66a381 200 * struct hw_perf_counter - performance counter hardware details:
0793a61d
TG
201 */
202struct hw_perf_counter {
ee06094f 203#ifdef CONFIG_PERF_COUNTERS
d6d020e9
PZ
204 union {
205 struct { /* hardware */
206 u64 config;
207 unsigned long config_base;
208 unsigned long counter_base;
209 int nmi;
210 unsigned int idx;
211 };
212 union { /* software */
213 atomic64_t count;
214 struct hrtimer hrtimer;
215 };
216 };
ee06094f 217 atomic64_t prev_count;
9f66a381 218 u64 irq_period;
ee06094f
IM
219 atomic64_t period_left;
220#endif
0793a61d
TG
221};
222
621a01ea
IM
223struct perf_counter;
224
225/**
226 * struct hw_perf_counter_ops - performance counter hw ops
227 */
228struct hw_perf_counter_ops {
95cdd2e7 229 int (*enable) (struct perf_counter *counter);
7671581f
IM
230 void (*disable) (struct perf_counter *counter);
231 void (*read) (struct perf_counter *counter);
621a01ea
IM
232};
233
6a930700
IM
234/**
235 * enum perf_counter_active_state - the states of a counter
236 */
237enum perf_counter_active_state {
3b6f9e5c 238 PERF_COUNTER_STATE_ERROR = -2,
6a930700
IM
239 PERF_COUNTER_STATE_OFF = -1,
240 PERF_COUNTER_STATE_INACTIVE = 0,
241 PERF_COUNTER_STATE_ACTIVE = 1,
242};
243
9b51f66d
IM
244struct file;
245
7b732a75
PZ
246struct perf_mmap_data {
247 struct rcu_head rcu_head;
248 int nr_pages;
c7138f37 249 atomic_t wakeup;
7b732a75
PZ
250 atomic_t head;
251 struct perf_counter_mmap_page *user_page;
252 void *data_pages[0];
253};
254
0793a61d
TG
255/**
256 * struct perf_counter - performance counter kernel representation:
257 */
258struct perf_counter {
ee06094f 259#ifdef CONFIG_PERF_COUNTERS
04289bb9 260 struct list_head list_entry;
592903cd 261 struct list_head event_entry;
04289bb9
IM
262 struct list_head sibling_list;
263 struct perf_counter *group_leader;
5c92d124 264 const struct hw_perf_counter_ops *hw_ops;
04289bb9 265
6a930700 266 enum perf_counter_active_state state;
c07c99b6 267 enum perf_counter_active_state prev_state;
0793a61d 268 atomic64_t count;
ee06094f 269
9f66a381 270 struct perf_counter_hw_event hw_event;
0793a61d
TG
271 struct hw_perf_counter hw;
272
273 struct perf_counter_context *ctx;
274 struct task_struct *task;
9b51f66d 275 struct file *filp;
0793a61d 276
9b51f66d 277 struct perf_counter *parent;
d859e29f
PM
278 struct list_head child_list;
279
0793a61d 280 /*
d859e29f 281 * Protect attach/detach and child_list:
0793a61d
TG
282 */
283 struct mutex mutex;
284
285 int oncpu;
286 int cpu;
287
7b732a75
PZ
288 /* mmap bits */
289 struct mutex mmap_mutex;
290 atomic_t mmap_count;
291 struct perf_mmap_data *data;
37d81828 292
7b732a75 293 /* poll related */
0793a61d
TG
294 wait_queue_head_t waitq;
295 /* optional: for NMIs */
296 int wakeup_pending;
592903cd 297
e077df4f 298 void (*destroy)(struct perf_counter *);
592903cd 299 struct rcu_head rcu_head;
ee06094f 300#endif
0793a61d
TG
301};
302
303/**
304 * struct perf_counter_context - counter context structure
305 *
306 * Used as a container for task counters and CPU counters as well:
307 */
308struct perf_counter_context {
309#ifdef CONFIG_PERF_COUNTERS
310 /*
d859e29f
PM
311 * Protect the states of the counters in the list,
312 * nr_active, and the list:
0793a61d
TG
313 */
314 spinlock_t lock;
d859e29f
PM
315 /*
316 * Protect the list of counters. Locking either mutex or lock
317 * is sufficient to ensure the list doesn't change; to change
318 * the list you need to lock both the mutex and the spinlock.
319 */
320 struct mutex mutex;
04289bb9
IM
321
322 struct list_head counter_list;
592903cd 323 struct list_head event_list;
0793a61d
TG
324 int nr_counters;
325 int nr_active;
d859e29f 326 int is_active;
0793a61d
TG
327 struct task_struct *task;
328#endif
329};
330
331/**
332 * struct perf_counter_cpu_context - per cpu counter context structure
333 */
334struct perf_cpu_context {
335 struct perf_counter_context ctx;
336 struct perf_counter_context *task_ctx;
337 int active_oncpu;
338 int max_pertask;
3b6f9e5c 339 int exclusive;
96f6d444
PZ
340
341 /*
342 * Recursion avoidance:
343 *
344 * task, softirq, irq, nmi context
345 */
346 int recursion[4];
0793a61d
TG
347};
348
349/*
350 * Set by architecture code:
351 */
352extern int perf_max_counters;
353
354#ifdef CONFIG_PERF_COUNTERS
5c92d124 355extern const struct hw_perf_counter_ops *
621a01ea
IM
356hw_perf_counter_init(struct perf_counter *counter);
357
0793a61d
TG
358extern void perf_counter_task_sched_in(struct task_struct *task, int cpu);
359extern void perf_counter_task_sched_out(struct task_struct *task, int cpu);
360extern void perf_counter_task_tick(struct task_struct *task, int cpu);
9b51f66d
IM
361extern void perf_counter_init_task(struct task_struct *child);
362extern void perf_counter_exit_task(struct task_struct *child);
0793a61d
TG
363extern void perf_counter_notify(struct pt_regs *regs);
364extern void perf_counter_print_debug(void);
1b023a96 365extern void perf_counter_unthrottle(void);
01b2838c
IM
366extern u64 hw_perf_save_disable(void);
367extern void hw_perf_restore(u64 ctrl);
1d1c7ddb
IM
368extern int perf_counter_task_disable(void);
369extern int perf_counter_task_enable(void);
3cbed429
PM
370extern int hw_perf_group_sched_in(struct perf_counter *group_leader,
371 struct perf_cpu_context *cpuctx,
372 struct perf_counter_context *ctx, int cpu);
37d81828 373extern void perf_counter_update_userpage(struct perf_counter *counter);
5c92d124 374
0322cd6e
PZ
375extern void perf_counter_output(struct perf_counter *counter,
376 int nmi, struct pt_regs *regs);
3b6f9e5c
PM
377/*
378 * Return 1 for a software counter, 0 for a hardware counter
379 */
380static inline int is_software_counter(struct perf_counter *counter)
381{
f4a2deb4
PZ
382 return !perf_event_raw(&counter->hw_event) &&
383 perf_event_type(&counter->hw_event) != PERF_TYPE_HARDWARE;
3b6f9e5c
PM
384}
385
b8e83514 386extern void perf_swcounter_event(u32, u64, int, struct pt_regs *);
15dbf27c 387
0793a61d
TG
388#else
389static inline void
390perf_counter_task_sched_in(struct task_struct *task, int cpu) { }
391static inline void
392perf_counter_task_sched_out(struct task_struct *task, int cpu) { }
393static inline void
394perf_counter_task_tick(struct task_struct *task, int cpu) { }
9b51f66d
IM
395static inline void perf_counter_init_task(struct task_struct *child) { }
396static inline void perf_counter_exit_task(struct task_struct *child) { }
0793a61d
TG
397static inline void perf_counter_notify(struct pt_regs *regs) { }
398static inline void perf_counter_print_debug(void) { }
1b023a96 399static inline void perf_counter_unthrottle(void) { }
15dbf27c 400static inline void hw_perf_restore(u64 ctrl) { }
01b2838c 401static inline u64 hw_perf_save_disable(void) { return 0; }
1d1c7ddb
IM
402static inline int perf_counter_task_disable(void) { return -EINVAL; }
403static inline int perf_counter_task_enable(void) { return -EINVAL; }
15dbf27c 404
b8e83514 405static inline void perf_swcounter_event(u32 event, u64 nr,
15dbf27c 406 int nmi, struct pt_regs *regs) { }
0793a61d
TG
407#endif
408
f3dfd265 409#endif /* __KERNEL__ */
0793a61d 410#endif /* _LINUX_PERF_COUNTER_H */