perf_event.h 28.2 KB
Newer Older
T
Thomas Gleixner 已提交
1
/*
I
Ingo Molnar 已提交
2
 * Performance events:
T
Thomas Gleixner 已提交
3
 *
I
Ingo Molnar 已提交
4
 *    Copyright (C) 2008-2009, Thomas Gleixner <tglx@linutronix.de>
5 6
 *    Copyright (C) 2008-2011, Red Hat, Inc., Ingo Molnar
 *    Copyright (C) 2008-2011, 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
#include <uapi/linux/perf_event.h>
T
Thomas Gleixner 已提交
18

I
Ingo Molnar 已提交
19
/*
20
 * Kernel-internal data types and definitions:
I
Ingo Molnar 已提交
21 22
 */

23 24
#ifdef CONFIG_PERF_EVENTS
# include <asm/perf_event.h>
25
# include <asm/local64.h>
26 27
#endif

28
struct perf_guest_info_callbacks {
29 30 31
	int				(*is_in_guest)(void);
	int				(*is_user_mode)(void);
	unsigned long			(*get_guest_ip)(void);
32 33
};

34 35 36 37
#ifdef CONFIG_HAVE_HW_BREAKPOINT
#include <asm/hw_breakpoint.h>
#endif

38 39 40 41 42
#include <linux/list.h>
#include <linux/mutex.h>
#include <linux/rculist.h>
#include <linux/rcupdate.h>
#include <linux/spinlock.h>
43
#include <linux/hrtimer.h>
P
Peter Zijlstra 已提交
44
#include <linux/fs.h>
45
#include <linux/pid_namespace.h>
46
#include <linux/workqueue.h>
47
#include <linux/ftrace.h>
48
#include <linux/cpu.h>
49
#include <linux/irq_work.h>
50
#include <linux/static_key.h>
51
#include <linux/jump_label_ratelimit.h>
A
Arun Sharma 已提交
52
#include <linux/atomic.h>
53
#include <linux/sysfs.h>
54
#include <linux/perf_regs.h>
55
#include <linux/workqueue.h>
56
#include <linux/cgroup.h>
57
#include <asm/local.h>
58

59 60 61 62 63
struct perf_callchain_entry {
	__u64				nr;
	__u64				ip[PERF_MAX_STACK_DEPTH];
};

64 65 66
struct perf_raw_record {
	u32				size;
	void				*data;
67 68
};

69 70 71 72 73 74 75 76 77
/*
 * branch stack layout:
 *  nr: number of taken branches stored in entries[]
 *
 * Note that nr can vary from sample to sample
 * branches (to, from) are stored from most recent
 * to least recent, i.e., entries[0] contains the most
 * recent branch.
 */
78 79 80 81 82
struct perf_branch_stack {
	__u64				nr;
	struct perf_branch_entry	entries[0];
};

83 84
struct task_struct;

85 86 87 88 89 90 91 92 93 94
/*
 * extra PMU register associated with an event
 */
struct hw_perf_event_extra {
	u64		config;	/* register value */
	unsigned int	reg;	/* register address or index */
	int		alloc;	/* extra register already allocated */
	int		idx;	/* index in shared_regs->regs[] */
};

95 96
struct event_constraint;

T
Thomas Gleixner 已提交
97
/**
98
 * struct hw_perf_event - performance event hardware details:
T
Thomas Gleixner 已提交
99
 */
100 101
struct hw_perf_event {
#ifdef CONFIG_PERF_EVENTS
102 103
	union {
		struct { /* hardware */
I
Ingo Molnar 已提交
104
			u64		config;
105
			u64		last_tag;
I
Ingo Molnar 已提交
106
			unsigned long	config_base;
107
			unsigned long	event_base;
108
			int		event_base_rdpmc;
I
Ingo Molnar 已提交
109
			int		idx;
110
			int		last_cpu;
111
			int		flags;
112

113
			struct hw_perf_event_extra extra_reg;
114
			struct hw_perf_event_extra branch_reg;
115 116

			struct event_constraint *constraint;
117
		};
118
		struct { /* software */
I
Ingo Molnar 已提交
119
			struct hrtimer	hrtimer;
120
		};
121 122 123 124
		struct { /* tracepoint */
			/* for tp_event->class */
			struct list_head	tp_list;
		};
125 126 127 128 129 130 131
		struct { /* intel_cqm */
			int			cqm_state;
			int			cqm_rmid;
			struct list_head	cqm_events_entry;
			struct list_head	cqm_groups_entry;
			struct list_head	cqm_group_entry;
		};
132
#ifdef CONFIG_HAVE_HW_BREAKPOINT
133
		struct { /* breakpoint */
134 135 136 137 138
			/*
			 * Crufty hack to avoid the chicken and egg
			 * problem hw_breakpoint has with context
			 * creation and event initalization.
			 */
139 140
			struct arch_hw_breakpoint	info;
			struct list_head		bp_list;
141
		};
142
#endif
143
	};
144
	struct task_struct		*target;
P
Peter Zijlstra 已提交
145
	int				state;
146
	local64_t			prev_count;
147
	u64				sample_period;
148
	u64				last_period;
149
	local64_t			period_left;
150
	u64                             interrupts_seq;
151
	u64				interrupts;
152

153 154
	u64				freq_time_stamp;
	u64				freq_count_stamp;
155
#endif
T
Thomas Gleixner 已提交
156 157
};

