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 "../common/src/metadata/tsdl/decoder.hpp"
20 #include "../common/src/msg-iter/msg-iter.hpp"
21 #include "viewer-connection.hpp"
23 enum lttng_live_stream_state
25 /* This stream won't have data until some known time in the future. */
26 LTTNG_LIVE_STREAM_QUIESCENT,
28 * This stream won't have data until some known time in the future and
29 * the message iterator inactivity message was already sent downstream.
31 LTTNG_LIVE_STREAM_QUIESCENT_NO_DATA, /* */
32 /* This stream has data ready to be consumed. */
33 LTTNG_LIVE_STREAM_ACTIVE_DATA,
35 * This stream has no data left to consume. We should asked the relay
38 LTTNG_LIVE_STREAM_ACTIVE_NO_DATA,
39 /* This stream won't have anymore data, ever. */
40 LTTNG_LIVE_STREAM_EOF,
43 /* Iterator over a live stream. */
44 struct lttng_live_stream_iterator
46 bt_logging_level log_level;
47 bt_self_component *self_comp;
53 struct lttng_live_trace *trace;
56 * Since only a single iterator per viewer connection, we have
57 * only a single message iterator per stream.
59 struct ctf_msg_iter *msg_iter;
61 uint64_t viewer_stream_id;
67 } ctf_stream_class_id;
69 /* base offset in current index. */
71 /* len to read in current index. */
73 /* offset in current index. */
77 * Clock Snapshot value of the last message iterator inactivity message
87 * Clock Snapshot value of the current message iterator inactivity
88 * message we might want to send downstream.
90 uint64_t current_inactivity_ts;
92 enum lttng_live_stream_state state;
95 * The current message produced by this live stream iterator. Owned by
98 const bt_message *current_msg;
100 /* Timestamp in nanoseconds of the current message (current_msg). */
101 int64_t current_msg_ts_ns;
110 bool has_stream_hung_up;
113 struct lttng_live_metadata
115 bt_logging_level log_level;
116 bt_self_component *self_comp;
119 /* Weak reference. */
120 struct ctf_metadata_decoder *decoder;
123 enum lttng_live_metadata_stream_state
126 * The metadata needs to be updated. This is either because we just
127 * created the trace and haven't asked yet, or the relay specifically
128 * told us that new metadata is available.
130 LTTNG_LIVE_METADATA_STREAM_STATE_NEEDED,
132 * The metadata was updated and the relay has not told us we need to
135 LTTNG_LIVE_METADATA_STREAM_STATE_NOT_NEEDED,
137 * The relay has closed this metadata stream. We set this in reaction
138 * to a LTTNG_VIEWER_METADATA_ERR reply to a LTTNG_VIEWER_GET_METADATA
139 * command to the relay. If this field is set, we have received all the
140 * metadata that we are ever going to get for that metadata stream.
142 LTTNG_LIVE_METADATA_STREAM_STATE_CLOSED,
145 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
175 bt_logging_level log_level;
176 bt_self_component *self_comp;
178 /* Weak reference. */
179 struct lttng_live_msg_iter *lttng_live_msg_iter;
185 GString *session_name;
189 /* Array of pointers to struct lttng_live_trace. */
193 bool new_streams_needed;
194 bool lazy_stream_msg_init;
198 enum session_not_found_action
200 SESSION_NOT_FOUND_ACTION_CONTINUE,
201 SESSION_NOT_FOUND_ACTION_FAIL,
202 SESSION_NOT_FOUND_ACTION_END,
206 * A component instance is an iterator on a single session.
208 struct lttng_live_component
210 bt_logging_level log_level;
212 /* Weak reference. */
213 bt_self_component *self_comp;
218 enum session_not_found_action sess_not_found_act;
221 size_t max_query_size;
224 * Keeps track of whether the downstream component already has a
225 * message iterator on this component.
230 struct lttng_live_msg_iter
232 bt_logging_level log_level;
233 bt_self_component *self_comp;
235 /* Weak reference. */
236 struct lttng_live_component *lttng_live_comp;
238 /* Weak reference. */
239 bt_self_message_iterator *self_msg_iter;
242 struct live_viewer_connection *viewer_connection;
244 /* Array of pointers to struct lttng_live_session. */
247 /* Number of live stream iterator this message iterator has.*/
248 uint64_t active_stream_iter;
250 /* Timestamp in nanosecond of the last message sent downstream. */
251 int64_t last_msg_ts_ns;
253 /* True if the iterator was interrupted. */
254 bool was_interrupted;
257 enum lttng_live_iterator_status
259 /** Iterator state has progressed. Continue iteration immediately. */
260 LTTNG_LIVE_ITERATOR_STATUS_CONTINUE = 3,
261 /** No message available for now. Try again later. */
262 LTTNG_LIVE_ITERATOR_STATUS_AGAIN = 2,
263 /** No more CTF_LTTNG_LIVEs to be delivered. */
264 LTTNG_LIVE_ITERATOR_STATUS_END = 1,
265 /** No error, okay. */
266 LTTNG_LIVE_ITERATOR_STATUS_OK = 0,
267 /** Invalid arguments. */
268 LTTNG_LIVE_ITERATOR_STATUS_INVAL = -1,
269 /** General error. */
270 LTTNG_LIVE_ITERATOR_STATUS_ERROR = -2,
271 /** Out of memory. */
272 LTTNG_LIVE_ITERATOR_STATUS_NOMEM = -3,
273 /** Unsupported iterator feature. */
274 LTTNG_LIVE_ITERATOR_STATUS_UNSUPPORTED = -4,
277 bt_component_class_initialize_method_status
278 lttng_live_component_init(bt_self_component_source *self_comp,
279 bt_self_component_source_configuration *config, const bt_value *params,
280 void *init_method_data);
282 bt_component_class_query_method_status lttng_live_query(bt_self_component_class_source *comp_class,
283 bt_private_query_executor *priv_query_exec,
284 const char *object, const bt_value *params,
285 void *method_data, const bt_value **result);
287 void lttng_live_component_finalize(bt_self_component_source *component);
289 bt_message_iterator_class_next_method_status
290 lttng_live_msg_iter_next(bt_self_message_iterator *iterator, bt_message_array_const msgs,
291 uint64_t capacity, uint64_t *count);
293 bt_message_iterator_class_initialize_method_status
294 lttng_live_msg_iter_init(bt_self_message_iterator *self_msg_it,
295 bt_self_message_iterator_configuration *config,
296 bt_self_component_port_output *self_port);
298 void lttng_live_msg_iter_finalize(bt_self_message_iterator *it);
300 enum lttng_live_viewer_status lttng_live_session_attach(struct lttng_live_session *session,
301 bt_self_message_iterator *self_msg_iter);
303 enum lttng_live_viewer_status lttng_live_session_detach(struct lttng_live_session *session);
305 enum lttng_live_iterator_status
306 lttng_live_session_get_new_streams(struct lttng_live_session *session,
307 bt_self_message_iterator *self_msg_iter);
309 struct lttng_live_trace *
310 lttng_live_session_borrow_or_create_trace_by_id(struct lttng_live_session *session,
313 int lttng_live_add_session(struct lttng_live_msg_iter *lttng_live_msg_iter, uint64_t session_id,
314 const char *hostname, const char *session_name);
317 * lttng_live_get_one_metadata_packet() asks the Relay Daemon for new metadata.
318 * If new metadata is received, the function writes it to the provided file
319 * handle and updates the reply_len output parameter. This function should be
320 * called in loop until _END status is received to ensure all metadata is
321 * written to the file.
323 enum lttng_live_get_one_metadata_status
324 lttng_live_get_one_metadata_packet(struct lttng_live_trace *trace, FILE *fp, size_t *reply_len);
326 enum lttng_live_iterator_status
327 lttng_live_get_next_index(struct lttng_live_msg_iter *lttng_live_msg_iter,
328 struct lttng_live_stream_iterator *stream, struct packet_index *index);
330 enum ctf_msg_iter_medium_status
331 lttng_live_get_stream_bytes(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);
337 void lttng_live_stream_iterator_set_state(struct lttng_live_stream_iterator *stream_iter,
338 enum lttng_live_stream_state new_state);
340 #endif /* BABELTRACE_PLUGIN_CTF_LTTNG_LIVE_H */