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