2 * SPDX-License-Identifier: MIT
4 * Copyright 2019 Francis Deslauriers <francis.deslauriers@efficios.com>
5 * Copyright 2016 Jérémie Galarneau <jeremie.galarneau@efficios.com>
6 * Copyright 2016 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
8 * BabelTrace - LTTng-live client Component
11 #ifndef BABELTRACE_PLUGIN_CTF_LTTNG_LIVE_H
12 #define BABELTRACE_PLUGIN_CTF_LTTNG_LIVE_H
19 #include <babeltrace2/babeltrace.h>
21 #include "common/macros.h"
22 #include "../common/metadata/decoder.hpp"
23 #include "../common/msg-iter/msg-iter.hpp"
24 #include "viewer-connection.hpp"
26 struct lttng_live_component;
27 struct lttng_live_session;
28 struct lttng_live_msg_iter;
30 enum lttng_live_stream_state {
31 /* This stream won't have data until some known time in the future. */
32 LTTNG_LIVE_STREAM_QUIESCENT,
34 * This stream won't have data until some known time in the future and
35 * the message iterator inactivity message was already sent downstream.
37 LTTNG_LIVE_STREAM_QUIESCENT_NO_DATA, /* */
38 /* This stream has data ready to be consumed. */
39 LTTNG_LIVE_STREAM_ACTIVE_DATA,
41 * This stream has no data left to consume. We should asked the relay
44 LTTNG_LIVE_STREAM_ACTIVE_NO_DATA,
45 /* This stream won't have anymore data, ever. */
46 LTTNG_LIVE_STREAM_EOF,
49 /* Iterator over a live stream. */
50 struct lttng_live_stream_iterator {
51 bt_logging_level log_level;
52 bt_self_component *self_comp;
58 struct lttng_live_trace *trace;
61 * Since only a single iterator per viewer connection, we have
62 * only a single message iterator per stream.
64 struct ctf_msg_iter *msg_iter;
66 uint64_t viewer_stream_id;
71 } ctf_stream_class_id;
73 /* base offset in current index. */
75 /* len to read in current index. */
77 /* offset in current index. */
81 * Clock Snapshot value of the last message iterator inactivity message
90 * Clock Snapshot value of the current message iterator inactivity
91 * message we might want to send downstream.
93 uint64_t current_inactivity_ts;
95 enum lttng_live_stream_state state;
98 * The current message produced by this live stream iterator. Owned by
101 const bt_message *current_msg;
103 /* Timestamp in nanoseconds of the current message (current_msg). */
104 int64_t current_msg_ts_ns;
113 bool has_stream_hung_up;
116 struct lttng_live_metadata {
117 bt_logging_level log_level;
118 bt_self_component *self_comp;
121 /* Weak reference. */
122 struct ctf_metadata_decoder *decoder;
125 enum lttng_live_metadata_stream_state {
127 * The metadata needs to be updated. This is either because we just
128 * created the trace and haven't asked yet, or the relay specifically
129 * told us that new metadata is available.
131 LTTNG_LIVE_METADATA_STREAM_STATE_NEEDED,
133 * The metadata was updated and the relay has not told us we need to
136 LTTNG_LIVE_METADATA_STREAM_STATE_NOT_NEEDED,
138 * The relay has closed this metadata stream. We set this in reaction
139 * to a LTTNG_VIEWER_METADATA_ERR reply to a LTTNG_VIEWER_GET_METADATA
140 * command to the relay. If this field is set, we have received all the
141 * metadata that we are ever going to get for that metadata stream.
143 LTTNG_LIVE_METADATA_STREAM_STATE_CLOSED,
146 struct lttng_live_trace {
147 bt_logging_level log_level;
148 bt_self_component *self_comp;
150 /* Back reference to session. */
151 struct lttng_live_session *session;
153 /* ctf trace ID within the session. */
159 /* Weak reference. */
160 bt_trace_class *trace_class;
162 struct lttng_live_metadata *metadata;
164 const bt_clock_class *clock_class;
166 /* Array of pointers to struct lttng_live_stream_iterator. */
168 GPtrArray *stream_iterators;
170 enum lttng_live_metadata_stream_state metadata_stream_state;
173 struct lttng_live_session {
174 bt_logging_level log_level;
175 bt_self_component *self_comp;
177 /* Weak reference. */
178 struct lttng_live_msg_iter *lttng_live_msg_iter;
184 GString *session_name;
188 /* Array of pointers to struct lttng_live_trace. */
192 bool new_streams_needed;
193 bool lazy_stream_msg_init;
197 enum session_not_found_action {
198 SESSION_NOT_FOUND_ACTION_CONTINUE,
199 SESSION_NOT_FOUND_ACTION_FAIL,
200 SESSION_NOT_FOUND_ACTION_END,
204 * A component instance is an iterator on a single session.
206 struct lttng_live_component {
207 bt_logging_level log_level;
209 /* Weak reference. */
210 bt_self_component *self_comp;
214 enum session_not_found_action sess_not_found_act;
217 size_t max_query_size;
220 * Keeps track of whether the downstream component already has a
221 * message iterator on this component.
226 struct lttng_live_msg_iter {
227 bt_logging_level log_level;
228 bt_self_component *self_comp;
230 /* Weak reference. */
231 struct lttng_live_component *lttng_live_comp;
233 /* Weak reference. */
234 bt_self_message_iterator *self_msg_iter;
237 struct live_viewer_connection *viewer_connection;
239 /* Array of pointers to struct lttng_live_session. */
242 /* Number of live stream iterator this message iterator has.*/
243 uint64_t active_stream_iter;
245 /* Timestamp in nanosecond of the last message sent downstream. */
246 int64_t last_msg_ts_ns;
248 /* True if the iterator was interrupted. */
249 bool was_interrupted;
252 enum lttng_live_iterator_status {
253 /** Iterator state has progressed. Continue iteration immediately. */
254 LTTNG_LIVE_ITERATOR_STATUS_CONTINUE = 3,
255 /** No message available for now. Try again later. */
256 LTTNG_LIVE_ITERATOR_STATUS_AGAIN = 2,
257 /** No more CTF_LTTNG_LIVEs to be delivered. */
258 LTTNG_LIVE_ITERATOR_STATUS_END = 1,
259 /** No error, okay. */
260 LTTNG_LIVE_ITERATOR_STATUS_OK = 0,
261 /** Invalid arguments. */
262 LTTNG_LIVE_ITERATOR_STATUS_INVAL = -1,
263 /** General error. */
264 LTTNG_LIVE_ITERATOR_STATUS_ERROR = -2,
265 /** Out of memory. */
266 LTTNG_LIVE_ITERATOR_STATUS_NOMEM = -3,
267 /** Unsupported iterator feature. */
268 LTTNG_LIVE_ITERATOR_STATUS_UNSUPPORTED = -4,
271 bt_component_class_initialize_method_status lttng_live_component_init(
272 bt_self_component_source *self_comp,
273 bt_self_component_source_configuration *config,
274 const bt_value *params, void *init_method_data);
276 bt_component_class_query_method_status lttng_live_query(
277 bt_self_component_class_source *comp_class,
278 bt_private_query_executor *priv_query_exec,
279 const char *object, const bt_value *params,
280 void *method_data, const bt_value **result);
282 void lttng_live_component_finalize(bt_self_component_source *component);
284 bt_message_iterator_class_next_method_status lttng_live_msg_iter_next(
285 bt_self_message_iterator *iterator,
286 bt_message_array_const msgs, uint64_t capacity,
289 bt_message_iterator_class_initialize_method_status lttng_live_msg_iter_init(
290 bt_self_message_iterator *self_msg_it,
291 bt_self_message_iterator_configuration *config,
292 bt_self_component_port_output *self_port);
294 void lttng_live_msg_iter_finalize(bt_self_message_iterator *it);
296 enum lttng_live_viewer_status lttng_live_session_attach(
297 struct lttng_live_session *session,
298 bt_self_message_iterator *self_msg_iter);
300 enum lttng_live_viewer_status lttng_live_session_detach(
301 struct lttng_live_session *session);
303 enum lttng_live_iterator_status lttng_live_session_get_new_streams(
304 struct lttng_live_session *session,
305 bt_self_message_iterator *self_msg_iter);
307 struct lttng_live_trace *lttng_live_session_borrow_or_create_trace_by_id(
308 struct lttng_live_session *session, uint64_t trace_id);
310 int lttng_live_add_session(struct lttng_live_msg_iter *lttng_live_msg_iter,
312 const char *hostname,
313 const char *session_name);
316 * lttng_live_get_one_metadata_packet() asks the Relay Daemon for new metadata.
317 * If new metadata is received, the function writes it to the provided file
318 * handle and updates the reply_len output parameter. This function should be
319 * called in loop until _END status is received to ensure all metadata is
320 * written to the file.
322 enum lttng_live_get_one_metadata_status lttng_live_get_one_metadata_packet(
323 struct lttng_live_trace *trace, FILE *fp, size_t *reply_len);
325 enum lttng_live_iterator_status lttng_live_get_next_index(
326 struct lttng_live_msg_iter *lttng_live_msg_iter,
327 struct lttng_live_stream_iterator *stream,
328 struct packet_index *index);
330 enum ctf_msg_iter_medium_status lttng_live_get_stream_bytes(
331 struct lttng_live_msg_iter *lttng_live_msg_iter,
332 struct lttng_live_stream_iterator *stream, uint8_t *buf,
333 uint64_t offset, uint64_t req_len, uint64_t *recv_len);
335 bool lttng_live_graph_is_canceled(struct lttng_live_msg_iter *msg_iter);
338 void lttng_live_stream_iterator_set_state(
339 struct lttng_live_stream_iterator *stream_iter,
340 enum lttng_live_stream_state new_state);
342 #endif /* BABELTRACE_PLUGIN_CTF_LTTNG_LIVE_H */