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