[lttng-ust.git] / liblttng-ust / lttng-ring-buffer-metadata-client.h

/*
 * lttng-ring-buffer-client.h
 *
 * LTTng lib ring buffer client template.
 *
 * Copyright (C) 2010-2012 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; only
 * version 2.1 of the License.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 */

#include <stdint.h>
#include <lttng/ust-events.h>
#include "lttng/bitfield.h"
#include "lttng-tracer.h"
#include "../libringbuffer/frontend_types.h"

struct metadata_packet_header {
	uint32_t magic;			/* 0x75D11D57 */
	uint8_t  uuid[LTTNG_UST_UUID_LEN]; /* Unique Universal Identifier */
	uint32_t checksum;		/* 0 if unused */
	uint32_t content_size;		/* in bits */
	uint32_t packet_size;		/* in bits */
	uint8_t  compression_scheme;	/* 0 if unused */
	uint8_t  encryption_scheme;	/* 0 if unused */
	uint8_t  checksum_scheme;	/* 0 if unused */
	uint8_t  major;			/* CTF spec major version number */
	uint8_t  minor;			/* CTF spec minor version number */
	uint8_t  header_end[0];
};

struct metadata_record_header {
	uint8_t header_end[0];		/* End of header */
};

static const struct lttng_ust_lib_ring_buffer_config client_config;

static inline uint64_t lib_ring_buffer_clock_read(struct channel *chan)
{
	return 0;
}

static inline
size_t record_header_size(const struct lttng_ust_lib_ring_buffer_config *config,
				 struct channel *chan, size_t offset,
				 size_t *pre_header_padding,
				 struct lttng_ust_lib_ring_buffer_ctx *ctx)
{
	return 0;
}

#include "../libringbuffer/api.h"
#include "lttng-rb-clients.h"

static uint64_t client_ring_buffer_clock_read(struct channel *chan)
{
	return 0;
}

static
size_t client_record_header_size(const struct lttng_ust_lib_ring_buffer_config *config,
				 struct channel *chan, size_t offset,
				 size_t *pre_header_padding,
				 struct lttng_ust_lib_ring_buffer_ctx *ctx)
{
	return 0;
}

/**
 * client_packet_header_size - called on buffer-switch to a new sub-buffer
 *
 * Return header size without padding after the structure. Don't use packed
 * structure because gcc generates inefficient code on some architectures
 * (powerpc, mips..)
 */
static size_t client_packet_header_size(void)
{
	return offsetof(struct metadata_packet_header, header_end);
}

static void client_buffer_begin(struct lttng_ust_lib_ring_buffer *buf, uint64_t tsc,
				unsigned int subbuf_idx,
				struct lttng_ust_shm_handle *handle)
{
	struct channel *chan = shmp(handle, buf->backend.chan);
	struct metadata_packet_header *header =
		(struct metadata_packet_header *)
			lib_ring_buffer_offset_address(&buf->backend,
				subbuf_idx * chan->backend.subbuf_size,
				handle);
	struct lttng_channel *lttng_chan = channel_get_private(chan);

	assert(header);
	if (!header)
		return;
	header->magic = TSDL_MAGIC_NUMBER;
	memcpy(header->uuid, lttng_chan->uuid, sizeof(lttng_chan->uuid));
	header->checksum = 0;		/* 0 if unused */
	header->content_size = 0xFFFFFFFF; /* in bits, for debugging */
	header->packet_size = 0xFFFFFFFF;  /* in bits, for debugging */
	header->compression_scheme = 0;	/* 0 if unused */
	header->encryption_scheme = 0;	/* 0 if unused */
	header->checksum_scheme = 0;	/* 0 if unused */
	header->major = CTF_SPEC_MAJOR;
	header->minor = CTF_SPEC_MINOR;
}

/*
 * offset is assumed to never be 0 here : never deliver a completely empty
 * subbuffer. data_size is between 1 and subbuf_size.
 */
