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/msg-iter/msg-iter.hpp"
20 #include "viewer-connection.hpp"
22 enum lttng_live_stream_state
24 /* This stream won't have data until some known time in the future. */
25 LTTNG_LIVE_STREAM_QUIESCENT,
27 * This stream won't have data until some known time in the future and
28 * the message iterator inactivity message was already sent downstream.
30 LTTNG_LIVE_STREAM_QUIESCENT_NO_DATA, /* */
31 /* This stream has data ready to be consumed. */
32 LTTNG_LIVE_STREAM_ACTIVE_DATA,
34 * This stream has no data left to consume. We should asked the relay
37 LTTNG_LIVE_STREAM_ACTIVE_NO_DATA,
38 /* This stream won't have anymore data, ever. */
39 LTTNG_LIVE_STREAM_EOF,
42 /* Iterator over a live stream. */
43 struct lttng_live_stream_iterator
45 bt_logging_level log_level;
46 bt_self_component *self_comp;
52 struct lttng_live_trace *trace;
55 * Since only a single iterator per viewer connection, we have
56 * only a single message iterator per stream.
58 struct ctf_msg_iter *msg_iter;
60 uint64_t viewer_stream_id;
66 } ctf_stream_class_id;
68 /* base offset in current index. */
70 /* len to read in current index. */
72 /* offset in current index. */
76 * Clock Snapshot value of the last message iterator inactivity message
86 * Clock Snapshot value of the current message iterator inactivity
87 * message we might want to send downstream.
89 uint64_t current_inactivity_ts;
91 enum lttng_live_stream_state state;
94 * The current message produced by this live stream iterator. Owned by
97 const bt_message *current_msg;
99 /* Timestamp in nanoseconds of the current message (current_msg). */
100 int64_t current_msg_ts_ns;
109 bool has_stream_hung_up;
112 struct lttng_live_metadata
114 bt_logging_level log_level;
115 bt_self_component *self_comp;
118 /* Weak reference. */
119 struct ctf_metadata_decoder *decoder;
122 enum lttng_live_metadata_stream_state
125 * The metadata needs to be updated. This is either because we just
126 * created the trace and haven't asked yet, or the relay specifically
127 * told us that new metadata is available.
129 LTTNG_LIVE_METADATA_STREAM_STATE_NEEDED,
131 * The metadata was updated and the relay has not told us we need to
134 LTTNG_LIVE_METADATA_STREAM_STATE_NOT_NEEDED,
136 * The relay has closed this metadata stream. We set this in reaction
137 * to a LTTNG_VIEWER_METADATA_ERR reply to a LTTNG_VIEWER_GET_METADATA
138 * command to the relay. If this field is set, we have received all the
139 * metadata that we are ever going to get for that metadata stream.
141 LTTNG_LIVE_METADATA_STREAM_STATE_CLOSED,
144 struct lttng_live_trace
146 bt_logging_level log_level;
147 bt_self_component *self_comp;
149 /* Back reference to session. */
150 struct lttng_live_session *session;
152 /* ctf trace ID within the session. */
158 /* Weak reference. */
159 bt_trace_class *trace_class;
161 struct lttng_live_metadata *metadata;
163 const bt_clock_class *clock_class;
165 /* Array of pointers to struct lttng_live_stream_iterator. */
167 GPtrArray *stream_iterators;
169 enum lttng_live_metadata_stream_state metadata_stream_state;
172 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
199 SESSION_NOT_FOUND_ACTION_CONTINUE,
200 SESSION_NOT_FOUND_ACTION_FAIL,
201 SESSION_NOT_FOUND_ACTION_END,
205 * A component instance is an iterator on a single session.
207 struct lttng_live_component
209 bt_logging_level log_level;
211 /* Weak reference. */
212 bt_self_component *self_comp;
217 enum session_not_found_action sess_not_found_act;
220 size_t max_query_size;
223 * Keeps track of whether the downstream component already has a
224 * message iterator on this component.
229 struct lttng_live_msg_iter
231 bt_logging_level log_level;
232 bt_self_component *self_comp;
234 /* Weak reference. */
235 struct lttng_live_component *lttng_live_comp;
237 /* Weak reference. */
238 bt_self_message_iterator *self_msg_iter;
241 struct live_viewer_connection *viewer_connection;
243 /* Array of pointers to struct lttng_live_session. */
246 /* Number of live stream iterator this message iterator has.*/
247 uint64_t active_stream_iter;
249 /* Timestamp in nanosecond of the last message sent downstream. */
250 int64_t last_msg_ts_ns;
252 /* True if the iterator was interrupted. */
253 bool was_interrupted;
256 enum lttng_live_iterator_status
258 /** Iterator state has progressed. Continue iteration immediately. */
259 LTTNG_LIVE_ITERATOR_STATUS_CONTINUE = 3,
260 /** No message available for now. Try again later. */
261 LTTNG_LIVE_ITERATOR_STATUS_AGAIN = 2,
262 /** No more CTF_LTTNG_LIVEs to be delivered. */
263 LTTNG_LIVE_ITERATOR_STATUS_END = 1,
264 /** No error, okay. */
265 LTTNG_LIVE_ITERATOR_STATUS_OK = 0,
266 /** Invalid arguments. */
267 LTTNG_LIVE_ITERATOR_STATUS_INVAL = -1,
268 /** General error. */
269 LTTNG_LIVE_ITERATOR_STATUS_ERROR = -2,
270 /** Out of memory. */
271 LTTNG_LIVE_ITERATOR_STATUS_NOMEM = -3,
272 /** Unsupported iterator feature. */
273 LTTNG_LIVE_ITERATOR_STATUS_UNSUPPORTED = -4,
276 bt_component_class_initialize_method_status
277 lttng_live_component_init(bt_self_component_source *self_comp,
278 bt_self_component_source_configuration *config, const bt_value *params,
279 void *init_method_data);
281 bt_component_class_query_method_status lttng_live_query(bt_self_component_class_source *comp_class,
282 bt_private_query_executor *priv_query_exec,
283 const char *object, const bt_value *params,
284 void *method_data, const bt_value **result);
286 void lttng_live_component_finalize(bt_self_component_source *component);
288 bt_message_iterator_class_next_method_status
289 lttng_live_msg_iter_next(bt_self_message_iterator *iterator, bt_message_array_const msgs,
290 uint64_t capacity, uint64_t *count);
292 bt_message_iterator_class_initialize_method_status
293 lttng_live_msg_iter_init(bt_self_message_iterator *self_msg_it,
294 bt_self_message_iterator_configuration *config,
295 bt_self_component_port_output *self_port);
297 void lttng_live_msg_iter_finalize(bt_self_message_iterator *it);
299 enum lttng_live_viewer_status lttng_live_session_attach(struct lttng_live_session *session,
300 bt_self_message_iterator *self_msg_iter);
302 enum lttng_live_viewer_status lttng_live_session_detach(struct lttng_live_session *session);
304 enum lttng_live_iterator_status
305 lttng_live_session_get_new_streams(struct lttng_live_session *session,
306 bt_self_message_iterator *self_msg_iter);
308 struct lttng_live_trace *
309 lttng_live_session_borrow_or_create_trace_by_id(struct lttng_live_session *session,
312 int lttng_live_add_session(struct lttng_live_msg_iter *lttng_live_msg_iter, uint64_t session_id,
313 const char *hostname, 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
323 lttng_live_get_one_metadata_packet(struct lttng_live_trace *trace, FILE *fp, size_t *reply_len);
325 enum lttng_live_iterator_status
326 lttng_live_get_next_index(struct lttng_live_msg_iter *lttng_live_msg_iter,
327 struct lttng_live_stream_iterator *stream, struct packet_index *index);
329 enum ctf_msg_iter_medium_status
330 lttng_live_get_stream_bytes(struct lttng_live_msg_iter *lttng_live_msg_iter,
331 struct lttng_live_stream_iterator *stream, uint8_t *buf,
332 uint64_t offset, uint64_t req_len, uint64_t *recv_len);
334 bool lttng_live_graph_is_canceled(struct lttng_live_msg_iter *msg_iter);
336 void lttng_live_stream_iterator_set_state(struct lttng_live_stream_iterator *stream_iter,
337 enum lttng_live_stream_state new_state);
339 #endif /* BABELTRACE_PLUGIN_CTF_LTTNG_LIVE_H */