[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>
#include <stdbool.h>

#ifdef HAVE_LIBLTTNG_UST_CTL

int lttng_ustconsumer_take_snapshot(struct lttng_consumer_stream *stream);
int lttng_ustconsumer_sample_snapshot_positions(
		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);

void lttng_ustctl_flush_buffer(struct lttng_consumer_stream *stream,
		int producer_active);
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, uint64_t version,
		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);
enum sync_metadata_status 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_sample_snapshot_positions(
		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_get_consumed_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_ustctl_flush_buffer(struct lttng_consumer_stream *stream,
		int producer_active)
{
}
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, uint64_t version,
		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
enum sync_metadata_status lttng_ustconsumer_sync_metadata(struct lttng_consumer_local_data *ctx,
		struct lttng_consumer_stream *metadata)
{
	return SYNC_METADATA_STATUS_ERROR;
}
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_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
	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 <errno.h>
	23
	24	#include <common/consumer/consumer.h>
	25	#include <stdbool.h>
	26
	27	#ifdef HAVE_LIBLTTNG_UST_CTL
	28
	29	int lttng_ustconsumer_take_snapshot(struct lttng_consumer_stream *stream);
	30	int lttng_ustconsumer_sample_snapshot_positions(
	31	struct lttng_consumer_stream *stream);
	32
	33	int lttng_ustconsumer_get_produced_snapshot(
	34	struct lttng_consumer_stream stream, unsigned long pos);
	35	int lttng_ustconsumer_get_consumed_snapshot(
	36	struct lttng_consumer_stream stream, unsigned long pos);
	37
	38	int lttng_ustconsumer_recv_cmd(struct lttng_consumer_local_data *ctx,
	39	int sock, struct pollfd *consumer_sockpoll);
	40
	41	extern int lttng_ustconsumer_allocate_channel(struct lttng_consumer_channel *chan);
	42	extern void lttng_ustconsumer_del_channel(struct lttng_consumer_channel *chan);
	43	extern void lttng_ustconsumer_free_channel(struct lttng_consumer_channel *chan);
	44	extern int lttng_ustconsumer_add_stream(struct lttng_consumer_stream *stream);
	45	extern void lttng_ustconsumer_del_stream(struct lttng_consumer_stream *stream);
	46
	47	int lttng_ustconsumer_read_subbuffer(struct lttng_consumer_stream *stream,
	48	struct lttng_consumer_local_data *ctx);
	49	int lttng_ustconsumer_on_recv_stream(struct lttng_consumer_stream *stream);
	50
	51	void lttng_ustconsumer_on_stream_hangup(struct lttng_consumer_stream *stream);
	52
	53	void lttng_ustctl_flush_buffer(struct lttng_consumer_stream *stream,
	54	int producer_active);
	55	int lttng_ustconsumer_get_stream_id(struct lttng_consumer_stream *stream,
	56	uint64_t *stream_id);
	57	int lttng_ustconsumer_data_pending(struct lttng_consumer_stream *stream);
	58	void lttng_ustconsumer_close_all_metadata(struct lttng_ht *ht);
	59	void lttng_ustconsumer_close_metadata(struct lttng_consumer_channel *metadata);
	60	void lttng_ustconsumer_close_stream_wakeup(struct lttng_consumer_stream *stream);
	61	int lttng_ustconsumer_recv_metadata(int sock, uint64_t key, uint64_t offset,
	62	uint64_t len, uint64_t version,
	63	struct lttng_consumer_channel *channel, int timer, int wait);
	64	int lttng_ustconsumer_request_metadata(struct lttng_consumer_local_data *ctx,
	65	struct lttng_consumer_channel *channel, int timer, int wait);
	66	enum sync_metadata_status lttng_ustconsumer_sync_metadata(
	67	struct lttng_consumer_local_data *ctx,
	68	struct lttng_consumer_stream *metadata);
	69	void lttng_ustconsumer_flush_buffer(struct lttng_consumer_stream *stream,
	70	int producer);
	71	int lttng_ustconsumer_get_current_timestamp(
	72	struct lttng_consumer_stream stream, uint64_t ts);
	73	int lttng_ustconsumer_get_sequence_number(
	74	struct lttng_consumer_stream stream, uint64_t seq);
	75
	76	#else /* HAVE_LIBLTTNG_UST_CTL */
	77
	78	static inline
	79	ssize_t lttng_ustconsumer_on_read_subbuffer_mmap(
	80	struct lttng_consumer_local_data *ctx,
	81	struct lttng_consumer_stream *stream, unsigned long len,
	82	unsigned long padding)
	83	{
	84	return -ENOSYS;
	85	}
	86
	87	static inline
	88	ssize_t lttng_ustconsumer_on_read_subbuffer_splice(
	89	struct lttng_consumer_local_data *ctx,
	90	struct lttng_consumer_stream *uststream, unsigned long len,
	91	unsigned long padding)
	92	{
	93	return -ENOSYS;
	94	}
	95
	96	static inline
	97	int lttng_ustconsumer_take_snapshot(struct lttng_consumer_stream *stream)
	98	{
	99	return -ENOSYS;
	100	}
	101
	102	static inline
	103	int lttng_ustconsumer_sample_snapshot_positions(
	104	struct lttng_consumer_stream *stream)
	105	{
	106	return -ENOSYS;
	107	}
	108
	109	static inline
	110	int lttng_ustconsumer_get_produced_snapshot(
	111	struct lttng_consumer_stream stream, unsigned long pos)
	112	{
	113	return -ENOSYS;
	114	}
	115
	116	static inline
	117	int lttng_ustconsumer_get_consumed_snapshot(
	118	struct lttng_consumer_stream stream, unsigned long pos)
	119	{
	120	return -ENOSYS;
	121	}
	122
	123	static inline
	124	int lttng_ustconsumer_recv_cmd(struct lttng_consumer_local_data *ctx,
	125	int sock, struct pollfd *consumer_sockpoll)
	126	{
	127	return -ENOSYS;
	128	}
	129
	130	static inline
	131	int lttng_ustconsumer_allocate_channel(struct lttng_consumer_channel *chan)
	132	{
	133	return -ENOSYS;
	134	}
	135
	136	static inline
	137	void lttng_ustconsumer_del_channel(struct lttng_consumer_channel *chan)
	138	{
	139	}
	140
	141	static inline
	142	void lttng_ustconsumer_free_channel(struct lttng_consumer_channel *chan)
	143	{
	144	}
	145
	146	static inline
	147	int lttng_ustconsumer_add_stream(struct lttng_consumer_stream *stream)
	148	{
	149	return -ENOSYS;
	150	}
	151
	152	static inline
	153	void lttng_ustconsumer_del_stream(struct lttng_consumer_stream *stream)
	154	{
	155	}
	156
	157	static inline
	158	int lttng_ustconsumer_read_subbuffer(struct lttng_consumer_stream *stream,
	159	struct lttng_consumer_local_data *ctx)
	160	{
	161	return -ENOSYS;
	162	}
	163
	164	static inline
	165	int lttng_ustconsumer_on_recv_stream(struct lttng_consumer_stream *stream)
	166	{
	167	return -ENOSYS;
	168	}
	169
	170	static inline
	171	void lttng_ustconsumer_on_stream_hangup(struct lttng_consumer_stream *stream)
	172	{
	173	}
	174
	175	static inline
	176	int lttng_ustctl_get_mmap_read_offset(struct lttng_consumer_stream *stream,
	177	unsigned long *off)
	178	{
	179	return -ENOSYS;
	180	}
	181	static inline
	182	int lttng_ustconsumer_data_pending(struct lttng_consumer_stream *stream)
	183	{
	184	return -ENOSYS;
	185	}
	186	static inline
	187	void lttng_ustctl_get_mmap_base(struct lttng_consumer_stream stream)
	188	{
	189	return NULL;
	190	}
	191	static inline
	192	void lttng_ustctl_flush_buffer(struct lttng_consumer_stream *stream,
	193	int producer_active)
	194	{
	195	}
	196	static inline
	197	void lttng_ustconsumer_close_all_metadata(struct lttng_ht *ht)
	198	{
	199	}
	200	static inline
	201	void lttng_ustconsumer_close_metadata(struct lttng_consumer_channel *metadata)
	202	{
	203	}
	204	static inline
	205	void lttng_ustconsumer_close_stream_wakeup(struct lttng_consumer_stream *stream)
	206	{
	207	}
	208	static inline
	209	int lttng_ustconsumer_recv_metadata(int sock, uint64_t key, uint64_t offset,
	210	uint64_t len, uint64_t version,
	211	struct lttng_consumer_channel *channel, int timer)
	212	{
	213	return -ENOSYS;
	214	}
	215	static inline
	216	int lttng_ustconsumer_request_metadata(struct lttng_consumer_local_data *ctx,
	217	struct lttng_consumer_channel *channel, int timer, int wait)
	218	{
	219	return -ENOSYS;
	220	}
	221	static inline
	222	enum sync_metadata_status lttng_ustconsumer_sync_metadata(struct lttng_consumer_local_data *ctx,
	223	struct lttng_consumer_stream *metadata)
	224	{
	225	return SYNC_METADATA_STATUS_ERROR;
	226	}
	227	static inline
	228	void lttng_ustconsumer_flush_buffer(struct lttng_consumer_stream *stream,
	229	int producer)
	230	{
	231	}
	232	static inline
	233	int lttng_ustconsumer_get_current_timestamp(
	234	struct lttng_consumer_stream stream, uint64_t ts)
	235	{
	236	return -ENOSYS;
	237	}
	238	static inline
	239	int lttng_ustconsumer_get_sequence_number(
	240	struct lttng_consumer_stream stream, uint64_t seq)
	241	{
	242	return -ENOSYS;
	243	}
	244	static inline
	245	int lttng_ustconsumer_get_stream_id(struct lttng_consumer_stream *stream,
	246	uint64_t *stream_id)
	247	{
	248	return -ENOSYS;
	249	}
	250	#endif /* HAVE_LIBLTTNG_UST_CTL */
	251
	252	#endif /* _LTTNG_USTCONSUMER_H */