perf_event.h 24.1 KB
Newer Older
T
Thomas Gleixner 已提交
1
/*
I
Ingo Molnar 已提交
2
 * Performance events:
T
Thomas Gleixner 已提交
3
 *
I
Ingo Molnar 已提交
4 5 6
 *    Copyright (C) 2008-2009, Thomas Gleixner <tglx@linutronix.de>
 *    Copyright (C) 2008-2009, Red Hat, Inc., Ingo Molnar
 *    Copyright (C) 2008-2009, Red Hat, Inc., Peter Zijlstra
T
Thomas Gleixner 已提交
7
 *
I
Ingo Molnar 已提交
8
 * Data type definitions, declarations, prototypes.
T
Thomas Gleixner 已提交
9
 *
I
Ingo Molnar 已提交
10
 *    Started by: Thomas Gleixner and Ingo Molnar
T
Thomas Gleixner 已提交
11
 *
I
Ingo Molnar 已提交
12
 * For licencing details see kernel-base/COPYING
T
Thomas Gleixner 已提交
13
 */
14 15
#ifndef _LINUX_PERF_EVENT_H
#define _LINUX_PERF_EVENT_H
T
Thomas Gleixner 已提交
16

17 18
#include <linux/types.h>
#include <linux/ioctl.h>
19
#include <asm/byteorder.h>
T
Thomas Gleixner 已提交
20 21

/*
I
Ingo Molnar 已提交
22 23 24 25
 * User-space ABI bits:
 */

/*
26
 * attr.type
T
Thomas Gleixner 已提交
27
 */
P
Peter Zijlstra 已提交
28
enum perf_type_id {
I
Ingo Molnar 已提交
29 30 31 32 33
	PERF_TYPE_HARDWARE			= 0,
	PERF_TYPE_SOFTWARE			= 1,
	PERF_TYPE_TRACEPOINT			= 2,
	PERF_TYPE_HW_CACHE			= 3,
	PERF_TYPE_RAW				= 4,
34
	PERF_TYPE_BREAKPOINT			= 5,
35

I
Ingo Molnar 已提交
36
	PERF_TYPE_MAX,				/* non-ABI */
37
};
38

39
/*
40 41
 * Generalized performance event event_id types, used by the
 * attr.event_id parameter of the sys_perf_event_open()
I
Ingo Molnar 已提交
42
 * syscall:
43
 */
P
Peter Zijlstra 已提交
44
enum perf_hw_id {
I
Ingo Molnar 已提交
45
	/*
46
	 * Common hardware events, generalized by the kernel:
I
Ingo Molnar 已提交
47
	 */
48 49 50 51 52 53 54 55
	PERF_COUNT_HW_CPU_CYCLES		= 0,
	PERF_COUNT_HW_INSTRUCTIONS		= 1,
	PERF_COUNT_HW_CACHE_REFERENCES		= 2,
	PERF_COUNT_HW_CACHE_MISSES		= 3,
	PERF_COUNT_HW_BRANCH_INSTRUCTIONS	= 4,
	PERF_COUNT_HW_BRANCH_MISSES		= 5,
	PERF_COUNT_HW_BUS_CYCLES		= 6,

I
Ingo Molnar 已提交
56
	PERF_COUNT_HW_MAX,			/* non-ABI */
57
};
58

59
/*
60
 * Generalized hardware cache events:
61
 *
62
 *       { L1-D, L1-I, LLC, ITLB, DTLB, BPU } x
63 64 65
 *       { read, write, prefetch } x
 *       { accesses, misses }
 */
P
Peter Zijlstra 已提交
66
enum perf_hw_cache_id {
I
Ingo Molnar 已提交
67 68 69 70 71 72 73 74
	PERF_COUNT_HW_CACHE_L1D			= 0,
	PERF_COUNT_HW_CACHE_L1I			= 1,
	PERF_COUNT_HW_CACHE_LL			= 2,
	PERF_COUNT_HW_CACHE_DTLB		= 3,
	PERF_COUNT_HW_CACHE_ITLB		= 4,
	PERF_COUNT_HW_CACHE_BPU			= 5,

	PERF_COUNT_HW_CACHE_MAX,		/* non-ABI */
75 76
};

P
Peter Zijlstra 已提交
77
enum perf_hw_cache_op_id {
I
Ingo Molnar 已提交
78 79 80
	PERF_COUNT_HW_CACHE_OP_READ		= 0,
	PERF_COUNT_HW_CACHE_OP_WRITE		= 1,
	PERF_COUNT_HW_CACHE_OP_PREFETCH		= 2,
81

I
Ingo Molnar 已提交
82
	PERF_COUNT_HW_CACHE_OP_MAX,		/* non-ABI */
83 84
};

P
Peter Zijlstra 已提交
85 86 87
enum perf_hw_cache_op_result_id {
	PERF_COUNT_HW_CACHE_RESULT_ACCESS	= 0,
	PERF_COUNT_HW_CACHE_RESULT_MISS		= 1,
88

I
Ingo Molnar 已提交
89
	PERF_COUNT_HW_CACHE_RESULT_MAX,		/* non-ABI */
90 91
};

