[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>

#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);

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_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_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
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
3bd1e081 MD	22	#include <errno.h>
3bd1e081 MD	23
c8fea79c	24	#include <common/consumer/consumer.h>
10a8a223	25
74d0b642	26	#ifdef HAVE_LIBLTTNG_UST_CTL
3bd1e081	27
ffe60014	28	int lttng_ustconsumer_take_snapshot(struct lttng_consumer_stream *stream);
e9404c27 JG	29	int lttng_ustconsumer_sample_snapshot_positions(
e9404c27 JG	30	struct lttng_consumer_stream *stream);
3bd1e081	31
3bd1e081	32	int lttng_ustconsumer_get_produced_snapshot(
ffe60014	33	struct lttng_consumer_stream stream, unsigned long pos);
10a50311 JD	34	int lttng_ustconsumer_get_consumed_snapshot(
10a50311 JD	35	struct lttng_consumer_stream stream, unsigned long pos);
3bd1e081 MD	36
	37	int lttng_ustconsumer_recv_cmd(struct lttng_consumer_local_data *ctx,
	38	int sock, struct pollfd *consumer_sockpoll);
	39
	40	extern int lttng_ustconsumer_allocate_channel(struct lttng_consumer_channel *chan);
	41	extern void lttng_ustconsumer_del_channel(struct lttng_consumer_channel *chan);
b83e03c4	42	extern void lttng_ustconsumer_free_channel(struct lttng_consumer_channel *chan);
e316aad5	43	extern int lttng_ustconsumer_add_stream(struct lttng_consumer_stream *stream);
3bd1e081 MD	44	extern void lttng_ustconsumer_del_stream(struct lttng_consumer_stream *stream);
3bd1e081 MD	45
d41f73b7 MD	46	int lttng_ustconsumer_read_subbuffer(struct lttng_consumer_stream *stream,
	47	struct lttng_consumer_local_data *ctx);
	48	int lttng_ustconsumer_on_recv_stream(struct lttng_consumer_stream *stream);
	49
d056b477 MD	50	void lttng_ustconsumer_on_stream_hangup(struct lttng_consumer_stream *stream);
d056b477 MD	51
ffe60014 DG	52	int lttng_ustctl_get_mmap_read_offset(struct lttng_consumer_stream *stream,
	53	unsigned long *off);
	54	void lttng_ustctl_get_mmap_base(struct lttng_consumer_stream stream);
70190e1c DG	55	int lttng_ustconsumer_get_stream_id(struct lttng_consumer_stream *stream,
70190e1c DG	56	uint64_t *stream_id);
6d805429	57	int lttng_ustconsumer_data_pending(struct lttng_consumer_stream *stream);
6d574024 DG	58	void lttng_ustconsumer_close_all_metadata(struct lttng_ht *ht);
6d574024 DG	59	void lttng_ustconsumer_close_metadata(struct lttng_consumer_channel *metadata);
d8ef542d	60	void lttng_ustconsumer_close_stream_wakeup(struct lttng_consumer_stream *stream);
331744e3	61	int lttng_ustconsumer_recv_metadata(int sock, uint64_t key, uint64_t offset,
93ec662e JD	62	uint64_t len, uint64_t version,
93ec662e JD	63	struct lttng_consumer_channel *channel, int timer, int wait);
331744e3	64	int lttng_ustconsumer_request_metadata(struct lttng_consumer_local_data *ctx,
94d49140 JD	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);
84a182ce DG	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);
fb83fe64 JD	72	int lttng_ustconsumer_get_sequence_number(
fb83fe64 JD	73	struct lttng_consumer_stream stream, uint64_t seq);
f02e1e8a	74
74d0b642	75	#else /* HAVE_LIBLTTNG_UST_CTL */
3bd1e081 MD	76
3bd1e081 MD	77	static inline
4078b776	78	ssize_t lttng_ustconsumer_on_read_subbuffer_mmap(
3bd1e081	79	struct lttng_consumer_local_data *ctx,
1d4dfdef DG	80	struct lttng_consumer_stream *stream, unsigned long len,
1d4dfdef DG	81	unsigned long padding)
3bd1e081 MD	82	{
	83	return -ENOSYS;
	84	}
	85
	86	static inline
4078b776	87	ssize_t lttng_ustconsumer_on_read_subbuffer_splice(
3bd1e081	88	struct lttng_consumer_local_data *ctx,
1d4dfdef DG	89	struct lttng_consumer_stream *uststream, unsigned long len,
1d4dfdef DG	90	unsigned long padding)
3bd1e081 MD	91	{
	92	return -ENOSYS;
	93	}
	94
	95	static inline
ffe60014	96	int lttng_ustconsumer_take_snapshot(struct lttng_consumer_stream *stream)
3bd1e081 MD	97	{
	98	return -ENOSYS;
	99	}
	100
