perf_counter.h 6.1 KB
Newer Older
T
Thomas Gleixner 已提交
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16
/*
 *  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>
17
#include <asm/perf_counter.h>
T
Thomas Gleixner 已提交
18 19 20 21 22 23 24 25 26 27

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

struct task_struct;

/*
I
Ingo Molnar 已提交
28 29 30 31 32 33
 * User-space ABI bits:
 */

/*
 * Generalized performance counter event types, used by the hw_event.type
 * parameter of the sys_perf_counter_open() syscall:
T
Thomas Gleixner 已提交
34 35 36
 */
enum hw_event_types {
	/*
I
Ingo Molnar 已提交
37
	 * Common hardware events, generalized by the kernel:
T
Thomas Gleixner 已提交
38
	 */
I
Ingo Molnar 已提交
39 40 41 42 43 44 45
	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,

46 47
	PERF_HW_EVENTS_MAX		=  6,

I
Ingo Molnar 已提交
48 49 50 51 52 53 54 55
	/*
	 * 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,
56 57
	PERF_COUNT_PAGE_FAULTS		= -3,
	PERF_COUNT_CONTEXT_SWITCHES	= -4,
58 59 60
	PERF_COUNT_CPU_MIGRATIONS	= -5,

	PERF_SW_EVENTS_MIN		= -6,
T
Thomas Gleixner 已提交
61 62 63 64 65
};

/*
 * IRQ-notification data record type:
 */
I
Ingo Molnar 已提交
66 67 68 69
enum perf_counter_record_type {
	PERF_RECORD_SIMPLE		=  0,
	PERF_RECORD_IRQ			=  1,
	PERF_RECORD_GROUP		=  2,
T
Thomas Gleixner 已提交
70 71
};

I
Ingo Molnar 已提交
72 73 74 75
/*
 * Hardware event to monitor via a performance monitoring counter:
 */
struct perf_counter_hw_event {
76
	s64			type;
I
Ingo Molnar 已提交
77 78 79 80

	u64			irq_period;
	u32			record_type;

81 82 83 84 85
	u32			disabled     :  1, /* off by default      */
				nmi	     :  1, /* NMI sampling        */
				raw	     :  1, /* raw event type      */
				inherit	     :  1, /* children inherit it */
				__reserved_1 : 28;
I
Ingo Molnar 已提交
86 87

	u64			__reserved_2;
88 89
};

I
Ingo Molnar 已提交
90 91 92 93
/*
 * Kernel-internal data types:
 */

T
Thomas Gleixner 已提交
94
/**
I
Ingo Molnar 已提交
95
 * struct hw_perf_counter - performance counter hardware details:
T
Thomas Gleixner 已提交
96 97
 */
struct hw_perf_counter {
98
#ifdef CONFIG_PERF_COUNTERS
I
Ingo Molnar 已提交
99 100 101 102 103
	u64				config;
	unsigned long			config_base;
	unsigned long			counter_base;
	int				nmi;
	unsigned int			idx;
104
	atomic64_t			prev_count;
I
Ingo Molnar 已提交
105
	u64				irq_period;
106 107
	atomic64_t			period_left;
#endif
T
Thomas Gleixner 已提交
108 109 110 111 112
};

/*
 * Hardcoded buffer length limit for now, for IRQ-fed events:
 */
I
Ingo Molnar 已提交
113
#define PERF_DATA_BUFLEN		2048
T
Thomas Gleixner 已提交
114 115 116 117 118

/**
 * struct perf_data - performance counter IRQ data sampling ...
 */
struct perf_data {
I
Ingo Molnar 已提交
119 120 121 122
	int				len;
	int				rd_idx;
	int				overrun;
	u8				data[PERF_DATA_BUFLEN];
T
Thomas Gleixner 已提交
123 124
};

I
Ingo Molnar 已提交
125 126 127 128 129 130
struct perf_counter;

/**
 * struct hw_perf_counter_ops - performance counter hw ops
 */
struct hw_perf_counter_ops {
131
	int (*enable)			(struct perf_counter *counter);
I
Ingo Molnar 已提交
132 133
	void (*disable)			(struct perf_counter *counter);
	void (*read)			(struct perf_counter *counter);
I
Ingo Molnar 已提交
134 135
};

136 137 138 139 140 141 142 143 144
/**
 * 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,
};

145 146
struct file;

T
Thomas Gleixner 已提交
147 148 149 150
/**
 * struct perf_counter - performance counter kernel representation:
 */
struct perf_counter {
151
#ifdef CONFIG_PERF_COUNTERS
152 153 154
	struct list_head		list_entry;
	struct list_head		sibling_list;
	struct perf_counter		*group_leader;
155
	const struct hw_perf_counter_ops *hw_ops;
156

157
	enum perf_counter_active_state	state;
T
Thomas Gleixner 已提交
158
	atomic64_t			count;
159

I
Ingo Molnar 已提交
160
	struct perf_counter_hw_event	hw_event;
T
Thomas Gleixner 已提交
161 162 163 164
	struct hw_perf_counter		hw;

	struct perf_counter_context	*ctx;
	struct task_struct		*task;
165
	struct file			*filp;
T
Thomas Gleixner 已提交
166

167
	struct perf_counter		*parent;
T
Thomas Gleixner 已提交
168 169 170 171 172 173 174 175 176 177 178 179 180 181 182
	/*
	 * 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];
183
#endif
T
Thomas Gleixner 已提交
184 185 186 187 188 189 190 191 192 193 194 195 196
};

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

	struct list_head	counter_list;
T
Thomas Gleixner 已提交
199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220
	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
221
extern const struct hw_perf_counter_ops *
I
Ingo Molnar 已提交
222 223
hw_perf_counter_init(struct perf_counter *counter);

T
Thomas Gleixner 已提交
224 225 226
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);
227 228
extern void perf_counter_init_task(struct task_struct *child);
extern void perf_counter_exit_task(struct task_struct *child);
T
Thomas Gleixner 已提交
229 230
extern void perf_counter_notify(struct pt_regs *regs);
extern void perf_counter_print_debug(void);
231 232
extern u64 hw_perf_save_disable(void);
extern void hw_perf_restore(u64 ctrl);
233 234
extern int perf_counter_task_disable(void);
extern int perf_counter_task_enable(void);
235

T
Thomas Gleixner 已提交
236 237 238 239 240 241 242
#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)		{ }
243 244
static inline void perf_counter_init_task(struct task_struct *child)	{ }
static inline void perf_counter_exit_task(struct task_struct *child)	{ }
T
Thomas Gleixner 已提交
245 246
static inline void perf_counter_notify(struct pt_regs *regs)		{ }
static inline void perf_counter_print_debug(void)			{ }
247 248
static inline void hw_perf_restore(u64 ctrl)			{ }
static inline u64 hw_perf_save_disable(void)		      { return 0; }
249 250
static inline int perf_counter_task_disable(void)	{ return -EINVAL; }
static inline int perf_counter_task_enable(void)	{ return -EINVAL; }
T
Thomas Gleixner 已提交
251 252 253
#endif

#endif /* _LINUX_PERF_COUNTER_H */