[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 <errno.h>

#include <common/consumer/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 void lttng_ustconsumer_free_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_get_stream_id(struct lttng_consumer_stream *stream,
		uint64_t *stream_id);
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);
int lttng_ustconsumer_get_sequence_number(
		struct lttng_consumer_stream *stream, uint64_t *seq);

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