P
Peter Zijlstra 已提交
158 159 160 161 162 163 164
/*
 * hw_perf_event::state flags
 */
#define PERF_HES_STOPPED	0x01 /* the counter is stopped */
#define PERF_HES_UPTODATE	0x02 /* event->count up-to-date */
#define PERF_HES_ARCH		0x04

165
struct perf_event;
I
Ingo Molnar 已提交
166

167 168 169 170
/*
 * Common implementation detail of pmu::{start,commit,cancel}_txn
 */
#define PERF_EVENT_TXN 0x1
171

172 173 174 175
/**
 * pmu::capabilities flags
 */
#define PERF_PMU_CAP_NO_INTERRUPT		0x01
176
#define PERF_PMU_CAP_NO_NMI			0x02
177
#define PERF_PMU_CAP_AUX_NO_SG			0x04
178
#define PERF_PMU_CAP_AUX_SW_DOUBLEBUF		0x08
179
#define PERF_PMU_CAP_EXCLUSIVE			0x10
180

I
Ingo Molnar 已提交
181
/**
182
 * struct pmu - generic performance monitoring unit
I
Ingo Molnar 已提交
183
 */
184
struct pmu {
185 186
	struct list_head		entry;

187
	struct module			*module;
P
Peter Zijlstra 已提交
188
	struct device			*dev;
189
	const struct attribute_group	**attr_groups;
190
	const char			*name;
P
Peter Zijlstra 已提交
191 192
	int				type;

193 194 195 196 197
	/*
	 * various common per-pmu feature flags
	 */
	int				capabilities;

P
Peter Zijlstra 已提交
198 199
	int * __percpu			pmu_disable_count;
	struct perf_cpu_context * __percpu pmu_cpu_context;
200
	atomic_t			exclusive_cnt; /* < 0: cpu; > 0: tsk */
P
Peter Zijlstra 已提交
201
	int				task_ctx_nr;
202
	int				hrtimer_interval_ms;
203 204

	/*
P
Peter Zijlstra 已提交
205 206
	 * Fully disable/enable this PMU, can be used to protect from the PMI
	 * as well as for lazy/batch writing of the MSRs.
207
	 */
P
Peter Zijlstra 已提交
208 209
	void (*pmu_enable)		(struct pmu *pmu); /* optional */
	void (*pmu_disable)		(struct pmu *pmu); /* optional */
210

211
	/*
P
Peter Zijlstra 已提交
212
	 * Try and initialize the event for this PMU.
213
	 * Should return -ENOENT when the @event doesn't match this PMU.
214
	 */
215 216
	int (*event_init)		(struct perf_event *event);

217 218 219 220 221 222 223
	/*
	 * Notification that the event was mapped or unmapped.  Called
	 * in the context of the mapping task.
	 */
	void (*event_mapped)		(struct perf_event *event); /*optional*/
	void (*event_unmapped)		(struct perf_event *event); /*optional*/

P
Peter Zijlstra 已提交
224 225 226 227
#define PERF_EF_START	0x01		/* start the counter when adding    */
#define PERF_EF_RELOAD	0x02		/* reload the counter when starting */
#define PERF_EF_UPDATE	0x04		/* update the counter when stopping */

228
	/*
P
Peter Zijlstra 已提交
229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245
	 * Adds/Removes a counter to/from the PMU, can be done inside
	 * a transaction, see the ->*_txn() methods.
	 */
	int  (*add)			(struct perf_event *event, int flags);
	void (*del)			(struct perf_event *event, int flags);

	/*
	 * Starts/Stops a counter present on the PMU. The PMI handler
	 * should stop the counter when perf_event_overflow() returns
	 * !0. ->start() will be used to continue.
	 */
	void (*start)			(struct perf_event *event, int flags);
	void (*stop)			(struct perf_event *event, int flags);

	/*
	 * Updates the counter value of the event.
	 */
246
	void (*read)			(struct perf_event *event);
247 248

	/*
249 250 251
	 * Group events scheduling is treated as a transaction, add
	 * group events as a whole and perform one schedulability test.
	 * If the test fails, roll back the whole group
P
Peter Zijlstra 已提交
252 253
	 *
	 * Start the transaction, after this ->add() doesn't need to
254
	 * do schedulability tests.
255
	 */
256
	void (*start_txn)		(struct pmu *pmu); /* optional */
257
	/*
P
Peter Zijlstra 已提交
258
	 * If ->start_txn() disabled the ->add() schedulability test
259 260 261 262
	 * then ->commit_txn() is required to perform one. On success
	 * the transaction is closed. On error the transaction is kept
	 * open until ->cancel_txn() is called.
	 */
263
	int  (*commit_txn)		(struct pmu *pmu); /* optional */
264
	/*
P
Peter Zijlstra 已提交
265
	 * Will cancel the transaction, assumes ->del() is called
L
Lucas De Marchi 已提交
266
	 * for each successful ->add() during the transaction.
267
	 */
268
	void (*cancel_txn)		(struct pmu *pmu); /* optional */
269 270 271 272 273 274