92
/*
93 94
 * Special "software" events provided by the kernel, even if the hardware
 * does not support performance events. These events measure various
95 96 97
 * physical and sw events of the kernel (and allow the profiling of them as
 * well):
 */
P
Peter Zijlstra 已提交
98
enum perf_sw_ids {
I
Ingo Molnar 已提交
99 100 101 102 103 104 105
	PERF_COUNT_SW_CPU_CLOCK			= 0,
	PERF_COUNT_SW_TASK_CLOCK		= 1,
	PERF_COUNT_SW_PAGE_FAULTS		= 2,
	PERF_COUNT_SW_CONTEXT_SWITCHES		= 3,
	PERF_COUNT_SW_CPU_MIGRATIONS		= 4,
	PERF_COUNT_SW_PAGE_FAULTS_MIN		= 5,
	PERF_COUNT_SW_PAGE_FAULTS_MAJ		= 6,
106 107
	PERF_COUNT_SW_ALIGNMENT_FAULTS		= 7,
	PERF_COUNT_SW_EMULATION_FAULTS		= 8,
I
Ingo Molnar 已提交
108 109

	PERF_COUNT_SW_MAX,			/* non-ABI */
T
Thomas Gleixner 已提交
110 111
};

112
/*
113
 * Bits that can be set in attr.sample_type to request information
114 115
 * in the overflow packets.
 */
116
enum perf_event_sample_format {
I
Ingo Molnar 已提交
117 118 119 120
	PERF_SAMPLE_IP				= 1U << 0,
	PERF_SAMPLE_TID				= 1U << 1,
	PERF_SAMPLE_TIME			= 1U << 2,
	PERF_SAMPLE_ADDR			= 1U << 3,
121
	PERF_SAMPLE_READ			= 1U << 4,
I
Ingo Molnar 已提交
122 123 124 125
	PERF_SAMPLE_CALLCHAIN			= 1U << 5,
	PERF_SAMPLE_ID				= 1U << 6,
	PERF_SAMPLE_CPU				= 1U << 7,
	PERF_SAMPLE_PERIOD			= 1U << 8,
126
	PERF_SAMPLE_STREAM_ID			= 1U << 9,
127
	PERF_SAMPLE_RAW				= 1U << 10,
128

129
	PERF_SAMPLE_MAX = 1U << 11,		/* non-ABI */
130 131
};

132
/*
133
 * The format of the data returned by read() on a perf event fd,
134 135 136
 * as specified by attr.read_format:
 *
 * struct read_format {
I
Ingo Molnar 已提交
137 138 139 140 141
 *	{ u64		value;
 *	  { u64		time_enabled; } && PERF_FORMAT_ENABLED
 *	  { u64		time_running; } && PERF_FORMAT_RUNNING
 *	  { u64		id;           } && PERF_FORMAT_ID
 *	} && !PERF_FORMAT_GROUP
142
 *
I
Ingo Molnar 已提交
143 144 145 146 147 148 149
 *	{ u64		nr;
 *	  { u64		time_enabled; } && PERF_FORMAT_ENABLED
 *	  { u64		time_running; } && PERF_FORMAT_RUNNING
 *	  { u64		value;
 *	    { u64	id;           } && PERF_FORMAT_ID
 *	  }		cntr[nr];
 *	} && PERF_FORMAT_GROUP
150
 * };
151
 */
152
enum perf_event_read_format {
I
Ingo Molnar 已提交
153 154 155
	PERF_FORMAT_TOTAL_TIME_ENABLED		= 1U << 0,
	PERF_FORMAT_TOTAL_TIME_RUNNING		= 1U << 1,
	PERF_FORMAT_ID				= 1U << 2,
156
	PERF_FORMAT_GROUP			= 1U << 3,
157

I
Ingo Molnar 已提交
158
	PERF_FORMAT_MAX = 1U << 4,		/* non-ABI */
159 160
};

161 162
#define PERF_ATTR_SIZE_VER0	64	/* sizeof first published struct */

I
Ingo Molnar 已提交
163
/*
164
 * Hardware event_id to monitor via a performance monitoring event:
I
Ingo Molnar 已提交
165
 */
166
struct perf_event_attr {
167

168
	/*
169 170 171
	 * Major type: hardware/software/tracepoint/etc.
	 */
	__u32			type;
172 173 174 175 176

	/*
	 * Size of the attr structure, for fwd/bwd compat.
	 */
	__u32			size;
177 178 179

	/*
	 * Type specific configuration information.
180 181
	 */
	__u64			config;
I
Ingo Molnar 已提交
182

183
	union {
184 185
		__u64		sample_period;
		__u64		sample_freq;
186 187
	};

188 189
	__u64			sample_type;
	__u64			read_format;
I
Ingo Molnar 已提交
190

191
	__u64			disabled       :  1, /* off by default        */
192 193 194 195 196 197
				inherit	       :  1, /* children inherit it   */
				pinned	       :  1, /* must always be on PMU */
				exclusive      :  1, /* only group on PMU     */
				exclude_user   :  1, /* don't count user      */
				exclude_kernel :  1, /* ditto kernel          */
				exclude_hv     :  1, /* ditto hypervisor      */
198
				exclude_idle   :  1, /* don't count when idle */
199
				mmap           :  1, /* include mmap data     */
200
				comm	       :  1, /* include comm data     */
201
				freq           :  1, /* use freq, not period  */
202
				inherit_stat   :  1, /* per task counts       */
203
				enable_on_exec :  1, /* next exec enables     */
P
Peter Zijlstra 已提交
204
				task           :  1, /* trace fork/exit       */
205
				watermark      :  1, /* wakeup_watermark      */
206
				precise        :  1, /* OoO invariant counter */
207

208
				__reserved_1   : 48;
209

210 211 212 213
	union {
		__u32		wakeup_events;	  /* wakeup every n events */
		__u32		wakeup_watermark; /* bytes before wakeup   */
	};
214

215
	__u32			bp_type;
216 217
	__u64			bp_addr;
	__u64			bp_len;
218 219
};