static void client_buffer_end(struct lttng_ust_lib_ring_buffer *buf, uint64_t tsc,
			      unsigned int subbuf_idx, unsigned long data_size,
			      struct lttng_ust_shm_handle *handle)
{
	struct channel *chan = shmp(handle, buf->backend.chan);
	struct metadata_packet_header *header =
		(struct metadata_packet_header *)
			lib_ring_buffer_offset_address(&buf->backend,
				subbuf_idx * chan->backend.subbuf_size,
				handle);
	unsigned long records_lost = 0;

	assert(header);
	if (!header)
		return;
	header->content_size = data_size * CHAR_BIT;		/* in bits */
	header->packet_size = PAGE_ALIGN(data_size) * CHAR_BIT; /* in bits */
	/*
	 * We do not care about the records lost count, because the metadata
	 * channel waits and retry.
	 */
	(void) lib_ring_buffer_get_records_lost_full(&client_config, buf);
	records_lost += lib_ring_buffer_get_records_lost_wrap(&client_config, buf);
	records_lost += lib_ring_buffer_get_records_lost_big(&client_config, buf);
	WARN_ON_ONCE(records_lost != 0);
}

static int client_buffer_create(struct lttng_ust_lib_ring_buffer *buf, void *priv,
				int cpu, const char *name,
				struct lttng_ust_shm_handle *handle)
{
	return 0;
}

static void client_buffer_finalize(struct lttng_ust_lib_ring_buffer *buf,
				   void *priv, int cpu,
				   struct lttng_ust_shm_handle *handle)
{
}

static const
struct lttng_ust_client_lib_ring_buffer_client_cb client_cb = {
	.parent = {
		.ring_buffer_clock_read = client_ring_buffer_clock_read,
		.record_header_size = client_record_header_size,
		.subbuffer_header_size = client_packet_header_size,
		.buffer_begin = client_buffer_begin,
		.buffer_end = client_buffer_end,
		.buffer_create = client_buffer_create,
		.buffer_finalize = client_buffer_finalize,
	},
};

static const struct lttng_ust_lib_ring_buffer_config client_config = {
	.cb.ring_buffer_clock_read = client_ring_buffer_clock_read,
	.cb.record_header_size = client_record_header_size,
	.cb.subbuffer_header_size = client_packet_header_size,
	.cb.buffer_begin = client_buffer_begin,
	.cb.buffer_end = client_buffer_end,
	.cb.buffer_create = client_buffer_create,
	.cb.buffer_finalize = client_buffer_finalize,

	.tsc_bits = 0,
	.alloc = RING_BUFFER_ALLOC_GLOBAL,
	.sync = RING_BUFFER_SYNC_GLOBAL,
	.mode = RING_BUFFER_MODE_TEMPLATE,
	.backend = RING_BUFFER_PAGE,
	.output = RING_BUFFER_MMAP,
	.oops = RING_BUFFER_OOPS_CONSISTENCY,
	.ipi = RING_BUFFER_NO_IPI_BARRIER,
	.wakeup = RING_BUFFER_WAKEUP_BY_WRITER,
	.client_type = LTTNG_CLIENT_TYPE,

	 .cb_ptr = &client_cb.parent,
};

const struct lttng_ust_client_lib_ring_buffer_client_cb *LTTNG_CLIENT_CALLBACKS = &client_cb;