	/*
	 * Will return the value for perf_event_mmap_page::index for this event,
	 * if no implementation is provided it will default to: event->hw.idx + 1.
	 */
	int (*event_idx)		(struct perf_event *event); /*optional */
275

276 277 278 279 280
	/*
	 * context-switches callback
	 */
	void (*sched_task)		(struct perf_event_context *ctx,
					bool sched_in);
281 282 283 284
	/*
	 * PMU specific data size
	 */
	size_t				task_ctx_size;
285

286 287 288 289 290

	/*
	 * Return the count value for a counter.
	 */
	u64 (*count)			(struct perf_event *event); /*optional*/
291 292 293 294 295 296 297 298 299 300 301 302

	/*
	 * Set up pmu-private data structures for an AUX area
	 */
	void *(*setup_aux)		(int cpu, void **pages,
					 int nr_pages, bool overwrite);
					/* optional */

	/*
	 * Free pmu-private AUX data structures
	 */
	void (*free_aux)		(void *aux); /* optional */
I
Ingo Molnar 已提交
303 304
};

305
/**
306
 * enum perf_event_active_state - the states of a event
307
 */
308
enum perf_event_active_state {
309
	PERF_EVENT_STATE_EXIT		= -3,
I
Ingo Molnar 已提交
310
	PERF_EVENT_STATE_ERROR		= -2,
311 312
	PERF_EVENT_STATE_OFF		= -1,
	PERF_EVENT_STATE_INACTIVE	=  0,
I
Ingo Molnar 已提交
313
	PERF_EVENT_STATE_ACTIVE		=  1,
314 315
};

316
struct file;
317 318
struct perf_sample_data;

319
typedef void (*perf_overflow_handler_t)(struct perf_event *,
320 321 322
					struct perf_sample_data *,
					struct pt_regs *regs);

323
enum perf_group_flag {
324
	PERF_GROUP_SOFTWARE		= 0x1,
325 326
};

327 328
#define SWEVENT_HLIST_BITS		8
#define SWEVENT_HLIST_SIZE		(1 << SWEVENT_HLIST_BITS)
329 330

struct swevent_hlist {
331 332
	struct hlist_head		heads[SWEVENT_HLIST_SIZE];
	struct rcu_head			rcu_head;
333 334
};

335 336
#define PERF_ATTACH_CONTEXT	0x01
#define PERF_ATTACH_GROUP	0x02
337
#define PERF_ATTACH_TASK	0x04
338
#define PERF_ATTACH_TASK_DATA	0x08
339

340
struct perf_cgroup;
341 342
struct ring_buffer;

T
Thomas Gleixner 已提交
343
/**
344
 * struct perf_event - performance event kernel representation:
T
Thomas Gleixner 已提交
345
 */
346 347
struct perf_event {
#ifdef CONFIG_PERF_EVENTS
348 349 350 351 352
	/*
	 * entry onto perf_event_context::event_list;
	 *   modifications require ctx->lock
	 *   RCU safe iterations.
	 */
P
Peter Zijlstra 已提交
353
	struct list_head		event_entry;
354 355 356 357 358 359 360 361 362 363

	/*
	 * XXX: group_entry and sibling_list should be mutually exclusive;
	 * either you're a sibling on a group, or you're the group leader.
	 * Rework the code to always use the same list element.
	 *
	 * Locked for modification by both ctx->mutex and ctx->lock; holding
	 * either sufficies for read.
	 */
	struct list_head		group_entry;
364
	struct list_head		sibling_list;
365 366 367 368 369 370 371 372

	/*
	 * We need storage to track the entries in perf_pmu_migrate_context; we
	 * cannot use the event_entry because of RCU and we want to keep the
	 * group in tact which avoids us using the other two entries.
	 */
	struct list_head		migrate_entry;

373 374
	struct hlist_node		hlist_entry;
	struct list_head		active_entry;
I
Ingo Molnar 已提交
375
	int				nr_siblings;
376
	int				group_flags;
377
	struct perf_event		*group_leader;
P
Peter Zijlstra 已提交
378
	struct pmu			*pmu;
379

380
	enum perf_event_active_state	state;
381
	unsigned int			attach_state;
382
	local64_t			count;
383
	atomic64_t			child_count;
384

385
	/*
386
	 * These are the total time in nanoseconds that the event
387
	 * has been enabled (i.e. eligible to run, and the task has
388
	 * been scheduled in, if this is a per-task event)
389 390 391
	 * and running (scheduled onto the CPU), respectively.
	 *
	 * They are computed from tstamp_enabled, tstamp_running and
392
	 * tstamp_stopped when the event is in INACTIVE or ACTIVE state.
393 394 395 396 397 398
	 */
	u64				total_time_enabled;
	u64				total_time_running;

