[mirror_ubuntu-zesty-kernel.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,
	/*
	 * Future software events:
	 */
	/* 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 {
	s64			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 {
#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 (*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);
};

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

	/*
	 * 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 *task);
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 *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(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>
	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,
bae43c99 IM	53	/*
	54	* Future software events:
	55	*/
	56	/* PERF_COUNT_PAGE_FAULTS = -3,
	57	PERF_COUNT_CONTEXT_SWITCHES = -4, */
0793a61d TG	58	};
	59
	60	/*
	61	* IRQ-notification data record type:
	62	*/
9f66a381 IM	63	enum perf_counter_record_type {
	64	PERF_RECORD_SIMPLE = 0,
	65	PERF_RECORD_IRQ = 1,
	66	PERF_RECORD_GROUP = 2,
0793a61d TG	67	};
0793a61d TG	68
9f66a381 IM	69	/*
	70	* Hardware event to monitor via a performance monitoring counter:
	71	*/
	72	struct perf_counter_hw_event {
01b2838c	73	s64 type;
9f66a381 IM	74
	75	u64 irq_period;
	76	u32 record_type;
	77
	78	u32 disabled : 1, /* off by default */
	79	nmi : 1, /* NMI sampling */
	80	raw : 1, /* raw event type */
	81	__reserved_1 : 29;
	82
	83	u64 __reserved_2;
eab656ae TG	84	};
eab656ae TG	85
9f66a381 IM	86	/*
	87	* Kernel-internal data types:
	88	*/
	89
0793a61d	90	/**
9f66a381	91	* struct hw_perf_counter - performance counter hardware details:
0793a61d TG	92	*/
0793a61d TG	93	struct hw_perf_counter {
ee06094f	94	#ifdef CONFIG_PERF_COUNTERS
9f66a381 IM	95	u64 config;
	96	unsigned long config_base;
	97	unsigned long counter_base;
	98	int nmi;
	99	unsigned int idx;
ee06094f	100	atomic64_t prev_count;
9f66a381	101	u64 irq_period;
ee06094f IM	102	atomic64_t period_left;
ee06094f IM	103	#endif
0793a61d TG	104	};
	105
	106	/*
	107	* Hardcoded buffer length limit for now, for IRQ-fed events:
	108	*/
9f66a381	109	#define PERF_DATA_BUFLEN 2048
0793a61d TG	110
	111	/**
	112	* struct perf_data - performance counter IRQ data sampling ...
	113	*/
	114	struct perf_data {
9f66a381 IM	115	int len;
	116	int rd_idx;
	117	int overrun;
	118	u8 data[PERF_DATA_BUFLEN];
0793a61d TG	119	};
0793a61d TG	120
621a01ea IM	121	struct perf_counter;
	122
	123	/**
	124	* struct hw_perf_counter_ops - performance counter hw ops
	125	*/
	126	struct hw_perf_counter_ops {
	127	void (hw_perf_counter_enable) (struct perf_counter counter);
	128	void (hw_perf_counter_disable) (struct perf_counter counter);
	129	void (hw_perf_counter_read) (struct perf_counter counter);
	130	};
	131
6a930700 IM	132	/**
	133	* enum perf_counter_active_state - the states of a counter
	134	*/
	135	enum perf_counter_active_state {
	136	PERF_COUNTER_STATE_OFF = -1,
	137	PERF_COUNTER_STATE_INACTIVE = 0,
	138	PERF_COUNTER_STATE_ACTIVE = 1,
	139	};
	140
