[lttng-ust.git] / libringbuffer / backend_types.h

#ifndef _LINUX_RING_BUFFER_BACKEND_TYPES_H
#define _LINUX_RING_BUFFER_BACKEND_TYPES_H

/*
 * linux/ringbuffer/backend_types.h
 *
 * Copyright (C) 2008-2010 - Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
 *
 * Ring buffer backend (types).
 *
 * Dual LGPL v2.1/GPL v2 license.
 */

#include "shm_internal.h"

struct lib_ring_buffer_backend_pages {
	unsigned long mmap_offset;	/* offset of the subbuffer in mmap */
	union v_atomic records_commit;	/* current records committed count */
	union v_atomic records_unread;	/* records to read */
	unsigned long data_size;	/* Amount of data to read from subbuf */
	DECLARE_SHMP(char, p);		/* Backing memory map */
};

struct lib_ring_buffer_backend_subbuffer {
	/* Identifier for subbuf backend pages. Exchanged atomically. */
	unsigned long id;		/* backend subbuffer identifier */
};

/*
 * Forward declaration of frontend-specific channel and ring_buffer.
 */
struct channel;
struct lib_ring_buffer;

struct lib_ring_buffer_backend_pages_shmp {
	DECLARE_SHMP(struct lib_ring_buffer_backend_pages, shmp);
};

struct lib_ring_buffer_backend {
	/* Array of ring_buffer_backend_subbuffer for writer */
	DECLARE_SHMP(struct lib_ring_buffer_backend_subbuffer, buf_wsb);
	/* ring_buffer_backend_subbuffer for reader */
	struct lib_ring_buffer_backend_subbuffer buf_rsb;
	/*
	 * Pointer array of backend pages, for whole buffer.
	 * Indexed by ring_buffer_backend_subbuffer identifier (id) index.
	 */
	DECLARE_SHMP(struct lib_ring_buffer_backend_pages_shmp, array);
	DECLARE_SHMP(char, memory_map);	/* memory mapping */

	DECLARE_SHMP(struct channel, chan);	/* Associated channel */
	int cpu;			/* This buffer's cpu. -1 if global. */
	union v_atomic records_read;	/* Number of records read */
	unsigned int allocated:1;	/* Bool: is buffer allocated ? */
};

struct lib_ring_buffer_shmp {
	DECLARE_SHMP(struct lib_ring_buffer, shmp); /* Channel per-cpu buffers */
};

struct channel_backend {
	unsigned long buf_size;		/* Size of the buffer */
	unsigned long subbuf_size;	/* Sub-buffer size */
	unsigned int subbuf_size_order;	/* Order of sub-buffer size */
	unsigned int num_subbuf_order;	/*
					 * Order of number of sub-buffers/buffer
					 * for writer.
					 */
	unsigned int buf_size_order;	/* Order of buffer size */
	int extra_reader_sb:1;		/* Bool: has extra reader subbuffer */
	unsigned long num_subbuf;	/* Number of sub-buffers for writer */
	u64 start_tsc;			/* Channel creation TSC value */
	void *priv;			/* Client-specific information */
	struct lib_ring_buffer_config config; /* Ring buffer configuration */
	char name[NAME_MAX];		/* Channel name */
	struct lib_ring_buffer_shmp buf[];
};

#endif /* _LINUX_RING_BUFFER_BACKEND_TYPES_H */
Commit	Line	Data
852c2936 MD	1	#ifndef _LINUX_RING_BUFFER_BACKEND_TYPES_H
	2	#define _LINUX_RING_BUFFER_BACKEND_TYPES_H
	3
	4	/*
	5	* linux/ringbuffer/backend_types.h
	6	*
	7	* Copyright (C) 2008-2010 - Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
	8	*
	9	* Ring buffer backend (types).
	10	*
	11	* Dual LGPL v2.1/GPL v2 license.
	12	*/
	13
1d498196	14	#include "shm_internal.h"
852c2936 MD	15
	16	struct lib_ring_buffer_backend_pages {
	17	unsigned long mmap_offset; /* offset of the subbuffer in mmap */
	18	union v_atomic records_commit; /* current records committed count */
	19	union v_atomic records_unread; /* records to read */
	20	unsigned long data_size; /* Amount of data to read from subbuf */
a6352fd4	21	DECLARE_SHMP(char, p); /* Backing memory map */
852c2936 MD	22	};
	23
	24	struct lib_ring_buffer_backend_subbuffer {
	25	/* Identifier for subbuf backend pages. Exchanged atomically. */
	26	unsigned long id; /* backend subbuffer identifier */
	27	};
	28
	29	/*
	30	* Forward declaration of frontend-specific channel and ring_buffer.
	31	*/
	32	struct channel;
	33	struct lib_ring_buffer;
	34
1d498196 MD	35	struct lib_ring_buffer_backend_pages_shmp {
	36	DECLARE_SHMP(struct lib_ring_buffer_backend_pages, shmp);
	37	};
	38
852c2936 MD	39	struct lib_ring_buffer_backend {
852c2936 MD	40	/* Array of ring_buffer_backend_subbuffer for writer */
a6352fd4	41	DECLARE_SHMP(struct lib_ring_buffer_backend_subbuffer, buf_wsb);
852c2936 MD	42	/* ring_buffer_backend_subbuffer for reader */
	43	struct lib_ring_buffer_backend_subbuffer buf_rsb;
	44	/*
	45	* Pointer array of backend pages, for whole buffer.
	46	* Indexed by ring_buffer_backend_subbuffer identifier (id) index.
	47	*/
1d498196	48	DECLARE_SHMP(struct lib_ring_buffer_backend_pages_shmp, array);
a6352fd4	49	DECLARE_SHMP(char, memory_map); /* memory mapping */
852c2936	50
a6352fd4	51	DECLARE_SHMP(struct channel, chan); /* Associated channel */
852c2936 MD	52	int cpu; /* This buffer's cpu. -1 if global. */
	53	union v_atomic records_read; /* Number of records read */
	54	unsigned int allocated:1; /* Bool: is buffer allocated ? */
	55	};
	56
1d498196 MD	57	struct lib_ring_buffer_shmp {
	58	DECLARE_SHMP(struct lib_ring_buffer, shmp); /* Channel per-cpu buffers */
	59	};
	60
852c2936 MD	61	struct channel_backend {
	62	unsigned long buf_size; /* Size of the buffer */
	63	unsigned long subbuf_size; /* Sub-buffer size */
	64	unsigned int subbuf_size_order; /* Order of sub-buffer size */
	65	unsigned int num_subbuf_order; /*
	66	* Order of number of sub-buffers/buffer
	67	* for writer.
	68	*/
	69	unsigned int buf_size_order; /* Order of buffer size */
	70	int extra_reader_sb:1; /* Bool: has extra reader subbuffer */
852c2936 MD	71	unsigned long num_subbuf; /* Number of sub-buffers for writer */
	72	u64 start_tsc; /* Channel creation TSC value */
	73	void priv; / Client-specific information */
193183fb	74	struct lib_ring_buffer_config config; /* Ring buffer configuration */
852c2936	75	char name[NAME_MAX]; /* Channel name */
1d498196	76	struct lib_ring_buffer_shmp buf[];
852c2936 MD	77	};
	78
	79	#endif /* _LINUX_RING_BUFFER_BACKEND_TYPES_H */