[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>
#include <asm/perf_counter.h>

#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_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_HW_EVENTS_MAX		=  6,

	/*
	 * 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 {
	void (*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;

	unsigned int			nr_inherited;
	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);

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