[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);

#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)
{
}
#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);
f02e1e8a	53
74d0b642	54	#else /* HAVE_LIBLTTNG_UST_CTL */
3bd1e081 MD	55
3bd1e081 MD	56	static inline
4078b776	57	ssize_t lttng_ustconsumer_on_read_subbuffer_mmap(
3bd1e081	58	struct lttng_consumer_local_data *ctx,
1d4dfdef DG	59	struct lttng_consumer_stream *stream, unsigned long len,
1d4dfdef DG	60	unsigned long padding)
3bd1e081 MD	61	{
	62	return -ENOSYS;
	63	}
	64
	65	static inline
4078b776	66	ssize_t lttng_ustconsumer_on_read_subbuffer_splice(
3bd1e081	67	struct lttng_consumer_local_data *ctx,
1d4dfdef DG	68	struct lttng_consumer_stream *uststream, unsigned long len,
1d4dfdef DG	69	unsigned long padding)
3bd1e081 MD	70	{
	71	return -ENOSYS;
	72	}
	73
	74	static inline
ffe60014	75	int lttng_ustconsumer_take_snapshot(struct lttng_consumer_stream *stream)
3bd1e081 MD	76	{
	77	return -ENOSYS;
	78	}
	79
	80	static inline
	81	int lttng_ustconsumer_get_produced_snapshot(
ffe60014	82	struct lttng_consumer_stream stream, unsigned long pos)
3bd1e081 MD	83	{
	84	return -ENOSYS;
	85	}
	86
	87	static inline
	88	int lttng_ustconsumer_recv_cmd(struct lttng_consumer_local_data *ctx,
fbc72522 DG	89	int sock, struct pollfd *consumer_sockpoll)
	90	{
	91	return -ENOSYS;
	92	}
3bd1e081 MD	93
	94	static inline
	95	int lttng_ustconsumer_allocate_channel(struct lttng_consumer_channel *chan)
	96	{
	97	return -ENOSYS;
	98	}
	99
	100	static inline
	101	void lttng_ustconsumer_del_channel(struct lttng_consumer_channel *chan)
	102	{
	103	}
	104
	105	static inline
e316aad5	106	int lttng_ustconsumer_add_stream(struct lttng_consumer_stream *stream)
3bd1e081 MD	107	{
	108	return -ENOSYS;
	109	}
	110
	111	static inline
	112	void lttng_ustconsumer_del_stream(struct lttng_consumer_stream *stream)
	113	{
	114	}
	115
d41f73b7 MD	116	static inline
	117	int lttng_ustconsumer_read_subbuffer(struct lttng_consumer_stream *stream,
	118	struct lttng_consumer_local_data *ctx)
	119	{
	120	return -ENOSYS;
	121	}
	122
	123	static inline
	124	int lttng_ustconsumer_on_recv_stream(struct lttng_consumer_stream *stream)
	125	{
	126	return -ENOSYS;
	127	}
	128
d056b477 MD	129	static inline
	130	void lttng_ustconsumer_on_stream_hangup(struct lttng_consumer_stream *stream)
	131	{
	132	}
	133
f02e1e8a	134	static inline
ffe60014 DG	135	int lttng_ustctl_get_mmap_read_offset(struct lttng_consumer_stream *stream,
ffe60014 DG	136	unsigned long *off)
f02e1e8a DG	137	{
	138	return -ENOSYS;
	139	}
ca22feea	140	static inline
6d805429	141	int lttng_ustconsumer_data_pending(struct lttng_consumer_stream *stream)
ca22feea DG	142	{
	143	return -ENOSYS;
	144	}
ffe60014 DG	145	static inline
	146	void lttng_ustctl_get_mmap_base(struct lttng_consumer_stream stream)
	147	{
	148	return NULL;
	149	}
d88aee68 DG	150	static inline
	151	void lttng_ustconsumer_close_metadata(struct lttng_ht *ht)
	152	{
	153	}
74d0b642	154	#endif /* HAVE_LIBLTTNG_UST_CTL */
3bd1e081 MD	155
3bd1e081 MD	156	#endif /* _LTTNG_USTCONSUMER_H */