	/*
	 * These are timestamps used for computing total_time_enabled
399
	 * and total_time_running when the event is in INACTIVE or
400 401
	 * ACTIVE state, measured in nanoseconds from an arbitrary point
	 * in time.
402 403
	 * tstamp_enabled: the notional time when the event was enabled
	 * tstamp_running: the notional time when the event was scheduled on
404
	 * tstamp_stopped: in INACTIVE state, the notional time when the
405
	 *	event was scheduled off.
406 407 408 409 410
	 */
	u64				tstamp_enabled;
	u64				tstamp_running;
	u64				tstamp_stopped;

411 412 413 414 415 416 417 418 419 420
	/*
	 * timestamp shadows the actual context timing but it can
	 * be safely used in NMI interrupt context. It reflects the
	 * context time as it was when the event was last scheduled in.
	 *
	 * ctx_time already accounts for ctx->timestamp. Therefore to
	 * compute ctx_time for a sample, simply add perf_clock().
	 */
	u64				shadow_ctx_time;

421
	struct perf_event_attr		attr;
422
	u16				header_size;
423
	u16				id_header_size;
424
	u16				read_size;
425
	struct hw_perf_event		hw;
T
Thomas Gleixner 已提交
426

427
	struct perf_event_context	*ctx;
428
	atomic_long_t			refcount;
T
Thomas Gleixner 已提交
429

430 431
	/*
	 * These accumulate total time (in nanoseconds) that children
432
	 * events have been enabled and running, respectively.
433 434 435 436
	 */
	atomic64_t			child_total_time_enabled;
	atomic64_t			child_total_time_running;

T
Thomas Gleixner 已提交
437
	/*
438
	 * Protect attach/detach and child_list:
T
Thomas Gleixner 已提交
439
	 */
440 441
	struct mutex			child_mutex;
	struct list_head		child_list;
442
	struct perf_event		*parent;
T
Thomas Gleixner 已提交
443 444 445 446

	int				oncpu;
	int				cpu;

447 448 449
	struct list_head		owner_entry;
	struct task_struct		*owner;

450 451 452
	/* mmap bits */
	struct mutex			mmap_mutex;
	atomic_t			mmap_count;
P
Peter Zijlstra 已提交
453

454
	struct ring_buffer		*rb;
455
	struct list_head		rb_entry;
456 457
	unsigned long			rcu_batches;
	int				rcu_pending;
458

459
	/* poll related */
T
Thomas Gleixner 已提交
460
	wait_queue_head_t		waitq;
P
Peter Zijlstra 已提交
461
	struct fasync_struct		*fasync;
462 463 464

	/* delayed work for NMIs and such */
	int				pending_wakeup;
465
	int				pending_kill;
466
	int				pending_disable;
467
	struct irq_work			pending;
P
Peter Zijlstra 已提交
468

469 470
	atomic_t			event_limit;

471
	void (*destroy)(struct perf_event *);
P
Peter Zijlstra 已提交
472
	struct rcu_head			rcu_head;
473 474

	struct pid_namespace		*ns;
475
	u64				id;
L
Li Zefan 已提交
476

477
	u64				(*clock)(void);
478
	perf_overflow_handler_t		overflow_handler;
479
	void				*overflow_handler_context;
480

481
#ifdef CONFIG_EVENT_TRACING
482
	struct ftrace_event_call	*tp_event;
L
Li Zefan 已提交
483
	struct event_filter		*filter;
484 485 486
#ifdef CONFIG_FUNCTION_TRACER
	struct ftrace_ops               ftrace_ops;
#endif
487
#endif
L
Li Zefan 已提交
488

S
Stephane Eranian 已提交
489 490 491 492 493
#ifdef CONFIG_CGROUP_PERF
	struct perf_cgroup		*cgrp; /* cgroup event is attach to */
	int				cgrp_defer_enabled;
#endif

L
Li Zefan 已提交
494
#endif /* CONFIG_PERF_EVENTS */
T
Thomas Gleixner 已提交
495 496 497
};

/**
498
 * struct perf_event_context - event context structure
T
Thomas Gleixner 已提交
499
 *
500
 * Used as a container for task events and CPU events as well:
T
Thomas Gleixner 已提交
501
 */
502
struct perf_event_context {
P
Peter Zijlstra 已提交
503
	struct pmu			*pmu;
T
Thomas Gleixner 已提交
504
	/*
505
	 * Protect the states of the events in the list,
506
	 * nr_active, and the list:
T
Thomas Gleixner 已提交
507
	 */
508
	raw_spinlock_t			lock;
509
	/*
510
	 * Protect the list of events.  Locking either mutex or lock
511 512 513
	 * 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 已提交
514
	struct mutex			mutex;
515

516
	struct list_head		active_ctx_list;
517 518
	struct list_head		pinned_groups;
	struct list_head		flexible_groups;
I
Ingo Molnar 已提交
519
	struct list_head		event_list;
520
	int				nr_events;
I
Ingo Molnar 已提交
521 522
	int				nr_active;
	int				is_active;
523
	int				nr_stat;
524
	int				nr_freq;
525
	int				rotate_disable;
I
Ingo Molnar 已提交
526 527
	atomic_t			refcount;
	struct task_struct		*task;
528 529

	/*
530
	 * Context clock, runs when context enabled.
531
	 */
I
Ingo Molnar 已提交
532 533
	u64				time;
	u64				timestamp;
534 535 536 537 538

