]> git.proxmox.com Git - mirror_ubuntu-jammy-kernel.git/blame - include/linux/perf_event.h
Merge tag 'fs.move_mount.move_mount_set_group.v5.15' of git://git.kernel.org/pub...
[mirror_ubuntu-jammy-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>
c895f6f7 18#include <uapi/linux/bpf_perf_event.h>
0793a61d 19
9f66a381 20/*
f3dfd265 21 * Kernel-internal data types and definitions:
9f66a381
IM
22 */
23
cdd6c482
IM
24#ifdef CONFIG_PERF_EVENTS
25# include <asm/perf_event.h>
7be79236 26# include <asm/local64.h>
f3dfd265
PM
27#endif
28
39447b38 29struct perf_guest_info_callbacks {
e7e7ee2e
IM
30 int (*is_in_guest)(void);
31 int (*is_user_mode)(void);
32 unsigned long (*get_guest_ip)(void);
8479e04e 33 void (*handle_intel_pt_intr)(void);
39447b38
ZY
34};
35
2ff6cfd7
AB
36#ifdef CONFIG_HAVE_HW_BREAKPOINT
37#include <asm/hw_breakpoint.h>
38#endif
39
f3dfd265
PM
40#include <linux/list.h>
41#include <linux/mutex.h>
42#include <linux/rculist.h>
43#include <linux/rcupdate.h>
44#include <linux/spinlock.h>
d6d020e9 45#include <linux/hrtimer.h>
3c446b3d 46#include <linux/fs.h>
709e50cf 47#include <linux/pid_namespace.h>
906010b2 48#include <linux/workqueue.h>
5331d7b8 49#include <linux/ftrace.h>
85cfabbc 50#include <linux/cpu.h>
e360adbe 51#include <linux/irq_work.h>
c5905afb 52#include <linux/static_key.h>
851cf6e7 53#include <linux/jump_label_ratelimit.h>
60063497 54#include <linux/atomic.h>
641cc938 55#include <linux/sysfs.h>
4018994f 56#include <linux/perf_regs.h>
39bed6cb 57#include <linux/cgroup.h>
8c94abbb 58#include <linux/refcount.h>
da97e184 59#include <linux/security.h>
fa588151 60#include <asm/local.h>
f3dfd265 61
f9188e02
PZ
62struct perf_callchain_entry {
63 __u64 nr;
c50c75e9 64 __u64 ip[]; /* /proc/sys/kernel/perf_event_max_stack */
f9188e02
PZ
65};
66
cfbcf468
ACM
67struct perf_callchain_entry_ctx {
68 struct perf_callchain_entry *entry;
69 u32 max_stack;
3b1fff08 70 u32 nr;
c85b0334
ACM
71 short contexts;
72 bool contexts_maxed;
cfbcf468
ACM
73};
74
7e3f977e 75typedef unsigned long (*perf_copy_f)(void *dst, const void *src,
aa7145c1 76 unsigned long off, unsigned long len);
7e3f977e
DB
77
78struct perf_raw_frag {
79 union {
80 struct perf_raw_frag *next;
81 unsigned long pad;
82 };
83 perf_copy_f copy;
84 void *data;
85 u32 size;
86} __packed;
87
3a43ce68 88struct perf_raw_record {
7e3f977e 89 struct perf_raw_frag frag;
3a43ce68 90 u32 size;
f413cdb8
FW
91};
92
bce38cd5
SE
93/*
94 * branch stack layout:
95 * nr: number of taken branches stored in entries[]
bbfd5e4f
KL
96 * hw_idx: The low level index of raw branch records
97 * for the most recent branch.
98 * -1ULL means invalid/unknown.
bce38cd5
SE
99 *
100 * Note that nr can vary from sample to sample
101 * branches (to, from) are stored from most recent
102 * to least recent, i.e., entries[0] contains the most
103 * recent branch.
bbfd5e4f
KL
104 * The entries[] is an abstraction of raw branch records,
105 * which may not be stored in age order in HW, e.g. Intel LBR.
106 * The hw_idx is to expose the low level index of raw
107 * branch record for the most recent branch aka entries[0].
108 * The hw_idx index is between -1 (unknown) and max depth,
109 * which can be retrieved in /sys/devices/cpu/caps/branches.
110 * For the architectures whose raw branch records are
111 * already stored in age order, the hw_idx should be 0.
bce38cd5 112 */
caff2bef
PZ
113struct perf_branch_stack {
114 __u64 nr;
bbfd5e4f 115 __u64 hw_idx;
c50c75e9 116 struct perf_branch_entry entries[];
caff2bef
PZ
117};
118
f3dfd265
PM
119struct task_struct;
120
efc9f05d
SE
121/*
122 * extra PMU register associated with an event
123 */
124struct hw_perf_event_extra {
125 u64 config; /* register value */
126 unsigned int reg; /* register address or index */
127 int alloc; /* extra register already allocated */
128 int idx; /* index in shared_regs->regs[] */
129};
130
0793a61d 131/**
cdd6c482 132 * struct hw_perf_event - performance event hardware details:
0793a61d 133 */
cdd6c482
IM
134struct hw_perf_event {
135#ifdef CONFIG_PERF_EVENTS
d6d020e9
PZ
136 union {
137 struct { /* hardware */
a308444c 138 u64 config;
447a194b 139 u64 last_tag;
a308444c 140 unsigned long config_base;
cdd6c482 141 unsigned long event_base;
c48b6053 142 int event_base_rdpmc;
a308444c 143 int idx;
447a194b 144 int last_cpu;
9fac2cf3 145 int flags;
bce38cd5 146
efc9f05d 147 struct hw_perf_event_extra extra_reg;
bce38cd5 148 struct hw_perf_event_extra branch_reg;
d6d020e9 149 };
721a669b 150 struct { /* software */
a308444c 151 struct hrtimer hrtimer;
d6d020e9 152 };
f22c1bb6 153 struct { /* tracepoint */
f22c1bb6
ON
154 /* for tp_event->class */
155 struct list_head tp_list;
156 };
c7ab62bf
HR
157 struct { /* amd_power */
158 u64 pwr_acc;
159 u64 ptsc;
160 };
24f1e32c 161#ifdef CONFIG_HAVE_HW_BREAKPOINT
45a73372 162 struct { /* breakpoint */
d580ff86
PZ
163 /*
164 * Crufty hack to avoid the chicken and egg
165 * problem hw_breakpoint has with context
166 * creation and event initalization.
167 */
f22c1bb6
ON
168 struct arch_hw_breakpoint info;
169 struct list_head bp_list;
45a73372 170 };
24f1e32c 171#endif
cf25f904
SS
172 struct { /* amd_iommu */
173 u8 iommu_bank;
174 u8 iommu_cntr;
175 u16 padding;
176 u64 conf;
177 u64 conf1;
178 };
d6d020e9 179 };
b0e87875
PZ
180 /*
181 * If the event is a per task event, this will point to the task in
182 * question. See the comment in perf_event_alloc().
183 */
50f16a8b 184 struct task_struct *target;
b0e87875 185
375637bc
AS
186 /*
187 * PMU would store hardware filter configuration
188 * here.
189 */
190 void *addr_filters;
191
192 /* Last sync'ed generation of filters */
193 unsigned long addr_filters_gen;
194
b0e87875
PZ
195/*
196 * hw_perf_event::state flags; used to track the PERF_EF_* state.
197 */
198#define PERF_HES_STOPPED 0x01 /* the counter is stopped */
199#define PERF_HES_UPTODATE 0x02 /* event->count up-to-date */
200#define PERF_HES_ARCH 0x04
201
a4eaf7f1 202 int state;
b0e87875
PZ
203
204 /*
205 * The last observed hardware counter value, updated with a
206 * local64_cmpxchg() such that pmu::read() can be called nested.
207 */
e7850595 208 local64_t prev_count;
b0e87875
PZ
209
210 /*
211 * The period to start the next sample with.
212 */
b23f3325 213 u64 sample_period;
b0e87875 214
2cb5383b
KL
215 union {
216 struct { /* Sampling */
217 /*
218 * The period we started this sample with.
219 */
220 u64 last_period;
b0e87875 221
2cb5383b
KL
222 /*
223 * However much is left of the current period;
224 * note that this is a full 64bit value and
225 * allows for generation of periods longer
226 * than hardware might allow.
227 */
228 local64_t period_left;
229 };
230 struct { /* Topdown events counting for context switch */
231 u64 saved_metric;
232 u64 saved_slots;
233 };
234 };
b0e87875
PZ
235
236 /*
237 * State for throttling the event, see __perf_event_overflow() and
238 * perf_adjust_freq_unthr_context().
239 */
e050e3f0 240 u64 interrupts_seq;
60db5e09 241 u64 interrupts;
6a24ed6c 242
b0e87875
PZ
243 /*
244 * State for freq target events, see __perf_event_overflow() and
245 * perf_adjust_freq_unthr_context().
246 */
abd50713
PZ
247 u64 freq_time_stamp;
248 u64 freq_count_stamp;
ee06094f 249#endif
0793a61d
TG
250};
251
cdd6c482 252struct perf_event;
621a01ea 253
8d2cacbb
PZ
254/*
255 * Common implementation detail of pmu::{start,commit,cancel}_txn
256 */
fbbe0701 257#define PERF_PMU_TXN_ADD 0x1 /* txn to add/schedule event on PMU */
4a00c16e 258#define PERF_PMU_TXN_READ 0x2 /* txn to read event group from PMU */
fbbe0701 259
53b25335
VW
260/**
261 * pmu::capabilities flags
262 */
55bcf6ef
KL
263#define PERF_PMU_CAP_NO_INTERRUPT 0x0001
264#define PERF_PMU_CAP_NO_NMI 0x0002
265#define PERF_PMU_CAP_AUX_NO_SG 0x0004
266#define PERF_PMU_CAP_EXTENDED_REGS 0x0008
267#define PERF_PMU_CAP_EXCLUSIVE 0x0010
268#define PERF_PMU_CAP_ITRACE 0x0020
269#define PERF_PMU_CAP_HETEROGENEOUS_CPUS 0x0040
270#define PERF_PMU_CAP_NO_EXCLUDE 0x0080
271#define PERF_PMU_CAP_AUX_OUTPUT 0x0100
272#define PERF_PMU_CAP_EXTENDED_HW_TYPE 0x0200
53b25335 273
a4faf00d
AS
274struct perf_output_handle;
275
621a01ea 276/**
4aeb0b42 277 * struct pmu - generic performance monitoring unit
621a01ea 278 */
4aeb0b42 279struct pmu {
b0a873eb
PZ
280 struct list_head entry;
281
c464c76e 282 struct module *module;
abe43400 283 struct device *dev;
0c9d42ed 284 const struct attribute_group **attr_groups;
f3a3a825 285 const struct attribute_group **attr_update;
03d8e80b 286 const char *name;
2e80a82a
PZ
287 int type;
288
53b25335
VW
289 /*
290 * various common per-pmu feature flags
291 */
292 int capabilities;
293
43b9e4fe
MO
294 int __percpu *pmu_disable_count;
295 struct perf_cpu_context __percpu *pmu_cpu_context;
bed5b25a 296 atomic_t exclusive_cnt; /* < 0: cpu; > 0: tsk */
8dc85d54 297 int task_ctx_nr;
62b85639 298 int hrtimer_interval_ms;
6bde9b6c 299
375637bc
AS
300 /* number of address filters this PMU can do */
301 unsigned int nr_addr_filters;
302
6bde9b6c 303 /*
a4eaf7f1
PZ
304 * Fully disable/enable this PMU, can be used to protect from the PMI
305 * as well as for lazy/batch writing of the MSRs.
6bde9b6c 306 */
ad5133b7
PZ
307 void (*pmu_enable) (struct pmu *pmu); /* optional */
308 void (*pmu_disable) (struct pmu *pmu); /* optional */
6bde9b6c 309
8d2cacbb 310 /*
a4eaf7f1 311 * Try and initialize the event for this PMU.
b0e87875
PZ
312 *
313 * Returns:
314 * -ENOENT -- @event is not for this PMU
315 *
316 * -ENODEV -- @event is for this PMU but PMU not present
317 * -EBUSY -- @event is for this PMU but PMU temporarily unavailable
318 * -EINVAL -- @event is for this PMU but @event is not valid
319 * -EOPNOTSUPP -- @event is for this PMU, @event is valid, but not supported
652521d4 320 * -EACCES -- @event is for this PMU, @event is valid, but no privileges
b0e87875
PZ
321 *
322 * 0 -- @event is for this PMU and valid
323 *
324 * Other error return values are allowed.
8d2cacbb 325 */
b0a873eb
PZ
326 int (*event_init) (struct perf_event *event);
327
1e0fb9ec
AL
328 /*
329 * Notification that the event was mapped or unmapped. Called
330 * in the context of the mapping task.
331 */
bfe33492
PZ
332 void (*event_mapped) (struct perf_event *event, struct mm_struct *mm); /* optional */
333 void (*event_unmapped) (struct perf_event *event, struct mm_struct *mm); /* optional */
1e0fb9ec 334
b0e87875
PZ
335 /*
336 * Flags for ->add()/->del()/ ->start()/->stop(). There are
337 * matching hw_perf_event::state flags.
338 */
a4eaf7f1
PZ
339#define PERF_EF_START 0x01 /* start the counter when adding */
340#define PERF_EF_RELOAD 0x02 /* reload the counter when starting */
341#define PERF_EF_UPDATE 0x04 /* update the counter when stopping */
342
8d2cacbb 343 /*
b0e87875
PZ
344 * Adds/Removes a counter to/from the PMU, can be done inside a
345 * transaction, see the ->*_txn() methods.
346 *
347 * The add/del callbacks will reserve all hardware resources required
348 * to service the event, this includes any counter constraint
349 * scheduling etc.
350 *
351 * Called with IRQs disabled and the PMU disabled on the CPU the event
352 * is on.
353 *
354 * ->add() called without PERF_EF_START should result in the same state
355 * as ->add() followed by ->stop().
356 *
357 * ->del() must always PERF_EF_UPDATE stop an event. If it calls
358 * ->stop() that must deal with already being stopped without
359 * PERF_EF_UPDATE.
a4eaf7f1
PZ
360 */
361 int (*add) (struct perf_event *event, int flags);
362 void (*del) (struct perf_event *event, int flags);
363
364 /*
b0e87875
PZ
365 * Starts/Stops a counter present on the PMU.
366 *
367 * The PMI handler should stop the counter when perf_event_overflow()
368 * returns !0. ->start() will be used to continue.
369 *
370 * Also used to change the sample period.
371 *
372 * Called with IRQs disabled and the PMU disabled on the CPU the event
373 * is on -- will be called from NMI context with the PMU generates
374 * NMIs.
375 *
376 * ->stop() with PERF_EF_UPDATE will read the counter and update
377 * period/count values like ->read() would.
378 *
c2127e14 379 * ->start() with PERF_EF_RELOAD will reprogram the counter
b0e87875 380 * value, must be preceded by a ->stop() with PERF_EF_UPDATE.
a4eaf7f1
PZ
381 */
382 void (*start) (struct perf_event *event, int flags);
383 void (*stop) (struct perf_event *event, int flags);
384
385 /*
386 * Updates the counter value of the event.
b0e87875
PZ
387 *
388 * For sampling capable PMUs this will also update the software period
389 * hw_perf_event::period_left field.
a4eaf7f1 390 */
cdd6c482 391 void (*read) (struct perf_event *event);
6bde9b6c
LM
392
393 /*
24cd7f54
PZ
394 * Group events scheduling is treated as a transaction, add
395 * group events as a whole and perform one schedulability test.
396 * If the test fails, roll back the whole group
a4eaf7f1
PZ
397 *
398 * Start the transaction, after this ->add() doesn't need to
24cd7f54 399 * do schedulability tests.
fbbe0701
SB
400 *
401 * Optional.
8d2cacbb 402 */
fbbe0701 403 void (*start_txn) (struct pmu *pmu, unsigned int txn_flags);
8d2cacbb 404 /*
a4eaf7f1 405 * If ->start_txn() disabled the ->add() schedulability test
8d2cacbb
PZ
406 * then ->commit_txn() is required to perform one. On success
407 * the transaction is closed. On error the transaction is kept
408 * open until ->cancel_txn() is called.
fbbe0701
SB
409 *
410 * Optional.
8d2cacbb 411 */
fbbe0701 412 int (*commit_txn) (struct pmu *pmu);
8d2cacbb 413 /*
a4eaf7f1 414 * Will cancel the transaction, assumes ->del() is called
25985edc 415 * for each successful ->add() during the transaction.
fbbe0701
SB
416 *
417 * Optional.
8d2cacbb 418 */
fbbe0701 419 void (*cancel_txn) (struct pmu *pmu);
35edc2a5
PZ
420
421 /*
422 * Will return the value for perf_event_mmap_page::index for this event,
423 * if no implementation is provided it will default to: event->hw.idx + 1.
424 */
425 int (*event_idx) (struct perf_event *event); /*optional */
d010b332 426
ba532500
YZ
427 /*
428 * context-switches callback
429 */
430 void (*sched_task) (struct perf_event_context *ctx,
431 bool sched_in);
432
217c2a63
KL
433 /*
434 * Kmem cache of PMU specific data
435 */
436 struct kmem_cache *task_ctx_cache;
437
fc1adfe3
AB
438 /*
439 * PMU specific parts of task perf event context (i.e. ctx->task_ctx_data)
440 * can be synchronized using this function. See Intel LBR callstack support
441 * implementation and Perf core context switch handling callbacks for usage
442 * examples.
443 */
444 void (*swap_task_ctx) (struct perf_event_context *prev,
445 struct perf_event_context *next);
446 /* optional */
eacd3ecc 447
45bfb2e5
PZ
448 /*
449 * Set up pmu-private data structures for an AUX area
450 */
84001866 451 void *(*setup_aux) (struct perf_event *event, void **pages,
45bfb2e5
PZ
452 int nr_pages, bool overwrite);
453 /* optional */
454
455 /*
456 * Free pmu-private AUX data structures
457 */
458 void (*free_aux) (void *aux); /* optional */
66eb579e 459
a4faf00d
AS
460 /*
461 * Take a snapshot of the AUX buffer without touching the event
462 * state, so that preempting ->start()/->stop() callbacks does
463 * not interfere with their logic. Called in PMI context.
464 *
465 * Returns the size of AUX data copied to the output handle.
466 *
467 * Optional.
468 */
469 long (*snapshot_aux) (struct perf_event *event,
470 struct perf_output_handle *handle,
471 unsigned long size);
472
375637bc
AS
473 /*
474 * Validate address range filters: make sure the HW supports the
475 * requested configuration and number of filters; return 0 if the
476 * supplied filters are valid, -errno otherwise.
477 *
478 * Runs in the context of the ioctl()ing process and is not serialized
479 * with the rest of the PMU callbacks.
480 */
481 int (*addr_filters_validate) (struct list_head *filters);
482 /* optional */
483
484 /*
485 * Synchronize address range filter configuration:
486 * translate hw-agnostic filters into hardware configuration in
487 * event::hw::addr_filters.
488 *
489 * Runs as a part of filter sync sequence that is done in ->start()
490 * callback by calling perf_event_addr_filters_sync().
491 *
492 * May (and should) traverse event::addr_filters::list, for which its
493 * caller provides necessary serialization.
494 */
495 void (*addr_filters_sync) (struct perf_event *event);
496 /* optional */
497
ab43762e
AS
498 /*
499 * Check if event can be used for aux_output purposes for
500 * events of this PMU.
501 *
502 * Runs from perf_event_open(). Should return 0 for "no match"
503 * or non-zero for "match".
504 */
505 int (*aux_output_match) (struct perf_event *event);
506 /* optional */
507
66eb579e
MR
508 /*
509 * Filter events for PMU-specific reasons.
510 */
511 int (*filter_match) (struct perf_event *event); /* optional */
81ec3f3c
JO
512
513 /*
514 * Check period value for PERF_EVENT_IOC_PERIOD ioctl.
515 */
516 int (*check_period) (struct perf_event *event, u64 value); /* optional */
621a01ea
IM
517};
518
6ed70cf3
AS
519enum perf_addr_filter_action_t {
520 PERF_ADDR_FILTER_ACTION_STOP = 0,
521 PERF_ADDR_FILTER_ACTION_START,
522 PERF_ADDR_FILTER_ACTION_FILTER,
523};
524
375637bc
AS
525/**
526 * struct perf_addr_filter - address range filter definition
527 * @entry: event's filter list linkage
1279e41d 528 * @path: object file's path for file-based filters
375637bc 529 * @offset: filter range offset
6ed70cf3
AS
530 * @size: filter range size (size==0 means single address trigger)
531 * @action: filter/start/stop
375637bc
AS
532 *
533 * This is a hardware-agnostic filter configuration as specified by the user.
534 */
535struct perf_addr_filter {
536 struct list_head entry;
9511bce9 537 struct path path;
375637bc
AS
538 unsigned long offset;
539 unsigned long size;
6ed70cf3 540 enum perf_addr_filter_action_t action;
375637bc
AS
541};
542
543/**
544 * struct perf_addr_filters_head - container for address range filters
545 * @list: list of filters for this event
546 * @lock: spinlock that serializes accesses to the @list and event's
547 * (and its children's) filter generations.
6ce77bfd 548 * @nr_file_filters: number of file-based filters
375637bc
AS
549 *
550 * A child event will use parent's @list (and therefore @lock), so they are
551 * bundled together; see perf_event_addr_filters().
552 */
553struct perf_addr_filters_head {
554 struct list_head list;
555 raw_spinlock_t lock;
6ce77bfd 556 unsigned int nr_file_filters;
375637bc
AS
557};
558
c60f83b8
AS
559struct perf_addr_filter_range {
560 unsigned long start;
561 unsigned long size;
562};
563
6a930700 564/**
788faab7 565 * enum perf_event_state - the states of an event:
6a930700 566 */
8ca2bd41 567enum perf_event_state {
a69b0ca4 568 PERF_EVENT_STATE_DEAD = -4,
179033b3 569 PERF_EVENT_STATE_EXIT = -3,
57c0c15b 570 PERF_EVENT_STATE_ERROR = -2,
cdd6c482
IM
571 PERF_EVENT_STATE_OFF = -1,
572 PERF_EVENT_STATE_INACTIVE = 0,
57c0c15b 573 PERF_EVENT_STATE_ACTIVE = 1,
6a930700
IM
574};
575
9b51f66d 576struct file;
453f19ee
PZ
577struct perf_sample_data;
578
a8b0ca17 579typedef void (*perf_overflow_handler_t)(struct perf_event *,
b326e956
FW
580 struct perf_sample_data *,
581 struct pt_regs *regs);
582
4ff6a8de
DCC
583/*
584 * Event capabilities. For event_caps and groups caps.
585 *
586 * PERF_EV_CAP_SOFTWARE: Is a software event.
d6a2f903
DCC
587 * PERF_EV_CAP_READ_ACTIVE_PKG: A CPU event (or cgroup event) that can be read
588 * from any CPU in the package where it is active.
9f0c4fa1
KL
589 * PERF_EV_CAP_SIBLING: An event with this flag must be a group sibling and
590 * cannot be a group leader. If an event with this flag is detached from the
591 * group it is scheduled out and moved into an unrecoverable ERROR state.
4ff6a8de
DCC
592 */
593#define PERF_EV_CAP_SOFTWARE BIT(0)
d6a2f903 594#define PERF_EV_CAP_READ_ACTIVE_PKG BIT(1)
9f0c4fa1 595#define PERF_EV_CAP_SIBLING BIT(2)
d6f962b5 596
e7e7ee2e
IM
597#define SWEVENT_HLIST_BITS 8
598#define SWEVENT_HLIST_SIZE (1 << SWEVENT_HLIST_BITS)
76e1d904
FW
599
600struct swevent_hlist {
e7e7ee2e
IM
601 struct hlist_head heads[SWEVENT_HLIST_SIZE];
602 struct rcu_head rcu_head;
76e1d904
FW
603};
604
8a49542c
PZ
605#define PERF_ATTACH_CONTEXT 0x01
606#define PERF_ATTACH_GROUP 0x02
d580ff86 607#define PERF_ATTACH_TASK 0x04
4af57ef2 608#define PERF_ATTACH_TASK_DATA 0x08
8d4e6c4c 609#define PERF_ATTACH_ITRACE 0x10
a5398bff 610#define PERF_ATTACH_SCHED_CB 0x20
ef54c1a4 611#define PERF_ATTACH_CHILD 0x40
8a49542c 612
877c6856 613struct perf_cgroup;
56de4e8f 614struct perf_buffer;
76369139 615
f2fb6bef
KL
616struct pmu_event_list {
617 raw_spinlock_t lock;
618 struct list_head list;
619};
620
edb39592
PZ
621#define for_each_sibling_event(sibling, event) \
622 if ((event)->group_leader == (event)) \
623 list_for_each_entry((sibling), &(event)->sibling_list, sibling_list)
624
0793a61d 625/**
cdd6c482 626 * struct perf_event - performance event kernel representation:
0793a61d 627 */
cdd6c482
IM
628struct perf_event {
629#ifdef CONFIG_PERF_EVENTS
9886167d
PZ
630 /*
631 * entry onto perf_event_context::event_list;
632 * modifications require ctx->lock
633 * RCU safe iterations.
634 */
592903cd 635 struct list_head event_entry;
9886167d
PZ
636
637 /*
9886167d
PZ
638 * Locked for modification by both ctx->mutex and ctx->lock; holding
639 * either sufficies for read.
640 */
04289bb9 641 struct list_head sibling_list;
6668128a 642 struct list_head active_list;
8e1a2031
AB
643 /*
644 * Node on the pinned or flexible tree located at the event context;
645 */
646 struct rb_node group_node;
647 u64 group_index;
9886167d
PZ
648 /*
649 * We need storage to track the entries in perf_pmu_migrate_context; we
650 * cannot use the event_entry because of RCU and we want to keep the
651 * group in tact which avoids us using the other two entries.
652 */
653 struct list_head migrate_entry;
654
f3ae75de
SE
655 struct hlist_node hlist_entry;
656 struct list_head active_entry;
0127c3ea 657 int nr_siblings;
4ff6a8de
DCC
658
659 /* Not serialized. Only written during event initialization. */
660 int event_caps;
661 /* The cumulative AND of all event_caps for events in this group. */
662 int group_caps;
663
cdd6c482 664 struct perf_event *group_leader;
a4eaf7f1 665 struct pmu *pmu;
54d751d4 666 void *pmu_private;
04289bb9 667
8ca2bd41 668 enum perf_event_state state;
8a49542c 669 unsigned int attach_state;
e7850595 670 local64_t count;
a6e6dea6 671 atomic64_t child_count;
ee06094f 672
53cfbf59 673 /*
cdd6c482 674 * These are the total time in nanoseconds that the event
53cfbf59 675 * has been enabled (i.e. eligible to run, and the task has
cdd6c482 676 * been scheduled in, if this is a per-task event)
53cfbf59 677 * and running (scheduled onto the CPU), respectively.
53cfbf59
PM
678 */
679 u64 total_time_enabled;
680 u64 total_time_running;
0d3d73aa 681 u64 tstamp;
53cfbf59 682
eed01528
SE
683 /*
684 * timestamp shadows the actual context timing but it can
685 * be safely used in NMI interrupt context. It reflects the
686 * context time as it was when the event was last scheduled in.
687 *
688 * ctx_time already accounts for ctx->timestamp. Therefore to
689 * compute ctx_time for a sample, simply add perf_clock().
690 */
691 u64 shadow_ctx_time;
692
24f1e32c 693 struct perf_event_attr attr;
c320c7b7 694 u16 header_size;
6844c09d 695 u16 id_header_size;
c320c7b7 696 u16 read_size;
cdd6c482 697 struct hw_perf_event hw;
0793a61d 698
cdd6c482 699 struct perf_event_context *ctx;
a6fa941d 700 atomic_long_t refcount;
0793a61d 701
53cfbf59
PM
702 /*
703 * These accumulate total time (in nanoseconds) that children
cdd6c482 704 * events have been enabled and running, respectively.
53cfbf59
PM
705 */
706 atomic64_t child_total_time_enabled;
707 atomic64_t child_total_time_running;
708
0793a61d 709 /*
d859e29f 710 * Protect attach/detach and child_list:
0793a61d 711 */
fccc714b
PZ
712 struct mutex child_mutex;
713 struct list_head child_list;
cdd6c482 714 struct perf_event *parent;
0793a61d
TG
715
716 int oncpu;
717 int cpu;
718
082ff5a2
PZ
719 struct list_head owner_entry;
720 struct task_struct *owner;
721
7b732a75
PZ
722 /* mmap bits */
723 struct mutex mmap_mutex;
724 atomic_t mmap_count;
26cb63ad 725
56de4e8f 726 struct perf_buffer *rb;
10c6db11 727 struct list_head rb_entry;
b69cf536
PZ
728 unsigned long rcu_batches;
729 int rcu_pending;
37d81828 730
7b732a75 731 /* poll related */
0793a61d 732 wait_queue_head_t waitq;
3c446b3d 733 struct fasync_struct *fasync;
79f14641
PZ
734
735 /* delayed work for NMIs and such */
736 int pending_wakeup;
4c9e2542 737 int pending_kill;
79f14641 738 int pending_disable;
97ba62b2 739 unsigned long pending_addr; /* SIGTRAP */
e360adbe 740 struct irq_work pending;
592903cd 741
79f14641
PZ
742 atomic_t event_limit;
743
375637bc
AS
744 /* address range filters */
745 struct perf_addr_filters_head addr_filters;
746 /* vma address array for file-based filders */
c60f83b8 747 struct perf_addr_filter_range *addr_filter_ranges;
375637bc
AS
748 unsigned long addr_filters_gen;
749
ab43762e
AS
750 /* for aux_output events */
751 struct perf_event *aux_event;
752
cdd6c482 753 void (*destroy)(struct perf_event *);
592903cd 754 struct rcu_head rcu_head;
709e50cf
PZ
755
756 struct pid_namespace *ns;
8e5799b1 757 u64 id;
6fb2915d 758
34f43927 759 u64 (*clock)(void);
b326e956 760 perf_overflow_handler_t overflow_handler;
4dc0da86 761 void *overflow_handler_context;
aa6a5f3c
AS
762#ifdef CONFIG_BPF_SYSCALL
763 perf_overflow_handler_t orig_overflow_handler;
764 struct bpf_prog *prog;
765#endif
453f19ee 766
07b139c8 767#ifdef CONFIG_EVENT_TRACING
2425bcb9 768 struct trace_event_call *tp_event;
6fb2915d 769 struct event_filter *filter;
ced39002
JO
770#ifdef CONFIG_FUNCTION_TRACER
771 struct ftrace_ops ftrace_ops;
772#endif
ee06094f 773#endif
6fb2915d 774
e5d1367f
SE
775#ifdef CONFIG_CGROUP_PERF
776 struct perf_cgroup *cgrp; /* cgroup event is attach to */
e5d1367f
SE
777#endif
778
da97e184
JFG
779#ifdef CONFIG_SECURITY
780 void *security;
781#endif
f2fb6bef 782 struct list_head sb_list;
6fb2915d 783#endif /* CONFIG_PERF_EVENTS */
0793a61d
TG
784};
785
8e1a2031
AB
786
787struct perf_event_groups {
788 struct rb_root tree;
789 u64 index;
790};
791
0793a61d 792/**
cdd6c482 793 * struct perf_event_context - event context structure
0793a61d 794 *
cdd6c482 795 * Used as a container for task events and CPU events as well:
0793a61d 796 */
cdd6c482 797struct perf_event_context {
108b02cf 798 struct pmu *pmu;
0793a61d 799 /*
cdd6c482 800 * Protect the states of the events in the list,
d859e29f 801 * nr_active, and the list:
0793a61d 802 */
e625cce1 803 raw_spinlock_t lock;
d859e29f 804 /*
cdd6c482 805 * Protect the list of events. Locking either mutex or lock
d859e29f
PM
806 * is sufficient to ensure the list doesn't change; to change
807 * the list you need to lock both the mutex and the spinlock.
808 */
a308444c 809 struct mutex mutex;
04289bb9 810
2fde4f94 811 struct list_head active_ctx_list;
8e1a2031
AB
812 struct perf_event_groups pinned_groups;
813 struct perf_event_groups flexible_groups;
a308444c 814 struct list_head event_list;
6668128a
PZ
815
816 struct list_head pinned_active;
817 struct list_head flexible_active;
818
cdd6c482 819 int nr_events;
a308444c
IM
820 int nr_active;
821 int is_active;
bfbd3381 822 int nr_stat;
0f5a2601 823 int nr_freq;
dddd3379 824 int rotate_disable;
fd7d5517
IR
825 /*
826 * Set when nr_events != nr_active, except tolerant to events not
827 * necessary to be active due to scheduling constraints, such as cgroups.
828 */
829 int rotate_necessary;
8c94abbb 830 refcount_t refcount;
a308444c 831 struct task_struct *task;
53cfbf59
PM
832
833 /*
4af4998b 834 * Context clock, runs when context enabled.
53cfbf59 835 */
a308444c
IM
836 u64 time;
837 u64 timestamp;
564c2b21
PM
838
839 /*
840 * These fields let us detect when two contexts have both
841 * been cloned (inherited) from a common ancestor.
842 */
cdd6c482 843 struct perf_event_context *parent_ctx;
a308444c
IM
844 u64 parent_gen;
845 u64 generation;
846 int pin_count;
db4a8356 847#ifdef CONFIG_CGROUP_PERF
d010b332 848 int nr_cgroups; /* cgroup evts */
db4a8356 849#endif
4af57ef2 850 void *task_ctx_data; /* pmu specific data */
28009ce4 851 struct rcu_head rcu_head;
0793a61d
TG
852};
853
7ae07ea3
FW
854/*
855 * Number of contexts where an event can trigger:
e7e7ee2e 856 * task, softirq, hardirq, nmi.
7ae07ea3
FW
857 */
858#define PERF_NR_CONTEXTS 4
859
0793a61d 860/**
cdd6c482 861 * struct perf_event_cpu_context - per cpu event context structure
0793a61d
TG
862 */
863struct perf_cpu_context {
cdd6c482
IM
864 struct perf_event_context ctx;
865 struct perf_event_context *task_ctx;
0793a61d 866 int active_oncpu;
3b6f9e5c 867 int exclusive;
4cfafd30
PZ
868
869 raw_spinlock_t hrtimer_lock;
9e630205
SE
870 struct hrtimer hrtimer;
871 ktime_t hrtimer_interval;
4cfafd30
PZ
872 unsigned int hrtimer_active;
873
db4a8356 874#ifdef CONFIG_CGROUP_PERF
e5d1367f 875 struct perf_cgroup *cgrp;
058fe1c0 876 struct list_head cgrp_cpuctx_entry;
db4a8356 877#endif
e48c1788 878
a5398bff 879 struct list_head sched_cb_entry;
e48c1788 880 int sched_cb_usage;
a63fbed7
TG
881
882 int online;
836196be
IR
883 /*
884 * Per-CPU storage for iterators used in visit_groups_merge. The default
885 * storage is of size 2 to hold the CPU and any CPU event iterators.
886 */
887 int heap_size;
888 struct perf_event **heap;
889 struct perf_event *heap_default[2];
0793a61d
TG
890};
891
5622f295 892struct perf_output_handle {
57c0c15b 893 struct perf_event *event;
56de4e8f 894 struct perf_buffer *rb;
6d1acfd5 895 unsigned long wakeup;
5d967a8b 896 unsigned long size;
f4c0b0aa 897 u64 aux_flags;
fdc26706
AS
898 union {
899 void *addr;
900 unsigned long head;
901 };
5d967a8b 902 int page;
5622f295
MM
903};
904
0515e599 905struct bpf_perf_event_data_kern {
c895f6f7 906 bpf_user_pt_regs_t *regs;
0515e599 907 struct perf_sample_data *data;
7d9285e8 908 struct perf_event *event;
0515e599
AS
909};
910
39bed6cb
MF
911#ifdef CONFIG_CGROUP_PERF
912
913/*
914 * perf_cgroup_info keeps track of time_enabled for a cgroup.
915 * This is a per-cpu dynamically allocated data structure.
916 */
917struct perf_cgroup_info {
918 u64 time;
919 u64 timestamp;
920};
921
922struct perf_cgroup {
923 struct cgroup_subsys_state css;
924 struct perf_cgroup_info __percpu *info;
925};
926
927/*
928 * Must ensure cgroup is pinned (css_get) before calling
929 * this function. In other words, we cannot call this function
930 * if there is no cgroup event for the current CPU context.
931 */
932static inline struct perf_cgroup *
614e4c4e 933perf_cgroup_from_task(struct task_struct *task, struct perf_event_context *ctx)
39bed6cb 934{
614e4c4e
SE
935 return container_of(task_css_check(task, perf_event_cgrp_id,
936 ctx ? lockdep_is_held(&ctx->lock)
937 : true),
39bed6cb
MF
938 struct perf_cgroup, css);
939}
940#endif /* CONFIG_CGROUP_PERF */
941
cdd6c482 942#ifdef CONFIG_PERF_EVENTS
829b42dd 943
fdc26706
AS
944extern void *perf_aux_output_begin(struct perf_output_handle *handle,
945 struct perf_event *event);
946extern void perf_aux_output_end(struct perf_output_handle *handle,
f4c0b0aa 947 unsigned long size);
fdc26706
AS
948extern int perf_aux_output_skip(struct perf_output_handle *handle,
949 unsigned long size);
950extern void *perf_get_aux(struct perf_output_handle *handle);
f4c0b0aa 951extern void perf_aux_output_flag(struct perf_output_handle *handle, u64 flags);
8d4e6c4c 952extern void perf_event_itrace_started(struct perf_event *event);
fdc26706 953
03d8e80b 954extern int perf_pmu_register(struct pmu *pmu, const char *name, int type);
b0a873eb 955extern void perf_pmu_unregister(struct pmu *pmu);
621a01ea 956
ab0cce56
JO
957extern void __perf_event_task_sched_in(struct task_struct *prev,
958 struct task_struct *task);
959extern void __perf_event_task_sched_out(struct task_struct *prev,
960 struct task_struct *next);
2b26f0aa 961extern int perf_event_init_task(struct task_struct *child, u64 clone_flags);
cdd6c482
IM
962extern void perf_event_exit_task(struct task_struct *child);
963extern void perf_event_free_task(struct task_struct *task);
4e231c79 964extern void perf_event_delayed_put(struct task_struct *task);
e03e7ee3 965extern struct file *perf_event_get(unsigned int fd);
f8d959a5 966extern const struct perf_event *perf_get_event(struct file *file);
ffe8690c 967extern const struct perf_event_attr *perf_event_attrs(struct perf_event *event);
cdd6c482 968extern void perf_event_print_debug(void);
33696fc0
PZ
969extern void perf_pmu_disable(struct pmu *pmu);
970extern void perf_pmu_enable(struct pmu *pmu);
ba532500
YZ
971extern void perf_sched_cb_dec(struct pmu *pmu);
972extern void perf_sched_cb_inc(struct pmu *pmu);
cdd6c482
IM
973extern int perf_event_task_disable(void);
974extern int perf_event_task_enable(void);
c68d224e
SE
975
976extern void perf_pmu_resched(struct pmu *pmu);
977
26ca5c11 978extern int perf_event_refresh(struct perf_event *event, int refresh);
cdd6c482 979extern void perf_event_update_userpage(struct perf_event *event);
fb0459d7
AV
980extern int perf_event_release_kernel(struct perf_event *event);
981extern struct perf_event *
982perf_event_create_kernel_counter(struct perf_event_attr *attr,
983 int cpu,
38a81da2 984 struct task_struct *task,
4dc0da86
AK
985 perf_overflow_handler_t callback,
986 void *context);
0cda4c02
YZ
987extern void perf_pmu_migrate_context(struct pmu *pmu,
988 int src_cpu, int dst_cpu);
7d9285e8
YS
989int perf_event_read_local(struct perf_event *event, u64 *value,
990 u64 *enabled, u64 *running);
59ed446f
PZ
991extern u64 perf_event_read_value(struct perf_event *event,
992 u64 *enabled, u64 *running);
5c92d124 993
d010b332 994
df1a132b 995struct perf_sample_data {
2565711f
PZ
996 /*
997 * Fields set by perf_sample_data_init(), group so as to
998 * minimize the cachelines touched.
999 */
1000 u64 addr;
1001 struct perf_raw_record *raw;
1002 struct perf_branch_stack *br_stack;
1003 u64 period;
2a6c6b7d 1004 union perf_sample_weight weight;
2565711f
PZ
1005 u64 txn;
1006 union perf_mem_data_src data_src;
5622f295 1007
2565711f
PZ
1008 /*
1009 * The other fields, optionally {set,used} by
1010 * perf_{prepare,output}_sample().
1011 */
1012 u64 type;
5622f295
MM
1013 u64 ip;
1014 struct {
1015 u32 pid;
1016 u32 tid;
1017 } tid_entry;
1018 u64 time;
5622f295
MM
1019 u64 id;
1020 u64 stream_id;
1021 struct {
1022 u32 cpu;
1023 u32 reserved;
1024 } cpu_entry;
5622f295 1025 struct perf_callchain_entry *callchain;
a4faf00d 1026 u64 aux_size;
88a7c26a 1027
60e2364e
SE
1028 struct perf_regs regs_user;
1029 struct perf_regs regs_intr;
c5ebcedb 1030 u64 stack_user_size;
fc7ce9c7
KL
1031
1032 u64 phys_addr;
6546b19f 1033 u64 cgroup;
8d97e718 1034 u64 data_page_size;
995f088e 1035 u64 code_page_size;
2565711f 1036} ____cacheline_aligned;
df1a132b 1037
770eee1f
SE
1038/* default value for data source */
1039#define PERF_MEM_NA (PERF_MEM_S(OP, NA) |\
1040 PERF_MEM_S(LVL, NA) |\
1041 PERF_MEM_S(SNOOP, NA) |\
1042 PERF_MEM_S(LOCK, NA) |\
1043 PERF_MEM_S(TLB, NA))
1044
fd0d000b
RR
1045static inline void perf_sample_data_init(struct perf_sample_data *data,
1046 u64 addr, u64 period)
dc1d628a 1047{
fd0d000b 1048 /* remaining struct members initialized in perf_prepare_sample() */
dc1d628a
PZ
1049 data->addr = addr;
1050 data->raw = NULL;
bce38cd5 1051 data->br_stack = NULL;
4018994f 1052 data->period = period;
2a6c6b7d 1053 data->weight.full = 0;
770eee1f 1054 data->data_src.val = PERF_MEM_NA;
fdfbbd07 1055 data->txn = 0;
dc1d628a
PZ
1056}
1057
5622f295
MM
1058extern void perf_output_sample(struct perf_output_handle *handle,
1059 struct perf_event_header *header,
1060 struct perf_sample_data *data,
cdd6c482 1061 struct perf_event *event);
5622f295
MM
1062extern void perf_prepare_sample(struct perf_event_header *header,
1063 struct perf_sample_data *data,
cdd6c482 1064 struct perf_event *event,
5622f295
MM
1065 struct pt_regs *regs);
1066
a8b0ca17 1067extern int perf_event_overflow(struct perf_event *event,
5622f295
MM
1068 struct perf_sample_data *data,
1069 struct pt_regs *regs);
df1a132b 1070
9ecda41a
WN
1071extern void perf_event_output_forward(struct perf_event *event,
1072 struct perf_sample_data *data,
1073 struct pt_regs *regs);
1074extern void perf_event_output_backward(struct perf_event *event,
1075 struct perf_sample_data *data,
1076 struct pt_regs *regs);
56201969
ACM
1077extern int perf_event_output(struct perf_event *event,
1078 struct perf_sample_data *data,
1079 struct pt_regs *regs);
21509084 1080
1879445d
WN
1081static inline bool
1082is_default_overflow_handler(struct perf_event *event)
1083{
9ecda41a
WN
1084 if (likely(event->overflow_handler == perf_event_output_forward))
1085 return true;
1086 if (unlikely(event->overflow_handler == perf_event_output_backward))
1087 return true;
1088 return false;
1879445d
WN
1089}
1090
21509084
YZ
1091extern void
1092perf_event_header__init_id(struct perf_event_header *header,
1093 struct perf_sample_data *data,
1094 struct perf_event *event);
1095extern void
1096perf_event__output_id_sample(struct perf_event *event,
1097 struct perf_output_handle *handle,
1098 struct perf_sample_data *sample);
1099
f38b0dbb
KL
1100extern void
1101perf_log_lost_samples(struct perf_event *event, u64 lost);
1102
486efe9f
AM
1103static inline bool event_has_any_exclude_flag(struct perf_event *event)
1104{
1105 struct perf_event_attr *attr = &event->attr;
1106
1107 return attr->exclude_idle || attr->exclude_user ||
1108 attr->exclude_kernel || attr->exclude_hv ||
1109 attr->exclude_guest || attr->exclude_host;
1110}
1111
6c7e550f
FBH
1112static inline bool is_sampling_event(struct perf_event *event)
1113{
1114 return event->attr.sample_period != 0;
1115}
1116
3b6f9e5c 1117/*
cdd6c482 1118 * Return 1 for a software event, 0 for a hardware event
3b6f9e5c 1119 */
cdd6c482 1120static inline int is_software_event(struct perf_event *event)
3b6f9e5c 1121{
4ff6a8de 1122 return event->event_caps & PERF_EV_CAP_SOFTWARE;
3b6f9e5c
PM
1123}
1124
a1150c20
SL
1125/*
1126 * Return 1 for event in sw context, 0 for event in hw context
1127 */
1128static inline int in_software_context(struct perf_event *event)
1129{
1130 return event->ctx->pmu->task_ctx_nr == perf_sw_context;
1131}
1132
8a58ddae
AS
1133static inline int is_exclusive_pmu(struct pmu *pmu)
1134{
1135 return pmu->capabilities & PERF_PMU_CAP_EXCLUSIVE;
1136}
1137
c5905afb 1138extern struct static_key perf_swevent_enabled[PERF_COUNT_SW_MAX];
f29ac756 1139
86038c5e 1140extern void ___perf_sw_event(u32, u64, struct pt_regs *, u64);
a8b0ca17 1141extern void __perf_sw_event(u32, u64, struct pt_regs *, u64);
f29ac756 1142
b0f82b81 1143#ifndef perf_arch_fetch_caller_regs
e7e7ee2e 1144static inline void perf_arch_fetch_caller_regs(struct pt_regs *regs, unsigned long ip) { }
b0f82b81 1145#endif
5331d7b8
FW
1146
1147/*
d15d3568
KS
1148 * When generating a perf sample in-line, instead of from an interrupt /
1149 * exception, we lack a pt_regs. This is typically used from software events
1150 * like: SW_CONTEXT_SWITCHES, SW_MIGRATIONS and the tie-in with tracepoints.
1151 *
1152 * We typically don't need a full set, but (for x86) do require:
5331d7b8
FW
1153 * - ip for PERF_SAMPLE_IP
1154 * - cs for user_mode() tests
d15d3568
KS
1155 * - sp for PERF_SAMPLE_CALLCHAIN
1156 * - eflags for MISC bits and CALLCHAIN (see: perf_hw_regs())
1157 *
1158 * NOTE: assumes @regs is otherwise already 0 filled; this is important for
1159 * things like PERF_SAMPLE_REGS_INTR.
5331d7b8 1160 */
b0f82b81 1161static inline void perf_fetch_caller_regs(struct pt_regs *regs)
5331d7b8 1162{
b0f82b81 1163 perf_arch_fetch_caller_regs(regs, CALLER_ADDR0);
5331d7b8
FW
1164}
1165
7e54a5a0 1166static __always_inline void
a8b0ca17 1167perf_sw_event(u32 event_id, u64 nr, struct pt_regs *regs, u64 addr)
e49a5bd3 1168{
86038c5e
PZI
1169 if (static_key_false(&perf_swevent_enabled[event_id]))
1170 __perf_sw_event(event_id, nr, regs, addr);
1171}
1172
1173DECLARE_PER_CPU(struct pt_regs, __perf_regs[4]);
7e54a5a0 1174
86038c5e
PZI
1175/*
1176 * 'Special' version for the scheduler, it hard assumes no recursion,
1177 * which is guaranteed by us not actually scheduling inside other swevents
1178 * because those disable preemption.
1179 */
7c8056bb 1180static __always_inline void __perf_sw_event_sched(u32 event_id, u64 nr, u64 addr)
86038c5e 1181{
7c8056bb 1182 struct pt_regs *regs = this_cpu_ptr(&__perf_regs[0]);
86038c5e 1183
7c8056bb
NK
1184 perf_fetch_caller_regs(regs);
1185 ___perf_sw_event(event_id, nr, regs, addr);
e49a5bd3
FW
1186}
1187
9107c89e 1188extern struct static_key_false perf_sched_events;
ee6dcfa4 1189
7c8056bb 1190static __always_inline bool __perf_sw_enabled(int swevt)
ff303e66 1191{
7c8056bb 1192 return static_key_false(&perf_swevent_enabled[swevt]);
ff303e66
PZ
1193}
1194
1195static inline void perf_event_task_migrate(struct task_struct *task)
1196{
7c8056bb 1197 if (__perf_sw_enabled(PERF_COUNT_SW_CPU_MIGRATIONS))
ff303e66
PZ
1198 task->sched_migrated = 1;
1199}
1200
ab0cce56 1201static inline void perf_event_task_sched_in(struct task_struct *prev,
a8d757ef 1202 struct task_struct *task)
ab0cce56 1203{
9107c89e 1204 if (static_branch_unlikely(&perf_sched_events))
ab0cce56 1205 __perf_event_task_sched_in(prev, task);
ff303e66 1206
7c8056bb
NK
1207 if (__perf_sw_enabled(PERF_COUNT_SW_CPU_MIGRATIONS) &&
1208 task->sched_migrated) {
1209 __perf_sw_event_sched(PERF_COUNT_SW_CPU_MIGRATIONS, 1, 0);
ff303e66
PZ
1210 task->sched_migrated = 0;
1211 }
ab0cce56
JO
1212}
1213
1214static inline void perf_event_task_sched_out(struct task_struct *prev,
1215 struct task_struct *next)
ee6dcfa4 1216{
7c8056bb
NK
1217 if (__perf_sw_enabled(PERF_COUNT_SW_CONTEXT_SWITCHES))
1218 __perf_sw_event_sched(PERF_COUNT_SW_CONTEXT_SWITCHES, 1, 0);
ee6dcfa4 1219
d0d1dd62
NK
1220#ifdef CONFIG_CGROUP_PERF
1221 if (__perf_sw_enabled(PERF_COUNT_SW_CGROUP_SWITCHES) &&
1222 perf_cgroup_from_task(prev, NULL) !=
1223 perf_cgroup_from_task(next, NULL))
1224 __perf_sw_event_sched(PERF_COUNT_SW_CGROUP_SWITCHES, 1, 0);
1225#endif
1226
9107c89e 1227 if (static_branch_unlikely(&perf_sched_events))
ab0cce56 1228 __perf_event_task_sched_out(prev, next);
ee6dcfa4
PZ
1229}
1230
3af9e859 1231extern void perf_event_mmap(struct vm_area_struct *vma);
76193a94
SL
1232
1233extern void perf_event_ksymbol(u16 ksym_type, u64 addr, u32 len,
1234 bool unregister, const char *sym);
6ee52e2a
SL
1235extern void perf_event_bpf_event(struct bpf_prog *prog,
1236 enum perf_bpf_event_type type,
1237 u16 flags);
76193a94 1238
39447b38 1239extern struct perf_guest_info_callbacks *perf_guest_cbs;
dcf46b94
ZY
1240extern int perf_register_guest_info_callbacks(struct perf_guest_info_callbacks *callbacks);
1241extern int perf_unregister_guest_info_callbacks(struct perf_guest_info_callbacks *callbacks);
39447b38 1242
e041e328 1243extern void perf_event_exec(void);
82b89778 1244extern void perf_event_comm(struct task_struct *tsk, bool exec);
e4222673 1245extern void perf_event_namespaces(struct task_struct *tsk);
cdd6c482 1246extern void perf_event_fork(struct task_struct *tsk);
e17d43b9
AH
1247extern void perf_event_text_poke(const void *addr,
1248 const void *old_bytes, size_t old_len,
1249 const void *new_bytes, size_t new_len);
8d1b2d93 1250
56962b44
FW
1251/* Callchains */
1252DECLARE_PER_CPU(struct perf_callchain_entry, perf_callchain_entry);
1253
cfbcf468
ACM
1254extern void perf_callchain_user(struct perf_callchain_entry_ctx *entry, struct pt_regs *regs);
1255extern void perf_callchain_kernel(struct perf_callchain_entry_ctx *entry, struct pt_regs *regs);
568b329a
AS
1256extern struct perf_callchain_entry *
1257get_perf_callchain(struct pt_regs *regs, u32 init_nr, bool kernel, bool user,
cfbcf468 1258 u32 max_stack, bool crosstask, bool add_mark);
6cbc304f 1259extern struct perf_callchain_entry *perf_callchain(struct perf_event *event, struct pt_regs *regs);
97c79a38 1260extern int get_callchain_buffers(int max_stack);
568b329a 1261extern void put_callchain_buffers(void);
d141b8bc
SL
1262extern struct perf_callchain_entry *get_callchain_entry(int *rctx);
1263extern void put_callchain_entry(int rctx);
394ee076 1264
c5dfd78e 1265extern int sysctl_perf_event_max_stack;
c85b0334 1266extern int sysctl_perf_event_max_contexts_per_stack;
c5dfd78e 1267
c85b0334
ACM
1268static inline int perf_callchain_store_context(struct perf_callchain_entry_ctx *ctx, u64 ip)
1269{
1270 if (ctx->contexts < sysctl_perf_event_max_contexts_per_stack) {
1271 struct perf_callchain_entry *entry = ctx->entry;
1272 entry->ip[entry->nr++] = ip;
1273 ++ctx->contexts;
1274 return 0;
1275 } else {
1276 ctx->contexts_maxed = true;
1277 return -1; /* no more room, stop walking the stack */
1278 }
1279}
3e4de4ec 1280
cfbcf468 1281static inline int perf_callchain_store(struct perf_callchain_entry_ctx *ctx, u64 ip)
70791ce9 1282{
c85b0334 1283 if (ctx->nr < ctx->max_stack && !ctx->contexts_maxed) {
3b1fff08 1284 struct perf_callchain_entry *entry = ctx->entry;
70791ce9 1285 entry->ip[entry->nr++] = ip;
3b1fff08 1286 ++ctx->nr;
568b329a
AS
1287 return 0;
1288 } else {
1289 return -1; /* no more room, stop walking the stack */
1290 }
70791ce9 1291}
394ee076 1292
cdd6c482
IM
1293extern int sysctl_perf_event_paranoid;
1294extern int sysctl_perf_event_mlock;
1295extern int sysctl_perf_event_sample_rate;
14c63f17
DH
1296extern int sysctl_perf_cpu_time_max_percent;
1297
1298extern void perf_sample_event_took(u64 sample_len_ns);
1ccd1549 1299
32927393
CH
1300int perf_proc_update_handler(struct ctl_table *table, int write,
1301 void *buffer, size_t *lenp, loff_t *ppos);
1302int perf_cpu_time_max_percent_handler(struct ctl_table *table, int write,
1303 void *buffer, size_t *lenp, loff_t *ppos);
c5dfd78e 1304int perf_event_max_stack_handler(struct ctl_table *table, int write,
32927393 1305 void *buffer, size_t *lenp, loff_t *ppos);
163ec435 1306
da97e184
JFG
1307/* Access to perf_event_open(2) syscall. */
1308#define PERF_SECURITY_OPEN 0
1309
1310/* Finer grained perf_event_open(2) access control. */
1311#define PERF_SECURITY_CPU 1
1312#define PERF_SECURITY_KERNEL 2
1313#define PERF_SECURITY_TRACEPOINT 3
1314
1315static inline int perf_is_paranoid(void)
320ebf09
PZ
1316{
1317 return sysctl_perf_event_paranoid > -1;
1318}
1319
da97e184 1320static inline int perf_allow_kernel(struct perf_event_attr *attr)
320ebf09 1321{
18aa1856 1322 if (sysctl_perf_event_paranoid > 1 && !perfmon_capable())
da97e184
JFG
1323 return -EACCES;
1324
1325 return security_perf_event_open(attr, PERF_SECURITY_KERNEL);
320ebf09
PZ
1326}
1327
da97e184 1328static inline int perf_allow_cpu(struct perf_event_attr *attr)
320ebf09 1329{
18aa1856 1330 if (sysctl_perf_event_paranoid > 0 && !perfmon_capable())
da97e184
JFG
1331 return -EACCES;
1332
1333 return security_perf_event_open(attr, PERF_SECURITY_CPU);
1334}
1335
1336static inline int perf_allow_tracepoint(struct perf_event_attr *attr)
1337{
18aa1856 1338 if (sysctl_perf_event_paranoid > -1 && !perfmon_capable())
da97e184
JFG
1339 return -EPERM;
1340
1341 return security_perf_event_open(attr, PERF_SECURITY_TRACEPOINT);
320ebf09
PZ
1342}
1343
cdd6c482 1344extern void perf_event_init(void);
1e1dcd93 1345extern void perf_tp_event(u16 event_type, u64 count, void *record,
1c024eca 1346 int entry_size, struct pt_regs *regs,
e6dab5ff 1347 struct hlist_head *head, int rctx,
8fd0fbbe 1348 struct task_struct *task);
24f1e32c 1349extern void perf_bp_event(struct perf_event *event, void *data);
0d905bca 1350
9d23a90a 1351#ifndef perf_misc_flags
e7e7ee2e
IM
1352# define perf_misc_flags(regs) \
1353 (user_mode(regs) ? PERF_RECORD_MISC_USER : PERF_RECORD_MISC_KERNEL)
1354# define perf_instruction_pointer(regs) instruction_pointer(regs)
9d23a90a 1355#endif
c895f6f7
HB
1356#ifndef perf_arch_bpf_user_pt_regs
1357# define perf_arch_bpf_user_pt_regs(regs) regs
1358#endif
9d23a90a 1359
bce38cd5
SE
1360static inline bool has_branch_stack(struct perf_event *event)
1361{
1362 return event->attr.sample_type & PERF_SAMPLE_BRANCH_STACK;
a46a2300
YZ
1363}
1364
1365static inline bool needs_branch_stack(struct perf_event *event)
1366{
1367 return event->attr.branch_sample_type != 0;
bce38cd5
SE
1368}
1369
45bfb2e5
PZ
1370static inline bool has_aux(struct perf_event *event)
1371{
1372 return event->pmu->setup_aux;
1373}
1374
9ecda41a
WN
1375static inline bool is_write_backward(struct perf_event *event)
1376{
1377 return !!event->attr.write_backward;
1378}
1379
375637bc
AS
1380static inline bool has_addr_filter(struct perf_event *event)
1381{
1382 return event->pmu->nr_addr_filters;
1383}
1384
1385/*
1386 * An inherited event uses parent's filters
1387 */
1388static inline struct perf_addr_filters_head *
1389perf_event_addr_filters(struct perf_event *event)
1390{
1391 struct perf_addr_filters_head *ifh = &event->addr_filters;
1392
1393 if (event->parent)
1394 ifh = &event->parent->addr_filters;
1395
1396 return ifh;
1397}
1398
1399extern void perf_event_addr_filters_sync(struct perf_event *event);
1400
5622f295 1401extern int perf_output_begin(struct perf_output_handle *handle,
267fb273 1402 struct perf_sample_data *data,
a7ac67ea 1403 struct perf_event *event, unsigned int size);
9ecda41a 1404extern int perf_output_begin_forward(struct perf_output_handle *handle,
267fb273
PZ
1405 struct perf_sample_data *data,
1406 struct perf_event *event,
1407 unsigned int size);
9ecda41a 1408extern int perf_output_begin_backward(struct perf_output_handle *handle,
267fb273 1409 struct perf_sample_data *data,
9ecda41a
WN
1410 struct perf_event *event,
1411 unsigned int size);
1412
5622f295 1413extern void perf_output_end(struct perf_output_handle *handle);
91d7753a 1414extern unsigned int perf_output_copy(struct perf_output_handle *handle,
5622f295 1415 const void *buf, unsigned int len);
5685e0ff
JO
1416extern unsigned int perf_output_skip(struct perf_output_handle *handle,
1417 unsigned int len);
a4faf00d
AS
1418extern long perf_output_copy_aux(struct perf_output_handle *aux_handle,
1419 struct perf_output_handle *handle,
1420 unsigned long from, unsigned long to);
4ed7c92d
PZ
1421extern int perf_swevent_get_recursion_context(void);
1422extern void perf_swevent_put_recursion_context(int rctx);
ab573844 1423extern u64 perf_swevent_set_period(struct perf_event *event);
44234adc
FW
1424extern void perf_event_enable(struct perf_event *event);
1425extern void perf_event_disable(struct perf_event *event);
fae3fde6 1426extern void perf_event_disable_local(struct perf_event *event);
5aab90ce 1427extern void perf_event_disable_inatomic(struct perf_event *event);
e9d2b064 1428extern void perf_event_task_tick(void);
475113d9 1429extern int perf_event_account_interrupt(struct perf_event *event);
3ca270fc 1430extern int perf_event_period(struct perf_event *event, u64 value);
52ba4b0b 1431extern u64 perf_event_pause(struct perf_event *event, bool reset);
e041e328 1432#else /* !CONFIG_PERF_EVENTS: */
fdc26706
AS
1433static inline void *
1434perf_aux_output_begin(struct perf_output_handle *handle,
1435 struct perf_event *event) { return NULL; }
1436static inline void
f4c0b0aa
WD
1437perf_aux_output_end(struct perf_output_handle *handle, unsigned long size)
1438 { }
fdc26706
AS
1439static inline int
1440perf_aux_output_skip(struct perf_output_handle *handle,
1441 unsigned long size) { return -EINVAL; }
1442static inline void *
1443perf_get_aux(struct perf_output_handle *handle) { return NULL; }
0793a61d 1444static inline void
ff303e66
PZ
1445perf_event_task_migrate(struct task_struct *task) { }
1446static inline void
ab0cce56
JO
1447perf_event_task_sched_in(struct task_struct *prev,
1448 struct task_struct *task) { }
1449static inline void
1450perf_event_task_sched_out(struct task_struct *prev,
1451 struct task_struct *next) { }
2b26f0aa
ME
1452static inline int perf_event_init_task(struct task_struct *child,
1453 u64 clone_flags) { return 0; }
cdd6c482
IM
1454static inline void perf_event_exit_task(struct task_struct *child) { }
1455static inline void perf_event_free_task(struct task_struct *task) { }
4e231c79 1456static inline void perf_event_delayed_put(struct task_struct *task) { }
e03e7ee3 1457static inline struct file *perf_event_get(unsigned int fd) { return ERR_PTR(-EINVAL); }
f8d959a5
YS
1458static inline const struct perf_event *perf_get_event(struct file *file)
1459{
1460 return ERR_PTR(-EINVAL);
1461}
ffe8690c
KX
1462static inline const struct perf_event_attr *perf_event_attrs(struct perf_event *event)
1463{
1464 return ERR_PTR(-EINVAL);
1465}
7d9285e8
YS
1466static inline int perf_event_read_local(struct perf_event *event, u64 *value,
1467 u64 *enabled, u64 *running)
f91840a3
AS
1468{
1469 return -EINVAL;
1470}
57c0c15b 1471static inline void perf_event_print_debug(void) { }
57c0c15b
IM
1472static inline int perf_event_task_disable(void) { return -EINVAL; }
1473static inline int perf_event_task_enable(void) { return -EINVAL; }
26ca5c11
AK
1474static inline int perf_event_refresh(struct perf_event *event, int refresh)
1475{
1476 return -EINVAL;
1477}
15dbf27c 1478
925d519a 1479static inline void
a8b0ca17 1480perf_sw_event(u32 event_id, u64 nr, struct pt_regs *regs, u64 addr) { }
24f1e32c 1481static inline void
184f412c 1482perf_bp_event(struct perf_event *event, void *data) { }
0a4a9391 1483
39447b38 1484static inline int perf_register_guest_info_callbacks
e7e7ee2e 1485(struct perf_guest_info_callbacks *callbacks) { return 0; }
39447b38 1486static inline int perf_unregister_guest_info_callbacks
e7e7ee2e 1487(struct perf_guest_info_callbacks *callbacks) { return 0; }
39447b38 1488
57c0c15b 1489static inline void perf_event_mmap(struct vm_area_struct *vma) { }
76193a94
SL
1490
1491typedef int (perf_ksymbol_get_name_f)(char *name, int name_len, void *data);
1492static inline void perf_event_ksymbol(u16 ksym_type, u64 addr, u32 len,
1493 bool unregister, const char *sym) { }
6ee52e2a
SL
1494static inline void perf_event_bpf_event(struct bpf_prog *prog,
1495 enum perf_bpf_event_type type,
1496 u16 flags) { }
e041e328 1497static inline void perf_event_exec(void) { }
82b89778 1498static inline void perf_event_comm(struct task_struct *tsk, bool exec) { }
e4222673 1499static inline void perf_event_namespaces(struct task_struct *tsk) { }
cdd6c482 1500static inline void perf_event_fork(struct task_struct *tsk) { }
e17d43b9
AH
1501static inline void perf_event_text_poke(const void *addr,
1502 const void *old_bytes,
1503 size_t old_len,
1504 const void *new_bytes,
1505 size_t new_len) { }
cdd6c482 1506static inline void perf_event_init(void) { }
184f412c 1507static inline int perf_swevent_get_recursion_context(void) { return -1; }
4ed7c92d 1508static inline void perf_swevent_put_recursion_context(int rctx) { }
ab573844 1509static inline u64 perf_swevent_set_period(struct perf_event *event) { return 0; }
44234adc
FW
1510static inline void perf_event_enable(struct perf_event *event) { }
1511static inline void perf_event_disable(struct perf_event *event) { }
500ad2d8 1512static inline int __perf_event_disable(void *info) { return -1; }
e9d2b064 1513static inline void perf_event_task_tick(void) { }
ffe8690c 1514static inline int perf_event_release_kernel(struct perf_event *event) { return 0; }
3ca270fc
LX
1515static inline int perf_event_period(struct perf_event *event, u64 value)
1516{
1517 return -EINVAL;
1518}
52ba4b0b
LX
1519static inline u64 perf_event_pause(struct perf_event *event, bool reset)
1520{
1521 return 0;
1522}
0793a61d
TG
1523#endif
1524
6c4d3bc9
DR
1525#if defined(CONFIG_PERF_EVENTS) && defined(CONFIG_CPU_SUP_INTEL)
1526extern void perf_restore_debug_store(void);
1527#else
1d9d8639 1528static inline void perf_restore_debug_store(void) { }
0793a61d
TG
1529#endif
1530
7e3f977e
DB
1531static __always_inline bool perf_raw_frag_last(const struct perf_raw_frag *frag)
1532{
1533 return frag->pad < sizeof(u64);
1534}
1535
e7e7ee2e 1536#define perf_output_put(handle, x) perf_output_copy((handle), &(x), sizeof(x))
5622f295 1537
2663960c
SB
1538struct perf_pmu_events_attr {
1539 struct device_attribute attr;
1540 u64 id;
3a54aaa0 1541 const char *event_str;
2663960c
SB
1542};
1543
fc07e9f9
AK
1544struct perf_pmu_events_ht_attr {
1545 struct device_attribute attr;
1546 u64 id;
1547 const char *event_str_ht;
1548 const char *event_str_noht;
1549};
1550
a9c81ccd
KL
1551struct perf_pmu_events_hybrid_attr {
1552 struct device_attribute attr;
1553 u64 id;
1554 const char *event_str;
1555 u64 pmu_type;
1556};
1557
1558struct perf_pmu_format_hybrid_attr {
1559 struct device_attribute attr;
1560 u64 pmu_type;
1561};
1562
fd979c01
CS
1563ssize_t perf_event_sysfs_show(struct device *dev, struct device_attribute *attr,
1564 char *page);
1565
2663960c
SB
1566#define PMU_EVENT_ATTR(_name, _var, _id, _show) \
1567static struct perf_pmu_events_attr _var = { \
1568 .attr = __ATTR(_name, 0444, _show, NULL), \
1569 .id = _id, \
1570};
1571
f0405b81
CS
1572#define PMU_EVENT_ATTR_STRING(_name, _var, _str) \
1573static struct perf_pmu_events_attr _var = { \
1574 .attr = __ATTR(_name, 0444, perf_event_sysfs_show, NULL), \
1575 .id = 0, \
1576 .event_str = _str, \
1577};
1578
f8e6d241
QL
1579#define PMU_EVENT_ATTR_ID(_name, _show, _id) \
1580 (&((struct perf_pmu_events_attr[]) { \
1581 { .attr = __ATTR(_name, 0444, _show, NULL), \
1582 .id = _id, } \
1583 })[0].attr.attr)
1584
641cc938
JO
1585#define PMU_FORMAT_ATTR(_name, _format) \
1586static ssize_t \
1587_name##_show(struct device *dev, \
1588 struct device_attribute *attr, \
1589 char *page) \
1590{ \
1591 BUILD_BUG_ON(sizeof(_format) >= PAGE_SIZE); \
1592 return sprintf(page, _format "\n"); \
1593} \
1594 \
1595static struct device_attribute format_attr_##_name = __ATTR_RO(_name)
1596
00e16c3d
TG
1597/* Performance counter hotplug functions */
1598#ifdef CONFIG_PERF_EVENTS
1599int perf_event_init_cpu(unsigned int cpu);
1600int perf_event_exit_cpu(unsigned int cpu);
1601#else
1602#define perf_event_init_cpu NULL
1603#define perf_event_exit_cpu NULL
1604#endif
1605
f1ec3a51
BT
1606extern void __weak arch_perf_update_userpage(struct perf_event *event,
1607 struct perf_event_mmap_page *userpg,
1608 u64 now);
1609
51b646b2
PZ
1610#ifdef CONFIG_MMU
1611extern __weak u64 arch_perf_get_page_size(struct mm_struct *mm, unsigned long addr);
1612#endif
1613
cdd6c482 1614#endif /* _LINUX_PERF_EVENT_H */