[deliverable/linux.git] / include / linux / perf_counter.h

/*
 *  Performance counters:
 *
 *   Copyright(C) 2008, Thomas Gleixner <tglx@linutronix.de>
 *   Copyright(C) 2008, Red Hat, Inc., Ingo Molnar
 *
 *  Data type definitions, declarations, prototypes.
 *
 *  Started by: Thomas Gleixner and Ingo Molnar
 *
 *  For licencing details see kernel-base/COPYING
 */
#ifndef _LINUX_PERF_COUNTER_H
#define _LINUX_PERF_COUNTER_H

#include <asm/atomic.h>

#ifdef CONFIG_PERF_COUNTERS
# include <asm/perf_counter.h>
#endif

#include <linux/list.h>
#include <linux/mutex.h>
#include <linux/rculist.h>
#include <linux/rcupdate.h>
#include <linux/spinlock.h>

struct task_struct;

/*
 * User-space ABI bits:
 */

/*
 * Generalized performance counter event types, used by the hw_event.type
 * parameter of the sys_perf_counter_open() syscall:
 */
enum hw_event_types {
	/*
	 * Common hardware events, generalized by the kernel:
	 */
	PERF_COUNT_CPU_CYCLES		=  0,
	PERF_COUNT_INSTRUCTIONS		=  1,
	PERF_COUNT_CACHE_REFERENCES	=  2,
	PERF_COUNT_CACHE_MISSES		=  3,
	PERF_COUNT_BRANCH_INSTRUCTIONS	=  4,
	PERF_COUNT_BRANCH_MISSES	=  5,
	PERF_COUNT_BUS_CYCLES		=  6,

	PERF_HW_EVENTS_MAX		=  7,

	/*
	 * Special "software" counters provided by the kernel, even if
	 * the hardware does not support performance counters. These
	 * counters measure various physical and sw events of the
	 * kernel (and allow the profiling of them as well):
	 */
	PERF_COUNT_CPU_CLOCK		= -1,
	PERF_COUNT_TASK_CLOCK		= -2,
	PERF_COUNT_PAGE_FAULTS		= -3,
	PERF_COUNT_CONTEXT_SWITCHES	= -4,
	PERF_COUNT_CPU_MIGRATIONS	= -5,

	PERF_SW_EVENTS_MIN		= -6,
};

/*
 * IRQ-notification data record type:
 */
enum perf_counter_record_type {
	PERF_RECORD_SIMPLE		=  0,
	PERF_RECORD_IRQ			=  1,
	PERF_RECORD_GROUP		=  2,
};

/*
 * Hardware event to monitor via a performance monitoring counter:
 */
struct perf_counter_hw_event {
	s64			type;

	u64			irq_period;
	u32			record_type;

	u32			disabled     :  1, /* off by default      */
				nmi	     :  1, /* NMI sampling        */
				raw	     :  1, /* raw event type      */
				inherit	     :  1, /* children inherit it */
				__reserved_1 : 28;

	u64			__reserved_2;
};

/*
 * Kernel-internal data types:
 */

/**
 * struct hw_perf_counter - performance counter hardware details:
 */
struct hw_perf_counter {
#ifdef CONFIG_PERF_COUNTERS
	u64				config;
	unsigned long			config_base;
	unsigned long			counter_base;
	int				nmi;
	unsigned int			idx;
	atomic64_t			prev_count;
	u64				irq_period;
	atomic64_t			period_left;
#endif
};

/*
 * Hardcoded buffer length limit for now, for IRQ-fed events:
 */
#define PERF_DATA_BUFLEN		2048

/**
 * struct perf_data - performance counter IRQ data sampling ...
 */
struct perf_data {
	int				len;
	int				rd_idx;
	int				overrun;
	u8				data[PERF_DATA_BUFLEN];
};

struct perf_counter;

/**
 * struct hw_perf_counter_ops - performance counter hw ops
 */
struct hw_perf_counter_ops {
	int (*enable)			(struct perf_counter *counter);
	void (*disable)			(struct perf_counter *counter);
	void (*read)			(struct perf_counter *counter);
};

/**
 * enum perf_counter_active_state - the states of a counter
 */
enum perf_counter_active_state {
	PERF_COUNTER_STATE_OFF		= -1,
	PERF_COUNTER_STATE_INACTIVE	=  0,
	PERF_COUNTER_STATE_ACTIVE	=  1,
};

struct file;

/**
 * struct perf_counter - performance counter kernel representation:
 */
struct perf_counter {
#ifdef CONFIG_PERF_COUNTERS
	struct list_head		list_entry;
	struct list_head		sibling_list;
	struct perf_counter		*group_leader;
	const struct hw_perf_counter_ops *hw_ops;

	enum perf_counter_active_state	state;
	atomic64_t			count;

