4 * Copyright (C) 2008-2009, Thomas Gleixner <tglx@linutronix.de>
5 * Copyright (C) 2008-2011, Red Hat, Inc., Ingo Molnar
6 * Copyright (C) 2008-2011, Red Hat, Inc., Peter Zijlstra
8 * Data type definitions, declarations, prototypes.
10 * Started by: Thomas Gleixner and Ingo Molnar
12 * For licencing details see kernel-base/COPYING
14 #ifndef _LINUX_PERF_EVENT_H
15 #define _LINUX_PERF_EVENT_H
17 #include <uapi/linux/perf_event.h>
20 * Kernel-internal data types and definitions:
23 #ifdef CONFIG_PERF_EVENTS
24 # include <asm/perf_event.h>
25 # include <asm/local64.h>
28 struct perf_guest_info_callbacks {
29 int (*is_in_guest)(void);
30 int (*is_user_mode)(void);
31 unsigned long (*get_guest_ip)(void);
34 #ifdef CONFIG_HAVE_HW_BREAKPOINT
35 #include <asm/hw_breakpoint.h>
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>
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 <linux/workqueue.h>
56 #include <linux/cgroup.h>
57 #include <asm/local.h>
59 struct perf_callchain_entry {
61 __u64 ip[0]; /* /proc/sys/kernel/perf_event_max_stack */
64 struct perf_callchain_entry_ctx {
65 struct perf_callchain_entry *entry;
72 typedef unsigned long (*perf_copy_f)(void *dst, const void *src,
73 unsigned long off, unsigned long len);
75 struct perf_raw_frag {
77 struct perf_raw_frag *next;
85 struct perf_raw_record {
86 struct perf_raw_frag frag;
91 * branch stack layout:
92 * nr: number of taken branches stored in entries[]
94 * Note that nr can vary from sample to sample
95 * branches (to, from) are stored from most recent
96 * to least recent, i.e., entries[0] contains the most
99 struct perf_branch_stack {
101 struct perf_branch_entry entries[0];
107 * extra PMU register associated with an event
109 struct hw_perf_event_extra {
110 u64 config; /* register value */
111 unsigned int reg; /* register address or index */
112 int alloc; /* extra register already allocated */
113 int idx; /* index in shared_regs->regs[] */
117 * struct hw_perf_event - performance event hardware details:
119 struct hw_perf_event {
120 #ifdef CONFIG_PERF_EVENTS
122 struct { /* hardware */
125 unsigned long config_base;
126 unsigned long event_base;
127 int event_base_rdpmc;
132 struct hw_perf_event_extra extra_reg;
133 struct hw_perf_event_extra branch_reg;
135 struct { /* software */
136 struct hrtimer hrtimer;
138 struct { /* tracepoint */
139 /* for tp_event->class */
140 struct list_head tp_list;
142 struct { /* intel_cqm */
146 struct list_head cqm_events_entry;
147 struct list_head cqm_groups_entry;
148 struct list_head cqm_group_entry;
150 struct { /* itrace */
153 struct { /* amd_power */
157 #ifdef CONFIG_HAVE_HW_BREAKPOINT
158 struct { /* breakpoint */
160 * Crufty hack to avoid the chicken and egg
161 * problem hw_breakpoint has with context
162 * creation and event initalization.
164 struct arch_hw_breakpoint info;
165 struct list_head bp_list;
170 * If the event is a per task event, this will point to the task in
171 * question. See the comment in perf_event_alloc().
173 struct task_struct *target;
176 * PMU would store hardware filter configuration
181 /* Last sync'ed generation of filters */
182 unsigned long addr_filters_gen;
185 * hw_perf_event::state flags; used to track the PERF_EF_* state.
187 #define PERF_HES_STOPPED 0x01 /* the counter is stopped */
188 #define PERF_HES_UPTODATE 0x02 /* event->count up-to-date */
189 #define PERF_HES_ARCH 0x04
194 * The last observed hardware counter value, updated with a
195 * local64_cmpxchg() such that pmu::read() can be called nested.
197 local64_t prev_count;
200 * The period to start the next sample with.
205 * The period we started this sample with.
210 * However much is left of the current period; note that this is
211 * a full 64bit value and allows for generation of periods longer
212 * than hardware might allow.
214 local64_t period_left;
217 * State for throttling the event, see __perf_event_overflow() and
218 * perf_adjust_freq_unthr_context().
224 * State for freq target events, see __perf_event_overflow() and
225 * perf_adjust_freq_unthr_context().
228 u64 freq_count_stamp;
235 * Common implementation detail of pmu::{start,commit,cancel}_txn
237 #define PERF_PMU_TXN_ADD 0x1 /* txn to add/schedule event on PMU */
238 #define PERF_PMU_TXN_READ 0x2 /* txn to read event group from PMU */
241 * pmu::capabilities flags
243 #define PERF_PMU_CAP_NO_INTERRUPT 0x01
244 #define PERF_PMU_CAP_NO_NMI 0x02
245 #define PERF_PMU_CAP_AUX_NO_SG 0x04
246 #define PERF_PMU_CAP_AUX_SW_DOUBLEBUF 0x08
247 #define PERF_PMU_CAP_EXCLUSIVE 0x10
248 #define PERF_PMU_CAP_ITRACE 0x20
249 #define PERF_PMU_CAP_HETEROGENEOUS_CPUS 0x40
252 * struct pmu - generic performance monitoring unit
255 struct list_head entry;
257 struct module *module;
259 const struct attribute_group **attr_groups;
264 * various common per-pmu feature flags
268 int * __percpu pmu_disable_count;
269 struct perf_cpu_context * __percpu pmu_cpu_context;
270 atomic_t exclusive_cnt; /* < 0: cpu; > 0: tsk */
272 int hrtimer_interval_ms;
274 /* number of address filters this PMU can do */
275 unsigned int nr_addr_filters;
278 * Fully disable/enable this PMU, can be used to protect from the PMI
279 * as well as for lazy/batch writing of the MSRs.
281 void (*pmu_enable) (struct pmu *pmu); /* optional */
282 void (*pmu_disable) (struct pmu *pmu); /* optional */
285 * Try and initialize the event for this PMU.
288 * -ENOENT -- @event is not for this PMU
290 * -ENODEV -- @event is for this PMU but PMU not present
291 * -EBUSY -- @event is for this PMU but PMU temporarily unavailable
292 * -EINVAL -- @event is for this PMU but @event is not valid
293 * -EOPNOTSUPP -- @event is for this PMU, @event is valid, but not supported
294 * -EACCESS -- @event is for this PMU, @event is valid, but no privilidges
296 * 0 -- @event is for this PMU and valid
298 * Other error return values are allowed.
300 int (*event_init) (struct perf_event *event);
303 * Notification that the event was mapped or unmapped. Called
304 * in the context of the mapping task.
306 void (*event_mapped) (struct perf_event *event); /*optional*/
307 void (*event_unmapped) (struct perf_event *event); /*optional*/
310 * Flags for ->add()/->del()/ ->start()/->stop(). There are
311 * matching hw_perf_event::state flags.
313 #define PERF_EF_START 0x01 /* start the counter when adding */
314 #define PERF_EF_RELOAD 0x02 /* reload the counter when starting */
315 #define PERF_EF_UPDATE 0x04 /* update the counter when stopping */
318 * Adds/Removes a counter to/from the PMU, can be done inside a
319 * transaction, see the ->*_txn() methods.
321 * The add/del callbacks will reserve all hardware resources required
322 * to service the event, this includes any counter constraint
325 * Called with IRQs disabled and the PMU disabled on the CPU the event
328 * ->add() called without PERF_EF_START should result in the same state
329 * as ->add() followed by ->stop().
331 * ->del() must always PERF_EF_UPDATE stop an event. If it calls
332 * ->stop() that must deal with already being stopped without
335 int (*add) (struct perf_event *event, int flags);
336 void (*del) (struct perf_event *event, int flags);
339 * Starts/Stops a counter present on the PMU.
341 * The PMI handler should stop the counter when perf_event_overflow()
342 * returns !0. ->start() will be used to continue.
344 * Also used to change the sample period.
346 * Called with IRQs disabled and the PMU disabled on the CPU the event
347 * is on -- will be called from NMI context with the PMU generates
350 * ->stop() with PERF_EF_UPDATE will read the counter and update
351 * period/count values like ->read() would.
353 * ->start() with PERF_EF_RELOAD will reprogram the the counter
354 * value, must be preceded by a ->stop() with PERF_EF_UPDATE.
356 void (*start) (struct perf_event *event, int flags);
357 void (*stop) (struct perf_event *event, int flags);
360 * Updates the counter value of the event.
362 * For sampling capable PMUs this will also update the software period
363 * hw_perf_event::period_left field.
365 void (*read) (struct perf_event *event);
368 * Group events scheduling is treated as a transaction, add
369 * group events as a whole and perform one schedulability test.
370 * If the test fails, roll back the whole group
372 * Start the transaction, after this ->add() doesn't need to
373 * do schedulability tests.
377 void (*start_txn) (struct pmu *pmu, unsigned int txn_flags);
379 * If ->start_txn() disabled the ->add() schedulability test
380 * then ->commit_txn() is required to perform one. On success
381 * the transaction is closed. On error the transaction is kept
382 * open until ->cancel_txn() is called.
386 int (*commit_txn) (struct pmu *pmu);
388 * Will cancel the transaction, assumes ->del() is called
389 * for each successful ->add() during the transaction.
393 void (*cancel_txn) (struct pmu *pmu);
396 * Will return the value for perf_event_mmap_page::index for this event,
397 * if no implementation is provided it will default to: event->hw.idx + 1.
399 int (*event_idx) (struct perf_event *event); /*optional */
402 * context-switches callback
404 void (*sched_task) (struct perf_event_context *ctx,
407 * PMU specific data size
409 size_t task_ctx_size;
413 * Return the count value for a counter.
415 u64 (*count) (struct perf_event *event); /*optional*/
418 * Set up pmu-private data structures for an AUX area
420 void *(*setup_aux) (int cpu, void **pages,
421 int nr_pages, bool overwrite);
425 * Free pmu-private AUX data structures
427 void (*free_aux) (void *aux); /* optional */
430 * Validate address range filters: make sure the HW supports the
431 * requested configuration and number of filters; return 0 if the
432 * supplied filters are valid, -errno otherwise.
434 * Runs in the context of the ioctl()ing process and is not serialized
435 * with the rest of the PMU callbacks.
437 int (*addr_filters_validate) (struct list_head *filters);
441 * Synchronize address range filter configuration:
442 * translate hw-agnostic filters into hardware configuration in
443 * event::hw::addr_filters.
445 * Runs as a part of filter sync sequence that is done in ->start()
446 * callback by calling perf_event_addr_filters_sync().
448 * May (and should) traverse event::addr_filters::list, for which its
449 * caller provides necessary serialization.
451 void (*addr_filters_sync) (struct perf_event *event);
455 * Filter events for PMU-specific reasons.
457 int (*filter_match) (struct perf_event *event); /* optional */
460 * Check period value for PERF_EVENT_IOC_PERIOD ioctl.
462 int (*check_period) (struct perf_event *event, u64 value); /* optional */
466 * struct perf_addr_filter - address range filter definition
467 * @entry: event's filter list linkage
468 * @inode: object file's inode for file-based filters
469 * @offset: filter range offset
470 * @size: filter range size
471 * @range: 1: range, 0: address
472 * @filter: 1: filter/start, 0: stop
474 * This is a hardware-agnostic filter configuration as specified by the user.
476 struct perf_addr_filter {
477 struct list_head entry;
479 unsigned long offset;
481 unsigned int range : 1,
486 * struct perf_addr_filters_head - container for address range filters
487 * @list: list of filters for this event
488 * @lock: spinlock that serializes accesses to the @list and event's
489 * (and its children's) filter generations.
491 * A child event will use parent's @list (and therefore @lock), so they are
492 * bundled together; see perf_event_addr_filters().
494 struct perf_addr_filters_head {
495 struct list_head list;
500 * enum perf_event_active_state - the states of a event
502 enum perf_event_active_state {
503 PERF_EVENT_STATE_DEAD = -4,
504 PERF_EVENT_STATE_EXIT = -3,
505 PERF_EVENT_STATE_ERROR = -2,
506 PERF_EVENT_STATE_OFF = -1,
507 PERF_EVENT_STATE_INACTIVE = 0,
508 PERF_EVENT_STATE_ACTIVE = 1,
512 struct perf_sample_data;
514 typedef void (*perf_overflow_handler_t)(struct perf_event *,
515 struct perf_sample_data *,
516 struct pt_regs *regs);
519 * Event capabilities. For event_caps and groups caps.
521 * PERF_EV_CAP_SOFTWARE: Is a software event.
522 * PERF_EV_CAP_READ_ACTIVE_PKG: A CPU event (or cgroup event) that can be read
523 * from any CPU in the package where it is active.
525 #define PERF_EV_CAP_SOFTWARE BIT(0)
526 #define PERF_EV_CAP_READ_ACTIVE_PKG BIT(1)
528 #define SWEVENT_HLIST_BITS 8
529 #define SWEVENT_HLIST_SIZE (1 << SWEVENT_HLIST_BITS)
531 struct swevent_hlist {
532 struct hlist_head heads[SWEVENT_HLIST_SIZE];
533 struct rcu_head rcu_head;
536 #define PERF_ATTACH_CONTEXT 0x01
537 #define PERF_ATTACH_GROUP 0x02
538 #define PERF_ATTACH_TASK 0x04
539 #define PERF_ATTACH_TASK_DATA 0x08
544 struct pmu_event_list {
546 struct list_head list;
550 * struct perf_event - performance event kernel representation:
553 #ifdef CONFIG_PERF_EVENTS
555 * entry onto perf_event_context::event_list;
556 * modifications require ctx->lock
557 * RCU safe iterations.
559 struct list_head event_entry;
562 * XXX: group_entry and sibling_list should be mutually exclusive;
563 * either you're a sibling on a group, or you're the group leader.
564 * Rework the code to always use the same list element.
566 * Locked for modification by both ctx->mutex and ctx->lock; holding
567 * either sufficies for read.
569 struct list_head group_entry;
570 struct list_head sibling_list;
573 * We need storage to track the entries in perf_pmu_migrate_context; we
574 * cannot use the event_entry because of RCU and we want to keep the
575 * group in tact which avoids us using the other two entries.
577 struct list_head migrate_entry;
579 struct hlist_node hlist_entry;
580 struct list_head active_entry;
583 /* Not serialized. Only written during event initialization. */
585 /* The cumulative AND of all event_caps for events in this group. */
588 struct perf_event *group_leader;
592 enum perf_event_active_state state;
593 unsigned int attach_state;
595 atomic64_t child_count;
598 * These are the total time in nanoseconds that the event
599 * has been enabled (i.e. eligible to run, and the task has
600 * been scheduled in, if this is a per-task event)
601 * and running (scheduled onto the CPU), respectively.
603 * They are computed from tstamp_enabled, tstamp_running and
604 * tstamp_stopped when the event is in INACTIVE or ACTIVE state.
606 u64 total_time_enabled;
607 u64 total_time_running;
610 * These are timestamps used for computing total_time_enabled
611 * and total_time_running when the event is in INACTIVE or
612 * ACTIVE state, measured in nanoseconds from an arbitrary point
614 * tstamp_enabled: the notional time when the event was enabled
615 * tstamp_running: the notional time when the event was scheduled on
616 * tstamp_stopped: in INACTIVE state, the notional time when the
617 * event was scheduled off.
624 * timestamp shadows the actual context timing but it can
625 * be safely used in NMI interrupt context. It reflects the
626 * context time as it was when the event was last scheduled in.
628 * ctx_time already accounts for ctx->timestamp. Therefore to
629 * compute ctx_time for a sample, simply add perf_clock().
633 struct perf_event_attr attr;
637 struct hw_perf_event hw;
639 struct perf_event_context *ctx;
640 atomic_long_t refcount;
643 * These accumulate total time (in nanoseconds) that children
644 * events have been enabled and running, respectively.
646 atomic64_t child_total_time_enabled;
647 atomic64_t child_total_time_running;
650 * Protect attach/detach and child_list:
652 struct mutex child_mutex;
653 struct list_head child_list;
654 struct perf_event *parent;
659 struct list_head owner_entry;
660 struct task_struct *owner;
663 struct mutex mmap_mutex;
666 struct ring_buffer *rb;
667 struct list_head rb_entry;
668 unsigned long rcu_batches;
672 wait_queue_head_t waitq;
673 struct fasync_struct *fasync;
675 /* delayed work for NMIs and such */
679 struct irq_work pending;
681 atomic_t event_limit;
683 /* address range filters */
684 struct perf_addr_filters_head addr_filters;
685 /* vma address array for file-based filders */
686 unsigned long *addr_filters_offs;
687 unsigned long addr_filters_gen;
689 void (*destroy)(struct perf_event *);
690 struct rcu_head rcu_head;
692 struct pid_namespace *ns;
696 perf_overflow_handler_t overflow_handler;
697 void *overflow_handler_context;
698 #ifdef CONFIG_BPF_SYSCALL
699 perf_overflow_handler_t orig_overflow_handler;
700 struct bpf_prog *prog;
703 #ifdef CONFIG_EVENT_TRACING
704 struct trace_event_call *tp_event;
705 struct event_filter *filter;
706 #ifdef CONFIG_FUNCTION_TRACER
707 struct ftrace_ops ftrace_ops;
711 #ifdef CONFIG_CGROUP_PERF
712 struct perf_cgroup *cgrp; /* cgroup event is attach to */
713 int cgrp_defer_enabled;
716 struct list_head sb_list;
717 #endif /* CONFIG_PERF_EVENTS */
721 * struct perf_event_context - event context structure
723 * Used as a container for task events and CPU events as well:
725 struct perf_event_context {
728 * Protect the states of the events in the list,
729 * nr_active, and the list:
733 * Protect the list of events. Locking either mutex or lock
734 * is sufficient to ensure the list doesn't change; to change
735 * the list you need to lock both the mutex and the spinlock.
739 struct list_head active_ctx_list;
740 struct list_head pinned_groups;
741 struct list_head flexible_groups;
742 struct list_head event_list;
750 struct task_struct *task;
753 * Context clock, runs when context enabled.
759 * These fields let us detect when two contexts have both
760 * been cloned (inherited) from a common ancestor.
762 struct perf_event_context *parent_ctx;
766 #ifdef CONFIG_CGROUP_PERF
767 int nr_cgroups; /* cgroup evts */
769 void *task_ctx_data; /* pmu specific data */
770 struct rcu_head rcu_head;
774 * Number of contexts where an event can trigger:
775 * task, softirq, hardirq, nmi.
777 #define PERF_NR_CONTEXTS 4
780 * struct perf_event_cpu_context - per cpu event context structure
782 struct perf_cpu_context {
783 struct perf_event_context ctx;
784 struct perf_event_context *task_ctx;
788 raw_spinlock_t hrtimer_lock;
789 struct hrtimer hrtimer;
790 ktime_t hrtimer_interval;
791 unsigned int hrtimer_active;
793 struct pmu *unique_pmu;
794 #ifdef CONFIG_CGROUP_PERF
795 struct perf_cgroup *cgrp;
798 struct list_head sched_cb_entry;
802 struct perf_output_handle {
803 struct perf_event *event;
804 struct ring_buffer *rb;
805 unsigned long wakeup;
814 struct bpf_perf_event_data_kern {
815 struct pt_regs *regs;
816 struct perf_sample_data *data;
819 #ifdef CONFIG_CGROUP_PERF
822 * perf_cgroup_info keeps track of time_enabled for a cgroup.
823 * This is a per-cpu dynamically allocated data structure.
825 struct perf_cgroup_info {
831 struct cgroup_subsys_state css;
832 struct perf_cgroup_info __percpu *info;
836 * Must ensure cgroup is pinned (css_get) before calling
837 * this function. In other words, we cannot call this function
838 * if there is no cgroup event for the current CPU context.
840 static inline struct perf_cgroup *
841 perf_cgroup_from_task(struct task_struct *task, struct perf_event_context *ctx)
843 return container_of(task_css_check(task, perf_event_cgrp_id,
844 ctx ? lockdep_is_held(&ctx->lock)
846 struct perf_cgroup, css);
848 #endif /* CONFIG_CGROUP_PERF */
850 #ifdef CONFIG_PERF_EVENTS
852 extern void *perf_aux_output_begin(struct perf_output_handle *handle,
853 struct perf_event *event);
854 extern void perf_aux_output_end(struct perf_output_handle *handle,
855 unsigned long size, bool truncated);
856 extern int perf_aux_output_skip(struct perf_output_handle *handle,
858 extern void *perf_get_aux(struct perf_output_handle *handle);
860 extern int perf_pmu_register(struct pmu *pmu, const char *name, int type);
861 extern void perf_pmu_unregister(struct pmu *pmu);
863 extern int perf_num_counters(void);
864 extern const char *perf_pmu_name(void);
865 extern void __perf_event_task_sched_in(struct task_struct *prev,
866 struct task_struct *task);
867 extern void __perf_event_task_sched_out(struct task_struct *prev,
868 struct task_struct *next);
869 extern int perf_event_init_task(struct task_struct *child);
870 extern void perf_event_exit_task(struct task_struct *child);
871 extern void perf_event_free_task(struct task_struct *task);
872 extern void perf_event_delayed_put(struct task_struct *task);
873 extern struct file *perf_event_get(unsigned int fd);
874 extern const struct perf_event_attr *perf_event_attrs(struct perf_event *event);
875 extern void perf_event_print_debug(void);
876 extern void perf_pmu_disable(struct pmu *pmu);
877 extern void perf_pmu_enable(struct pmu *pmu);
878 extern void perf_sched_cb_dec(struct pmu *pmu);
879 extern void perf_sched_cb_inc(struct pmu *pmu);
880 extern int perf_event_task_disable(void);
881 extern int perf_event_task_enable(void);
882 extern int perf_event_refresh(struct perf_event *event, int refresh);
883 extern void perf_event_update_userpage(struct perf_event *event);
884 extern int perf_event_release_kernel(struct perf_event *event);
885 extern struct perf_event *
886 perf_event_create_kernel_counter(struct perf_event_attr *attr,
888 struct task_struct *task,
889 perf_overflow_handler_t callback,
891 extern void perf_pmu_migrate_context(struct pmu *pmu,
892 int src_cpu, int dst_cpu);
893 extern u64 perf_event_read_local(struct perf_event *event);
894 extern u64 perf_event_read_value(struct perf_event *event,
895 u64 *enabled, u64 *running);
898 struct perf_sample_data {
900 * Fields set by perf_sample_data_init(), group so as to
901 * minimize the cachelines touched.
904 struct perf_raw_record *raw;
905 struct perf_branch_stack *br_stack;
909 union perf_mem_data_src data_src;
912 * The other fields, optionally {set,used} by
913 * perf_{prepare,output}_sample().
928 struct perf_callchain_entry *callchain;
931 * regs_user may point to task_pt_regs or to regs_user_copy, depending
934 struct perf_regs regs_user;
935 struct pt_regs regs_user_copy;
937 struct perf_regs regs_intr;
939 } ____cacheline_aligned;
941 /* default value for data source */
942 #define PERF_MEM_NA (PERF_MEM_S(OP, NA) |\
943 PERF_MEM_S(LVL, NA) |\
944 PERF_MEM_S(SNOOP, NA) |\
945 PERF_MEM_S(LOCK, NA) |\
948 static inline void perf_sample_data_init(struct perf_sample_data *data,
949 u64 addr, u64 period)
951 /* remaining struct members initialized in perf_prepare_sample() */
954 data->br_stack = NULL;
955 data->period = period;
957 data->data_src.val = PERF_MEM_NA;
961 extern void perf_output_sample(struct perf_output_handle *handle,
962 struct perf_event_header *header,
963 struct perf_sample_data *data,
964 struct perf_event *event);
965 extern void perf_prepare_sample(struct perf_event_header *header,
966 struct perf_sample_data *data,
967 struct perf_event *event,
968 struct pt_regs *regs);
970 extern int perf_event_overflow(struct perf_event *event,
971 struct perf_sample_data *data,
972 struct pt_regs *regs);
974 extern void perf_event_output_forward(struct perf_event *event,
975 struct perf_sample_data *data,
976 struct pt_regs *regs);
977 extern void perf_event_output_backward(struct perf_event *event,
978 struct perf_sample_data *data,
979 struct pt_regs *regs);
980 extern void perf_event_output(struct perf_event *event,
981 struct perf_sample_data *data,
982 struct pt_regs *regs);
985 is_default_overflow_handler(struct perf_event *event)
987 if (likely(event->overflow_handler == perf_event_output_forward))
989 if (unlikely(event->overflow_handler == perf_event_output_backward))
995 perf_event_header__init_id(struct perf_event_header *header,
996 struct perf_sample_data *data,
997 struct perf_event *event);
999 perf_event__output_id_sample(struct perf_event *event,
1000 struct perf_output_handle *handle,
1001 struct perf_sample_data *sample);
1004 perf_log_lost_samples(struct perf_event *event, u64 lost);
1006 static inline bool is_sampling_event(struct perf_event *event)
1008 return event->attr.sample_period != 0;
1012 * Return 1 for a software event, 0 for a hardware event
1014 static inline int is_software_event(struct perf_event *event)
1016 return event->event_caps & PERF_EV_CAP_SOFTWARE;
1019 extern struct static_key perf_swevent_enabled[PERF_COUNT_SW_MAX];
1021 extern void ___perf_sw_event(u32, u64, struct pt_regs *, u64);
1022 extern void __perf_sw_event(u32, u64, struct pt_regs *, u64);
1024 #ifndef perf_arch_fetch_caller_regs
1025 static inline void perf_arch_fetch_caller_regs(struct pt_regs *regs, unsigned long ip) { }
1029 * Take a snapshot of the regs. Skip ip and frame pointer to
1030 * the nth caller. We only need a few of the regs:
1031 * - ip for PERF_SAMPLE_IP
1032 * - cs for user_mode() tests
1033 * - bp for callchains
1034 * - eflags, for future purposes, just in case
1036 static inline void perf_fetch_caller_regs(struct pt_regs *regs)
1038 perf_arch_fetch_caller_regs(regs, CALLER_ADDR0);
1041 static __always_inline void
1042 perf_sw_event(u32 event_id, u64 nr, struct pt_regs *regs, u64 addr)
1044 if (static_key_false(&perf_swevent_enabled[event_id]))
1045 __perf_sw_event(event_id, nr, regs, addr);
1048 DECLARE_PER_CPU(struct pt_regs, __perf_regs[4]);
1051 * 'Special' version for the scheduler, it hard assumes no recursion,
1052 * which is guaranteed by us not actually scheduling inside other swevents
1053 * because those disable preemption.
1055 static __always_inline void
1056 perf_sw_event_sched(u32 event_id, u64 nr, u64 addr)
1058 if (static_key_false(&perf_swevent_enabled[event_id])) {
1059 struct pt_regs *regs = this_cpu_ptr(&__perf_regs[0]);
1061 perf_fetch_caller_regs(regs);
1062 ___perf_sw_event(event_id, nr, regs, addr);
1066 extern struct static_key_false perf_sched_events;
1068 static __always_inline bool
1069 perf_sw_migrate_enabled(void)
1071 if (static_key_false(&perf_swevent_enabled[PERF_COUNT_SW_CPU_MIGRATIONS]))
1076 static inline void perf_event_task_migrate(struct task_struct *task)
1078 if (perf_sw_migrate_enabled())
1079 task->sched_migrated = 1;
1082 static inline void perf_event_task_sched_in(struct task_struct *prev,
1083 struct task_struct *task)
1085 if (static_branch_unlikely(&perf_sched_events))
1086 __perf_event_task_sched_in(prev, task);
1088 if (perf_sw_migrate_enabled() && task->sched_migrated) {
1089 struct pt_regs *regs = this_cpu_ptr(&__perf_regs[0]);
1091 perf_fetch_caller_regs(regs);
1092 ___perf_sw_event(PERF_COUNT_SW_CPU_MIGRATIONS, 1, regs, 0);
1093 task->sched_migrated = 0;
1097 static inline void perf_event_task_sched_out(struct task_struct *prev,
1098 struct task_struct *next)
1100 perf_sw_event_sched(PERF_COUNT_SW_CONTEXT_SWITCHES, 1, 0);
1102 if (static_branch_unlikely(&perf_sched_events))
1103 __perf_event_task_sched_out(prev, next);
1106 static inline u64 __perf_event_count(struct perf_event *event)
1108 return local64_read(&event->count) + atomic64_read(&event->child_count);
1111 extern void perf_event_mmap(struct vm_area_struct *vma);
1112 extern struct perf_guest_info_callbacks *perf_guest_cbs;
1113 extern int perf_register_guest_info_callbacks(struct perf_guest_info_callbacks *callbacks);
1114 extern int perf_unregister_guest_info_callbacks(struct perf_guest_info_callbacks *callbacks);
1116 extern void perf_event_exec(void);
1117 extern void perf_event_comm(struct task_struct *tsk, bool exec);
1118 extern void perf_event_fork(struct task_struct *tsk);
1121 DECLARE_PER_CPU(struct perf_callchain_entry, perf_callchain_entry);
1123 extern void perf_callchain_user(struct perf_callchain_entry_ctx *entry, struct pt_regs *regs);
1124 extern void perf_callchain_kernel(struct perf_callchain_entry_ctx *entry, struct pt_regs *regs);
1125 extern struct perf_callchain_entry *
1126 get_perf_callchain(struct pt_regs *regs, u32 init_nr, bool kernel, bool user,
1127 u32 max_stack, bool crosstask, bool add_mark);
1128 extern int get_callchain_buffers(int max_stack);
1129 extern void put_callchain_buffers(void);
1131 extern int sysctl_perf_event_max_stack;
1132 extern int sysctl_perf_event_max_contexts_per_stack;
1134 static inline int perf_callchain_store_context(struct perf_callchain_entry_ctx *ctx, u64 ip)
1136 if (ctx->contexts < sysctl_perf_event_max_contexts_per_stack) {
1137 struct perf_callchain_entry *entry = ctx->entry;
1138 entry->ip[entry->nr++] = ip;
1142 ctx->contexts_maxed = true;
1143 return -1; /* no more room, stop walking the stack */
1147 static inline int perf_callchain_store(struct perf_callchain_entry_ctx *ctx, u64 ip)
1149 if (ctx->nr < ctx->max_stack && !ctx->contexts_maxed) {
1150 struct perf_callchain_entry *entry = ctx->entry;
1151 entry->ip[entry->nr++] = ip;
1155 return -1; /* no more room, stop walking the stack */
1159 extern int sysctl_perf_event_paranoid;
1160 extern int sysctl_perf_event_mlock;
1161 extern int sysctl_perf_event_sample_rate;
1162 extern int sysctl_perf_cpu_time_max_percent;
1164 extern void perf_sample_event_took(u64 sample_len_ns);
1166 extern int perf_proc_update_handler(struct ctl_table *table, int write,
1167 void __user *buffer, size_t *lenp,
1169 extern int perf_cpu_time_max_percent_handler(struct ctl_table *table, int write,
1170 void __user *buffer, size_t *lenp,
1173 int perf_event_max_stack_handler(struct ctl_table *table, int write,
1174 void __user *buffer, size_t *lenp, loff_t *ppos);
1176 static inline bool perf_paranoid_tracepoint_raw(void)
1178 return sysctl_perf_event_paranoid > -1;
1181 static inline bool perf_paranoid_cpu(void)
1183 return sysctl_perf_event_paranoid > 0;
1186 static inline bool perf_paranoid_kernel(void)
1188 return sysctl_perf_event_paranoid > 1;
1191 extern void perf_event_init(void);
1192 extern void perf_tp_event(u16 event_type, u64 count, void *record,
1193 int entry_size, struct pt_regs *regs,
1194 struct hlist_head *head, int rctx,
1195 struct task_struct *task);
1196 extern void perf_bp_event(struct perf_event *event, void *data);
1198 #ifndef perf_misc_flags
1199 # define perf_misc_flags(regs) \
1200 (user_mode(regs) ? PERF_RECORD_MISC_USER : PERF_RECORD_MISC_KERNEL)
1201 # define perf_instruction_pointer(regs) instruction_pointer(regs)
1204 static inline bool has_branch_stack(struct perf_event *event)
1206 return event->attr.sample_type & PERF_SAMPLE_BRANCH_STACK;
1209 static inline bool needs_branch_stack(struct perf_event *event)
1211 return event->attr.branch_sample_type != 0;
1214 static inline bool has_aux(struct perf_event *event)
1216 return event->pmu->setup_aux;
1219 static inline bool is_write_backward(struct perf_event *event)
1221 return !!event->attr.write_backward;
1224 static inline bool has_addr_filter(struct perf_event *event)
1226 return event->pmu->nr_addr_filters;
1230 * An inherited event uses parent's filters
1232 static inline struct perf_addr_filters_head *
1233 perf_event_addr_filters(struct perf_event *event)
1235 struct perf_addr_filters_head *ifh = &event->addr_filters;
1238 ifh = &event->parent->addr_filters;
1243 extern void perf_event_addr_filters_sync(struct perf_event *event);
1245 extern int perf_output_begin(struct perf_output_handle *handle,
1246 struct perf_event *event, unsigned int size);
1247 extern int perf_output_begin_forward(struct perf_output_handle *handle,
1248 struct perf_event *event,
1250 extern int perf_output_begin_backward(struct perf_output_handle *handle,
1251 struct perf_event *event,
1254 extern void perf_output_end(struct perf_output_handle *handle);
1255 extern unsigned int perf_output_copy(struct perf_output_handle *handle,
1256 const void *buf, unsigned int len);
1257 extern unsigned int perf_output_skip(struct perf_output_handle *handle,
1259 extern int perf_swevent_get_recursion_context(void);
1260 extern void perf_swevent_put_recursion_context(int rctx);
1261 extern u64 perf_swevent_set_period(struct perf_event *event);
1262 extern void perf_event_enable(struct perf_event *event);
1263 extern void perf_event_disable(struct perf_event *event);
1264 extern void perf_event_disable_local(struct perf_event *event);
1265 extern void perf_event_disable_inatomic(struct perf_event *event);
1266 extern void perf_event_task_tick(void);
1267 extern int perf_event_account_interrupt(struct perf_event *event);
1268 #else /* !CONFIG_PERF_EVENTS: */
1269 static inline void *
1270 perf_aux_output_begin(struct perf_output_handle *handle,
1271 struct perf_event *event) { return NULL; }
1273 perf_aux_output_end(struct perf_output_handle *handle, unsigned long size,
1276 perf_aux_output_skip(struct perf_output_handle *handle,
1277 unsigned long size) { return -EINVAL; }
1278 static inline void *
1279 perf_get_aux(struct perf_output_handle *handle) { return NULL; }
1281 perf_event_task_migrate(struct task_struct *task) { }
1283 perf_event_task_sched_in(struct task_struct *prev,
1284 struct task_struct *task) { }
1286 perf_event_task_sched_out(struct task_struct *prev,
1287 struct task_struct *next) { }
1288 static inline int perf_event_init_task(struct task_struct *child) { return 0; }
1289 static inline void perf_event_exit_task(struct task_struct *child) { }
1290 static inline void perf_event_free_task(struct task_struct *task) { }
1291 static inline void perf_event_delayed_put(struct task_struct *task) { }
1292 static inline struct file *perf_event_get(unsigned int fd) { return ERR_PTR(-EINVAL); }
1293 static inline const struct perf_event_attr *perf_event_attrs(struct perf_event *event)
1295 return ERR_PTR(-EINVAL);
1297 static inline u64 perf_event_read_local(struct perf_event *event) { return -EINVAL; }
1298 static inline void perf_event_print_debug(void) { }
1299 static inline int perf_event_task_disable(void) { return -EINVAL; }
1300 static inline int perf_event_task_enable(void) { return -EINVAL; }
1301 static inline int perf_event_refresh(struct perf_event *event, int refresh)
1307 perf_sw_event(u32 event_id, u64 nr, struct pt_regs *regs, u64 addr) { }
1309 perf_sw_event_sched(u32 event_id, u64 nr, u64 addr) { }
1311 perf_bp_event(struct perf_event *event, void *data) { }
1313 static inline int perf_register_guest_info_callbacks
1314 (struct perf_guest_info_callbacks *callbacks) { return 0; }
1315 static inline int perf_unregister_guest_info_callbacks
1316 (struct perf_guest_info_callbacks *callbacks) { return 0; }
1318 static inline void perf_event_mmap(struct vm_area_struct *vma) { }
1319 static inline void perf_event_exec(void) { }
1320 static inline void perf_event_comm(struct task_struct *tsk, bool exec) { }
1321 static inline void perf_event_fork(struct task_struct *tsk) { }
1322 static inline void perf_event_init(void) { }
1323 static inline int perf_swevent_get_recursion_context(void) { return -1; }
1324 static inline void perf_swevent_put_recursion_context(int rctx) { }
1325 static inline u64 perf_swevent_set_period(struct perf_event *event) { return 0; }
1326 static inline void perf_event_enable(struct perf_event *event) { }
1327 static inline void perf_event_disable(struct perf_event *event) { }
1328 static inline int __perf_event_disable(void *info) { return -1; }
1329 static inline void perf_event_task_tick(void) { }
1330 static inline int perf_event_release_kernel(struct perf_event *event) { return 0; }
1333 #if defined(CONFIG_PERF_EVENTS) && defined(CONFIG_CPU_SUP_INTEL)
1334 extern void perf_restore_debug_store(void);
1336 static inline void perf_restore_debug_store(void) { }
1339 static __always_inline bool perf_raw_frag_last(const struct perf_raw_frag *frag)
1341 return frag->pad < sizeof(u64);
1344 #define perf_output_put(handle, x) perf_output_copy((handle), &(x), sizeof(x))
1346 struct perf_pmu_events_attr {
1347 struct device_attribute attr;
1349 const char *event_str;
1352 struct perf_pmu_events_ht_attr {
1353 struct device_attribute attr;
1355 const char *event_str_ht;
1356 const char *event_str_noht;
1359 ssize_t perf_event_sysfs_show(struct device *dev, struct device_attribute *attr,
1362 #define PMU_EVENT_ATTR(_name, _var, _id, _show) \
1363 static struct perf_pmu_events_attr _var = { \
1364 .attr = __ATTR(_name, 0444, _show, NULL), \
1368 #define PMU_EVENT_ATTR_STRING(_name, _var, _str) \
1369 static struct perf_pmu_events_attr _var = { \
1370 .attr = __ATTR(_name, 0444, perf_event_sysfs_show, NULL), \
1372 .event_str = _str, \
1375 #define PMU_FORMAT_ATTR(_name, _format) \
1377 _name##_show(struct device *dev, \
1378 struct device_attribute *attr, \
1381 BUILD_BUG_ON(sizeof(_format) >= PAGE_SIZE); \
1382 return sprintf(page, _format "\n"); \
1385 static struct device_attribute format_attr_##_name = __ATTR_RO(_name)
1387 /* Performance counter hotplug functions */
1388 #ifdef CONFIG_PERF_EVENTS
1389 int perf_event_init_cpu(unsigned int cpu);
1390 int perf_event_exit_cpu(unsigned int cpu);
1392 #define perf_event_init_cpu NULL
1393 #define perf_event_exit_cpu NULL
1396 #endif /* _LINUX_PERF_EVENT_H */