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