	struct perf_counter_hw_event	hw_event;
	struct hw_perf_counter		hw;

	struct perf_counter_context	*ctx;
	struct task_struct		*task;
	struct file			*filp;

	struct perf_counter		*parent;
	/*
	 * Protect attach/detach:
	 */
	struct mutex			mutex;

	int				oncpu;
	int				cpu;

	/* read() / irq related data */
	wait_queue_head_t		waitq;
	/* optional: for NMIs */
	int				wakeup_pending;
	struct perf_data		*irqdata;
	struct perf_data		*usrdata;
	struct perf_data		data[2];
#endif
};

/**
 * struct perf_counter_context - counter context structure
 *
 * Used as a container for task counters and CPU counters as well:
 */
struct perf_counter_context {
#ifdef CONFIG_PERF_COUNTERS
	/*
	 * Protect the list of counters:
	 */
	spinlock_t		lock;

	struct list_head	counter_list;
	int			nr_counters;
	int			nr_active;
	struct task_struct	*task;
#endif
};

/**
 * struct perf_counter_cpu_context - per cpu counter context structure
 */
struct perf_cpu_context {
	struct perf_counter_context	ctx;
	struct perf_counter_context	*task_ctx;
	int				active_oncpu;
	int				max_pertask;
};

/*
 * Set by architecture code:
 */
extern int perf_max_counters;

#ifdef CONFIG_PERF_COUNTERS
extern const struct hw_perf_counter_ops *
hw_perf_counter_init(struct perf_counter *counter);

extern void perf_counter_task_sched_in(struct task_struct *task, int cpu);
extern void perf_counter_task_sched_out(struct task_struct *task, int cpu);
extern void perf_counter_task_tick(struct task_struct *task, int cpu);
extern void perf_counter_init_task(struct task_struct *child);
extern void perf_counter_exit_task(struct task_struct *child);
extern void perf_counter_notify(struct pt_regs *regs);
extern void perf_counter_print_debug(void);
extern u64 hw_perf_save_disable(void);
extern void hw_perf_restore(u64 ctrl);
extern int perf_counter_task_disable(void);
extern int perf_counter_task_enable(void);
extern int hw_perf_group_sched_in(struct perf_counter *group_leader,
	       struct perf_cpu_context *cpuctx,
	       struct perf_counter_context *ctx, int cpu);

#else
static inline void
perf_counter_task_sched_in(struct task_struct *task, int cpu)		{ }
static inline void
perf_counter_task_sched_out(struct task_struct *task, int cpu)		{ }
static inline void
perf_counter_task_tick(struct task_struct *task, int cpu)		{ }
static inline void perf_counter_init_task(struct task_struct *child)	{ }
static inline void perf_counter_exit_task(struct task_struct *child)	{ }
static inline void perf_counter_notify(struct pt_regs *regs)		{ }
static inline void perf_counter_print_debug(void)			{ }
static inline void hw_perf_restore(u64 ctrl)			{ }
static inline u64 hw_perf_save_disable(void)		      { return 0; }
static inline int perf_counter_task_disable(void)	{ return -EINVAL; }
static inline int perf_counter_task_enable(void)	{ return -EINVAL; }
#endif

#endif /* _LINUX_PERF_COUNTER_H */
Commit	Line	Data
0793a61d TG	1	/*
	2	* Performance counters:
	3	*
	4	* Copyright(C) 2008, Thomas Gleixner <tglx@linutronix.de>
	5	* Copyright(C) 2008, Red Hat, Inc., Ingo Molnar
	6	*
	7	* Data type definitions, declarations, prototypes.
	8	*
	9	* Started by: Thomas Gleixner and Ingo Molnar
	10	*
	11	* For licencing details see kernel-base/COPYING
	12	*/
	13	#ifndef _LINUX_PERF_COUNTER_H
	14	#define _LINUX_PERF_COUNTER_H
	15
	16	#include <asm/atomic.h>
e44aef58 IM	17
	18	#ifdef CONFIG_PERF_COUNTERS
	19	# include <asm/perf_counter.h>
	20	#endif
