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