static
struct lttng_channel *_channel_create(const char *name,
				void *buf_addr,
				size_t subbuf_size, size_t num_subbuf,
				unsigned int switch_timer_interval,
				unsigned int read_timer_interval,
				unsigned char *uuid,
				uint32_t chan_id,
				const int *stream_fds, int nr_stream_fds,
				int64_t blocking_timeout)
{
	struct lttng_channel chan_priv_init;
	struct lttng_ust_shm_handle *handle;
	struct lttng_channel *lttng_chan;
	void *priv;

	memset(&chan_priv_init, 0, sizeof(chan_priv_init));
	memcpy(chan_priv_init.uuid, uuid, LTTNG_UST_UUID_LEN);
	chan_priv_init.id = chan_id;
	handle = channel_create(&client_config, name,
			&priv, __alignof__(struct lttng_channel),
			sizeof(struct lttng_channel),
			&chan_priv_init,
			buf_addr, subbuf_size, num_subbuf,
			switch_timer_interval, read_timer_interval,
			stream_fds, nr_stream_fds, blocking_timeout);
	if (!handle)
		return NULL;
	lttng_chan = priv;
	lttng_chan->handle = handle;
	lttng_chan->chan = shmp(handle, handle->chan);
	return lttng_chan;
}

static
void lttng_channel_destroy(struct lttng_channel *chan)
{
	channel_destroy(chan->chan, chan->handle, 1);
}

static
int lttng_event_reserve(struct lttng_ust_lib_ring_buffer_ctx *ctx, uint32_t event_id)
{
	int ret;

	ret = lib_ring_buffer_reserve(&client_config, ctx);
	if (ret)
		return ret;
	if (caa_likely(ctx->ctx_len
			>= sizeof(struct lttng_ust_lib_ring_buffer_ctx))) {
		if (lib_ring_buffer_backend_get_pages(&client_config, ctx,
				&ctx->backend_pages))
			return -EPERM;
	}
	return 0;
}

static
void lttng_event_commit(struct lttng_ust_lib_ring_buffer_ctx *ctx)
{
	lib_ring_buffer_commit(&client_config, ctx);
}

static
void lttng_event_write(struct lttng_ust_lib_ring_buffer_ctx *ctx, const void *src,
		     size_t len)
{
	lib_ring_buffer_write(&client_config, ctx, src, len);
}

static
size_t lttng_packet_avail_size(struct channel *chan, struct lttng_ust_shm_handle *handle)
{
	unsigned long o_begin;
	struct lttng_ust_lib_ring_buffer *buf;

	buf = shmp(handle, chan->backend.buf[0].shmp);	/* Only for global buffer ! */
	o_begin = v_read(&client_config, &buf->offset);
	if (subbuf_offset(o_begin, chan) != 0) {
		return chan->backend.subbuf_size - subbuf_offset(o_begin, chan);
	} else {
		return chan->backend.subbuf_size - subbuf_offset(o_begin, chan)
			- sizeof(struct metadata_packet_header);
	}
}

#if 0
static
wait_queue_head_t *lttng_get_reader_wait_queue(struct channel *chan)
{
	return &chan->read_wait;
}

static
wait_queue_head_t *lttng_get_hp_wait_queue(struct channel *chan)
{
	return &chan->hp_wait;
}
#endif //0

static
int lttng_is_finalized(struct channel *chan)
{
	return lib_ring_buffer_channel_is_finalized(chan);
}

static
int lttng_is_disabled(struct channel *chan)
{
	return lib_ring_buffer_channel_is_disabled(chan);
}

static
int lttng_flush_buffer(struct channel *chan, struct lttng_ust_shm_handle *handle)
{
	struct lttng_ust_lib_ring_buffer *buf;
	int shm_fd, wait_fd, wakeup_fd;
	uint64_t memory_map_size;

	buf = channel_get_ring_buffer(&client_config, chan,
			0, handle, &shm_fd, &wait_fd, &wakeup_fd,
			&memory_map_size);
	lib_ring_buffer_switch(&client_config, buf,
			SWITCH_ACTIVE, handle);
	return 0;
}

static struct lttng_transport lttng_relay_transport = {
	.name = "relay-" RING_BUFFER_MODE_TEMPLATE_STRING "-mmap",
	.ops = {
		.channel_create = _channel_create,
		.channel_destroy = lttng_channel_destroy,
		.event_reserve = lttng_event_reserve,
		.event_commit = lttng_event_commit,
		.event_write = lttng_event_write,
		.packet_avail_size = lttng_packet_avail_size,
		//.get_reader_wait_queue = lttng_get_reader_wait_queue,
		//.get_hp_wait_queue = lttng_get_hp_wait_queue,
		.is_finalized = lttng_is_finalized,
		.is_disabled = lttng_is_disabled,
		.flush_buffer = lttng_flush_buffer,
	},
	.client_config = &client_config,
};

