[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_get_consumed_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);
int lttng_ustconsumer_recv_metadata(int sock, uint64_t key, uint64_t offset,
		uint64_t len, struct lttng_consumer_channel *channel);
int lttng_ustconsumer_request_metadata(struct lttng_consumer_local_data *ctx,
		struct lttng_consumer_channel *channel);

#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)
{
}
static inline
int lttng_ustconsumer_recv_metadata(int sock, uint64_t key, uint64_t offset,
		uint64_t len, struct lttng_consumer_channel *channel)
{
	return -ENOSYS;
}
static inline
int lttng_ustconsumer_request_metadata(struct lttng_consumer_local_data *ctx,
		struct lttng_consumer_channel *channel)
{
	return -ENOSYS;
}
#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);
10a50311 JD	33	int lttng_ustconsumer_get_consumed_snapshot(
10a50311 JD	34	struct lttng_consumer_stream stream, unsigned long pos);
3bd1e081 MD	35
	36	int lttng_ustconsumer_recv_cmd(struct lttng_consumer_local_data *ctx,
	37	int sock, struct pollfd *consumer_sockpoll);
	38
	39	extern int lttng_ustconsumer_allocate_channel(struct lttng_consumer_channel *chan);
	40	extern void lttng_ustconsumer_del_channel(struct lttng_consumer_channel *chan);
e316aad5	41	extern int lttng_ustconsumer_add_stream(struct lttng_consumer_stream *stream);
3bd1e081 MD	42	extern void lttng_ustconsumer_del_stream(struct lttng_consumer_stream *stream);
3bd1e081 MD	43
d41f73b7 MD	44	int lttng_ustconsumer_read_subbuffer(struct lttng_consumer_stream *stream,
	45	struct lttng_consumer_local_data *ctx);
	46	int lttng_ustconsumer_on_recv_stream(struct lttng_consumer_stream *stream);
	47
d056b477 MD	48	void lttng_ustconsumer_on_stream_hangup(struct lttng_consumer_stream *stream);
d056b477 MD	49
ffe60014 DG	50	int lttng_ustctl_get_mmap_read_offset(struct lttng_consumer_stream *stream,
	51	unsigned long *off);
	52	void lttng_ustctl_get_mmap_base(struct lttng_consumer_stream stream);
6d805429	53	int lttng_ustconsumer_data_pending(struct lttng_consumer_stream *stream);
d88aee68	54	void lttng_ustconsumer_close_metadata(struct lttng_ht *ht);
d8ef542d	55	void lttng_ustconsumer_close_stream_wakeup(struct lttng_consumer_stream *stream);
331744e3 JD	56	int lttng_ustconsumer_recv_metadata(int sock, uint64_t key, uint64_t offset,
331744e3 JD	57	uint64_t len, struct lttng_consumer_channel *channel);
331744e3 JD	58	int lttng_ustconsumer_request_metadata(struct lttng_consumer_local_data *ctx,
331744e3 JD	59	struct lttng_consumer_channel *channel);
f02e1e8a	60
74d0b642	61	#else /* HAVE_LIBLTTNG_UST_CTL */
3bd1e081 MD	62
3bd1e081 MD	63	static inline
4078b776	64	ssize_t lttng_ustconsumer_on_read_subbuffer_mmap(
3bd1e081	65	struct lttng_consumer_local_data *ctx,
1d4dfdef DG	66	struct lttng_consumer_stream *stream, unsigned long len,
1d4dfdef DG	67	unsigned long padding)
3bd1e081 MD	68	{
	69	return -ENOSYS;
	70	}
	71
	72	static inline
4078b776	73	ssize_t lttng_ustconsumer_on_read_subbuffer_splice(
3bd1e081	74	struct lttng_consumer_local_data *ctx,
1d4dfdef DG	75	struct lttng_consumer_stream *uststream, unsigned long len,
1d4dfdef DG	76	unsigned long padding)
3bd1e081 MD	77	{
	78	return -ENOSYS;
	79	}
	80
	81	static inline
