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