[deliverable/linux.git] / drivers / oprofile / cpu_buffer.h

/**
 * @file cpu_buffer.h
 *
 * @remark Copyright 2002-2009 OProfile authors
 * @remark Read the file COPYING
 *
 * @author John Levon <levon@movementarian.org>
 * @author Robert Richter <robert.richter@amd.com>
 */

#ifndef OPROFILE_CPU_BUFFER_H
#define OPROFILE_CPU_BUFFER_H

#include <linux/types.h>
#include <linux/spinlock.h>
#include <linux/workqueue.h>
#include <linux/cache.h>
#include <linux/sched.h>
#include <linux/ring_buffer.h>

struct task_struct;

int alloc_cpu_buffers(void);
void free_cpu_buffers(void);

void start_cpu_work(void);
void end_cpu_work(void);

/* CPU buffer is composed of such entries (which are
 * also used for context switch notes)
 */
struct op_sample {
	unsigned long eip;
	unsigned long event;
	unsigned long data[0];
};

struct op_entry;

struct oprofile_cpu_buffer {
	unsigned long buffer_size;
	struct task_struct *last_task;
	int last_is_kernel;
	int tracing;
	unsigned long sample_received;
	unsigned long sample_lost_overflow;
	unsigned long backtrace_aborted;
	unsigned long sample_invalid_eip;
	int cpu;
	struct delayed_work work;
};

DECLARE_PER_CPU(struct oprofile_cpu_buffer, cpu_buffer);

/*
 * Resets the cpu buffer to a sane state.
 *
 * reset these to invalid values; the next sample collected will
 * populate the buffer with proper values to initialize the buffer
 */
static inline void op_cpu_buffer_reset(int cpu)
{
	struct oprofile_cpu_buffer *cpu_buf = &per_cpu(cpu_buffer, cpu);

	cpu_buf->last_is_kernel = -1;
	cpu_buf->last_task = NULL;
}

struct op_sample
*op_cpu_buffer_write_reserve(struct op_entry *entry, unsigned long size);
int op_cpu_buffer_write_commit(struct op_entry *entry);
struct op_sample *op_cpu_buffer_read_entry(struct op_entry *entry, int cpu);
unsigned long op_cpu_buffer_entries(int cpu);

/* returns the remaining free size of data in the entry */
static inline
int op_cpu_buffer_add_data(struct op_entry *entry, unsigned long val)
{
	if (!entry->size)
		return 0;
	*entry->data = val;
	entry->size--;
	entry->data++;
	return entry->size;
}

/* returns the size of data in the entry */
static inline
int op_cpu_buffer_get_size(struct op_entry *entry)
{
	return entry->size;
}

/* returns 0 if empty or the size of data including the current value */
static inline
int op_cpu_buffer_get_data(struct op_entry *entry, unsigned long *val)
{
	int size = entry->size;
	if (!size)
		return 0;
	*val = *entry->data;
	entry->size--;
	entry->data++;
	return size;
}

/* extra data flags */
#define KERNEL_CTX_SWITCH	(1UL << 0)
#define IS_KERNEL		(1UL << 1)
#define TRACE_BEGIN		(1UL << 2)
#define USER_CTX_SWITCH		(1UL << 3)

#endif /* OPROFILE_CPU_BUFFER_H */
Commit	Line	Data
1da177e4 LT	1	/**
	2	* @file cpu_buffer.h
	3	*
2cc28b9f	4	* @remark Copyright 2002-2009 OProfile authors
1da177e4 LT	5	* @remark Read the file COPYING
	6	*
	7	* @author John Levon <levon@movementarian.org>
2cc28b9f	8	* @author Robert Richter <robert.richter@amd.com>
1da177e4 LT	9	*/
	10
	11	#ifndef OPROFILE_CPU_BUFFER_H
	12	#define OPROFILE_CPU_BUFFER_H
	13
	14	#include <linux/types.h>
	15	#include <linux/spinlock.h>
	16	#include <linux/workqueue.h>
	17	#include <linux/cache.h>