e9404c27 JG	101	static inline
	102	int lttng_ustconsumer_sample_snapshot_positions(
	103	struct lttng_consumer_stream *stream)
	104	{
	105	return -ENOSYS;
	106	}
	107
3bd1e081 MD	108	static inline
3bd1e081 MD	109	int lttng_ustconsumer_get_produced_snapshot(
ffe60014	110	struct lttng_consumer_stream stream, unsigned long pos)
3bd1e081 MD	111	{
	112	return -ENOSYS;
	113	}
	114
e9404c27 JG	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
3bd1e081 MD	122	static inline
3bd1e081 MD	123	int lttng_ustconsumer_recv_cmd(struct lttng_consumer_local_data *ctx,
fbc72522 DG	124	int sock, struct pollfd *consumer_sockpoll)
	125	{
	126	return -ENOSYS;
	127	}
3bd1e081 MD	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
b83e03c4 MD	140	static inline
	141	void lttng_ustconsumer_free_channel(struct lttng_consumer_channel *chan)
	142	{
	143	}
	144
3bd1e081	145	static inline
e316aad5	146	int lttng_ustconsumer_add_stream(struct lttng_consumer_stream *stream)
3bd1e081 MD	147	{
	148	return -ENOSYS;
	149	}
	150
	151	static inline
	152	void lttng_ustconsumer_del_stream(struct lttng_consumer_stream *stream)
	153	{
	154	}
	155
d41f73b7 MD	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
d056b477 MD	169	static inline
	170	void lttng_ustconsumer_on_stream_hangup(struct lttng_consumer_stream *stream)
	171	{
	172	}
	173
f02e1e8a	174	static inline
ffe60014 DG	175	int lttng_ustctl_get_mmap_read_offset(struct lttng_consumer_stream *stream,
ffe60014 DG	176	unsigned long *off)
f02e1e8a DG	177	{
	178	return -ENOSYS;
	179	}
ca22feea	180	static inline
6d805429	181	int lttng_ustconsumer_data_pending(struct lttng_consumer_stream *stream)
ca22feea DG	182	{
	183	return -ENOSYS;
	184	}
ffe60014 DG	185	static inline
	186	void lttng_ustctl_get_mmap_base(struct lttng_consumer_stream stream)
	187	{
	188	return NULL;
	189	}
d88aee68	190	static inline
6d574024 DG	191	void lttng_ustconsumer_close_all_metadata(struct lttng_ht *ht)
	192	{
	193	}
	194	static inline
	195	void lttng_ustconsumer_close_metadata(struct lttng_consumer_channel *metadata)
d88aee68 DG	196	{
d88aee68 DG	197	}
d8ef542d MD	198	static inline
	199	void lttng_ustconsumer_close_stream_wakeup(struct lttng_consumer_stream *stream)
	200	{
	201	}
ee69440b DG	202	static inline
ee69440b DG	203	int lttng_ustconsumer_recv_metadata(int sock, uint64_t key, uint64_t offset,
93ec662e JD	204	uint64_t len, uint64_t version,
93ec662e JD	205	struct lttng_consumer_channel *channel, int timer)
ee69440b DG	206	{
	207	return -ENOSYS;
	208	}
	209	static inline
ee69440b	210	int lttng_ustconsumer_request_metadata(struct lttng_consumer_local_data *ctx,
84a182ce	211	struct lttng_consumer_channel *channel, int timer, int wait)
ee69440b DG	212	{
	213	return -ENOSYS;
	214	}
94d49140 JD	215	static inline
	216	int lttng_ustconsumer_sync_metadata(struct lttng_consumer_local_data *ctx,
	217	struct lttng_consumer_stream *metadata)
	218	{
	219	return -ENOSYS;
	220	}
84a182ce DG	221	static inline
	222	void lttng_ustconsumer_flush_buffer(struct lttng_consumer_stream *stream,
	223	int producer)
	224	{
	225	}
	226	static inline
	227	int lttng_ustconsumer_get_current_timestamp(
	228	struct lttng_consumer_stream stream, uint64_t ts)
	229	{
	230	return -ENOSYS;
	231	}
a31c9f22	232	static inline
fb83fe64 JD	233	int lttng_ustconsumer_get_sequence_number(
	234	struct lttng_consumer_stream stream, uint64_t seq)
	235	{
	236	return -ENOSYS;
	237	}
70190e1c DG	238	static inline
	239	int lttng_ustconsumer_get_stream_id(struct lttng_consumer_stream *stream,
	240	uint64_t *stream_id)
	241	{
	242	return -ENOSYS;
	243	}
74d0b642	244	#endif /* HAVE_LIBLTTNG_UST_CTL */
3bd1e081 MD	245
3bd1e081 MD	246	#endif /* _LTTNG_USTCONSUMER_H */