220
/*
221
 * Ioctls that can be done on a perf event fd:
222
 */
223
#define PERF_EVENT_IOC_ENABLE		_IO ('$', 0)
I
Ingo Molnar 已提交
224 225
#define PERF_EVENT_IOC_DISABLE		_IO ('$', 1)
#define PERF_EVENT_IOC_REFRESH		_IO ('$', 2)
226
#define PERF_EVENT_IOC_RESET		_IO ('$', 3)
227
#define PERF_EVENT_IOC_PERIOD		_IOW('$', 4, __u64)
228
#define PERF_EVENT_IOC_SET_OUTPUT	_IO ('$', 5)
L
Li Zefan 已提交
229
#define PERF_EVENT_IOC_SET_FILTER	_IOW('$', 6, char *)
230 231

enum perf_event_ioc_flags {
P
Peter Zijlstra 已提交
232 233
	PERF_IOC_FLAG_GROUP		= 1U << 0,
};
234

235 236 237
/*
 * Structure of the page that can be mapped via mmap
 */
238
struct perf_event_mmap_page {
239 240
	__u32	version;		/* version number of this structure */
	__u32	compat_version;		/* lowest version this is compat with */
241 242

	/*
243
	 * Bits needed to read the hw events in user-space.
244
	 *
245 246
	 *   u32 seq;
	 *   s64 count;
247
	 *
248 249
	 *   do {
	 *     seq = pc->lock;
250
	 *
251 252 253 254 255 256
	 *     barrier()
	 *     if (pc->index) {
	 *       count = pmc_read(pc->index - 1);
	 *       count += pc->offset;
	 *     } else
	 *       goto regular_read;
257
	 *
258 259
	 *     barrier();
	 *   } while (pc->lock != seq);
260
	 *
261 262
	 * NOTE: for obvious reason this only works on self-monitoring
	 *       processes.
263
	 */
264
	__u32	lock;			/* seqlock for synchronization */
265 266 267 268
	__u32	index;			/* hardware event identifier */
	__s64	offset;			/* add to hardware event value */
	__u64	time_enabled;		/* time event active */
	__u64	time_running;		/* time event on cpu */
269

270 271 272 273
		/*
		 * Hole for extension of the self monitor capabilities
		 */

274
	__u64	__reserved[123];	/* align to 1k */
275

276 277 278
	/*
	 * Control data for the mmap() data buffer.
	 *
279 280
	 * User-space reading the @data_head value should issue an rmb(), on
	 * SMP capable platforms, after reading this value -- see
281
	 * perf_event_wakeup().
282 283 284 285
	 *
	 * When the mapping is PROT_WRITE the @data_tail value should be
	 * written by userspace to reflect the last read data. In this case
	 * the kernel will not over-write unread data.
286
	 */
287
	__u64   data_head;		/* head in the data section */
288
	__u64	data_tail;		/* user-space written tail */
289 290
};

291
#define PERF_RECORD_MISC_CPUMODE_MASK		(3 << 0)
292
#define PERF_RECORD_MISC_CPUMODE_UNKNOWN	(0 << 0)
293 294 295
#define PERF_RECORD_MISC_KERNEL			(1 << 0)
#define PERF_RECORD_MISC_USER			(2 << 0)
#define PERF_RECORD_MISC_HYPERVISOR		(3 << 0)
296

P
Peter Zijlstra 已提交
297 298
struct perf_event_header {
	__u32	type;
299 300
	__u16	misc;
	__u16	size;
P
Peter Zijlstra 已提交
301 302 303
};

