[lttng-tools.git] / src / common / ust-consumer / ust-consumer.h

/*
 * Copyright (C) 2011 - Julien Desfossez <julien.desfossez@polymtl.ca>
 * Copyright (C) 2011 - Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License, version 2 only,
 * as published by the Free Software Foundation.
 *
 * This program 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */

#ifndef _LTTNG_USTCONSUMER_H
#define _LTTNG_USTCONSUMER_H

#include <config.h>
#include <errno.h>

#include <common/consumer.h>

#ifdef HAVE_LIBLTTNG_UST_CTL

int lttng_ustconsumer_take_snapshot(struct lttng_consumer_stream *stream);

int lttng_ustconsumer_get_produced_snapshot(
		struct lttng_consumer_stream *stream, unsigned long *pos);

int lttng_ustconsumer_recv_cmd(struct lttng_consumer_local_data *ctx,
		int sock, struct pollfd *consumer_sockpoll);

extern int lttng_ustconsumer_allocate_channel(struct lttng_consumer_channel *chan);
extern void lttng_ustconsumer_del_channel(struct lttng_consumer_channel *chan);
extern int lttng_ustconsumer_add_stream(struct lttng_consumer_stream *stream);
extern void lttng_ustconsumer_del_stream(struct lttng_consumer_stream *stream);

int lttng_ustconsumer_read_subbuffer(struct lttng_consumer_stream *stream,
		struct lttng_consumer_local_data *ctx);
int lttng_ustconsumer_on_recv_stream(struct lttng_consumer_stream *stream);

void lttng_ustconsumer_on_stream_hangup(struct lttng_consumer_stream *stream);

int lttng_ustctl_get_mmap_read_offset(struct lttng_consumer_stream *stream,
		unsigned long *off);
void *lttng_ustctl_get_mmap_base(struct lttng_consumer_stream *stream);
int lttng_ustconsumer_data_pending(struct lttng_consumer_stream *stream);
void lttng_ustconsumer_close_metadata(struct lttng_ht *ht);
void lttng_ustconsumer_close_stream_wakeup(struct lttng_consumer_stream *stream);

#else /* HAVE_LIBLTTNG_UST_CTL */

static inline
ssize_t lttng_ustconsumer_on_read_subbuffer_mmap(
		struct lttng_consumer_local_data *ctx,
		struct lttng_consumer_stream *stream, unsigned long len,
		unsigned long padding)
{
	return -ENOSYS;
}

static inline
ssize_t lttng_ustconsumer_on_read_subbuffer_splice(
		struct lttng_consumer_local_data *ctx,
		struct lttng_consumer_stream *uststream, unsigned long len,
		unsigned long padding)
{
	return -ENOSYS;
}

static inline
int lttng_ustconsumer_take_snapshot(struct lttng_consumer_stream *stream)
{
	return -ENOSYS;
}

static inline
int lttng_ustconsumer_get_produced_snapshot(
		struct lttng_consumer_stream *stream, unsigned long *pos)
{
	return -ENOSYS;
}

static inline
int lttng_ustconsumer_recv_cmd(struct lttng_consumer_local_data *ctx,
		int sock, struct pollfd *consumer_sockpoll)
{
	return -ENOSYS;
}

static inline
int lttng_ustconsumer_allocate_channel(struct lttng_consumer_channel *chan)
{
	return -ENOSYS;
}

static inline
void lttng_ustconsumer_del_channel(struct lttng_consumer_channel *chan)
{
}

static inline
int lttng_ustconsumer_add_stream(struct lttng_consumer_stream *stream)
{
	return -ENOSYS;
}

static inline
void lttng_ustconsumer_del_stream(struct lttng_consumer_stream *stream)
{
}

static inline
int lttng_ustconsumer_read_subbuffer(struct lttng_consumer_stream *stream,
		struct lttng_consumer_local_data *ctx)
{
	return -ENOSYS;
}

static inline
int lttng_ustconsumer_on_recv_stream(struct lttng_consumer_stream *stream)
{
	return -ENOSYS;
}

static inline
void lttng_ustconsumer_on_stream_hangup(struct lttng_consumer_stream *stream)
{
}

