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 CTF LTTng-live Client Component
14 #include "common/assert.h"
15 #include "cpp-common/bt2c/fmt.hpp"
16 #include "cpp-common/bt2c/glib-up.hpp"
17 #include "cpp-common/bt2s/make-unique.hpp"
18 #include "cpp-common/vendor/fmt/format.h"
20 #include "plugins/common/muxing/muxing.h"
21 #include "plugins/common/param-validation/param-validation.h"
23 #include "data-stream.hpp"
24 #include "lttng-live.hpp"
25 #include "metadata.hpp"
27 #define MAX_QUERY_SIZE (256 * 1024)
28 #define URL_PARAM "url"
29 #define INPUTS_PARAM "inputs"
30 #define SESS_NOT_FOUND_ACTION_PARAM "session-not-found-action"
31 #define SESS_NOT_FOUND_ACTION_CONTINUE_STR "continue"
32 #define SESS_NOT_FOUND_ACTION_FAIL_STR "fail"
33 #define SESS_NOT_FOUND_ACTION_END_STR "end"
35 void lttng_live_stream_iterator_set_state(struct lttng_live_stream_iterator
*stream_iter
,
36 enum lttng_live_stream_state new_state
)
38 BT_CPPLOGD_SPEC(stream_iter
->logger
,
39 "Setting live stream iterator state: viewer-stream-id={}, "
40 "old-state={}, new-state={}",
41 stream_iter
->viewer_stream_id
, stream_iter
->state
, new_state
);
43 stream_iter
->state
= new_state
;
46 #define LTTNG_LIVE_LOGD_STREAM_ITER(live_stream_iter) \
48 BT_CPPLOGD_SPEC((live_stream_iter)->logger, \
49 "Live stream iterator state={}, " \
50 "last-inact-ts-is-set={}, last-inact-ts-value={}, " \
52 (live_stream_iter)->state, (live_stream_iter)->last_inactivity_ts.is_set, \
53 (live_stream_iter)->last_inactivity_ts.value, \
54 (live_stream_iter)->current_inactivity_ts); \
57 bool lttng_live_graph_is_canceled(struct lttng_live_msg_iter
*msg_iter
)
66 ret
= bt_self_message_iterator_is_interrupted(msg_iter
->self_msg_iter
);
72 static struct lttng_live_trace
*
73 lttng_live_session_borrow_trace_by_id(struct lttng_live_session
*session
, uint64_t trace_id
)
76 struct lttng_live_trace
*ret_trace
= NULL
;
78 for (trace_idx
= 0; trace_idx
< session
->traces
->len
; trace_idx
++) {
79 struct lttng_live_trace
*trace
=
80 (lttng_live_trace
*) g_ptr_array_index(session
->traces
, trace_idx
);
81 if (trace
->id
== trace_id
) {
91 static void lttng_live_destroy_trace(struct lttng_live_trace
*trace
)
93 BT_CPPLOGD_SPEC(trace
->logger
, "Destroying live trace: trace-id={}", trace
->id
);
95 BT_ASSERT(trace
->stream_iterators
);
96 g_ptr_array_free(trace
->stream_iterators
, TRUE
);
101 static struct lttng_live_trace
*lttng_live_create_trace(struct lttng_live_session
*session
,
104 BT_CPPLOGD_SPEC(session
->logger
, "Creating live trace: session-id={}, trace-id={}", session
->id
,
107 lttng_live_trace
*trace
= new lttng_live_trace
{session
->logger
};
108 trace
->session
= session
;
109 trace
->id
= trace_id
;
110 trace
->stream_iterators
=
111 g_ptr_array_new_with_free_func((GDestroyNotify
) lttng_live_stream_iterator_destroy
);
112 BT_ASSERT(trace
->stream_iterators
);
113 trace
->metadata_stream_state
= LTTNG_LIVE_METADATA_STREAM_STATE_NEEDED
;
114 g_ptr_array_add(session
->traces
, trace
);
119 struct lttng_live_trace
*
120 lttng_live_session_borrow_or_create_trace_by_id(struct lttng_live_session
*session
,
123 struct lttng_live_trace
*trace
;
125 trace
= lttng_live_session_borrow_trace_by_id(session
, trace_id
);
130 /* The session is the owner of the newly created trace. */
131 trace
= lttng_live_create_trace(session
, trace_id
);
137 int lttng_live_add_session(struct lttng_live_msg_iter
*lttng_live_msg_iter
, uint64_t session_id
,
138 const char *hostname
, const char *session_name
)
140 BT_CPPLOGD_SPEC(lttng_live_msg_iter
->logger
,
141 "Adding live session: "
142 "session-id={}, hostname=\"{}\", session-name=\"{}\"",
143 session_id
, hostname
, session_name
);
145 lttng_live_session
*session
= new lttng_live_session
{lttng_live_msg_iter
->logger
};
146 session
->self_comp
= lttng_live_msg_iter
->self_comp
;
147 session
->id
= session_id
;
148 session
->traces
= g_ptr_array_new_with_free_func((GDestroyNotify
) lttng_live_destroy_trace
);
149 BT_ASSERT(session
->traces
);
150 session
->lttng_live_msg_iter
= lttng_live_msg_iter
;
151 session
->new_streams_needed
= true;
152 session
->hostname
= g_string_new(hostname
);
153 BT_ASSERT(session
->hostname
);
155 session
->session_name
= g_string_new(session_name
);
156 BT_ASSERT(session
->session_name
);
158 g_ptr_array_add(lttng_live_msg_iter
->sessions
, session
);
163 static void lttng_live_destroy_session(struct lttng_live_session
*session
)
169 BT_CPPLOGD_SPEC(session
->logger
,
170 "Destroying live session: "
171 "session-id={}, session-name=\"{}\"",
172 session
->id
, session
->session_name
->str
);
173 if (session
->id
!= -1ULL) {
174 if (lttng_live_session_detach(session
)) {
175 if (!lttng_live_graph_is_canceled(session
->lttng_live_msg_iter
)) {
176 /* Old relayd cannot detach sessions. */
177 BT_CPPLOGD_SPEC(session
->logger
, "Unable to detach lttng live session {}",
184 if (session
->traces
) {
185 g_ptr_array_free(session
->traces
, TRUE
);
188 if (session
->hostname
) {
189 g_string_free(session
->hostname
, TRUE
);
192 if (session
->session_name
) {
193 g_string_free(session
->session_name
, TRUE
);
202 static void lttng_live_msg_iter_destroy(struct lttng_live_msg_iter
*lttng_live_msg_iter
)
204 if (!lttng_live_msg_iter
) {
208 if (lttng_live_msg_iter
->sessions
) {
209 g_ptr_array_free(lttng_live_msg_iter
->sessions
, TRUE
);
212 if (lttng_live_msg_iter
->viewer_connection
) {
213 live_viewer_connection_destroy(lttng_live_msg_iter
->viewer_connection
);
215 BT_ASSERT(lttng_live_msg_iter
->lttng_live_comp
);
216 BT_ASSERT(lttng_live_msg_iter
->lttng_live_comp
->has_msg_iter
);
218 /* All stream iterators must be destroyed at this point. */
219 BT_ASSERT(lttng_live_msg_iter
->active_stream_iter
== 0);
220 lttng_live_msg_iter
->lttng_live_comp
->has_msg_iter
= false;
222 delete lttng_live_msg_iter
;
228 void lttng_live_msg_iter_finalize(bt_self_message_iterator
*self_msg_iter
)
230 struct lttng_live_msg_iter
*lttng_live_msg_iter
;
232 BT_ASSERT(self_msg_iter
);
234 lttng_live_msg_iter
=
235 (struct lttng_live_msg_iter
*) bt_self_message_iterator_get_data(self_msg_iter
);
236 BT_ASSERT(lttng_live_msg_iter
);
237 lttng_live_msg_iter_destroy(lttng_live_msg_iter
);
240 static enum lttng_live_iterator_status
241 lttng_live_iterator_next_check_stream_state(struct lttng_live_stream_iterator
*lttng_live_stream
)
243 switch (lttng_live_stream
->state
) {
244 case LTTNG_LIVE_STREAM_QUIESCENT
:
245 case LTTNG_LIVE_STREAM_ACTIVE_DATA
:
247 case LTTNG_LIVE_STREAM_ACTIVE_NO_DATA
:
249 BT_CPPLOGF_SPEC(lttng_live_stream
->logger
, "Unexpected stream state \"ACTIVE_NO_DATA\"");
251 case LTTNG_LIVE_STREAM_QUIESCENT_NO_DATA
:
253 BT_CPPLOGF_SPEC(lttng_live_stream
->logger
, "Unexpected stream state \"QUIESCENT_NO_DATA\"");
255 case LTTNG_LIVE_STREAM_EOF
:
258 return LTTNG_LIVE_ITERATOR_STATUS_OK
;
262 * For active no data stream, fetch next index. As a result of that it can
264 * - quiescent: won't have events for a bit,
265 * - have data: need to get that data and produce the event,
266 * - have no data on this stream at this point: need to retry (AGAIN) or return
269 static enum lttng_live_iterator_status
lttng_live_iterator_next_handle_one_no_data_stream(
270 struct lttng_live_msg_iter
*lttng_live_msg_iter
,
271 struct lttng_live_stream_iterator
*lttng_live_stream
)
273 enum lttng_live_iterator_status ret
= LTTNG_LIVE_ITERATOR_STATUS_OK
;
274 enum lttng_live_stream_state orig_state
= lttng_live_stream
->state
;
275 struct packet_index index
;
277 if (lttng_live_stream
->trace
->metadata_stream_state
==
278 LTTNG_LIVE_METADATA_STREAM_STATE_NEEDED
) {
279 BT_CPPLOGD_SPEC(lttng_live_msg_iter
->logger
,
280 "Need to get an update for the metadata stream before proceeding "
281 "further with this stream: stream-name=\"{}\"",
282 lttng_live_stream
->name
);
283 ret
= LTTNG_LIVE_ITERATOR_STATUS_CONTINUE
;
287 if (lttng_live_stream
->trace
->session
->new_streams_needed
) {
288 BT_CPPLOGD_SPEC(lttng_live_msg_iter
->logger
,
289 "Need to get an update of all streams before proceeding further "
290 "with this stream: stream-name=\"{}\"",
291 lttng_live_stream
->name
);
292 ret
= LTTNG_LIVE_ITERATOR_STATUS_CONTINUE
;
296 if (lttng_live_stream
->state
!= LTTNG_LIVE_STREAM_ACTIVE_NO_DATA
&&
297 lttng_live_stream
->state
!= LTTNG_LIVE_STREAM_QUIESCENT_NO_DATA
) {
300 ret
= lttng_live_get_next_index(lttng_live_msg_iter
, lttng_live_stream
, &index
);
301 if (ret
!= LTTNG_LIVE_ITERATOR_STATUS_OK
) {
305 BT_ASSERT_DBG(lttng_live_stream
->state
!= LTTNG_LIVE_STREAM_EOF
);
307 if (lttng_live_stream
->state
== LTTNG_LIVE_STREAM_QUIESCENT
) {
308 uint64_t last_inact_ts
= lttng_live_stream
->last_inactivity_ts
.value
,
309 curr_inact_ts
= lttng_live_stream
->current_inactivity_ts
;
311 if (orig_state
== LTTNG_LIVE_STREAM_QUIESCENT_NO_DATA
&& last_inact_ts
== curr_inact_ts
) {
313 * Because the stream is in the QUIESCENT_NO_DATA
314 * state, we can assert that the last_inactivity_ts was
315 * set and can be safely used in the `if` above.
317 BT_ASSERT(lttng_live_stream
->last_inactivity_ts
.is_set
);
319 ret
= LTTNG_LIVE_ITERATOR_STATUS_AGAIN
;
320 LTTNG_LIVE_LOGD_STREAM_ITER(lttng_live_stream
);
322 ret
= LTTNG_LIVE_ITERATOR_STATUS_CONTINUE
;
327 lttng_live_stream
->base_offset
= index
.offset
;
328 lttng_live_stream
->offset
= index
.offset
;
329 lttng_live_stream
->len
= index
.packet_size
/ CHAR_BIT
;
331 BT_CPPLOGD_SPEC(lttng_live_msg_iter
->logger
,
332 "Setting live stream reading info: stream-name=\"{}\", "
333 "viewer-stream-id={}, stream-base-offset={}, stream-offset={}, stream-len={}",
334 lttng_live_stream
->name
, lttng_live_stream
->viewer_stream_id
,
335 lttng_live_stream
->base_offset
, lttng_live_stream
->offset
,
336 lttng_live_stream
->len
);
339 if (ret
== LTTNG_LIVE_ITERATOR_STATUS_OK
) {
340 ret
= lttng_live_iterator_next_check_stream_state(lttng_live_stream
);
346 * Creation of the message requires the ctf trace class to be created
347 * beforehand, but the live protocol gives us all streams (including metadata)
348 * at once. So we split it in three steps: getting streams, getting metadata
349 * (which creates the ctf trace class), and then creating the per-stream
352 static enum lttng_live_iterator_status
353 lttng_live_get_session(struct lttng_live_msg_iter
*lttng_live_msg_iter
,
354 struct lttng_live_session
*session
)
356 enum lttng_live_iterator_status status
;
359 if (!session
->attached
) {
360 BT_CPPLOGD_SPEC(lttng_live_msg_iter
->logger
, "Attach to session: session-id={}",
362 enum lttng_live_viewer_status attach_status
=
363 lttng_live_session_attach(session
, lttng_live_msg_iter
->self_msg_iter
);
364 if (attach_status
!= LTTNG_LIVE_VIEWER_STATUS_OK
) {
365 if (lttng_live_graph_is_canceled(lttng_live_msg_iter
)) {
367 * Clear any causes appended in
368 * `lttng_live_attach_session()` as we want to
369 * return gracefully since the graph was
372 bt_current_thread_clear_error();
373 status
= LTTNG_LIVE_ITERATOR_STATUS_AGAIN
;
375 status
= LTTNG_LIVE_ITERATOR_STATUS_ERROR
;
376 BT_CPPLOGE_APPEND_CAUSE_SPEC(lttng_live_msg_iter
->logger
,
377 "Error attaching to LTTng live session");
383 BT_CPPLOGD_SPEC(lttng_live_msg_iter
->logger
,
384 "Updating all data streams: "
385 "session-id={}, session-name=\"{}\"",
386 session
->id
, session
->session_name
->str
);
388 status
= lttng_live_session_get_new_streams(session
, lttng_live_msg_iter
->self_msg_iter
);
390 case LTTNG_LIVE_ITERATOR_STATUS_OK
:
392 case LTTNG_LIVE_ITERATOR_STATUS_END
:
394 * We received a `_END` from the `_get_new_streams()` function,
395 * which means no more data will ever be received from the data
396 * streams of this session. But it's possible that the metadata
398 * The live protocol guarantees that we receive all the
399 * metadata needed before we receive data streams needing it.
400 * But it's possible to receive metadata NOT needed by
401 * data streams after the session was closed. For example, this
402 * could happen if a new event is registered and the session is
403 * stopped before any tracepoint for that event is actually
407 lttng_live_msg_iter
->logger
,
408 "Updating streams returned _END status. Override status to _OK in order fetch any remaining metadata:"
409 "session-id={}, session-name=\"{}\"",
410 session
->id
, session
->session_name
->str
);
411 status
= LTTNG_LIVE_ITERATOR_STATUS_OK
;
417 BT_CPPLOGD_SPEC(lttng_live_msg_iter
->logger
,
418 "Updating metadata stream for session: "
419 "session-id={}, session-name=\"{}\"",
420 session
->id
, session
->session_name
->str
);
423 while (trace_idx
< session
->traces
->len
) {
424 struct lttng_live_trace
*trace
=
425 (lttng_live_trace
*) g_ptr_array_index(session
->traces
, trace_idx
);
427 status
= lttng_live_metadata_update(trace
);
429 case LTTNG_LIVE_ITERATOR_STATUS_END
:
430 case LTTNG_LIVE_ITERATOR_STATUS_OK
:
433 case LTTNG_LIVE_ITERATOR_STATUS_CONTINUE
:
434 case LTTNG_LIVE_ITERATOR_STATUS_AGAIN
:
437 BT_CPPLOGE_APPEND_CAUSE_SPEC(lttng_live_msg_iter
->logger
,
438 "Error updating trace metadata: "
439 "stream-iter-status={}, trace-id={}",
446 * Now that we have the metadata we can initialize the downstream
449 status
= lttng_live_lazy_msg_init(session
, lttng_live_msg_iter
->self_msg_iter
);
456 lttng_live_force_new_streams_and_metadata(struct lttng_live_msg_iter
*lttng_live_msg_iter
)
458 uint64_t session_idx
, trace_idx
;
460 for (session_idx
= 0; session_idx
< lttng_live_msg_iter
->sessions
->len
; session_idx
++) {
461 struct lttng_live_session
*session
=
462 (lttng_live_session
*) g_ptr_array_index(lttng_live_msg_iter
->sessions
, session_idx
);
463 BT_CPPLOGD_SPEC(lttng_live_msg_iter
->logger
,
464 "Force marking session as needing new streams: "
467 session
->new_streams_needed
= true;
468 for (trace_idx
= 0; trace_idx
< session
->traces
->len
; trace_idx
++) {
469 struct lttng_live_trace
*trace
=
470 (lttng_live_trace
*) g_ptr_array_index(session
->traces
, trace_idx
);
471 BT_CPPLOGD_SPEC(lttng_live_msg_iter
->logger
,
472 "Force marking trace metadata state as needing an update: "
473 "session-id={}, trace-id={}",
474 session
->id
, trace
->id
);
476 BT_ASSERT(trace
->metadata_stream_state
!= LTTNG_LIVE_METADATA_STREAM_STATE_CLOSED
);
478 trace
->metadata_stream_state
= LTTNG_LIVE_METADATA_STREAM_STATE_NEEDED
;
483 static enum lttng_live_iterator_status
484 lttng_live_iterator_handle_new_streams_and_metadata(struct lttng_live_msg_iter
*lttng_live_msg_iter
)
486 enum lttng_live_iterator_status status
;
487 enum lttng_live_viewer_status viewer_status
;
488 uint64_t session_idx
= 0, nr_sessions_opened
= 0;
489 struct lttng_live_session
*session
;
490 enum session_not_found_action sess_not_found_act
=
491 lttng_live_msg_iter
->lttng_live_comp
->params
.sess_not_found_act
;
493 BT_CPPLOGD_SPEC(lttng_live_msg_iter
->logger
,
494 "Update data and metadata of all sessions: "
495 "live-msg-iter-addr={}",
496 fmt::ptr(lttng_live_msg_iter
));
498 * In a remotely distant future, we could add a "new
499 * session" flag to the protocol, which would tell us that we
500 * need to query for new sessions even though we have sessions
503 if (lttng_live_msg_iter
->sessions
->len
== 0) {
504 if (sess_not_found_act
!= SESSION_NOT_FOUND_ACTION_CONTINUE
) {
506 lttng_live_msg_iter
->logger
,
507 "No session found. Exiting in accordance with the `session-not-found-action` parameter");
508 status
= LTTNG_LIVE_ITERATOR_STATUS_END
;
512 lttng_live_msg_iter
->logger
,
513 "No session found. Try creating a new one in accordance with the `session-not-found-action` parameter");
515 * Retry to create a viewer session for the requested
518 viewer_status
= lttng_live_create_viewer_session(lttng_live_msg_iter
);
519 if (viewer_status
!= LTTNG_LIVE_VIEWER_STATUS_OK
) {
520 if (viewer_status
== LTTNG_LIVE_VIEWER_STATUS_ERROR
) {
521 status
= LTTNG_LIVE_ITERATOR_STATUS_ERROR
;
522 BT_CPPLOGE_APPEND_CAUSE_SPEC(lttng_live_msg_iter
->logger
,
523 "Error creating LTTng live viewer session");
524 } else if (viewer_status
== LTTNG_LIVE_VIEWER_STATUS_INTERRUPTED
) {
525 status
= LTTNG_LIVE_ITERATOR_STATUS_AGAIN
;
534 for (session_idx
= 0; session_idx
< lttng_live_msg_iter
->sessions
->len
; session_idx
++) {
536 (lttng_live_session
*) g_ptr_array_index(lttng_live_msg_iter
->sessions
, session_idx
);
537 status
= lttng_live_get_session(lttng_live_msg_iter
, session
);
539 case LTTNG_LIVE_ITERATOR_STATUS_OK
:
540 case LTTNG_LIVE_ITERATOR_STATUS_END
:
542 * A session returned `_END`. Other sessions may still
543 * be active so we override the status and continue
550 if (!session
->closed
) {
551 nr_sessions_opened
++;
555 if (sess_not_found_act
!= SESSION_NOT_FOUND_ACTION_CONTINUE
&& nr_sessions_opened
== 0) {
556 status
= LTTNG_LIVE_ITERATOR_STATUS_END
;
558 status
= LTTNG_LIVE_ITERATOR_STATUS_OK
;
565 static enum lttng_live_iterator_status
566 emit_inactivity_message(struct lttng_live_msg_iter
*lttng_live_msg_iter
,
567 struct lttng_live_stream_iterator
*stream_iter
, const bt_message
**message
,
570 enum lttng_live_iterator_status ret
= LTTNG_LIVE_ITERATOR_STATUS_OK
;
571 bt_message
*msg
= NULL
;
573 BT_ASSERT(stream_iter
->trace
->clock_class
);
575 BT_CPPLOGD_SPEC(lttng_live_msg_iter
->logger
,
576 "Emitting inactivity message for stream: ctf-stream-id={}, "
577 "viewer-stream-id={}, timestamp={}",
578 stream_iter
->ctf_stream_class_id
.value
, stream_iter
->viewer_stream_id
,
581 msg
= bt_message_message_iterator_inactivity_create(lttng_live_msg_iter
->self_msg_iter
,
582 stream_iter
->trace
->clock_class
, timestamp
);
584 BT_CPPLOGE_APPEND_CAUSE_SPEC(lttng_live_msg_iter
->logger
,
585 "Error emitting message iterator inactivity message");
594 ret
= LTTNG_LIVE_ITERATOR_STATUS_ERROR
;
595 bt_message_put_ref(msg
);
599 static enum lttng_live_iterator_status
lttng_live_iterator_next_handle_one_quiescent_stream(
600 struct lttng_live_msg_iter
*lttng_live_msg_iter
,
601 struct lttng_live_stream_iterator
*lttng_live_stream
, const bt_message
**message
)
603 enum lttng_live_iterator_status ret
= LTTNG_LIVE_ITERATOR_STATUS_OK
;
605 if (lttng_live_stream
->state
!= LTTNG_LIVE_STREAM_QUIESCENT
) {
606 return LTTNG_LIVE_ITERATOR_STATUS_OK
;
610 * Check if we already sent an inactivty message downstream for this
611 * `current_inactivity_ts` value.
613 if (lttng_live_stream
->last_inactivity_ts
.is_set
&&
614 lttng_live_stream
->current_inactivity_ts
== lttng_live_stream
->last_inactivity_ts
.value
) {
615 lttng_live_stream_iterator_set_state(lttng_live_stream
,
616 LTTNG_LIVE_STREAM_QUIESCENT_NO_DATA
);
618 ret
= LTTNG_LIVE_ITERATOR_STATUS_CONTINUE
;
622 ret
= emit_inactivity_message(lttng_live_msg_iter
, lttng_live_stream
, message
,
623 lttng_live_stream
->current_inactivity_ts
);
625 lttng_live_stream
->last_inactivity_ts
.value
= lttng_live_stream
->current_inactivity_ts
;
626 lttng_live_stream
->last_inactivity_ts
.is_set
= true;
631 static int live_get_msg_ts_ns(struct lttng_live_msg_iter
*lttng_live_msg_iter
,
632 const bt_message
*msg
, int64_t last_msg_ts_ns
, int64_t *ts_ns
)
634 const bt_clock_snapshot
*clock_snapshot
= NULL
;
638 BT_ASSERT_DBG(ts_ns
);
640 BT_CPPLOGD_SPEC(lttng_live_msg_iter
->logger
,
641 "Getting message's timestamp: iter-data-addr={}, msg-addr={}, "
643 fmt::ptr(lttng_live_msg_iter
), fmt::ptr(msg
), last_msg_ts_ns
);
645 switch (bt_message_get_type(msg
)) {
646 case BT_MESSAGE_TYPE_EVENT
:
647 clock_snapshot
= bt_message_event_borrow_default_clock_snapshot_const(msg
);
649 case BT_MESSAGE_TYPE_PACKET_BEGINNING
:
650 clock_snapshot
= bt_message_packet_beginning_borrow_default_clock_snapshot_const(msg
);
652 case BT_MESSAGE_TYPE_PACKET_END
:
653 clock_snapshot
= bt_message_packet_end_borrow_default_clock_snapshot_const(msg
);
655 case BT_MESSAGE_TYPE_DISCARDED_EVENTS
:
657 bt_message_discarded_events_borrow_beginning_default_clock_snapshot_const(msg
);
659 case BT_MESSAGE_TYPE_DISCARDED_PACKETS
:
661 bt_message_discarded_packets_borrow_beginning_default_clock_snapshot_const(msg
);
663 case BT_MESSAGE_TYPE_MESSAGE_ITERATOR_INACTIVITY
:
664 clock_snapshot
= bt_message_message_iterator_inactivity_borrow_clock_snapshot_const(msg
);
667 /* All the other messages have a higher priority */
668 BT_CPPLOGD_STR_SPEC(lttng_live_msg_iter
->logger
,
669 "Message has no timestamp: using the last message timestamp.");
670 *ts_ns
= last_msg_ts_ns
;
674 ret
= bt_clock_snapshot_get_ns_from_origin(clock_snapshot
, ts_ns
);
676 BT_CPPLOGE_APPEND_CAUSE_SPEC(lttng_live_msg_iter
->logger
,
677 "Cannot get nanoseconds from Epoch of clock snapshot: "
678 "clock-snapshot-addr={}",
679 fmt::ptr(clock_snapshot
));
690 BT_CPPLOGD_SPEC(lttng_live_msg_iter
->logger
,
691 "Found message's timestamp: iter-data-addr={}, msg-addr={}, "
692 "last-msg-ts={}, ts={}",
693 fmt::ptr(lttng_live_msg_iter
), fmt::ptr(msg
), last_msg_ts_ns
, *ts_ns
);
699 static enum lttng_live_iterator_status
lttng_live_iterator_next_handle_one_active_data_stream(
700 struct lttng_live_msg_iter
*lttng_live_msg_iter
,
701 struct lttng_live_stream_iterator
*lttng_live_stream
, const bt_message
**message
)
703 enum lttng_live_iterator_status ret
= LTTNG_LIVE_ITERATOR_STATUS_OK
;
704 enum ctf_msg_iter_status status
;
705 uint64_t session_idx
, trace_idx
;
707 for (session_idx
= 0; session_idx
< lttng_live_msg_iter
->sessions
->len
; session_idx
++) {
708 struct lttng_live_session
*session
=
709 (lttng_live_session
*) g_ptr_array_index(lttng_live_msg_iter
->sessions
, session_idx
);
711 if (session
->new_streams_needed
) {
712 BT_CPPLOGD_SPEC(lttng_live_msg_iter
->logger
,
713 "Need an update for streams: "
716 ret
= LTTNG_LIVE_ITERATOR_STATUS_CONTINUE
;
719 for (trace_idx
= 0; trace_idx
< session
->traces
->len
; trace_idx
++) {
720 struct lttng_live_trace
*trace
=
721 (lttng_live_trace
*) g_ptr_array_index(session
->traces
, trace_idx
);
722 if (trace
->metadata_stream_state
== LTTNG_LIVE_METADATA_STREAM_STATE_NEEDED
) {
723 BT_CPPLOGD_SPEC(lttng_live_msg_iter
->logger
,
724 "Need an update for metadata stream: "
725 "session-id={}, trace-id={}",
726 session
->id
, trace
->id
);
727 ret
= LTTNG_LIVE_ITERATOR_STATUS_CONTINUE
;
733 if (lttng_live_stream
->state
!= LTTNG_LIVE_STREAM_ACTIVE_DATA
) {
734 ret
= LTTNG_LIVE_ITERATOR_STATUS_ERROR
;
735 BT_CPPLOGE_APPEND_CAUSE_SPEC(lttng_live_msg_iter
->logger
,
736 "Invalid state of live stream iterator"
737 "stream-iter-status={}",
738 lttng_live_stream
->state
);
742 status
= ctf_msg_iter_get_next_message(lttng_live_stream
->msg_iter
.get(), message
);
744 case CTF_MSG_ITER_STATUS_EOF
:
745 ret
= LTTNG_LIVE_ITERATOR_STATUS_END
;
747 case CTF_MSG_ITER_STATUS_OK
:
748 ret
= LTTNG_LIVE_ITERATOR_STATUS_OK
;
750 case CTF_MSG_ITER_STATUS_AGAIN
:
752 * Continue immediately (end of packet). The next
753 * get_index may return AGAIN to delay the following
756 ret
= LTTNG_LIVE_ITERATOR_STATUS_CONTINUE
;
758 case CTF_MSG_ITER_STATUS_ERROR
:
760 ret
= LTTNG_LIVE_ITERATOR_STATUS_ERROR
;
761 BT_CPPLOGE_APPEND_CAUSE_SPEC(lttng_live_msg_iter
->logger
,
762 "CTF message iterator failed to get next message: "
763 "msg-iter={}, msg-iter-status={}",
764 fmt::ptr(lttng_live_stream
->msg_iter
), status
);
772 static enum lttng_live_iterator_status
773 lttng_live_iterator_close_stream(struct lttng_live_msg_iter
*lttng_live_msg_iter
,
774 struct lttng_live_stream_iterator
*stream_iter
,
775 const bt_message
**curr_msg
)
777 enum lttng_live_iterator_status live_status
= LTTNG_LIVE_ITERATOR_STATUS_OK
;
779 BT_CPPLOGD_SPEC(lttng_live_msg_iter
->logger
,
780 "Closing live stream iterator: stream-name=\"{}\", "
781 "viewer-stream-id={}",
782 stream_iter
->name
, stream_iter
->viewer_stream_id
);
785 * The viewer has hung up on us so we are closing the stream. The
786 * `ctf_msg_iter` should simply realize that it needs to close the
787 * stream properly by emitting the necessary stream end message.
789 enum ctf_msg_iter_status status
=
790 ctf_msg_iter_get_next_message(stream_iter
->msg_iter
.get(), curr_msg
);
792 if (status
== CTF_MSG_ITER_STATUS_ERROR
) {
793 BT_CPPLOGE_APPEND_CAUSE_SPEC(lttng_live_msg_iter
->logger
,
794 "Error getting the next message from CTF message iterator");
795 live_status
= LTTNG_LIVE_ITERATOR_STATUS_ERROR
;
797 } else if (status
== CTF_MSG_ITER_STATUS_EOF
) {
798 BT_CPPLOGI_SPEC(lttng_live_msg_iter
->logger
,
799 "Reached the end of the live stream iterator.");
800 live_status
= LTTNG_LIVE_ITERATOR_STATUS_END
;
804 BT_ASSERT(status
== CTF_MSG_ITER_STATUS_OK
);
812 * handle_no_data_streams()
814 * - for each ACTIVE_NO_DATA stream:
815 * - query relayd for stream data, or quiescence info.
816 * - if need metadata, get metadata, goto retry.
817 * - if new stream, get new stream as ACTIVE_NO_DATA, goto retry
818 * - if quiescent, move to QUIESCENT streams
819 * - if fetched data, move to ACTIVE_DATA streams
820 * (at this point each stream either has data, or is quiescent)
824 * handle_new_streams_and_metadata()
825 * - query relayd for known streams, add them as ACTIVE_NO_DATA
826 * - query relayd for metadata
828 * call handle_active_no_data_streams()
830 * handle_quiescent_streams()
831 * - if at least one stream is ACTIVE_DATA:
832 * - peek stream event with lowest timestamp -> next_ts
833 * - for each quiescent stream
834 * - if next_ts >= quiescent end
835 * - set state to ACTIVE_NO_DATA
837 * - for each quiescent stream
838 * - set state to ACTIVE_NO_DATA
840 * call handle_active_no_data_streams()
842 * handle_active_data_streams()
843 * - if at least one stream is ACTIVE_DATA:
844 * - get stream event with lowest timestamp from heap
845 * - make that stream event the current message.
846 * - move this stream heap position to its next event
847 * - if we need to fetch data from relayd, move
848 * stream to ACTIVE_NO_DATA.
852 * end criterion: ctrl-c on client. If relayd exits or the session
853 * closes on the relay daemon side, we keep on waiting for streams.
854 * Eventually handle --end timestamp (also an end criterion).
856 * When disconnected from relayd: try to re-connect endlessly.
858 static enum lttng_live_iterator_status
859 lttng_live_iterator_next_msg_on_stream(struct lttng_live_msg_iter
*lttng_live_msg_iter
,
860 struct lttng_live_stream_iterator
*stream_iter
,
861 const bt_message
**curr_msg
)
863 enum lttng_live_iterator_status live_status
;
865 BT_CPPLOGD_SPEC(lttng_live_msg_iter
->logger
,
866 "Advancing live stream iterator until next message if possible: "
867 "stream-name=\"{}\", viewer-stream-id={}",
868 stream_iter
->name
, stream_iter
->viewer_stream_id
);
870 if (stream_iter
->has_stream_hung_up
) {
872 * The stream has hung up and the stream was properly closed
873 * during the last call to the current function. Return _END
874 * status now so that this stream iterator is removed for the
875 * stream iterator list.
877 live_status
= LTTNG_LIVE_ITERATOR_STATUS_END
;
882 LTTNG_LIVE_LOGD_STREAM_ITER(stream_iter
);
885 * Make sure we have the most recent metadata and possibly some new
888 live_status
= lttng_live_iterator_handle_new_streams_and_metadata(lttng_live_msg_iter
);
889 if (live_status
!= LTTNG_LIVE_ITERATOR_STATUS_OK
) {
894 lttng_live_iterator_next_handle_one_no_data_stream(lttng_live_msg_iter
, stream_iter
);
895 if (live_status
!= LTTNG_LIVE_ITERATOR_STATUS_OK
) {
896 if (live_status
== LTTNG_LIVE_ITERATOR_STATUS_END
) {
898 * We overwrite `live_status` since `curr_msg` is
899 * likely set to a valid message in this function.
902 lttng_live_iterator_close_stream(lttng_live_msg_iter
, stream_iter
, curr_msg
);
907 live_status
= lttng_live_iterator_next_handle_one_quiescent_stream(lttng_live_msg_iter
,
908 stream_iter
, curr_msg
);
909 if (live_status
!= LTTNG_LIVE_ITERATOR_STATUS_OK
) {
910 BT_ASSERT(!*curr_msg
);
916 live_status
= lttng_live_iterator_next_handle_one_active_data_stream(lttng_live_msg_iter
,
917 stream_iter
, curr_msg
);
918 if (live_status
!= LTTNG_LIVE_ITERATOR_STATUS_OK
) {
919 BT_ASSERT(!*curr_msg
);
923 if (live_status
== LTTNG_LIVE_ITERATOR_STATUS_CONTINUE
) {
925 lttng_live_msg_iter
->logger
,
926 "Ask the relay daemon for an updated view of the data and metadata streams");
930 BT_CPPLOGD_SPEC(lttng_live_msg_iter
->logger
,
931 "Returning from advancing live stream iterator: status={}, "
932 "stream-name=\"{}\", viewer-stream-id={}",
933 live_status
, stream_iter
->name
, stream_iter
->viewer_stream_id
);
938 static bool is_discarded_packet_or_event_message(const bt_message
*msg
)
940 const enum bt_message_type msg_type
= bt_message_get_type(msg
);
942 return msg_type
== BT_MESSAGE_TYPE_DISCARDED_EVENTS
||
943 msg_type
== BT_MESSAGE_TYPE_DISCARDED_PACKETS
;
946 static enum lttng_live_iterator_status
947 adjust_discarded_packets_message(bt_self_message_iterator
*iter
, const bt_stream
*stream
,
948 const bt_message
*msg_in
, bt_message
**msg_out
,
949 uint64_t new_begin_ts
)
951 enum lttng_live_iterator_status status
= LTTNG_LIVE_ITERATOR_STATUS_OK
;
952 enum bt_property_availability availability
;
953 const bt_clock_snapshot
*clock_snapshot
;
957 clock_snapshot
= bt_message_discarded_packets_borrow_end_default_clock_snapshot_const(msg_in
);
958 end_ts
= bt_clock_snapshot_get_value(clock_snapshot
);
960 availability
= bt_message_discarded_packets_get_count(msg_in
, &count
);
961 BT_ASSERT_DBG(availability
== BT_PROPERTY_AVAILABILITY_AVAILABLE
);
963 *msg_out
= bt_message_discarded_packets_create_with_default_clock_snapshots(
964 iter
, stream
, new_begin_ts
, end_ts
);
966 status
= LTTNG_LIVE_ITERATOR_STATUS_NOMEM
;
970 bt_message_discarded_packets_set_count(*msg_out
, count
);
975 static enum lttng_live_iterator_status
976 adjust_discarded_events_message(bt_self_message_iterator
*iter
, const bt_stream
*stream
,
977 const bt_message
*msg_in
, bt_message
**msg_out
,
978 uint64_t new_begin_ts
)
980 enum lttng_live_iterator_status status
= LTTNG_LIVE_ITERATOR_STATUS_OK
;
981 enum bt_property_availability availability
;
982 const bt_clock_snapshot
*clock_snapshot
;
986 clock_snapshot
= bt_message_discarded_events_borrow_end_default_clock_snapshot_const(msg_in
);
987 end_ts
= bt_clock_snapshot_get_value(clock_snapshot
);
989 availability
= bt_message_discarded_events_get_count(msg_in
, &count
);
990 BT_ASSERT_DBG(availability
== BT_PROPERTY_AVAILABILITY_AVAILABLE
);
992 *msg_out
= bt_message_discarded_events_create_with_default_clock_snapshots(
993 iter
, stream
, new_begin_ts
, end_ts
);
995 status
= LTTNG_LIVE_ITERATOR_STATUS_NOMEM
;
999 bt_message_discarded_events_set_count(*msg_out
, count
);
1004 static enum lttng_live_iterator_status
1005 handle_late_message(struct lttng_live_msg_iter
*lttng_live_msg_iter
,
1006 struct lttng_live_stream_iterator
*stream_iter
, int64_t late_msg_ts_ns
,
1007 const bt_message
*late_msg
)
1009 const bt_clock_class
*clock_class
;
1010 const bt_stream_class
*stream_class
;
1011 enum bt_clock_class_cycles_to_ns_from_origin_status ts_ns_status
;
1012 int64_t last_inactivity_ts_ns
;
1013 enum lttng_live_iterator_status stream_iter_status
= LTTNG_LIVE_ITERATOR_STATUS_OK
;
1014 enum lttng_live_iterator_status adjust_status
;
1015 bt_message
*adjusted_message
;
1018 * The timestamp of the current message is before the last message sent
1019 * by this component. We CANNOT send it as is.
1021 * The only expected scenario in which that could happen is the
1022 * following, everything else is a bug in this component, relay daemon,
1025 * Expected scenario: The CTF message iterator emitted discarded
1026 * packets and discarded events with synthesized beginning and end
1027 * timestamps from the bounds of the last known packet and the newly
1028 * decoded packet header. The CTF message iterator is not aware of
1029 * stream inactivity beacons. Hence, we have to adjust the beginning
1030 * timestamp of those types of messages if a stream signalled its
1031 * inactivity up until _after_ the last known packet's beginning
1034 * Otherwise, the monotonicity guarantee of message timestamps would
1037 * In short, the only scenario in which it's okay and fixable to
1038 * received a late message is when:
1039 * 1. the late message is a discarded packets or discarded events
1041 * 2. this stream produced an inactivity message downstream, and
1042 * 3. the timestamp of the late message is within the inactivity
1043 * timespan we sent downstream through the inactivity message.
1046 BT_CPPLOGD_SPEC(lttng_live_msg_iter
->logger
,
1047 "Handling late message on live stream iterator: "
1048 "stream-name=\"{}\", viewer-stream-id={}",
1049 stream_iter
->name
, stream_iter
->viewer_stream_id
);
1051 if (!stream_iter
->last_inactivity_ts
.is_set
) {
1052 BT_CPPLOGE_APPEND_CAUSE_SPEC(lttng_live_msg_iter
->logger
,
1053 "Invalid live stream state: "
1054 "have a late message when no inactivity message "
1055 "was ever sent for that stream.");
1056 stream_iter_status
= LTTNG_LIVE_ITERATOR_STATUS_ERROR
;
1060 if (!is_discarded_packet_or_event_message(late_msg
)) {
1061 BT_CPPLOGE_APPEND_CAUSE_SPEC(lttng_live_msg_iter
->logger
,
1062 "Invalid live stream state: "
1063 "have a late message that is not a packet discarded or "
1064 "event discarded message: late-msg-type={}",
1065 static_cast<bt2::MessageType
>(bt_message_get_type(late_msg
)));
1066 stream_iter_status
= LTTNG_LIVE_ITERATOR_STATUS_ERROR
;
1070 stream_class
= bt_stream_borrow_class_const(stream_iter
->stream
->libObjPtr());
1071 clock_class
= bt_stream_class_borrow_default_clock_class_const(stream_class
);
1073 ts_ns_status
= bt_clock_class_cycles_to_ns_from_origin(
1074 clock_class
, stream_iter
->last_inactivity_ts
.value
, &last_inactivity_ts_ns
);
1075 if (ts_ns_status
!= BT_CLOCK_CLASS_CYCLES_TO_NS_FROM_ORIGIN_STATUS_OK
) {
1076 BT_CPPLOGE_APPEND_CAUSE_SPEC(lttng_live_msg_iter
->logger
,
1077 "Error converting last "
1078 "inactivity message timestamp to nanoseconds");
1079 stream_iter_status
= LTTNG_LIVE_ITERATOR_STATUS_ERROR
;
1083 if (last_inactivity_ts_ns
<= late_msg_ts_ns
) {
1084 BT_CPPLOGE_APPEND_CAUSE_SPEC(lttng_live_msg_iter
->logger
,
1085 "Invalid live stream state: "
1086 "have a late message that is none included in a stream "
1087 "inactivity timespan: last-inactivity-ts-ns={}, "
1088 "late-msg-ts-ns={}",
1089 last_inactivity_ts_ns
, late_msg_ts_ns
);
1090 stream_iter_status
= LTTNG_LIVE_ITERATOR_STATUS_ERROR
;
1095 * We now know that it's okay for this message to be late, we can now
1096 * adjust its timestamp to ensure monotonicity.
1098 BT_CPPLOGD_SPEC(lttng_live_msg_iter
->logger
,
1099 "Adjusting the timestamp of late message: late-msg-type={}, "
1101 static_cast<bt2::MessageType
>(bt_message_get_type(late_msg
)),
1102 stream_iter
->last_inactivity_ts
.value
);
1103 switch (bt_message_get_type(late_msg
)) {
1104 case BT_MESSAGE_TYPE_DISCARDED_EVENTS
:
1105 adjust_status
= adjust_discarded_events_message(
1106 lttng_live_msg_iter
->self_msg_iter
, stream_iter
->stream
->libObjPtr(), late_msg
,
1107 &adjusted_message
, stream_iter
->last_inactivity_ts
.value
);
1109 case BT_MESSAGE_TYPE_DISCARDED_PACKETS
:
1110 adjust_status
= adjust_discarded_packets_message(
1111 lttng_live_msg_iter
->self_msg_iter
, stream_iter
->stream
->libObjPtr(), late_msg
,
1112 &adjusted_message
, stream_iter
->last_inactivity_ts
.value
);
1118 if (adjust_status
!= LTTNG_LIVE_ITERATOR_STATUS_OK
) {
1119 stream_iter_status
= adjust_status
;
1123 BT_ASSERT_DBG(adjusted_message
);
1124 stream_iter
->current_msg
= adjusted_message
;
1125 stream_iter
->current_msg_ts_ns
= last_inactivity_ts_ns
;
1126 bt_message_put_ref(late_msg
);
1129 return stream_iter_status
;
1132 static enum lttng_live_iterator_status
1133 next_stream_iterator_for_trace(struct lttng_live_msg_iter
*lttng_live_msg_iter
,
1134 struct lttng_live_trace
*live_trace
,
1135 struct lttng_live_stream_iterator
**youngest_trace_stream_iter
)
1137 struct lttng_live_stream_iterator
*youngest_candidate_stream_iter
= NULL
;
1138 enum lttng_live_iterator_status stream_iter_status
;
1139 int64_t youngest_candidate_msg_ts
= INT64_MAX
;
1140 uint64_t stream_iter_idx
;
1142 BT_ASSERT_DBG(live_trace
);
1143 BT_ASSERT_DBG(live_trace
->stream_iterators
);
1145 BT_CPPLOGD_SPEC(lttng_live_msg_iter
->logger
,
1146 "Finding the next stream iterator for trace: "
1150 * Update the current message of every stream iterators of this trace.
1151 * The current msg of every stream must have a timestamp equal or
1152 * larger than the last message returned by this iterator. We must
1153 * ensure monotonicity.
1155 stream_iter_idx
= 0;
1156 while (stream_iter_idx
< live_trace
->stream_iterators
->len
) {
1157 bool stream_iter_is_ended
= false;
1158 struct lttng_live_stream_iterator
*stream_iter
=
1159 (lttng_live_stream_iterator
*) g_ptr_array_index(live_trace
->stream_iterators
,
1163 * If there is no current message for this stream, go fetch
1166 while (!stream_iter
->current_msg
) {
1167 const bt_message
*msg
= NULL
;
1168 int64_t curr_msg_ts_ns
= INT64_MAX
;
1170 stream_iter_status
=
1171 lttng_live_iterator_next_msg_on_stream(lttng_live_msg_iter
, stream_iter
, &msg
);
1173 if (stream_iter_status
== LTTNG_LIVE_ITERATOR_STATUS_END
) {
1174 stream_iter_is_ended
= true;
1178 if (stream_iter_status
!= LTTNG_LIVE_ITERATOR_STATUS_OK
) {
1184 BT_CPPLOGD_SPEC(lttng_live_msg_iter
->logger
,
1185 "Live stream iterator returned message: msg-type={}, "
1186 "stream-name=\"{}\", viewer-stream-id={}",
1187 static_cast<bt2::MessageType
>(bt_message_get_type(msg
)),
1188 stream_iter
->name
, stream_iter
->viewer_stream_id
);
1191 * Get the timestamp in nanoseconds from origin of this
1194 live_get_msg_ts_ns(lttng_live_msg_iter
, msg
, lttng_live_msg_iter
->last_msg_ts_ns
,
1198 * Check if the message of the current live stream
1199 * iterator occurred at the exact same time or after the
1200 * last message returned by this component's message
1201 * iterator. If not, we need to handle it with care.
1203 if (curr_msg_ts_ns
>= lttng_live_msg_iter
->last_msg_ts_ns
) {
1204 stream_iter
->current_msg
= msg
;
1205 stream_iter
->current_msg_ts_ns
= curr_msg_ts_ns
;
1208 * We received a message from the past. This
1209 * may be fixable but it can also be an error.
1211 stream_iter_status
=
1212 handle_late_message(lttng_live_msg_iter
, stream_iter
, curr_msg_ts_ns
, msg
);
1213 if (stream_iter_status
!= LTTNG_LIVE_ITERATOR_STATUS_OK
) {
1214 BT_CPPLOGE_APPEND_CAUSE_SPEC(lttng_live_msg_iter
->logger
,
1215 "Late message could not be handled correctly: "
1216 "lttng-live-msg-iter-addr={}, "
1217 "stream-name=\"{}\", "
1218 "curr-msg-ts={}, last-msg-ts={}",
1219 fmt::ptr(lttng_live_msg_iter
), stream_iter
->name
,
1221 lttng_live_msg_iter
->last_msg_ts_ns
);
1222 stream_iter_status
= LTTNG_LIVE_ITERATOR_STATUS_ERROR
;
1228 BT_ASSERT_DBG(stream_iter
!= youngest_candidate_stream_iter
);
1230 if (!stream_iter_is_ended
) {
1231 if (G_UNLIKELY(youngest_candidate_stream_iter
== NULL
) ||
1232 stream_iter
->current_msg_ts_ns
< youngest_candidate_msg_ts
) {
1234 * Update the current best candidate message
1235 * for the stream iterator of this live trace
1236 * to be forwarded downstream.
1238 youngest_candidate_msg_ts
= stream_iter
->current_msg_ts_ns
;
1239 youngest_candidate_stream_iter
= stream_iter
;
1240 } else if (stream_iter
->current_msg_ts_ns
== youngest_candidate_msg_ts
) {
1242 * Order the messages in an arbitrary but
1243 * deterministic way.
1245 BT_ASSERT_DBG(stream_iter
!= youngest_candidate_stream_iter
);
1246 int ret
= common_muxing_compare_messages(
1247 stream_iter
->current_msg
, youngest_candidate_stream_iter
->current_msg
);
1250 * The `youngest_candidate_stream_iter->current_msg`
1251 * should go first. Update the next
1252 * iterator and the current timestamp.
1254 youngest_candidate_msg_ts
= stream_iter
->current_msg_ts_ns
;
1255 youngest_candidate_stream_iter
= stream_iter
;
1256 } else if (ret
== 0) {
1258 * Unable to pick which one should go
1262 lttng_live_msg_iter
->logger
,
1263 "Cannot deterministically pick next live stream message iterator because they have identical next messages: "
1264 "stream-iter-addr={}"
1265 "stream-iter-addr={}",
1266 fmt::ptr(stream_iter
), fmt::ptr(youngest_candidate_stream_iter
));
1273 * The live stream iterator has ended. That
1274 * iterator is removed from the array, but
1275 * there is no need to increment
1276 * stream_iter_idx as
1277 * g_ptr_array_remove_index_fast replaces the
1278 * removed element with the array's last
1281 g_ptr_array_remove_index_fast(live_trace
->stream_iterators
, stream_iter_idx
);
1285 if (youngest_candidate_stream_iter
) {
1286 *youngest_trace_stream_iter
= youngest_candidate_stream_iter
;
1287 stream_iter_status
= LTTNG_LIVE_ITERATOR_STATUS_OK
;
1290 * The only case where we don't have a candidate for this trace
1291 * is if we reached the end of all the iterators.
1293 BT_ASSERT(live_trace
->stream_iterators
->len
== 0);
1294 stream_iter_status
= LTTNG_LIVE_ITERATOR_STATUS_END
;
1298 return stream_iter_status
;
1301 static enum lttng_live_iterator_status
1302 next_stream_iterator_for_session(struct lttng_live_msg_iter
*lttng_live_msg_iter
,
1303 struct lttng_live_session
*session
,
1304 struct lttng_live_stream_iterator
**youngest_session_stream_iter
)
1306 enum lttng_live_iterator_status stream_iter_status
;
1307 uint64_t trace_idx
= 0;
1308 int64_t youngest_candidate_msg_ts
= INT64_MAX
;
1309 struct lttng_live_stream_iterator
*youngest_candidate_stream_iter
= NULL
;
1311 BT_CPPLOGD_SPEC(lttng_live_msg_iter
->logger
,
1312 "Finding the next stream iterator for session: "
1316 * Make sure we are attached to the session and look for new streams
1319 stream_iter_status
= lttng_live_get_session(lttng_live_msg_iter
, session
);
1320 if (stream_iter_status
!= LTTNG_LIVE_ITERATOR_STATUS_OK
&&
1321 stream_iter_status
!= LTTNG_LIVE_ITERATOR_STATUS_CONTINUE
&&
1322 stream_iter_status
!= LTTNG_LIVE_ITERATOR_STATUS_END
) {
1326 BT_ASSERT_DBG(session
->traces
);
1328 while (trace_idx
< session
->traces
->len
) {
1329 bool trace_is_ended
= false;
1330 struct lttng_live_stream_iterator
*stream_iter
;
1331 struct lttng_live_trace
*trace
=
1332 (lttng_live_trace
*) g_ptr_array_index(session
->traces
, trace_idx
);
1334 stream_iter_status
=
1335 next_stream_iterator_for_trace(lttng_live_msg_iter
, trace
, &stream_iter
);
1336 if (stream_iter_status
== LTTNG_LIVE_ITERATOR_STATUS_END
) {
1338 * All the live stream iterators for this trace are
1339 * ENDed. Remove the trace from this session.
1341 trace_is_ended
= true;
1342 } else if (stream_iter_status
!= LTTNG_LIVE_ITERATOR_STATUS_OK
) {
1346 if (!trace_is_ended
) {
1347 BT_ASSERT_DBG(stream_iter
);
1349 if (G_UNLIKELY(youngest_candidate_stream_iter
== NULL
) ||
1350 stream_iter
->current_msg_ts_ns
< youngest_candidate_msg_ts
) {
1351 youngest_candidate_msg_ts
= stream_iter
->current_msg_ts_ns
;
1352 youngest_candidate_stream_iter
= stream_iter
;
1353 } else if (stream_iter
->current_msg_ts_ns
== youngest_candidate_msg_ts
) {
1355 * Order the messages in an arbitrary but
1356 * deterministic way.
1358 int ret
= common_muxing_compare_messages(
1359 stream_iter
->current_msg
, youngest_candidate_stream_iter
->current_msg
);
1362 * The `youngest_candidate_stream_iter->current_msg`
1363 * should go first. Update the next iterator
1364 * and the current timestamp.
1366 youngest_candidate_msg_ts
= stream_iter
->current_msg_ts_ns
;
1367 youngest_candidate_stream_iter
= stream_iter
;
1368 } else if (ret
== 0) {
1369 /* Unable to pick which one should go first. */
1371 lttng_live_msg_iter
->logger
,
1372 "Cannot deterministically pick next live stream message iterator because they have identical next messages: "
1373 "stream-iter-addr={}"
1374 "youngest-candidate-stream-iter-addr={}",
1375 fmt::ptr(stream_iter
), fmt::ptr(youngest_candidate_stream_iter
));
1381 * trace_idx is not incremented since
1382 * g_ptr_array_remove_index_fast replaces the
1383 * element at trace_idx with the array's last element.
1385 g_ptr_array_remove_index_fast(session
->traces
, trace_idx
);
1388 if (youngest_candidate_stream_iter
) {
1389 *youngest_session_stream_iter
= youngest_candidate_stream_iter
;
1390 stream_iter_status
= LTTNG_LIVE_ITERATOR_STATUS_OK
;
1393 * The only cases where we don't have a candidate for this
1395 * 1. if we reached the end of all the iterators of all the
1396 * traces of this session,
1397 * 2. if we never had live stream iterator in the first place.
1399 * In either cases, we return END.
1401 BT_ASSERT(session
->traces
->len
== 0);
1402 stream_iter_status
= LTTNG_LIVE_ITERATOR_STATUS_END
;
1405 return stream_iter_status
;
1408 static inline void put_messages(bt_message_array_const msgs
, uint64_t count
)
1412 for (i
= 0; i
< count
; i
++) {
1413 BT_MESSAGE_PUT_REF_AND_RESET(msgs
[i
]);
1417 bt_message_iterator_class_next_method_status
1418 lttng_live_msg_iter_next(bt_self_message_iterator
*self_msg_it
, bt_message_array_const msgs
,
1419 uint64_t capacity
, uint64_t *count
)
1422 bt_message_iterator_class_next_method_status status
;
1423 enum lttng_live_viewer_status viewer_status
;
1424 struct lttng_live_msg_iter
*lttng_live_msg_iter
=
1425 (struct lttng_live_msg_iter
*) bt_self_message_iterator_get_data(self_msg_it
);
1426 struct lttng_live_component
*lttng_live
= lttng_live_msg_iter
->lttng_live_comp
;
1427 enum lttng_live_iterator_status stream_iter_status
;
1428 uint64_t session_idx
;
1432 BT_ASSERT_DBG(lttng_live_msg_iter
);
1434 if (G_UNLIKELY(lttng_live_msg_iter
->was_interrupted
)) {
1436 * The iterator was interrupted in a previous call to the
1437 * `_next()` method. We currently do not support generating
1438 * messages after such event. The babeltrace2 CLI should never
1439 * be running the graph after being interrupted. So this check
1440 * is to prevent other graph users from using this live
1441 * iterator in an messed up internal state.
1443 status
= BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_ERROR
;
1444 BT_CPPLOGE_APPEND_CAUSE_SPEC(
1445 lttng_live_msg_iter
->logger
,
1446 "Message iterator was interrupted during a previous call to the `next()` and currently does not support continuing after such event.");
1451 * Clear all the invalid message reference that might be left over in
1454 memset(msgs
, 0, capacity
* sizeof(*msgs
));
1457 * If no session are exposed on the relay found at the url provided by
1458 * the user, session count will be 0. In this case, we return status
1459 * end to return gracefully.
1461 if (lttng_live_msg_iter
->sessions
->len
== 0) {
1462 if (lttng_live
->params
.sess_not_found_act
!= SESSION_NOT_FOUND_ACTION_CONTINUE
) {
1463 status
= BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_END
;
1467 * The are no more active session for this session
1468 * name. Retry to create a viewer session for the
1469 * requested session name.
1471 viewer_status
= lttng_live_create_viewer_session(lttng_live_msg_iter
);
1472 if (viewer_status
!= LTTNG_LIVE_VIEWER_STATUS_OK
) {
1473 if (viewer_status
== LTTNG_LIVE_VIEWER_STATUS_ERROR
) {
1474 status
= BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_ERROR
;
1475 BT_CPPLOGE_APPEND_CAUSE_SPEC(lttng_live_msg_iter
->logger
,
1476 "Error creating LTTng live viewer session");
1477 } else if (viewer_status
== LTTNG_LIVE_VIEWER_STATUS_INTERRUPTED
) {
1478 status
= BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_AGAIN
;
1487 if (lttng_live_msg_iter
->active_stream_iter
== 0) {
1488 lttng_live_force_new_streams_and_metadata(lttng_live_msg_iter
);
1492 * Here the muxing of message is done.
1494 * We need to iterate over all the streams of all the traces of all the
1495 * viewer sessions in order to get the message with the smallest
1496 * timestamp. In this case, a session is a viewer session and there is
1497 * one viewer session per consumer daemon. (UST 32bit, UST 64bit and/or
1498 * kernel). Each viewer session can have multiple traces, for example,
1499 * 64bit UST viewer sessions could have multiple per-pid traces.
1501 * We iterate over the streams of each traces to update and see what is
1502 * their next message's timestamp. From those timestamps, we select the
1503 * message with the smallest timestamp as the best candidate message
1504 * for that trace and do the same thing across all the sessions.
1506 * We then compare the timestamp of best candidate message of all the
1507 * sessions to pick the message with the smallest timestamp and we
1510 while (*count
< capacity
) {
1511 struct lttng_live_stream_iterator
*youngest_stream_iter
= NULL
,
1512 *candidate_stream_iter
= NULL
;
1513 int64_t youngest_msg_ts_ns
= INT64_MAX
;
1515 BT_ASSERT_DBG(lttng_live_msg_iter
->sessions
);
1517 while (session_idx
< lttng_live_msg_iter
->sessions
->len
) {
1518 struct lttng_live_session
*session
= (lttng_live_session
*) g_ptr_array_index(
1519 lttng_live_msg_iter
->sessions
, session_idx
);
1521 /* Find the best candidate message to send downstream. */
1522 stream_iter_status
= next_stream_iterator_for_session(lttng_live_msg_iter
, session
,
1523 &candidate_stream_iter
);
1525 /* If we receive an END status, it means that either:
1526 * - Those traces never had active streams (UST with no
1527 * data produced yet),
1528 * - All live stream iterators have ENDed.*/
1529 if (stream_iter_status
== LTTNG_LIVE_ITERATOR_STATUS_END
) {
1530 if (session
->closed
&& session
->traces
->len
== 0) {
1532 * Remove the session from the list.
1533 * session_idx is not modified since
1534 * g_ptr_array_remove_index_fast
1535 * replaces the the removed element with
1536 * the array's last element.
1538 g_ptr_array_remove_index_fast(lttng_live_msg_iter
->sessions
, session_idx
);
1545 if (stream_iter_status
!= LTTNG_LIVE_ITERATOR_STATUS_OK
) {
1549 if (G_UNLIKELY(youngest_stream_iter
== NULL
) ||
1550 candidate_stream_iter
->current_msg_ts_ns
< youngest_msg_ts_ns
) {
1551 youngest_msg_ts_ns
= candidate_stream_iter
->current_msg_ts_ns
;
1552 youngest_stream_iter
= candidate_stream_iter
;
1553 } else if (candidate_stream_iter
->current_msg_ts_ns
== youngest_msg_ts_ns
) {
1555 * The currently selected message to be sent
1556 * downstream next has the exact same timestamp
1557 * that of the current candidate message. We
1558 * must break the tie in a predictable manner.
1560 BT_CPPLOGD_STR_SPEC(
1561 lttng_live_msg_iter
->logger
,
1562 "Two of the next message candidates have the same timestamps, pick one deterministically.");
1564 * Order the messages in an arbitrary but
1565 * deterministic way.
1567 int ret
= common_muxing_compare_messages(candidate_stream_iter
->current_msg
,
1568 youngest_stream_iter
->current_msg
);
1571 * The `candidate_stream_iter->current_msg`
1572 * should go first. Update the next
1573 * iterator and the current timestamp.
1575 youngest_msg_ts_ns
= candidate_stream_iter
->current_msg_ts_ns
;
1576 youngest_stream_iter
= candidate_stream_iter
;
1577 } else if (ret
== 0) {
1578 /* Unable to pick which one should go first. */
1580 lttng_live_msg_iter
->logger
,
1581 "Cannot deterministically pick next live stream message iterator because they have identical next messages: "
1582 "next-stream-iter-addr={}"
1583 "candidate-stream-iter-addr={}",
1584 fmt::ptr(youngest_stream_iter
), fmt::ptr(candidate_stream_iter
));
1591 if (!youngest_stream_iter
) {
1592 stream_iter_status
= LTTNG_LIVE_ITERATOR_STATUS_AGAIN
;
1596 BT_ASSERT_DBG(youngest_stream_iter
->current_msg
);
1597 /* Ensure monotonicity. */
1598 BT_ASSERT_DBG(lttng_live_msg_iter
->last_msg_ts_ns
<=
1599 youngest_stream_iter
->current_msg_ts_ns
);
1602 * Insert the next message to the message batch. This will set
1603 * stream iterator current message to NULL so that next time
1604 * we fetch the next message of that stream iterator
1606 BT_MESSAGE_MOVE_REF(msgs
[*count
], youngest_stream_iter
->current_msg
);
1609 /* Update the last timestamp in nanoseconds sent downstream. */
1610 lttng_live_msg_iter
->last_msg_ts_ns
= youngest_msg_ts_ns
;
1611 youngest_stream_iter
->current_msg_ts_ns
= INT64_MAX
;
1613 stream_iter_status
= LTTNG_LIVE_ITERATOR_STATUS_OK
;
1617 switch (stream_iter_status
) {
1618 case LTTNG_LIVE_ITERATOR_STATUS_OK
:
1619 case LTTNG_LIVE_ITERATOR_STATUS_AGAIN
:
1621 * If we gathered messages, return _OK even if the graph was
1622 * interrupted. This allows for the components downstream to at
1623 * least get the those messages. If the graph was indeed
1624 * interrupted there should not be another _next() call as the
1625 * application will tear down the graph. This component class
1626 * doesn't support restarting after an interruption.
1629 status
= BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_OK
;
1631 status
= BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_AGAIN
;
1634 case LTTNG_LIVE_ITERATOR_STATUS_END
:
1635 status
= BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_END
;
1637 case LTTNG_LIVE_ITERATOR_STATUS_NOMEM
:
1638 BT_CPPLOGE_APPEND_CAUSE_SPEC(lttng_live_msg_iter
->logger
,
1639 "Memory error preparing the next batch of messages: "
1640 "live-iter-status={}",
1641 stream_iter_status
);
1642 status
= BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_MEMORY_ERROR
;
1644 case LTTNG_LIVE_ITERATOR_STATUS_ERROR
:
1645 case LTTNG_LIVE_ITERATOR_STATUS_INVAL
:
1646 case LTTNG_LIVE_ITERATOR_STATUS_UNSUPPORTED
:
1647 BT_CPPLOGE_APPEND_CAUSE_SPEC(lttng_live_msg_iter
->logger
,
1648 "Error preparing the next batch of messages: "
1649 "live-iter-status={}",
1650 stream_iter_status
);
1652 status
= BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_ERROR
;
1653 /* Put all existing messages on error. */
1654 put_messages(msgs
, *count
);
1662 } catch (const std::bad_alloc
&) {
1663 return BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_MEMORY_ERROR
;
1664 } catch (const bt2::Error
&) {
1665 return BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_ERROR
;
1669 static struct lttng_live_msg_iter
*
1670 lttng_live_msg_iter_create(struct lttng_live_component
*lttng_live_comp
,
1671 bt_self_message_iterator
*self_msg_it
)
1673 lttng_live_msg_iter
*msg_iter
= new lttng_live_msg_iter
{lttng_live_comp
->logger
};
1674 msg_iter
->self_comp
= lttng_live_comp
->self_comp
;
1675 msg_iter
->lttng_live_comp
= lttng_live_comp
;
1676 msg_iter
->self_msg_iter
= self_msg_it
;
1678 msg_iter
->active_stream_iter
= 0;
1679 msg_iter
->last_msg_ts_ns
= INT64_MIN
;
1680 msg_iter
->was_interrupted
= false;
1682 msg_iter
->sessions
=
1683 g_ptr_array_new_with_free_func((GDestroyNotify
) lttng_live_destroy_session
);
1684 BT_ASSERT(msg_iter
->sessions
);
1689 bt_message_iterator_class_initialize_method_status
1690 lttng_live_msg_iter_init(bt_self_message_iterator
*self_msg_it
,
1691 bt_self_message_iterator_configuration
*, bt_self_component_port_output
*)
1694 bt_message_iterator_class_initialize_method_status status
;
1695 struct lttng_live_component
*lttng_live
;
1696 struct lttng_live_msg_iter
*lttng_live_msg_iter
;
1697 enum lttng_live_viewer_status viewer_status
;
1698 bt_self_component
*self_comp
= bt_self_message_iterator_borrow_component(self_msg_it
);
1700 lttng_live
= (lttng_live_component
*) bt_self_component_get_data(self_comp
);
1702 /* There can be only one downstream iterator at the same time. */
1703 BT_ASSERT(!lttng_live
->has_msg_iter
);
1704 lttng_live
->has_msg_iter
= true;
1706 lttng_live_msg_iter
= lttng_live_msg_iter_create(lttng_live
, self_msg_it
);
1707 if (!lttng_live_msg_iter
) {
1708 BT_CPPLOGE_APPEND_CAUSE_SPEC(lttng_live
->logger
,
1709 "Failed to create lttng_live_msg_iter");
1710 status
= BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_MEMORY_ERROR
;
1714 viewer_status
= live_viewer_connection_create(
1715 lttng_live
->params
.url
.c_str(), false, lttng_live_msg_iter
, lttng_live_msg_iter
->logger
,
1716 <tng_live_msg_iter
->viewer_connection
);
1717 if (viewer_status
!= LTTNG_LIVE_VIEWER_STATUS_OK
) {
1718 if (viewer_status
== LTTNG_LIVE_VIEWER_STATUS_ERROR
) {
1719 BT_CPPLOGE_APPEND_CAUSE_SPEC(lttng_live_msg_iter
->logger
,
1720 "Failed to create viewer connection");
1721 } else if (viewer_status
== LTTNG_LIVE_VIEWER_STATUS_INTERRUPTED
) {
1723 * Interruption in the _iter_init() method is not
1724 * supported. Return an error.
1726 BT_CPPLOGE_APPEND_CAUSE_SPEC(lttng_live_msg_iter
->logger
,
1727 "Interrupted while creating viewer connection");
1730 status
= BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_ERROR
;
1734 viewer_status
= lttng_live_create_viewer_session(lttng_live_msg_iter
);
1735 if (viewer_status
!= LTTNG_LIVE_VIEWER_STATUS_OK
) {
1736 if (viewer_status
== LTTNG_LIVE_VIEWER_STATUS_ERROR
) {
1737 BT_CPPLOGE_APPEND_CAUSE_SPEC(lttng_live_msg_iter
->logger
,
1738 "Failed to create viewer session");
1739 } else if (viewer_status
== LTTNG_LIVE_VIEWER_STATUS_INTERRUPTED
) {
1741 * Interruption in the _iter_init() method is not
1742 * supported. Return an error.
1744 BT_CPPLOGE_APPEND_CAUSE_SPEC(lttng_live_msg_iter
->logger
,
1745 "Interrupted when creating viewer session");
1748 status
= BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_ERROR
;
1752 if (lttng_live_msg_iter
->sessions
->len
== 0) {
1753 switch (lttng_live
->params
.sess_not_found_act
) {
1754 case SESSION_NOT_FOUND_ACTION_CONTINUE
:
1756 lttng_live_msg_iter
->logger
,
1757 "Unable to connect to the requested live viewer session. "
1758 "Keep trying to connect because of {}=\"{}\" component parameter: url=\"{}\"",
1759 SESS_NOT_FOUND_ACTION_PARAM
, SESS_NOT_FOUND_ACTION_CONTINUE_STR
,
1760 lttng_live
->params
.url
);
1762 case SESSION_NOT_FOUND_ACTION_FAIL
:
1763 BT_CPPLOGE_APPEND_CAUSE_SPEC(
1764 lttng_live_msg_iter
->logger
,
1765 "Unable to connect to the requested live viewer session. "
1766 "Fail the message iterator initialization because of {}=\"{}\" "
1767 "component parameter: url =\"{}\"",
1768 SESS_NOT_FOUND_ACTION_PARAM
, SESS_NOT_FOUND_ACTION_FAIL_STR
,
1769 lttng_live
->params
.url
);
1770 status
= BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_ERROR
;
1772 case SESSION_NOT_FOUND_ACTION_END
:
1773 BT_CPPLOGI_SPEC(lttng_live_msg_iter
->logger
,
1774 "Unable to connect to the requested live viewer session. "
1775 "End gracefully at the first _next() call because of {}=\"{}\""
1776 " component parameter: url=\"{}\"",
1777 SESS_NOT_FOUND_ACTION_PARAM
, SESS_NOT_FOUND_ACTION_END_STR
,
1778 lttng_live
->params
.url
);
1785 bt_self_message_iterator_set_data(self_msg_it
, lttng_live_msg_iter
);
1786 status
= BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_OK
;
1790 lttng_live_msg_iter_destroy(lttng_live_msg_iter
);
1793 } catch (const std::bad_alloc
&) {
1794 return BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_MEMORY_ERROR
;
1795 } catch (const bt2::Error
&) {
1796 return BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_ERROR
;
1800 static struct bt_param_validation_map_value_entry_descr list_sessions_params
[] = {
1801 {URL_PARAM
, BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_MANDATORY
,
1802 bt_param_validation_value_descr::makeString()},
1803 BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_END
};
1805 static bt_component_class_query_method_status
1806 lttng_live_query_list_sessions(const bt_value
*params
, const bt_value
**result
,
1807 const bt2c::Logger
& logger
)
1809 bt_component_class_query_method_status status
;
1810 const bt_value
*url_value
= NULL
;
1812 struct live_viewer_connection
*viewer_connection
= NULL
;
1813 enum lttng_live_viewer_status viewer_status
;
1814 enum bt_param_validation_status validation_status
;
1815 gchar
*validate_error
= NULL
;
1817 validation_status
= bt_param_validation_validate(params
, list_sessions_params
, &validate_error
);
1818 if (validation_status
== BT_PARAM_VALIDATION_STATUS_MEMORY_ERROR
) {
1819 status
= BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_MEMORY_ERROR
;
1821 } else if (validation_status
== BT_PARAM_VALIDATION_STATUS_VALIDATION_ERROR
) {
1822 status
= BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_ERROR
;
1823 BT_CPPLOGE_APPEND_CAUSE_SPEC(logger
, "{}", validate_error
);
1827 url_value
= bt_value_map_borrow_entry_value_const(params
, URL_PARAM
);
1828 url
= bt_value_string_get(url_value
);
1830 viewer_status
= live_viewer_connection_create(url
, true, NULL
, logger
, &viewer_connection
);
1831 if (viewer_status
!= LTTNG_LIVE_VIEWER_STATUS_OK
) {
1832 if (viewer_status
== LTTNG_LIVE_VIEWER_STATUS_ERROR
) {
1833 BT_CPPLOGE_APPEND_CAUSE_SPEC(logger
, "Failed to create viewer connection");
1834 status
= BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_ERROR
;
1835 } else if (viewer_status
== LTTNG_LIVE_VIEWER_STATUS_INTERRUPTED
) {
1836 status
= BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_AGAIN
;
1843 status
= live_viewer_connection_list_sessions(viewer_connection
, result
);
1844 if (status
!= BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_OK
) {
1845 BT_CPPLOGE_APPEND_CAUSE_SPEC(logger
, "Failed to list viewer sessions");
1852 BT_VALUE_PUT_REF_AND_RESET(*result
);
1855 status
= BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_ERROR
;
1859 if (viewer_connection
) {
1860 live_viewer_connection_destroy(viewer_connection
);
1863 g_free(validate_error
);
1868 static bt_component_class_query_method_status
1869 lttng_live_query_support_info(const bt_value
*params
, const bt_value
**result
,
1870 const bt2c::Logger
& logger
)
1872 bt_component_class_query_method_status status
= BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_OK
;
1873 const bt_value
*input_type_value
;
1874 const bt_value
*input_value
;
1876 struct bt_common_lttng_live_url_parts parts
= {};
1878 /* Used by the logging macros */
1879 __attribute__((unused
)) bt_self_component
*self_comp
= NULL
;
1882 input_type_value
= bt_value_map_borrow_entry_value_const(params
, "type");
1883 if (!input_type_value
) {
1884 BT_CPPLOGE_APPEND_CAUSE_SPEC(logger
, "Missing expected `type` parameter.");
1888 if (!bt_value_is_string(input_type_value
)) {
1889 BT_CPPLOGE_APPEND_CAUSE_SPEC(logger
, "`type` parameter is not a string value.");
1893 if (strcmp(bt_value_string_get(input_type_value
), "string") != 0) {
1894 /* We don't handle file system paths */
1898 input_value
= bt_value_map_borrow_entry_value_const(params
, "input");
1900 BT_CPPLOGE_APPEND_CAUSE_SPEC(logger
, "Missing expected `input` parameter.");
1904 if (!bt_value_is_string(input_value
)) {
1905 BT_CPPLOGE_APPEND_CAUSE_SPEC(logger
, "`input` parameter is not a string value.");
1909 parts
= bt_common_parse_lttng_live_url(bt_value_string_get(input_value
), NULL
, 0);
1910 if (parts
.session_name
) {
1912 * Looks pretty much like an LTTng live URL: we got the
1913 * session name part, which forms a complete URL.
1919 *result
= bt_value_real_create_init(weight
);
1921 status
= BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_MEMORY_ERROR
;
1929 status
= BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_ERROR
;
1932 BT_ASSERT(!*result
);
1935 bt_common_destroy_lttng_live_url_parts(&parts
);
1939 bt_component_class_query_method_status
lttng_live_query(bt_self_component_class_source
*comp_class
,
1940 bt_private_query_executor
*priv_query_exec
,
1941 const char *object
, const bt_value
*params
,
1942 __attribute__((unused
)) void *method_data
,
1943 const bt_value
**result
)
1946 bt_component_class_query_method_status status
= BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_OK
;
1947 bt2c::Logger logger
{bt2::SelfComponentClass
{comp_class
},
1948 bt2::PrivateQueryExecutor
{priv_query_exec
},
1949 "PLUGIN/SRC.CTF.LTTNG-LIVE/QUERY"};
1951 if (strcmp(object
, "sessions") == 0) {
1952 status
= lttng_live_query_list_sessions(params
, result
, logger
);
1953 } else if (strcmp(object
, "babeltrace.support-info") == 0) {
1954 status
= lttng_live_query_support_info(params
, result
, logger
);
1956 BT_CPPLOGI_SPEC(logger
, "Unknown query object `{}`", object
);
1957 status
= BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_UNKNOWN_OBJECT
;
1963 } catch (const std::bad_alloc
&) {
1964 return BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_MEMORY_ERROR
;
1965 } catch (const bt2::Error
&) {
1966 return BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_ERROR
;
1970 void lttng_live_component_finalize(bt_self_component_source
*component
)
1972 lttng_live_component::UP
{static_cast<lttng_live_component
*>(
1973 bt_self_component_get_data(bt_self_component_source_as_self_component(component
)))};
1976 static enum session_not_found_action
1977 parse_session_not_found_action_param(const bt_value
*no_session_param
)
1979 enum session_not_found_action action
;
1980 const char *no_session_act_str
= bt_value_string_get(no_session_param
);
1982 if (strcmp(no_session_act_str
, SESS_NOT_FOUND_ACTION_CONTINUE_STR
) == 0) {
1983 action
= SESSION_NOT_FOUND_ACTION_CONTINUE
;
1984 } else if (strcmp(no_session_act_str
, SESS_NOT_FOUND_ACTION_FAIL_STR
) == 0) {
1985 action
= SESSION_NOT_FOUND_ACTION_FAIL
;
1987 BT_ASSERT(strcmp(no_session_act_str
, SESS_NOT_FOUND_ACTION_END_STR
) == 0);
1988 action
= SESSION_NOT_FOUND_ACTION_END
;
1994 static bt_param_validation_value_descr inputs_elem_descr
=
1995 bt_param_validation_value_descr::makeString();
1997 static const char *sess_not_found_action_choices
[] = {
1998 SESS_NOT_FOUND_ACTION_CONTINUE_STR
,
1999 SESS_NOT_FOUND_ACTION_FAIL_STR
,
2000 SESS_NOT_FOUND_ACTION_END_STR
,
2003 static struct bt_param_validation_map_value_entry_descr params_descr
[] = {
2004 {INPUTS_PARAM
, BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_MANDATORY
,
2005 bt_param_validation_value_descr::makeArray(1, 1, inputs_elem_descr
)},
2006 {SESS_NOT_FOUND_ACTION_PARAM
, BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL
,
2007 bt_param_validation_value_descr::makeString(sess_not_found_action_choices
)},
2008 BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_END
};
2010 static bt_component_class_initialize_method_status
2011 lttng_live_component_create(const bt_value
*params
, bt_self_component_source
*self_comp
,
2012 lttng_live_component::UP
& component
)
2014 const bt_value
*inputs_value
;
2015 const bt_value
*url_value
;
2016 const bt_value
*value
;
2017 enum bt_param_validation_status validation_status
;
2018 gchar
*validation_error
= NULL
;
2019 bt2c::Logger logger
{bt2::SelfSourceComponent
{self_comp
}, "PLUGIN/SRC.CTF.LTTNG-LIVE/COMP"};
2021 validation_status
= bt_param_validation_validate(params
, params_descr
, &validation_error
);
2022 if (validation_status
== BT_PARAM_VALIDATION_STATUS_MEMORY_ERROR
) {
2023 return BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_MEMORY_ERROR
;
2024 } else if (validation_status
== BT_PARAM_VALIDATION_STATUS_VALIDATION_ERROR
) {
2025 bt2c::GCharUP errorFreer
{validation_error
};
2026 BT_CPPLOGE_APPEND_CAUSE_SPEC(logger
, "{}", validation_error
);
2027 return BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_ERROR
;
2030 auto lttng_live
= bt2s::make_unique
<lttng_live_component
>(std::move(logger
));
2031 lttng_live
->self_comp
= bt_self_component_source_as_self_component(self_comp
);
2032 lttng_live
->max_query_size
= MAX_QUERY_SIZE
;
2033 lttng_live
->has_msg_iter
= false;
2035 inputs_value
= bt_value_map_borrow_entry_value_const(params
, INPUTS_PARAM
);
2036 url_value
= bt_value_array_borrow_element_by_index_const(inputs_value
, 0);
2037 lttng_live
->params
.url
= bt_value_string_get(url_value
);
2039 value
= bt_value_map_borrow_entry_value_const(params
, SESS_NOT_FOUND_ACTION_PARAM
);
2041 lttng_live
->params
.sess_not_found_act
= parse_session_not_found_action_param(value
);
2043 BT_CPPLOGI_SPEC(lttng_live
->logger
,
2044 "Optional `{}` parameter is missing: defaulting to `{}`.",
2045 SESS_NOT_FOUND_ACTION_PARAM
, SESS_NOT_FOUND_ACTION_CONTINUE_STR
);
2046 lttng_live
->params
.sess_not_found_act
= SESSION_NOT_FOUND_ACTION_CONTINUE
;
2049 component
= std::move(lttng_live
);
2050 return BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_OK
;
2053 bt_component_class_initialize_method_status
2054 lttng_live_component_init(bt_self_component_source
*self_comp_src
,
2055 bt_self_component_source_configuration
*, const bt_value
*params
, void *)
2058 lttng_live_component::UP lttng_live
;
2059 bt_component_class_initialize_method_status ret
;
2060 bt_self_component
*self_comp
= bt_self_component_source_as_self_component(self_comp_src
);
2061 bt_self_component_add_port_status add_port_status
;
2063 ret
= lttng_live_component_create(params
, self_comp_src
, lttng_live
);
2064 if (ret
!= BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_OK
) {
2069 bt_self_component_source_add_output_port(self_comp_src
, "out", NULL
, NULL
);
2070 if (add_port_status
!= BT_SELF_COMPONENT_ADD_PORT_STATUS_OK
) {
2071 ret
= (bt_component_class_initialize_method_status
) add_port_status
;
2075 bt_self_component_set_data(self_comp
, lttng_live
.release());
2077 return BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_OK
;
2078 } catch (const std::bad_alloc
&) {
2079 return BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_MEMORY_ERROR
;
2080 } catch (const bt2::Error
&) {
2081 return BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_ERROR
;