	/*
	 * These fields let us detect when two contexts have both
	 * been cloned (inherited) from a common ancestor.
	 */
539
	struct perf_event_context	*parent_ctx;
I
Ingo Molnar 已提交
540 541 542
	u64				parent_gen;
	u64				generation;
	int				pin_count;
543
	int				nr_cgroups;	 /* cgroup evts */
544
	void				*task_ctx_data; /* pmu specific data */
545
	struct rcu_head			rcu_head;
546 547 548

	struct delayed_work		orphans_remove;
	bool				orphans_remove_sched;
T
Thomas Gleixner 已提交
549 550
};

551 552
/*
 * Number of contexts where an event can trigger:
553
 *	task, softirq, hardirq, nmi.
554 555 556
 */
#define PERF_NR_CONTEXTS	4

T
Thomas Gleixner 已提交
557
/**
558
 * struct perf_event_cpu_context - per cpu event context structure
T
Thomas Gleixner 已提交
559 560
 */
struct perf_cpu_context {
561 562
	struct perf_event_context	ctx;
	struct perf_event_context	*task_ctx;
T
Thomas Gleixner 已提交
563
	int				active_oncpu;
564
	int				exclusive;
565 566
	struct hrtimer			hrtimer;
	ktime_t				hrtimer_interval;
567
	struct pmu			*unique_pmu;
S
Stephane Eranian 已提交
568
	struct perf_cgroup		*cgrp;
T
Thomas Gleixner 已提交
569 570
};

571
struct perf_output_handle {
I
Ingo Molnar 已提交
572
	struct perf_event		*event;
573
	struct ring_buffer		*rb;
574
	unsigned long			wakeup;
575 576 577
	unsigned long			size;
	void				*addr;
	int				page;
578 579
};

580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608
#ifdef CONFIG_CGROUP_PERF

/*
 * perf_cgroup_info keeps track of time_enabled for a cgroup.
 * This is a per-cpu dynamically allocated data structure.
 */
struct perf_cgroup_info {
	u64				time;
	u64				timestamp;
};

struct perf_cgroup {
	struct cgroup_subsys_state	css;
	struct perf_cgroup_info	__percpu *info;
};

/*
 * Must ensure cgroup is pinned (css_get) before calling
 * this function. In other words, we cannot call this function
 * if there is no cgroup event for the current CPU context.
 */
static inline struct perf_cgroup *
perf_cgroup_from_task(struct task_struct *task)
{
	return container_of(task_css(task, perf_event_cgrp_id),
			    struct perf_cgroup, css);
}
#endif /* CONFIG_CGROUP_PERF */

609
#ifdef CONFIG_PERF_EVENTS
610

611
extern int perf_pmu_register(struct pmu *pmu, const char *name, int type);
612
extern void perf_pmu_unregister(struct pmu *pmu);
I
Ingo Molnar 已提交
613

614
extern int perf_num_counters(void);
615
extern const char *perf_pmu_name(void);
616 617 618 619
extern void __perf_event_task_sched_in(struct task_struct *prev,
				       struct task_struct *task);
extern void __perf_event_task_sched_out(struct task_struct *prev,
					struct task_struct *next);
620 621 622
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);
623
extern void perf_event_delayed_put(struct task_struct *task);
624
extern void perf_event_print_debug(void);
P
Peter Zijlstra 已提交
625 626
extern void perf_pmu_disable(struct pmu *pmu);
extern void perf_pmu_enable(struct pmu *pmu);
627 628
extern void perf_sched_cb_dec(struct pmu *pmu);
extern void perf_sched_cb_inc(struct pmu *pmu);
629 630
extern int perf_event_task_disable(void);
extern int perf_event_task_enable(void);
631
extern int perf_event_refresh(struct perf_event *event, int refresh);
632
extern void perf_event_update_userpage(struct perf_event *event);
633 634 635 636
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,
M
Matt Helsley 已提交
637
				struct task_struct *task,
638 639
				perf_overflow_handler_t callback,
				void *context);
640 641
extern void perf_pmu_migrate_context(struct pmu *pmu,
				int src_cpu, int dst_cpu);
642 643
extern u64 perf_event_read_value(struct perf_event *event,
				 u64 *enabled, u64 *running);
644

645

646
struct perf_sample_data {
647 648 649 650 651 652 653 654 655 656 657
	/*
	 * Fields set by perf_sample_data_init(), group so as to
	 * minimize the cachelines touched.
	 */
	u64				addr;
	struct perf_raw_record		*raw;
	struct perf_branch_stack	*br_stack;
	u64				period;
	u64				weight;
	u64				txn;
	union  perf_mem_data_src	data_src;
658

659 660 661 662 663
	/*
	 * The other fields, optionally {set,used} by
	 * perf_{prepare,output}_sample().
	 */
	u64				type;
664 665 666 667 668 669 670 671 672 673 674 675 676
	u64				ip;
	struct {
		u32	pid;
		u32	tid;
	}				tid_entry;
	u64				time;
	u64				id;
	u64				stream_id;
	struct {
		u32	cpu;
		u32	reserved;
	}				cpu_entry;
	struct perf_callchain_entry	*callchain;
677 678 679 680 681

