]> git.proxmox.com Git - mirror_ubuntu-bionic-kernel.git/blame - include/linux/perf_event.h
perf/x86/intel: Fix Makefile to actually build the cqm driver
[mirror_ubuntu-bionic-kernel.git] / include / linux / perf_event.h
CommitLineData
0793a61d 1/*
57c0c15b 2 * Performance events:
0793a61d 3 *
a308444c 4 * Copyright (C) 2008-2009, Thomas Gleixner <tglx@linutronix.de>
e7e7ee2e
IM
5 * Copyright (C) 2008-2011, Red Hat, Inc., Ingo Molnar
6 * Copyright (C) 2008-2011, 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
607ca46e 17#include <uapi/linux/perf_event.h>
0793a61d 18
9f66a381 19/*
f3dfd265 20 * Kernel-internal data types and definitions:
9f66a381
IM
21 */
22
cdd6c482
IM
23#ifdef CONFIG_PERF_EVENTS
24# include <asm/perf_event.h>
7be79236 25# include <asm/local64.h>
f3dfd265
PM
26#endif
27
39447b38 28struct perf_guest_info_callbacks {
e7e7ee2e
IM
29 int (*is_in_guest)(void);
30 int (*is_user_mode)(void);
31 unsigned long (*get_guest_ip)(void);
39447b38
ZY
32};
33
2ff6cfd7
AB
34#ifdef CONFIG_HAVE_HW_BREAKPOINT
35#include <asm/hw_breakpoint.h>
36#endif
37
f3dfd265
PM
38#include <linux/list.h>
39#include <linux/mutex.h>
40#include <linux/rculist.h>
41#include <linux/rcupdate.h>
42#include <linux/spinlock.h>
d6d020e9 43#include <linux/hrtimer.h>
3c446b3d 44#include <linux/fs.h>
709e50cf 45#include <linux/pid_namespace.h>
906010b2 46#include <linux/workqueue.h>
5331d7b8 47#include <linux/ftrace.h>
85cfabbc 48#include <linux/cpu.h>
e360adbe 49#include <linux/irq_work.h>
c5905afb 50#include <linux/static_key.h>
851cf6e7 51#include <linux/jump_label_ratelimit.h>
60063497 52#include <linux/atomic.h>
641cc938 53#include <linux/sysfs.h>
4018994f 54#include <linux/perf_regs.h>
fadfe7be 55#include <linux/workqueue.h>
39bed6cb 56#include <linux/cgroup.h>
fa588151 57#include <asm/local.h>
f3dfd265 58
f9188e02
PZ
59struct perf_callchain_entry {
60 __u64 nr;
61 __u64 ip[PERF_MAX_STACK_DEPTH];
62};
63
3a43ce68
FW
64struct perf_raw_record {
65 u32 size;
66 void *data;
f413cdb8
FW
67};
68
bce38cd5
SE
69/*
70 * branch stack layout:
71 * nr: number of taken branches stored in entries[]
72 *
73 * Note that nr can vary from sample to sample
74 * branches (to, from) are stored from most recent
75 * to least recent, i.e., entries[0] contains the most
76 * recent branch.
77 */
caff2bef
PZ
78struct perf_branch_stack {
79 __u64 nr;
80 struct perf_branch_entry entries[0];
81};
82
f3dfd265
PM
83struct task_struct;
84
efc9f05d
SE
85/*
86 * extra PMU register associated with an event
87 */
88struct hw_perf_event_extra {
89 u64 config; /* register value */
90 unsigned int reg; /* register address or index */
91 int alloc; /* extra register already allocated */
92 int idx; /* index in shared_regs->regs[] */
93};
94
43b45780
AH
95struct event_constraint;
96
0793a61d 97/**
cdd6c482 98 * struct hw_perf_event - performance event hardware details:
0793a61d 99 */
cdd6c482
IM
100struct hw_perf_event {
101#ifdef CONFIG_PERF_EVENTS
d6d020e9
PZ
102 union {
103 struct { /* hardware */
a308444c 104 u64 config;
447a194b 105 u64 last_tag;
a308444c 106 unsigned long config_base;
cdd6c482 107 unsigned long event_base;
c48b6053 108 int event_base_rdpmc;
a308444c 109 int idx;
447a194b 110 int last_cpu;
9fac2cf3 111 int flags;
bce38cd5 112
efc9f05d 113 struct hw_perf_event_extra extra_reg;
bce38cd5 114 struct hw_perf_event_extra branch_reg;
43b45780
AH
115
116 struct event_constraint *constraint;
d6d020e9 117 };
721a669b 118 struct { /* software */
a308444c 119 struct hrtimer hrtimer;
d6d020e9 120 };
f22c1bb6
ON
121 struct { /* tracepoint */
122 struct task_struct *tp_target;
123 /* for tp_event->class */
124 struct list_head tp_list;
125 };
4afbb24c
MF
126 struct { /* intel_cqm */
127 int cqm_state;
128 int cqm_rmid;
129 struct list_head cqm_events_entry;
130 struct list_head cqm_groups_entry;
131 struct list_head cqm_group_entry;
bfe1fcd2 132 struct task_struct *cqm_target;
4afbb24c 133 };
24f1e32c 134#ifdef CONFIG_HAVE_HW_BREAKPOINT
45a73372 135 struct { /* breakpoint */
d580ff86
PZ
136 /*
137 * Crufty hack to avoid the chicken and egg
138 * problem hw_breakpoint has with context
139 * creation and event initalization.
140 */
141 struct task_struct *bp_target;
f22c1bb6
ON
142 struct arch_hw_breakpoint info;
143 struct list_head bp_list;
45a73372 144 };
24f1e32c 145#endif
d6d020e9 146 };
a4eaf7f1 147 int state;
e7850595 148 local64_t prev_count;
b23f3325 149 u64 sample_period;
9e350de3 150 u64 last_period;
e7850595 151 local64_t period_left;
e050e3f0 152 u64 interrupts_seq;
60db5e09 153 u64 interrupts;
6a24ed6c 154
abd50713
PZ
155 u64 freq_time_stamp;
156 u64 freq_count_stamp;
ee06094f 157#endif
0793a61d
TG
158};
159
a4eaf7f1
PZ
160/*
161 * hw_perf_event::state flags
162 */
163#define PERF_HES_STOPPED 0x01 /* the counter is stopped */
164#define PERF_HES_UPTODATE 0x02 /* event->count up-to-date */
165#define PERF_HES_ARCH 0x04
166
cdd6c482 167struct perf_event;
621a01ea 168
8d2cacbb
PZ
169/*
170 * Common implementation detail of pmu::{start,commit,cancel}_txn
171 */
172#define PERF_EVENT_TXN 0x1
6bde9b6c 173
53b25335
VW
174/**
175 * pmu::capabilities flags
176 */
177#define PERF_PMU_CAP_NO_INTERRUPT 0x01
178
621a01ea 179/**
4aeb0b42 180 * struct pmu - generic performance monitoring unit
621a01ea 181 */
4aeb0b42 182struct pmu {
b0a873eb
PZ
183 struct list_head entry;
184
c464c76e 185 struct module *module;
abe43400 186 struct device *dev;
0c9d42ed 187 const struct attribute_group **attr_groups;
03d8e80b 188 const char *name;
2e80a82a
PZ
189 int type;
190
53b25335
VW
191 /*
192 * various common per-pmu feature flags
193 */
194 int capabilities;
195
108b02cf
PZ
196 int * __percpu pmu_disable_count;
197 struct perf_cpu_context * __percpu pmu_cpu_context;
8dc85d54 198 int task_ctx_nr;
62b85639 199 int hrtimer_interval_ms;
6bde9b6c
LM
200
201 /*
a4eaf7f1
PZ
202 * Fully disable/enable this PMU, can be used to protect from the PMI
203 * as well as for lazy/batch writing of the MSRs.
6bde9b6c 204 */
ad5133b7
PZ
205 void (*pmu_enable) (struct pmu *pmu); /* optional */
206 void (*pmu_disable) (struct pmu *pmu); /* optional */
6bde9b6c 207
8d2cacbb 208 /*
a4eaf7f1 209 * Try and initialize the event for this PMU.
24cd7f54 210 * Should return -ENOENT when the @event doesn't match this PMU.
8d2cacbb 211 */
b0a873eb
PZ
212 int (*event_init) (struct perf_event *event);
213
1e0fb9ec
AL
214 /*
215 * Notification that the event was mapped or unmapped. Called
216 * in the context of the mapping task.
217 */
218 void (*event_mapped) (struct perf_event *event); /*optional*/
219 void (*event_unmapped) (struct perf_event *event); /*optional*/
220
a4eaf7f1
PZ
221#define PERF_EF_START 0x01 /* start the counter when adding */
222#define PERF_EF_RELOAD 0x02 /* reload the counter when starting */
223#define PERF_EF_UPDATE 0x04 /* update the counter when stopping */
224
8d2cacbb 225 /*
a4eaf7f1
PZ
226 * Adds/Removes a counter to/from the PMU, can be done inside
227 * a transaction, see the ->*_txn() methods.
228 */
229 int (*add) (struct perf_event *event, int flags);
230 void (*del) (struct perf_event *event, int flags);
231
232 /*
233 * Starts/Stops a counter present on the PMU. The PMI handler
234 * should stop the counter when perf_event_overflow() returns
235 * !0. ->start() will be used to continue.
236 */
237 void (*start) (struct perf_event *event, int flags);
238 void (*stop) (struct perf_event *event, int flags);
239
240 /*
241 * Updates the counter value of the event.
242 */
cdd6c482 243 void (*read) (struct perf_event *event);
6bde9b6c
LM
244
245 /*
24cd7f54
PZ
246 * Group events scheduling is treated as a transaction, add
247 * group events as a whole and perform one schedulability test.
248 * If the test fails, roll back the whole group
a4eaf7f1
PZ
249 *
250 * Start the transaction, after this ->add() doesn't need to
24cd7f54 251 * do schedulability tests.
8d2cacbb 252 */
e7e7ee2e 253 void (*start_txn) (struct pmu *pmu); /* optional */
8d2cacbb 254 /*
a4eaf7f1 255 * If ->start_txn() disabled the ->add() schedulability test
8d2cacbb
PZ
256 * then ->commit_txn() is required to perform one. On success
257 * the transaction is closed. On error the transaction is kept
258 * open until ->cancel_txn() is called.
259 */
e7e7ee2e 260 int (*commit_txn) (struct pmu *pmu); /* optional */
8d2cacbb 261 /*
a4eaf7f1 262 * Will cancel the transaction, assumes ->del() is called
25985edc 263 * for each successful ->add() during the transaction.
8d2cacbb 264 */
e7e7ee2e 265 void (*cancel_txn) (struct pmu *pmu); /* optional */
35edc2a5
PZ
266
267 /*
268 * Will return the value for perf_event_mmap_page::index for this event,
269 * if no implementation is provided it will default to: event->hw.idx + 1.
270 */
271 int (*event_idx) (struct perf_event *event); /*optional */
d010b332 272
ba532500
YZ
273 /*
274 * context-switches callback
275 */
276 void (*sched_task) (struct perf_event_context *ctx,
277 bool sched_in);
4af57ef2
YZ
278 /*
279 * PMU specific data size
280 */
281 size_t task_ctx_size;
ba532500 282
eacd3ecc
MF
283
284 /*
285 * Return the count value for a counter.
286 */
287 u64 (*count) (struct perf_event *event); /*optional*/
621a01ea
IM
288};
289
6a930700 290/**
cdd6c482 291 * enum perf_event_active_state - the states of a event
6a930700 292 */
cdd6c482 293enum perf_event_active_state {
179033b3 294 PERF_EVENT_STATE_EXIT = -3,
57c0c15b 295 PERF_EVENT_STATE_ERROR = -2,
cdd6c482
IM
296 PERF_EVENT_STATE_OFF = -1,
297 PERF_EVENT_STATE_INACTIVE = 0,
57c0c15b 298 PERF_EVENT_STATE_ACTIVE = 1,
6a930700
IM
299};
300
9b51f66d 301struct file;
453f19ee
PZ
302struct perf_sample_data;
303
a8b0ca17 304typedef void (*perf_overflow_handler_t)(struct perf_event *,
b326e956
FW
305 struct perf_sample_data *,
306 struct pt_regs *regs);
307
d6f962b5 308enum perf_group_flag {
e7e7ee2e 309 PERF_GROUP_SOFTWARE = 0x1,
d6f962b5
FW
310};
311
e7e7ee2e
IM
312#define SWEVENT_HLIST_BITS 8
313#define SWEVENT_HLIST_SIZE (1 << SWEVENT_HLIST_BITS)
76e1d904
FW
314
315struct swevent_hlist {
e7e7ee2e
IM
316 struct hlist_head heads[SWEVENT_HLIST_SIZE];
317 struct rcu_head rcu_head;
76e1d904
FW
318};
319
8a49542c
PZ
320#define PERF_ATTACH_CONTEXT 0x01
321#define PERF_ATTACH_GROUP 0x02
d580ff86 322#define PERF_ATTACH_TASK 0x04
4af57ef2 323#define PERF_ATTACH_TASK_DATA 0x08
8a49542c 324
877c6856 325struct perf_cgroup;
76369139
FW
326struct ring_buffer;
327
0793a61d 328/**
cdd6c482 329 * struct perf_event - performance event kernel representation:
0793a61d 330 */
cdd6c482
IM
331struct perf_event {
332#ifdef CONFIG_PERF_EVENTS
9886167d
PZ
333 /*
334 * entry onto perf_event_context::event_list;
335 * modifications require ctx->lock
336 * RCU safe iterations.
337 */
592903cd 338 struct list_head event_entry;
9886167d
PZ
339
340 /*
341 * XXX: group_entry and sibling_list should be mutually exclusive;
342 * either you're a sibling on a group, or you're the group leader.
343 * Rework the code to always use the same list element.
344 *
345 * Locked for modification by both ctx->mutex and ctx->lock; holding
346 * either sufficies for read.
347 */
348 struct list_head group_entry;
04289bb9 349 struct list_head sibling_list;
9886167d
PZ
350
351 /*
352 * We need storage to track the entries in perf_pmu_migrate_context; we
353 * cannot use the event_entry because of RCU and we want to keep the
354 * group in tact which avoids us using the other two entries.
355 */
356 struct list_head migrate_entry;
357
f3ae75de
SE
358 struct hlist_node hlist_entry;
359 struct list_head active_entry;
0127c3ea 360 int nr_siblings;
d6f962b5 361 int group_flags;
cdd6c482 362 struct perf_event *group_leader;
a4eaf7f1 363 struct pmu *pmu;
04289bb9 364
cdd6c482 365 enum perf_event_active_state state;
8a49542c 366 unsigned int attach_state;
e7850595 367 local64_t count;
a6e6dea6 368 atomic64_t child_count;
ee06094f 369
53cfbf59 370 /*
cdd6c482 371 * These are the total time in nanoseconds that the event
53cfbf59 372 * has been enabled (i.e. eligible to run, and the task has
cdd6c482 373 * been scheduled in, if this is a per-task event)
53cfbf59
PM
374 * and running (scheduled onto the CPU), respectively.
375 *
376 * They are computed from tstamp_enabled, tstamp_running and
cdd6c482 377 * tstamp_stopped when the event is in INACTIVE or ACTIVE state.
53cfbf59
PM
378 */
379 u64 total_time_enabled;
380 u64 total_time_running;
381
382 /*
383 * These are timestamps used for computing total_time_enabled
cdd6c482 384 * and total_time_running when the event is in INACTIVE or
53cfbf59
PM
385 * ACTIVE state, measured in nanoseconds from an arbitrary point
386 * in time.
cdd6c482
IM
387 * tstamp_enabled: the notional time when the event was enabled
388 * tstamp_running: the notional time when the event was scheduled on
53cfbf59 389 * tstamp_stopped: in INACTIVE state, the notional time when the
cdd6c482 390 * event was scheduled off.
53cfbf59
PM
391 */
392 u64 tstamp_enabled;
393 u64 tstamp_running;
394 u64 tstamp_stopped;
395
eed01528
SE
396 /*
397 * timestamp shadows the actual context timing but it can
398 * be safely used in NMI interrupt context. It reflects the
399 * context time as it was when the event was last scheduled in.
400 *
401 * ctx_time already accounts for ctx->timestamp. Therefore to
402 * compute ctx_time for a sample, simply add perf_clock().
403 */
404 u64 shadow_ctx_time;
405
24f1e32c 406 struct perf_event_attr attr;
c320c7b7 407 u16 header_size;
6844c09d 408 u16 id_header_size;
c320c7b7 409 u16 read_size;
cdd6c482 410 struct hw_perf_event hw;
0793a61d 411
cdd6c482 412 struct perf_event_context *ctx;
a6fa941d 413 atomic_long_t refcount;
0793a61d 414
53cfbf59
PM
415 /*
416 * These accumulate total time (in nanoseconds) that children
cdd6c482 417 * events have been enabled and running, respectively.
53cfbf59
PM
418 */
419 atomic64_t child_total_time_enabled;
420 atomic64_t child_total_time_running;
421
0793a61d 422 /*
d859e29f 423 * Protect attach/detach and child_list:
0793a61d 424 */
fccc714b
PZ
425 struct mutex child_mutex;
426 struct list_head child_list;
cdd6c482 427 struct perf_event *parent;
0793a61d
TG
428
429 int oncpu;
430 int cpu;
431
082ff5a2
PZ
432 struct list_head owner_entry;
433 struct task_struct *owner;
434
7b732a75
PZ
435 /* mmap bits */
436 struct mutex mmap_mutex;
437 atomic_t mmap_count;
26cb63ad 438
76369139 439 struct ring_buffer *rb;
10c6db11 440 struct list_head rb_entry;
b69cf536
PZ
441 unsigned long rcu_batches;
442 int rcu_pending;
37d81828 443
7b732a75 444 /* poll related */
0793a61d 445 wait_queue_head_t waitq;
3c446b3d 446 struct fasync_struct *fasync;
79f14641
PZ
447
448 /* delayed work for NMIs and such */
449 int pending_wakeup;
4c9e2542 450 int pending_kill;
79f14641 451 int pending_disable;
e360adbe 452 struct irq_work pending;
592903cd 453
79f14641
PZ
454 atomic_t event_limit;
455
cdd6c482 456 void (*destroy)(struct perf_event *);
592903cd 457 struct rcu_head rcu_head;
709e50cf
PZ
458
459 struct pid_namespace *ns;
8e5799b1 460 u64 id;
6fb2915d 461
b326e956 462 perf_overflow_handler_t overflow_handler;
4dc0da86 463 void *overflow_handler_context;
453f19ee 464
07b139c8 465#ifdef CONFIG_EVENT_TRACING
1c024eca 466 struct ftrace_event_call *tp_event;
6fb2915d 467 struct event_filter *filter;
ced39002
JO
468#ifdef CONFIG_FUNCTION_TRACER
469 struct ftrace_ops ftrace_ops;
470#endif
ee06094f 471#endif
6fb2915d 472
e5d1367f
SE
473#ifdef CONFIG_CGROUP_PERF
474 struct perf_cgroup *cgrp; /* cgroup event is attach to */
475 int cgrp_defer_enabled;
476#endif
477
6fb2915d 478#endif /* CONFIG_PERF_EVENTS */
0793a61d
TG
479};
480
481/**
cdd6c482 482 * struct perf_event_context - event context structure
0793a61d 483 *
cdd6c482 484 * Used as a container for task events and CPU events as well:
0793a61d 485 */
cdd6c482 486struct perf_event_context {
108b02cf 487 struct pmu *pmu;
0793a61d 488 /*
cdd6c482 489 * Protect the states of the events in the list,
d859e29f 490 * nr_active, and the list:
0793a61d 491 */
e625cce1 492 raw_spinlock_t lock;
d859e29f 493 /*
cdd6c482 494 * Protect the list of events. Locking either mutex or lock
d859e29f
PM
495 * is sufficient to ensure the list doesn't change; to change
496 * the list you need to lock both the mutex and the spinlock.
497 */
a308444c 498 struct mutex mutex;
04289bb9 499
2fde4f94 500 struct list_head active_ctx_list;
889ff015
FW
501 struct list_head pinned_groups;
502 struct list_head flexible_groups;
a308444c 503 struct list_head event_list;
cdd6c482 504 int nr_events;
a308444c
IM
505 int nr_active;
506 int is_active;
bfbd3381 507 int nr_stat;
0f5a2601 508 int nr_freq;
dddd3379 509 int rotate_disable;
a308444c
IM
510 atomic_t refcount;
511 struct task_struct *task;
53cfbf59
PM
512
513 /*
4af4998b 514 * Context clock, runs when context enabled.
53cfbf59 515 */
a308444c
IM
516 u64 time;
517 u64 timestamp;
564c2b21
PM
518
519 /*
520 * These fields let us detect when two contexts have both
521 * been cloned (inherited) from a common ancestor.
522 */
cdd6c482 523 struct perf_event_context *parent_ctx;
a308444c
IM
524 u64 parent_gen;
525 u64 generation;
526 int pin_count;
d010b332 527 int nr_cgroups; /* cgroup evts */
4af57ef2 528 void *task_ctx_data; /* pmu specific data */
28009ce4 529 struct rcu_head rcu_head;
fadfe7be
JO
530
531 struct delayed_work orphans_remove;
532 bool orphans_remove_sched;
0793a61d
TG
533};
534
7ae07ea3
FW
535/*
536 * Number of contexts where an event can trigger:
e7e7ee2e 537 * task, softirq, hardirq, nmi.
7ae07ea3
FW
538 */
539#define PERF_NR_CONTEXTS 4
540
0793a61d 541/**
cdd6c482 542 * struct perf_event_cpu_context - per cpu event context structure
0793a61d
TG
543 */
544struct perf_cpu_context {
cdd6c482
IM
545 struct perf_event_context ctx;
546 struct perf_event_context *task_ctx;
0793a61d 547 int active_oncpu;
3b6f9e5c 548 int exclusive;
9e630205
SE
549 struct hrtimer hrtimer;
550 ktime_t hrtimer_interval;
3f1f3320 551 struct pmu *unique_pmu;
e5d1367f 552 struct perf_cgroup *cgrp;
0793a61d
TG
553};
554
5622f295 555struct perf_output_handle {
57c0c15b 556 struct perf_event *event;
76369139 557 struct ring_buffer *rb;
6d1acfd5 558 unsigned long wakeup;
5d967a8b
PZ
559 unsigned long size;
560 void *addr;
561 int page;
5622f295
MM
562};
563
39bed6cb
MF
564#ifdef CONFIG_CGROUP_PERF
565
566/*
567 * perf_cgroup_info keeps track of time_enabled for a cgroup.
568 * This is a per-cpu dynamically allocated data structure.
569 */
570struct perf_cgroup_info {
571 u64 time;
572 u64 timestamp;
573};
574
575struct perf_cgroup {
576 struct cgroup_subsys_state css;
577 struct perf_cgroup_info __percpu *info;
578};
579
580/*
581 * Must ensure cgroup is pinned (css_get) before calling
582 * this function. In other words, we cannot call this function
583 * if there is no cgroup event for the current CPU context.
584 */
585static inline struct perf_cgroup *
586perf_cgroup_from_task(struct task_struct *task)
587{
588 return container_of(task_css(task, perf_event_cgrp_id),
589 struct perf_cgroup, css);
590}
591#endif /* CONFIG_CGROUP_PERF */
592
cdd6c482 593#ifdef CONFIG_PERF_EVENTS
829b42dd 594
03d8e80b 595extern int perf_pmu_register(struct pmu *pmu, const char *name, int type);
b0a873eb 596extern void perf_pmu_unregister(struct pmu *pmu);
621a01ea 597
3bf101ba 598extern int perf_num_counters(void);
84c79910 599extern const char *perf_pmu_name(void);
ab0cce56
JO
600extern void __perf_event_task_sched_in(struct task_struct *prev,
601 struct task_struct *task);
602extern void __perf_event_task_sched_out(struct task_struct *prev,
603 struct task_struct *next);
cdd6c482
IM
604extern int perf_event_init_task(struct task_struct *child);
605extern void perf_event_exit_task(struct task_struct *child);
606extern void perf_event_free_task(struct task_struct *task);
4e231c79 607extern void perf_event_delayed_put(struct task_struct *task);
cdd6c482 608extern void perf_event_print_debug(void);
33696fc0
PZ
609extern void perf_pmu_disable(struct pmu *pmu);
610extern void perf_pmu_enable(struct pmu *pmu);
ba532500
YZ
611extern void perf_sched_cb_dec(struct pmu *pmu);
612extern void perf_sched_cb_inc(struct pmu *pmu);
cdd6c482
IM
613extern int perf_event_task_disable(void);
614extern int perf_event_task_enable(void);
26ca5c11 615extern int perf_event_refresh(struct perf_event *event, int refresh);
cdd6c482 616extern void perf_event_update_userpage(struct perf_event *event);
fb0459d7
AV
617extern int perf_event_release_kernel(struct perf_event *event);
618extern struct perf_event *
619perf_event_create_kernel_counter(struct perf_event_attr *attr,
620 int cpu,
38a81da2 621 struct task_struct *task,
4dc0da86
AK
622 perf_overflow_handler_t callback,
623 void *context);
0cda4c02
YZ
624extern void perf_pmu_migrate_context(struct pmu *pmu,
625 int src_cpu, int dst_cpu);
59ed446f
PZ
626extern u64 perf_event_read_value(struct perf_event *event,
627 u64 *enabled, u64 *running);
5c92d124 628
d010b332 629
df1a132b 630struct perf_sample_data {
2565711f
PZ
631 /*
632 * Fields set by perf_sample_data_init(), group so as to
633 * minimize the cachelines touched.
634 */
635 u64 addr;
636 struct perf_raw_record *raw;
637 struct perf_branch_stack *br_stack;
638 u64 period;
639 u64 weight;
640 u64 txn;
641 union perf_mem_data_src data_src;
5622f295 642
2565711f
PZ
643 /*
644 * The other fields, optionally {set,used} by
645 * perf_{prepare,output}_sample().
646 */
647 u64 type;
5622f295
MM
648 u64 ip;
649 struct {
650 u32 pid;
651 u32 tid;
652 } tid_entry;
653 u64 time;
5622f295
MM
654 u64 id;
655 u64 stream_id;
656 struct {
657 u32 cpu;
658 u32 reserved;
659 } cpu_entry;
5622f295 660 struct perf_callchain_entry *callchain;
88a7c26a
AL
661
662 /*
663 * regs_user may point to task_pt_regs or to regs_user_copy, depending
664 * on arch details.
665 */
60e2364e 666 struct perf_regs regs_user;
88a7c26a
AL
667 struct pt_regs regs_user_copy;
668
60e2364e 669 struct perf_regs regs_intr;
c5ebcedb 670 u64 stack_user_size;
2565711f 671} ____cacheline_aligned;
df1a132b 672
770eee1f
SE
673/* default value for data source */
674#define PERF_MEM_NA (PERF_MEM_S(OP, NA) |\
675 PERF_MEM_S(LVL, NA) |\
676 PERF_MEM_S(SNOOP, NA) |\
677 PERF_MEM_S(LOCK, NA) |\
678 PERF_MEM_S(TLB, NA))
679
fd0d000b
RR
680static inline void perf_sample_data_init(struct perf_sample_data *data,
681 u64 addr, u64 period)
dc1d628a 682{
fd0d000b 683 /* remaining struct members initialized in perf_prepare_sample() */
dc1d628a
PZ
684 data->addr = addr;
685 data->raw = NULL;
bce38cd5 686 data->br_stack = NULL;
4018994f 687 data->period = period;
c3feedf2 688 data->weight = 0;
770eee1f 689 data->data_src.val = PERF_MEM_NA;
fdfbbd07 690 data->txn = 0;
dc1d628a
PZ
691}
692
5622f295
MM
693extern void perf_output_sample(struct perf_output_handle *handle,
694 struct perf_event_header *header,
695 struct perf_sample_data *data,
cdd6c482 696 struct perf_event *event);
5622f295
MM
697extern void perf_prepare_sample(struct perf_event_header *header,
698 struct perf_sample_data *data,
cdd6c482 699 struct perf_event *event,
5622f295
MM
700 struct pt_regs *regs);
701
a8b0ca17 702extern int perf_event_overflow(struct perf_event *event,
5622f295
MM
703 struct perf_sample_data *data,
704 struct pt_regs *regs);
df1a132b 705
6c7e550f
FBH
706static inline bool is_sampling_event(struct perf_event *event)
707{
708 return event->attr.sample_period != 0;
709}
710
3b6f9e5c 711/*
cdd6c482 712 * Return 1 for a software event, 0 for a hardware event
3b6f9e5c 713 */
cdd6c482 714static inline int is_software_event(struct perf_event *event)
3b6f9e5c 715{
89a1e187 716 return event->pmu->task_ctx_nr == perf_sw_context;
3b6f9e5c
PM
717}
718
c5905afb 719extern struct static_key perf_swevent_enabled[PERF_COUNT_SW_MAX];
f29ac756 720
86038c5e 721extern void ___perf_sw_event(u32, u64, struct pt_regs *, u64);
a8b0ca17 722extern void __perf_sw_event(u32, u64, struct pt_regs *, u64);
f29ac756 723
b0f82b81 724#ifndef perf_arch_fetch_caller_regs
e7e7ee2e 725static inline void perf_arch_fetch_caller_regs(struct pt_regs *regs, unsigned long ip) { }
b0f82b81 726#endif
5331d7b8
FW
727
728/*
729 * Take a snapshot of the regs. Skip ip and frame pointer to
730 * the nth caller. We only need a few of the regs:
731 * - ip for PERF_SAMPLE_IP
732 * - cs for user_mode() tests
733 * - bp for callchains
734 * - eflags, for future purposes, just in case
735 */
b0f82b81 736static inline void perf_fetch_caller_regs(struct pt_regs *regs)
5331d7b8 737{
5331d7b8
FW
738 memset(regs, 0, sizeof(*regs));
739
b0f82b81 740 perf_arch_fetch_caller_regs(regs, CALLER_ADDR0);
5331d7b8
FW
741}
742
7e54a5a0 743static __always_inline void
a8b0ca17 744perf_sw_event(u32 event_id, u64 nr, struct pt_regs *regs, u64 addr)
e49a5bd3 745{
86038c5e
PZI
746 if (static_key_false(&perf_swevent_enabled[event_id]))
747 __perf_sw_event(event_id, nr, regs, addr);
748}
749
750DECLARE_PER_CPU(struct pt_regs, __perf_regs[4]);
7e54a5a0 751
86038c5e
PZI
752/*
753 * 'Special' version for the scheduler, it hard assumes no recursion,
754 * which is guaranteed by us not actually scheduling inside other swevents
755 * because those disable preemption.
756 */
757static __always_inline void
758perf_sw_event_sched(u32 event_id, u64 nr, u64 addr)
759{
c5905afb 760 if (static_key_false(&perf_swevent_enabled[event_id])) {
86038c5e
PZI
761 struct pt_regs *regs = this_cpu_ptr(&__perf_regs[0]);
762
763 perf_fetch_caller_regs(regs);
764 ___perf_sw_event(event_id, nr, regs, addr);
e49a5bd3
FW
765 }
766}
767
c5905afb 768extern struct static_key_deferred perf_sched_events;
ee6dcfa4 769
ab0cce56 770static inline void perf_event_task_sched_in(struct task_struct *prev,
a8d757ef 771 struct task_struct *task)
ab0cce56
JO
772{
773 if (static_key_false(&perf_sched_events.key))
774 __perf_event_task_sched_in(prev, task);
775}
776
777static inline void perf_event_task_sched_out(struct task_struct *prev,
778 struct task_struct *next)
ee6dcfa4 779{
86038c5e 780 perf_sw_event_sched(PERF_COUNT_SW_CONTEXT_SWITCHES, 1, 0);
ee6dcfa4 781
c5905afb 782 if (static_key_false(&perf_sched_events.key))
ab0cce56 783 __perf_event_task_sched_out(prev, next);
ee6dcfa4
PZ
784}
785
eacd3ecc
MF
786static inline u64 __perf_event_count(struct perf_event *event)
787{
788 return local64_read(&event->count) + atomic64_read(&event->child_count);
789}
790
3af9e859 791extern void perf_event_mmap(struct vm_area_struct *vma);
39447b38 792extern struct perf_guest_info_callbacks *perf_guest_cbs;
dcf46b94
ZY
793extern int perf_register_guest_info_callbacks(struct perf_guest_info_callbacks *callbacks);
794extern int perf_unregister_guest_info_callbacks(struct perf_guest_info_callbacks *callbacks);
39447b38 795
e041e328 796extern void perf_event_exec(void);
82b89778 797extern void perf_event_comm(struct task_struct *tsk, bool exec);
cdd6c482 798extern void perf_event_fork(struct task_struct *tsk);
8d1b2d93 799
56962b44
FW
800/* Callchains */
801DECLARE_PER_CPU(struct perf_callchain_entry, perf_callchain_entry);
802
e7e7ee2e
IM
803extern void perf_callchain_user(struct perf_callchain_entry *entry, struct pt_regs *regs);
804extern void perf_callchain_kernel(struct perf_callchain_entry *entry, struct pt_regs *regs);
394ee076 805
e7e7ee2e 806static inline void perf_callchain_store(struct perf_callchain_entry *entry, u64 ip)
70791ce9
FW
807{
808 if (entry->nr < PERF_MAX_STACK_DEPTH)
809 entry->ip[entry->nr++] = ip;
810}
394ee076 811
cdd6c482
IM
812extern int sysctl_perf_event_paranoid;
813extern int sysctl_perf_event_mlock;
814extern int sysctl_perf_event_sample_rate;
14c63f17
DH
815extern int sysctl_perf_cpu_time_max_percent;
816
817extern void perf_sample_event_took(u64 sample_len_ns);
1ccd1549 818
163ec435
PZ
819extern int perf_proc_update_handler(struct ctl_table *table, int write,
820 void __user *buffer, size_t *lenp,
821 loff_t *ppos);
14c63f17
DH
822extern int perf_cpu_time_max_percent_handler(struct ctl_table *table, int write,
823 void __user *buffer, size_t *lenp,
824 loff_t *ppos);
825
163ec435 826
320ebf09
PZ
827static inline bool perf_paranoid_tracepoint_raw(void)
828{
829 return sysctl_perf_event_paranoid > -1;
830}
831
832static inline bool perf_paranoid_cpu(void)
833{
834 return sysctl_perf_event_paranoid > 0;
835}
836
837static inline bool perf_paranoid_kernel(void)
838{
839 return sysctl_perf_event_paranoid > 1;
840}
841
cdd6c482 842extern void perf_event_init(void);
1c024eca
PZ
843extern void perf_tp_event(u64 addr, u64 count, void *record,
844 int entry_size, struct pt_regs *regs,
e6dab5ff
AV
845 struct hlist_head *head, int rctx,
846 struct task_struct *task);
24f1e32c 847extern void perf_bp_event(struct perf_event *event, void *data);
0d905bca 848
9d23a90a 849#ifndef perf_misc_flags
e7e7ee2e
IM
850# define perf_misc_flags(regs) \
851 (user_mode(regs) ? PERF_RECORD_MISC_USER : PERF_RECORD_MISC_KERNEL)
852# define perf_instruction_pointer(regs) instruction_pointer(regs)
9d23a90a
PM
853#endif
854
bce38cd5
SE
855static inline bool has_branch_stack(struct perf_event *event)
856{
857 return event->attr.sample_type & PERF_SAMPLE_BRANCH_STACK;
a46a2300
YZ
858}
859
860static inline bool needs_branch_stack(struct perf_event *event)
861{
862 return event->attr.branch_sample_type != 0;
bce38cd5
SE
863}
864
5622f295 865extern int perf_output_begin(struct perf_output_handle *handle,
a7ac67ea 866 struct perf_event *event, unsigned int size);
5622f295 867extern void perf_output_end(struct perf_output_handle *handle);
91d7753a 868extern unsigned int perf_output_copy(struct perf_output_handle *handle,
5622f295 869 const void *buf, unsigned int len);
5685e0ff
JO
870extern unsigned int perf_output_skip(struct perf_output_handle *handle,
871 unsigned int len);
4ed7c92d
PZ
872extern int perf_swevent_get_recursion_context(void);
873extern void perf_swevent_put_recursion_context(int rctx);
ab573844 874extern u64 perf_swevent_set_period(struct perf_event *event);
44234adc
FW
875extern void perf_event_enable(struct perf_event *event);
876extern void perf_event_disable(struct perf_event *event);
500ad2d8 877extern int __perf_event_disable(void *info);
e9d2b064 878extern void perf_event_task_tick(void);
e041e328 879#else /* !CONFIG_PERF_EVENTS: */
0793a61d 880static inline void
ab0cce56
JO
881perf_event_task_sched_in(struct task_struct *prev,
882 struct task_struct *task) { }
883static inline void
884perf_event_task_sched_out(struct task_struct *prev,
885 struct task_struct *next) { }
cdd6c482
IM
886static inline int perf_event_init_task(struct task_struct *child) { return 0; }
887static inline void perf_event_exit_task(struct task_struct *child) { }
888static inline void perf_event_free_task(struct task_struct *task) { }
4e231c79 889static inline void perf_event_delayed_put(struct task_struct *task) { }
57c0c15b 890static inline void perf_event_print_debug(void) { }
57c0c15b
IM
891static inline int perf_event_task_disable(void) { return -EINVAL; }
892static inline int perf_event_task_enable(void) { return -EINVAL; }
26ca5c11
AK
893static inline int perf_event_refresh(struct perf_event *event, int refresh)
894{
895 return -EINVAL;
896}
15dbf27c 897
925d519a 898static inline void
a8b0ca17 899perf_sw_event(u32 event_id, u64 nr, struct pt_regs *regs, u64 addr) { }
24f1e32c 900static inline void
86038c5e
PZI
901perf_sw_event_sched(u32 event_id, u64 nr, u64 addr) { }
902static inline void
184f412c 903perf_bp_event(struct perf_event *event, void *data) { }
0a4a9391 904
39447b38 905static inline int perf_register_guest_info_callbacks
e7e7ee2e 906(struct perf_guest_info_callbacks *callbacks) { return 0; }
39447b38 907static inline int perf_unregister_guest_info_callbacks
e7e7ee2e 908(struct perf_guest_info_callbacks *callbacks) { return 0; }
39447b38 909
57c0c15b 910static inline void perf_event_mmap(struct vm_area_struct *vma) { }
e041e328 911static inline void perf_event_exec(void) { }
82b89778 912static inline void perf_event_comm(struct task_struct *tsk, bool exec) { }
cdd6c482
IM
913static inline void perf_event_fork(struct task_struct *tsk) { }
914static inline void perf_event_init(void) { }
184f412c 915static inline int perf_swevent_get_recursion_context(void) { return -1; }
4ed7c92d 916static inline void perf_swevent_put_recursion_context(int rctx) { }
ab573844 917static inline u64 perf_swevent_set_period(struct perf_event *event) { return 0; }
44234adc
FW
918static inline void perf_event_enable(struct perf_event *event) { }
919static inline void perf_event_disable(struct perf_event *event) { }
500ad2d8 920static inline int __perf_event_disable(void *info) { return -1; }
e9d2b064 921static inline void perf_event_task_tick(void) { }
0793a61d
TG
922#endif
923
026249ef
FW
924#if defined(CONFIG_PERF_EVENTS) && defined(CONFIG_NO_HZ_FULL)
925extern bool perf_event_can_stop_tick(void);
926#else
927static inline bool perf_event_can_stop_tick(void) { return true; }
928#endif
929
6c4d3bc9
DR
930#if defined(CONFIG_PERF_EVENTS) && defined(CONFIG_CPU_SUP_INTEL)
931extern void perf_restore_debug_store(void);
932#else
1d9d8639 933static inline void perf_restore_debug_store(void) { }
0793a61d
TG
934#endif
935
e7e7ee2e 936#define perf_output_put(handle, x) perf_output_copy((handle), &(x), sizeof(x))
5622f295 937
3f6da390 938/*
0a0fca9d 939 * This has to have a higher priority than migration_notifier in sched/core.c.
3f6da390 940 */
e7e7ee2e
IM
941#define perf_cpu_notifier(fn) \
942do { \
0db0628d 943 static struct notifier_block fn##_nb = \
e7e7ee2e 944 { .notifier_call = fn, .priority = CPU_PRI_PERF }; \
c13d38e4 945 unsigned long cpu = smp_processor_id(); \
6760bca9 946 unsigned long flags; \
f0bdb5e0
SB
947 \
948 cpu_notifier_register_begin(); \
e7e7ee2e 949 fn(&fn##_nb, (unsigned long)CPU_UP_PREPARE, \
c13d38e4 950 (void *)(unsigned long)cpu); \
6760bca9 951 local_irq_save(flags); \
e7e7ee2e 952 fn(&fn##_nb, (unsigned long)CPU_STARTING, \
c13d38e4 953 (void *)(unsigned long)cpu); \
6760bca9 954 local_irq_restore(flags); \
e7e7ee2e 955 fn(&fn##_nb, (unsigned long)CPU_ONLINE, \
c13d38e4 956 (void *)(unsigned long)cpu); \
f0bdb5e0
SB
957 __register_cpu_notifier(&fn##_nb); \
958 cpu_notifier_register_done(); \
3f6da390
PZ
959} while (0)
960
f0bdb5e0
SB
961/*
962 * Bare-bones version of perf_cpu_notifier(), which doesn't invoke the
963 * callback for already online CPUs.
964 */
965#define __perf_cpu_notifier(fn) \
966do { \
967 static struct notifier_block fn##_nb = \
968 { .notifier_call = fn, .priority = CPU_PRI_PERF }; \
969 \
970 __register_cpu_notifier(&fn##_nb); \
971} while (0)
641cc938 972
2663960c
SB
973struct perf_pmu_events_attr {
974 struct device_attribute attr;
975 u64 id;
3a54aaa0 976 const char *event_str;
2663960c
SB
977};
978
979#define PMU_EVENT_ATTR(_name, _var, _id, _show) \
980static struct perf_pmu_events_attr _var = { \
981 .attr = __ATTR(_name, 0444, _show, NULL), \
982 .id = _id, \
983};
984
641cc938
JO
985#define PMU_FORMAT_ATTR(_name, _format) \
986static ssize_t \
987_name##_show(struct device *dev, \
988 struct device_attribute *attr, \
989 char *page) \
990{ \
991 BUILD_BUG_ON(sizeof(_format) >= PAGE_SIZE); \
992 return sprintf(page, _format "\n"); \
993} \
994 \
995static struct device_attribute format_attr_##_name = __ATTR_RO(_name)
996
cdd6c482 997#endif /* _LINUX_PERF_EVENT_H */