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