ffe60014	82	int lttng_ustconsumer_take_snapshot(struct lttng_consumer_stream *stream)
3bd1e081 MD	83	{
	84	return -ENOSYS;
	85	}
	86
	87	static inline
	88	int lttng_ustconsumer_get_produced_snapshot(
ffe60014	89	struct lttng_consumer_stream stream, unsigned long pos)
3bd1e081 MD	90	{
	91	return -ENOSYS;
	92	}
	93
	94	static inline
	95	int lttng_ustconsumer_recv_cmd(struct lttng_consumer_local_data *ctx,
fbc72522 DG	96	int sock, struct pollfd *consumer_sockpoll)
	97	{
	98	return -ENOSYS;
	99	}
3bd1e081 MD	100
	101	static inline
	102	int lttng_ustconsumer_allocate_channel(struct lttng_consumer_channel *chan)
	103	{
	104	return -ENOSYS;
	105	}
	106
	107	static inline
	108	void lttng_ustconsumer_del_channel(struct lttng_consumer_channel *chan)
	109	{
	110	}
	111
	112	static inline
e316aad5	113	int lttng_ustconsumer_add_stream(struct lttng_consumer_stream *stream)
3bd1e081 MD	114	{
	115	return -ENOSYS;
	116	}
	117
	118	static inline
	119	void lttng_ustconsumer_del_stream(struct lttng_consumer_stream *stream)
	120	{
	121	}
	122
d41f73b7 MD	123	static inline
	124	int lttng_ustconsumer_read_subbuffer(struct lttng_consumer_stream *stream,
	125	struct lttng_consumer_local_data *ctx)
	126	{
	127	return -ENOSYS;
	128	}
	129
	130	static inline
	131	int lttng_ustconsumer_on_recv_stream(struct lttng_consumer_stream *stream)
	132	{
	133	return -ENOSYS;
	134	}
	135
d056b477 MD	136	static inline
	137	void lttng_ustconsumer_on_stream_hangup(struct lttng_consumer_stream *stream)
	138	{
	139	}
	140
f02e1e8a	141	static inline
ffe60014 DG	142	int lttng_ustctl_get_mmap_read_offset(struct lttng_consumer_stream *stream,
ffe60014 DG	143	unsigned long *off)
f02e1e8a DG	144	{
	145	return -ENOSYS;
	146	}
ca22feea	147	static inline
6d805429	148	int lttng_ustconsumer_data_pending(struct lttng_consumer_stream *stream)
ca22feea DG	149	{
	150	return -ENOSYS;
	151	}
ffe60014 DG	152	static inline
	153	void lttng_ustctl_get_mmap_base(struct lttng_consumer_stream stream)
	154	{
	155	return NULL;
	156	}
d88aee68 DG	157	static inline
	158	void lttng_ustconsumer_close_metadata(struct lttng_ht *ht)
	159	{
	160	}
d8ef542d MD	161	static inline
	162	void lttng_ustconsumer_close_stream_wakeup(struct lttng_consumer_stream *stream)
	163	{
	164	}
ee69440b DG	165	static inline
	166	int lttng_ustconsumer_recv_metadata(int sock, uint64_t key, uint64_t offset,
	167	uint64_t len, struct lttng_consumer_channel *channel)
	168	{
	169	return -ENOSYS;
	170	}
	171	static inline
ee69440b DG	172	int lttng_ustconsumer_request_metadata(struct lttng_consumer_local_data *ctx,
	173	struct lttng_consumer_channel *channel)
	174	{
	175	return -ENOSYS;
	176	}
74d0b642	177	#endif /* HAVE_LIBLTTNG_UST_CTL */
3bd1e081 MD	178
3bd1e081 MD	179	#endif /* _LTTNG_USTCONSUMER_H */