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/bt2c/vector.hpp"
18 #include "cpp-common/bt2s/make-unique.hpp"
19 #include "cpp-common/vendor/fmt/format.h"
21 #include "plugins/common/muxing/muxing.h"
22 #include "plugins/common/param-validation/param-validation.h"
24 #include "data-stream.hpp"
25 #include "lttng-live.hpp"
26 #include "metadata.hpp"
28 #define MAX_QUERY_SIZE (256 * 1024)
29 #define URL_PARAM "url"
30 #define INPUTS_PARAM "inputs"
31 #define SESS_NOT_FOUND_ACTION_PARAM "session-not-found-action"
32 #define SESS_NOT_FOUND_ACTION_CONTINUE_STR "continue"
33 #define SESS_NOT_FOUND_ACTION_FAIL_STR "fail"
34 #define SESS_NOT_FOUND_ACTION_END_STR "end"
36 void lttng_live_stream_iterator_set_state(struct lttng_live_stream_iterator
*stream_iter
,
37 enum lttng_live_stream_state new_state
)
39 BT_CPPLOGD_SPEC(stream_iter
->logger
,
40 "Setting live stream iterator state: viewer-stream-id={}, "
41 "old-state={}, new-state={}",
42 stream_iter
->viewer_stream_id
, stream_iter
->state
, new_state
);
44 stream_iter
->state
= new_state
;
47 #define LTTNG_LIVE_LOGD_STREAM_ITER(live_stream_iter) \
49 BT_CPPLOGD_SPEC((live_stream_iter)->logger, \
50 "Live stream iterator state={}, " \
51 "last-inact-ts-is-set={}, last-inact-ts-value={}, " \
53 (live_stream_iter)->state, (live_stream_iter)->last_inactivity_ts.is_set, \
54 (live_stream_iter)->last_inactivity_ts.value, \
55 (live_stream_iter)->current_inactivity_ts); \
58 bool lttng_live_graph_is_canceled(struct lttng_live_msg_iter
*msg_iter
)
67 ret
= bt_self_message_iterator_is_interrupted(msg_iter
->self_msg_iter
);
73 static struct lttng_live_trace
*
74 lttng_live_session_borrow_trace_by_id(struct lttng_live_session
*session
, uint64_t trace_id
)
76 for (lttng_live_trace::UP
& trace
: session
->traces
) {
77 if (trace
->id
== trace_id
) {
85 static struct lttng_live_trace
*lttng_live_create_trace(struct lttng_live_session
*session
,
88 BT_CPPLOGD_SPEC(session
->logger
, "Creating live trace: session-id={}, trace-id={}", session
->id
,
91 auto trace
= bt2s::make_unique
<lttng_live_trace
>(session
->logger
);
93 trace
->session
= session
;
95 trace
->metadata_stream_state
= LTTNG_LIVE_METADATA_STREAM_STATE_NEEDED
;
97 const auto ret
= trace
.get();
98 session
->traces
.emplace_back(std::move(trace
));
102 struct lttng_live_trace
*
103 lttng_live_session_borrow_or_create_trace_by_id(struct lttng_live_session
*session
,
106 struct lttng_live_trace
*trace
;
108 trace
= lttng_live_session_borrow_trace_by_id(session
, trace_id
);
113 /* The session is the owner of the newly created trace. */
114 trace
= lttng_live_create_trace(session
, trace_id
);
120 int lttng_live_add_session(struct lttng_live_msg_iter
*lttng_live_msg_iter
, uint64_t session_id
,
121 const char *hostname
, const char *session_name
)
123 BT_CPPLOGD_SPEC(lttng_live_msg_iter
->logger
,
124 "Adding live session: "
125 "session-id={}, hostname=\"{}\", session-name=\"{}\"",
126 session_id
, hostname
, session_name
);
128 lttng_live_session
*session
= new lttng_live_session
{lttng_live_msg_iter
->logger
};
129 session
->self_comp
= lttng_live_msg_iter
->self_comp
;
130 session
->id
= session_id
;
131 session
->lttng_live_msg_iter
= lttng_live_msg_iter
;
132 session
->new_streams_needed
= true;
133 session
->hostname
= g_string_new(hostname
);
134 BT_ASSERT(session
->hostname
);
136 session
->session_name
= g_string_new(session_name
);
137 BT_ASSERT(session
->session_name
);
139 g_ptr_array_add(lttng_live_msg_iter
->sessions
, session
);
144 static void lttng_live_destroy_session(struct lttng_live_session
*session
)
150 BT_CPPLOGD_SPEC(session
->logger
,
151 "Destroying live session: "
152 "session-id={}, session-name=\"{}\"",
153 session
->id
, session
->session_name
->str
);
154 if (session
->id
!= -1ULL) {
155 if (lttng_live_session_detach(session
)) {
156 if (!lttng_live_graph_is_canceled(session
->lttng_live_msg_iter
)) {
157 /* Old relayd cannot detach sessions. */
158 BT_CPPLOGD_SPEC(session
->logger
, "Unable to detach lttng live session {}",
165 if (session
->hostname
) {
166 g_string_free(session
->hostname
, TRUE
);
169 if (session
->session_name
) {
170 g_string_free(session
->session_name
, TRUE
);
179 static void lttng_live_msg_iter_destroy(struct lttng_live_msg_iter
*lttng_live_msg_iter
)
181 if (!lttng_live_msg_iter
) {
185 if (lttng_live_msg_iter
->sessions
) {
186 g_ptr_array_free(lttng_live_msg_iter
->sessions
, TRUE
);
189 if (lttng_live_msg_iter
->viewer_connection
) {
190 live_viewer_connection_destroy(lttng_live_msg_iter
->viewer_connection
);
192 BT_ASSERT(lttng_live_msg_iter
->lttng_live_comp
);
193 BT_ASSERT(lttng_live_msg_iter
->lttng_live_comp
->has_msg_iter
);
195 /* All stream iterators must be destroyed at this point. */
196 BT_ASSERT(lttng_live_msg_iter
->active_stream_iter
== 0);
197 lttng_live_msg_iter
->lttng_live_comp
->has_msg_iter
= false;
199 delete lttng_live_msg_iter
;
205 void lttng_live_msg_iter_finalize(bt_self_message_iterator
*self_msg_iter
)
207 struct lttng_live_msg_iter
*lttng_live_msg_iter
;
209 BT_ASSERT(self_msg_iter
);
211 lttng_live_msg_iter
=
212 (struct lttng_live_msg_iter
*) bt_self_message_iterator_get_data(self_msg_iter
);
213 BT_ASSERT(lttng_live_msg_iter
);
214 lttng_live_msg_iter_destroy(lttng_live_msg_iter
);
217 static enum lttng_live_iterator_status
218 lttng_live_iterator_next_check_stream_state(struct lttng_live_stream_iterator
*lttng_live_stream
)
220 switch (lttng_live_stream
->state
) {
221 case LTTNG_LIVE_STREAM_QUIESCENT
:
222 case LTTNG_LIVE_STREAM_ACTIVE_DATA
:
224 case LTTNG_LIVE_STREAM_ACTIVE_NO_DATA
:
226 BT_CPPLOGF_SPEC(lttng_live_stream
->logger
, "Unexpected stream state \"ACTIVE_NO_DATA\"");
228 case LTTNG_LIVE_STREAM_QUIESCENT_NO_DATA
:
230 BT_CPPLOGF_SPEC(lttng_live_stream
->logger
, "Unexpected stream state \"QUIESCENT_NO_DATA\"");
232 case LTTNG_LIVE_STREAM_EOF
:
235 return LTTNG_LIVE_ITERATOR_STATUS_OK
;
239 * For active no data stream, fetch next index. As a result of that it can
241 * - quiescent: won't have events for a bit,
242 * - have data: need to get that data and produce the event,
243 * - have no data on this stream at this point: need to retry (AGAIN) or return
246 static enum lttng_live_iterator_status
lttng_live_iterator_next_handle_one_no_data_stream(
247 struct lttng_live_msg_iter
*lttng_live_msg_iter
,
248 struct lttng_live_stream_iterator
*lttng_live_stream
)
250 enum lttng_live_iterator_status ret
= LTTNG_LIVE_ITERATOR_STATUS_OK
;
251 enum lttng_live_stream_state orig_state
= lttng_live_stream
->state
;
252 struct packet_index index
;
254 if (lttng_live_stream
->trace
->metadata_stream_state
==
255 LTTNG_LIVE_METADATA_STREAM_STATE_NEEDED
) {
256 BT_CPPLOGD_SPEC(lttng_live_msg_iter
->logger
,
257 "Need to get an update for the metadata stream before proceeding "
258 "further with this stream: stream-name=\"{}\"",
259 lttng_live_stream
->name
);
260 ret
= LTTNG_LIVE_ITERATOR_STATUS_CONTINUE
;
264 if (lttng_live_stream
->trace
->session
->new_streams_needed
) {
265 BT_CPPLOGD_SPEC(lttng_live_msg_iter
->logger
,
266 "Need to get an update of all streams before proceeding further "
267 "with this stream: stream-name=\"{}\"",
268 lttng_live_stream
->name
);
269 ret
= LTTNG_LIVE_ITERATOR_STATUS_CONTINUE
;
273 if (lttng_live_stream
->state
!= LTTNG_LIVE_STREAM_ACTIVE_NO_DATA
&&
274 lttng_live_stream
->state
!= LTTNG_LIVE_STREAM_QUIESCENT_NO_DATA
) {
277 ret
= lttng_live_get_next_index(lttng_live_msg_iter
, lttng_live_stream
, &index
);
278 if (ret
!= LTTNG_LIVE_ITERATOR_STATUS_OK
) {
282 BT_ASSERT_DBG(lttng_live_stream
->state
!= LTTNG_LIVE_STREAM_EOF
);
284 if (lttng_live_stream
->state
== LTTNG_LIVE_STREAM_QUIESCENT
) {
285 uint64_t last_inact_ts
= lttng_live_stream
->last_inactivity_ts
.value
,
286 curr_inact_ts
= lttng_live_stream
->current_inactivity_ts
;
288 if (orig_state
== LTTNG_LIVE_STREAM_QUIESCENT_NO_DATA
&& last_inact_ts
== curr_inact_ts
) {
290 * Because the stream is in the QUIESCENT_NO_DATA
291 * state, we can assert that the last_inactivity_ts was
292 * set and can be safely used in the `if` above.
294 BT_ASSERT(lttng_live_stream
->last_inactivity_ts
.is_set
);
296 ret
= LTTNG_LIVE_ITERATOR_STATUS_AGAIN
;
297 LTTNG_LIVE_LOGD_STREAM_ITER(lttng_live_stream
);
299 ret
= LTTNG_LIVE_ITERATOR_STATUS_CONTINUE
;
304 lttng_live_stream
->base_offset
= index
.offset
;
305 lttng_live_stream
->offset
= index
.offset
;
306 lttng_live_stream
->len
= index
.packet_size
/ CHAR_BIT
;
308 BT_CPPLOGD_SPEC(lttng_live_msg_iter
->logger
,
309 "Setting live stream reading info: stream-name=\"{}\", "
310 "viewer-stream-id={}, stream-base-offset={}, stream-offset={}, stream-len={}",
311 lttng_live_stream
->name
, lttng_live_stream
->viewer_stream_id
,
312 lttng_live_stream
->base_offset
, lttng_live_stream
->offset
,
313 lttng_live_stream
->len
);
316 if (ret
== LTTNG_LIVE_ITERATOR_STATUS_OK
) {
317 ret
= lttng_live_iterator_next_check_stream_state(lttng_live_stream
);
323 * Creation of the message requires the ctf trace class to be created
324 * beforehand, but the live protocol gives us all streams (including metadata)
325 * at once. So we split it in three steps: getting streams, getting metadata
326 * (which creates the ctf trace class), and then creating the per-stream
329 static enum lttng_live_iterator_status
330 lttng_live_get_session(struct lttng_live_msg_iter
*lttng_live_msg_iter
,
331 struct lttng_live_session
*session
)
333 enum lttng_live_iterator_status status
;
335 if (!session
->attached
) {
336 BT_CPPLOGD_SPEC(lttng_live_msg_iter
->logger
, "Attach to session: session-id={}",
338 enum lttng_live_viewer_status attach_status
=
339 lttng_live_session_attach(session
, lttng_live_msg_iter
->self_msg_iter
);
340 if (attach_status
!= LTTNG_LIVE_VIEWER_STATUS_OK
) {
341 if (lttng_live_graph_is_canceled(lttng_live_msg_iter
)) {
343 * Clear any causes appended in
344 * `lttng_live_attach_session()` as we want to
345 * return gracefully since the graph was
348 bt_current_thread_clear_error();
349 status
= LTTNG_LIVE_ITERATOR_STATUS_AGAIN
;
351 status
= LTTNG_LIVE_ITERATOR_STATUS_ERROR
;
352 BT_CPPLOGE_APPEND_CAUSE_SPEC(lttng_live_msg_iter
->logger
,
353 "Error attaching to LTTng live session");
359 BT_CPPLOGD_SPEC(lttng_live_msg_iter
->logger
,
360 "Updating all data streams: "
361 "session-id={}, session-name=\"{}\"",
362 session
->id
, session
->session_name
->str
);
364 status
= lttng_live_session_get_new_streams(session
, lttng_live_msg_iter
->self_msg_iter
);
366 case LTTNG_LIVE_ITERATOR_STATUS_OK
:
368 case LTTNG_LIVE_ITERATOR_STATUS_END
:
370 * We received a `_END` from the `_get_new_streams()` function,
371 * which means no more data will ever be received from the data
372 * streams of this session. But it's possible that the metadata
374 * The live protocol guarantees that we receive all the
375 * metadata needed before we receive data streams needing it.
376 * But it's possible to receive metadata NOT needed by
377 * data streams after the session was closed. For example, this
378 * could happen if a new event is registered and the session is
379 * stopped before any tracepoint for that event is actually
383 lttng_live_msg_iter
->logger
,
384 "Updating streams returned _END status. Override status to _OK in order fetch any remaining metadata:"
385 "session-id={}, session-name=\"{}\"",
386 session
->id
, session
->session_name
->str
);
387 status
= LTTNG_LIVE_ITERATOR_STATUS_OK
;
393 BT_CPPLOGD_SPEC(lttng_live_msg_iter
->logger
,
394 "Updating metadata stream for session: "
395 "session-id={}, session-name=\"{}\"",
396 session
->id
, session
->session_name
->str
);
398 for (lttng_live_trace::UP
& trace
: session
->traces
) {
399 status
= lttng_live_metadata_update(trace
.get());
401 case LTTNG_LIVE_ITERATOR_STATUS_END
:
402 case LTTNG_LIVE_ITERATOR_STATUS_OK
:
404 case LTTNG_LIVE_ITERATOR_STATUS_CONTINUE
:
405 case LTTNG_LIVE_ITERATOR_STATUS_AGAIN
:
408 BT_CPPLOGE_APPEND_CAUSE_SPEC(lttng_live_msg_iter
->logger
,
409 "Error updating trace metadata: "
410 "stream-iter-status={}, trace-id={}",
417 * Now that we have the metadata we can initialize the downstream
420 status
= lttng_live_lazy_msg_init(session
, lttng_live_msg_iter
->self_msg_iter
);
427 lttng_live_force_new_streams_and_metadata(struct lttng_live_msg_iter
*lttng_live_msg_iter
)
429 uint64_t session_idx
;
431 for (session_idx
= 0; session_idx
< lttng_live_msg_iter
->sessions
->len
; session_idx
++) {
432 struct lttng_live_session
*session
=
433 (lttng_live_session
*) g_ptr_array_index(lttng_live_msg_iter
->sessions
, session_idx
);
434 BT_CPPLOGD_SPEC(lttng_live_msg_iter
->logger
,
435 "Force marking session as needing new streams: "
438 session
->new_streams_needed
= true;
439 for (lttng_live_trace::UP
& trace
: session
->traces
) {
440 BT_CPPLOGD_SPEC(lttng_live_msg_iter
->logger
,
441 "Force marking trace metadata state as needing an update: "
442 "session-id={}, trace-id={}",
443 session
->id
, trace
->id
);
445 BT_ASSERT(trace
->metadata_stream_state
!= LTTNG_LIVE_METADATA_STREAM_STATE_CLOSED
);
447 trace
->metadata_stream_state
= LTTNG_LIVE_METADATA_STREAM_STATE_NEEDED
;
452 static enum lttng_live_iterator_status
453 lttng_live_iterator_handle_new_streams_and_metadata(struct lttng_live_msg_iter
*lttng_live_msg_iter
)
455 enum lttng_live_iterator_status status
;
456 enum lttng_live_viewer_status viewer_status
;
457 uint64_t session_idx
= 0, nr_sessions_opened
= 0;
458 struct lttng_live_session
*session
;
459 enum session_not_found_action sess_not_found_act
=
460 lttng_live_msg_iter
->lttng_live_comp
->params
.sess_not_found_act
;
462 BT_CPPLOGD_SPEC(lttng_live_msg_iter
->logger
,
463 "Update data and metadata of all sessions: "
464 "live-msg-iter-addr={}",
465 fmt::ptr(lttng_live_msg_iter
));
467 * In a remotely distant future, we could add a "new
468 * session" flag to the protocol, which would tell us that we
469 * need to query for new sessions even though we have sessions
472 if (lttng_live_msg_iter
->sessions
->len
== 0) {
473 if (sess_not_found_act
!= SESSION_NOT_FOUND_ACTION_CONTINUE
) {
475 lttng_live_msg_iter
->logger
,
476 "No session found. Exiting in accordance with the `session-not-found-action` parameter");
477 status
= LTTNG_LIVE_ITERATOR_STATUS_END
;
481 lttng_live_msg_iter
->logger
,
482 "No session found. Try creating a new one in accordance with the `session-not-found-action` parameter");
484 * Retry to create a viewer session for the requested
487 viewer_status
= lttng_live_create_viewer_session(lttng_live_msg_iter
);
488 if (viewer_status
!= LTTNG_LIVE_VIEWER_STATUS_OK
) {
489 if (viewer_status
== LTTNG_LIVE_VIEWER_STATUS_ERROR
) {
490 status
= LTTNG_LIVE_ITERATOR_STATUS_ERROR
;
491 BT_CPPLOGE_APPEND_CAUSE_SPEC(lttng_live_msg_iter
->logger
,
492 "Error creating LTTng live viewer session");
493 } else if (viewer_status
== LTTNG_LIVE_VIEWER_STATUS_INTERRUPTED
) {
494 status
= LTTNG_LIVE_ITERATOR_STATUS_AGAIN
;
503 for (session_idx
= 0; session_idx
< lttng_live_msg_iter
->sessions
->len
; session_idx
++) {
505 (lttng_live_session
*) g_ptr_array_index(lttng_live_msg_iter
->sessions
, session_idx
);
506 status
= lttng_live_get_session(lttng_live_msg_iter
, session
);
508 case LTTNG_LIVE_ITERATOR_STATUS_OK
:
509 case LTTNG_LIVE_ITERATOR_STATUS_END
:
511 * A session returned `_END`. Other sessions may still
512 * be active so we override the status and continue
519 if (!session
->closed
) {
520 nr_sessions_opened
++;
524 if (sess_not_found_act
!= SESSION_NOT_FOUND_ACTION_CONTINUE
&& nr_sessions_opened
== 0) {
525 status
= LTTNG_LIVE_ITERATOR_STATUS_END
;
527 status
= LTTNG_LIVE_ITERATOR_STATUS_OK
;
534 static enum lttng_live_iterator_status
535 emit_inactivity_message(struct lttng_live_msg_iter
*lttng_live_msg_iter
,
536 struct lttng_live_stream_iterator
*stream_iter
,
537 bt2::ConstMessage::Shared
& message
, uint64_t timestamp
)
539 BT_ASSERT(stream_iter
->trace
->clock_class
);
540 BT_CPPLOGD_SPEC(lttng_live_msg_iter
->logger
,
541 "Emitting inactivity message for stream: ctf-stream-id={}, "
542 "viewer-stream-id={}, timestamp={}",
543 stream_iter
->ctf_stream_class_id
.value
, stream_iter
->viewer_stream_id
,
546 const auto msg
= bt_message_message_iterator_inactivity_create(
547 lttng_live_msg_iter
->self_msg_iter
, stream_iter
->trace
->clock_class
, timestamp
);
550 BT_CPPLOGE_APPEND_CAUSE_SPEC(lttng_live_msg_iter
->logger
,
551 "Error emitting message iterator inactivity message");
552 return LTTNG_LIVE_ITERATOR_STATUS_ERROR
;
555 message
= bt2::ConstMessage::Shared::createWithoutRef(msg
);
556 return LTTNG_LIVE_ITERATOR_STATUS_OK
;
559 static enum lttng_live_iterator_status
lttng_live_iterator_next_handle_one_quiescent_stream(
560 struct lttng_live_msg_iter
*lttng_live_msg_iter
,
561 struct lttng_live_stream_iterator
*lttng_live_stream
, bt2::ConstMessage::Shared
& message
)
563 enum lttng_live_iterator_status ret
= LTTNG_LIVE_ITERATOR_STATUS_OK
;
565 if (lttng_live_stream
->state
!= LTTNG_LIVE_STREAM_QUIESCENT
) {
566 return LTTNG_LIVE_ITERATOR_STATUS_OK
;
570 * Check if we already sent an inactivty message downstream for this
571 * `current_inactivity_ts` value.
573 if (lttng_live_stream
->last_inactivity_ts
.is_set
&&
574 lttng_live_stream
->current_inactivity_ts
== lttng_live_stream
->last_inactivity_ts
.value
) {
575 lttng_live_stream_iterator_set_state(lttng_live_stream
,
576 LTTNG_LIVE_STREAM_QUIESCENT_NO_DATA
);
578 ret
= LTTNG_LIVE_ITERATOR_STATUS_CONTINUE
;
582 ret
= emit_inactivity_message(lttng_live_msg_iter
, lttng_live_stream
, message
,
583 lttng_live_stream
->current_inactivity_ts
);
585 lttng_live_stream
->last_inactivity_ts
.value
= lttng_live_stream
->current_inactivity_ts
;
586 lttng_live_stream
->last_inactivity_ts
.is_set
= true;
591 static int live_get_msg_ts_ns(struct lttng_live_msg_iter
*lttng_live_msg_iter
,
592 const bt_message
*msg
, int64_t last_msg_ts_ns
, int64_t *ts_ns
)
594 const bt_clock_snapshot
*clock_snapshot
= NULL
;
598 BT_ASSERT_DBG(ts_ns
);
600 BT_CPPLOGD_SPEC(lttng_live_msg_iter
->logger
,
601 "Getting message's timestamp: iter-data-addr={}, msg-addr={}, "
603 fmt::ptr(lttng_live_msg_iter
), fmt::ptr(msg
), last_msg_ts_ns
);
605 switch (bt_message_get_type(msg
)) {
606 case BT_MESSAGE_TYPE_EVENT
:
607 clock_snapshot
= bt_message_event_borrow_default_clock_snapshot_const(msg
);
609 case BT_MESSAGE_TYPE_PACKET_BEGINNING
:
610 clock_snapshot
= bt_message_packet_beginning_borrow_default_clock_snapshot_const(msg
);
612 case BT_MESSAGE_TYPE_PACKET_END
:
613 clock_snapshot
= bt_message_packet_end_borrow_default_clock_snapshot_const(msg
);
615 case BT_MESSAGE_TYPE_DISCARDED_EVENTS
:
617 bt_message_discarded_events_borrow_beginning_default_clock_snapshot_const(msg
);
619 case BT_MESSAGE_TYPE_DISCARDED_PACKETS
:
621 bt_message_discarded_packets_borrow_beginning_default_clock_snapshot_const(msg
);
623 case BT_MESSAGE_TYPE_MESSAGE_ITERATOR_INACTIVITY
:
624 clock_snapshot
= bt_message_message_iterator_inactivity_borrow_clock_snapshot_const(msg
);
627 /* All the other messages have a higher priority */
628 BT_CPPLOGD_STR_SPEC(lttng_live_msg_iter
->logger
,
629 "Message has no timestamp: using the last message timestamp.");
630 *ts_ns
= last_msg_ts_ns
;
634 ret
= bt_clock_snapshot_get_ns_from_origin(clock_snapshot
, ts_ns
);
636 BT_CPPLOGE_APPEND_CAUSE_SPEC(lttng_live_msg_iter
->logger
,
637 "Cannot get nanoseconds from Epoch of clock snapshot: "
638 "clock-snapshot-addr={}",
639 fmt::ptr(clock_snapshot
));
650 BT_CPPLOGD_SPEC(lttng_live_msg_iter
->logger
,
651 "Found message's timestamp: iter-data-addr={}, msg-addr={}, "
652 "last-msg-ts={}, ts={}",
653 fmt::ptr(lttng_live_msg_iter
), fmt::ptr(msg
), last_msg_ts_ns
, *ts_ns
);
659 static enum lttng_live_iterator_status
lttng_live_iterator_next_handle_one_active_data_stream(
660 struct lttng_live_msg_iter
*lttng_live_msg_iter
,
661 struct lttng_live_stream_iterator
*lttng_live_stream
, bt2::ConstMessage::Shared
& message
)
663 enum lttng_live_iterator_status ret
= LTTNG_LIVE_ITERATOR_STATUS_OK
;
664 enum ctf_msg_iter_status status
;
665 uint64_t session_idx
;
667 for (session_idx
= 0; session_idx
< lttng_live_msg_iter
->sessions
->len
; session_idx
++) {
668 struct lttng_live_session
*session
=
669 (lttng_live_session
*) g_ptr_array_index(lttng_live_msg_iter
->sessions
, session_idx
);
671 if (session
->new_streams_needed
) {
672 BT_CPPLOGD_SPEC(lttng_live_msg_iter
->logger
,
673 "Need an update for streams: "
676 ret
= LTTNG_LIVE_ITERATOR_STATUS_CONTINUE
;
679 for (lttng_live_trace::UP
& trace
: session
->traces
) {
680 if (trace
->metadata_stream_state
== LTTNG_LIVE_METADATA_STREAM_STATE_NEEDED
) {
681 BT_CPPLOGD_SPEC(lttng_live_msg_iter
->logger
,
682 "Need an update for metadata stream: "
683 "session-id={}, trace-id={}",
684 session
->id
, trace
->id
);
685 ret
= LTTNG_LIVE_ITERATOR_STATUS_CONTINUE
;
691 if (lttng_live_stream
->state
!= LTTNG_LIVE_STREAM_ACTIVE_DATA
) {
692 ret
= LTTNG_LIVE_ITERATOR_STATUS_ERROR
;
693 BT_CPPLOGE_APPEND_CAUSE_SPEC(lttng_live_msg_iter
->logger
,
694 "Invalid state of live stream iterator"
695 "stream-iter-status={}",
696 lttng_live_stream
->state
);
700 const bt_message
*msg
;
701 status
= ctf_msg_iter_get_next_message(lttng_live_stream
->msg_iter
.get(), &msg
);
703 case CTF_MSG_ITER_STATUS_EOF
:
704 ret
= LTTNG_LIVE_ITERATOR_STATUS_END
;
706 case CTF_MSG_ITER_STATUS_OK
:
707 message
= bt2::ConstMessage::Shared::createWithoutRef(msg
);
708 ret
= LTTNG_LIVE_ITERATOR_STATUS_OK
;
710 case CTF_MSG_ITER_STATUS_AGAIN
:
712 * Continue immediately (end of packet). The next
713 * get_index may return AGAIN to delay the following
716 ret
= LTTNG_LIVE_ITERATOR_STATUS_CONTINUE
;
718 case CTF_MSG_ITER_STATUS_ERROR
:
720 ret
= LTTNG_LIVE_ITERATOR_STATUS_ERROR
;
721 BT_CPPLOGE_APPEND_CAUSE_SPEC(lttng_live_msg_iter
->logger
,
722 "CTF message iterator failed to get next message: "
723 "msg-iter={}, msg-iter-status={}",
724 fmt::ptr(lttng_live_stream
->msg_iter
), status
);
732 static enum lttng_live_iterator_status
733 lttng_live_iterator_close_stream(struct lttng_live_msg_iter
*lttng_live_msg_iter
,
734 struct lttng_live_stream_iterator
*stream_iter
,
735 bt2::ConstMessage::Shared
& curr_msg
)
737 enum lttng_live_iterator_status live_status
= LTTNG_LIVE_ITERATOR_STATUS_OK
;
739 BT_CPPLOGD_SPEC(lttng_live_msg_iter
->logger
,
740 "Closing live stream iterator: stream-name=\"{}\", "
741 "viewer-stream-id={}",
742 stream_iter
->name
, stream_iter
->viewer_stream_id
);
745 * The viewer has hung up on us so we are closing the stream. The
746 * `ctf_msg_iter` should simply realize that it needs to close the
747 * stream properly by emitting the necessary stream end message.
749 const bt_message
*msg
;
750 enum ctf_msg_iter_status status
=
751 ctf_msg_iter_get_next_message(stream_iter
->msg_iter
.get(), &msg
);
753 if (status
== CTF_MSG_ITER_STATUS_ERROR
) {
754 BT_CPPLOGE_APPEND_CAUSE_SPEC(lttng_live_msg_iter
->logger
,
755 "Error getting the next message from CTF message iterator");
756 live_status
= LTTNG_LIVE_ITERATOR_STATUS_ERROR
;
758 } else if (status
== CTF_MSG_ITER_STATUS_EOF
) {
759 BT_CPPLOGI_SPEC(lttng_live_msg_iter
->logger
,
760 "Reached the end of the live stream iterator.");
761 live_status
= LTTNG_LIVE_ITERATOR_STATUS_END
;
765 BT_ASSERT(status
== CTF_MSG_ITER_STATUS_OK
);
767 curr_msg
= bt2::ConstMessage::Shared::createWithoutRef(msg
);
775 * handle_no_data_streams()
777 * - for each ACTIVE_NO_DATA stream:
778 * - query relayd for stream data, or quiescence info.
779 * - if need metadata, get metadata, goto retry.
780 * - if new stream, get new stream as ACTIVE_NO_DATA, goto retry
781 * - if quiescent, move to QUIESCENT streams
782 * - if fetched data, move to ACTIVE_DATA streams
783 * (at this point each stream either has data, or is quiescent)
787 * handle_new_streams_and_metadata()
788 * - query relayd for known streams, add them as ACTIVE_NO_DATA
789 * - query relayd for metadata
791 * call handle_active_no_data_streams()
793 * handle_quiescent_streams()
794 * - if at least one stream is ACTIVE_DATA:
795 * - peek stream event with lowest timestamp -> next_ts
796 * - for each quiescent stream
797 * - if next_ts >= quiescent end
798 * - set state to ACTIVE_NO_DATA
800 * - for each quiescent stream
801 * - set state to ACTIVE_NO_DATA
803 * call handle_active_no_data_streams()
805 * handle_active_data_streams()
806 * - if at least one stream is ACTIVE_DATA:
807 * - get stream event with lowest timestamp from heap
808 * - make that stream event the current message.
809 * - move this stream heap position to its next event
810 * - if we need to fetch data from relayd, move
811 * stream to ACTIVE_NO_DATA.
815 * end criterion: ctrl-c on client. If relayd exits or the session
816 * closes on the relay daemon side, we keep on waiting for streams.
817 * Eventually handle --end timestamp (also an end criterion).
819 * When disconnected from relayd: try to re-connect endlessly.
821 static enum lttng_live_iterator_status
822 lttng_live_iterator_next_msg_on_stream(struct lttng_live_msg_iter
*lttng_live_msg_iter
,
823 struct lttng_live_stream_iterator
*stream_iter
,
824 bt2::ConstMessage::Shared
& curr_msg
)
826 enum lttng_live_iterator_status live_status
;
828 BT_CPPLOGD_SPEC(lttng_live_msg_iter
->logger
,
829 "Advancing live stream iterator until next message if possible: "
830 "stream-name=\"{}\", viewer-stream-id={}",
831 stream_iter
->name
, stream_iter
->viewer_stream_id
);
833 if (stream_iter
->has_stream_hung_up
) {
835 * The stream has hung up and the stream was properly closed
836 * during the last call to the current function. Return _END
837 * status now so that this stream iterator is removed for the
838 * stream iterator list.
840 live_status
= LTTNG_LIVE_ITERATOR_STATUS_END
;
845 LTTNG_LIVE_LOGD_STREAM_ITER(stream_iter
);
848 * Make sure we have the most recent metadata and possibly some new
851 live_status
= lttng_live_iterator_handle_new_streams_and_metadata(lttng_live_msg_iter
);
852 if (live_status
!= LTTNG_LIVE_ITERATOR_STATUS_OK
) {
857 lttng_live_iterator_next_handle_one_no_data_stream(lttng_live_msg_iter
, stream_iter
);
858 if (live_status
!= LTTNG_LIVE_ITERATOR_STATUS_OK
) {
859 if (live_status
== LTTNG_LIVE_ITERATOR_STATUS_END
) {
861 * We overwrite `live_status` since `curr_msg` is
862 * likely set to a valid message in this function.
865 lttng_live_iterator_close_stream(lttng_live_msg_iter
, stream_iter
, curr_msg
);
870 live_status
= lttng_live_iterator_next_handle_one_quiescent_stream(lttng_live_msg_iter
,
871 stream_iter
, curr_msg
);
872 if (live_status
!= LTTNG_LIVE_ITERATOR_STATUS_OK
) {
873 BT_ASSERT(!curr_msg
);
879 live_status
= lttng_live_iterator_next_handle_one_active_data_stream(lttng_live_msg_iter
,
880 stream_iter
, curr_msg
);
881 if (live_status
!= LTTNG_LIVE_ITERATOR_STATUS_OK
) {
882 BT_ASSERT(!curr_msg
);
886 if (live_status
== LTTNG_LIVE_ITERATOR_STATUS_CONTINUE
) {
888 lttng_live_msg_iter
->logger
,
889 "Ask the relay daemon for an updated view of the data and metadata streams");
893 BT_CPPLOGD_SPEC(lttng_live_msg_iter
->logger
,
894 "Returning from advancing live stream iterator: status={}, "
895 "stream-name=\"{}\", viewer-stream-id={}",
896 live_status
, stream_iter
->name
, stream_iter
->viewer_stream_id
);
901 static bool is_discarded_packet_or_event_message(const bt2::ConstMessage msg
)
903 return msg
.type() == bt2::MessageType::DiscardedEvents
||
904 msg
.type() == bt2::MessageType::DiscardedPackets
;
907 static enum lttng_live_iterator_status
908 adjust_discarded_packets_message(bt_self_message_iterator
*iter
, const bt_stream
*stream
,
909 const bt_message
*msg_in
, bt2::ConstMessage::Shared
& msg_out
,
910 uint64_t new_begin_ts
)
912 enum bt_property_availability availability
;
913 const bt_clock_snapshot
*clock_snapshot
;
917 clock_snapshot
= bt_message_discarded_packets_borrow_end_default_clock_snapshot_const(msg_in
);
918 end_ts
= bt_clock_snapshot_get_value(clock_snapshot
);
920 availability
= bt_message_discarded_packets_get_count(msg_in
, &count
);
921 BT_ASSERT_DBG(availability
== BT_PROPERTY_AVAILABILITY_AVAILABLE
);
923 const auto msg
= bt_message_discarded_packets_create_with_default_clock_snapshots(
924 iter
, stream
, new_begin_ts
, end_ts
);
927 return LTTNG_LIVE_ITERATOR_STATUS_NOMEM
;
930 bt_message_discarded_packets_set_count(msg
, count
);
931 msg_out
= bt2::ConstMessage::Shared::createWithoutRef(msg
);
932 return LTTNG_LIVE_ITERATOR_STATUS_OK
;
935 static enum lttng_live_iterator_status
936 adjust_discarded_events_message(bt_self_message_iterator
*iter
, const bt_stream
*stream
,
937 const bt_message
*msg_in
, bt2::ConstMessage::Shared
& msg_out
,
938 uint64_t new_begin_ts
)
940 enum bt_property_availability availability
;
941 const bt_clock_snapshot
*clock_snapshot
;
945 clock_snapshot
= bt_message_discarded_events_borrow_end_default_clock_snapshot_const(msg_in
);
946 end_ts
= bt_clock_snapshot_get_value(clock_snapshot
);
948 availability
= bt_message_discarded_events_get_count(msg_in
, &count
);
949 BT_ASSERT_DBG(availability
== BT_PROPERTY_AVAILABILITY_AVAILABLE
);
951 const auto msg
= bt_message_discarded_events_create_with_default_clock_snapshots(
952 iter
, stream
, new_begin_ts
, end_ts
);
955 return LTTNG_LIVE_ITERATOR_STATUS_NOMEM
;
958 bt_message_discarded_events_set_count(msg
, count
);
959 msg_out
= bt2::ConstMessage::Shared::createWithoutRef(msg
);
960 return LTTNG_LIVE_ITERATOR_STATUS_OK
;
963 static enum lttng_live_iterator_status
964 handle_late_message(struct lttng_live_msg_iter
*lttng_live_msg_iter
,
965 struct lttng_live_stream_iterator
*stream_iter
, int64_t late_msg_ts_ns
,
966 const bt2::ConstMessage
& late_msg
)
968 const bt_clock_class
*clock_class
;
969 const bt_stream_class
*stream_class
;
970 enum bt_clock_class_cycles_to_ns_from_origin_status ts_ns_status
;
971 int64_t last_inactivity_ts_ns
;
972 enum lttng_live_iterator_status stream_iter_status
= LTTNG_LIVE_ITERATOR_STATUS_OK
;
973 enum lttng_live_iterator_status adjust_status
;
974 bt2::ConstMessage::Shared adjusted_message
;
977 * The timestamp of the current message is before the last message sent
978 * by this component. We CANNOT send it as is.
980 * The only expected scenario in which that could happen is the
981 * following, everything else is a bug in this component, relay daemon,
984 * Expected scenario: The CTF message iterator emitted discarded
985 * packets and discarded events with synthesized beginning and end
986 * timestamps from the bounds of the last known packet and the newly
987 * decoded packet header. The CTF message iterator is not aware of
988 * stream inactivity beacons. Hence, we have to adjust the beginning
989 * timestamp of those types of messages if a stream signalled its
990 * inactivity up until _after_ the last known packet's beginning
993 * Otherwise, the monotonicity guarantee of message timestamps would
996 * In short, the only scenario in which it's okay and fixable to
997 * received a late message is when:
998 * 1. the late message is a discarded packets or discarded events
1000 * 2. this stream produced an inactivity message downstream, and
1001 * 3. the timestamp of the late message is within the inactivity
1002 * timespan we sent downstream through the inactivity message.
1005 BT_CPPLOGD_SPEC(lttng_live_msg_iter
->logger
,
1006 "Handling late message on live stream iterator: "
1007 "stream-name=\"{}\", viewer-stream-id={}",
1008 stream_iter
->name
, stream_iter
->viewer_stream_id
);
1010 if (!stream_iter
->last_inactivity_ts
.is_set
) {
1011 BT_CPPLOGE_APPEND_CAUSE_SPEC(lttng_live_msg_iter
->logger
,
1012 "Invalid live stream state: "
1013 "have a late message when no inactivity message "
1014 "was ever sent for that stream.");
1015 stream_iter_status
= LTTNG_LIVE_ITERATOR_STATUS_ERROR
;
1019 if (!is_discarded_packet_or_event_message(late_msg
)) {
1020 BT_CPPLOGE_APPEND_CAUSE_SPEC(lttng_live_msg_iter
->logger
,
1021 "Invalid live stream state: "
1022 "have a late message that is not a packet discarded or "
1023 "event discarded message: late-msg-type={}",
1025 stream_iter_status
= LTTNG_LIVE_ITERATOR_STATUS_ERROR
;
1029 stream_class
= bt_stream_borrow_class_const(stream_iter
->stream
->libObjPtr());
1030 clock_class
= bt_stream_class_borrow_default_clock_class_const(stream_class
);
1032 ts_ns_status
= bt_clock_class_cycles_to_ns_from_origin(
1033 clock_class
, stream_iter
->last_inactivity_ts
.value
, &last_inactivity_ts_ns
);
1034 if (ts_ns_status
!= BT_CLOCK_CLASS_CYCLES_TO_NS_FROM_ORIGIN_STATUS_OK
) {
1035 BT_CPPLOGE_APPEND_CAUSE_SPEC(lttng_live_msg_iter
->logger
,
1036 "Error converting last "
1037 "inactivity message timestamp to nanoseconds");
1038 stream_iter_status
= LTTNG_LIVE_ITERATOR_STATUS_ERROR
;
1042 if (last_inactivity_ts_ns
<= late_msg_ts_ns
) {
1043 BT_CPPLOGE_APPEND_CAUSE_SPEC(lttng_live_msg_iter
->logger
,
1044 "Invalid live stream state: "
1045 "have a late message that is none included in a stream "
1046 "inactivity timespan: last-inactivity-ts-ns={}, "
1047 "late-msg-ts-ns={}",
1048 last_inactivity_ts_ns
, late_msg_ts_ns
);
1049 stream_iter_status
= LTTNG_LIVE_ITERATOR_STATUS_ERROR
;
1054 * We now know that it's okay for this message to be late, we can now
1055 * adjust its timestamp to ensure monotonicity.
1057 BT_CPPLOGD_SPEC(lttng_live_msg_iter
->logger
,
1058 "Adjusting the timestamp of late message: late-msg-type={}, "
1060 late_msg
.type(), stream_iter
->last_inactivity_ts
.value
);
1061 switch (late_msg
.type()) {
1062 case bt2::MessageType::DiscardedEvents
:
1063 adjust_status
= adjust_discarded_events_message(
1064 lttng_live_msg_iter
->self_msg_iter
, stream_iter
->stream
->libObjPtr(),
1065 late_msg
.libObjPtr(), adjusted_message
, stream_iter
->last_inactivity_ts
.value
);
1067 case bt2::MessageType::DiscardedPackets
:
1068 adjust_status
= adjust_discarded_packets_message(
1069 lttng_live_msg_iter
->self_msg_iter
, stream_iter
->stream
->libObjPtr(),
1070 late_msg
.libObjPtr(), adjusted_message
, stream_iter
->last_inactivity_ts
.value
);
1076 if (adjust_status
!= LTTNG_LIVE_ITERATOR_STATUS_OK
) {
1077 stream_iter_status
= adjust_status
;
1081 BT_ASSERT_DBG(adjusted_message
);
1082 stream_iter
->current_msg
= adjusted_message
;
1083 stream_iter
->current_msg_ts_ns
= last_inactivity_ts_ns
;
1086 return stream_iter_status
;
1089 static enum lttng_live_iterator_status
1090 next_stream_iterator_for_trace(struct lttng_live_msg_iter
*lttng_live_msg_iter
,
1091 struct lttng_live_trace
*live_trace
,
1092 struct lttng_live_stream_iterator
**youngest_trace_stream_iter
)
1094 struct lttng_live_stream_iterator
*youngest_candidate_stream_iter
= NULL
;
1095 enum lttng_live_iterator_status stream_iter_status
;
1096 int64_t youngest_candidate_msg_ts
= INT64_MAX
;
1097 uint64_t stream_iter_idx
;
1099 BT_ASSERT_DBG(live_trace
);
1101 BT_CPPLOGD_SPEC(lttng_live_msg_iter
->logger
,
1102 "Finding the next stream iterator for trace: "
1106 * Update the current message of every stream iterators of this trace.
1107 * The current msg of every stream must have a timestamp equal or
1108 * larger than the last message returned by this iterator. We must
1109 * ensure monotonicity.
1111 stream_iter_idx
= 0;
1112 while (stream_iter_idx
< live_trace
->stream_iterators
.size()) {
1113 bool stream_iter_is_ended
= false;
1114 lttng_live_stream_iterator
*stream_iter
=
1115 live_trace
->stream_iterators
[stream_iter_idx
].get();
1118 * If there is no current message for this stream, go fetch
1121 while (!stream_iter
->current_msg
) {
1122 bt2::ConstMessage::Shared msg
;
1123 int64_t curr_msg_ts_ns
= INT64_MAX
;
1125 stream_iter_status
=
1126 lttng_live_iterator_next_msg_on_stream(lttng_live_msg_iter
, stream_iter
, msg
);
1128 if (stream_iter_status
== LTTNG_LIVE_ITERATOR_STATUS_END
) {
1129 stream_iter_is_ended
= true;
1133 if (stream_iter_status
!= LTTNG_LIVE_ITERATOR_STATUS_OK
) {
1139 BT_CPPLOGD_SPEC(lttng_live_msg_iter
->logger
,
1140 "Live stream iterator returned message: msg-type={}, "
1141 "stream-name=\"{}\", viewer-stream-id={}",
1142 msg
->type(), stream_iter
->name
, stream_iter
->viewer_stream_id
);
1145 * Get the timestamp in nanoseconds from origin of this
1148 live_get_msg_ts_ns(lttng_live_msg_iter
, msg
->libObjPtr(),
1149 lttng_live_msg_iter
->last_msg_ts_ns
, &curr_msg_ts_ns
);
1152 * Check if the message of the current live stream
1153 * iterator occurred at the exact same time or after the
1154 * last message returned by this component's message
1155 * iterator. If not, we need to handle it with care.
1157 if (curr_msg_ts_ns
>= lttng_live_msg_iter
->last_msg_ts_ns
) {
1158 stream_iter
->current_msg
= std::move(msg
);
1159 stream_iter
->current_msg_ts_ns
= curr_msg_ts_ns
;
1162 * We received a message from the past. This
1163 * may be fixable but it can also be an error.
1165 stream_iter_status
=
1166 handle_late_message(lttng_live_msg_iter
, stream_iter
, curr_msg_ts_ns
, *msg
);
1167 if (stream_iter_status
!= LTTNG_LIVE_ITERATOR_STATUS_OK
) {
1168 BT_CPPLOGE_APPEND_CAUSE_SPEC(lttng_live_msg_iter
->logger
,
1169 "Late message could not be handled correctly: "
1170 "lttng-live-msg-iter-addr={}, "
1171 "stream-name=\"{}\", "
1172 "curr-msg-ts={}, last-msg-ts={}",
1173 fmt::ptr(lttng_live_msg_iter
), stream_iter
->name
,
1175 lttng_live_msg_iter
->last_msg_ts_ns
);
1176 stream_iter_status
= LTTNG_LIVE_ITERATOR_STATUS_ERROR
;
1182 BT_ASSERT_DBG(stream_iter
!= youngest_candidate_stream_iter
);
1184 if (!stream_iter_is_ended
) {
1185 if (G_UNLIKELY(youngest_candidate_stream_iter
== NULL
) ||
1186 stream_iter
->current_msg_ts_ns
< youngest_candidate_msg_ts
) {
1188 * Update the current best candidate message
1189 * for the stream iterator of this live trace
1190 * to be forwarded downstream.
1192 youngest_candidate_msg_ts
= stream_iter
->current_msg_ts_ns
;
1193 youngest_candidate_stream_iter
= stream_iter
;
1194 } else if (stream_iter
->current_msg_ts_ns
== youngest_candidate_msg_ts
) {
1196 * Order the messages in an arbitrary but
1197 * deterministic way.
1199 BT_ASSERT_DBG(stream_iter
!= youngest_candidate_stream_iter
);
1200 int ret
= common_muxing_compare_messages(
1201 stream_iter
->current_msg
->libObjPtr(),
1202 youngest_candidate_stream_iter
->current_msg
->libObjPtr());
1205 * The `youngest_candidate_stream_iter->current_msg`
1206 * should go first. Update the next
1207 * iterator and the current timestamp.
1209 youngest_candidate_msg_ts
= stream_iter
->current_msg_ts_ns
;
1210 youngest_candidate_stream_iter
= stream_iter
;
1211 } else if (ret
== 0) {
1213 * Unable to pick which one should go
1217 lttng_live_msg_iter
->logger
,
1218 "Cannot deterministically pick next live stream message iterator because they have identical next messages: "
1219 "stream-iter-addr={}"
1220 "stream-iter-addr={}",
1221 fmt::ptr(stream_iter
), fmt::ptr(youngest_candidate_stream_iter
));
1228 * The live stream iterator has ended. That
1229 * iterator is removed from the array, but
1230 * there is no need to increment
1231 * stream_iter_idx as
1232 * g_ptr_array_remove_index_fast replaces the
1233 * removed element with the array's last
1236 bt2c::vectorFastRemove(live_trace
->stream_iterators
, stream_iter_idx
);
1240 if (youngest_candidate_stream_iter
) {
1241 *youngest_trace_stream_iter
= youngest_candidate_stream_iter
;
1242 stream_iter_status
= LTTNG_LIVE_ITERATOR_STATUS_OK
;
1245 * The only case where we don't have a candidate for this trace
1246 * is if we reached the end of all the iterators.
1248 BT_ASSERT(live_trace
->stream_iterators
.empty());
1249 stream_iter_status
= LTTNG_LIVE_ITERATOR_STATUS_END
;
1253 return stream_iter_status
;
1256 static enum lttng_live_iterator_status
1257 next_stream_iterator_for_session(struct lttng_live_msg_iter
*lttng_live_msg_iter
,
1258 struct lttng_live_session
*session
,
1259 struct lttng_live_stream_iterator
**youngest_session_stream_iter
)
1261 enum lttng_live_iterator_status stream_iter_status
;
1262 uint64_t trace_idx
= 0;
1263 int64_t youngest_candidate_msg_ts
= INT64_MAX
;
1264 struct lttng_live_stream_iterator
*youngest_candidate_stream_iter
= NULL
;
1266 BT_CPPLOGD_SPEC(lttng_live_msg_iter
->logger
,
1267 "Finding the next stream iterator for session: "
1271 * Make sure we are attached to the session and look for new streams
1274 stream_iter_status
= lttng_live_get_session(lttng_live_msg_iter
, session
);
1275 if (stream_iter_status
!= LTTNG_LIVE_ITERATOR_STATUS_OK
&&
1276 stream_iter_status
!= LTTNG_LIVE_ITERATOR_STATUS_CONTINUE
&&
1277 stream_iter_status
!= LTTNG_LIVE_ITERATOR_STATUS_END
) {
1281 while (trace_idx
< session
->traces
.size()) {
1282 bool trace_is_ended
= false;
1283 struct lttng_live_stream_iterator
*stream_iter
;
1284 lttng_live_trace
*trace
= session
->traces
[trace_idx
].get();
1286 stream_iter_status
=
1287 next_stream_iterator_for_trace(lttng_live_msg_iter
, trace
, &stream_iter
);
1288 if (stream_iter_status
== LTTNG_LIVE_ITERATOR_STATUS_END
) {
1290 * All the live stream iterators for this trace are
1291 * ENDed. Remove the trace from this session.
1293 trace_is_ended
= true;
1294 } else if (stream_iter_status
!= LTTNG_LIVE_ITERATOR_STATUS_OK
) {
1298 if (!trace_is_ended
) {
1299 BT_ASSERT_DBG(stream_iter
);
1301 if (G_UNLIKELY(youngest_candidate_stream_iter
== NULL
) ||
1302 stream_iter
->current_msg_ts_ns
< youngest_candidate_msg_ts
) {
1303 youngest_candidate_msg_ts
= stream_iter
->current_msg_ts_ns
;
1304 youngest_candidate_stream_iter
= stream_iter
;
1305 } else if (stream_iter
->current_msg_ts_ns
== youngest_candidate_msg_ts
) {
1307 * Order the messages in an arbitrary but
1308 * deterministic way.
1310 int ret
= common_muxing_compare_messages(
1311 stream_iter
->current_msg
->libObjPtr(),
1312 youngest_candidate_stream_iter
->current_msg
->libObjPtr());
1315 * The `youngest_candidate_stream_iter->current_msg`
1316 * should go first. Update the next iterator
1317 * and the current timestamp.
1319 youngest_candidate_msg_ts
= stream_iter
->current_msg_ts_ns
;
1320 youngest_candidate_stream_iter
= stream_iter
;
1321 } else if (ret
== 0) {
1322 /* Unable to pick which one should go first. */
1324 lttng_live_msg_iter
->logger
,
1325 "Cannot deterministically pick next live stream message iterator because they have identical next messages: "
1326 "stream-iter-addr={}"
1327 "youngest-candidate-stream-iter-addr={}",
1328 fmt::ptr(stream_iter
), fmt::ptr(youngest_candidate_stream_iter
));
1334 * trace_idx is not incremented since
1335 * vectorFastRemove replaces the
1336 * element at trace_idx with the array's last element.
1338 bt2c::vectorFastRemove(session
->traces
, trace_idx
);
1341 if (youngest_candidate_stream_iter
) {
1342 *youngest_session_stream_iter
= youngest_candidate_stream_iter
;
1343 stream_iter_status
= LTTNG_LIVE_ITERATOR_STATUS_OK
;
1346 * The only cases where we don't have a candidate for this
1348 * 1. if we reached the end of all the iterators of all the
1349 * traces of this session,
1350 * 2. if we never had live stream iterator in the first place.
1352 * In either cases, we return END.
1354 BT_ASSERT(session
->traces
.empty());
1355 stream_iter_status
= LTTNG_LIVE_ITERATOR_STATUS_END
;
1358 return stream_iter_status
;
1361 static inline void put_messages(bt_message_array_const msgs
, uint64_t count
)
1365 for (i
= 0; i
< count
; i
++) {
1366 BT_MESSAGE_PUT_REF_AND_RESET(msgs
[i
]);
1370 bt_message_iterator_class_next_method_status
1371 lttng_live_msg_iter_next(bt_self_message_iterator
*self_msg_it
, bt_message_array_const msgs
,
1372 uint64_t capacity
, uint64_t *count
)
1375 bt_message_iterator_class_next_method_status status
;
1376 enum lttng_live_viewer_status viewer_status
;
1377 struct lttng_live_msg_iter
*lttng_live_msg_iter
=
1378 (struct lttng_live_msg_iter
*) bt_self_message_iterator_get_data(self_msg_it
);
1379 struct lttng_live_component
*lttng_live
= lttng_live_msg_iter
->lttng_live_comp
;
1380 enum lttng_live_iterator_status stream_iter_status
;
1381 uint64_t session_idx
;
1385 BT_ASSERT_DBG(lttng_live_msg_iter
);
1387 if (G_UNLIKELY(lttng_live_msg_iter
->was_interrupted
)) {
1389 * The iterator was interrupted in a previous call to the
1390 * `_next()` method. We currently do not support generating
1391 * messages after such event. The babeltrace2 CLI should never
1392 * be running the graph after being interrupted. So this check
1393 * is to prevent other graph users from using this live
1394 * iterator in an messed up internal state.
1396 status
= BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_ERROR
;
1397 BT_CPPLOGE_APPEND_CAUSE_SPEC(
1398 lttng_live_msg_iter
->logger
,
1399 "Message iterator was interrupted during a previous call to the `next()` and currently does not support continuing after such event.");
1404 * Clear all the invalid message reference that might be left over in
1407 memset(msgs
, 0, capacity
* sizeof(*msgs
));
1410 * If no session are exposed on the relay found at the url provided by
1411 * the user, session count will be 0. In this case, we return status
1412 * end to return gracefully.
1414 if (lttng_live_msg_iter
->sessions
->len
== 0) {
1415 if (lttng_live
->params
.sess_not_found_act
!= SESSION_NOT_FOUND_ACTION_CONTINUE
) {
1416 status
= BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_END
;
1420 * The are no more active session for this session
1421 * name. Retry to create a viewer session for the
1422 * requested session name.
1424 viewer_status
= lttng_live_create_viewer_session(lttng_live_msg_iter
);
1425 if (viewer_status
!= LTTNG_LIVE_VIEWER_STATUS_OK
) {
1426 if (viewer_status
== LTTNG_LIVE_VIEWER_STATUS_ERROR
) {
1427 status
= BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_ERROR
;
1428 BT_CPPLOGE_APPEND_CAUSE_SPEC(lttng_live_msg_iter
->logger
,
1429 "Error creating LTTng live viewer session");
1430 } else if (viewer_status
== LTTNG_LIVE_VIEWER_STATUS_INTERRUPTED
) {
1431 status
= BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_AGAIN
;
1440 if (lttng_live_msg_iter
->active_stream_iter
== 0) {
1441 lttng_live_force_new_streams_and_metadata(lttng_live_msg_iter
);
1445 * Here the muxing of message is done.
1447 * We need to iterate over all the streams of all the traces of all the
1448 * viewer sessions in order to get the message with the smallest
1449 * timestamp. In this case, a session is a viewer session and there is
1450 * one viewer session per consumer daemon. (UST 32bit, UST 64bit and/or
1451 * kernel). Each viewer session can have multiple traces, for example,
1452 * 64bit UST viewer sessions could have multiple per-pid traces.
1454 * We iterate over the streams of each traces to update and see what is
1455 * their next message's timestamp. From those timestamps, we select the
1456 * message with the smallest timestamp as the best candidate message
1457 * for that trace and do the same thing across all the sessions.
1459 * We then compare the timestamp of best candidate message of all the
1460 * sessions to pick the message with the smallest timestamp and we
1463 while (*count
< capacity
) {
1464 struct lttng_live_stream_iterator
*youngest_stream_iter
= NULL
,
1465 *candidate_stream_iter
= NULL
;
1466 int64_t youngest_msg_ts_ns
= INT64_MAX
;
1468 BT_ASSERT_DBG(lttng_live_msg_iter
->sessions
);
1470 while (session_idx
< lttng_live_msg_iter
->sessions
->len
) {
1471 struct lttng_live_session
*session
= (lttng_live_session
*) g_ptr_array_index(
1472 lttng_live_msg_iter
->sessions
, session_idx
);
1474 /* Find the best candidate message to send downstream. */
1475 stream_iter_status
= next_stream_iterator_for_session(lttng_live_msg_iter
, session
,
1476 &candidate_stream_iter
);
1478 /* If we receive an END status, it means that either:
1479 * - Those traces never had active streams (UST with no
1480 * data produced yet),
1481 * - All live stream iterators have ENDed.
1483 if (stream_iter_status
== LTTNG_LIVE_ITERATOR_STATUS_END
) {
1484 if (session
->closed
&& session
->traces
.empty()) {
1486 * Remove the session from the list.
1487 * session_idx is not modified since
1488 * g_ptr_array_remove_index_fast
1489 * replaces the the removed element with
1490 * the array's last element.
1492 g_ptr_array_remove_index_fast(lttng_live_msg_iter
->sessions
, session_idx
);
1499 if (stream_iter_status
!= LTTNG_LIVE_ITERATOR_STATUS_OK
) {
1503 if (G_UNLIKELY(youngest_stream_iter
== NULL
) ||
1504 candidate_stream_iter
->current_msg_ts_ns
< youngest_msg_ts_ns
) {
1505 youngest_msg_ts_ns
= candidate_stream_iter
->current_msg_ts_ns
;
1506 youngest_stream_iter
= candidate_stream_iter
;
1507 } else if (candidate_stream_iter
->current_msg_ts_ns
== youngest_msg_ts_ns
) {
1509 * The currently selected message to be sent
1510 * downstream next has the exact same timestamp
1511 * that of the current candidate message. We
1512 * must break the tie in a predictable manner.
1514 BT_CPPLOGD_STR_SPEC(
1515 lttng_live_msg_iter
->logger
,
1516 "Two of the next message candidates have the same timestamps, pick one deterministically.");
1518 * Order the messages in an arbitrary but
1519 * deterministic way.
1521 int ret
= common_muxing_compare_messages(
1522 candidate_stream_iter
->current_msg
->libObjPtr(),
1523 youngest_stream_iter
->current_msg
->libObjPtr());
1526 * The `candidate_stream_iter->current_msg`
1527 * should go first. Update the next
1528 * iterator and the current timestamp.
1530 youngest_msg_ts_ns
= candidate_stream_iter
->current_msg_ts_ns
;
1531 youngest_stream_iter
= candidate_stream_iter
;
1532 } else if (ret
== 0) {
1533 /* Unable to pick which one should go first. */
1535 lttng_live_msg_iter
->logger
,
1536 "Cannot deterministically pick next live stream message iterator because they have identical next messages: "
1537 "next-stream-iter-addr={}"
1538 "candidate-stream-iter-addr={}",
1539 fmt::ptr(youngest_stream_iter
), fmt::ptr(candidate_stream_iter
));
1546 if (!youngest_stream_iter
) {
1547 stream_iter_status
= LTTNG_LIVE_ITERATOR_STATUS_AGAIN
;
1551 BT_ASSERT_DBG(youngest_stream_iter
->current_msg
);
1552 /* Ensure monotonicity. */
1553 BT_ASSERT_DBG(lttng_live_msg_iter
->last_msg_ts_ns
<=
1554 youngest_stream_iter
->current_msg_ts_ns
);
1557 * Insert the next message to the message batch. This will set
1558 * stream iterator current message to NULL so that next time
1559 * we fetch the next message of that stream iterator
1561 msgs
[*count
] = youngest_stream_iter
->current_msg
.release().libObjPtr();
1564 /* Update the last timestamp in nanoseconds sent downstream. */
1565 lttng_live_msg_iter
->last_msg_ts_ns
= youngest_msg_ts_ns
;
1566 youngest_stream_iter
->current_msg_ts_ns
= INT64_MAX
;
1568 stream_iter_status
= LTTNG_LIVE_ITERATOR_STATUS_OK
;
1572 switch (stream_iter_status
) {
1573 case LTTNG_LIVE_ITERATOR_STATUS_OK
:
1574 case LTTNG_LIVE_ITERATOR_STATUS_AGAIN
:
1576 * If we gathered messages, return _OK even if the graph was
1577 * interrupted. This allows for the components downstream to at
1578 * least get the those messages. If the graph was indeed
1579 * interrupted there should not be another _next() call as the
1580 * application will tear down the graph. This component class
1581 * doesn't support restarting after an interruption.
1584 status
= BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_OK
;
1586 status
= BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_AGAIN
;
1589 case LTTNG_LIVE_ITERATOR_STATUS_END
:
1590 status
= BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_END
;
1592 case LTTNG_LIVE_ITERATOR_STATUS_NOMEM
:
1593 BT_CPPLOGE_APPEND_CAUSE_SPEC(lttng_live_msg_iter
->logger
,
1594 "Memory error preparing the next batch of messages: "
1595 "live-iter-status={}",
1596 stream_iter_status
);
1597 status
= BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_MEMORY_ERROR
;
1599 case LTTNG_LIVE_ITERATOR_STATUS_ERROR
:
1600 case LTTNG_LIVE_ITERATOR_STATUS_INVAL
:
1601 case LTTNG_LIVE_ITERATOR_STATUS_UNSUPPORTED
:
1602 BT_CPPLOGE_APPEND_CAUSE_SPEC(lttng_live_msg_iter
->logger
,
1603 "Error preparing the next batch of messages: "
1604 "live-iter-status={}",
1605 stream_iter_status
);
1607 status
= BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_ERROR
;
1608 /* Put all existing messages on error. */
1609 put_messages(msgs
, *count
);
1617 } catch (const std::bad_alloc
&) {
1618 return BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_MEMORY_ERROR
;
1619 } catch (const bt2::Error
&) {
1620 return BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_ERROR
;
1624 static struct lttng_live_msg_iter
*
1625 lttng_live_msg_iter_create(struct lttng_live_component
*lttng_live_comp
,
1626 bt_self_message_iterator
*self_msg_it
)
1628 lttng_live_msg_iter
*msg_iter
= new lttng_live_msg_iter
{lttng_live_comp
->logger
};
1629 msg_iter
->self_comp
= lttng_live_comp
->self_comp
;
1630 msg_iter
->lttng_live_comp
= lttng_live_comp
;
1631 msg_iter
->self_msg_iter
= self_msg_it
;
1633 msg_iter
->active_stream_iter
= 0;
1634 msg_iter
->last_msg_ts_ns
= INT64_MIN
;
1635 msg_iter
->was_interrupted
= false;
1637 msg_iter
->sessions
=
1638 g_ptr_array_new_with_free_func((GDestroyNotify
) lttng_live_destroy_session
);
1639 BT_ASSERT(msg_iter
->sessions
);
1644 bt_message_iterator_class_initialize_method_status
1645 lttng_live_msg_iter_init(bt_self_message_iterator
*self_msg_it
,
1646 bt_self_message_iterator_configuration
*, bt_self_component_port_output
*)
1649 bt_message_iterator_class_initialize_method_status status
;
1650 struct lttng_live_component
*lttng_live
;
1651 struct lttng_live_msg_iter
*lttng_live_msg_iter
;
1652 enum lttng_live_viewer_status viewer_status
;
1653 bt_self_component
*self_comp
= bt_self_message_iterator_borrow_component(self_msg_it
);
1655 lttng_live
= (lttng_live_component
*) bt_self_component_get_data(self_comp
);
1657 /* There can be only one downstream iterator at the same time. */
1658 BT_ASSERT(!lttng_live
->has_msg_iter
);
1659 lttng_live
->has_msg_iter
= true;
1661 lttng_live_msg_iter
= lttng_live_msg_iter_create(lttng_live
, self_msg_it
);
1662 if (!lttng_live_msg_iter
) {
1663 BT_CPPLOGE_APPEND_CAUSE_SPEC(lttng_live
->logger
,
1664 "Failed to create lttng_live_msg_iter");
1665 status
= BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_MEMORY_ERROR
;
1669 viewer_status
= live_viewer_connection_create(
1670 lttng_live
->params
.url
.c_str(), false, lttng_live_msg_iter
, lttng_live_msg_iter
->logger
,
1671 <tng_live_msg_iter
->viewer_connection
);
1672 if (viewer_status
!= LTTNG_LIVE_VIEWER_STATUS_OK
) {
1673 if (viewer_status
== LTTNG_LIVE_VIEWER_STATUS_ERROR
) {
1674 BT_CPPLOGE_APPEND_CAUSE_SPEC(lttng_live_msg_iter
->logger
,
1675 "Failed to create viewer connection");
1676 } else if (viewer_status
== LTTNG_LIVE_VIEWER_STATUS_INTERRUPTED
) {
1678 * Interruption in the _iter_init() method is not
1679 * supported. Return an error.
1681 BT_CPPLOGE_APPEND_CAUSE_SPEC(lttng_live_msg_iter
->logger
,
1682 "Interrupted while creating viewer connection");
1685 status
= BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_ERROR
;
1689 viewer_status
= lttng_live_create_viewer_session(lttng_live_msg_iter
);
1690 if (viewer_status
!= LTTNG_LIVE_VIEWER_STATUS_OK
) {
1691 if (viewer_status
== LTTNG_LIVE_VIEWER_STATUS_ERROR
) {
1692 BT_CPPLOGE_APPEND_CAUSE_SPEC(lttng_live_msg_iter
->logger
,
1693 "Failed to create viewer session");
1694 } else if (viewer_status
== LTTNG_LIVE_VIEWER_STATUS_INTERRUPTED
) {
1696 * Interruption in the _iter_init() method is not
1697 * supported. Return an error.
1699 BT_CPPLOGE_APPEND_CAUSE_SPEC(lttng_live_msg_iter
->logger
,
1700 "Interrupted when creating viewer session");
1703 status
= BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_ERROR
;
1707 if (lttng_live_msg_iter
->sessions
->len
== 0) {
1708 switch (lttng_live
->params
.sess_not_found_act
) {
1709 case SESSION_NOT_FOUND_ACTION_CONTINUE
:
1711 lttng_live_msg_iter
->logger
,
1712 "Unable to connect to the requested live viewer session. "
1713 "Keep trying to connect because of {}=\"{}\" component parameter: url=\"{}\"",
1714 SESS_NOT_FOUND_ACTION_PARAM
, SESS_NOT_FOUND_ACTION_CONTINUE_STR
,
1715 lttng_live
->params
.url
);
1717 case SESSION_NOT_FOUND_ACTION_FAIL
:
1718 BT_CPPLOGE_APPEND_CAUSE_SPEC(
1719 lttng_live_msg_iter
->logger
,
1720 "Unable to connect to the requested live viewer session. "
1721 "Fail the message iterator initialization because of {}=\"{}\" "
1722 "component parameter: url =\"{}\"",
1723 SESS_NOT_FOUND_ACTION_PARAM
, SESS_NOT_FOUND_ACTION_FAIL_STR
,
1724 lttng_live
->params
.url
);
1725 status
= BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_ERROR
;
1727 case SESSION_NOT_FOUND_ACTION_END
:
1728 BT_CPPLOGI_SPEC(lttng_live_msg_iter
->logger
,
1729 "Unable to connect to the requested live viewer session. "
1730 "End gracefully at the first _next() call because of {}=\"{}\""
1731 " component parameter: url=\"{}\"",
1732 SESS_NOT_FOUND_ACTION_PARAM
, SESS_NOT_FOUND_ACTION_END_STR
,
1733 lttng_live
->params
.url
);
1740 bt_self_message_iterator_set_data(self_msg_it
, lttng_live_msg_iter
);
1741 status
= BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_OK
;
1745 lttng_live_msg_iter_destroy(lttng_live_msg_iter
);
1748 } catch (const std::bad_alloc
&) {
1749 return BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_MEMORY_ERROR
;
1750 } catch (const bt2::Error
&) {
1751 return BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_ERROR
;
1755 static struct bt_param_validation_map_value_entry_descr list_sessions_params
[] = {
1756 {URL_PARAM
, BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_MANDATORY
,
1757 bt_param_validation_value_descr::makeString()},
1758 BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_END
};
1760 static bt_component_class_query_method_status
1761 lttng_live_query_list_sessions(const bt_value
*params
, const bt_value
**result
,
1762 const bt2c::Logger
& logger
)
1764 bt_component_class_query_method_status status
;
1765 const bt_value
*url_value
= NULL
;
1767 struct live_viewer_connection
*viewer_connection
= NULL
;
1768 enum lttng_live_viewer_status viewer_status
;
1769 enum bt_param_validation_status validation_status
;
1770 gchar
*validate_error
= NULL
;
1772 validation_status
= bt_param_validation_validate(params
, list_sessions_params
, &validate_error
);
1773 if (validation_status
== BT_PARAM_VALIDATION_STATUS_MEMORY_ERROR
) {
1774 status
= BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_MEMORY_ERROR
;
1776 } else if (validation_status
== BT_PARAM_VALIDATION_STATUS_VALIDATION_ERROR
) {
1777 status
= BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_ERROR
;
1778 BT_CPPLOGE_APPEND_CAUSE_SPEC(logger
, "{}", validate_error
);
1782 url_value
= bt_value_map_borrow_entry_value_const(params
, URL_PARAM
);
1783 url
= bt_value_string_get(url_value
);
1785 viewer_status
= live_viewer_connection_create(url
, true, NULL
, logger
, &viewer_connection
);
1786 if (viewer_status
!= LTTNG_LIVE_VIEWER_STATUS_OK
) {
1787 if (viewer_status
== LTTNG_LIVE_VIEWER_STATUS_ERROR
) {
1788 BT_CPPLOGE_APPEND_CAUSE_SPEC(logger
, "Failed to create viewer connection");
1789 status
= BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_ERROR
;
1790 } else if (viewer_status
== LTTNG_LIVE_VIEWER_STATUS_INTERRUPTED
) {
1791 status
= BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_AGAIN
;
1798 status
= live_viewer_connection_list_sessions(viewer_connection
, result
);
1799 if (status
!= BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_OK
) {
1800 BT_CPPLOGE_APPEND_CAUSE_SPEC(logger
, "Failed to list viewer sessions");
1807 BT_VALUE_PUT_REF_AND_RESET(*result
);
1810 status
= BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_ERROR
;
1814 if (viewer_connection
) {
1815 live_viewer_connection_destroy(viewer_connection
);
1818 g_free(validate_error
);
1823 static bt_component_class_query_method_status
1824 lttng_live_query_support_info(const bt_value
*params
, const bt_value
**result
,
1825 const bt2c::Logger
& logger
)
1827 bt_component_class_query_method_status status
= BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_OK
;
1828 const bt_value
*input_type_value
;
1829 const bt_value
*input_value
;
1831 struct bt_common_lttng_live_url_parts parts
= {};
1833 /* Used by the logging macros */
1834 __attribute__((unused
)) bt_self_component
*self_comp
= NULL
;
1837 input_type_value
= bt_value_map_borrow_entry_value_const(params
, "type");
1838 if (!input_type_value
) {
1839 BT_CPPLOGE_APPEND_CAUSE_SPEC(logger
, "Missing expected `type` parameter.");
1843 if (!bt_value_is_string(input_type_value
)) {
1844 BT_CPPLOGE_APPEND_CAUSE_SPEC(logger
, "`type` parameter is not a string value.");
1848 if (strcmp(bt_value_string_get(input_type_value
), "string") != 0) {
1849 /* We don't handle file system paths */
1853 input_value
= bt_value_map_borrow_entry_value_const(params
, "input");
1855 BT_CPPLOGE_APPEND_CAUSE_SPEC(logger
, "Missing expected `input` parameter.");
1859 if (!bt_value_is_string(input_value
)) {
1860 BT_CPPLOGE_APPEND_CAUSE_SPEC(logger
, "`input` parameter is not a string value.");
1864 parts
= bt_common_parse_lttng_live_url(bt_value_string_get(input_value
), NULL
, 0);
1865 if (parts
.session_name
) {
1867 * Looks pretty much like an LTTng live URL: we got the
1868 * session name part, which forms a complete URL.
1874 *result
= bt_value_real_create_init(weight
);
1876 status
= BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_MEMORY_ERROR
;
1884 status
= BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_ERROR
;
1887 BT_ASSERT(!*result
);
1890 bt_common_destroy_lttng_live_url_parts(&parts
);
1894 bt_component_class_query_method_status
lttng_live_query(bt_self_component_class_source
*comp_class
,
1895 bt_private_query_executor
*priv_query_exec
,
1896 const char *object
, const bt_value
*params
,
1897 __attribute__((unused
)) void *method_data
,
1898 const bt_value
**result
)
1901 bt_component_class_query_method_status status
= BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_OK
;
1902 bt2c::Logger logger
{bt2::SelfComponentClass
{comp_class
},
1903 bt2::PrivateQueryExecutor
{priv_query_exec
},
1904 "PLUGIN/SRC.CTF.LTTNG-LIVE/QUERY"};
1906 if (strcmp(object
, "sessions") == 0) {
1907 status
= lttng_live_query_list_sessions(params
, result
, logger
);
1908 } else if (strcmp(object
, "babeltrace.support-info") == 0) {
1909 status
= lttng_live_query_support_info(params
, result
, logger
);
1911 BT_CPPLOGI_SPEC(logger
, "Unknown query object `{}`", object
);
1912 status
= BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_UNKNOWN_OBJECT
;
1918 } catch (const std::bad_alloc
&) {
1919 return BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_MEMORY_ERROR
;
1920 } catch (const bt2::Error
&) {
1921 return BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_ERROR
;
1925 void lttng_live_component_finalize(bt_self_component_source
*component
)
1927 lttng_live_component::UP
{static_cast<lttng_live_component
*>(
1928 bt_self_component_get_data(bt_self_component_source_as_self_component(component
)))};
1931 static enum session_not_found_action
1932 parse_session_not_found_action_param(const bt_value
*no_session_param
)
1934 enum session_not_found_action action
;
1935 const char *no_session_act_str
= bt_value_string_get(no_session_param
);
1937 if (strcmp(no_session_act_str
, SESS_NOT_FOUND_ACTION_CONTINUE_STR
) == 0) {
1938 action
= SESSION_NOT_FOUND_ACTION_CONTINUE
;
1939 } else if (strcmp(no_session_act_str
, SESS_NOT_FOUND_ACTION_FAIL_STR
) == 0) {
1940 action
= SESSION_NOT_FOUND_ACTION_FAIL
;
1942 BT_ASSERT(strcmp(no_session_act_str
, SESS_NOT_FOUND_ACTION_END_STR
) == 0);
1943 action
= SESSION_NOT_FOUND_ACTION_END
;
1949 static bt_param_validation_value_descr inputs_elem_descr
=
1950 bt_param_validation_value_descr::makeString();
1952 static const char *sess_not_found_action_choices
[] = {
1953 SESS_NOT_FOUND_ACTION_CONTINUE_STR
,
1954 SESS_NOT_FOUND_ACTION_FAIL_STR
,
1955 SESS_NOT_FOUND_ACTION_END_STR
,
1958 static struct bt_param_validation_map_value_entry_descr params_descr
[] = {
1959 {INPUTS_PARAM
, BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_MANDATORY
,
1960 bt_param_validation_value_descr::makeArray(1, 1, inputs_elem_descr
)},
1961 {SESS_NOT_FOUND_ACTION_PARAM
, BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL
,
1962 bt_param_validation_value_descr::makeString(sess_not_found_action_choices
)},
1963 BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_END
};
1965 static bt_component_class_initialize_method_status
1966 lttng_live_component_create(const bt_value
*params
, bt_self_component_source
*self_comp
,
1967 lttng_live_component::UP
& component
)
1969 const bt_value
*inputs_value
;
1970 const bt_value
*url_value
;
1971 const bt_value
*value
;
1972 enum bt_param_validation_status validation_status
;
1973 gchar
*validation_error
= NULL
;
1974 bt2c::Logger logger
{bt2::SelfSourceComponent
{self_comp
}, "PLUGIN/SRC.CTF.LTTNG-LIVE/COMP"};
1976 validation_status
= bt_param_validation_validate(params
, params_descr
, &validation_error
);
1977 if (validation_status
== BT_PARAM_VALIDATION_STATUS_MEMORY_ERROR
) {
1978 return BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_MEMORY_ERROR
;
1979 } else if (validation_status
== BT_PARAM_VALIDATION_STATUS_VALIDATION_ERROR
) {
1980 bt2c::GCharUP errorFreer
{validation_error
};
1981 BT_CPPLOGE_APPEND_CAUSE_SPEC(logger
, "{}", validation_error
);
1982 return BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_ERROR
;
1985 auto lttng_live
= bt2s::make_unique
<lttng_live_component
>(std::move(logger
));
1986 lttng_live
->self_comp
= bt_self_component_source_as_self_component(self_comp
);
1987 lttng_live
->max_query_size
= MAX_QUERY_SIZE
;
1988 lttng_live
->has_msg_iter
= false;
1990 inputs_value
= bt_value_map_borrow_entry_value_const(params
, INPUTS_PARAM
);
1991 url_value
= bt_value_array_borrow_element_by_index_const(inputs_value
, 0);
1992 lttng_live
->params
.url
= bt_value_string_get(url_value
);
1994 value
= bt_value_map_borrow_entry_value_const(params
, SESS_NOT_FOUND_ACTION_PARAM
);
1996 lttng_live
->params
.sess_not_found_act
= parse_session_not_found_action_param(value
);
1998 BT_CPPLOGI_SPEC(lttng_live
->logger
,
1999 "Optional `{}` parameter is missing: defaulting to `{}`.",
2000 SESS_NOT_FOUND_ACTION_PARAM
, SESS_NOT_FOUND_ACTION_CONTINUE_STR
);
2001 lttng_live
->params
.sess_not_found_act
= SESSION_NOT_FOUND_ACTION_CONTINUE
;
2004 component
= std::move(lttng_live
);
2005 return BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_OK
;
2008 bt_component_class_initialize_method_status
2009 lttng_live_component_init(bt_self_component_source
*self_comp_src
,
2010 bt_self_component_source_configuration
*, const bt_value
*params
, void *)
2013 lttng_live_component::UP lttng_live
;
2014 bt_component_class_initialize_method_status ret
;
2015 bt_self_component
*self_comp
= bt_self_component_source_as_self_component(self_comp_src
);
2016 bt_self_component_add_port_status add_port_status
;
2018 ret
= lttng_live_component_create(params
, self_comp_src
, lttng_live
);
2019 if (ret
!= BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_OK
) {
2024 bt_self_component_source_add_output_port(self_comp_src
, "out", NULL
, NULL
);
2025 if (add_port_status
!= BT_SELF_COMPONENT_ADD_PORT_STATUS_OK
) {
2026 ret
= (bt_component_class_initialize_method_status
) add_port_status
;
2030 bt_self_component_set_data(self_comp
, lttng_live
.release());
2032 return BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_OK
;
2033 } catch (const std::bad_alloc
&) {
2034 return BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_MEMORY_ERROR
;
2035 } catch (const bt2::Error
&) {
2036 return BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_ERROR
;