enum perf_event_type {
304

305 306 307 308 309
	/*
	 * The MMAP events record the PROT_EXEC mappings so that we can
	 * correlate userspace IPs to code. They have the following structure:
	 *
	 * struct {
I
Ingo Molnar 已提交
310
	 *	struct perf_event_header	header;
311
	 *
I
Ingo Molnar 已提交
312 313 314 315 316
	 *	u32				pid, tid;
	 *	u64				addr;
	 *	u64				len;
	 *	u64				pgoff;
	 *	char				filename[];
317 318
	 * };
	 */
319
	PERF_RECORD_MMAP			= 1,
320

321 322
	/*
	 * struct {
I
Ingo Molnar 已提交
323 324 325
	 *	struct perf_event_header	header;
	 *	u64				id;
	 *	u64				lost;
326 327
	 * };
	 */
328
	PERF_RECORD_LOST			= 2,
329

330 331
	/*
	 * struct {
I
Ingo Molnar 已提交
332
	 *	struct perf_event_header	header;
333
	 *
I
Ingo Molnar 已提交
334 335
	 *	u32				pid, tid;
	 *	char				comm[];
336 337
	 * };
	 */
338
	PERF_RECORD_COMM			= 3,
339

P
Peter Zijlstra 已提交
340 341 342 343 344
	/*
	 * struct {
	 *	struct perf_event_header	header;
	 *	u32				pid, ppid;
	 *	u32				tid, ptid;
345
	 *	u64				time;
P
Peter Zijlstra 已提交
346 347
	 * };
	 */
348
	PERF_RECORD_EXIT			= 4,
P
Peter Zijlstra 已提交
349

350 351
	/*
	 * struct {
I
Ingo Molnar 已提交
352 353
	 *	struct perf_event_header	header;
	 *	u64				time;
354
	 *	u64				id;
355
	 *	u64				stream_id;
356 357
	 * };
	 */
358 359
	PERF_RECORD_THROTTLE			= 5,
	PERF_RECORD_UNTHROTTLE			= 6,
360

P
Peter Zijlstra 已提交
361 362
	/*
	 * struct {
363 364
	 *	struct perf_event_header	header;
	 *	u32				pid, ppid;
P
Peter Zijlstra 已提交
365
	 *	u32				tid, ptid;
366
	 *	u64				time;
P
Peter Zijlstra 已提交
367 368
	 * };
	 */
369
	PERF_RECORD_FORK			= 7,
P
Peter Zijlstra 已提交
370

371 372
	/*
	 * struct {
373 374
	 *	struct perf_event_header	header;
	 *	u32				pid, tid;
375
	 *
376
	 *	struct read_format		values;
377 378
	 * };
	 */
379
	PERF_RECORD_READ			= 8,
380

381
	/*
382
	 * struct {
I
Ingo Molnar 已提交
383
	 *	struct perf_event_header	header;
384
	 *
385 386 387 388
	 *	{ u64			ip;	  } && PERF_SAMPLE_IP
	 *	{ u32			pid, tid; } && PERF_SAMPLE_TID
	 *	{ u64			time;     } && PERF_SAMPLE_TIME
	 *	{ u64			addr;     } && PERF_SAMPLE_ADDR
389
	 *	{ u64			id;	  } && PERF_SAMPLE_ID
390
	 *	{ u64			stream_id;} && PERF_SAMPLE_STREAM_ID
391
	 *	{ u32			cpu, res; } && PERF_SAMPLE_CPU
I
Ingo Molnar 已提交
392
	 *	{ u64			period;   } && PERF_SAMPLE_PERIOD
393
	 *
394
	 *	{ struct read_format	values;	  } && PERF_SAMPLE_READ
395
	 *
396
	 *	{ u64			nr,
397
	 *	  u64			ips[nr];  } && PERF_SAMPLE_CALLCHAIN
398
	 *
I
Ingo Molnar 已提交
399 400 401 402 403 404 405 406 407 408
	 *	#
	 *	# The RAW record below is opaque data wrt the ABI
	 *	#
	 *	# That is, the ABI doesn't make any promises wrt to
	 *	# the stability of its content, it may vary depending
	 *	# on event, hardware, kernel version and phase of
	 *	# the moon.
	 *	#
	 *	# In other words, PERF_SAMPLE_RAW contents are not an ABI.
	 *	#
409
	 *
410 411
	 *	{ u32			size;
	 *	  char                  data[size];}&& PERF_SAMPLE_RAW
412
	 * };
413
	 */
414
	PERF_RECORD_SAMPLE			= 9,
415

416
	PERF_RECORD_MAX,			/* non-ABI */
P
Peter Zijlstra 已提交
417 418
};

419 420 421 422
enum perf_callchain_context {
	PERF_CONTEXT_HV			= (__u64)-32,
	PERF_CONTEXT_KERNEL		= (__u64)-128,
	PERF_CONTEXT_USER		= (__u64)-512,
423

424 425 426 427 428
	PERF_CONTEXT_GUEST		= (__u64)-2048,
	PERF_CONTEXT_GUEST_KERNEL	= (__u64)-2176,
	PERF_CONTEXT_GUEST_USER		= (__u64)-2560,

	PERF_CONTEXT_MAX		= (__u64)-4095,
429 430
};

431 432 433
#define PERF_FLAG_FD_NO_GROUP	(1U << 0)
#define PERF_FLAG_FD_OUTPUT	(1U << 1)

434
#ifdef __KERNEL__
I
Ingo Molnar 已提交
435
/*
436
 * Kernel-internal data types and definitions:
I
Ingo Molnar 已提交
437 438
 */

439 440
#ifdef CONFIG_PERF_EVENTS
# include <asm/perf_event.h>
441 442
#endif

443 444 445 446
#ifdef CONFIG_HAVE_HW_BREAKPOINT
#include <asm/hw_breakpoint.h>
#endif

447 448 449 450 451
#include <linux/list.h>
#include <linux/mutex.h>
#include <linux/rculist.h>
#include <linux/rcupdate.h>
#include <linux/spinlock.h>
452
#include <linux/hrtimer.h>
P
Peter Zijlstra 已提交
453
#include <linux/fs.h>
454
#include <linux/pid_namespace.h>
455
#include <linux/workqueue.h>
456 457
#include <asm/atomic.h>