void RING_BUFFER_MODE_TEMPLATE_INIT(void)
{
	DBG("LTT : ltt ring buffer client \"%s\" init\n",
		"relay-" RING_BUFFER_MODE_TEMPLATE_STRING "-mmap");
	lttng_transport_register(&lttng_relay_transport);
}

void RING_BUFFER_MODE_TEMPLATE_EXIT(void)
{
	DBG("LTT : ltt ring buffer client \"%s\" exit\n",
		"relay-" RING_BUFFER_MODE_TEMPLATE_STRING "-mmap");
	lttng_transport_unregister(&lttng_relay_transport);
}
Commit	Line	Data
3d1fc7fd	1	/*
7dd08bec	2	* lttng-ring-buffer-client.h
3d1fc7fd	3	*
3d1fc7fd MD	4	* LTTng lib ring buffer client template.
3d1fc7fd MD	5	*
e92f3e28 MD	6	* Copyright (C) 2010-2012 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
	7	*
	8	* This library is free software; you can redistribute it and/or
	9	* modify it under the terms of the GNU Lesser General Public
	10	* License as published by the Free Software Foundation; only
	11	* version 2.1 of the License.
	12	*
	13	* This library is distributed in the hope that it will be useful,
	14	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	15	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
	16	* Lesser General Public License for more details.
	17	*
	18	* You should have received a copy of the GNU Lesser General Public
	19	* License along with this library; if not, write to the Free Software
	20	* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
3d1fc7fd MD	21	*/
3d1fc7fd MD	22
9f3fdbc6	23	#include <stdint.h>
4318ae1b MD	24	#include <lttng/ust-events.h>
4318ae1b MD	25	#include "lttng/bitfield.h"
7dd08bec	26	#include "lttng-tracer.h"
9f3fdbc6	27	#include "../libringbuffer/frontend_types.h"
3d1fc7fd MD	28
	29	struct metadata_packet_header {
	30	uint32_t magic; /* 0x75D11D57 */
19d8b1b3	31	uint8_t uuid[LTTNG_UST_UUID_LEN]; /* Unique Universal Identifier */
3d1fc7fd MD	32	uint32_t checksum; /* 0 if unused */
	33	uint32_t content_size; /* in bits */
	34	uint32_t packet_size; /* in bits */
	35	uint8_t compression_scheme; /* 0 if unused */
	36	uint8_t encryption_scheme; /* 0 if unused */
	37	uint8_t checksum_scheme; /* 0 if unused */
8a98a75d MD	38	uint8_t major; /* CTF spec major version number */
8a98a75d MD	39	uint8_t minor; /* CTF spec minor version number */
3d1fc7fd MD	40	uint8_t header_end[0];
	41	};
	42
	43	struct metadata_record_header {
	44	uint8_t header_end[0]; /* End of header */
	45	};
	46
4cfec15c	47	static const struct lttng_ust_lib_ring_buffer_config client_config;
3d1fc7fd	48
23c8854a	49	static inline uint64_t lib_ring_buffer_clock_read(struct channel *chan)
3d1fc7fd MD	50	{
	51	return 0;
	52	}
	53
	54	static inline
8ca68914	55	size_t record_header_size(const struct lttng_ust_lib_ring_buffer_config *config,
3d1fc7fd MD	56	struct channel *chan, size_t offset,
3d1fc7fd MD	57	size_t *pre_header_padding,
4cfec15c	58	struct lttng_ust_lib_ring_buffer_ctx *ctx)
3d1fc7fd MD	59	{
	60	return 0;
	61	}
	62
