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 <asm/local.h>
57 struct perf_callchain_entry {
59 __u64 ip[PERF_MAX_STACK_DEPTH];
62 struct perf_raw_record {
68 * branch stack layout:
69 * nr: number of taken branches stored in entries[]
71 * Note that nr can vary from sample to sample
72 * branches (to, from) are stored from most recent
73 * to least recent, i.e., entries[0] contains the most
76 struct perf_branch_stack {
78 struct perf_branch_entry entries[0];
81 struct perf_regs_user {
89 * extra PMU register associated with an event
91 struct hw_perf_event_extra {
92 u64 config; /* register value */
93 unsigned int reg; /* register address or index */
94 int alloc; /* extra register already allocated */
95 int idx; /* index in shared_regs->regs[] */
98 struct event_constraint;
101 * struct hw_perf_event - performance event hardware details:
103 struct hw_perf_event {
104 #ifdef CONFIG_PERF_EVENTS
106 struct { /* hardware */
109 unsigned long config_base;
110 unsigned long event_base;
111 int event_base_rdpmc;
116 struct hw_perf_event_extra extra_reg;
117 struct hw_perf_event_extra branch_reg;
119 struct event_constraint *constraint;
121 struct { /* software */
122 struct hrtimer hrtimer;
124 struct { /* tracepoint */
125 struct task_struct *tp_target;
126 /* for tp_event->class */
127 struct list_head tp_list;
129 #ifdef CONFIG_HAVE_HW_BREAKPOINT
130 struct { /* breakpoint */
132 * Crufty hack to avoid the chicken and egg
133 * problem hw_breakpoint has with context
134 * creation and event initalization.
136 struct task_struct *bp_target;
137 struct arch_hw_breakpoint info;
138 struct list_head bp_list;
143 local64_t prev_count;
146 local64_t period_left;
151 u64 freq_count_stamp;
156 * hw_perf_event::state flags
158 #define PERF_HES_STOPPED 0x01 /* the counter is stopped */
159 #define PERF_HES_UPTODATE 0x02 /* event->count up-to-date */
160 #define PERF_HES_ARCH 0x04
165 * Common implementation detail of pmu::{start,commit,cancel}_txn
167 #define PERF_EVENT_TXN 0x1
170 * struct pmu - generic performance monitoring unit
173 struct list_head entry;
176 const struct attribute_group **attr_groups;
180 int * __percpu pmu_disable_count;
181 struct perf_cpu_context * __percpu pmu_cpu_context;
183 int hrtimer_interval_ms;
186 * Fully disable/enable this PMU, can be used to protect from the PMI
187 * as well as for lazy/batch writing of the MSRs.
189 void (*pmu_enable) (struct pmu *pmu); /* optional */
190 void (*pmu_disable) (struct pmu *pmu); /* optional */
193 * Try and initialize the event for this PMU.
194 * Should return -ENOENT when the @event doesn't match this PMU.
196 int (*event_init) (struct perf_event *event);
198 #define PERF_EF_START 0x01 /* start the counter when adding */
199 #define PERF_EF_RELOAD 0x02 /* reload the counter when starting */
200 #define PERF_EF_UPDATE 0x04 /* update the counter when stopping */
203 * Adds/Removes a counter to/from the PMU, can be done inside
204 * a transaction, see the ->*_txn() methods.
206 int (*add) (struct perf_event *event, int flags);
207 void (*del) (struct perf_event *event, int flags);
210 * Starts/Stops a counter present on the PMU. The PMI handler
211 * should stop the counter when perf_event_overflow() returns
212 * !0. ->start() will be used to continue.
214 void (*start) (struct perf_event *event, int flags);
215 void (*stop) (struct perf_event *event, int flags);
218 * Updates the counter value of the event.
220 void (*read) (struct perf_event *event);
223 * Group events scheduling is treated as a transaction, add
224 * group events as a whole and perform one schedulability test.
225 * If the test fails, roll back the whole group
227 * Start the transaction, after this ->add() doesn't need to
228 * do schedulability tests.
230 void (*start_txn) (struct pmu *pmu); /* optional */
232 * If ->start_txn() disabled the ->add() schedulability test
233 * then ->commit_txn() is required to perform one. On success
234 * the transaction is closed. On error the transaction is kept
235 * open until ->cancel_txn() is called.
237 int (*commit_txn) (struct pmu *pmu); /* optional */
239 * Will cancel the transaction, assumes ->del() is called
240 * for each successful ->add() during the transaction.
242 void (*cancel_txn) (struct pmu *pmu); /* optional */
245 * Will return the value for perf_event_mmap_page::index for this event,
246 * if no implementation is provided it will default to: event->hw.idx + 1.
248 int (*event_idx) (struct perf_event *event); /*optional */
251 * flush branch stack on context-switches (needed in cpu-wide mode)
253 void (*flush_branch_stack) (void);
257 * enum perf_event_active_state - the states of a event
259 enum 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,
267 struct perf_sample_data;
269 typedef void (*perf_overflow_handler_t)(struct perf_event *,
270 struct perf_sample_data *,
271 struct pt_regs *regs);
273 enum perf_group_flag {
274 PERF_GROUP_SOFTWARE = 0x1,
277 #define SWEVENT_HLIST_BITS 8
278 #define SWEVENT_HLIST_SIZE (1 << SWEVENT_HLIST_BITS)
280 struct swevent_hlist {
281 struct hlist_head heads[SWEVENT_HLIST_SIZE];
282 struct rcu_head rcu_head;
285 #define PERF_ATTACH_CONTEXT 0x01
286 #define PERF_ATTACH_GROUP 0x02
287 #define PERF_ATTACH_TASK 0x04
293 * struct perf_event - performance event kernel representation:
296 #ifdef CONFIG_PERF_EVENTS
297 struct list_head group_entry;
298 struct list_head event_entry;
299 struct list_head sibling_list;
300 struct hlist_node hlist_entry;
303 struct perf_event *group_leader;
306 enum perf_event_active_state state;
307 unsigned int attach_state;
309 atomic64_t child_count;
312 * These are the total time in nanoseconds that the event
313 * has been enabled (i.e. eligible to run, and the task has
314 * been scheduled in, if this is a per-task event)
315 * and running (scheduled onto the CPU), respectively.
317 * They are computed from tstamp_enabled, tstamp_running and
318 * tstamp_stopped when the event is in INACTIVE or ACTIVE state.
320 u64 total_time_enabled;
321 u64 total_time_running;
324 * These are timestamps used for computing total_time_enabled
325 * and total_time_running when the event is in INACTIVE or
326 * ACTIVE state, measured in nanoseconds from an arbitrary point
328 * tstamp_enabled: the notional time when the event was enabled
329 * tstamp_running: the notional time when the event was scheduled on
330 * tstamp_stopped: in INACTIVE state, the notional time when the
331 * event was scheduled off.
338 * timestamp shadows the actual context timing but it can
339 * be safely used in NMI interrupt context. It reflects the
340 * context time as it was when the event was last scheduled in.
342 * ctx_time already accounts for ctx->timestamp. Therefore to
343 * compute ctx_time for a sample, simply add perf_clock().
347 struct perf_event_attr attr;
351 struct hw_perf_event hw;
353 struct perf_event_context *ctx;
354 atomic_long_t refcount;
357 * These accumulate total time (in nanoseconds) that children
358 * events have been enabled and running, respectively.
360 atomic64_t child_total_time_enabled;
361 atomic64_t child_total_time_running;
364 * Protect attach/detach and child_list:
366 struct mutex child_mutex;
367 struct list_head child_list;
368 struct perf_event *parent;
373 struct list_head owner_entry;
374 struct task_struct *owner;
377 struct mutex mmap_mutex;
380 struct ring_buffer *rb;
381 struct list_head rb_entry;
384 wait_queue_head_t waitq;
385 struct fasync_struct *fasync;
387 /* delayed work for NMIs and such */
391 struct irq_work pending;
393 atomic_t event_limit;
395 void (*destroy)(struct perf_event *);
396 struct rcu_head rcu_head;
398 struct pid_namespace *ns;
401 perf_overflow_handler_t overflow_handler;
402 void *overflow_handler_context;
404 #ifdef CONFIG_EVENT_TRACING
405 struct ftrace_event_call *tp_event;
406 struct event_filter *filter;
407 #ifdef CONFIG_FUNCTION_TRACER
408 struct ftrace_ops ftrace_ops;
412 #ifdef CONFIG_CGROUP_PERF
413 struct perf_cgroup *cgrp; /* cgroup event is attach to */
414 int cgrp_defer_enabled;
417 #endif /* CONFIG_PERF_EVENTS */
420 enum perf_event_context_type {
426 * struct perf_event_context - event context structure
428 * Used as a container for task events and CPU events as well:
430 struct perf_event_context {
432 enum perf_event_context_type type;
434 * Protect the states of the events in the list,
435 * nr_active, and the list:
439 * Protect the list of events. Locking either mutex or lock
440 * is sufficient to ensure the list doesn't change; to change
441 * the list you need to lock both the mutex and the spinlock.
445 struct list_head pinned_groups;
446 struct list_head flexible_groups;
447 struct list_head event_list;
455 struct task_struct *task;
458 * Context clock, runs when context enabled.
464 * These fields let us detect when two contexts have both
465 * been cloned (inherited) from a common ancestor.
467 struct perf_event_context *parent_ctx;
471 int nr_cgroups; /* cgroup evts */
472 int nr_branch_stack; /* branch_stack evt */
473 struct rcu_head rcu_head;
477 * Number of contexts where an event can trigger:
478 * task, softirq, hardirq, nmi.
480 #define PERF_NR_CONTEXTS 4
483 * struct perf_event_cpu_context - per cpu event context structure
485 struct perf_cpu_context {
486 struct perf_event_context ctx;
487 struct perf_event_context *task_ctx;
490 struct hrtimer hrtimer;
491 ktime_t hrtimer_interval;
492 struct list_head rotation_list;
493 struct pmu *unique_pmu;
494 struct perf_cgroup *cgrp;
497 struct perf_output_handle {
498 struct perf_event *event;
499 struct ring_buffer *rb;
500 unsigned long wakeup;
506 #ifdef CONFIG_PERF_EVENTS
508 extern int perf_pmu_register(struct pmu *pmu, const char *name, int type);
509 extern void perf_pmu_unregister(struct pmu *pmu);
511 extern int perf_num_counters(void);
512 extern const char *perf_pmu_name(void);
513 extern void __perf_event_task_sched_in(struct task_struct *prev,
514 struct task_struct *task);
515 extern void __perf_event_task_sched_out(struct task_struct *prev,
516 struct task_struct *next);
517 extern int perf_event_init_task(struct task_struct *child);
518 extern void perf_event_exit_task(struct task_struct *child);
519 extern void perf_event_free_task(struct task_struct *task);
520 extern void perf_event_delayed_put(struct task_struct *task);
521 extern void perf_event_print_debug(void);
522 extern void perf_pmu_disable(struct pmu *pmu);
523 extern void perf_pmu_enable(struct pmu *pmu);
524 extern int perf_event_task_disable(void);
525 extern int perf_event_task_enable(void);
526 extern int perf_event_refresh(struct perf_event *event, int refresh);
527 extern void perf_event_update_userpage(struct perf_event *event);
528 extern int perf_event_release_kernel(struct perf_event *event);
529 extern struct perf_event *
530 perf_event_create_kernel_counter(struct perf_event_attr *attr,
532 struct task_struct *task,
533 perf_overflow_handler_t callback,
535 extern void perf_pmu_migrate_context(struct pmu *pmu,
536 int src_cpu, int dst_cpu);
537 extern u64 perf_event_read_value(struct perf_event *event,
538 u64 *enabled, u64 *running);
541 struct perf_sample_data {
558 union perf_mem_data_src data_src;
559 struct perf_callchain_entry *callchain;
560 struct perf_raw_record *raw;
561 struct perf_branch_stack *br_stack;
562 struct perf_regs_user regs_user;
567 static inline void perf_sample_data_init(struct perf_sample_data *data,
568 u64 addr, u64 period)
570 /* remaining struct members initialized in perf_prepare_sample() */
573 data->br_stack = NULL;
574 data->period = period;
575 data->regs_user.abi = PERF_SAMPLE_REGS_ABI_NONE;
576 data->regs_user.regs = NULL;
577 data->stack_user_size = 0;
579 data->data_src.val = 0;
582 extern void perf_output_sample(struct perf_output_handle *handle,
583 struct perf_event_header *header,
584 struct perf_sample_data *data,
585 struct perf_event *event);
586 extern void perf_prepare_sample(struct perf_event_header *header,
587 struct perf_sample_data *data,
588 struct perf_event *event,
589 struct pt_regs *regs);
591 extern int perf_event_overflow(struct perf_event *event,
592 struct perf_sample_data *data,
593 struct pt_regs *regs);
595 static inline bool is_sampling_event(struct perf_event *event)
597 return event->attr.sample_period != 0;
601 * Return 1 for a software event, 0 for a hardware event
603 static inline int is_software_event(struct perf_event *event)
605 return event->pmu->task_ctx_nr == perf_sw_context;
608 extern struct static_key perf_swevent_enabled[PERF_COUNT_SW_MAX];
610 extern void __perf_sw_event(u32, u64, struct pt_regs *, u64);
612 #ifndef perf_arch_fetch_caller_regs
613 static inline void perf_arch_fetch_caller_regs(struct pt_regs *regs, unsigned long ip) { }
617 * Take a snapshot of the regs. Skip ip and frame pointer to
618 * the nth caller. We only need a few of the regs:
619 * - ip for PERF_SAMPLE_IP
620 * - cs for user_mode() tests
621 * - bp for callchains
622 * - eflags, for future purposes, just in case
624 static inline void perf_fetch_caller_regs(struct pt_regs *regs)
626 memset(regs, 0, sizeof(*regs));
628 perf_arch_fetch_caller_regs(regs, CALLER_ADDR0);
631 static __always_inline void
632 perf_sw_event(u32 event_id, u64 nr, struct pt_regs *regs, u64 addr)
634 struct pt_regs hot_regs;
636 if (static_key_false(&perf_swevent_enabled[event_id])) {
638 perf_fetch_caller_regs(&hot_regs);
641 __perf_sw_event(event_id, nr, regs, addr);
645 extern struct static_key_deferred perf_sched_events;
647 static inline void perf_event_task_sched_in(struct task_struct *prev,
648 struct task_struct *task)
650 if (static_key_false(&perf_sched_events.key))
651 __perf_event_task_sched_in(prev, task);
654 static inline void perf_event_task_sched_out(struct task_struct *prev,
655 struct task_struct *next)
657 perf_sw_event(PERF_COUNT_SW_CONTEXT_SWITCHES, 1, NULL, 0);
659 if (static_key_false(&perf_sched_events.key))
660 __perf_event_task_sched_out(prev, next);
663 extern void perf_event_mmap(struct vm_area_struct *vma);
664 extern struct perf_guest_info_callbacks *perf_guest_cbs;
665 extern int perf_register_guest_info_callbacks(struct perf_guest_info_callbacks *callbacks);
666 extern int perf_unregister_guest_info_callbacks(struct perf_guest_info_callbacks *callbacks);
668 extern void perf_event_comm(struct task_struct *tsk);
669 extern void perf_event_fork(struct task_struct *tsk);
672 DECLARE_PER_CPU(struct perf_callchain_entry, perf_callchain_entry);
674 extern void perf_callchain_user(struct perf_callchain_entry *entry, struct pt_regs *regs);
675 extern void perf_callchain_kernel(struct perf_callchain_entry *entry, struct pt_regs *regs);
677 static inline void perf_callchain_store(struct perf_callchain_entry *entry, u64 ip)
679 if (entry->nr < PERF_MAX_STACK_DEPTH)
680 entry->ip[entry->nr++] = ip;
683 extern int sysctl_perf_event_paranoid;
684 extern int sysctl_perf_event_mlock;
685 extern int sysctl_perf_event_sample_rate;
686 extern int sysctl_perf_cpu_time_max_percent;
688 extern void perf_sample_event_took(u64 sample_len_ns);
690 extern int perf_proc_update_handler(struct ctl_table *table, int write,
691 void __user *buffer, size_t *lenp,
693 extern int perf_cpu_time_max_percent_handler(struct ctl_table *table, int write,
694 void __user *buffer, size_t *lenp,
698 static inline bool perf_paranoid_tracepoint_raw(void)
700 return sysctl_perf_event_paranoid > -1;
703 static inline bool perf_paranoid_cpu(void)
705 return sysctl_perf_event_paranoid > 0;
708 static inline bool perf_paranoid_kernel(void)
710 return sysctl_perf_event_paranoid > 1;
713 extern void perf_event_init(void);
714 extern void perf_tp_event(u64 addr, u64 count, void *record,
715 int entry_size, struct pt_regs *regs,
716 struct hlist_head *head, int rctx,
717 struct task_struct *task);
718 extern void perf_bp_event(struct perf_event *event, void *data);
720 #ifndef perf_misc_flags
721 # define perf_misc_flags(regs) \
722 (user_mode(regs) ? PERF_RECORD_MISC_USER : PERF_RECORD_MISC_KERNEL)
723 # define perf_instruction_pointer(regs) instruction_pointer(regs)
726 static inline bool has_branch_stack(struct perf_event *event)
728 return event->attr.sample_type & PERF_SAMPLE_BRANCH_STACK;
731 extern int perf_output_begin(struct perf_output_handle *handle,
732 struct perf_event *event, unsigned int size);
733 extern void perf_output_end(struct perf_output_handle *handle);
734 extern unsigned int perf_output_copy(struct perf_output_handle *handle,
735 const void *buf, unsigned int len);
736 extern unsigned int perf_output_skip(struct perf_output_handle *handle,
738 extern int perf_swevent_get_recursion_context(void);
739 extern void perf_swevent_put_recursion_context(int rctx);
740 extern u64 perf_swevent_set_period(struct perf_event *event);
741 extern void perf_event_enable(struct perf_event *event);
742 extern void perf_event_disable(struct perf_event *event);
743 extern int __perf_event_disable(void *info);
744 extern void perf_event_task_tick(void);
747 perf_event_task_sched_in(struct task_struct *prev,
748 struct task_struct *task) { }
750 perf_event_task_sched_out(struct task_struct *prev,
751 struct task_struct *next) { }
752 static inline int perf_event_init_task(struct task_struct *child) { return 0; }
753 static inline void perf_event_exit_task(struct task_struct *child) { }
754 static inline void perf_event_free_task(struct task_struct *task) { }
755 static inline void perf_event_delayed_put(struct task_struct *task) { }
756 static inline void perf_event_print_debug(void) { }
757 static inline int perf_event_task_disable(void) { return -EINVAL; }
758 static inline int perf_event_task_enable(void) { return -EINVAL; }
759 static inline int perf_event_refresh(struct perf_event *event, int refresh)
765 perf_sw_event(u32 event_id, u64 nr, struct pt_regs *regs, u64 addr) { }
767 perf_bp_event(struct perf_event *event, void *data) { }
769 static inline int perf_register_guest_info_callbacks
770 (struct perf_guest_info_callbacks *callbacks) { return 0; }
771 static inline int perf_unregister_guest_info_callbacks
772 (struct perf_guest_info_callbacks *callbacks) { return 0; }
774 static inline void perf_event_mmap(struct vm_area_struct *vma) { }
775 static inline void perf_event_comm(struct task_struct *tsk) { }
776 static inline void perf_event_fork(struct task_struct *tsk) { }
777 static inline void perf_event_init(void) { }
778 static inline int perf_swevent_get_recursion_context(void) { return -1; }
779 static inline void perf_swevent_put_recursion_context(int rctx) { }
780 static inline u64 perf_swevent_set_period(struct perf_event *event) { return 0; }
781 static inline void perf_event_enable(struct perf_event *event) { }
782 static inline void perf_event_disable(struct perf_event *event) { }
783 static inline int __perf_event_disable(void *info) { return -1; }
784 static inline void perf_event_task_tick(void) { }
787 #if defined(CONFIG_PERF_EVENTS) && defined(CONFIG_NO_HZ_FULL)
788 extern bool perf_event_can_stop_tick(void);
790 static inline bool perf_event_can_stop_tick(void) { return true; }
793 #if defined(CONFIG_PERF_EVENTS) && defined(CONFIG_CPU_SUP_INTEL)
794 extern void perf_restore_debug_store(void);
796 static inline void perf_restore_debug_store(void) { }
799 #define perf_output_put(handle, x) perf_output_copy((handle), &(x), sizeof(x))
802 * This has to have a higher priority than migration_notifier in sched/core.c.
804 #define perf_cpu_notifier(fn) \
806 static struct notifier_block fn##_nb = \
807 { .notifier_call = fn, .priority = CPU_PRI_PERF }; \
808 unsigned long cpu = smp_processor_id(); \
809 unsigned long flags; \
810 fn(&fn##_nb, (unsigned long)CPU_UP_PREPARE, \
811 (void *)(unsigned long)cpu); \
812 local_irq_save(flags); \
813 fn(&fn##_nb, (unsigned long)CPU_STARTING, \
814 (void *)(unsigned long)cpu); \
815 local_irq_restore(flags); \
816 fn(&fn##_nb, (unsigned long)CPU_ONLINE, \
817 (void *)(unsigned long)cpu); \
818 register_cpu_notifier(&fn##_nb); \
822 struct perf_pmu_events_attr {
823 struct device_attribute attr;
825 const char *event_str;
828 #define PMU_EVENT_ATTR(_name, _var, _id, _show) \
829 static struct perf_pmu_events_attr _var = { \
830 .attr = __ATTR(_name, 0444, _show, NULL), \
834 #define PMU_FORMAT_ATTR(_name, _format) \
836 _name##_show(struct device *dev, \
837 struct device_attribute *attr, \
840 BUILD_BUG_ON(sizeof(_format) >= PAGE_SIZE); \
841 return sprintf(page, _format "\n"); \
844 static struct device_attribute format_attr_##_name = __ATTR_RO(_name)
846 #endif /* _LINUX_PERF_EVENT_H */