458 459 460 461 462 463 464
#define PERF_MAX_STACK_DEPTH		255

struct perf_callchain_entry {
	__u64				nr;
	__u64				ip[PERF_MAX_STACK_DEPTH];
};

465 466 467
struct perf_raw_record {
	u32				size;
	void				*data;
468 469
};

470 471 472 473 474 475 476 477 478 479 480
struct perf_branch_entry {
	__u64				from;
	__u64				to;
	__u64				flags;
};

struct perf_branch_stack {
	__u64				nr;
	struct perf_branch_entry	entries[0];
};

481 482
struct task_struct;

T
Thomas Gleixner 已提交
483
/**
484
 * struct hw_perf_event - performance event hardware details:
T
Thomas Gleixner 已提交
485
 */
486 487
struct hw_perf_event {
#ifdef CONFIG_PERF_EVENTS
488 489
	union {
		struct { /* hardware */
I
Ingo Molnar 已提交
490
			u64		config;
491
			u64		last_tag;
I
Ingo Molnar 已提交
492
			unsigned long	config_base;
493
			unsigned long	event_base;
I
Ingo Molnar 已提交
494
			int		idx;
495
			int		last_cpu;
496
		};
497 498
		struct { /* software */
			s64		remaining;
I
Ingo Molnar 已提交
499
			struct hrtimer	hrtimer;
500
		};
501
#ifdef CONFIG_HAVE_HW_BREAKPOINT
502 503
		/* breakpoint */
		struct arch_hw_breakpoint	info;
504
#endif
505
	};
506
	atomic64_t			prev_count;
507
	u64				sample_period;
508
	u64				last_period;
509
	atomic64_t			period_left;
510
	u64				interrupts;
511

512 513
	u64				freq_time_stamp;
	u64				freq_count_stamp;
514
#endif
T
Thomas Gleixner 已提交
515 516
};

517
struct perf_event;
I
Ingo Molnar 已提交
518 519

/**
520
 * struct pmu - generic performance monitoring unit
I
Ingo Molnar 已提交
521
 */
522
struct pmu {
523 524
	int (*enable)			(struct perf_event *event);
	void (*disable)			(struct perf_event *event);
525 526
	int (*start)			(struct perf_event *event);
	void (*stop)			(struct perf_event *event);
527 528
	void (*read)			(struct perf_event *event);
	void (*unthrottle)		(struct perf_event *event);
I
Ingo Molnar 已提交
529 530
};

531
/**
532
 * enum perf_event_active_state - the states of a event
533
 */
534
enum perf_event_active_state {
I
Ingo Molnar 已提交
535
	PERF_EVENT_STATE_ERROR		= -2,
536 537
	PERF_EVENT_STATE_OFF		= -1,
	PERF_EVENT_STATE_INACTIVE	=  0,
I
Ingo Molnar 已提交
538
	PERF_EVENT_STATE_ACTIVE		=  1,
539 540
};

541 542
struct file;

543 544
struct perf_mmap_data {
	struct rcu_head			rcu_head;
545 546 547 548
#ifdef CONFIG_PERF_USE_VMALLOC
	struct work_struct		work;
#endif
	int				data_order;
P
Peter Zijlstra 已提交
549
	int				nr_pages;	/* nr of data pages  */
550
	int				writable;	/* are we writable   */
551
	int				nr_locked;	/* nr pages mlocked  */
P
Peter Zijlstra 已提交
552

553
	atomic_t			poll;		/* POLL_ for wakeups */
554
	atomic_t			events;		/* event_id limit       */
P
Peter Zijlstra 已提交
555

556 557 558
	atomic_long_t			head;		/* write position    */
	atomic_long_t			done_head;	/* completed head    */

559
	atomic_t			lock;		/* concurrent writes */
560
	atomic_t			wakeup;		/* needs a wakeup    */
561
	atomic_t			lost;		/* nr records lost   */
562

563 564
	long				watermark;	/* wakeup watermark  */

I
Ingo Molnar 已提交
565
	struct perf_event_mmap_page	*user_page;
I
Ingo Molnar 已提交
566
	void				*data_pages[0];
567 568
};

569 570 571
struct perf_pending_entry {
	struct perf_pending_entry *next;
	void (*func)(struct perf_pending_entry *);
572 573
};

574 575
struct perf_sample_data;

576 577 578 579
typedef void (*perf_overflow_handler_t)(struct perf_event *, int,
					struct perf_sample_data *,
					struct pt_regs *regs);

580 581 582 583
enum perf_group_flag {
	PERF_GROUP_SOFTWARE = 0x1,
};

T
Thomas Gleixner 已提交
584
/**
585
 * struct perf_event - performance event kernel representation:
T
Thomas Gleixner 已提交
586
 */
