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
17 #include <babeltrace2/babeltrace.h>
19 #include "cpp-common/vendor/fmt/format.h" /* IWYU pragma: keep */
21 #include "../common/src/metadata/tsdl/decoder.hpp"
22 #include "../common/src/msg-iter/msg-iter.hpp"
23 #include "viewer-connection.hpp"
25 enum lttng_live_stream_state
27 /* This stream won't have data until some known time in the future. */
28 LTTNG_LIVE_STREAM_QUIESCENT,
30 * This stream won't have data until some known time in the future and
31 * the message iterator inactivity message was already sent downstream.
33 LTTNG_LIVE_STREAM_QUIESCENT_NO_DATA, /* */
34 /* This stream has data ready to be consumed. */
35 LTTNG_LIVE_STREAM_ACTIVE_DATA,
37 * This stream has no data left to consume. We should asked the relay
40 LTTNG_LIVE_STREAM_ACTIVE_NO_DATA,
41 /* This stream won't have anymore data, ever. */
42 LTTNG_LIVE_STREAM_EOF,
45 inline const char *format_as(const lttng_live_stream_state state) noexcept
48 case LTTNG_LIVE_STREAM_ACTIVE_NO_DATA:
49 return "ACTIVE_NO_DATA";
51 case LTTNG_LIVE_STREAM_QUIESCENT_NO_DATA:
52 return "QUIESCENT_NO_DATA";
54 case LTTNG_LIVE_STREAM_QUIESCENT:
57 case LTTNG_LIVE_STREAM_ACTIVE_DATA:
60 case LTTNG_LIVE_STREAM_EOF:
67 /* Iterator over a live stream. */
68 struct lttng_live_stream_iterator
70 explicit lttng_live_stream_iterator(const bt2c::Logger& parentLogger) :
71 logger {parentLogger, "PLUGIN/SRC.CTF.LTTNG-LIVE/STREAM-ITER"}
78 bt_stream *stream = nullptr;
81 struct lttng_live_trace *trace = nullptr;
84 * Since only a single iterator per viewer connection, we have
85 * only a single message iterator per stream.
87 struct ctf_msg_iter *msg_iter = nullptr;
89 uint64_t viewer_stream_id = 0;
95 } ctf_stream_class_id;
97 /* base offset in current index. */
98 uint64_t base_offset = 0;
99 /* len to read in current index. */
101 /* offset in current index. */
105 * Clock Snapshot value of the last message iterator inactivity message
112 } last_inactivity_ts;
115 * Clock Snapshot value of the current message iterator inactivity
116 * message we might want to send downstream.
118 uint64_t current_inactivity_ts = 0;
120 enum lttng_live_stream_state state = LTTNG_LIVE_STREAM_QUIESCENT;
123 * The current message produced by this live stream iterator. Owned by
126 const bt_message *current_msg = nullptr;
128 /* Timestamp in nanoseconds of the current message (current_msg). */
129 int64_t current_msg_ts_ns = 0;
132 uint8_t *buf = nullptr;
136 GString *name = nullptr;
138 bool has_stream_hung_up = false;
141 struct lttng_live_metadata
143 using UP = std::unique_ptr<lttng_live_metadata>;
145 explicit lttng_live_metadata(const bt2c::Logger& parentLogger) :
146 logger {parentLogger, "PLUGIN/SRC.CTF.LTTNG-LIVE/METADATA"}
152 uint64_t stream_id = 0;
154 /* Weak reference. */
155 ctf_metadata_decoder_up decoder;
158 enum lttng_live_metadata_stream_state
161 * The metadata needs to be updated. This is either because we just
162 * created the trace and haven't asked yet, or the relay specifically
163 * told us that new metadata is available.
165 LTTNG_LIVE_METADATA_STREAM_STATE_NEEDED,
167 * The metadata was updated and the relay has not told us we need to
170 LTTNG_LIVE_METADATA_STREAM_STATE_NOT_NEEDED,
172 * The relay has closed this metadata stream. We set this in reaction
173 * to a LTTNG_VIEWER_METADATA_ERR reply to a LTTNG_VIEWER_GET_METADATA
174 * command to the relay. If this field is set, we have received all the
175 * metadata that we are ever going to get for that metadata stream.
177 LTTNG_LIVE_METADATA_STREAM_STATE_CLOSED,
180 struct lttng_live_trace
182 explicit lttng_live_trace(const bt2c::Logger& parentLogger) :
183 logger {parentLogger, "PLUGIN/SRC.CTF.LTTNG-LIVE/TRACE"}
189 /* Back reference to session. */
190 struct lttng_live_session *session = nullptr;
192 /* ctf trace ID within the session. */
195 bt2::Trace::Shared trace;
197 bt2::TraceClass::Shared trace_class;
199 lttng_live_metadata::UP metadata;
201 const bt_clock_class *clock_class = nullptr;
203 /* Array of pointers to struct lttng_live_stream_iterator. */
205 GPtrArray *stream_iterators = nullptr;
207 enum lttng_live_metadata_stream_state metadata_stream_state =
208 LTTNG_LIVE_METADATA_STREAM_STATE_NEEDED;
211 struct lttng_live_session
213 explicit lttng_live_session(const bt2c::Logger& parentLogger) :
214 logger {parentLogger, "PLUGIN/SRC.CTF.LTTNG-LIVE/SESSION"}
220 bt_self_component *self_comp = nullptr;
222 /* Weak reference. */
223 struct lttng_live_msg_iter *lttng_live_msg_iter = nullptr;
226 GString *hostname = nullptr;
229 GString *session_name = nullptr;
233 /* Array of pointers to struct lttng_live_trace. */
234 GPtrArray *traces = nullptr;
236 bool attached = false;
237 bool new_streams_needed = false;
238 bool lazy_stream_msg_init = false;
242 enum session_not_found_action
244 SESSION_NOT_FOUND_ACTION_CONTINUE,
245 SESSION_NOT_FOUND_ACTION_FAIL,
246 SESSION_NOT_FOUND_ACTION_END,
250 * A component instance is an iterator on a single session.
252 struct lttng_live_component
254 using UP = std::unique_ptr<lttng_live_component>;
256 explicit lttng_live_component(bt2c::Logger loggerParam) noexcept :
257 logger {std::move(loggerParam)}
263 /* Weak reference. */
264 bt_self_component *self_comp = nullptr;
269 enum session_not_found_action sess_not_found_act = SESSION_NOT_FOUND_ACTION_CONTINUE;
272 size_t max_query_size = 0;
275 * Keeps track of whether the downstream component already has a
276 * message iterator on this component.
278 bool has_msg_iter = false;
281 struct lttng_live_msg_iter
283 explicit lttng_live_msg_iter(const bt2c::Logger& parentLogger) :
284 logger {parentLogger, "PLUGIN/SRC.CTF.LTTNG-LIVE/MSG-ITER"}
290 bt_self_component *self_comp = nullptr;
292 /* Weak reference. */
293 struct lttng_live_component *lttng_live_comp = nullptr;
295 /* Weak reference. */
296 bt_self_message_iterator *self_msg_iter = nullptr;
299 struct live_viewer_connection *viewer_connection = nullptr;
301 /* Array of pointers to struct lttng_live_session. */
302 GPtrArray *sessions = nullptr;
304 /* Number of live stream iterator this message iterator has.*/
305 uint64_t active_stream_iter = 0;
307 /* Timestamp in nanosecond of the last message sent downstream. */
308 int64_t last_msg_ts_ns = 0;
310 /* True if the iterator was interrupted. */
311 bool was_interrupted = false;
314 enum lttng_live_iterator_status
316 /** Iterator state has progressed. Continue iteration immediately. */
317 LTTNG_LIVE_ITERATOR_STATUS_CONTINUE = 3,
318 /** No message available for now. Try again later. */
319 LTTNG_LIVE_ITERATOR_STATUS_AGAIN = 2,
320 /** No more CTF_LTTNG_LIVEs to be delivered. */
321 LTTNG_LIVE_ITERATOR_STATUS_END = 1,
322 /** No error, okay. */
323 LTTNG_LIVE_ITERATOR_STATUS_OK = 0,
324 /** Invalid arguments. */
325 LTTNG_LIVE_ITERATOR_STATUS_INVAL = -1,
326 /** General error. */
327 LTTNG_LIVE_ITERATOR_STATUS_ERROR = -2,
328 /** Out of memory. */
329 LTTNG_LIVE_ITERATOR_STATUS_NOMEM = -3,
330 /** Unsupported iterator feature. */
331 LTTNG_LIVE_ITERATOR_STATUS_UNSUPPORTED = -4,
334 inline const char *format_as(const lttng_live_iterator_status status) noexcept
337 case LTTNG_LIVE_ITERATOR_STATUS_CONTINUE:
338 return "LTTNG_LIVE_ITERATOR_STATUS_CONTINUE";
340 case LTTNG_LIVE_ITERATOR_STATUS_AGAIN:
341 return "LTTNG_LIVE_ITERATOR_STATUS_AGAIN";
343 case LTTNG_LIVE_ITERATOR_STATUS_END:
344 return "LTTNG_LIVE_ITERATOR_STATUS_END";
346 case LTTNG_LIVE_ITERATOR_STATUS_OK:
347 return "LTTNG_LIVE_ITERATOR_STATUS_OK";
349 case LTTNG_LIVE_ITERATOR_STATUS_INVAL:
350 return "LTTNG_LIVE_ITERATOR_STATUS_INVAL";
352 case LTTNG_LIVE_ITERATOR_STATUS_ERROR:
353 return "LTTNG_LIVE_ITERATOR_STATUS_ERROR";
355 case LTTNG_LIVE_ITERATOR_STATUS_NOMEM:
356 return "LTTNG_LIVE_ITERATOR_STATUS_NOMEM";
358 case LTTNG_LIVE_ITERATOR_STATUS_UNSUPPORTED:
359 return "LTTNG_LIVE_ITERATOR_STATUS_UNSUPPORTED";
365 bt_component_class_initialize_method_status
366 lttng_live_component_init(bt_self_component_source *self_comp,
367 bt_self_component_source_configuration *config, const bt_value *params,
368 void *init_method_data);
370 bt_component_class_query_method_status lttng_live_query(bt_self_component_class_source *comp_class,
371 bt_private_query_executor *priv_query_exec,
372 const char *object, const bt_value *params,
373 void *method_data, const bt_value **result);
375 void lttng_live_component_finalize(bt_self_component_source *component);
377 bt_message_iterator_class_next_method_status
378 lttng_live_msg_iter_next(bt_self_message_iterator *iterator, bt_message_array_const msgs,
379 uint64_t capacity, uint64_t *count);
381 bt_message_iterator_class_initialize_method_status
382 lttng_live_msg_iter_init(bt_self_message_iterator *self_msg_it,
383 bt_self_message_iterator_configuration *config,
384 bt_self_component_port_output *self_port);
386 void lttng_live_msg_iter_finalize(bt_self_message_iterator *it);
388 enum lttng_live_viewer_status lttng_live_session_attach(struct lttng_live_session *session,
389 bt_self_message_iterator *self_msg_iter);
391 enum lttng_live_viewer_status lttng_live_session_detach(struct lttng_live_session *session);
393 enum lttng_live_iterator_status
394 lttng_live_session_get_new_streams(struct lttng_live_session *session,
395 bt_self_message_iterator *self_msg_iter);
397 struct lttng_live_trace *
398 lttng_live_session_borrow_or_create_trace_by_id(struct lttng_live_session *session,
401 int lttng_live_add_session(struct lttng_live_msg_iter *lttng_live_msg_iter, uint64_t session_id,
402 const char *hostname, const char *session_name);
405 * lttng_live_get_one_metadata_packet() asks the Relay Daemon for new metadata.
406 * If new metadata is received, the function writes it to the provided file
407 * handle and updates the reply_len output parameter. This function should be
408 * called in loop until _END status is received to ensure all metadata is
409 * written to the file.
411 enum lttng_live_get_one_metadata_status
412 lttng_live_get_one_metadata_packet(struct lttng_live_trace *trace, std::vector<char>& buf);
414 enum lttng_live_iterator_status
415 lttng_live_get_next_index(struct lttng_live_msg_iter *lttng_live_msg_iter,
416 struct lttng_live_stream_iterator *stream, struct packet_index *index);
418 enum ctf_msg_iter_medium_status
419 lttng_live_get_stream_bytes(struct lttng_live_msg_iter *lttng_live_msg_iter,
420 struct lttng_live_stream_iterator *stream, uint8_t *buf,
421 uint64_t offset, uint64_t req_len, uint64_t *recv_len);
423 bool lttng_live_graph_is_canceled(struct lttng_live_msg_iter *msg_iter);
425 void lttng_live_stream_iterator_set_state(struct lttng_live_stream_iterator *stream_iter,
426 enum lttng_live_stream_state new_state);
428 #endif /* BABELTRACE_PLUGIN_CTF_LTTNG_LIVE_H */