[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);
void lttng_ustconsumer_flush_buffer(struct lttng_consumer_stream *stream,
		int producer);
int lttng_ustconsumer_get_current_timestamp(
		struct lttng_consumer_stream *stream, uint64_t *ts);

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