1
2
3
4
5
6
7
8
9
10
11
12
13
14#ifndef _LINUX_PERF_EVENT_H
15#define _LINUX_PERF_EVENT_H
16
17#include <uapi/linux/perf_event.h>
18
19
20
21
22
23#ifdef CONFIG_PERF_EVENTS
24# include <asm/perf_event.h>
25# include <asm/local64.h>
26#endif
27
28struct perf_guest_info_callbacks {
29 int (*is_in_guest)(void);
30 int (*is_user_mode)(void);
31 unsigned long (*get_guest_ip)(void);
32};
33
34#ifdef CONFIG_HAVE_HW_BREAKPOINT
35#include <asm/hw_breakpoint.h>
36#endif
37
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>
43#include <linux/hrtimer.h>
44#include <linux/fs.h>
45#include <linux/pid_namespace.h>
46#include <linux/workqueue.h>
47#include <linux/ftrace.h>
48#include <linux/cpu.h>
49#include <linux/irq_work.h>
50#include <linux/static_key.h>
51#include <linux/jump_label_ratelimit.h>
52#include <linux/atomic.h>
53#include <linux/sysfs.h>
54#include <linux/perf_regs.h>
55#include <asm/local.h>
56
57struct perf_callchain_entry {
58 __u64 nr;
59 __u64 ip[PERF_MAX_STACK_DEPTH];
60};
61
62struct perf_raw_record {
63 u32 size;
64 void *data;
65};
66
67
68
69
70
71
72
73
74
75
76struct perf_branch_stack {
77 __u64 nr;
78 struct perf_branch_entry entries[0];
79};
80
81struct perf_regs_user {
82 __u64 abi;
83 struct pt_regs *regs;
84};
85
86struct task_struct;
87
88
89
90
91struct hw_perf_event_extra {
92 u64 config;
93 unsigned int reg;
94 int alloc;
95 int idx;
96};
97
98struct event_constraint;
99
100
101
102
103struct hw_perf_event {
104#ifdef CONFIG_PERF_EVENTS
105 union {
106 struct {
107 u64 config;
108 u64 last_tag;
109 unsigned long config_base;
110 unsigned long event_base;
111 int event_base_rdpmc;
112 int idx;
113 int last_cpu;
114 int flags;
115
116 struct hw_perf_event_extra extra_reg;
117 struct hw_perf_event_extra branch_reg;
118
119 struct event_constraint *constraint;
120 };
121 struct {
122 struct hrtimer hrtimer;
123 };
124 struct {
125 struct task_struct *tp_target;
126
127 struct list_head tp_list;
128 };
129#ifdef CONFIG_HAVE_HW_BREAKPOINT
130 struct {
131
132
133
134
135
136 struct task_struct *bp_target;
137 struct arch_hw_breakpoint info;
138 struct list_head bp_list;
139 };
140#endif
141 };
142 int state;
143 local64_t prev_count;
144 u64 sample_period;
145 u64 last_period;
146 local64_t period_left;
147 u64 interrupts_seq;
148 u64 interrupts;
149
150 u64 freq_time_stamp;
151 u64 freq_count_stamp;
152#endif
153};
154
155
156
157
158#define PERF_HES_STOPPED 0x01
159#define PERF_HES_UPTODATE 0x02
160#define PERF_HES_ARCH 0x04
161
162struct perf_event;
163
164
165
166
167#define PERF_EVENT_TXN 0x1
168
169
170
171
172struct pmu {
173 struct list_head entry;
174
175 struct device *dev;
176 const struct attribute_group **attr_groups;
177 const char *name;
178 int type;
179
180 int * __percpu pmu_disable_count;
181 struct perf_cpu_context * __percpu pmu_cpu_context;
182 int task_ctx_nr;
183 int hrtimer_interval_ms;
184
185
186
187
188
189 void (*pmu_enable) (struct pmu *pmu);
190 void (*pmu_disable) (struct pmu *pmu);
191
192
193
194
195
196 int (*event_init) (struct perf_event *event);
197
198#define PERF_EF_START 0x01
199#define PERF_EF_RELOAD 0x02
200#define PERF_EF_UPDATE 0x04
201
202
203
204
205
206 int (*add) (struct perf_event *event, int flags);
207 void (*del) (struct perf_event *event, int flags);
208
209
210
211
212
213
214 void (*start) (struct perf_event *event, int flags);
215 void (*stop) (struct perf_event *event, int flags);
216
217
218
219
220 void (*read) (struct perf_event *event);
221
222
223
224
225
226
227
228
229
230 void (*start_txn) (struct pmu *pmu);
231
232
233
234
235
236
237 int (*commit_txn) (struct pmu *pmu);
238
239
240
241
242 void (*cancel_txn) (struct pmu *pmu);
243
244
245
246
247
248 int (*event_idx) (struct perf_event *event);
249
250
251
252
253 void (*flush_branch_stack) (void);
254};
255
256
257
258
259enum perf_event_active_state {
260 PERF_EVENT_STATE_ERROR = -2,
261 PERF_EVENT_STATE_OFF = -1,
262 PERF_EVENT_STATE_INACTIVE = 0,
263 PERF_EVENT_STATE_ACTIVE = 1,
264};
265
266struct file;
267struct perf_sample_data;
268
269typedef void (*perf_overflow_handler_t)(struct perf_event *,
270 struct perf_sample_data *,
271 struct pt_regs *regs);
272
273enum perf_group_flag {
274 PERF_GROUP_SOFTWARE = 0x1,
275};
276
277#define SWEVENT_HLIST_BITS 8
278#define SWEVENT_HLIST_SIZE (1 << SWEVENT_HLIST_BITS)
279
280struct swevent_hlist {
281 struct hlist_head heads[SWEVENT_HLIST_SIZE];
282 struct rcu_head rcu_head;
283};
284
285#define PERF_ATTACH_CONTEXT 0x01
286#define PERF_ATTACH_GROUP 0x02
287#define PERF_ATTACH_TASK 0x04
288
289struct perf_cgroup;
290struct ring_buffer;
291
292
293
294
295struct perf_event {
296#ifdef CONFIG_PERF_EVENTS
297
298
299
300
301
302 struct list_head event_entry;
303
304
305
306
307
308
309
310
311
312 struct list_head group_entry;
313 struct list_head sibling_list;
314
315
316
317
318
319
320 struct list_head migrate_entry;
321
322 struct hlist_node hlist_entry;
323 int nr_siblings;
324 int group_flags;
325 struct perf_event *group_leader;
326 struct pmu *pmu;
327
328 enum perf_event_active_state state;
329 unsigned int attach_state;
330 local64_t count;
331 atomic64_t child_count;
332
333
334
335
336
337
338
339
340
341
342 u64 total_time_enabled;
343 u64 total_time_running;
344
345
346
347
348
349
350
351
352
353
354
355 u64 tstamp_enabled;
356 u64 tstamp_running;
357 u64 tstamp_stopped;
358
359
360
361
362
363
364
365
366
367 u64 shadow_ctx_time;
368
369 struct perf_event_attr attr;
370 u16 header_size;
371 u16 id_header_size;
372 u16 read_size;
373 struct hw_perf_event hw;
374
375 struct perf_event_context *ctx;
376 atomic_long_t refcount;
377
378
379
380
381
382 atomic64_t child_total_time_enabled;
383 atomic64_t child_total_time_running;
384
385
386
387
388 struct mutex child_mutex;
389 struct list_head child_list;
390 struct perf_event *parent;
391
392 int oncpu;
393 int cpu;
394
395 struct list_head owner_entry;
396 struct task_struct *owner;
397
398
399 struct mutex mmap_mutex;
400 atomic_t mmap_count;
401
402 struct ring_buffer *rb;
403 struct list_head rb_entry;
404
405
406 wait_queue_head_t waitq;
407 struct fasync_struct *fasync;
408
409
410 int pending_wakeup;
411 int pending_kill;
412 int pending_disable;
413 struct irq_work pending;
414
415 atomic_t event_limit;
416
417 void (*destroy)(struct perf_event *);
418 struct rcu_head rcu_head;
419
420 struct pid_namespace *ns;
421 u64 id;
422
423 perf_overflow_handler_t overflow_handler;
424 void *overflow_handler_context;
425
426#ifdef CONFIG_EVENT_TRACING
427 struct ftrace_event_call *tp_event;
428 struct event_filter *filter;
429#ifdef CONFIG_FUNCTION_TRACER
430 struct ftrace_ops ftrace_ops;
431#endif
432#endif
433
434#ifdef CONFIG_CGROUP_PERF
435 struct perf_cgroup *cgrp;
436 int cgrp_defer_enabled;
437#endif
438
439#endif
440};
441
442enum perf_event_context_type {
443 task_context,
444 cpu_context,
445};
446
447
448
449
450
451
452struct perf_event_context {
453 struct pmu *pmu;
454 enum perf_event_context_type type;
455
456
457
458
459 raw_spinlock_t lock;
460
461
462
463
464
465 struct mutex mutex;
466
467 struct list_head pinned_groups;
468 struct list_head flexible_groups;
469 struct list_head event_list;
470 int nr_events;
471 int nr_active;
472 int is_active;
473 int nr_stat;
474 int nr_freq;
475 int rotate_disable;
476 atomic_t refcount;
477 struct task_struct *task;
478
479
480
481
482 u64 time;
483 u64 timestamp;
484
485
486
487
488
489 struct perf_event_context *parent_ctx;
490 u64 parent_gen;
491 u64 generation;
492 int pin_count;
493 int nr_cgroups;
494 int nr_branch_stack;
495 struct rcu_head rcu_head;
496};
497
498
499
500
501
502#define PERF_NR_CONTEXTS 4
503
504
505
506
507struct perf_cpu_context {
508 struct perf_event_context ctx;
509 struct perf_event_context *task_ctx;
510 int active_oncpu;
511 int exclusive;
512 struct hrtimer hrtimer;
513 ktime_t hrtimer_interval;
514 struct list_head rotation_list;
515 struct pmu *unique_pmu;
516 struct perf_cgroup *cgrp;
517};
518
519struct perf_output_handle {
520 struct perf_event *event;
521 struct ring_buffer *rb;
522 unsigned long wakeup;
523 unsigned long size;
524 void *addr;
525 int page;
526};
527
528#ifdef CONFIG_PERF_EVENTS
529
530extern int perf_pmu_register(struct pmu *pmu, const char *name, int type);
531extern void perf_pmu_unregister(struct pmu *pmu);
532
533extern int perf_num_counters(void);
534extern const char *perf_pmu_name(void);
535extern void __perf_event_task_sched_in(struct task_struct *prev,
536 struct task_struct *task);
537extern void __perf_event_task_sched_out(struct task_struct *prev,
538 struct task_struct *next);
539extern int perf_event_init_task(struct task_struct *child);
540extern void perf_event_exit_task(struct task_struct *child);
541extern void perf_event_free_task(struct task_struct *task);
542extern void perf_event_delayed_put(struct task_struct *task);
543extern void perf_event_print_debug(void);
544extern void perf_pmu_disable(struct pmu *pmu);
545extern void perf_pmu_enable(struct pmu *pmu);
546extern int perf_event_task_disable(void);
547extern int perf_event_task_enable(void);
548extern int perf_event_refresh(struct perf_event *event, int refresh);
549extern void perf_event_update_userpage(struct perf_event *event);
550extern int perf_event_release_kernel(struct perf_event *event);
551extern struct perf_event *
552perf_event_create_kernel_counter(struct perf_event_attr *attr,
553 int cpu,
554 struct task_struct *task,
555 perf_overflow_handler_t callback,
556 void *context);
557extern void perf_pmu_migrate_context(struct pmu *pmu,
558 int src_cpu, int dst_cpu);
559extern u64 perf_event_read_value(struct perf_event *event,
560 u64 *enabled, u64 *running);
561
562
563struct perf_sample_data {
564 u64 type;
565
566 u64 ip;
567 struct {
568 u32 pid;
569 u32 tid;
570 } tid_entry;
571 u64 time;
572 u64 addr;
573 u64 id;
574 u64 stream_id;
575 struct {
576 u32 cpu;
577 u32 reserved;
578 } cpu_entry;
579 u64 period;
580 union perf_mem_data_src data_src;
581 struct perf_callchain_entry *callchain;
582 struct perf_raw_record *raw;
583 struct perf_branch_stack *br_stack;
584 struct perf_regs_user regs_user;
585 u64 stack_user_size;
586 u64 weight;
587};
588
589static inline void perf_sample_data_init(struct perf_sample_data *data,
590 u64 addr, u64 period)
591{
592
593 data->addr = addr;
594 data->raw = NULL;
595 data->br_stack = NULL;
596 data->period = period;
597 data->regs_user.abi = PERF_SAMPLE_REGS_ABI_NONE;
598 data->regs_user.regs = NULL;
599 data->stack_user_size = 0;
600 data->weight = 0;
601 data->data_src.val = 0;
602}
603
604extern void perf_output_sample(struct perf_output_handle *handle,
605 struct perf_event_header *header,
606 struct perf_sample_data *data,
607 struct perf_event *event);
608extern void perf_prepare_sample(struct perf_event_header *header,
609 struct perf_sample_data *data,
610 struct perf_event *event,
611 struct pt_regs *regs);
612
613extern int perf_event_overflow(struct perf_event *event,
614 struct perf_sample_data *data,
615 struct pt_regs *regs);
616
617static inline bool is_sampling_event(struct perf_event *event)
618{
619 return event->attr.sample_period != 0;
620}
621
622
623
624
625static inline int is_software_event(struct perf_event *event)
626{
627 return event->pmu->task_ctx_nr == perf_sw_context;
628}
629
630extern struct static_key perf_swevent_enabled[PERF_COUNT_SW_MAX];
631
632extern void __perf_sw_event(u32, u64, struct pt_regs *, u64);
633
634#ifndef perf_arch_fetch_caller_regs
635static inline void perf_arch_fetch_caller_regs(struct pt_regs *regs, unsigned long ip) { }
636#endif
637
638
639
640
641
642
643
644
645
646static inline void perf_fetch_caller_regs(struct pt_regs *regs)
647{
648 memset(regs, 0, sizeof(*regs));
649
650 perf_arch_fetch_caller_regs(regs, CALLER_ADDR0);
651}
652
653static __always_inline void
654perf_sw_event(u32 event_id, u64 nr, struct pt_regs *regs, u64 addr)
655{
656 struct pt_regs hot_regs;
657
658 if (static_key_false(&perf_swevent_enabled[event_id])) {
659 if (!regs) {
660 perf_fetch_caller_regs(&hot_regs);
661 regs = &hot_regs;
662 }
663 __perf_sw_event(event_id, nr, regs, addr);
664 }
665}
666
667extern struct static_key_deferred perf_sched_events;
668
669static inline void perf_event_task_sched_in(struct task_struct *prev,
670 struct task_struct *task)
671{
672 if (static_key_false(&perf_sched_events.key))
673 __perf_event_task_sched_in(prev, task);
674}
675
676static inline void perf_event_task_sched_out(struct task_struct *prev,
677 struct task_struct *next)
678{
679 perf_sw_event(PERF_COUNT_SW_CONTEXT_SWITCHES, 1, NULL, 0);
680
681 if (static_key_false(&perf_sched_events.key))
682 __perf_event_task_sched_out(prev, next);
683}
684
685extern void perf_event_mmap(struct vm_area_struct *vma);
686extern struct perf_guest_info_callbacks *perf_guest_cbs;
687extern int perf_register_guest_info_callbacks(struct perf_guest_info_callbacks *callbacks);
688extern int perf_unregister_guest_info_callbacks(struct perf_guest_info_callbacks *callbacks);
689
690extern void perf_event_comm(struct task_struct *tsk);
691extern void perf_event_fork(struct task_struct *tsk);
692
693
694DECLARE_PER_CPU(struct perf_callchain_entry, perf_callchain_entry);
695
696extern void perf_callchain_user(struct perf_callchain_entry *entry, struct pt_regs *regs);
697extern void perf_callchain_kernel(struct perf_callchain_entry *entry, struct pt_regs *regs);
698
699static inline void perf_callchain_store(struct perf_callchain_entry *entry, u64 ip)
700{
701 if (entry->nr < PERF_MAX_STACK_DEPTH)
702 entry->ip[entry->nr++] = ip;
703}
704
705extern int sysctl_perf_event_paranoid;
706extern int sysctl_perf_event_mlock;
707extern int sysctl_perf_event_sample_rate;
708extern int sysctl_perf_cpu_time_max_percent;
709
710extern void perf_sample_event_took(u64 sample_len_ns);
711
712extern int perf_proc_update_handler(struct ctl_table *table, int write,
713 void __user *buffer, size_t *lenp,
714 loff_t *ppos);
715extern int perf_cpu_time_max_percent_handler(struct ctl_table *table, int write,
716 void __user *buffer, size_t *lenp,
717 loff_t *ppos);
718
719
720static inline bool perf_paranoid_tracepoint_raw(void)
721{
722 return sysctl_perf_event_paranoid > -1;
723}
724
725static inline bool perf_paranoid_cpu(void)
726{
727 return sysctl_perf_event_paranoid > 0;
728}
729
730static inline bool perf_paranoid_kernel(void)
731{
732 return sysctl_perf_event_paranoid > 1;
733}
734
735extern void perf_event_init(void);
736extern void perf_tp_event(u64 addr, u64 count, void *record,
737 int entry_size, struct pt_regs *regs,
738 struct hlist_head *head, int rctx,
739 struct task_struct *task);
740extern void perf_bp_event(struct perf_event *event, void *data);
741
742#ifndef perf_misc_flags
743# define perf_misc_flags(regs) \
744 (user_mode(regs) ? PERF_RECORD_MISC_USER : PERF_RECORD_MISC_KERNEL)
745# define perf_instruction_pointer(regs) instruction_pointer(regs)
746#endif
747
748static inline bool has_branch_stack(struct perf_event *event)
749{
750 return event->attr.sample_type & PERF_SAMPLE_BRANCH_STACK;
751}
752
753extern int perf_output_begin(struct perf_output_handle *handle,
754 struct perf_event *event, unsigned int size);
755extern void perf_output_end(struct perf_output_handle *handle);
756extern unsigned int perf_output_copy(struct perf_output_handle *handle,
757 const void *buf, unsigned int len);
758extern unsigned int perf_output_skip(struct perf_output_handle *handle,
759 unsigned int len);
760extern int perf_swevent_get_recursion_context(void);
761extern void perf_swevent_put_recursion_context(int rctx);
762extern u64 perf_swevent_set_period(struct perf_event *event);
763extern void perf_event_enable(struct perf_event *event);
764extern void perf_event_disable(struct perf_event *event);
765extern int __perf_event_disable(void *info);
766extern void perf_event_task_tick(void);
767#else
768static inline void
769perf_event_task_sched_in(struct task_struct *prev,
770 struct task_struct *task) { }
771static inline void
772perf_event_task_sched_out(struct task_struct *prev,
773 struct task_struct *next) { }
774static inline int perf_event_init_task(struct task_struct *child) { return 0; }
775static inline void perf_event_exit_task(struct task_struct *child) { }
776static inline void perf_event_free_task(struct task_struct *task) { }
777static inline void perf_event_delayed_put(struct task_struct *task) { }
778static inline void perf_event_print_debug(void) { }
779static inline int perf_event_task_disable(void) { return -EINVAL; }
780static inline int perf_event_task_enable(void) { return -EINVAL; }
781static inline int perf_event_refresh(struct perf_event *event, int refresh)
782{
783 return -EINVAL;
784}
785
786static inline void
787perf_sw_event(u32 event_id, u64 nr, struct pt_regs *regs, u64 addr) { }
788static inline void
789perf_bp_event(struct perf_event *event, void *data) { }
790
791static inline int perf_register_guest_info_callbacks
792(struct perf_guest_info_callbacks *callbacks) { return 0; }
793static inline int perf_unregister_guest_info_callbacks
794(struct perf_guest_info_callbacks *callbacks) { return 0; }
795
796static inline void perf_event_mmap(struct vm_area_struct *vma) { }
797static inline void perf_event_comm(struct task_struct *tsk) { }
798static inline void perf_event_fork(struct task_struct *tsk) { }
799static inline void perf_event_init(void) { }
800static inline int perf_swevent_get_recursion_context(void) { return -1; }
801static inline void perf_swevent_put_recursion_context(int rctx) { }
802static inline u64 perf_swevent_set_period(struct perf_event *event) { return 0; }
803static inline void perf_event_enable(struct perf_event *event) { }
804static inline void perf_event_disable(struct perf_event *event) { }
805static inline int __perf_event_disable(void *info) { return -1; }
806static inline void perf_event_task_tick(void) { }
807#endif
808
809#if defined(CONFIG_PERF_EVENTS) && defined(CONFIG_NO_HZ_FULL)
810extern bool perf_event_can_stop_tick(void);
811#else
812static inline bool perf_event_can_stop_tick(void) { return true; }
813#endif
814
815#if defined(CONFIG_PERF_EVENTS) && defined(CONFIG_CPU_SUP_INTEL)
816extern void perf_restore_debug_store(void);
817#else
818static inline void perf_restore_debug_store(void) { }
819#endif
820
821#define perf_output_put(handle, x) perf_output_copy((handle), &(x), sizeof(x))
822
823
824
825
826#define perf_cpu_notifier(fn) \
827do { \
828 static struct notifier_block fn##_nb = \
829 { .notifier_call = fn, .priority = CPU_PRI_PERF }; \
830 unsigned long cpu = smp_processor_id(); \
831 unsigned long flags; \
832 fn(&fn##_nb, (unsigned long)CPU_UP_PREPARE, \
833 (void *)(unsigned long)cpu); \
834 local_irq_save(flags); \
835 fn(&fn##_nb, (unsigned long)CPU_STARTING, \
836 (void *)(unsigned long)cpu); \
837 local_irq_restore(flags); \
838 fn(&fn##_nb, (unsigned long)CPU_ONLINE, \
839 (void *)(unsigned long)cpu); \
840 register_cpu_notifier(&fn##_nb); \
841} while (0)
842
843
844struct perf_pmu_events_attr {
845 struct device_attribute attr;
846 u64 id;
847 const char *event_str;
848};
849
850#define PMU_EVENT_ATTR(_name, _var, _id, _show) \
851static struct perf_pmu_events_attr _var = { \
852 .attr = __ATTR(_name, 0444, _show, NULL), \
853 .id = _id, \
854};
855
856#define PMU_FORMAT_ATTR(_name, _format) \
857static ssize_t \
858_name##_show(struct device *dev, \
859 struct device_attribute *attr, \
860 char *page) \
861{ \
862 BUILD_BUG_ON(sizeof(_format) >= PAGE_SIZE); \
863 return sprintf(page, _format "\n"); \
864} \
865 \
866static struct device_attribute format_attr_##_name = __ATTR_RO(_name)
867
868#endif
869