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