Update coding style. Add error handling section
[lttng-tools.git] / src / common / ust-consumer / ust-consumer.h
CommitLineData
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.
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
22#include <config.h>
3bd1e081
MD
23#include <errno.h>
24
10a8a223
DG
25#include <common/consumer.h>
26
74d0b642 27#ifdef HAVE_LIBLTTNG_UST_CTL
3bd1e081 28
3bd1e081
MD
29/*
30 * Take a snapshot for a specific fd
31 *
32 * Returns 0 on success, < 0 on error
33 */
34int lttng_ustconsumer_take_snapshot(struct lttng_consumer_local_data *ctx,
35 struct lttng_consumer_stream *stream);
36
37/*
38 * Get the produced position
39 *
40 * Returns 0 on success, < 0 on error
41 */
42int lttng_ustconsumer_get_produced_snapshot(
43 struct lttng_consumer_local_data *ctx,
44 struct lttng_consumer_stream *stream,
45 unsigned long *pos);
46
47int lttng_ustconsumer_recv_cmd(struct lttng_consumer_local_data *ctx,
48 int sock, struct pollfd *consumer_sockpoll);
49
50extern int lttng_ustconsumer_allocate_channel(struct lttng_consumer_channel *chan);
51extern void lttng_ustconsumer_del_channel(struct lttng_consumer_channel *chan);
52extern int lttng_ustconsumer_allocate_stream(struct lttng_consumer_stream *stream);
53extern void lttng_ustconsumer_del_stream(struct lttng_consumer_stream *stream);
54
d41f73b7
MD
55int lttng_ustconsumer_read_subbuffer(struct lttng_consumer_stream *stream,
56 struct lttng_consumer_local_data *ctx);
57int lttng_ustconsumer_on_recv_stream(struct lttng_consumer_stream *stream);
58
d056b477
MD
59void lttng_ustconsumer_on_stream_hangup(struct lttng_consumer_stream *stream);
60
f02e1e8a
DG
61extern int lttng_ustctl_get_mmap_read_offset(
62 struct lttng_ust_shm_handle *handle,
63 struct lttng_ust_lib_ring_buffer *buf, unsigned long *off);
64
74d0b642 65#else /* HAVE_LIBLTTNG_UST_CTL */
3bd1e081
MD
66
67static inline
4078b776 68ssize_t lttng_ustconsumer_on_read_subbuffer_mmap(
3bd1e081
MD
69 struct lttng_consumer_local_data *ctx,
70 struct lttng_consumer_stream *stream, unsigned long len)
71{
72 return -ENOSYS;
73}
74
75static inline
4078b776 76ssize_t lttng_ustconsumer_on_read_subbuffer_splice(
3bd1e081
MD
77 struct lttng_consumer_local_data *ctx,
78 struct lttng_consumer_stream *uststream, unsigned long len)
79{
80 return -ENOSYS;
81}
82
83static inline
84int lttng_ustconsumer_take_snapshot(struct lttng_consumer_local_data *ctx,
85 struct lttng_consumer_stream *stream)
86{
87 return -ENOSYS;
88}
89
90static inline
91int lttng_ustconsumer_get_produced_snapshot(
92 struct lttng_consumer_local_data *ctx,
93 struct lttng_consumer_stream *stream,
94 unsigned long *pos)
95{
96 return -ENOSYS;
97}
98
99static inline
100int lttng_ustconsumer_recv_cmd(struct lttng_consumer_local_data *ctx,
fbc72522
DG
101 int sock, struct pollfd *consumer_sockpoll)
102{
103 return -ENOSYS;
104}
3bd1e081
MD
105
106static inline
107int lttng_ustconsumer_allocate_channel(struct lttng_consumer_channel *chan)
108{
109 return -ENOSYS;
110}
111
112static inline
113void lttng_ustconsumer_del_channel(struct lttng_consumer_channel *chan)
114{
115}
116
117static inline
118int lttng_ustconsumer_allocate_stream(struct lttng_consumer_stream *stream)
119{
120 return -ENOSYS;
121}
122
123static inline
124void lttng_ustconsumer_del_stream(struct lttng_consumer_stream *stream)
125{
126}
127
d41f73b7
MD
128static inline
129int lttng_ustconsumer_read_subbuffer(struct lttng_consumer_stream *stream,
130 struct lttng_consumer_local_data *ctx)
131{
132 return -ENOSYS;
133}
134
135static inline
136int lttng_ustconsumer_on_recv_stream(struct lttng_consumer_stream *stream)
137{
138 return -ENOSYS;
139}
140
d056b477
MD
141static inline
142void lttng_ustconsumer_on_stream_hangup(struct lttng_consumer_stream *stream)
143{
144}
145
f02e1e8a
DG
146static inline
147int lttng_ustctl_get_mmap_read_offset(struct lttng_ust_shm_handle *handle,
148 struct lttng_ust_lib_ring_buffer *buf, unsigned long *off)
149{
150 return -ENOSYS;
151}
74d0b642 152#endif /* HAVE_LIBLTTNG_UST_CTL */
3bd1e081
MD
153
154#endif /* _LTTNG_USTCONSUMER_H */
This page took 0.051342 seconds and 4 git commands to generate.