9f3fdbc6	63	#include "../libringbuffer/api.h"
82b9bde8	64	#include "lttng-rb-clients.h"
3d1fc7fd	65
23c8854a	66	static uint64_t client_ring_buffer_clock_read(struct channel *chan)
3d1fc7fd MD	67	{
	68	return 0;
	69	}
	70
	71	static
4cfec15c	72	size_t client_record_header_size(const struct lttng_ust_lib_ring_buffer_config *config,
3d1fc7fd MD	73	struct channel *chan, size_t offset,
3d1fc7fd MD	74	size_t *pre_header_padding,
4cfec15c	75	struct lttng_ust_lib_ring_buffer_ctx *ctx)
3d1fc7fd MD	76	{
	77	return 0;
	78	}
	79
	80	/**
	81	* client_packet_header_size - called on buffer-switch to a new sub-buffer
	82	*
	83	* Return header size without padding after the structure. Don't use packed
	84	* structure because gcc generates inefficient code on some architectures
	85	* (powerpc, mips..)
	86	*/
	87	static size_t client_packet_header_size(void)
	88	{
	89	return offsetof(struct metadata_packet_header, header_end);
	90	}
	91
23c8854a	92	static void client_buffer_begin(struct lttng_ust_lib_ring_buffer *buf, uint64_t tsc,
1d498196	93	unsigned int subbuf_idx,
38fae1d3	94	struct lttng_ust_shm_handle *handle)
3d1fc7fd	95	{
1d498196	96	struct channel *chan = shmp(handle, buf->backend.chan);
3d1fc7fd MD	97	struct metadata_packet_header *header =
	98	(struct metadata_packet_header *)
	99	lib_ring_buffer_offset_address(&buf->backend,
1d498196 MD	100	subbuf_idx * chan->backend.subbuf_size,
1d498196 MD	101	handle);
7dd08bec	102	struct lttng_channel *lttng_chan = channel_get_private(chan);
3d1fc7fd	103
34daae3e MD	104	assert(header);
	105	if (!header)
	106	return;
3d1fc7fd	107	header->magic = TSDL_MAGIC_NUMBER;
7dd08bec	108	memcpy(header->uuid, lttng_chan->uuid, sizeof(lttng_chan->uuid));
3d1fc7fd MD	109	header->checksum = 0; /* 0 if unused */
	110	header->content_size = 0xFFFFFFFF; /* in bits, for debugging */
	111	header->packet_size = 0xFFFFFFFF; /* in bits, for debugging */
	112	header->compression_scheme = 0; /* 0 if unused */
	113	header->encryption_scheme = 0; /* 0 if unused */
	114	header->checksum_scheme = 0; /* 0 if unused */
8a98a75d MD	115	header->major = CTF_SPEC_MAJOR;
8a98a75d MD	116	header->minor = CTF_SPEC_MINOR;
3d1fc7fd MD	117	}
	118
	119	/*
	120	* offset is assumed to never be 0 here : never deliver a completely empty
	121	* subbuffer. data_size is between 1 and subbuf_size.
	122	*/
23c8854a	123	static void client_buffer_end(struct lttng_ust_lib_ring_buffer *buf, uint64_t tsc,
1d498196	124	unsigned int subbuf_idx, unsigned long data_size,
38fae1d3	125	struct lttng_ust_shm_handle *handle)
3d1fc7fd	126	{
1d498196	127	struct channel *chan = shmp(handle, buf->backend.chan);
3d1fc7fd MD	128	struct metadata_packet_header *header =
	129	(struct metadata_packet_header *)
	130	lib_ring_buffer_offset_address(&buf->backend,
1d498196 MD	131	subbuf_idx * chan->backend.subbuf_size,
1d498196 MD	132	handle);
3d1fc7fd MD	133	unsigned long records_lost = 0;
3d1fc7fd MD	134
34daae3e MD	135	assert(header);
	136	if (!header)
	137	return;
3d1fc7fd MD	138	header->content_size = data_size * CHAR_BIT; /* in bits */
3d1fc7fd MD	139	header->packet_size = PAGE_ALIGN(data_size) * CHAR_BIT; /* in bits */
04489ab4 MD	140	/*
	141	* We do not care about the records lost count, because the metadata
	142	* channel waits and retry.
	143	*/
	144	(void) lib_ring_buffer_get_records_lost_full(&client_config, buf);
3d1fc7fd MD	145	records_lost += lib_ring_buffer_get_records_lost_wrap(&client_config, buf);
	146	records_lost += lib_ring_buffer_get_records_lost_big(&client_config, buf);
	147	WARN_ON_ONCE(records_lost != 0);
	148	}
	149
