[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);

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