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