4cfec15c	150	static int client_buffer_create(struct lttng_ust_lib_ring_buffer buf, void priv,
1d498196	151	int cpu, const char *name,
38fae1d3	152	struct lttng_ust_shm_handle *handle)
3d1fc7fd MD	153	{
	154	return 0;
	155	}
	156
4cfec15c	157	static void client_buffer_finalize(struct lttng_ust_lib_ring_buffer *buf,
1d498196	158	void *priv, int cpu,
38fae1d3	159	struct lttng_ust_shm_handle *handle)
3d1fc7fd MD	160	{
	161	}
	162
82b9bde8 JD	163	static const
	164	struct lttng_ust_client_lib_ring_buffer_client_cb client_cb = {
	165	.parent = {
	166	.ring_buffer_clock_read = client_ring_buffer_clock_read,
	167	.record_header_size = client_record_header_size,
	168	.subbuffer_header_size = client_packet_header_size,
	169	.buffer_begin = client_buffer_begin,
	170	.buffer_end = client_buffer_end,
	171	.buffer_create = client_buffer_create,
	172	.buffer_finalize = client_buffer_finalize,
	173	},
	174	};
	175
4cfec15c	176	static const struct lttng_ust_lib_ring_buffer_config client_config = {
3d1fc7fd MD	177	.cb.ring_buffer_clock_read = client_ring_buffer_clock_read,
	178	.cb.record_header_size = client_record_header_size,
	179	.cb.subbuffer_header_size = client_packet_header_size,
	180	.cb.buffer_begin = client_buffer_begin,
	181	.cb.buffer_end = client_buffer_end,
	182	.cb.buffer_create = client_buffer_create,
	183	.cb.buffer_finalize = client_buffer_finalize,
	184
	185	.tsc_bits = 0,
	186	.alloc = RING_BUFFER_ALLOC_GLOBAL,
	187	.sync = RING_BUFFER_SYNC_GLOBAL,
	188	.mode = RING_BUFFER_MODE_TEMPLATE,
	189	.backend = RING_BUFFER_PAGE,
5d61a504	190	.output = RING_BUFFER_MMAP,
3d1fc7fd	191	.oops = RING_BUFFER_OOPS_CONSISTENCY,
5d61a504 MD	192	.ipi = RING_BUFFER_NO_IPI_BARRIER,
5d61a504 MD	193	.wakeup = RING_BUFFER_WAKEUP_BY_WRITER,
c1fca457	194	.client_type = LTTNG_CLIENT_TYPE,
82b9bde8 JD	195
82b9bde8 JD	196	.cb_ptr = &client_cb.parent,
3d1fc7fd MD	197	};
3d1fc7fd MD	198
82b9bde8	199	const struct lttng_ust_client_lib_ring_buffer_client_cb *LTTNG_CLIENT_CALLBACKS = &client_cb;
c1fca457	200
3d1fc7fd	201	static
7dd08bec	202	struct lttng_channel _channel_create(const char name,
a3f61e7f	203	void *buf_addr,
3d1fc7fd MD	204	size_t subbuf_size, size_t num_subbuf,
3d1fc7fd MD	205	unsigned int switch_timer_interval,
193183fb	206	unsigned int read_timer_interval,
6ca18e66	207	unsigned char *uuid,
a9ff648c	208	uint32_t chan_id,
9050321d MD	209	const int *stream_fds, int nr_stream_fds,
9050321d MD	210	int64_t blocking_timeout)
3d1fc7fd	211	{
74d81a6c	212	struct lttng_channel chan_priv_init;
a3f61e7f	213	struct lttng_ust_shm_handle *handle;
74d81a6c MD	214	struct lttng_channel *lttng_chan;
74d81a6c MD	215	void *priv;
a3f61e7f	216
74d81a6c MD	217	memset(&chan_priv_init, 0, sizeof(chan_priv_init));
74d81a6c MD	218	memcpy(chan_priv_init.uuid, uuid, LTTNG_UST_UUID_LEN);
6ca18e66	219	chan_priv_init.id = chan_id;
a3f61e7f	220	handle = channel_create(&client_config, name,
8824f307 MD	221	&priv, __alignof__(struct lttng_channel),
8824f307 MD	222	sizeof(struct lttng_channel),
74d81a6c	223	&chan_priv_init,
a3f61e7f	224	buf_addr, subbuf_size, num_subbuf,
a9ff648c	225	switch_timer_interval, read_timer_interval,
9050321d	226	stream_fds, nr_stream_fds, blocking_timeout);
a3f61e7f	227	if (!handle)
1b2c2540	228	return NULL;
7dd08bec MD	229	lttng_chan = priv;
7dd08bec MD	230	lttng_chan->handle = handle;
74d81a6c	231	lttng_chan->chan = shmp(handle, handle->chan);
7dd08bec	232	return lttng_chan;
3d1fc7fd MD	233	}
	234
	235	static