	/*
	 * regs_user may point to task_pt_regs or to regs_user_copy, depending
	 * on arch details.
	 */
682
	struct perf_regs		regs_user;
683 684
	struct pt_regs			regs_user_copy;

685
	struct perf_regs		regs_intr;
686
	u64				stack_user_size;
687
} ____cacheline_aligned;
688

689 690 691 692 693 694 695
/* default value for data source */
#define PERF_MEM_NA (PERF_MEM_S(OP, NA)   |\
		    PERF_MEM_S(LVL, NA)   |\
		    PERF_MEM_S(SNOOP, NA) |\
		    PERF_MEM_S(LOCK, NA)  |\
		    PERF_MEM_S(TLB, NA))

696 697
static inline void perf_sample_data_init(struct perf_sample_data *data,
					 u64 addr, u64 period)
698
{
699
	/* remaining struct members initialized in perf_prepare_sample() */
700 701
	data->addr = addr;
	data->raw  = NULL;
702
	data->br_stack = NULL;
703
	data->period = period;
A
Andi Kleen 已提交
704
	data->weight = 0;
705
	data->data_src.val = PERF_MEM_NA;
A
Andi Kleen 已提交
706
	data->txn = 0;
707 708
}

709 710 711
extern void perf_output_sample(struct perf_output_handle *handle,
			       struct perf_event_header *header,
			       struct perf_sample_data *data,
712
			       struct perf_event *event);
713 714
extern void perf_prepare_sample(struct perf_event_header *header,
				struct perf_sample_data *data,
715
				struct perf_event *event,
716 717
				struct pt_regs *regs);

718
extern int perf_event_overflow(struct perf_event *event,
719 720
				 struct perf_sample_data *data,
				 struct pt_regs *regs);
721

722 723 724 725 726
static inline bool is_sampling_event(struct perf_event *event)
{
	return event->attr.sample_period != 0;
}

727
/*
728
 * Return 1 for a software event, 0 for a hardware event
729
 */
730
static inline int is_software_event(struct perf_event *event)
731
{
732
	return event->pmu->task_ctx_nr == perf_sw_context;
733 734
}

735
extern struct static_key perf_swevent_enabled[PERF_COUNT_SW_MAX];
736

737
extern void ___perf_sw_event(u32, u64, struct pt_regs *, u64);
738
extern void __perf_sw_event(u32, u64, struct pt_regs *, u64);
739

740
#ifndef perf_arch_fetch_caller_regs
741
static inline void perf_arch_fetch_caller_regs(struct pt_regs *regs, unsigned long ip) { }
742
#endif
743 744 745 746 747 748 749 750 751

/*
 * Take a snapshot of the regs. Skip ip and frame pointer to
 * the nth caller. We only need a few of the regs:
 * - ip for PERF_SAMPLE_IP
 * - cs for user_mode() tests
 * - bp for callchains
 * - eflags, for future purposes, just in case
 */
752
static inline void perf_fetch_caller_regs(struct pt_regs *regs)
753 754 755
{
	memset(regs, 0, sizeof(*regs));

756
	perf_arch_fetch_caller_regs(regs, CALLER_ADDR0);
757 758
}

P
Peter Zijlstra 已提交
759
static __always_inline void
760
perf_sw_event(u32 event_id, u64 nr, struct pt_regs *regs, u64 addr)
761
{
762 763 764 765 766
	if (static_key_false(&perf_swevent_enabled[event_id]))
		__perf_sw_event(event_id, nr, regs, addr);
}

DECLARE_PER_CPU(struct pt_regs, __perf_regs[4]);
P
Peter Zijlstra 已提交
767

768 769 770 771 772 773 774 775
/*
 * 'Special' version for the scheduler, it hard assumes no recursion,
 * which is guaranteed by us not actually scheduling inside other swevents
 * because those disable preemption.
 */
static __always_inline void
perf_sw_event_sched(u32 event_id, u64 nr, u64 addr)
{
776
	if (static_key_false(&perf_swevent_enabled[event_id])) {
777 778 779 780
		struct pt_regs *regs = this_cpu_ptr(&__perf_regs[0]);

		perf_fetch_caller_regs(regs);
		___perf_sw_event(event_id, nr, regs, addr);
781 782 783
	}
}

784
extern struct static_key_deferred perf_sched_events;
785

786
static inline void perf_event_task_sched_in(struct task_struct *prev,
787
					    struct task_struct *task)
788 789 790 791 792 793 794
{
	if (static_key_false(&perf_sched_events.key))
		__perf_event_task_sched_in(prev, task);
}

static inline void perf_event_task_sched_out(struct task_struct *prev,
					     struct task_struct *next)
795
{
796
	perf_sw_event_sched(PERF_COUNT_SW_CONTEXT_SWITCHES, 1, 0);
797

798
	if (static_key_false(&perf_sched_events.key))
799
		__perf_event_task_sched_out(prev, next);
800 801
}

