[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 ring_buffer_event *event;
	struct op_sample *sample;
	unsigned long irq_flags;
	unsigned long size;
	unsigned long *data;
};

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;
}

/* 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)
#define IBS_FETCH_BEGIN		(1UL << 4)
#define IBS_OP_BEGIN		(1UL << 5)

#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
6dad828b RR	38	struct op_entry {
	39	struct ring_buffer_event *event;
	40	struct op_sample *sample;
	41	unsigned long irq_flags;
2cc28b9f RR	42	unsigned long size;
2cc28b9f RR	43	unsigned long *data;
6dad828b RR	44	};
6dad828b RR	45
1da177e4	46	struct oprofile_cpu_buffer {
1da177e4	47	unsigned long buffer_size;
25ad2913	48	struct task_struct *last_task;
1da177e4 LT	49	int last_is_kernel;
1da177e4 LT	50	int tracing;
1da177e4 LT	51	unsigned long sample_received;
	52	unsigned long sample_lost_overflow;
	53	unsigned long backtrace_aborted;
df9d177a	54	unsigned long sample_invalid_eip;
1da177e4	55	int cpu;
c4028958	56	struct delayed_work work;
8b8b4988	57	};
1da177e4	58
608dfddd	59	DECLARE_PER_CPU(struct oprofile_cpu_buffer, cpu_buffer);
1da177e4	60
fbc9bf9f RR	61	/*
	62	* Resets the cpu buffer to a sane state.
	63	*
	64	* reset these to invalid values; the next sample collected will
	65	* populate the buffer with proper values to initialize the buffer
	66	*/
6d2c53f3	67	static inline void op_cpu_buffer_reset(int cpu)
fbc9bf9f RR	68	{
	69	struct oprofile_cpu_buffer *cpu_buf = &per_cpu(cpu_buffer, cpu);
	70
	71	cpu_buf->last_is_kernel = -1;
	72	cpu_buf->last_task = NULL;
	73	}
1da177e4	74
2cc28b9f RR	75	struct op_sample
2cc28b9f RR	76	op_cpu_buffer_write_reserve(struct op_entry entry, unsigned long size);
9966718d	77	int op_cpu_buffer_write_commit(struct op_entry *entry);
2d87b14c	78	struct op_sample op_cpu_buffer_read_entry(struct op_entry entry, int cpu);
9966718d	79	unsigned long op_cpu_buffer_entries(int cpu);
bf589e32	80
d9928c25 RR	81	/* returns the remaining free size of data in the entry */
	82	static inline
	83	int op_cpu_buffer_add_data(struct op_entry *entry, unsigned long val)
	84	{
	85	if (!entry->size)
	86	return 0;
	87	*entry->data = val;
	88	entry->size--;
	89	entry->data++;
	90	return entry->size;
	91	}
	92
ae735e99 RR	93	/* extra data flags */
	94	#define KERNEL_CTX_SWITCH (1UL << 0)
	95	#define IS_KERNEL (1UL << 1)
	96	#define TRACE_BEGIN (1UL << 2)
	97	#define USER_CTX_SWITCH (1UL << 3)
	98	#define IBS_FETCH_BEGIN (1UL << 4)
	99	#define IBS_OP_BEGIN (1UL << 5)
1da177e4 LT	100
1da177e4 LT	101	#endif /* OPROFILE_CPU_BUFFER_H */