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

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