802 803 804 805 806
static inline u64 __perf_event_count(struct perf_event *event)
{
	return local64_read(&event->count) + atomic64_read(&event->child_count);
}

807
extern void perf_event_mmap(struct vm_area_struct *vma);
808
extern struct perf_guest_info_callbacks *perf_guest_cbs;
809 810
extern int perf_register_guest_info_callbacks(struct perf_guest_info_callbacks *callbacks);
extern int perf_unregister_guest_info_callbacks(struct perf_guest_info_callbacks *callbacks);
811

812
extern void perf_event_exec(void);
813
extern void perf_event_comm(struct task_struct *tsk, bool exec);
814
extern void perf_event_fork(struct task_struct *tsk);
815

816 817 818
/* Callchains */
DECLARE_PER_CPU(struct perf_callchain_entry, perf_callchain_entry);

819 820
extern void perf_callchain_user(struct perf_callchain_entry *entry, struct pt_regs *regs);
extern void perf_callchain_kernel(struct perf_callchain_entry *entry, struct pt_regs *regs);
821

822
static inline void perf_callchain_store(struct perf_callchain_entry *entry, u64 ip)
823 824 825 826
{
	if (entry->nr < PERF_MAX_STACK_DEPTH)
		entry->ip[entry->nr++] = ip;
}
827

828 829 830
extern int sysctl_perf_event_paranoid;
extern int sysctl_perf_event_mlock;
extern int sysctl_perf_event_sample_rate;
831 832 833
extern int sysctl_perf_cpu_time_max_percent;

extern void perf_sample_event_took(u64 sample_len_ns);
834

P
Peter Zijlstra 已提交
835 836 837
extern int perf_proc_update_handler(struct ctl_table *table, int write,
		void __user *buffer, size_t *lenp,
		loff_t *ppos);
838 839 840 841
extern int perf_cpu_time_max_percent_handler(struct ctl_table *table, int write,
		void __user *buffer, size_t *lenp,
		loff_t *ppos);

P
Peter Zijlstra 已提交
842

843 844 845 846 847 848 849 850 851 852 853 854 855 856 857
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;
}

858
extern void perf_event_init(void);
859 860
extern void perf_tp_event(u64 addr, u64 count, void *record,
			  int entry_size, struct pt_regs *regs,
861 862
			  struct hlist_head *head, int rctx,
			  struct task_struct *task);
863
extern void perf_bp_event(struct perf_event *event, void *data);
864

865
#ifndef perf_misc_flags
866 867 868
# define perf_misc_flags(regs) \
		(user_mode(regs) ? PERF_RECORD_MISC_USER : PERF_RECORD_MISC_KERNEL)
# define perf_instruction_pointer(regs)	instruction_pointer(regs)
869 870
#endif

871 872 873
static inline bool has_branch_stack(struct perf_event *event)
{
	return event->attr.sample_type & PERF_SAMPLE_BRANCH_STACK;
874 875 876 877 878
}

static inline bool needs_branch_stack(struct perf_event *event)
{
	return event->attr.branch_sample_type != 0;
879 880
}

881 882 883 884 885
static inline bool has_aux(struct perf_event *event)
{
	return event->pmu->setup_aux;
}

886
extern int perf_output_begin(struct perf_output_handle *handle,
887
			     struct perf_event *event, unsigned int size);
888
extern void perf_output_end(struct perf_output_handle *handle);
889
extern unsigned int perf_output_copy(struct perf_output_handle *handle,
890
			     const void *buf, unsigned int len);
891 892
extern unsigned int perf_output_skip(struct perf_output_handle *handle,
				     unsigned int len);
893 894
extern int perf_swevent_get_recursion_context(void);
extern void perf_swevent_put_recursion_context(int rctx);
895
extern u64 perf_swevent_set_period(struct perf_event *event);
896 897
extern void perf_event_enable(struct perf_event *event);
extern void perf_event_disable(struct perf_event *event);
898
extern int __perf_event_disable(void *info);
899
extern void perf_event_task_tick(void);
900
#else /* !CONFIG_PERF_EVENTS: */
T
Thomas Gleixner 已提交
901
static inline void
902 903 904 905 906
perf_event_task_sched_in(struct task_struct *prev,
			 struct task_struct *task)			{ }
static inline void
perf_event_task_sched_out(struct task_struct *prev,
			  struct task_struct *next)			{ }
907 908 909
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)	{ }
910
static inline void perf_event_delayed_put(struct task_struct *task)	{ }
I
Ingo Molnar 已提交
911 912 913
static inline void perf_event_print_debug(void)				{ }
static inline int perf_event_task_disable(void)				{ return -EINVAL; }
static inline int perf_event_task_enable(void)				{ return -EINVAL; }
914 915 916 917
static inline int perf_event_refresh(struct perf_event *event, int refresh)
{
	return -EINVAL;
}
918

