[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

/*
 * Take a snapshot for a specific fd
 *
 * Returns 0 on success, < 0 on error
 */
int lttng_ustconsumer_take_snapshot(struct lttng_consumer_local_data *ctx,
        struct lttng_consumer_stream *stream);

/*
 * Get the produced position
 *
 * Returns 0 on success, < 0 on error
 */
int lttng_ustconsumer_get_produced_snapshot(
        struct lttng_consumer_local_data *ctx,
        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);

extern int lttng_ustctl_get_mmap_read_offset(
		struct lttng_ust_shm_handle *handle,
		struct lttng_ust_lib_ring_buffer *buf, unsigned long *off);
int lttng_ustconsumer_data_pending(struct lttng_consumer_stream *stream);

#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_local_data *ctx,
        struct lttng_consumer_stream *stream)
{
	return -ENOSYS;
}

static inline
int lttng_ustconsumer_get_produced_snapshot(
        struct lttng_consumer_local_data *ctx,
        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_ust_shm_handle *handle,
		struct lttng_ust_lib_ring_buffer *buf, unsigned long *off)
{
	return -ENOSYS;
}
static inline
int lttng_ustconsumer_data_pending(struct lttng_consumer_stream *stream)
{
	return -ENOSYS;
}
#endif /* HAVE_LIBLTTNG_UST_CTL */

#endif /* _LTTNG_USTCONSUMER_H */
Commit	Line	Data
	1	/*
	2	* Copyright (C) 2011 - Julien Desfossez <julien.desfossez@polymtl.ca>
	3	* Copyright (C) 2011 - Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
	4	*
	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.
	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
	11	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	12	* GNU General Public License for more details.
	13	*
	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.
	17	*/
	18
	19	#ifndef _LTTNG_USTCONSUMER_H
	20	#define _LTTNG_USTCONSUMER_H
	21
	22	#include <config.h>
	23	#include <errno.h>
	24
	25	#include <common/consumer.h>
	26
	27	#ifdef HAVE_LIBLTTNG_UST_CTL
	28
	29	/*
	30	* Take a snapshot for a specific fd
	31	*
	32	* Returns 0 on success, < 0 on error
	33	*/
	34	int lttng_ustconsumer_take_snapshot(struct lttng_consumer_local_data *ctx,
	35	struct lttng_consumer_stream *stream);
	36
	37	/*
	38	* Get the produced position
	39	*
	40	* Returns 0 on success, < 0 on error
	41	*/
	42	int lttng_ustconsumer_get_produced_snapshot(
	43	struct lttng_consumer_local_data *ctx,
	44	struct lttng_consumer_stream *stream,
	45	unsigned long *pos);
	46
	47	int lttng_ustconsumer_recv_cmd(struct lttng_consumer_local_data *ctx,
	48	int sock, struct pollfd *consumer_sockpoll);
	49
	50	extern int lttng_ustconsumer_allocate_channel(struct lttng_consumer_channel *chan);
	51	extern void lttng_ustconsumer_del_channel(struct lttng_consumer_channel *chan);
	52	extern int lttng_ustconsumer_add_stream(struct lttng_consumer_stream *stream);
	53	extern void lttng_ustconsumer_del_stream(struct lttng_consumer_stream *stream);
	54
	55	int lttng_ustconsumer_read_subbuffer(struct lttng_consumer_stream *stream,
	56	struct lttng_consumer_local_data *ctx);
	57	int lttng_ustconsumer_on_recv_stream(struct lttng_consumer_stream *stream);
	58
	59	void lttng_ustconsumer_on_stream_hangup(struct lttng_consumer_stream *stream);
	60
	61	extern int lttng_ustctl_get_mmap_read_offset(
	62	struct lttng_ust_shm_handle *handle,
	63	struct lttng_ust_lib_ring_buffer buf, unsigned long off);
	64	int lttng_ustconsumer_data_pending(struct lttng_consumer_stream *stream);
	65
	66	#else /* HAVE_LIBLTTNG_UST_CTL */
	67
	68	static inline
	69	ssize_t lttng_ustconsumer_on_read_subbuffer_mmap(
	70	struct lttng_consumer_local_data *ctx,
	71	struct lttng_consumer_stream *stream, unsigned long len,
	72	unsigned long padding)
	73	{
	74	return -ENOSYS;
	75	}
	76
	77	static inline
	78	ssize_t lttng_ustconsumer_on_read_subbuffer_splice(
	79	struct lttng_consumer_local_data *ctx,
	80	struct lttng_consumer_stream *uststream, unsigned long len,
	81	unsigned long padding)
	82	{
	83	return -ENOSYS;
	84	}
	85
	86	static inline
	87	int lttng_ustconsumer_take_snapshot(struct lttng_consumer_local_data *ctx,
	88	struct lttng_consumer_stream *stream)
	89	{
	90	return -ENOSYS;
	91	}
	92
	93	static inline
	94	int lttng_ustconsumer_get_produced_snapshot(
	95	struct lttng_consumer_local_data *ctx,
	96	struct lttng_consumer_stream *stream,
	97	unsigned long *pos)
	98	{
	99	return -ENOSYS;
	100	}
	101
	102	static inline
	103	int lttng_ustconsumer_recv_cmd(struct lttng_consumer_local_data *ctx,
	104	int sock, struct pollfd *consumer_sockpoll)
	105	{
	106	return -ENOSYS;
	107	}
	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
	121	int lttng_ustconsumer_add_stream(struct lttng_consumer_stream *stream)
	122	{
	123	return -ENOSYS;
	124	}
	125
	126	static inline
	127	void lttng_ustconsumer_del_stream(struct lttng_consumer_stream *stream)
	128	{
	129	}
	130
	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
	144	static inline
	145	void lttng_ustconsumer_on_stream_hangup(struct lttng_consumer_stream *stream)
	146	{
	147	}
	148
	149	static inline
	150	int lttng_ustctl_get_mmap_read_offset(struct lttng_ust_shm_handle *handle,
	151	struct lttng_ust_lib_ring_buffer buf, unsigned long off)
	152	{
	153	return -ENOSYS;
	154	}
	155	static inline
	156	int lttng_ustconsumer_data_pending(struct lttng_consumer_stream *stream)
	157	{
	158	return -ENOSYS;
	159	}
	160	#endif /* HAVE_LIBLTTNG_UST_CTL */
	161
	162	#endif /* _LTTNG_USTCONSUMER_H */