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