587 588
struct perf_event {
#ifdef CONFIG_PERF_EVENTS
589
	struct list_head		group_entry;
P
Peter Zijlstra 已提交
590
	struct list_head		event_entry;
591
	struct list_head		sibling_list;
I
Ingo Molnar 已提交
592
	int				nr_siblings;
593
	int				group_flags;
594 595
	struct perf_event		*group_leader;
	struct perf_event		*output;
596
	const struct pmu		*pmu;
597

598
	enum perf_event_active_state	state;
T
Thomas Gleixner 已提交
599
	atomic64_t			count;
600

601
	/*
602
	 * These are the total time in nanoseconds that the event
603
	 * has been enabled (i.e. eligible to run, and the task has
604
	 * been scheduled in, if this is a per-task event)
605 606 607
	 * and running (scheduled onto the CPU), respectively.
	 *
	 * They are computed from tstamp_enabled, tstamp_running and
608
	 * tstamp_stopped when the event is in INACTIVE or ACTIVE state.
609 610 611 612 613 614
	 */
	u64				total_time_enabled;
	u64				total_time_running;

	/*
	 * These are timestamps used for computing total_time_enabled
615
	 * and total_time_running when the event is in INACTIVE or
616 617
	 * ACTIVE state, measured in nanoseconds from an arbitrary point
	 * in time.
618 619
	 * tstamp_enabled: the notional time when the event was enabled
	 * tstamp_running: the notional time when the event was scheduled on
620
	 * tstamp_stopped: in INACTIVE state, the notional time when the
621
	 *	event was scheduled off.
622 623 624 625 626
	 */
	u64				tstamp_enabled;
	u64				tstamp_running;
	u64				tstamp_stopped;

627
	struct perf_event_attr		attr;
628
	struct hw_perf_event		hw;
T
Thomas Gleixner 已提交
629

630
	struct perf_event_context	*ctx;
631
	struct file			*filp;
T
Thomas Gleixner 已提交
632

633 634
	/*
	 * These accumulate total time (in nanoseconds) that children
635
	 * events have been enabled and running, respectively.
636 637 638 639
	 */
	atomic64_t			child_total_time_enabled;
	atomic64_t			child_total_time_running;

T
Thomas Gleixner 已提交
640
	/*
641
	 * Protect attach/detach and child_list:
T
Thomas Gleixner 已提交
642
	 */
643 644
	struct mutex			child_mutex;
	struct list_head		child_list;
645
	struct perf_event		*parent;
T
Thomas Gleixner 已提交
646 647 648 649

	int				oncpu;
	int				cpu;

650 651 652
	struct list_head		owner_entry;
	struct task_struct		*owner;

653 654 655 656
	/* mmap bits */
	struct mutex			mmap_mutex;
	atomic_t			mmap_count;
	struct perf_mmap_data		*data;
657

658
	/* poll related */
T
Thomas Gleixner 已提交
659
	wait_queue_head_t		waitq;
P
Peter Zijlstra 已提交
660
	struct fasync_struct		*fasync;
661 662 663

	/* delayed work for NMIs and such */
	int				pending_wakeup;
664
	int				pending_kill;
665
	int				pending_disable;
666
	struct perf_pending_entry	pending;
P
Peter Zijlstra 已提交
667

668 669
	atomic_t			event_limit;

670
	void (*destroy)(struct perf_event *);
P
Peter Zijlstra 已提交
671
	struct rcu_head			rcu_head;
672 673

	struct pid_namespace		*ns;
674
	u64				id;
L
Li Zefan 已提交
675

676
	perf_overflow_handler_t		overflow_handler;
677

678
#ifdef CONFIG_EVENT_TRACING
L
Li Zefan 已提交
679
	struct event_filter		*filter;
680
#endif
L
Li Zefan 已提交
681 682

#endif /* CONFIG_PERF_EVENTS */
T
Thomas Gleixner 已提交
683 684 685
};

/**
686
 * struct perf_event_context - event context structure
T
Thomas Gleixner 已提交
687
 *
688
 * Used as a container for task events and CPU events as well:
T
Thomas Gleixner 已提交
689
 */
690
struct perf_event_context {
T
Thomas Gleixner 已提交
691
	/*
692
	 * Protect the states of the events in the list,
693
	 * nr_active, and the list:
T
Thomas Gleixner 已提交
694
	 */
695
	raw_spinlock_t			lock;
696
	/*
697
	 * Protect the list of events.  Locking either mutex or lock
698 699 700
	 * is sufficient to ensure the list doesn't change; to change
	 * the list you need to lock both the mutex and the spinlock.
	 */
I
Ingo Molnar 已提交
701
	struct mutex			mutex;
702

703 704
	struct list_head		pinned_groups;
	struct list_head		flexible_groups;
I
Ingo Molnar 已提交
705
	struct list_head		event_list;
706
	int				nr_events;
I
Ingo Molnar 已提交
707 708
	int				nr_active;
	int				is_active;
709
	int				nr_stat;
I
Ingo Molnar 已提交
710 711
	atomic_t			refcount;
	struct task_struct		*task;
712 713

	/*
714
	 * Context clock, runs when context enabled.
715
	 */
I
Ingo Molnar 已提交
716 717
	u64				time;
	u64				timestamp;
718 719 720 721 722

