[lttng-tools.git] / include / lttng / lttng-ustconsumer.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
 * as published by the Free Software Foundation; only version 2
 * of the License.
 *
 * 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., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
 */

#ifndef _LTTNG_USTCONSUMER_H
#define _LTTNG_USTCONSUMER_H

#include <config.h>
#include <lttng/lttng-consumer.h>
#include <errno.h>

#ifdef CONFIG_LTTNG_TOOLS_HAVE_UST

/*
 * Mmap the ring buffer, read it and write the data to the tracefile.
 *
 * Returns the number of bytes written.
 */
extern int lttng_ustconsumer_on_read_subbuffer_mmap(
		struct lttng_consumer_local_data *ctx,
		struct lttng_consumer_stream *stream, unsigned long len);

/* Not implemented */
extern int lttng_ustconsumer_on_read_subbuffer_splice(
		struct lttng_consumer_local_data *ctx,
		struct lttng_consumer_stream *stream, unsigned long len);

/*
 * Take a snapshot for a specific fd
 *
 * Returns 0 on success, < 0 on error
 */
int lttng_ustconsumer_take_snapshot(struct lttng_consumer_local_data *ctx,
        struct lttng_consumer_stream *stream);

/*
 * Get the produced position
 *
 * Returns 0 on success, < 0 on error
 */
int lttng_ustconsumer_get_produced_snapshot(
        struct lttng_consumer_local_data *ctx,
        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 int lttng_ustconsumer_allocate_stream(struct lttng_consumer_stream *stream);
extern void lttng_ustconsumer_del_stream(struct lttng_consumer_stream *stream);


#else /* CONFIG_LTTNG_TOOLS_HAVE_UST */

static inline
int lttng_ustconsumer_on_read_subbuffer_mmap(
		struct lttng_consumer_local_data *ctx,
		struct lttng_consumer_stream *stream, unsigned long len)
{
	return -ENOSYS;
}

static inline
int lttng_ustconsumer_on_read_subbuffer_splice(
		struct lttng_consumer_local_data *ctx,
		struct lttng_consumer_stream *uststream, unsigned long len)
{
	return -ENOSYS;
}

static inline
int lttng_ustconsumer_take_snapshot(struct lttng_consumer_local_data *ctx,
        struct lttng_consumer_stream *stream)
{
	return -ENOSYS;
}

static inline
int lttng_ustconsumer_get_produced_snapshot(
        struct lttng_consumer_local_data *ctx,
        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);

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
int lttng_ustconsumer_allocate_stream(struct lttng_consumer_stream *stream)
{
	return -ENOSYS;
}

static inline
void lttng_ustconsumer_del_stream(struct lttng_consumer_stream *stream)
{
}

#endif /* CONFIG_LTTNG_TOOLS_HAVE_UST */

#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	*
	5	* This program is free software; you can redistribute it and/or
	6	* modify it under the terms of the GNU General Public License
	7	* as published by the Free Software Foundation; only version 2
	8	* of the License.
	9	*
	10	* This program is distributed in the hope that it will be useful,
	11	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	12	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	13	* GNU General Public License for more details.
	14	*
	15	* You should have received a copy of the GNU General Public License
	16	* along with this program; if not, write to the Free Software
	17	* Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
	18	*/
	19
	20	#ifndef _LTTNG_USTCONSUMER_H
	21	#define _LTTNG_USTCONSUMER_H
	22
	23	#include <config.h>
	24	#include <lttng/lttng-consumer.h>
	25	#include <errno.h>
	26
	27	#ifdef CONFIG_LTTNG_TOOLS_HAVE_UST
	28
	29	/*
	30	* Mmap the ring buffer, read it and write the data to the tracefile.
	31	*
	32	* Returns the number of bytes written.
	33	*/
	34	extern int lttng_ustconsumer_on_read_subbuffer_mmap(
	35	struct lttng_consumer_local_data *ctx,
	36	struct lttng_consumer_stream *stream, unsigned long len);
	37
	38	/* Not implemented */
	39	extern int lttng_ustconsumer_on_read_subbuffer_splice(
	40	struct lttng_consumer_local_data *ctx,
	41	struct lttng_consumer_stream *stream, unsigned long len);
	42
	43	/*
	44	* Take a snapshot for a specific fd
	45	*
	46	* Returns 0 on success, < 0 on error
	47	*/
	48	int lttng_ustconsumer_take_snapshot(struct lttng_consumer_local_data *ctx,
	49	struct lttng_consumer_stream *stream);
	50
	51	/*
	52	* Get the produced position
	53	*
	54	* Returns 0 on success, < 0 on error
	55	*/
	56	int lttng_ustconsumer_get_produced_snapshot(
	57	struct lttng_consumer_local_data *ctx,
	58	struct lttng_consumer_stream *stream,
	59	unsigned long *pos);
	60
	61	int lttng_ustconsumer_recv_cmd(struct lttng_consumer_local_data *ctx,
	62	int sock, struct pollfd *consumer_sockpoll);
	63
	64	extern int lttng_ustconsumer_allocate_channel(struct lttng_consumer_channel *chan);
65	extern void lttng_ustconsumer_del_channel(struct lttng_consumer_channel *chan);
66	extern int lttng_ustconsumer_allocate_stream(struct lttng_consumer_stream *stream);
67	extern void lttng_ustconsumer_del_stream(struct lttng_consumer_stream *stream);
68
69
70	#else /* CONFIG_LTTNG_TOOLS_HAVE_UST */
71
72	static inline
73	int lttng_ustconsumer_on_read_subbuffer_mmap(
74	struct lttng_consumer_local_data *ctx,
75	struct lttng_consumer_stream *stream, unsigned long len)
76	{
77	return -ENOSYS;
78	}
79
80	static inline
81	int lttng_ustconsumer_on_read_subbuffer_splice(
82	struct lttng_consumer_local_data *ctx,
83	struct lttng_consumer_stream *uststream, unsigned long len)
84	{
85	return -ENOSYS;
86	}
87
88	static inline
89	int lttng_ustconsumer_take_snapshot(struct lttng_consumer_local_data *ctx,
90	struct lttng_consumer_stream *stream)
91	{
92	return -ENOSYS;
93	}
94
95	static inline
96	int lttng_ustconsumer_get_produced_snapshot(
97	struct lttng_consumer_local_data *ctx,
98	struct lttng_consumer_stream *stream,
99	unsigned long *pos)
100	{
101	return -ENOSYS;
102	}
103
104	static inline
105	int lttng_ustconsumer_recv_cmd(struct lttng_consumer_local_data *ctx,
106	int sock, struct pollfd *consumer_sockpoll);
107
108	static inline
109	int lttng_ustconsumer_allocate_channel(struct lttng_consumer_channel *chan)
110	{
111	return -ENOSYS;
112	}
113
114	static inline
115	void lttng_ustconsumer_del_channel(struct lttng_consumer_channel *chan)
116	{
117	}
118
119	static inline
120	int lttng_ustconsumer_allocate_stream(struct lttng_consumer_stream *stream)
121	{
122	return -ENOSYS;
123	}
124
125	static inline
126	void lttng_ustconsumer_del_stream(struct lttng_consumer_stream *stream)
127	{
128	}
129
130	#endif /* CONFIG_LTTNG_TOOLS_HAVE_UST */
131
132	#endif /* _LTTNG_USTCONSUMER_H */