74d81a6c	236	void lttng_channel_destroy(struct lttng_channel *chan)
3d1fc7fd	237	{
74d81a6c	238	channel_destroy(chan->chan, chan->handle, 1);
3d1fc7fd MD	239	}
	240
	241	static
7dd08bec	242	int lttng_event_reserve(struct lttng_ust_lib_ring_buffer_ctx *ctx, uint32_t event_id)
3d1fc7fd	243	{
a3492932 MD	244	int ret;
	245
	246	ret = lib_ring_buffer_reserve(&client_config, ctx);
	247	if (ret)
	248	return ret;
	249	if (caa_likely(ctx->ctx_len
	250	>= sizeof(struct lttng_ust_lib_ring_buffer_ctx))) {
	251	if (lib_ring_buffer_backend_get_pages(&client_config, ctx,
	252	&ctx->backend_pages))
	253	return -EPERM;
	254	}
	255	return 0;
3d1fc7fd MD	256	}
	257
	258	static
7dd08bec	259	void lttng_event_commit(struct lttng_ust_lib_ring_buffer_ctx *ctx)
3d1fc7fd MD	260	{
	261	lib_ring_buffer_commit(&client_config, ctx);
	262	}
	263
	264	static
7dd08bec	265	void lttng_event_write(struct lttng_ust_lib_ring_buffer_ctx ctx, const void src,
3d1fc7fd MD	266	size_t len)
	267	{
	268	lib_ring_buffer_write(&client_config, ctx, src, len);
	269	}
	270
	271	static
7dd08bec	272	size_t lttng_packet_avail_size(struct channel chan, struct lttng_ust_shm_handle handle)
3d1fc7fd MD	273	{
3d1fc7fd MD	274	unsigned long o_begin;
4cfec15c	275	struct lttng_ust_lib_ring_buffer *buf;
3d1fc7fd	276
1d498196	277	buf = shmp(handle, chan->backend.buf[0].shmp); /* Only for global buffer ! */
3d1fc7fd MD	278	o_begin = v_read(&client_config, &buf->offset);
	279	if (subbuf_offset(o_begin, chan) != 0) {
	280	return chan->backend.subbuf_size - subbuf_offset(o_begin, chan);
	281	} else {
	282	return chan->backend.subbuf_size - subbuf_offset(o_begin, chan)
	283	- sizeof(struct metadata_packet_header);
	284	}
	285	}
	286