	/*
	 * These fields let us detect when two contexts have both
	 * been cloned (inherited) from a common ancestor.
	 */
723
	struct perf_event_context	*parent_ctx;
I
Ingo Molnar 已提交
724 725 726 727
	u64				parent_gen;
	u64				generation;
	int				pin_count;
	struct rcu_head			rcu_head;
T
Thomas Gleixner 已提交
728 729 730
};

/**
731
 * struct perf_event_cpu_context - per cpu event context structure
T
Thomas Gleixner 已提交
732 733
 */
struct perf_cpu_context {
734 735
	struct perf_event_context	ctx;
	struct perf_event_context	*task_ctx;
T
Thomas Gleixner 已提交
736 737
	int				active_oncpu;
	int				max_pertask;
738
	int				exclusive;
P
Peter Zijlstra 已提交
739 740 741 742 743 744

	/*
	 * Recursion avoidance:
	 *
	 * task, softirq, irq, nmi context
	 */
745
	int				recursion[4];
T
Thomas Gleixner 已提交
746 747
};

748
struct perf_output_handle {
I
Ingo Molnar 已提交
749 750 751 752 753 754 755
	struct perf_event		*event;
	struct perf_mmap_data		*data;
	unsigned long			head;
	unsigned long			offset;
	int				nmi;
	int				sample;
	int				locked;
756 757
};

758
#ifdef CONFIG_PERF_EVENTS
759

T
Thomas Gleixner 已提交
760 761 762
/*
 * Set by architecture code:
 */
763
extern int perf_max_events;
T
Thomas Gleixner 已提交
764

765
extern const struct pmu *hw_perf_event_init(struct perf_event *event);
I
Ingo Molnar 已提交
766

767
extern void perf_event_task_sched_in(struct task_struct *task);
768
extern void perf_event_task_sched_out(struct task_struct *task, struct task_struct *next);
769
extern void perf_event_task_tick(struct task_struct *task);
770 771 772 773 774 775
extern int perf_event_init_task(struct task_struct *child);
extern void perf_event_exit_task(struct task_struct *child);
extern void perf_event_free_task(struct task_struct *task);
extern void set_perf_event_pending(void);
extern void perf_event_do_pending(void);
extern void perf_event_print_debug(void);
776 777 778 779
extern void __perf_disable(void);
extern bool __perf_enable(void);
extern void perf_disable(void);
extern void perf_enable(void);
780 781 782
extern int perf_event_task_disable(void);
extern int perf_event_task_enable(void);
extern int hw_perf_group_sched_in(struct perf_event *group_leader,
783
	       struct perf_cpu_context *cpuctx,
784
	       struct perf_event_context *ctx);
785
extern void perf_event_update_userpage(struct perf_event *event);
786 787 788 789
extern int perf_event_release_kernel(struct perf_event *event);
extern struct perf_event *
perf_event_create_kernel_counter(struct perf_event_attr *attr,
				int cpu,
790
				pid_t pid,
791
				perf_overflow_handler_t callback);
792 793
extern u64 perf_event_read_value(struct perf_event *event,
				 u64 *enabled, u64 *running);
794

795
struct perf_sample_data {
796 797 798 799 800 801 802 803
	u64				type;

	u64				ip;
	struct {
		u32	pid;
		u32	tid;
	}				tid_entry;
	u64				time;
I
Ingo Molnar 已提交
804
	u64				addr;
805 806 807 808 809 810
	u64				id;
	u64				stream_id;
	struct {
		u32	cpu;
		u32	reserved;
	}				cpu_entry;
I
Ingo Molnar 已提交
811
	u64				period;
812
	struct perf_callchain_entry	*callchain;
813
	struct perf_raw_record		*raw;
814 815
};

816 817 818 819 820 821 822
static inline
void perf_sample_data_init(struct perf_sample_data *data, u64 addr)
{
	data->addr = addr;
	data->raw  = NULL;
}

823 824 825
extern void perf_output_sample(struct perf_output_handle *handle,
			       struct perf_event_header *header,
			       struct perf_sample_data *data,
826
			       struct perf_event *event);
827 828
extern void perf_prepare_sample(struct perf_event_header *header,
				struct perf_sample_data *data,
829
				struct perf_event *event,
830 831
				struct pt_regs *regs);

832
extern int perf_event_overflow(struct perf_event *event, int nmi,
833 834
				 struct perf_sample_data *data,
				 struct pt_regs *regs);
835

836
/*
837
 * Return 1 for a software event, 0 for a hardware event
838
 */
839
static inline int is_software_event(struct perf_event *event)
840
{
841 842 843 844 845 846 847 848
	switch (event->attr.type) {
	case PERF_TYPE_SOFTWARE:
	case PERF_TYPE_TRACEPOINT:
	/* for now the breakpoint stuff also works as software event */
	case PERF_TYPE_BREAKPOINT:
		return 1;
	}
	return 0;
849 850
}

851
extern atomic_t perf_swevent_enabled[PERF_COUNT_SW_MAX];
852

853
extern void __perf_sw_event(u32, u64, int, struct pt_regs *, u64);
854 855

static inline void
856
perf_sw_event(u32 event_id, u64 nr, int nmi, struct pt_regs *regs, u64 addr)
857
{
858 859
	if (atomic_read(&perf_swevent_enabled[event_id]))
		__perf_sw_event(event_id, nr, nmi, regs, addr);
860
}
861

