perf: Add non-exec mmap() tracking
[linux-2.6-block.git] / include / linux / perf_event.h
CommitLineData
0793a61d 1/*
57c0c15b 2 * Performance events:
0793a61d 3 *
a308444c
IM
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
0793a61d 7 *
57c0c15b 8 * Data type definitions, declarations, prototypes.
0793a61d 9 *
a308444c 10 * Started by: Thomas Gleixner and Ingo Molnar
0793a61d 11 *
57c0c15b 12 * For licencing details see kernel-base/COPYING
0793a61d 13 */
cdd6c482
IM
14#ifndef _LINUX_PERF_EVENT_H
15#define _LINUX_PERF_EVENT_H
0793a61d 16
f3dfd265
PM
17#include <linux/types.h>
18#include <linux/ioctl.h>
9aaa131a 19#include <asm/byteorder.h>
0793a61d
TG
20
21/*
9f66a381
IM
22 * User-space ABI bits:
23 */
24
25/*
0d48696f 26 * attr.type
0793a61d 27 */
1c432d89 28enum perf_type_id {
a308444c
IM
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,
24f1e32c 34 PERF_TYPE_BREAKPOINT = 5,
b8e83514 35
a308444c 36 PERF_TYPE_MAX, /* non-ABI */
b8e83514 37};
6c594c21 38
b8e83514 39/*
cdd6c482
IM
40 * Generalized performance event event_id types, used by the
41 * attr.event_id parameter of the sys_perf_event_open()
a308444c 42 * syscall:
b8e83514 43 */
1c432d89 44enum perf_hw_id {
9f66a381 45 /*
b8e83514 46 * Common hardware events, generalized by the kernel:
9f66a381 47 */
f4dbfa8f
PZ
48 PERF_COUNT_HW_CPU_CYCLES = 0,
49 PERF_COUNT_HW_INSTRUCTIONS = 1,
50 PERF_COUNT_HW_CACHE_REFERENCES = 2,
51 PERF_COUNT_HW_CACHE_MISSES = 3,
52 PERF_COUNT_HW_BRANCH_INSTRUCTIONS = 4,
53 PERF_COUNT_HW_BRANCH_MISSES = 5,
54 PERF_COUNT_HW_BUS_CYCLES = 6,
55
a308444c 56 PERF_COUNT_HW_MAX, /* non-ABI */
b8e83514 57};
e077df4f 58
8326f44d 59/*
cdd6c482 60 * Generalized hardware cache events:
8326f44d 61 *
8be6e8f3 62 * { L1-D, L1-I, LLC, ITLB, DTLB, BPU } x
8326f44d
IM
63 * { read, write, prefetch } x
64 * { accesses, misses }
65 */
1c432d89 66enum perf_hw_cache_id {
a308444c
IM
67 PERF_COUNT_HW_CACHE_L1D = 0,
68 PERF_COUNT_HW_CACHE_L1I = 1,
69 PERF_COUNT_HW_CACHE_LL = 2,
70 PERF_COUNT_HW_CACHE_DTLB = 3,
71 PERF_COUNT_HW_CACHE_ITLB = 4,
72 PERF_COUNT_HW_CACHE_BPU = 5,
73
74 PERF_COUNT_HW_CACHE_MAX, /* non-ABI */
8326f44d
IM
75};
76
1c432d89 77enum perf_hw_cache_op_id {
a308444c
IM
78 PERF_COUNT_HW_CACHE_OP_READ = 0,
79 PERF_COUNT_HW_CACHE_OP_WRITE = 1,
80 PERF_COUNT_HW_CACHE_OP_PREFETCH = 2,
8326f44d 81
a308444c 82 PERF_COUNT_HW_CACHE_OP_MAX, /* non-ABI */
8326f44d
IM
83};
84
1c432d89
PZ
85enum perf_hw_cache_op_result_id {
86 PERF_COUNT_HW_CACHE_RESULT_ACCESS = 0,
87 PERF_COUNT_HW_CACHE_RESULT_MISS = 1,
8326f44d 88
a308444c 89 PERF_COUNT_HW_CACHE_RESULT_MAX, /* non-ABI */
8326f44d
IM
90};
91
b8e83514 92/*
cdd6c482
IM
93 * Special "software" events provided by the kernel, even if the hardware
94 * does not support performance events. These events measure various
b8e83514
PZ
95 * physical and sw events of the kernel (and allow the profiling of them as
96 * well):
97 */
1c432d89 98enum perf_sw_ids {
a308444c
IM
99 PERF_COUNT_SW_CPU_CLOCK = 0,
100 PERF_COUNT_SW_TASK_CLOCK = 1,
101 PERF_COUNT_SW_PAGE_FAULTS = 2,
102 PERF_COUNT_SW_CONTEXT_SWITCHES = 3,
103 PERF_COUNT_SW_CPU_MIGRATIONS = 4,
104 PERF_COUNT_SW_PAGE_FAULTS_MIN = 5,
105 PERF_COUNT_SW_PAGE_FAULTS_MAJ = 6,
f7d79860
AB
106 PERF_COUNT_SW_ALIGNMENT_FAULTS = 7,
107 PERF_COUNT_SW_EMULATION_FAULTS = 8,
a308444c
IM
108
109 PERF_COUNT_SW_MAX, /* non-ABI */
0793a61d
TG
110};
111
8a057d84 112/*
0d48696f 113 * Bits that can be set in attr.sample_type to request information
8a057d84
PZ
114 * in the overflow packets.
115 */
cdd6c482 116enum perf_event_sample_format {
a308444c
IM
117 PERF_SAMPLE_IP = 1U << 0,
118 PERF_SAMPLE_TID = 1U << 1,
119 PERF_SAMPLE_TIME = 1U << 2,
120 PERF_SAMPLE_ADDR = 1U << 3,
3dab77fb 121 PERF_SAMPLE_READ = 1U << 4,
a308444c
IM
122 PERF_SAMPLE_CALLCHAIN = 1U << 5,
123 PERF_SAMPLE_ID = 1U << 6,
124 PERF_SAMPLE_CPU = 1U << 7,
125 PERF_SAMPLE_PERIOD = 1U << 8,
7f453c24 126 PERF_SAMPLE_STREAM_ID = 1U << 9,
3a43ce68 127 PERF_SAMPLE_RAW = 1U << 10,
974802ea 128
f413cdb8 129 PERF_SAMPLE_MAX = 1U << 11, /* non-ABI */
8a057d84
PZ
130};
131
53cfbf59 132/*
cdd6c482 133 * The format of the data returned by read() on a perf event fd,
3dab77fb
PZ
134 * as specified by attr.read_format:
135 *
136 * struct read_format {
57c0c15b
IM
137 * { u64 value;
138 * { u64 time_enabled; } && PERF_FORMAT_ENABLED
139 * { u64 time_running; } && PERF_FORMAT_RUNNING
140 * { u64 id; } && PERF_FORMAT_ID
141 * } && !PERF_FORMAT_GROUP
3dab77fb 142 *
57c0c15b
IM
143 * { u64 nr;
144 * { u64 time_enabled; } && PERF_FORMAT_ENABLED
145 * { u64 time_running; } && PERF_FORMAT_RUNNING
146 * { u64 value;
147 * { u64 id; } && PERF_FORMAT_ID
148 * } cntr[nr];
149 * } && PERF_FORMAT_GROUP
3dab77fb 150 * };
53cfbf59 151 */
cdd6c482 152enum perf_event_read_format {
a308444c
IM
153 PERF_FORMAT_TOTAL_TIME_ENABLED = 1U << 0,
154 PERF_FORMAT_TOTAL_TIME_RUNNING = 1U << 1,
155 PERF_FORMAT_ID = 1U << 2,
3dab77fb 156 PERF_FORMAT_GROUP = 1U << 3,
974802ea 157
57c0c15b 158 PERF_FORMAT_MAX = 1U << 4, /* non-ABI */
53cfbf59
PM
159};
160
974802ea
PZ
161#define PERF_ATTR_SIZE_VER0 64 /* sizeof first published struct */
162
9f66a381 163/*
cdd6c482 164 * Hardware event_id to monitor via a performance monitoring event:
9f66a381 165 */
cdd6c482 166struct perf_event_attr {
974802ea 167
f4a2deb4 168 /*
a21ca2ca
IM
169 * Major type: hardware/software/tracepoint/etc.
170 */
171 __u32 type;
974802ea
PZ
172
173 /*
174 * Size of the attr structure, for fwd/bwd compat.
175 */
176 __u32 size;
a21ca2ca
IM
177
178 /*
179 * Type specific configuration information.
f4a2deb4
PZ
180 */
181 __u64 config;
9f66a381 182
60db5e09 183 union {
b23f3325
PZ
184 __u64 sample_period;
185 __u64 sample_freq;
60db5e09
PZ
186 };
187
b23f3325
PZ
188 __u64 sample_type;
189 __u64 read_format;
9f66a381 190
2743a5b0 191 __u64 disabled : 1, /* off by default */
0475f9ea
PM
192 inherit : 1, /* children inherit it */
193 pinned : 1, /* must always be on PMU */
194 exclusive : 1, /* only group on PMU */
195 exclude_user : 1, /* don't count user */
196 exclude_kernel : 1, /* ditto kernel */
197 exclude_hv : 1, /* ditto hypervisor */
2743a5b0 198 exclude_idle : 1, /* don't count when idle */
0a4a9391 199 mmap : 1, /* include mmap data */
8d1b2d93 200 comm : 1, /* include comm data */
60db5e09 201 freq : 1, /* use freq, not period */
bfbd3381 202 inherit_stat : 1, /* per task counts */
57e7986e 203 enable_on_exec : 1, /* next exec enables */
9f498cc5 204 task : 1, /* trace fork/exit */
2667de81 205 watermark : 1, /* wakeup_watermark */
ab608344
PZ
206 /*
207 * precise_ip:
208 *
209 * 0 - SAMPLE_IP can have arbitrary skid
210 * 1 - SAMPLE_IP must have constant skid
211 * 2 - SAMPLE_IP requested to have 0 skid
212 * 3 - SAMPLE_IP must have 0 skid
213 *
214 * See also PERF_RECORD_MISC_EXACT_IP
215 */
216 precise_ip : 2, /* skid constraint */
3af9e859 217 mmap_data : 1, /* non-exec mmap data */
ab608344 218
3af9e859 219 __reserved_1 : 46;
2743a5b0 220
2667de81
PZ
221 union {
222 __u32 wakeup_events; /* wakeup every n events */
223 __u32 wakeup_watermark; /* bytes before wakeup */
224 };
24f1e32c 225
f13c12c6 226 __u32 bp_type;
cd757645
MS
227 __u64 bp_addr;
228 __u64 bp_len;
eab656ae
TG
229};
230
d859e29f 231/*
cdd6c482 232 * Ioctls that can be done on a perf event fd:
d859e29f 233 */
cdd6c482 234#define PERF_EVENT_IOC_ENABLE _IO ('$', 0)
57c0c15b
IM
235#define PERF_EVENT_IOC_DISABLE _IO ('$', 1)
236#define PERF_EVENT_IOC_REFRESH _IO ('$', 2)
cdd6c482 237#define PERF_EVENT_IOC_RESET _IO ('$', 3)
4c49b128 238#define PERF_EVENT_IOC_PERIOD _IOW('$', 4, __u64)
cdd6c482 239#define PERF_EVENT_IOC_SET_OUTPUT _IO ('$', 5)
6fb2915d 240#define PERF_EVENT_IOC_SET_FILTER _IOW('$', 6, char *)
cdd6c482
IM
241
242enum perf_event_ioc_flags {
3df5edad
PZ
243 PERF_IOC_FLAG_GROUP = 1U << 0,
244};
d859e29f 245
37d81828
PM
246/*
247 * Structure of the page that can be mapped via mmap
248 */
cdd6c482 249struct perf_event_mmap_page {
37d81828
PM
250 __u32 version; /* version number of this structure */
251 __u32 compat_version; /* lowest version this is compat with */
38ff667b
PZ
252
253 /*
cdd6c482 254 * Bits needed to read the hw events in user-space.
38ff667b 255 *
92f22a38
PZ
256 * u32 seq;
257 * s64 count;
38ff667b 258 *
a2e87d06
PZ
259 * do {
260 * seq = pc->lock;
38ff667b 261 *
a2e87d06
PZ
262 * barrier()
263 * if (pc->index) {
264 * count = pmc_read(pc->index - 1);
265 * count += pc->offset;
266 * } else
267 * goto regular_read;
38ff667b 268 *
a2e87d06
PZ
269 * barrier();
270 * } while (pc->lock != seq);
38ff667b 271 *
92f22a38
PZ
272 * NOTE: for obvious reason this only works on self-monitoring
273 * processes.
38ff667b 274 */
37d81828 275 __u32 lock; /* seqlock for synchronization */
cdd6c482
IM
276 __u32 index; /* hardware event identifier */
277 __s64 offset; /* add to hardware event value */
278 __u64 time_enabled; /* time event active */
279 __u64 time_running; /* time event on cpu */
7b732a75 280
41f95331
PZ
281 /*
282 * Hole for extension of the self monitor capabilities
283 */
284
7f8b4e4e 285 __u64 __reserved[123]; /* align to 1k */
41f95331 286
38ff667b
PZ
287 /*
288 * Control data for the mmap() data buffer.
289 *
43a21ea8
PZ
290 * User-space reading the @data_head value should issue an rmb(), on
291 * SMP capable platforms, after reading this value -- see
cdd6c482 292 * perf_event_wakeup().
43a21ea8
PZ
293 *
294 * When the mapping is PROT_WRITE the @data_tail value should be
295 * written by userspace to reflect the last read data. In this case
296 * the kernel will not over-write unread data.
38ff667b 297 */
8e3747c1 298 __u64 data_head; /* head in the data section */
43a21ea8 299 __u64 data_tail; /* user-space written tail */
37d81828
PM
300};
301
39447b38 302#define PERF_RECORD_MISC_CPUMODE_MASK (7 << 0)
184f412c 303#define PERF_RECORD_MISC_CPUMODE_UNKNOWN (0 << 0)
cdd6c482
IM
304#define PERF_RECORD_MISC_KERNEL (1 << 0)
305#define PERF_RECORD_MISC_USER (2 << 0)
306#define PERF_RECORD_MISC_HYPERVISOR (3 << 0)
39447b38
ZY
307#define PERF_RECORD_MISC_GUEST_KERNEL (4 << 0)
308#define PERF_RECORD_MISC_GUEST_USER (5 << 0)
6fab0192 309
ab608344
PZ
310/*
311 * Indicates that the content of PERF_SAMPLE_IP points to
312 * the actual instruction that triggered the event. See also
313 * perf_event_attr::precise_ip.
314 */
315#define PERF_RECORD_MISC_EXACT_IP (1 << 14)
ef21f683
PZ
316/*
317 * Reserve the last bit to indicate some extended misc field
318 */
319#define PERF_RECORD_MISC_EXT_RESERVED (1 << 15)
320
5c148194
PZ
321struct perf_event_header {
322 __u32 type;
6fab0192
PZ
323 __u16 misc;
324 __u16 size;
5c148194
PZ
325};
326
327enum perf_event_type {
5ed00415 328
0c593b34
PZ
329 /*
330 * The MMAP events record the PROT_EXEC mappings so that we can
331 * correlate userspace IPs to code. They have the following structure:
332 *
333 * struct {
0127c3ea 334 * struct perf_event_header header;
0c593b34 335 *
0127c3ea
IM
336 * u32 pid, tid;
337 * u64 addr;
338 * u64 len;
339 * u64 pgoff;
340 * char filename[];
0c593b34
PZ
341 * };
342 */
cdd6c482 343 PERF_RECORD_MMAP = 1,
0a4a9391 344
43a21ea8
PZ
345 /*
346 * struct {
57c0c15b
IM
347 * struct perf_event_header header;
348 * u64 id;
349 * u64 lost;
43a21ea8
PZ
350 * };
351 */
cdd6c482 352 PERF_RECORD_LOST = 2,
43a21ea8 353
8d1b2d93
PZ
354 /*
355 * struct {
0127c3ea 356 * struct perf_event_header header;
8d1b2d93 357 *
0127c3ea
IM
358 * u32 pid, tid;
359 * char comm[];
8d1b2d93
PZ
360 * };
361 */
cdd6c482 362 PERF_RECORD_COMM = 3,
8d1b2d93 363
9f498cc5
PZ
364 /*
365 * struct {
366 * struct perf_event_header header;
367 * u32 pid, ppid;
368 * u32 tid, ptid;
393b2ad8 369 * u64 time;
9f498cc5
PZ
370 * };
371 */
cdd6c482 372 PERF_RECORD_EXIT = 4,
9f498cc5 373
26b119bc
PZ
374 /*
375 * struct {
0127c3ea
IM
376 * struct perf_event_header header;
377 * u64 time;
689802b2 378 * u64 id;
7f453c24 379 * u64 stream_id;
a78ac325
PZ
380 * };
381 */
184f412c
IM
382 PERF_RECORD_THROTTLE = 5,
383 PERF_RECORD_UNTHROTTLE = 6,
a78ac325 384
60313ebe
PZ
385 /*
386 * struct {
a21ca2ca
IM
387 * struct perf_event_header header;
388 * u32 pid, ppid;
9f498cc5 389 * u32 tid, ptid;
a6f10a2f 390 * u64 time;
60313ebe
PZ
391 * };
392 */
cdd6c482 393 PERF_RECORD_FORK = 7,
60313ebe 394
38b200d6
PZ
395 /*
396 * struct {
184f412c
IM
397 * struct perf_event_header header;
398 * u32 pid, tid;
3dab77fb 399 *
184f412c 400 * struct read_format values;
38b200d6
PZ
401 * };
402 */
cdd6c482 403 PERF_RECORD_READ = 8,
38b200d6 404
8a057d84 405 /*
0c593b34 406 * struct {
0127c3ea 407 * struct perf_event_header header;
0c593b34 408 *
43a21ea8
PZ
409 * { u64 ip; } && PERF_SAMPLE_IP
410 * { u32 pid, tid; } && PERF_SAMPLE_TID
411 * { u64 time; } && PERF_SAMPLE_TIME
412 * { u64 addr; } && PERF_SAMPLE_ADDR
e6e18ec7 413 * { u64 id; } && PERF_SAMPLE_ID
7f453c24 414 * { u64 stream_id;} && PERF_SAMPLE_STREAM_ID
43a21ea8 415 * { u32 cpu, res; } && PERF_SAMPLE_CPU
57c0c15b 416 * { u64 period; } && PERF_SAMPLE_PERIOD
0c593b34 417 *
3dab77fb 418 * { struct read_format values; } && PERF_SAMPLE_READ
0c593b34 419 *
f9188e02 420 * { u64 nr,
43a21ea8 421 * u64 ips[nr]; } && PERF_SAMPLE_CALLCHAIN
3dab77fb 422 *
57c0c15b
IM
423 * #
424 * # The RAW record below is opaque data wrt the ABI
425 * #
426 * # That is, the ABI doesn't make any promises wrt to
427 * # the stability of its content, it may vary depending
428 * # on event, hardware, kernel version and phase of
429 * # the moon.
430 * #
431 * # In other words, PERF_SAMPLE_RAW contents are not an ABI.
432 * #
3dab77fb 433 *
a044560c
PZ
434 * { u32 size;
435 * char data[size];}&& PERF_SAMPLE_RAW
0c593b34 436 * };
8a057d84 437 */
184f412c 438 PERF_RECORD_SAMPLE = 9,
e6e18ec7 439
cdd6c482 440 PERF_RECORD_MAX, /* non-ABI */
5c148194
PZ
441};
442
f9188e02
PZ
443enum perf_callchain_context {
444 PERF_CONTEXT_HV = (__u64)-32,
445 PERF_CONTEXT_KERNEL = (__u64)-128,
446 PERF_CONTEXT_USER = (__u64)-512,
7522060c 447
f9188e02
PZ
448 PERF_CONTEXT_GUEST = (__u64)-2048,
449 PERF_CONTEXT_GUEST_KERNEL = (__u64)-2176,
450 PERF_CONTEXT_GUEST_USER = (__u64)-2560,
451
452 PERF_CONTEXT_MAX = (__u64)-4095,
7522060c
IM
453};
454
a4be7c27
PZ
455#define PERF_FLAG_FD_NO_GROUP (1U << 0)
456#define PERF_FLAG_FD_OUTPUT (1U << 1)
457
f3dfd265 458#ifdef __KERNEL__
9f66a381 459/*
f3dfd265 460 * Kernel-internal data types and definitions:
9f66a381
IM
461 */
462
cdd6c482
IM
463#ifdef CONFIG_PERF_EVENTS
464# include <asm/perf_event.h>
f3dfd265
PM
465#endif
466
39447b38
ZY
467struct perf_guest_info_callbacks {
468 int (*is_in_guest) (void);
469 int (*is_user_mode) (void);
470 unsigned long (*get_guest_ip) (void);
471};
472
2ff6cfd7
AB
473#ifdef CONFIG_HAVE_HW_BREAKPOINT
474#include <asm/hw_breakpoint.h>
475#endif
476
f3dfd265
PM
477#include <linux/list.h>
478#include <linux/mutex.h>
479#include <linux/rculist.h>
480#include <linux/rcupdate.h>
481#include <linux/spinlock.h>
d6d020e9 482#include <linux/hrtimer.h>
3c446b3d 483#include <linux/fs.h>
709e50cf 484#include <linux/pid_namespace.h>
906010b2 485#include <linux/workqueue.h>
5331d7b8 486#include <linux/ftrace.h>
85cfabbc 487#include <linux/cpu.h>
f3dfd265 488#include <asm/atomic.h>
fa588151 489#include <asm/local.h>
f3dfd265 490
f9188e02
PZ
491#define PERF_MAX_STACK_DEPTH 255
492
493struct perf_callchain_entry {
494 __u64 nr;
495 __u64 ip[PERF_MAX_STACK_DEPTH];
496};
497
3a43ce68
FW
498struct perf_raw_record {
499 u32 size;
500 void *data;
f413cdb8
FW
501};
502
caff2bef
PZ
503struct perf_branch_entry {
504 __u64 from;
505 __u64 to;
506 __u64 flags;
507};
508
509struct perf_branch_stack {
510 __u64 nr;
511 struct perf_branch_entry entries[0];
512};
513
f3dfd265
PM
514struct task_struct;
515
0793a61d 516/**
cdd6c482 517 * struct hw_perf_event - performance event hardware details:
0793a61d 518 */
cdd6c482
IM
519struct hw_perf_event {
520#ifdef CONFIG_PERF_EVENTS
d6d020e9
PZ
521 union {
522 struct { /* hardware */
a308444c 523 u64 config;
447a194b 524 u64 last_tag;
a308444c 525 unsigned long config_base;
cdd6c482 526 unsigned long event_base;
a308444c 527 int idx;
447a194b 528 int last_cpu;
d6d020e9 529 };
721a669b
SS
530 struct { /* software */
531 s64 remaining;
a308444c 532 struct hrtimer hrtimer;
d6d020e9 533 };
24f1e32c 534#ifdef CONFIG_HAVE_HW_BREAKPOINT
dd8b1cf6
FW
535 /* breakpoint */
536 struct arch_hw_breakpoint info;
24f1e32c 537#endif
d6d020e9 538 };
ee06094f 539 atomic64_t prev_count;
b23f3325 540 u64 sample_period;
9e350de3 541 u64 last_period;
ee06094f 542 atomic64_t period_left;
60db5e09 543 u64 interrupts;
6a24ed6c 544
abd50713
PZ
545 u64 freq_time_stamp;
546 u64 freq_count_stamp;
ee06094f 547#endif
0793a61d
TG
548};
549
cdd6c482 550struct perf_event;
621a01ea 551
6bde9b6c
LM
552#define PERF_EVENT_TXN_STARTED 1
553
621a01ea 554/**
4aeb0b42 555 * struct pmu - generic performance monitoring unit
621a01ea 556 */
4aeb0b42 557struct pmu {
cdd6c482
IM
558 int (*enable) (struct perf_event *event);
559 void (*disable) (struct perf_event *event);
d76a0812
SE
560 int (*start) (struct perf_event *event);
561 void (*stop) (struct perf_event *event);
cdd6c482
IM
562 void (*read) (struct perf_event *event);
563 void (*unthrottle) (struct perf_event *event);
6bde9b6c
LM
564
565 /*
566 * group events scheduling is treated as a transaction,
567 * add group events as a whole and perform one schedulability test.
568 * If test fails, roll back the whole group
569 */
570
571 void (*start_txn) (const struct pmu *pmu);
572 void (*cancel_txn) (const struct pmu *pmu);
573 int (*commit_txn) (const struct pmu *pmu);
621a01ea
IM
574};
575
6a930700 576/**
cdd6c482 577 * enum perf_event_active_state - the states of a event
6a930700 578 */
cdd6c482 579enum perf_event_active_state {
57c0c15b 580 PERF_EVENT_STATE_ERROR = -2,
cdd6c482
IM
581 PERF_EVENT_STATE_OFF = -1,
582 PERF_EVENT_STATE_INACTIVE = 0,
57c0c15b 583 PERF_EVENT_STATE_ACTIVE = 1,
6a930700
IM
584};
585
9b51f66d
IM
586struct file;
587
7b732a75 588struct perf_mmap_data {
ac9721f3 589 atomic_t refcount;
7b732a75 590 struct rcu_head rcu_head;
906010b2
PZ
591#ifdef CONFIG_PERF_USE_VMALLOC
592 struct work_struct work;
3cafa9fb 593 int page_order; /* allocation order */
906010b2 594#endif
8740f941 595 int nr_pages; /* nr of data pages */
43a21ea8 596 int writable; /* are we writable */
8740f941 597
c33a0bc4 598 atomic_t poll; /* POLL_ for wakeups */
8740f941 599
fa588151
PZ
600 local_t head; /* write position */
601 local_t nest; /* nested writers */
602 local_t events; /* event limit */
adb8e118 603 local_t wakeup; /* wakeup stamp */
fa588151 604 local_t lost; /* nr records lost */
ef60777c 605
2667de81
PZ
606 long watermark; /* wakeup watermark */
607
57c0c15b 608 struct perf_event_mmap_page *user_page;
0127c3ea 609 void *data_pages[0];
7b732a75
PZ
610};
611
671dec5d
PZ
612struct perf_pending_entry {
613 struct perf_pending_entry *next;
614 void (*func)(struct perf_pending_entry *);
925d519a
PZ
615};
616
453f19ee
PZ
617struct perf_sample_data;
618
b326e956
FW
619typedef void (*perf_overflow_handler_t)(struct perf_event *, int,
620 struct perf_sample_data *,
621 struct pt_regs *regs);
622
d6f962b5
FW
623enum perf_group_flag {
624 PERF_GROUP_SOFTWARE = 0x1,
625};
626
76e1d904
FW
627#define SWEVENT_HLIST_BITS 8
628#define SWEVENT_HLIST_SIZE (1 << SWEVENT_HLIST_BITS)
629
630struct swevent_hlist {
631 struct hlist_head heads[SWEVENT_HLIST_SIZE];
632 struct rcu_head rcu_head;
633};
634
8a49542c
PZ
635#define PERF_ATTACH_CONTEXT 0x01
636#define PERF_ATTACH_GROUP 0x02
637
0793a61d 638/**
cdd6c482 639 * struct perf_event - performance event kernel representation:
0793a61d 640 */
cdd6c482
IM
641struct perf_event {
642#ifdef CONFIG_PERF_EVENTS
65abc865 643 struct list_head group_entry;
592903cd 644 struct list_head event_entry;
04289bb9 645 struct list_head sibling_list;
76e1d904 646 struct hlist_node hlist_entry;
0127c3ea 647 int nr_siblings;
d6f962b5 648 int group_flags;
cdd6c482 649 struct perf_event *group_leader;
4aeb0b42 650 const struct pmu *pmu;
04289bb9 651
cdd6c482 652 enum perf_event_active_state state;
8a49542c 653 unsigned int attach_state;
0793a61d 654 atomic64_t count;
ee06094f 655
53cfbf59 656 /*
cdd6c482 657 * These are the total time in nanoseconds that the event
53cfbf59 658 * has been enabled (i.e. eligible to run, and the task has
cdd6c482 659 * been scheduled in, if this is a per-task event)
53cfbf59
PM
660 * and running (scheduled onto the CPU), respectively.
661 *
662 * They are computed from tstamp_enabled, tstamp_running and
cdd6c482 663 * tstamp_stopped when the event is in INACTIVE or ACTIVE state.
53cfbf59
PM
664 */
665 u64 total_time_enabled;
666 u64 total_time_running;
667
668 /*
669 * These are timestamps used for computing total_time_enabled
cdd6c482 670 * and total_time_running when the event is in INACTIVE or
53cfbf59
PM
671 * ACTIVE state, measured in nanoseconds from an arbitrary point
672 * in time.
cdd6c482
IM
673 * tstamp_enabled: the notional time when the event was enabled
674 * tstamp_running: the notional time when the event was scheduled on
53cfbf59 675 * tstamp_stopped: in INACTIVE state, the notional time when the
cdd6c482 676 * event was scheduled off.
53cfbf59
PM
677 */
678 u64 tstamp_enabled;
679 u64 tstamp_running;
680 u64 tstamp_stopped;
681
24f1e32c 682 struct perf_event_attr attr;
cdd6c482 683 struct hw_perf_event hw;
0793a61d 684
cdd6c482 685 struct perf_event_context *ctx;
9b51f66d 686 struct file *filp;
0793a61d 687
53cfbf59
PM
688 /*
689 * These accumulate total time (in nanoseconds) that children
cdd6c482 690 * events have been enabled and running, respectively.
53cfbf59
PM
691 */
692 atomic64_t child_total_time_enabled;
693 atomic64_t child_total_time_running;
694
0793a61d 695 /*
d859e29f 696 * Protect attach/detach and child_list:
0793a61d 697 */
fccc714b
PZ
698 struct mutex child_mutex;
699 struct list_head child_list;
cdd6c482 700 struct perf_event *parent;
0793a61d
TG
701
702 int oncpu;
703 int cpu;
704
082ff5a2
PZ
705 struct list_head owner_entry;
706 struct task_struct *owner;
707
7b732a75
PZ
708 /* mmap bits */
709 struct mutex mmap_mutex;
710 atomic_t mmap_count;
ac9721f3
PZ
711 int mmap_locked;
712 struct user_struct *mmap_user;
7b732a75 713 struct perf_mmap_data *data;
37d81828 714
7b732a75 715 /* poll related */
0793a61d 716 wait_queue_head_t waitq;
3c446b3d 717 struct fasync_struct *fasync;
79f14641
PZ
718
719 /* delayed work for NMIs and such */
720 int pending_wakeup;
4c9e2542 721 int pending_kill;
79f14641 722 int pending_disable;
671dec5d 723 struct perf_pending_entry pending;
592903cd 724
79f14641
PZ
725 atomic_t event_limit;
726
cdd6c482 727 void (*destroy)(struct perf_event *);
592903cd 728 struct rcu_head rcu_head;
709e50cf
PZ
729
730 struct pid_namespace *ns;
8e5799b1 731 u64 id;
6fb2915d 732
b326e956 733 perf_overflow_handler_t overflow_handler;
453f19ee 734
07b139c8 735#ifdef CONFIG_EVENT_TRACING
1c024eca 736 struct ftrace_event_call *tp_event;
6fb2915d 737 struct event_filter *filter;
ee06094f 738#endif
6fb2915d
LZ
739
740#endif /* CONFIG_PERF_EVENTS */
0793a61d
TG
741};
742
743/**
cdd6c482 744 * struct perf_event_context - event context structure
0793a61d 745 *
cdd6c482 746 * Used as a container for task events and CPU events as well:
0793a61d 747 */
cdd6c482 748struct perf_event_context {
0793a61d 749 /*
cdd6c482 750 * Protect the states of the events in the list,
d859e29f 751 * nr_active, and the list:
0793a61d 752 */
e625cce1 753 raw_spinlock_t lock;
d859e29f 754 /*
cdd6c482 755 * Protect the list of events. Locking either mutex or lock
d859e29f
PM
756 * is sufficient to ensure the list doesn't change; to change
757 * the list you need to lock both the mutex and the spinlock.
758 */
a308444c 759 struct mutex mutex;
04289bb9 760
889ff015
FW
761 struct list_head pinned_groups;
762 struct list_head flexible_groups;
a308444c 763 struct list_head event_list;
cdd6c482 764 int nr_events;
a308444c
IM
765 int nr_active;
766 int is_active;
bfbd3381 767 int nr_stat;
a308444c
IM
768 atomic_t refcount;
769 struct task_struct *task;
53cfbf59
PM
770
771 /*
4af4998b 772 * Context clock, runs when context enabled.
53cfbf59 773 */
a308444c
IM
774 u64 time;
775 u64 timestamp;
564c2b21
PM
776
777 /*
778 * These fields let us detect when two contexts have both
779 * been cloned (inherited) from a common ancestor.
780 */
cdd6c482 781 struct perf_event_context *parent_ctx;
a308444c
IM
782 u64 parent_gen;
783 u64 generation;
784 int pin_count;
785 struct rcu_head rcu_head;
0793a61d
TG
786};
787
788/**
cdd6c482 789 * struct perf_event_cpu_context - per cpu event context structure
0793a61d
TG
790 */
791struct perf_cpu_context {
cdd6c482
IM
792 struct perf_event_context ctx;
793 struct perf_event_context *task_ctx;
0793a61d
TG
794 int active_oncpu;
795 int max_pertask;
3b6f9e5c 796 int exclusive;
76e1d904
FW
797 struct swevent_hlist *swevent_hlist;
798 struct mutex hlist_mutex;
799 int hlist_refcount;
96f6d444
PZ
800
801 /*
802 * Recursion avoidance:
803 *
804 * task, softirq, irq, nmi context
805 */
22a4f650 806 int recursion[4];
0793a61d
TG
807};
808
5622f295 809struct perf_output_handle {
57c0c15b
IM
810 struct perf_event *event;
811 struct perf_mmap_data *data;
6d1acfd5 812 unsigned long wakeup;
5d967a8b
PZ
813 unsigned long size;
814 void *addr;
815 int page;
57c0c15b
IM
816 int nmi;
817 int sample;
5622f295
MM
818};
819
cdd6c482 820#ifdef CONFIG_PERF_EVENTS
829b42dd 821
0793a61d
TG
822/*
823 * Set by architecture code:
824 */
cdd6c482 825extern int perf_max_events;
0793a61d 826
cdd6c482 827extern const struct pmu *hw_perf_event_init(struct perf_event *event);
621a01ea 828
49f47433 829extern void perf_event_task_sched_in(struct task_struct *task);
184f412c 830extern void perf_event_task_sched_out(struct task_struct *task, struct task_struct *next);
49f47433 831extern void perf_event_task_tick(struct task_struct *task);
cdd6c482
IM
832extern int perf_event_init_task(struct task_struct *child);
833extern void perf_event_exit_task(struct task_struct *child);
834extern void perf_event_free_task(struct task_struct *task);
835extern void set_perf_event_pending(void);
836extern void perf_event_do_pending(void);
837extern void perf_event_print_debug(void);
9e35ad38
PZ
838extern void __perf_disable(void);
839extern bool __perf_enable(void);
840extern void perf_disable(void);
841extern void perf_enable(void);
cdd6c482
IM
842extern int perf_event_task_disable(void);
843extern int perf_event_task_enable(void);
cdd6c482 844extern void perf_event_update_userpage(struct perf_event *event);
fb0459d7
AV
845extern int perf_event_release_kernel(struct perf_event *event);
846extern struct perf_event *
847perf_event_create_kernel_counter(struct perf_event_attr *attr,
848 int cpu,
97eaf530 849 pid_t pid,
b326e956 850 perf_overflow_handler_t callback);
59ed446f
PZ
851extern u64 perf_event_read_value(struct perf_event *event,
852 u64 *enabled, u64 *running);
5c92d124 853
df1a132b 854struct perf_sample_data {
5622f295
MM
855 u64 type;
856
857 u64 ip;
858 struct {
859 u32 pid;
860 u32 tid;
861 } tid_entry;
862 u64 time;
a308444c 863 u64 addr;
5622f295
MM
864 u64 id;
865 u64 stream_id;
866 struct {
867 u32 cpu;
868 u32 reserved;
869 } cpu_entry;
a308444c 870 u64 period;
5622f295 871 struct perf_callchain_entry *callchain;
3a43ce68 872 struct perf_raw_record *raw;
df1a132b
PZ
873};
874
dc1d628a
PZ
875static inline
876void perf_sample_data_init(struct perf_sample_data *data, u64 addr)
877{
878 data->addr = addr;
879 data->raw = NULL;
880}
881
5622f295
MM
882extern void perf_output_sample(struct perf_output_handle *handle,
883 struct perf_event_header *header,
884 struct perf_sample_data *data,
cdd6c482 885 struct perf_event *event);
5622f295
MM
886extern void perf_prepare_sample(struct perf_event_header *header,
887 struct perf_sample_data *data,
cdd6c482 888 struct perf_event *event,
5622f295
MM
889 struct pt_regs *regs);
890
cdd6c482 891extern int perf_event_overflow(struct perf_event *event, int nmi,
5622f295
MM
892 struct perf_sample_data *data,
893 struct pt_regs *regs);
df1a132b 894
3b6f9e5c 895/*
cdd6c482 896 * Return 1 for a software event, 0 for a hardware event
3b6f9e5c 897 */
cdd6c482 898static inline int is_software_event(struct perf_event *event)
3b6f9e5c 899{
92b67598
PZ
900 switch (event->attr.type) {
901 case PERF_TYPE_SOFTWARE:
902 case PERF_TYPE_TRACEPOINT:
903 /* for now the breakpoint stuff also works as software event */
904 case PERF_TYPE_BREAKPOINT:
905 return 1;
906 }
907 return 0;
3b6f9e5c
PM
908}
909
cdd6c482 910extern atomic_t perf_swevent_enabled[PERF_COUNT_SW_MAX];
f29ac756 911
cdd6c482 912extern void __perf_sw_event(u32, u64, int, struct pt_regs *, u64);
f29ac756 913
5331d7b8
FW
914extern void
915perf_arch_fetch_caller_regs(struct pt_regs *regs, unsigned long ip, int skip);
916
917/*
918 * Take a snapshot of the regs. Skip ip and frame pointer to
919 * the nth caller. We only need a few of the regs:
920 * - ip for PERF_SAMPLE_IP
921 * - cs for user_mode() tests
922 * - bp for callchains
923 * - eflags, for future purposes, just in case
924 */
925static inline void perf_fetch_caller_regs(struct pt_regs *regs, int skip)
926{
927 unsigned long ip;
928
929 memset(regs, 0, sizeof(*regs));
930
931 switch (skip) {
932 case 1 :
933 ip = CALLER_ADDR0;
934 break;
935 case 2 :
936 ip = CALLER_ADDR1;
937 break;
938 case 3 :
939 ip = CALLER_ADDR2;
940 break;
941 case 4:
942 ip = CALLER_ADDR3;
943 break;
944 /* No need to support further for now */
945 default:
946 ip = 0;
947 }
948
949 return perf_arch_fetch_caller_regs(regs, ip, skip);
950}
951
e49a5bd3
FW
952static inline void
953perf_sw_event(u32 event_id, u64 nr, int nmi, struct pt_regs *regs, u64 addr)
954{
955 if (atomic_read(&perf_swevent_enabled[event_id])) {
956 struct pt_regs hot_regs;
957
958 if (!regs) {
959 perf_fetch_caller_regs(&hot_regs, 1);
960 regs = &hot_regs;
961 }
962 __perf_sw_event(event_id, nr, nmi, regs, addr);
963 }
964}
965
3af9e859 966extern void perf_event_mmap(struct vm_area_struct *vma);
39447b38 967extern struct perf_guest_info_callbacks *perf_guest_cbs;
dcf46b94
ZY
968extern int perf_register_guest_info_callbacks(struct perf_guest_info_callbacks *callbacks);
969extern int perf_unregister_guest_info_callbacks(struct perf_guest_info_callbacks *callbacks);
39447b38 970
cdd6c482
IM
971extern void perf_event_comm(struct task_struct *tsk);
972extern void perf_event_fork(struct task_struct *tsk);
8d1b2d93 973
394ee076
PZ
974extern struct perf_callchain_entry *perf_callchain(struct pt_regs *regs);
975
cdd6c482
IM
976extern int sysctl_perf_event_paranoid;
977extern int sysctl_perf_event_mlock;
978extern int sysctl_perf_event_sample_rate;
1ccd1549 979
320ebf09
PZ
980static inline bool perf_paranoid_tracepoint_raw(void)
981{
982 return sysctl_perf_event_paranoid > -1;
983}
984
985static inline bool perf_paranoid_cpu(void)
986{
987 return sysctl_perf_event_paranoid > 0;
988}
989
990static inline bool perf_paranoid_kernel(void)
991{
992 return sysctl_perf_event_paranoid > 1;
993}
994
cdd6c482 995extern void perf_event_init(void);
1c024eca
PZ
996extern void perf_tp_event(u64 addr, u64 count, void *record,
997 int entry_size, struct pt_regs *regs,
ecc55f84 998 struct hlist_head *head, int rctx);
24f1e32c 999extern void perf_bp_event(struct perf_event *event, void *data);
0d905bca 1000
9d23a90a 1001#ifndef perf_misc_flags
cdd6c482
IM
1002#define perf_misc_flags(regs) (user_mode(regs) ? PERF_RECORD_MISC_USER : \
1003 PERF_RECORD_MISC_KERNEL)
9d23a90a
PM
1004#define perf_instruction_pointer(regs) instruction_pointer(regs)
1005#endif
1006
5622f295 1007extern int perf_output_begin(struct perf_output_handle *handle,
cdd6c482 1008 struct perf_event *event, unsigned int size,
5622f295
MM
1009 int nmi, int sample);
1010extern void perf_output_end(struct perf_output_handle *handle);
1011extern void perf_output_copy(struct perf_output_handle *handle,
1012 const void *buf, unsigned int len);
4ed7c92d
PZ
1013extern int perf_swevent_get_recursion_context(void);
1014extern void perf_swevent_put_recursion_context(int rctx);
44234adc
FW
1015extern void perf_event_enable(struct perf_event *event);
1016extern void perf_event_disable(struct perf_event *event);
0793a61d
TG
1017#else
1018static inline void
49f47433 1019perf_event_task_sched_in(struct task_struct *task) { }
0793a61d 1020static inline void
cdd6c482 1021perf_event_task_sched_out(struct task_struct *task,
49f47433 1022 struct task_struct *next) { }
0793a61d 1023static inline void
49f47433 1024perf_event_task_tick(struct task_struct *task) { }
cdd6c482
IM
1025static inline int perf_event_init_task(struct task_struct *child) { return 0; }
1026static inline void perf_event_exit_task(struct task_struct *child) { }
1027static inline void perf_event_free_task(struct task_struct *task) { }
57c0c15b
IM
1028static inline void perf_event_do_pending(void) { }
1029static inline void perf_event_print_debug(void) { }
9e35ad38
PZ
1030static inline void perf_disable(void) { }
1031static inline void perf_enable(void) { }
57c0c15b
IM
1032static inline int perf_event_task_disable(void) { return -EINVAL; }
1033static inline int perf_event_task_enable(void) { return -EINVAL; }
15dbf27c 1034
925d519a 1035static inline void
cdd6c482 1036perf_sw_event(u32 event_id, u64 nr, int nmi,
78f13e95 1037 struct pt_regs *regs, u64 addr) { }
24f1e32c 1038static inline void
184f412c 1039perf_bp_event(struct perf_event *event, void *data) { }
0a4a9391 1040
39447b38 1041static inline int perf_register_guest_info_callbacks
dcf46b94 1042(struct perf_guest_info_callbacks *callbacks) { return 0; }
39447b38 1043static inline int perf_unregister_guest_info_callbacks
dcf46b94 1044(struct perf_guest_info_callbacks *callbacks) { return 0; }
39447b38 1045
57c0c15b 1046static inline void perf_event_mmap(struct vm_area_struct *vma) { }
cdd6c482
IM
1047static inline void perf_event_comm(struct task_struct *tsk) { }
1048static inline void perf_event_fork(struct task_struct *tsk) { }
1049static inline void perf_event_init(void) { }
184f412c 1050static inline int perf_swevent_get_recursion_context(void) { return -1; }
4ed7c92d 1051static inline void perf_swevent_put_recursion_context(int rctx) { }
44234adc
FW
1052static inline void perf_event_enable(struct perf_event *event) { }
1053static inline void perf_event_disable(struct perf_event *event) { }
0793a61d
TG
1054#endif
1055
5622f295
MM
1056#define perf_output_put(handle, x) \
1057 perf_output_copy((handle), &(x), sizeof(x))
1058
3f6da390
PZ
1059/*
1060 * This has to have a higher priority than migration_notifier in sched.c.
1061 */
1062#define perf_cpu_notifier(fn) \
1063do { \
1064 static struct notifier_block fn##_nb __cpuinitdata = \
1065 { .notifier_call = fn, .priority = 20 }; \
1066 fn(&fn##_nb, (unsigned long)CPU_UP_PREPARE, \
1067 (void *)(unsigned long)smp_processor_id()); \
1068 fn(&fn##_nb, (unsigned long)CPU_STARTING, \
1069 (void *)(unsigned long)smp_processor_id()); \
1070 fn(&fn##_nb, (unsigned long)CPU_ONLINE, \
1071 (void *)(unsigned long)smp_processor_id()); \
1072 register_cpu_notifier(&fn##_nb); \
1073} while (0)
1074
f3dfd265 1075#endif /* __KERNEL__ */
cdd6c482 1076#endif /* _LINUX_PERF_EVENT_H */