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.h>
13 #include <common/consumer/consumer.h>
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 void lttng_ust_flush_buffer(
43 struct lttng_consumer_stream
*stream
, int producer_active
);
44 int lttng_ustconsumer_get_stream_id(
45 struct lttng_consumer_stream
*stream
, uint64_t *stream_id
);
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 void lttng_ustconsumer_flush_buffer(struct lttng_consumer_stream
*stream
,
60 void 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
);
66 #else /* HAVE_LIBLTTNG_UST_CTL */
69 ssize_t
lttng_ustconsumer_on_read_subbuffer_mmap(
70 struct lttng_consumer_local_data
*ctx
,
71 struct lttng_consumer_stream
*stream
, unsigned long len
,
72 unsigned long padding
)
78 ssize_t
lttng_ustconsumer_on_read_subbuffer_splice(
79 struct lttng_consumer_local_data
*ctx
,
80 struct lttng_consumer_stream
*uststream
, unsigned long len
,
81 unsigned long padding
)
87 int lttng_ustconsumer_take_snapshot(struct lttng_consumer_stream
*stream
)
93 int lttng_ustconsumer_sample_snapshot_positions(
94 struct lttng_consumer_stream
*stream
)
100 int lttng_ustconsumer_get_produced_snapshot(
101 struct lttng_consumer_stream
*stream
, unsigned long *pos
)
107 int lttng_ustconsumer_get_consumed_snapshot(
108 struct lttng_consumer_stream
*stream
, unsigned long *pos
)
114 int lttng_ustconsumer_recv_cmd(struct lttng_consumer_local_data
*ctx
,
115 int sock
, struct pollfd
*consumer_sockpoll
)
121 int lttng_ustconsumer_allocate_channel(struct lttng_consumer_channel
*chan
)
127 void lttng_ustconsumer_del_channel(struct lttng_consumer_channel
*chan
)
132 void lttng_ustconsumer_free_channel(struct lttng_consumer_channel
*chan
)
137 int lttng_ustconsumer_add_stream(struct lttng_consumer_stream
*stream
)
143 void lttng_ustconsumer_del_stream(struct lttng_consumer_stream
*stream
)
148 int lttng_ustconsumer_read_subbuffer(struct lttng_consumer_stream
*stream
,
149 struct lttng_consumer_local_data
*ctx
)
155 int lttng_ustconsumer_on_recv_stream(struct lttng_consumer_stream
*stream
)
161 void lttng_ustconsumer_on_stream_hangup(struct lttng_consumer_stream
*stream
)
166 int lttng_ustconsumer_data_pending(struct lttng_consumer_stream
*stream
)
171 void lttng_ust_flush_buffer(struct lttng_consumer_stream
*stream
,
176 void lttng_ustconsumer_close_all_metadata(struct lttng_ht
*ht
)
180 void lttng_ustconsumer_close_metadata(struct lttng_consumer_channel
*metadata
)
184 void lttng_ustconsumer_close_stream_wakeup(struct lttng_consumer_stream
*stream
)
188 int lttng_ustconsumer_recv_metadata(int sock
, uint64_t key
, uint64_t offset
,
189 uint64_t len
, uint64_t version
,
190 struct lttng_consumer_channel
*channel
, int timer
)
195 int lttng_ustconsumer_request_metadata(struct lttng_consumer_local_data
*ctx
,
196 struct lttng_consumer_channel
*channel
, int timer
, int wait
)
201 enum sync_metadata_status
lttng_ustconsumer_sync_metadata(struct lttng_consumer_local_data
*ctx
,
202 struct lttng_consumer_stream
*metadata
)
204 return SYNC_METADATA_STATUS_ERROR
;
207 void lttng_ustconsumer_flush_buffer(struct lttng_consumer_stream
*stream
,
212 void lttng_ustconsumer_clear_buffer(struct lttng_consumer_stream
*stream
)
216 int lttng_ustconsumer_get_current_timestamp(
217 struct lttng_consumer_stream
*stream
, uint64_t *ts
)
222 int lttng_ustconsumer_get_sequence_number(
223 struct lttng_consumer_stream
*stream
, uint64_t *seq
)
228 int lttng_ustconsumer_get_stream_id(struct lttng_consumer_stream
*stream
,
233 #endif /* HAVE_LIBLTTNG_UST_CTL */
235 #endif /* _LTTNG_USTCONSUMER_H */