0793a61d TG	21
	22	#include <linux/list.h>
	23	#include <linux/mutex.h>
	24	#include <linux/rculist.h>
	25	#include <linux/rcupdate.h>
	26	#include <linux/spinlock.h>
	27
	28	struct task_struct;
	29
	30	/*
9f66a381 IM	31	* User-space ABI bits:
	32	*/
	33
	34	/*
	35	* Generalized performance counter event types, used by the hw_event.type
	36	* parameter of the sys_perf_counter_open() syscall:
0793a61d TG	37	*/
0793a61d TG	38	enum hw_event_types {
0793a61d	39	/*
9f66a381	40	* Common hardware events, generalized by the kernel:
0793a61d	41	*/
f650a672	42	PERF_COUNT_CPU_CYCLES = 0,
9f66a381 IM	43	PERF_COUNT_INSTRUCTIONS = 1,
	44	PERF_COUNT_CACHE_REFERENCES = 2,
	45	PERF_COUNT_CACHE_MISSES = 3,
	46	PERF_COUNT_BRANCH_INSTRUCTIONS = 4,
	47	PERF_COUNT_BRANCH_MISSES = 5,
f650a672	48	PERF_COUNT_BUS_CYCLES = 6,
9f66a381	49
f650a672	50	PERF_HW_EVENTS_MAX = 7,
6c594c21	51
9f66a381 IM	52	/*
	53	* Special "software" counters provided by the kernel, even if
	54	* the hardware does not support performance counters. These
	55	* counters measure various physical and sw events of the
	56	* kernel (and allow the profiling of them as well):
	57	*/
	58	PERF_COUNT_CPU_CLOCK = -1,
	59	PERF_COUNT_TASK_CLOCK = -2,
5d6a27d8 IM	60	PERF_COUNT_PAGE_FAULTS = -3,
5d6a27d8 IM	61	PERF_COUNT_CONTEXT_SWITCHES = -4,
6c594c21 IM	62	PERF_COUNT_CPU_MIGRATIONS = -5,
	63
	64	PERF_SW_EVENTS_MIN = -6,
0793a61d TG	65	};
	66
	67	/*
	68	* IRQ-notification data record type:
	69	*/
9f66a381 IM	70	enum perf_counter_record_type {
	71	PERF_RECORD_SIMPLE = 0,
	72	PERF_RECORD_IRQ = 1,
	73	PERF_RECORD_GROUP = 2,
0793a61d TG	74	};
0793a61d TG	75
9f66a381 IM	76	/*
	77	* Hardware event to monitor via a performance monitoring counter:
	78	*/
	79	struct perf_counter_hw_event {
01b2838c	80	s64 type;
9f66a381 IM	81
	82	u64 irq_period;
	83	u32 record_type;
	84
9b51f66d IM	85	u32 disabled : 1, /* off by default */
	86	nmi : 1, /* NMI sampling */
	87	raw : 1, /* raw event type */
	88	inherit : 1, /* children inherit it */
	89	__reserved_1 : 28;
9f66a381 IM	90
9f66a381 IM	91	u64 __reserved_2;
eab656ae TG	92	};
eab656ae TG	93
9f66a381 IM	94	/*
	95	* Kernel-internal data types:
	96	*/
	97
0793a61d	98	/**
9f66a381	99	* struct hw_perf_counter - performance counter hardware details:
0793a61d TG	100	*/
0793a61d TG	101	struct hw_perf_counter {
ee06094f	102	#ifdef CONFIG_PERF_COUNTERS
9f66a381 IM	103	u64 config;
	104	unsigned long config_base;
	105	unsigned long counter_base;
	106	int nmi;
	107	unsigned int idx;
ee06094f	108	atomic64_t prev_count;
9f66a381	109	u64 irq_period;
ee06094f IM	110	atomic64_t period_left;
ee06094f IM	111	#endif
0793a61d TG	112	};
	113
	114	/*
	115	* Hardcoded buffer length limit for now, for IRQ-fed events:
	116	*/
9f66a381	117	#define PERF_DATA_BUFLEN 2048
0793a61d TG	118
	119	/**
	120	* struct perf_data - performance counter IRQ data sampling ...
	121	*/
	122	struct perf_data {
9f66a381 IM	123	int len;
	124	int rd_idx;
	125	int overrun;
	126	u8 data[PERF_DATA_BUFLEN];
0793a61d TG	127	};
0793a61d TG	128
621a01ea IM	129	struct perf_counter;
	130
	131	/**
	132	* struct hw_perf_counter_ops - performance counter hw ops
	133	*/
	134	struct hw_perf_counter_ops {
95cdd2e7	135	int (enable) (struct perf_counter counter);
7671581f IM	136	void (disable) (struct perf_counter counter);
7671581f IM	137	void (read) (struct perf_counter counter);
621a01ea IM	138	};
621a01ea IM	139
6a930700 IM	140	/**
	141	* enum perf_counter_active_state - the states of a counter
	142	*/
	143	enum perf_counter_active_state {
	144	PERF_COUNTER_STATE_OFF = -1,
	145	PERF_COUNTER_STATE_INACTIVE = 0,
	146	PERF_COUNTER_STATE_ACTIVE = 1,
	147	};
	148
