[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 timer, int wait);
int lttng_ustconsumer_request_metadata(struct lttng_consumer_local_data *ctx,
		struct lttng_consumer_channel *channel, int timer, int wait);
int lttng_ustconsumer_sync_metadata(struct lttng_consumer_local_data *ctx,
		struct lttng_consumer_stream *metadata);

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