[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 lttng_ustconsumer_push_metadata(struct lttng_consumer_channel *metadata,
		const char *metadata_str, uint64_t target_offset, uint64_t len);
int lttng_ustconsumer_request_metadata(struct lttng_consumer_local_data *ctx,
		struct lttng_consumer_channel *channel);

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