static inline
int lttng_ustctl_get_mmap_read_offset(struct lttng_consumer_stream *stream,
		unsigned long *off)
{
	return -ENOSYS;
}
static inline
int lttng_ustconsumer_data_pending(struct lttng_consumer_stream *stream)
{
	return -ENOSYS;
}
static inline
void *lttng_ustctl_get_mmap_base(struct lttng_consumer_stream *stream)
{
	return NULL;
}
static inline
void lttng_ustconsumer_close_metadata(struct lttng_ht *ht)
{
}
static inline
void lttng_ustconsumer_close_stream_wakeup(struct lttng_consumer_stream *stream)
{
}
#endif /* HAVE_LIBLTTNG_UST_CTL */

#endif /* _LTTNG_USTCONSUMER_H */
Commit	Line	Data
3bd1e081 MD	1	/*
	2	* Copyright (C) 2011 - Julien Desfossez <julien.desfossez@polymtl.ca>
	3	* Copyright (C) 2011 - Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
	4	*
d14d33bf AM	5	* This program is free software; you can redistribute it and/or modify
	6	* it under the terms of the GNU General Public License, version 2 only,
	7	* as published by the Free Software Foundation.
3bd1e081 MD	8	*
	9	* This program is distributed in the hope that it will be useful,
	10	* but WITHOUT ANY WARRANTY; without even the implied warranty of
d14d33bf	11	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
3bd1e081 MD	12	* GNU General Public License for more details.
3bd1e081 MD	13	*
d14d33bf AM	14	* You should have received a copy of the GNU General Public License along
	15	* with this program; if not, write to the Free Software Foundation, Inc.,
	16	* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
3bd1e081 MD	17	*/
	18
	19	#ifndef _LTTNG_USTCONSUMER_H
	20	#define _LTTNG_USTCONSUMER_H
	21
	22	#include <config.h>
3bd1e081 MD	23	#include <errno.h>
3bd1e081 MD	24
10a8a223 DG	25	#include <common/consumer.h>
10a8a223 DG	26
74d0b642	27	#ifdef HAVE_LIBLTTNG_UST_CTL
3bd1e081	28
ffe60014	29	int lttng_ustconsumer_take_snapshot(struct lttng_consumer_stream *stream);
3bd1e081	30
3bd1e081	31	int lttng_ustconsumer_get_produced_snapshot(
ffe60014	32	struct lttng_consumer_stream stream, unsigned long pos);
3bd1e081 MD	33
	34	int lttng_ustconsumer_recv_cmd(struct lttng_consumer_local_data *ctx,
	35	int sock, struct pollfd *consumer_sockpoll);
	36
	37	extern int lttng_ustconsumer_allocate_channel(struct lttng_consumer_channel *chan);
	38	extern void lttng_ustconsumer_del_channel(struct lttng_consumer_channel *chan);
e316aad5	39	extern int lttng_ustconsumer_add_stream(struct lttng_consumer_stream *stream);
3bd1e081 MD	40	extern void lttng_ustconsumer_del_stream(struct lttng_consumer_stream *stream);
3bd1e081 MD	41
d41f73b7 MD	42	int lttng_ustconsumer_read_subbuffer(struct lttng_consumer_stream *stream,
	43	struct lttng_consumer_local_data *ctx);
	44	int lttng_ustconsumer_on_recv_stream(struct lttng_consumer_stream *stream);
	45
d056b477 MD	46	void lttng_ustconsumer_on_stream_hangup(struct lttng_consumer_stream *stream);
d056b477 MD	47
ffe60014 DG	48	int lttng_ustctl_get_mmap_read_offset(struct lttng_consumer_stream *stream,
	49	unsigned long *off);
	50	void lttng_ustctl_get_mmap_base(struct lttng_consumer_stream stream);
