[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_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)
{
}
#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	int lttng_ustconsumer_take_snapshot(struct lttng_consumer_stream *stream);
	30
	31	int lttng_ustconsumer_get_produced_snapshot(
	32	struct lttng_consumer_stream stream, unsigned long pos);
	33
	34	int lttng_ustconsumer_recv_cmd(struct lttng_consumer_local_data *ctx,
	35	int sock, struct pollfd *consumer_sockpoll);
	36
	37	extern int lttng_ustconsumer_allocate_channel(struct lttng_consumer_channel *chan);
	38	extern void lttng_ustconsumer_del_channel(struct lttng_consumer_channel *chan);
	39	extern int lttng_ustconsumer_add_stream(struct lttng_consumer_stream *stream);
	40	extern void lttng_ustconsumer_del_stream(struct lttng_consumer_stream *stream);
	41
	42	int lttng_ustconsumer_read_subbuffer(struct lttng_consumer_stream *stream,
	43	struct lttng_consumer_local_data *ctx);
	44	int lttng_ustconsumer_on_recv_stream(struct lttng_consumer_stream *stream);
	45
	46	void lttng_ustconsumer_on_stream_hangup(struct lttng_consumer_stream *stream);
	47
	48	int lttng_ustctl_get_mmap_read_offset(struct lttng_consumer_stream *stream,
	49	unsigned long *off);
	50	void lttng_ustctl_get_mmap_base(struct lttng_consumer_stream stream);
	51	int lttng_ustconsumer_data_pending(struct lttng_consumer_stream *stream);
	52	void lttng_ustconsumer_close_metadata(struct lttng_ht *ht);
	53	void lttng_ustconsumer_close_stream_wakeup(struct lttng_consumer_stream *stream);
	54	int lttng_ustconsumer_recv_metadata(int sock, uint64_t key, uint64_t offset,
	55	uint64_t len, struct lttng_consumer_channel *channel);
	56	int lttng_ustconsumer_push_metadata(struct lttng_consumer_channel *metadata,
	57	const char *metadata_str, uint64_t target_offset, uint64_t len);
	58	int lttng_ustconsumer_request_metadata(struct lttng_consumer_local_data *ctx,
	59	struct lttng_consumer_channel *channel);
	60
	61	#else /* HAVE_LIBLTTNG_UST_CTL */
	62
	63	static inline
	64	ssize_t lttng_ustconsumer_on_read_subbuffer_mmap(
	65	struct lttng_consumer_local_data *ctx,
	66	struct lttng_consumer_stream *stream, unsigned long len,
	67	unsigned long padding)
	68	{
	69	return -ENOSYS;
	70	}
	71
	72	static inline
	73	ssize_t lttng_ustconsumer_on_read_subbuffer_splice(
	74	struct lttng_consumer_local_data *ctx,
	75	struct lttng_consumer_stream *uststream, unsigned long len,
	76	unsigned long padding)
	77	{
	78	return -ENOSYS;
	79	}
	80
	81	static inline
	82	int lttng_ustconsumer_take_snapshot(struct lttng_consumer_stream *stream)
	83	{
	84	return -ENOSYS;
	85	}
	86
	87	static inline
	88	int lttng_ustconsumer_get_produced_snapshot(
	89	struct lttng_consumer_stream stream, unsigned long pos)
	90	{
	91	return -ENOSYS;
	92	}
	93
	94	static inline
	95	int lttng_ustconsumer_recv_cmd(struct lttng_consumer_local_data *ctx,
	96	int sock, struct pollfd *consumer_sockpoll)
	97	{
	98	return -ENOSYS;
	99	}
	100
	101	static inline
	102	int lttng_ustconsumer_allocate_channel(struct lttng_consumer_channel *chan)
	103	{
	104	return -ENOSYS;
	105	}
	106
	107	static inline
	108	void lttng_ustconsumer_del_channel(struct lttng_consumer_channel *chan)
	109	{
	110	}
	111
	112	static inline
	113	int lttng_ustconsumer_add_stream(struct lttng_consumer_stream *stream)
	114	{
	115	return -ENOSYS;
	116	}
	117
	118	static inline
	119	void lttng_ustconsumer_del_stream(struct lttng_consumer_stream *stream)
	120	{
	121	}
	122
	123	static inline
	124	int lttng_ustconsumer_read_subbuffer(struct lttng_consumer_stream *stream,
	125	struct lttng_consumer_local_data *ctx)
	126	{
	127	return -ENOSYS;
	128	}
	129
	130	static inline
	131	int lttng_ustconsumer_on_recv_stream(struct lttng_consumer_stream *stream)
	132	{
	133	return -ENOSYS;
	134	}
	135
	136	static inline
	137	void lttng_ustconsumer_on_stream_hangup(struct lttng_consumer_stream *stream)
	138	{
	139	}
	140
	141	static inline
	142	int lttng_ustctl_get_mmap_read_offset(struct lttng_consumer_stream *stream,
	143	unsigned long *off)
	144	{
	145	return -ENOSYS;
	146	}
	147	static inline
	148	int lttng_ustconsumer_data_pending(struct lttng_consumer_stream *stream)
	149	{
	150	return -ENOSYS;
	151	}
	152	static inline
	153	void lttng_ustctl_get_mmap_base(struct lttng_consumer_stream stream)
	154	{
	155	return NULL;
	156	}
	157	static inline
	158	void lttng_ustconsumer_close_metadata(struct lttng_ht *ht)
	159	{
	160	}
	161	static inline
	162	void lttng_ustconsumer_close_stream_wakeup(struct lttng_consumer_stream *stream)
	163	{
	164	}
	165	#endif /* HAVE_LIBLTTNG_UST_CTL */
	166
	167	#endif /* _LTTNG_USTCONSUMER_H */