0793a61d TG	141	/**
	142	* struct perf_counter - performance counter kernel representation:
	143	*/
	144	struct perf_counter {
ee06094f	145	#ifdef CONFIG_PERF_COUNTERS
04289bb9 IM	146	struct list_head list_entry;
	147	struct list_head sibling_list;
	148	struct perf_counter *group_leader;
5c92d124	149	const struct hw_perf_counter_ops *hw_ops;
04289bb9	150
6a930700	151	enum perf_counter_active_state state;
0793a61d	152	atomic64_t count;
ee06094f	153
9f66a381	154	struct perf_counter_hw_event hw_event;
0793a61d TG	155	struct hw_perf_counter hw;
	156
	157	struct perf_counter_context *ctx;
	158	struct task_struct *task;
	159
	160	/*
	161	* Protect attach/detach:
	162	*/
	163	struct mutex mutex;
	164
	165	int oncpu;
	166	int cpu;
	167
0793a61d TG	168	/* read() / irq related data */
	169	wait_queue_head_t waitq;
	170	/* optional: for NMIs */
	171	int wakeup_pending;
	172	struct perf_data *irqdata;
	173	struct perf_data *usrdata;
	174	struct perf_data data[2];
ee06094f	175	#endif
0793a61d TG	176	};
	177
	178	/**
	179	* struct perf_counter_context - counter context structure
	180	*
	181	* Used as a container for task counters and CPU counters as well:
	182	*/
	183	struct perf_counter_context {
	184	#ifdef CONFIG_PERF_COUNTERS
	185	/*
	186	* Protect the list of counters:
	187	*/
	188	spinlock_t lock;
04289bb9 IM	189
04289bb9 IM	190	struct list_head counter_list;
0793a61d TG	191	int nr_counters;
	192	int nr_active;
	193	struct task_struct *task;
	194	#endif
	195	};
	196
	197	/**
	198	* struct perf_counter_cpu_context - per cpu counter context structure
	199	*/
	200	struct perf_cpu_context {
	201	struct perf_counter_context ctx;
	202	struct perf_counter_context *task_ctx;
	203	int active_oncpu;
	204	int max_pertask;
	205	};
	206
	207	/*
	208	* Set by architecture code:
	209	*/
	210	extern int perf_max_counters;
	211
	212	#ifdef CONFIG_PERF_COUNTERS
5c92d124	213	extern const struct hw_perf_counter_ops *
621a01ea IM	214	hw_perf_counter_init(struct perf_counter *counter);
621a01ea IM	215
0793a61d TG	216	extern void perf_counter_task_sched_in(struct task_struct *task, int cpu);
	217	extern void perf_counter_task_sched_out(struct task_struct *task, int cpu);
	218	extern void perf_counter_task_tick(struct task_struct *task, int cpu);
	219	extern void perf_counter_init_task(struct task_struct *task);
	220	extern void perf_counter_notify(struct pt_regs *regs);
	221	extern void perf_counter_print_debug(void);
01b2838c IM	222	extern u64 hw_perf_save_disable(void);
01b2838c IM	223	extern void hw_perf_restore(u64 ctrl);
1d1c7ddb IM	224	extern int perf_counter_task_disable(void);
1d1c7ddb IM	225	extern int perf_counter_task_enable(void);
5c92d124	226
0793a61d TG	227	#else
	228	static inline void
	229	perf_counter_task_sched_in(struct task_struct *task, int cpu) { }
	230	static inline void
	231	perf_counter_task_sched_out(struct task_struct *task, int cpu) { }
	232	static inline void
	233	perf_counter_task_tick(struct task_struct *task, int cpu) { }
	234	static inline void perf_counter_init_task(struct task_struct *task) { }
	235	static inline void perf_counter_notify(struct pt_regs *regs) { }
	236	static inline void perf_counter_print_debug(void) { }
01b2838c IM	237	static inline void hw_perf_restore(u64 ctrl) { }
01b2838c IM	238	static inline u64 hw_perf_save_disable(void) { return 0; }
1d1c7ddb IM	239	static inline int perf_counter_task_disable(void) { return -EINVAL; }
1d1c7ddb IM	240	static inline int perf_counter_task_enable(void) { return -EINVAL; }
0793a61d TG	241	#endif
	242
	243	#endif /* _LINUX_PERF_COUNTER_H */