919
static inline void
920
perf_sw_event(u32 event_id, u64 nr, struct pt_regs *regs, u64 addr)	{ }
921
static inline void
922 923
perf_sw_event_sched(u32 event_id, u64 nr, u64 addr)			{ }
static inline void
924
perf_bp_event(struct perf_event *event, void *data)			{ }
925

926
static inline int perf_register_guest_info_callbacks
927
(struct perf_guest_info_callbacks *callbacks)				{ return 0; }
928
static inline int perf_unregister_guest_info_callbacks
929
(struct perf_guest_info_callbacks *callbacks)				{ return 0; }
930

I
Ingo Molnar 已提交
931
static inline void perf_event_mmap(struct vm_area_struct *vma)		{ }
932
static inline void perf_event_exec(void)				{ }
933
static inline void perf_event_comm(struct task_struct *tsk, bool exec)	{ }
934 935
static inline void perf_event_fork(struct task_struct *tsk)		{ }
static inline void perf_event_init(void)				{ }
936
static inline int  perf_swevent_get_recursion_context(void)		{ return -1; }
937
static inline void perf_swevent_put_recursion_context(int rctx)		{ }
938
static inline u64 perf_swevent_set_period(struct perf_event *event)	{ return 0; }
939 940
static inline void perf_event_enable(struct perf_event *event)		{ }
static inline void perf_event_disable(struct perf_event *event)		{ }
941
static inline int __perf_event_disable(void *info)			{ return -1; }
942
static inline void perf_event_task_tick(void)				{ }
T
Thomas Gleixner 已提交
943 944
#endif

945 946 947 948 949 950
#if defined(CONFIG_PERF_EVENTS) && defined(CONFIG_NO_HZ_FULL)
extern bool perf_event_can_stop_tick(void);
#else
static inline bool perf_event_can_stop_tick(void)			{ return true; }
#endif

951 952 953
#if defined(CONFIG_PERF_EVENTS) && defined(CONFIG_CPU_SUP_INTEL)
extern void perf_restore_debug_store(void);
#else
954
static inline void perf_restore_debug_store(void)			{ }
T
Thomas Gleixner 已提交
955 956
#endif

957
#define perf_output_put(handle, x) perf_output_copy((handle), &(x), sizeof(x))
958

959
/*
960
 * This has to have a higher priority than migration_notifier in sched/core.c.
961
 */
962 963
#define perf_cpu_notifier(fn)						\
do {									\
964
	static struct notifier_block fn##_nb =				\
965
		{ .notifier_call = fn, .priority = CPU_PRI_PERF };	\
966
	unsigned long cpu = smp_processor_id();				\
967
	unsigned long flags;						\
968 969
									\
	cpu_notifier_register_begin();					\
970
	fn(&fn##_nb, (unsigned long)CPU_UP_PREPARE,			\
971
		(void *)(unsigned long)cpu);				\
972
	local_irq_save(flags);						\
973
	fn(&fn##_nb, (unsigned long)CPU_STARTING,			\
974
		(void *)(unsigned long)cpu);				\
975
	local_irq_restore(flags);					\
976
	fn(&fn##_nb, (unsigned long)CPU_ONLINE,				\
977
		(void *)(unsigned long)cpu);				\
978 979
	__register_cpu_notifier(&fn##_nb);				\
	cpu_notifier_register_done();					\
980 981
} while (0)

982 983 984 985 986 987 988 989 990 991 992
/*
 * Bare-bones version of perf_cpu_notifier(), which doesn't invoke the
 * callback for already online CPUs.
 */
#define __perf_cpu_notifier(fn)						\
do {									\
	static struct notifier_block fn##_nb =				\
		{ .notifier_call = fn, .priority = CPU_PRI_PERF };	\
									\
	__register_cpu_notifier(&fn##_nb);				\
} while (0)
993

994 995 996
struct perf_pmu_events_attr {
	struct device_attribute attr;
	u64 id;
997
	const char *event_str;
998 999
};

1000 1001 1002
ssize_t perf_event_sysfs_show(struct device *dev, struct device_attribute *attr,
			      char *page);

1003 1004 1005 1006 1007 1008
#define PMU_EVENT_ATTR(_name, _var, _id, _show)				\
static struct perf_pmu_events_attr _var = {				\
	.attr = __ATTR(_name, 0444, _show, NULL),			\
	.id   =  _id,							\
};

1009 1010 1011 1012 1013 1014 1015
#define PMU_EVENT_ATTR_STRING(_name, _var, _str)			    \
static struct perf_pmu_events_attr _var = {				    \
	.attr		= __ATTR(_name, 0444, perf_event_sysfs_show, NULL), \
	.id		= 0,						    \
	.event_str	= _str,						    \
};

1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027
#define PMU_FORMAT_ATTR(_name, _format)					\
static ssize_t								\
_name##_show(struct device *dev,					\
			       struct device_attribute *attr,		\
			       char *page)				\
{									\
	BUILD_BUG_ON(sizeof(_format) >= PAGE_SIZE);			\
	return sprintf(page, _format "\n");				\
}									\
									\
static struct device_attribute format_attr_##_name = __ATTR_RO(_name)

1028
#endif /* _LINUX_PERF_EVENT_H */