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

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