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