9b51f66d IM	149	struct file;
9b51f66d IM	150
0793a61d TG	151	/**
	152	* struct perf_counter - performance counter kernel representation:
	153	*/
	154	struct perf_counter {
ee06094f	155	#ifdef CONFIG_PERF_COUNTERS
04289bb9 IM	156	struct list_head list_entry;
	157	struct list_head sibling_list;
	158	struct perf_counter *group_leader;
5c92d124	159	const struct hw_perf_counter_ops *hw_ops;
04289bb9	160
6a930700	161	enum perf_counter_active_state state;
0793a61d	162	atomic64_t count;
ee06094f	163
9f66a381	164	struct perf_counter_hw_event hw_event;
0793a61d TG	165	struct hw_perf_counter hw;
	166
	167	struct perf_counter_context *ctx;
	168	struct task_struct *task;
9b51f66d	169	struct file *filp;
0793a61d	170
9b51f66d	171	struct perf_counter *parent;
0793a61d TG	172	/*
	173	* Protect attach/detach:
	174	*/
	175	struct mutex mutex;
	176
	177	int oncpu;
	178	int cpu;
	179
0793a61d TG	180	/* read() / irq related data */
	181	wait_queue_head_t waitq;
	182	/* optional: for NMIs */
	183	int wakeup_pending;
	184	struct perf_data *irqdata;
	185	struct perf_data *usrdata;
	186	struct perf_data data[2];
ee06094f	187	#endif
0793a61d TG	188	};
	189
	190	/**
	191	* struct perf_counter_context - counter context structure
	192	*
	193	* Used as a container for task counters and CPU counters as well:
	194	*/
	195	struct perf_counter_context {
	196	#ifdef CONFIG_PERF_COUNTERS
	197	/*
	198	* Protect the list of counters:
	199	*/
	200	spinlock_t lock;
04289bb9 IM	201
04289bb9 IM	202	struct list_head counter_list;
0793a61d TG	203	int nr_counters;
	204	int nr_active;
	205	struct task_struct *task;
	206	#endif
	207	};
	208
	209	/**
	210	* struct perf_counter_cpu_context - per cpu counter context structure
	211	*/
	212	struct perf_cpu_context {
	213	struct perf_counter_context ctx;
	214	struct perf_counter_context *task_ctx;
	215	int active_oncpu;
	216	int max_pertask;
	217	};
	218
	219	/*
	220	* Set by architecture code:
	221	*/
	222	extern int perf_max_counters;
	223
	224	#ifdef CONFIG_PERF_COUNTERS
5c92d124	225	extern const struct hw_perf_counter_ops *
621a01ea IM	226	hw_perf_counter_init(struct perf_counter *counter);
621a01ea IM	227
0793a61d TG	228	extern void perf_counter_task_sched_in(struct task_struct *task, int cpu);
	229	extern void perf_counter_task_sched_out(struct task_struct *task, int cpu);
	230	extern void perf_counter_task_tick(struct task_struct *task, int cpu);
9b51f66d IM	231	extern void perf_counter_init_task(struct task_struct *child);
9b51f66d IM	232	extern void perf_counter_exit_task(struct task_struct *child);
0793a61d TG	233	extern void perf_counter_notify(struct pt_regs *regs);
0793a61d TG	234	extern void perf_counter_print_debug(void);
01b2838c IM	235	extern u64 hw_perf_save_disable(void);
01b2838c IM	236	extern void hw_perf_restore(u64 ctrl);
1d1c7ddb IM	237	extern int perf_counter_task_disable(void);
1d1c7ddb IM	238	extern int perf_counter_task_enable(void);
3cbed429 PM	239	extern int hw_perf_group_sched_in(struct perf_counter *group_leader,
	240	struct perf_cpu_context *cpuctx,
	241	struct perf_counter_context *ctx, int cpu);
5c92d124	242
0793a61d TG	243	#else
	244	static inline void
	245	perf_counter_task_sched_in(struct task_struct *task, int cpu) { }
	246	static inline void
	247	perf_counter_task_sched_out(struct task_struct *task, int cpu) { }
	248	static inline void
	249	perf_counter_task_tick(struct task_struct *task, int cpu) { }
9b51f66d IM	250	static inline void perf_counter_init_task(struct task_struct *child) { }
9b51f66d IM	251	static inline void perf_counter_exit_task(struct task_struct *child) { }
0793a61d TG	252	static inline void perf_counter_notify(struct pt_regs *regs) { }
0793a61d TG	253	static inline void perf_counter_print_debug(void) { }
01b2838c IM	254	static inline void hw_perf_restore(u64 ctrl) { }
01b2838c IM	255	static inline u64 hw_perf_save_disable(void) { return 0; }
1d1c7ddb IM	256	static inline int perf_counter_task_disable(void) { return -EINVAL; }
1d1c7ddb IM	257	static inline int perf_counter_task_enable(void) { return -EINVAL; }
0793a61d TG	258	#endif
	259
	260	#endif /* _LINUX_PERF_COUNTER_H */