9f3fdbc6	287	#if 0
3d1fc7fd	288	static
7dd08bec	289	wait_queue_head_t lttng_get_reader_wait_queue(struct channel chan)
3d1fc7fd MD	290	{
	291	return &chan->read_wait;
	292	}
	293
	294	static
7dd08bec	295	wait_queue_head_t lttng_get_hp_wait_queue(struct channel chan)
3d1fc7fd MD	296	{
	297	return &chan->hp_wait;
	298	}
9f3fdbc6	299	#endif //0
3d1fc7fd MD	300
3d1fc7fd MD	301	static
7dd08bec	302	int lttng_is_finalized(struct channel *chan)
3d1fc7fd MD	303	{
	304	return lib_ring_buffer_channel_is_finalized(chan);
	305	}
	306
	307	static
7dd08bec	308	int lttng_is_disabled(struct channel *chan)
3d1fc7fd MD	309	{
	310	return lib_ring_buffer_channel_is_disabled(chan);
	311	}
	312
43861eab	313	static
7dd08bec	314	int lttng_flush_buffer(struct channel chan, struct lttng_ust_shm_handle handle)
43861eab	315	{
4cfec15c	316	struct lttng_ust_lib_ring_buffer *buf;
74d81a6c MD	317	int shm_fd, wait_fd, wakeup_fd;
74d81a6c MD	318	uint64_t memory_map_size;
43861eab MD	319
43861eab MD	320	buf = channel_get_ring_buffer(&client_config, chan,
74d81a6c	321	0, handle, &shm_fd, &wait_fd, &wakeup_fd,
43861eab MD	322	&memory_map_size);
	323	lib_ring_buffer_switch(&client_config, buf,
	324	SWITCH_ACTIVE, handle);
	325	return 0;
	326	}
	327
7dd08bec	328	static struct lttng_transport lttng_relay_transport = {
818173b9	329	.name = "relay-" RING_BUFFER_MODE_TEMPLATE_STRING "-mmap",
3d1fc7fd MD	330	.ops = {
3d1fc7fd MD	331	.channel_create = _channel_create,
7dd08bec	332	.channel_destroy = lttng_channel_destroy,
7dd08bec MD	333	.event_reserve = lttng_event_reserve,
	334	.event_commit = lttng_event_commit,
	335	.event_write = lttng_event_write,
	336	.packet_avail_size = lttng_packet_avail_size,
	337	//.get_reader_wait_queue = lttng_get_reader_wait_queue,
	338	//.get_hp_wait_queue = lttng_get_hp_wait_queue,
	339	.is_finalized = lttng_is_finalized,
	340	.is_disabled = lttng_is_disabled,
	341	.flush_buffer = lttng_flush_buffer,
3d1fc7fd	342	},
74d81a6c	343	.client_config = &client_config,
3d1fc7fd MD	344	};
3d1fc7fd MD	345
edaa1431	346	void RING_BUFFER_MODE_TEMPLATE_INIT(void)
3d1fc7fd	347	{
34a91bdb MD	348	DBG("LTT : ltt ring buffer client \"%s\" init\n",
34a91bdb MD	349	"relay-" RING_BUFFER_MODE_TEMPLATE_STRING "-mmap");
7dd08bec	350	lttng_transport_register(&lttng_relay_transport);
3d1fc7fd MD	351	}
3d1fc7fd MD	352
edaa1431	353	void RING_BUFFER_MODE_TEMPLATE_EXIT(void)
3d1fc7fd	354	{
34a91bdb MD	355	DBG("LTT : ltt ring buffer client \"%s\" exit\n",
34a91bdb MD	356	"relay-" RING_BUFFER_MODE_TEMPLATE_STRING "-mmap");
7dd08bec	357	lttng_transport_unregister(&lttng_relay_transport);
3d1fc7fd	358	}