[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 <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,

	/*
	 * 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,
};

/*
 * 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 {
	u64			type;

	u64			irq_period;
	u32			record_type;

	u32			disabled     :  1, /* off by default */
				nmi	     :  1, /* NMI sampling   */
				raw	     :  1, /* raw event type */
				__reserved_1 : 29;

	u64			__reserved_2;
};

/*
 * Kernel-internal data types:
 */

/**
 * struct hw_perf_counter - performance counter hardware details:
 */
struct hw_perf_counter {
	u64				config;
	unsigned long			config_base;
	unsigned long			counter_base;
	int				nmi;
	unsigned int			idx;
	u64				prev_count;
	u64				irq_period;
	s32				next_count;
};

/*
 * 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 (*hw_perf_counter_enable)	(struct perf_counter *counter);
	void (*hw_perf_counter_disable)	(struct perf_counter *counter);
	void (*hw_perf_counter_read)	(struct perf_counter *counter);
};

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

	int				active;
#if BITS_PER_LONG == 64
	atomic64_t			count;
#else
	atomic_t			count32[2];
#endif
	struct perf_counter_hw_event	hw_event;
	struct hw_perf_counter		hw;

	struct perf_counter_context	*ctx;
	struct task_struct		*task;

	/*
	 * 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];
};

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