6d805429	51	int lttng_ustconsumer_data_pending(struct lttng_consumer_stream *stream);
d88aee68	52	void lttng_ustconsumer_close_metadata(struct lttng_ht *ht);
d8ef542d	53	void lttng_ustconsumer_close_stream_wakeup(struct lttng_consumer_stream *stream);
f02e1e8a	54
74d0b642	55	#else /* HAVE_LIBLTTNG_UST_CTL */
3bd1e081 MD	56
3bd1e081 MD	57	static inline
4078b776	58	ssize_t lttng_ustconsumer_on_read_subbuffer_mmap(
3bd1e081	59	struct lttng_consumer_local_data *ctx,
1d4dfdef DG	60	struct lttng_consumer_stream *stream, unsigned long len,
1d4dfdef DG	61	unsigned long padding)
3bd1e081 MD	62	{
	63	return -ENOSYS;
	64	}
	65
	66	static inline
4078b776	67	ssize_t lttng_ustconsumer_on_read_subbuffer_splice(
3bd1e081	68	struct lttng_consumer_local_data *ctx,
1d4dfdef DG	69	struct lttng_consumer_stream *uststream, unsigned long len,
1d4dfdef DG	70	unsigned long padding)
3bd1e081 MD	71	{
	72	return -ENOSYS;
	73	}
	74
	75	static inline
ffe60014	76	int lttng_ustconsumer_take_snapshot(struct lttng_consumer_stream *stream)
3bd1e081 MD	77	{
	78	return -ENOSYS;
	79	}
	80
	81	static inline
	82	int lttng_ustconsumer_get_produced_snapshot(
ffe60014	83	struct lttng_consumer_stream stream, unsigned long pos)
3bd1e081 MD	84	{
	85	return -ENOSYS;
	86	}
	87
	88	static inline
	89	int lttng_ustconsumer_recv_cmd(struct lttng_consumer_local_data *ctx,
fbc72522 DG	90	int sock, struct pollfd *consumer_sockpoll)
	91	{
	92	return -ENOSYS;
	93	}
3bd1e081 MD	94
	95	static inline
	96	int lttng_ustconsumer_allocate_channel(struct lttng_consumer_channel *chan)
	97	{
	98	return -ENOSYS;
	99	}
	100
	101	static inline
	102	void lttng_ustconsumer_del_channel(struct lttng_consumer_channel *chan)
	103	{
	104	}
	105
	106	static inline
e316aad5	107	int lttng_ustconsumer_add_stream(struct lttng_consumer_stream *stream)
3bd1e081 MD	108	{
	109	return -ENOSYS;
	110	}
	111
	112	static inline
	113	void lttng_ustconsumer_del_stream(struct lttng_consumer_stream *stream)
	114	{
	115	}
	116
d41f73b7 MD	117	static inline
	118	int lttng_ustconsumer_read_subbuffer(struct lttng_consumer_stream *stream,
	119	struct lttng_consumer_local_data *ctx)
	120	{
	121	return -ENOSYS;
	122	}
	123
	124	static inline
	125	int lttng_ustconsumer_on_recv_stream(struct lttng_consumer_stream *stream)
	126	{
	127	return -ENOSYS;
	128	}
	129
d056b477 MD	130	static inline
	131	void lttng_ustconsumer_on_stream_hangup(struct lttng_consumer_stream *stream)
	132	{
	133	}
	134
f02e1e8a	135	static inline
ffe60014 DG	136	int lttng_ustctl_get_mmap_read_offset(struct lttng_consumer_stream *stream,
ffe60014 DG	137	unsigned long *off)
f02e1e8a DG	138	{
	139	return -ENOSYS;
	140	}
ca22feea	141	static inline
6d805429	142	int lttng_ustconsumer_data_pending(struct lttng_consumer_stream *stream)
ca22feea DG	143	{
	144	return -ENOSYS;
	145	}
ffe60014 DG	146	static inline
	147	void lttng_ustctl_get_mmap_base(struct lttng_consumer_stream stream)
	148	{
	149	return NULL;
	150	}
d88aee68 DG	151	static inline
	152	void lttng_ustconsumer_close_metadata(struct lttng_ht *ht)
	153	{
	154	}
d8ef542d MD	155	static inline
	156	void lttng_ustconsumer_close_stream_wakeup(struct lttng_consumer_stream *stream)
	157	{
	158	}
74d0b642	159	#endif /* HAVE_LIBLTTNG_UST_CTL */
3bd1e081 MD	160
3bd1e081 MD	161	#endif /* _LTTNG_USTCONSUMER_H */