862
extern void __perf_event_mmap(struct vm_area_struct *vma);
863

864
static inline void perf_event_mmap(struct vm_area_struct *vma)
865 866
{
	if (vma->vm_flags & VM_EXEC)
867
		__perf_event_mmap(vma);
868
}
869

870 871
extern void perf_event_comm(struct task_struct *tsk);
extern void perf_event_fork(struct task_struct *tsk);
872

873 874
extern struct perf_callchain_entry *perf_callchain(struct pt_regs *regs);

875 876 877
extern int sysctl_perf_event_paranoid;
extern int sysctl_perf_event_mlock;
extern int sysctl_perf_event_sample_rate;
878

879 880 881 882 883 884 885 886 887 888 889 890 891 892 893
static inline bool perf_paranoid_tracepoint_raw(void)
{
	return sysctl_perf_event_paranoid > -1;
}

static inline bool perf_paranoid_cpu(void)
{
	return sysctl_perf_event_paranoid > 0;
}

static inline bool perf_paranoid_kernel(void)
{
	return sysctl_perf_event_paranoid > 1;
}

894
extern void perf_event_init(void);
895
extern void perf_tp_event(int event_id, u64 addr, u64 count, void *record, int entry_size);
896
extern void perf_bp_event(struct perf_event *event, void *data);
897

898
#ifndef perf_misc_flags
899 900
#define perf_misc_flags(regs)	(user_mode(regs) ? PERF_RECORD_MISC_USER : \
				 PERF_RECORD_MISC_KERNEL)
901 902 903
#define perf_instruction_pointer(regs)	instruction_pointer(regs)
#endif

904
extern int perf_output_begin(struct perf_output_handle *handle,
905
			     struct perf_event *event, unsigned int size,
906 907 908 909
			     int nmi, int sample);
extern void perf_output_end(struct perf_output_handle *handle);
extern void perf_output_copy(struct perf_output_handle *handle,
			     const void *buf, unsigned int len);
910 911
extern int perf_swevent_get_recursion_context(void);
extern void perf_swevent_put_recursion_context(int rctx);
912 913
extern void perf_event_enable(struct perf_event *event);
extern void perf_event_disable(struct perf_event *event);
T
Thomas Gleixner 已提交
914 915
#else
static inline void
916
perf_event_task_sched_in(struct task_struct *task)			{ }
T
Thomas Gleixner 已提交
917
static inline void
918
perf_event_task_sched_out(struct task_struct *task,
919
			    struct task_struct *next)			{ }
T
Thomas Gleixner 已提交
920
static inline void
921
perf_event_task_tick(struct task_struct *task)				{ }
922 923 924
static inline int perf_event_init_task(struct task_struct *child)	{ return 0; }
static inline void perf_event_exit_task(struct task_struct *child)	{ }
static inline void perf_event_free_task(struct task_struct *task)	{ }
I
Ingo Molnar 已提交
925 926
static inline void perf_event_do_pending(void)				{ }
static inline void perf_event_print_debug(void)				{ }
927 928
static inline void perf_disable(void)					{ }
static inline void perf_enable(void)					{ }
I
Ingo Molnar 已提交
929 930
static inline int perf_event_task_disable(void)				{ return -EINVAL; }
static inline int perf_event_task_enable(void)				{ return -EINVAL; }
931

932
static inline void
933
perf_sw_event(u32 event_id, u64 nr, int nmi,
934
		     struct pt_regs *regs, u64 addr)			{ }
935
static inline void
936
perf_bp_event(struct perf_event *event, void *data)			{ }
937

I
Ingo Molnar 已提交
938
static inline void perf_event_mmap(struct vm_area_struct *vma)		{ }
939 940 941
static inline void perf_event_comm(struct task_struct *tsk)		{ }
static inline void perf_event_fork(struct task_struct *tsk)		{ }
static inline void perf_event_init(void)				{ }
942
static inline int  perf_swevent_get_recursion_context(void)		{ return -1; }
943
static inline void perf_swevent_put_recursion_context(int rctx)		{ }
944 945
static inline void perf_event_enable(struct perf_event *event)		{ }
static inline void perf_event_disable(struct perf_event *event)		{ }
T
Thomas Gleixner 已提交
946 947
#endif

948 949 950
#define perf_output_put(handle, x) \
	perf_output_copy((handle), &(x), sizeof(x))

951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966
/*
 * This has to have a higher priority than migration_notifier in sched.c.
 */
#define perf_cpu_notifier(fn)					\
do {								\
	static struct notifier_block fn##_nb __cpuinitdata =	\
		{ .notifier_call = fn, .priority = 20 };	\
	fn(&fn##_nb, (unsigned long)CPU_UP_PREPARE,		\
		(void *)(unsigned long)smp_processor_id());	\
	fn(&fn##_nb, (unsigned long)CPU_STARTING,		\
		(void *)(unsigned long)smp_processor_id());	\
	fn(&fn##_nb, (unsigned long)CPU_ONLINE,			\
		(void *)(unsigned long)smp_processor_id());	\
	register_cpu_notifier(&fn##_nb);			\
} while (0)

967
#endif /* __KERNEL__ */
968
#endif /* _LINUX_PERF_EVENT_H */