608dfddd	18	#include <linux/sched.h>
6dad828b	19	#include <linux/ring_buffer.h>
6a18037d	20
1da177e4	21	struct task_struct;
6a18037d	22
1da177e4 LT	23	int alloc_cpu_buffers(void);
	24	void free_cpu_buffers(void);
	25
	26	void start_cpu_work(void);
	27	void end_cpu_work(void);
	28
	29	/* CPU buffer is composed of such entries (which are
	30	* also used for context switch notes)
	31	*/
	32	struct op_sample {
	33	unsigned long eip;
	34	unsigned long event;
2cc28b9f	35	unsigned long data[0];
1da177e4	36	};
6a18037d	37
14f0ca8e	38	struct op_entry;
6dad828b	39
1da177e4	40	struct oprofile_cpu_buffer {
1da177e4	41	unsigned long buffer_size;
25ad2913	42	struct task_struct *last_task;
1da177e4 LT	43	int last_is_kernel;
1da177e4 LT	44	int tracing;
1da177e4 LT	45	unsigned long sample_received;
	46	unsigned long sample_lost_overflow;
	47	unsigned long backtrace_aborted;
df9d177a	48	unsigned long sample_invalid_eip;
1da177e4	49	int cpu;
c4028958	50	struct delayed_work work;
8b8b4988	51	};
1da177e4	52
608dfddd	53	DECLARE_PER_CPU(struct oprofile_cpu_buffer, cpu_buffer);
1da177e4	54
fbc9bf9f RR	55	/*
	56	* Resets the cpu buffer to a sane state.
	57	*
	58	* reset these to invalid values; the next sample collected will
	59	* populate the buffer with proper values to initialize the buffer
	60	*/
6d2c53f3	61	static inline void op_cpu_buffer_reset(int cpu)
fbc9bf9f RR	62	{
	63	struct oprofile_cpu_buffer *cpu_buf = &per_cpu(cpu_buffer, cpu);
	64
	65	cpu_buf->last_is_kernel = -1;
	66	cpu_buf->last_task = NULL;
	67	}
1da177e4	68
2cc28b9f RR	69	struct op_sample
2cc28b9f RR	70	op_cpu_buffer_write_reserve(struct op_entry entry, unsigned long size);
9966718d	71	int op_cpu_buffer_write_commit(struct op_entry *entry);
2d87b14c	72	struct op_sample op_cpu_buffer_read_entry(struct op_entry entry, int cpu);
9966718d	73	unsigned long op_cpu_buffer_entries(int cpu);
bf589e32	74
d9928c25 RR	75	/* returns the remaining free size of data in the entry */
	76	static inline
	77	int op_cpu_buffer_add_data(struct op_entry *entry, unsigned long val)
	78	{
	79	if (!entry->size)
	80	return 0;
	81	*entry->data = val;
	82	entry->size--;
	83	entry->data++;
	84	return entry->size;
	85	}
	86
bd7dc46f RR	87	/* returns the size of data in the entry */
	88	static inline
	89	int op_cpu_buffer_get_size(struct op_entry *entry)
	90	{
	91	return entry->size;
	92	}
	93
	94	/* returns 0 if empty or the size of data including the current value */
	95	static inline
	96	int op_cpu_buffer_get_data(struct op_entry entry, unsigned long val)
	97	{
	98	int size = entry->size;
	99	if (!size)
	100	return 0;
	101	val = entry->data;
	102	entry->size--;
	103	entry->data++;
	104	return size;
	105	}
	106
ae735e99 RR	107	/* extra data flags */
	108	#define KERNEL_CTX_SWITCH (1UL << 0)
	109	#define IS_KERNEL (1UL << 1)
	110	#define TRACE_BEGIN (1UL << 2)
	111	#define USER_CTX_SWITCH (1UL << 3)
1da177e4 LT	112
1da177e4 LT	113	#endif /* OPROFILE_CPU_BUFFER_H */