[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>
 *
 * SPDX-License-Identifier: GPL-2.0-only
 *
 */

#ifndef _LTTNG_USTCONSUMER_H
#define _LTTNG_USTCONSUMER_H

#include <common/compat/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);
void lttng_ustconsumer_clear_buffer(struct lttng_consumer_stream *stream);
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
void lttng_ustconsumer_clear_buffer(struct lttng_consumer_stream *stream)
{
}
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	1	/*
ab5be9fa MJ	2	* Copyright (C) 2011 Julien Desfossez <julien.desfossez@polymtl.ca>
ab5be9fa MJ	3	* Copyright (C) 2011 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
3bd1e081	4	*
ab5be9fa	5	* SPDX-License-Identifier: GPL-2.0-only
3bd1e081	6	*
3bd1e081 MD	7	*/
	8
	9	#ifndef _LTTNG_USTCONSUMER_H
	10	#define _LTTNG_USTCONSUMER_H
	11
edf4b93e	12	#include <common/compat/errno.h>
c8fea79c	13	#include <common/consumer/consumer.h>
02d02e31	14	#include <stdbool.h>
10a8a223	15
74d0b642	16	#ifdef HAVE_LIBLTTNG_UST_CTL
3bd1e081	17
ffe60014	18	int lttng_ustconsumer_take_snapshot(struct lttng_consumer_stream *stream);
e9404c27 JG	19	int lttng_ustconsumer_sample_snapshot_positions(
e9404c27 JG	20	struct lttng_consumer_stream *stream);
3bd1e081	21
3bd1e081	22	int lttng_ustconsumer_get_produced_snapshot(
ffe60014	23	struct lttng_consumer_stream stream, unsigned long pos);
10a50311 JD	24	int lttng_ustconsumer_get_consumed_snapshot(
10a50311 JD	25	struct lttng_consumer_stream stream, unsigned long pos);
3bd1e081 MD	26
	27	int lttng_ustconsumer_recv_cmd(struct lttng_consumer_local_data *ctx,
	28	int sock, struct pollfd *consumer_sockpoll);
	29
	30	extern int lttng_ustconsumer_allocate_channel(struct lttng_consumer_channel *chan);
	31	extern void lttng_ustconsumer_del_channel(struct lttng_consumer_channel *chan);
b83e03c4	32	extern void lttng_ustconsumer_free_channel(struct lttng_consumer_channel *chan);
e316aad5	33	extern int lttng_ustconsumer_add_stream(struct lttng_consumer_stream *stream);
3bd1e081 MD	34	extern void lttng_ustconsumer_del_stream(struct lttng_consumer_stream *stream);
3bd1e081 MD	35
d41f73b7	36	int lttng_ustconsumer_read_subbuffer(struct lttng_consumer_stream *stream,
d2956687	37	struct lttng_consumer_local_data *ctx);
d41f73b7 MD	38	int lttng_ustconsumer_on_recv_stream(struct lttng_consumer_stream *stream);
d41f73b7 MD	39
d056b477 MD	40	void lttng_ustconsumer_on_stream_hangup(struct lttng_consumer_stream *stream);
d056b477 MD	41
fc6d7a51 JD	42	void lttng_ustctl_flush_buffer(struct lttng_consumer_stream *stream,
fc6d7a51 JD	43	int producer_active);
70190e1c DG	44	int lttng_ustconsumer_get_stream_id(struct lttng_consumer_stream *stream,
70190e1c DG	45	uint64_t *stream_id);
6d805429	46	int lttng_ustconsumer_data_pending(struct lttng_consumer_stream *stream);
6d574024 DG	47	void lttng_ustconsumer_close_all_metadata(struct lttng_ht *ht);
6d574024 DG	48	void lttng_ustconsumer_close_metadata(struct lttng_consumer_channel *metadata);
d8ef542d	49	void lttng_ustconsumer_close_stream_wakeup(struct lttng_consumer_stream *stream);
331744e3	50	int lttng_ustconsumer_recv_metadata(int sock, uint64_t key, uint64_t offset,
93ec662e JD	51	uint64_t len, uint64_t version,
93ec662e JD	52	struct lttng_consumer_channel *channel, int timer, int wait);
331744e3	53	int lttng_ustconsumer_request_metadata(struct lttng_consumer_local_data *ctx,
94d49140	54	struct lttng_consumer_channel *channel, int timer, int wait);
577eea73 JG	55	enum sync_metadata_status lttng_ustconsumer_sync_metadata(
577eea73 JG	56	struct lttng_consumer_local_data *ctx,
94d49140	57	struct lttng_consumer_stream *metadata);
84a182ce DG	58	void lttng_ustconsumer_flush_buffer(struct lttng_consumer_stream *stream,
84a182ce DG	59	int producer);
214f70e0	60	void lttng_ustconsumer_clear_buffer(struct lttng_consumer_stream *stream);
84a182ce DG	61	int lttng_ustconsumer_get_current_timestamp(
84a182ce DG	62	struct lttng_consumer_stream stream, uint64_t ts);
fb83fe64 JD	63	int lttng_ustconsumer_get_sequence_number(
fb83fe64 JD	64	struct lttng_consumer_stream stream, uint64_t seq);
f02e1e8a	65
74d0b642	66	#else /* HAVE_LIBLTTNG_UST_CTL */
3bd1e081 MD	67
3bd1e081 MD	68	static inline
4078b776	69	ssize_t lttng_ustconsumer_on_read_subbuffer_mmap(
3bd1e081	70	struct lttng_consumer_local_data *ctx,
1d4dfdef DG	71	struct lttng_consumer_stream *stream, unsigned long len,
1d4dfdef DG	72	unsigned long padding)
3bd1e081 MD	73	{
	74	return -ENOSYS;
	75	}
	76
	77	static inline
4078b776	78	ssize_t lttng_ustconsumer_on_read_subbuffer_splice(
3bd1e081	79	struct lttng_consumer_local_data *ctx,
1d4dfdef DG	80	struct lttng_consumer_stream *uststream, unsigned long len,
1d4dfdef DG	81	unsigned long padding)
3bd1e081 MD	82	{
	83	return -ENOSYS;
	84	}
	85
	86	static inline
ffe60014	87	int lttng_ustconsumer_take_snapshot(struct lttng_consumer_stream *stream)
3bd1e081 MD	88	{
	89	return -ENOSYS;
	90	}
	91
e9404c27 JG	92	static inline
	93	int lttng_ustconsumer_sample_snapshot_positions(
	94	struct lttng_consumer_stream *stream)
	95	{
	96	return -ENOSYS;
	97	}
	98
3bd1e081 MD	99	static inline
3bd1e081 MD	100	int lttng_ustconsumer_get_produced_snapshot(
ffe60014	101	struct lttng_consumer_stream stream, unsigned long pos)
3bd1e081 MD	102	{
	103	return -ENOSYS;
	104	}
	105
e9404c27 JG	106	static inline
	107	int lttng_ustconsumer_get_consumed_snapshot(
	108	struct lttng_consumer_stream stream, unsigned long pos)
	109	{
	110	return -ENOSYS;
	111	}
	112
3bd1e081 MD	113	static inline
3bd1e081 MD	114	int lttng_ustconsumer_recv_cmd(struct lttng_consumer_local_data *ctx,
fbc72522 DG	115	int sock, struct pollfd *consumer_sockpoll)
	116	{
	117	return -ENOSYS;
	118	}
3bd1e081 MD	119
	120	static inline
	121	int lttng_ustconsumer_allocate_channel(struct lttng_consumer_channel *chan)
	122	{
	123	return -ENOSYS;
	124	}
	125
	126	static inline
	127	void lttng_ustconsumer_del_channel(struct lttng_consumer_channel *chan)
	128	{
	129	}
	130
b83e03c4 MD	131	static inline
	132	void lttng_ustconsumer_free_channel(struct lttng_consumer_channel *chan)
	133	{
	134	}
	135
3bd1e081	136	static inline
e316aad5	137	int lttng_ustconsumer_add_stream(struct lttng_consumer_stream *stream)
3bd1e081 MD	138	{
	139	return -ENOSYS;
	140	}
	141
	142	static inline
	143	void lttng_ustconsumer_del_stream(struct lttng_consumer_stream *stream)
	144	{
	145	}
	146
d41f73b7 MD	147	static inline
d41f73b7 MD	148	int lttng_ustconsumer_read_subbuffer(struct lttng_consumer_stream *stream,
d2956687	149	struct lttng_consumer_local_data *ctx)
d41f73b7 MD	150	{
	151	return -ENOSYS;
	152	}
	153
	154	static inline
	155	int lttng_ustconsumer_on_recv_stream(struct lttng_consumer_stream *stream)
	156	{
	157	return -ENOSYS;
	158	}
	159
d056b477 MD	160	static inline
	161	void lttng_ustconsumer_on_stream_hangup(struct lttng_consumer_stream *stream)
	162	{
	163	}
	164
f02e1e8a	165	static inline
ffe60014 DG	166	int lttng_ustctl_get_mmap_read_offset(struct lttng_consumer_stream *stream,
ffe60014 DG	167	unsigned long *off)
f02e1e8a DG	168	{
	169	return -ENOSYS;
	170	}
ca22feea	171	static inline
6d805429	172	int lttng_ustconsumer_data_pending(struct lttng_consumer_stream *stream)
ca22feea DG	173	{
	174	return -ENOSYS;
	175	}
ffe60014 DG	176	static inline
	177	void lttng_ustctl_get_mmap_base(struct lttng_consumer_stream stream)
	178	{
	179	return NULL;
	180	}
d88aee68	181	static inline
fc6d7a51 JD	182	void lttng_ustctl_flush_buffer(struct lttng_consumer_stream *stream,
	183	int producer_active)
	184	{
	185	}
	186	static inline
6d574024 DG	187	void lttng_ustconsumer_close_all_metadata(struct lttng_ht *ht)
	188	{
	189	}
	190	static inline
	191	void lttng_ustconsumer_close_metadata(struct lttng_consumer_channel *metadata)
d88aee68 DG	192	{
d88aee68 DG	193	}
d8ef542d MD	194	static inline
	195	void lttng_ustconsumer_close_stream_wakeup(struct lttng_consumer_stream *stream)
	196	{
	197	}
ee69440b DG	198	static inline
ee69440b DG	199	int lttng_ustconsumer_recv_metadata(int sock, uint64_t key, uint64_t offset,
93ec662e JD	200	uint64_t len, uint64_t version,
93ec662e JD	201	struct lttng_consumer_channel *channel, int timer)
ee69440b DG	202	{
	203	return -ENOSYS;
	204	}
	205	static inline
ee69440b	206	int lttng_ustconsumer_request_metadata(struct lttng_consumer_local_data *ctx,
84a182ce	207	struct lttng_consumer_channel *channel, int timer, int wait)
ee69440b DG	208	{
	209	return -ENOSYS;
	210	}
94d49140	211	static inline
577eea73	212	enum sync_metadata_status lttng_ustconsumer_sync_metadata(struct lttng_consumer_local_data *ctx,
94d49140 JD	213	struct lttng_consumer_stream *metadata)
94d49140 JD	214	{
577eea73	215	return SYNC_METADATA_STATUS_ERROR;
94d49140	216	}
84a182ce DG	217	static inline
	218	void lttng_ustconsumer_flush_buffer(struct lttng_consumer_stream *stream,
	219	int producer)
	220	{
	221	}
	222	static inline
214f70e0 JR	223	void lttng_ustconsumer_clear_buffer(struct lttng_consumer_stream *stream)
	224	{
	225	}
	226	static inline
84a182ce DG	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 */