2 * Copyright (C) 2011 Julien Desfossez <julien.desfossez@polymtl.ca>
3 * Copyright (C) 2011 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
5 * SPDX-License-Identifier: GPL-2.0-only
9 #ifndef _LTTNG_USTCONSUMER_H
10 #define _LTTNG_USTCONSUMER_H
12 #include <common/compat/errno.hpp>
13 #include <common/consumer/consumer.hpp>
16 #ifdef HAVE_LIBLTTNG_UST_CTL
18 int lttng_ustconsumer_take_snapshot(struct lttng_consumer_stream *stream);
19 int lttng_ustconsumer_sample_snapshot_positions(
20 struct lttng_consumer_stream *stream);
22 int lttng_ustconsumer_get_produced_snapshot(
23 struct lttng_consumer_stream *stream, unsigned long *pos);
24 int lttng_ustconsumer_get_consumed_snapshot(
25 struct lttng_consumer_stream *stream, unsigned long *pos);
27 int lttng_ustconsumer_recv_cmd(struct lttng_consumer_local_data *ctx,
28 int sock, struct pollfd *consumer_sockpoll);
30 extern int lttng_ustconsumer_allocate_channel(struct lttng_consumer_channel *chan);
31 extern void lttng_ustconsumer_del_channel(struct lttng_consumer_channel *chan);
32 extern void lttng_ustconsumer_free_channel(struct lttng_consumer_channel *chan);
33 extern int lttng_ustconsumer_add_stream(struct lttng_consumer_stream *stream);
34 extern void lttng_ustconsumer_del_stream(struct lttng_consumer_stream *stream);
36 int lttng_ustconsumer_read_subbuffer(struct lttng_consumer_stream *stream,
37 struct lttng_consumer_local_data *ctx);
38 int lttng_ustconsumer_on_recv_stream(struct lttng_consumer_stream *stream);
40 void lttng_ustconsumer_on_stream_hangup(struct lttng_consumer_stream *stream);
42 int lttng_ust_flush_buffer(struct lttng_consumer_stream *stream,
44 int lttng_ustconsumer_get_stream_id(struct lttng_consumer_stream *stream,
46 int lttng_ustconsumer_data_pending(struct lttng_consumer_stream *stream);
47 void lttng_ustconsumer_close_all_metadata(struct lttng_ht *ht);
48 void lttng_ustconsumer_close_metadata(struct lttng_consumer_channel *metadata);
49 void lttng_ustconsumer_close_stream_wakeup(struct lttng_consumer_stream *stream);
50 int lttng_ustconsumer_recv_metadata(int sock, uint64_t key, uint64_t offset,
51 uint64_t len, uint64_t version,
52 struct lttng_consumer_channel *channel, int timer, int wait);
53 int lttng_ustconsumer_request_metadata(struct lttng_consumer_local_data *ctx,
54 struct lttng_consumer_channel *channel, int timer, int wait);
55 enum sync_metadata_status lttng_ustconsumer_sync_metadata(
56 struct lttng_consumer_local_data *ctx,
57 struct lttng_consumer_stream *metadata);
58 int lttng_ustconsumer_flush_buffer(struct lttng_consumer_stream *stream,
60 int lttng_ustconsumer_clear_buffer(struct lttng_consumer_stream *stream);
61 int lttng_ustconsumer_get_current_timestamp(
62 struct lttng_consumer_stream *stream, uint64_t *ts);
63 int lttng_ustconsumer_get_sequence_number(
64 struct lttng_consumer_stream *stream, uint64_t *seq);
65 void lttng_ustconsumer_sigbus_handle(void *addr);
67 #else /* HAVE_LIBLTTNG_UST_CTL */
70 ssize_t lttng_ustconsumer_on_read_subbuffer_mmap(
71 struct lttng_consumer_local_data *ctx,
72 struct lttng_consumer_stream *stream, unsigned long len,
73 unsigned long padding)
79 ssize_t lttng_ustconsumer_on_read_subbuffer_splice(
80 struct lttng_consumer_local_data *ctx,
81 struct lttng_consumer_stream *uststream, unsigned long len,
82 unsigned long padding)
88 int lttng_ustconsumer_take_snapshot(struct lttng_consumer_stream *stream)
94 int lttng_ustconsumer_sample_snapshot_positions(
95 struct lttng_consumer_stream *stream)
101 int lttng_ustconsumer_get_produced_snapshot(
102 struct lttng_consumer_stream *stream, unsigned long *pos)
108 int lttng_ustconsumer_get_consumed_snapshot(
109 struct lttng_consumer_stream *stream, unsigned long *pos)
115 int lttng_ustconsumer_recv_cmd(struct lttng_consumer_local_data *ctx,
116 int sock, struct pollfd *consumer_sockpoll)
122 int lttng_ustconsumer_allocate_channel(struct lttng_consumer_channel *chan)
128 void lttng_ustconsumer_del_channel(struct lttng_consumer_channel *chan)
133 void lttng_ustconsumer_free_channel(struct lttng_consumer_channel *chan)
138 int lttng_ustconsumer_add_stream(struct lttng_consumer_stream *stream)
144 void lttng_ustconsumer_del_stream(struct lttng_consumer_stream *stream)
149 int lttng_ustconsumer_read_subbuffer(struct lttng_consumer_stream *stream,
150 struct lttng_consumer_local_data *ctx)
156 int lttng_ustconsumer_on_recv_stream(struct lttng_consumer_stream *stream)
162 void lttng_ustconsumer_on_stream_hangup(struct lttng_consumer_stream *stream)
167 int lttng_ustconsumer_data_pending(struct lttng_consumer_stream *stream)
172 int lttng_ust_flush_buffer(struct lttng_consumer_stream *stream,
178 void lttng_ustconsumer_close_all_metadata(struct lttng_ht *ht)
182 void lttng_ustconsumer_close_metadata(struct lttng_consumer_channel *metadata)
186 void lttng_ustconsumer_close_stream_wakeup(struct lttng_consumer_stream *stream)
190 int lttng_ustconsumer_recv_metadata(int sock, uint64_t key, uint64_t offset,
191 uint64_t len, uint64_t version,
192 struct lttng_consumer_channel *channel, int timer)
197 int lttng_ustconsumer_request_metadata(struct lttng_consumer_local_data *ctx,
198 struct lttng_consumer_channel *channel, int timer, int wait)
203 enum sync_metadata_status lttng_ustconsumer_sync_metadata(struct lttng_consumer_local_data *ctx,
204 struct lttng_consumer_stream *metadata)
206 return SYNC_METADATA_STATUS_ERROR;
209 int lttng_ustconsumer_flush_buffer(struct lttng_consumer_stream *stream,
215 int lttng_ustconsumer_clear_buffer(struct lttng_consumer_stream *stream)
220 int lttng_ustconsumer_get_current_timestamp(
221 struct lttng_consumer_stream *stream, uint64_t *ts)
226 int lttng_ustconsumer_get_sequence_number(
227 struct lttng_consumer_stream *stream, uint64_t *seq)
232 int lttng_ustconsumer_get_stream_id(struct lttng_consumer_stream *stream,
238 void lttng_ustconsumer_sigbus_handle(void *addr)
241 #endif /* HAVE_LIBLTTNG_UST_CTL */
243 #endif /* _LTTNG_USTCONSUMER_H */