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 auto session
= bt2s::make_unique
<lttng_live_session
>(lttng_live_msg_iter
->logger
);
130 session
->self_comp
= lttng_live_msg_iter
->self_comp
;
131 session
->id
= session_id
;
132 session
->lttng_live_msg_iter
= lttng_live_msg_iter
;
133 session
->new_streams_needed
= true;
134 session
->hostname
= hostname
;
135 session
->session_name
= session_name
;
137 lttng_live_msg_iter
->sessions
.emplace_back(std::move(session
));
142 lttng_live_session::~lttng_live_session()
144 BT_CPPLOGD_SPEC(this->logger
, "Destroying live session: session-id={}, session-name=\"{}\"",
145 this->id
, this->session_name
);
147 if (this->id
!= -1ULL) {
148 if (lttng_live_session_detach(this)) {
149 if (!lttng_live_graph_is_canceled(this->lttng_live_msg_iter
)) {
150 /* Old relayd cannot detach sessions. */
151 BT_CPPLOGD_SPEC(this->logger
, "Unable to detach lttng live session {}", this->id
);
159 lttng_live_msg_iter::~lttng_live_msg_iter()
161 BT_ASSERT(this->lttng_live_comp
);
162 BT_ASSERT(this->lttng_live_comp
->has_msg_iter
);
164 /* All stream iterators must be destroyed at this point. */
165 BT_ASSERT(this->active_stream_iter
== 0);
166 this->lttng_live_comp
->has_msg_iter
= false;
169 void lttng_live_msg_iter_finalize(bt_self_message_iterator
*self_msg_iter
)
171 lttng_live_msg_iter::UP
{
172 static_cast<lttng_live_msg_iter
*>(bt_self_message_iterator_get_data(self_msg_iter
))};
175 static enum lttng_live_iterator_status
176 lttng_live_iterator_next_check_stream_state(struct lttng_live_stream_iterator
*lttng_live_stream
)
178 switch (lttng_live_stream
->state
) {
179 case LTTNG_LIVE_STREAM_QUIESCENT
:
180 case LTTNG_LIVE_STREAM_ACTIVE_DATA
:
182 case LTTNG_LIVE_STREAM_ACTIVE_NO_DATA
:
184 BT_CPPLOGF_SPEC(lttng_live_stream
->logger
, "Unexpected stream state \"ACTIVE_NO_DATA\"");
186 case LTTNG_LIVE_STREAM_QUIESCENT_NO_DATA
:
188 BT_CPPLOGF_SPEC(lttng_live_stream
->logger
, "Unexpected stream state \"QUIESCENT_NO_DATA\"");
190 case LTTNG_LIVE_STREAM_EOF
:
193 return LTTNG_LIVE_ITERATOR_STATUS_OK
;
197 * For active no data stream, fetch next index. As a result of that it can
199 * - quiescent: won't have events for a bit,
200 * - have data: need to get that data and produce the event,
201 * - have no data on this stream at this point: need to retry (AGAIN) or return
204 static enum lttng_live_iterator_status
lttng_live_iterator_next_handle_one_no_data_stream(
205 struct lttng_live_msg_iter
*lttng_live_msg_iter
,
206 struct lttng_live_stream_iterator
*lttng_live_stream
)
208 enum lttng_live_iterator_status ret
= LTTNG_LIVE_ITERATOR_STATUS_OK
;
209 enum lttng_live_stream_state orig_state
= lttng_live_stream
->state
;
210 struct packet_index index
;
212 if (lttng_live_stream
->trace
->metadata_stream_state
==
213 LTTNG_LIVE_METADATA_STREAM_STATE_NEEDED
) {
214 BT_CPPLOGD_SPEC(lttng_live_msg_iter
->logger
,
215 "Need to get an update for the metadata stream before proceeding "
216 "further with this stream: stream-name=\"{}\"",
217 lttng_live_stream
->name
);
218 ret
= LTTNG_LIVE_ITERATOR_STATUS_CONTINUE
;
222 if (lttng_live_stream
->trace
->session
->new_streams_needed
) {
223 BT_CPPLOGD_SPEC(lttng_live_msg_iter
->logger
,
224 "Need to get an update of all streams before proceeding further "
225 "with this stream: stream-name=\"{}\"",
226 lttng_live_stream
->name
);
227 ret
= LTTNG_LIVE_ITERATOR_STATUS_CONTINUE
;
231 if (lttng_live_stream
->state
!= LTTNG_LIVE_STREAM_ACTIVE_NO_DATA
&&
232 lttng_live_stream
->state
!= LTTNG_LIVE_STREAM_QUIESCENT_NO_DATA
) {
235 ret
= lttng_live_get_next_index(lttng_live_msg_iter
, lttng_live_stream
, &index
);
236 if (ret
!= LTTNG_LIVE_ITERATOR_STATUS_OK
) {
240 BT_ASSERT_DBG(lttng_live_stream
->state
!= LTTNG_LIVE_STREAM_EOF
);
242 if (lttng_live_stream
->state
== LTTNG_LIVE_STREAM_QUIESCENT
) {
243 uint64_t last_inact_ts
= lttng_live_stream
->last_inactivity_ts
.value
,
244 curr_inact_ts
= lttng_live_stream
->current_inactivity_ts
;
246 if (orig_state
== LTTNG_LIVE_STREAM_QUIESCENT_NO_DATA
&& last_inact_ts
== curr_inact_ts
) {
248 * Because the stream is in the QUIESCENT_NO_DATA
249 * state, we can assert that the last_inactivity_ts was
250 * set and can be safely used in the `if` above.
252 BT_ASSERT(lttng_live_stream
->last_inactivity_ts
.is_set
);
254 ret
= LTTNG_LIVE_ITERATOR_STATUS_AGAIN
;
255 LTTNG_LIVE_LOGD_STREAM_ITER(lttng_live_stream
);
257 ret
= LTTNG_LIVE_ITERATOR_STATUS_CONTINUE
;
262 lttng_live_stream
->base_offset
= index
.offset
;
263 lttng_live_stream
->offset
= index
.offset
;
264 lttng_live_stream
->len
= index
.packet_size
/ CHAR_BIT
;
266 BT_CPPLOGD_SPEC(lttng_live_msg_iter
->logger
,
267 "Setting live stream reading info: stream-name=\"{}\", "
268 "viewer-stream-id={}, stream-base-offset={}, stream-offset={}, stream-len={}",
269 lttng_live_stream
->name
, lttng_live_stream
->viewer_stream_id
,
270 lttng_live_stream
->base_offset
, lttng_live_stream
->offset
,
271 lttng_live_stream
->len
);
274 if (ret
== LTTNG_LIVE_ITERATOR_STATUS_OK
) {
275 ret
= lttng_live_iterator_next_check_stream_state(lttng_live_stream
);
281 * Creation of the message requires the ctf trace class to be created
282 * beforehand, but the live protocol gives us all streams (including metadata)
283 * at once. So we split it in three steps: getting streams, getting metadata
284 * (which creates the ctf trace class), and then creating the per-stream
287 static enum lttng_live_iterator_status
288 lttng_live_get_session(struct lttng_live_msg_iter
*lttng_live_msg_iter
,
289 struct lttng_live_session
*session
)
291 enum lttng_live_iterator_status status
;
293 if (!session
->attached
) {
294 BT_CPPLOGD_SPEC(lttng_live_msg_iter
->logger
, "Attach to session: session-id={}",
296 enum lttng_live_viewer_status attach_status
=
297 lttng_live_session_attach(session
, lttng_live_msg_iter
->self_msg_iter
);
298 if (attach_status
!= LTTNG_LIVE_VIEWER_STATUS_OK
) {
299 if (lttng_live_graph_is_canceled(lttng_live_msg_iter
)) {
301 * Clear any causes appended in
302 * `lttng_live_attach_session()` as we want to
303 * return gracefully since the graph was
306 bt_current_thread_clear_error();
307 status
= LTTNG_LIVE_ITERATOR_STATUS_AGAIN
;
309 status
= LTTNG_LIVE_ITERATOR_STATUS_ERROR
;
310 BT_CPPLOGE_APPEND_CAUSE_SPEC(lttng_live_msg_iter
->logger
,
311 "Error attaching to LTTng live session");
317 BT_CPPLOGD_SPEC(lttng_live_msg_iter
->logger
,
318 "Updating all data streams: session-id={}, session-name=\"{}\"", session
->id
,
319 session
->session_name
);
321 status
= lttng_live_session_get_new_streams(session
, lttng_live_msg_iter
->self_msg_iter
);
323 case LTTNG_LIVE_ITERATOR_STATUS_OK
:
325 case LTTNG_LIVE_ITERATOR_STATUS_END
:
327 * We received a `_END` from the `_get_new_streams()` function,
328 * which means no more data will ever be received from the data
329 * streams of this session. But it's possible that the metadata
331 * The live protocol guarantees that we receive all the
332 * metadata needed before we receive data streams needing it.
333 * But it's possible to receive metadata NOT needed by
334 * data streams after the session was closed. For example, this
335 * could happen if a new event is registered and the session is
336 * stopped before any tracepoint for that event is actually
340 lttng_live_msg_iter
->logger
,
341 "Updating streams returned _END status. Override status to _OK in order fetch any remaining metadata:"
342 "session-id={}, session-name=\"{}\"",
343 session
->id
, session
->session_name
);
344 status
= LTTNG_LIVE_ITERATOR_STATUS_OK
;
350 BT_CPPLOGD_SPEC(lttng_live_msg_iter
->logger
,
351 "Updating metadata stream for session: session-id={}, session-name=\"{}\"",
352 session
->id
, session
->session_name
);
354 for (lttng_live_trace::UP
& trace
: session
->traces
) {
355 status
= lttng_live_metadata_update(trace
.get());
357 case LTTNG_LIVE_ITERATOR_STATUS_END
:
358 case LTTNG_LIVE_ITERATOR_STATUS_OK
:
360 case LTTNG_LIVE_ITERATOR_STATUS_CONTINUE
:
361 case LTTNG_LIVE_ITERATOR_STATUS_AGAIN
:
364 BT_CPPLOGE_APPEND_CAUSE_SPEC(lttng_live_msg_iter
->logger
,
365 "Error updating trace metadata: "
366 "stream-iter-status={}, trace-id={}",
373 * Now that we have the metadata we can initialize the downstream
376 status
= lttng_live_lazy_msg_init(session
, lttng_live_msg_iter
->self_msg_iter
);
383 lttng_live_force_new_streams_and_metadata(struct lttng_live_msg_iter
*lttng_live_msg_iter
)
385 for (const auto& session
: lttng_live_msg_iter
->sessions
) {
386 BT_CPPLOGD_SPEC(lttng_live_msg_iter
->logger
,
387 "Force marking session as needing new streams: "
390 session
->new_streams_needed
= true;
391 for (lttng_live_trace::UP
& trace
: session
->traces
) {
392 BT_CPPLOGD_SPEC(lttng_live_msg_iter
->logger
,
393 "Force marking trace metadata state as needing an update: "
394 "session-id={}, trace-id={}",
395 session
->id
, trace
->id
);
397 BT_ASSERT(trace
->metadata_stream_state
!= LTTNG_LIVE_METADATA_STREAM_STATE_CLOSED
);
399 trace
->metadata_stream_state
= LTTNG_LIVE_METADATA_STREAM_STATE_NEEDED
;
404 static enum lttng_live_iterator_status
405 lttng_live_iterator_handle_new_streams_and_metadata(struct lttng_live_msg_iter
*lttng_live_msg_iter
)
407 enum lttng_live_iterator_status status
;
408 enum lttng_live_viewer_status viewer_status
;
409 uint64_t nr_sessions_opened
= 0;
410 enum session_not_found_action sess_not_found_act
=
411 lttng_live_msg_iter
->lttng_live_comp
->params
.sess_not_found_act
;
413 BT_CPPLOGD_SPEC(lttng_live_msg_iter
->logger
,
414 "Update data and metadata of all sessions: "
415 "live-msg-iter-addr={}",
416 fmt::ptr(lttng_live_msg_iter
));
418 * In a remotely distant future, we could add a "new
419 * session" flag to the protocol, which would tell us that we
420 * need to query for new sessions even though we have sessions
423 if (lttng_live_msg_iter
->sessions
.empty()) {
424 if (sess_not_found_act
!= SESSION_NOT_FOUND_ACTION_CONTINUE
) {
426 lttng_live_msg_iter
->logger
,
427 "No session found. Exiting in accordance with the `session-not-found-action` parameter");
428 status
= LTTNG_LIVE_ITERATOR_STATUS_END
;
432 lttng_live_msg_iter
->logger
,
433 "No session found. Try creating a new one in accordance with the `session-not-found-action` parameter");
435 * Retry to create a viewer session for the requested
438 viewer_status
= lttng_live_create_viewer_session(lttng_live_msg_iter
);
439 if (viewer_status
!= LTTNG_LIVE_VIEWER_STATUS_OK
) {
440 if (viewer_status
== LTTNG_LIVE_VIEWER_STATUS_ERROR
) {
441 status
= LTTNG_LIVE_ITERATOR_STATUS_ERROR
;
442 BT_CPPLOGE_APPEND_CAUSE_SPEC(lttng_live_msg_iter
->logger
,
443 "Error creating LTTng live viewer session");
444 } else if (viewer_status
== LTTNG_LIVE_VIEWER_STATUS_INTERRUPTED
) {
445 status
= LTTNG_LIVE_ITERATOR_STATUS_AGAIN
;
454 for (const auto& session
: lttng_live_msg_iter
->sessions
) {
455 status
= lttng_live_get_session(lttng_live_msg_iter
, session
.get());
457 case LTTNG_LIVE_ITERATOR_STATUS_OK
:
458 case LTTNG_LIVE_ITERATOR_STATUS_END
:
460 * A session returned `_END`. Other sessions may still
461 * be active so we override the status and continue
468 if (!session
->closed
) {
469 nr_sessions_opened
++;
473 if (sess_not_found_act
!= SESSION_NOT_FOUND_ACTION_CONTINUE
&& nr_sessions_opened
== 0) {
474 status
= LTTNG_LIVE_ITERATOR_STATUS_END
;
476 status
= LTTNG_LIVE_ITERATOR_STATUS_OK
;
483 static enum lttng_live_iterator_status
484 emit_inactivity_message(struct lttng_live_msg_iter
*lttng_live_msg_iter
,
485 struct lttng_live_stream_iterator
*stream_iter
,
486 bt2::ConstMessage::Shared
& message
, uint64_t timestamp
)
488 BT_ASSERT(stream_iter
->trace
->clock_class
);
489 BT_CPPLOGD_SPEC(lttng_live_msg_iter
->logger
,
490 "Emitting inactivity message for stream: ctf-stream-id={}, "
491 "viewer-stream-id={}, timestamp={}",
492 stream_iter
->ctf_stream_class_id
.value
, stream_iter
->viewer_stream_id
,
495 const auto msg
= bt_message_message_iterator_inactivity_create(
496 lttng_live_msg_iter
->self_msg_iter
, stream_iter
->trace
->clock_class
, timestamp
);
499 BT_CPPLOGE_APPEND_CAUSE_SPEC(lttng_live_msg_iter
->logger
,
500 "Error emitting message iterator inactivity message");
501 return LTTNG_LIVE_ITERATOR_STATUS_ERROR
;
504 message
= bt2::ConstMessage::Shared::createWithoutRef(msg
);
505 return LTTNG_LIVE_ITERATOR_STATUS_OK
;
508 static enum lttng_live_iterator_status
lttng_live_iterator_next_handle_one_quiescent_stream(
509 struct lttng_live_msg_iter
*lttng_live_msg_iter
,
510 struct lttng_live_stream_iterator
*lttng_live_stream
, bt2::ConstMessage::Shared
& message
)
512 enum lttng_live_iterator_status ret
= LTTNG_LIVE_ITERATOR_STATUS_OK
;
514 if (lttng_live_stream
->state
!= LTTNG_LIVE_STREAM_QUIESCENT
) {
515 return LTTNG_LIVE_ITERATOR_STATUS_OK
;
519 * Check if we already sent an inactivty message downstream for this
520 * `current_inactivity_ts` value.
522 if (lttng_live_stream
->last_inactivity_ts
.is_set
&&
523 lttng_live_stream
->current_inactivity_ts
== lttng_live_stream
->last_inactivity_ts
.value
) {
524 lttng_live_stream_iterator_set_state(lttng_live_stream
,
525 LTTNG_LIVE_STREAM_QUIESCENT_NO_DATA
);
527 ret
= LTTNG_LIVE_ITERATOR_STATUS_CONTINUE
;
531 ret
= emit_inactivity_message(lttng_live_msg_iter
, lttng_live_stream
, message
,
532 lttng_live_stream
->current_inactivity_ts
);
534 lttng_live_stream
->last_inactivity_ts
.value
= lttng_live_stream
->current_inactivity_ts
;
535 lttng_live_stream
->last_inactivity_ts
.is_set
= true;
540 static int live_get_msg_ts_ns(struct lttng_live_msg_iter
*lttng_live_msg_iter
,
541 const bt_message
*msg
, int64_t last_msg_ts_ns
, int64_t *ts_ns
)
543 const bt_clock_snapshot
*clock_snapshot
= NULL
;
547 BT_ASSERT_DBG(ts_ns
);
549 BT_CPPLOGD_SPEC(lttng_live_msg_iter
->logger
,
550 "Getting message's timestamp: iter-data-addr={}, msg-addr={}, "
552 fmt::ptr(lttng_live_msg_iter
), fmt::ptr(msg
), last_msg_ts_ns
);
554 switch (bt_message_get_type(msg
)) {
555 case BT_MESSAGE_TYPE_EVENT
:
556 clock_snapshot
= bt_message_event_borrow_default_clock_snapshot_const(msg
);
558 case BT_MESSAGE_TYPE_PACKET_BEGINNING
:
559 clock_snapshot
= bt_message_packet_beginning_borrow_default_clock_snapshot_const(msg
);
561 case BT_MESSAGE_TYPE_PACKET_END
:
562 clock_snapshot
= bt_message_packet_end_borrow_default_clock_snapshot_const(msg
);
564 case BT_MESSAGE_TYPE_DISCARDED_EVENTS
:
566 bt_message_discarded_events_borrow_beginning_default_clock_snapshot_const(msg
);
568 case BT_MESSAGE_TYPE_DISCARDED_PACKETS
:
570 bt_message_discarded_packets_borrow_beginning_default_clock_snapshot_const(msg
);
572 case BT_MESSAGE_TYPE_MESSAGE_ITERATOR_INACTIVITY
:
573 clock_snapshot
= bt_message_message_iterator_inactivity_borrow_clock_snapshot_const(msg
);
576 /* All the other messages have a higher priority */
577 BT_CPPLOGD_STR_SPEC(lttng_live_msg_iter
->logger
,
578 "Message has no timestamp: using the last message timestamp.");
579 *ts_ns
= last_msg_ts_ns
;
583 ret
= bt_clock_snapshot_get_ns_from_origin(clock_snapshot
, ts_ns
);
585 BT_CPPLOGE_APPEND_CAUSE_SPEC(lttng_live_msg_iter
->logger
,
586 "Cannot get nanoseconds from Epoch of clock snapshot: "
587 "clock-snapshot-addr={}",
588 fmt::ptr(clock_snapshot
));
599 BT_CPPLOGD_SPEC(lttng_live_msg_iter
->logger
,
600 "Found message's timestamp: iter-data-addr={}, msg-addr={}, "
601 "last-msg-ts={}, ts={}",
602 fmt::ptr(lttng_live_msg_iter
), fmt::ptr(msg
), last_msg_ts_ns
, *ts_ns
);
608 static enum lttng_live_iterator_status
lttng_live_iterator_next_handle_one_active_data_stream(
609 struct lttng_live_msg_iter
*lttng_live_msg_iter
,
610 struct lttng_live_stream_iterator
*lttng_live_stream
, bt2::ConstMessage::Shared
& message
)
612 enum lttng_live_iterator_status ret
= LTTNG_LIVE_ITERATOR_STATUS_OK
;
613 enum ctf_msg_iter_status status
;
615 for (const auto& session
: lttng_live_msg_iter
->sessions
) {
616 if (session
->new_streams_needed
) {
617 BT_CPPLOGD_SPEC(lttng_live_msg_iter
->logger
,
618 "Need an update for streams: "
621 ret
= LTTNG_LIVE_ITERATOR_STATUS_CONTINUE
;
624 for (lttng_live_trace::UP
& trace
: session
->traces
) {
625 if (trace
->metadata_stream_state
== LTTNG_LIVE_METADATA_STREAM_STATE_NEEDED
) {
626 BT_CPPLOGD_SPEC(lttng_live_msg_iter
->logger
,
627 "Need an update for metadata stream: "
628 "session-id={}, trace-id={}",
629 session
->id
, trace
->id
);
630 ret
= LTTNG_LIVE_ITERATOR_STATUS_CONTINUE
;
636 if (lttng_live_stream
->state
!= LTTNG_LIVE_STREAM_ACTIVE_DATA
) {
637 ret
= LTTNG_LIVE_ITERATOR_STATUS_ERROR
;
638 BT_CPPLOGE_APPEND_CAUSE_SPEC(lttng_live_msg_iter
->logger
,
639 "Invalid state of live stream iterator"
640 "stream-iter-status={}",
641 lttng_live_stream
->state
);
645 const bt_message
*msg
;
646 status
= ctf_msg_iter_get_next_message(lttng_live_stream
->msg_iter
.get(), &msg
);
648 case CTF_MSG_ITER_STATUS_EOF
:
649 ret
= LTTNG_LIVE_ITERATOR_STATUS_END
;
651 case CTF_MSG_ITER_STATUS_OK
:
652 message
= bt2::ConstMessage::Shared::createWithoutRef(msg
);
653 ret
= LTTNG_LIVE_ITERATOR_STATUS_OK
;
655 case CTF_MSG_ITER_STATUS_AGAIN
:
657 * Continue immediately (end of packet). The next
658 * get_index may return AGAIN to delay the following
661 ret
= LTTNG_LIVE_ITERATOR_STATUS_CONTINUE
;
663 case CTF_MSG_ITER_STATUS_ERROR
:
665 ret
= LTTNG_LIVE_ITERATOR_STATUS_ERROR
;
666 BT_CPPLOGE_APPEND_CAUSE_SPEC(lttng_live_msg_iter
->logger
,
667 "CTF message iterator failed to get next message: "
668 "msg-iter={}, msg-iter-status={}",
669 fmt::ptr(lttng_live_stream
->msg_iter
), status
);
677 static enum lttng_live_iterator_status
678 lttng_live_iterator_close_stream(struct lttng_live_msg_iter
*lttng_live_msg_iter
,
679 struct lttng_live_stream_iterator
*stream_iter
,
680 bt2::ConstMessage::Shared
& curr_msg
)
682 enum lttng_live_iterator_status live_status
= LTTNG_LIVE_ITERATOR_STATUS_OK
;
684 BT_CPPLOGD_SPEC(lttng_live_msg_iter
->logger
,
685 "Closing live stream iterator: stream-name=\"{}\", "
686 "viewer-stream-id={}",
687 stream_iter
->name
, stream_iter
->viewer_stream_id
);
690 * The viewer has hung up on us so we are closing the stream. The
691 * `ctf_msg_iter` should simply realize that it needs to close the
692 * stream properly by emitting the necessary stream end message.
694 const bt_message
*msg
;
695 enum ctf_msg_iter_status status
=
696 ctf_msg_iter_get_next_message(stream_iter
->msg_iter
.get(), &msg
);
698 if (status
== CTF_MSG_ITER_STATUS_ERROR
) {
699 BT_CPPLOGE_APPEND_CAUSE_SPEC(lttng_live_msg_iter
->logger
,
700 "Error getting the next message from CTF message iterator");
701 live_status
= LTTNG_LIVE_ITERATOR_STATUS_ERROR
;
703 } else if (status
== CTF_MSG_ITER_STATUS_EOF
) {
704 BT_CPPLOGI_SPEC(lttng_live_msg_iter
->logger
,
705 "Reached the end of the live stream iterator.");
706 live_status
= LTTNG_LIVE_ITERATOR_STATUS_END
;
710 BT_ASSERT(status
== CTF_MSG_ITER_STATUS_OK
);
712 curr_msg
= bt2::ConstMessage::Shared::createWithoutRef(msg
);
720 * handle_no_data_streams()
722 * - for each ACTIVE_NO_DATA stream:
723 * - query relayd for stream data, or quiescence info.
724 * - if need metadata, get metadata, goto retry.
725 * - if new stream, get new stream as ACTIVE_NO_DATA, goto retry
726 * - if quiescent, move to QUIESCENT streams
727 * - if fetched data, move to ACTIVE_DATA streams
728 * (at this point each stream either has data, or is quiescent)
732 * handle_new_streams_and_metadata()
733 * - query relayd for known streams, add them as ACTIVE_NO_DATA
734 * - query relayd for metadata
736 * call handle_active_no_data_streams()
738 * handle_quiescent_streams()
739 * - if at least one stream is ACTIVE_DATA:
740 * - peek stream event with lowest timestamp -> next_ts
741 * - for each quiescent stream
742 * - if next_ts >= quiescent end
743 * - set state to ACTIVE_NO_DATA
745 * - for each quiescent stream
746 * - set state to ACTIVE_NO_DATA
748 * call handle_active_no_data_streams()
750 * handle_active_data_streams()
751 * - if at least one stream is ACTIVE_DATA:
752 * - get stream event with lowest timestamp from heap
753 * - make that stream event the current message.
754 * - move this stream heap position to its next event
755 * - if we need to fetch data from relayd, move
756 * stream to ACTIVE_NO_DATA.
760 * end criterion: ctrl-c on client. If relayd exits or the session
761 * closes on the relay daemon side, we keep on waiting for streams.
762 * Eventually handle --end timestamp (also an end criterion).
764 * When disconnected from relayd: try to re-connect endlessly.
766 static enum lttng_live_iterator_status
767 lttng_live_iterator_next_msg_on_stream(struct lttng_live_msg_iter
*lttng_live_msg_iter
,
768 struct lttng_live_stream_iterator
*stream_iter
,
769 bt2::ConstMessage::Shared
& curr_msg
)
771 enum lttng_live_iterator_status live_status
;
773 BT_CPPLOGD_SPEC(lttng_live_msg_iter
->logger
,
774 "Advancing live stream iterator until next message if possible: "
775 "stream-name=\"{}\", viewer-stream-id={}",
776 stream_iter
->name
, stream_iter
->viewer_stream_id
);
778 if (stream_iter
->has_stream_hung_up
) {
780 * The stream has hung up and the stream was properly closed
781 * during the last call to the current function. Return _END
782 * status now so that this stream iterator is removed for the
783 * stream iterator list.
785 live_status
= LTTNG_LIVE_ITERATOR_STATUS_END
;
790 LTTNG_LIVE_LOGD_STREAM_ITER(stream_iter
);
793 * Make sure we have the most recent metadata and possibly some new
796 live_status
= lttng_live_iterator_handle_new_streams_and_metadata(lttng_live_msg_iter
);
797 if (live_status
!= LTTNG_LIVE_ITERATOR_STATUS_OK
) {
802 lttng_live_iterator_next_handle_one_no_data_stream(lttng_live_msg_iter
, stream_iter
);
803 if (live_status
!= LTTNG_LIVE_ITERATOR_STATUS_OK
) {
804 if (live_status
== LTTNG_LIVE_ITERATOR_STATUS_END
) {
806 * We overwrite `live_status` since `curr_msg` is
807 * likely set to a valid message in this function.
810 lttng_live_iterator_close_stream(lttng_live_msg_iter
, stream_iter
, curr_msg
);
815 live_status
= lttng_live_iterator_next_handle_one_quiescent_stream(lttng_live_msg_iter
,
816 stream_iter
, curr_msg
);
817 if (live_status
!= LTTNG_LIVE_ITERATOR_STATUS_OK
) {
818 BT_ASSERT(!curr_msg
);
824 live_status
= lttng_live_iterator_next_handle_one_active_data_stream(lttng_live_msg_iter
,
825 stream_iter
, curr_msg
);
826 if (live_status
!= LTTNG_LIVE_ITERATOR_STATUS_OK
) {
827 BT_ASSERT(!curr_msg
);
831 if (live_status
== LTTNG_LIVE_ITERATOR_STATUS_CONTINUE
) {
833 lttng_live_msg_iter
->logger
,
834 "Ask the relay daemon for an updated view of the data and metadata streams");
838 BT_CPPLOGD_SPEC(lttng_live_msg_iter
->logger
,
839 "Returning from advancing live stream iterator: status={}, "
840 "stream-name=\"{}\", viewer-stream-id={}",
841 live_status
, stream_iter
->name
, stream_iter
->viewer_stream_id
);
846 static bool is_discarded_packet_or_event_message(const bt2::ConstMessage msg
)
848 return msg
.type() == bt2::MessageType::DiscardedEvents
||
849 msg
.type() == bt2::MessageType::DiscardedPackets
;
852 static enum lttng_live_iterator_status
853 adjust_discarded_packets_message(bt_self_message_iterator
*iter
, const bt_stream
*stream
,
854 const bt_message
*msg_in
, bt2::ConstMessage::Shared
& msg_out
,
855 uint64_t new_begin_ts
)
857 enum bt_property_availability availability
;
858 const bt_clock_snapshot
*clock_snapshot
;
862 clock_snapshot
= bt_message_discarded_packets_borrow_end_default_clock_snapshot_const(msg_in
);
863 end_ts
= bt_clock_snapshot_get_value(clock_snapshot
);
865 availability
= bt_message_discarded_packets_get_count(msg_in
, &count
);
866 BT_ASSERT_DBG(availability
== BT_PROPERTY_AVAILABILITY_AVAILABLE
);
868 const auto msg
= bt_message_discarded_packets_create_with_default_clock_snapshots(
869 iter
, stream
, new_begin_ts
, end_ts
);
872 return LTTNG_LIVE_ITERATOR_STATUS_NOMEM
;
875 bt_message_discarded_packets_set_count(msg
, count
);
876 msg_out
= bt2::ConstMessage::Shared::createWithoutRef(msg
);
877 return LTTNG_LIVE_ITERATOR_STATUS_OK
;
880 static enum lttng_live_iterator_status
881 adjust_discarded_events_message(bt_self_message_iterator
*iter
, const bt_stream
*stream
,
882 const bt_message
*msg_in
, bt2::ConstMessage::Shared
& msg_out
,
883 uint64_t new_begin_ts
)
885 enum bt_property_availability availability
;
886 const bt_clock_snapshot
*clock_snapshot
;
890 clock_snapshot
= bt_message_discarded_events_borrow_end_default_clock_snapshot_const(msg_in
);
891 end_ts
= bt_clock_snapshot_get_value(clock_snapshot
);
893 availability
= bt_message_discarded_events_get_count(msg_in
, &count
);
894 BT_ASSERT_DBG(availability
== BT_PROPERTY_AVAILABILITY_AVAILABLE
);
896 const auto msg
= bt_message_discarded_events_create_with_default_clock_snapshots(
897 iter
, stream
, new_begin_ts
, end_ts
);
900 return LTTNG_LIVE_ITERATOR_STATUS_NOMEM
;
903 bt_message_discarded_events_set_count(msg
, count
);
904 msg_out
= bt2::ConstMessage::Shared::createWithoutRef(msg
);
905 return LTTNG_LIVE_ITERATOR_STATUS_OK
;
908 static enum lttng_live_iterator_status
909 handle_late_message(struct lttng_live_msg_iter
*lttng_live_msg_iter
,
910 struct lttng_live_stream_iterator
*stream_iter
, int64_t late_msg_ts_ns
,
911 const bt2::ConstMessage
& late_msg
)
913 const bt_clock_class
*clock_class
;
914 const bt_stream_class
*stream_class
;
915 enum bt_clock_class_cycles_to_ns_from_origin_status ts_ns_status
;
916 int64_t last_inactivity_ts_ns
;
917 enum lttng_live_iterator_status stream_iter_status
= LTTNG_LIVE_ITERATOR_STATUS_OK
;
918 enum lttng_live_iterator_status adjust_status
;
919 bt2::ConstMessage::Shared adjusted_message
;
922 * The timestamp of the current message is before the last message sent
923 * by this component. We CANNOT send it as is.
925 * The only expected scenario in which that could happen is the
926 * following, everything else is a bug in this component, relay daemon,
929 * Expected scenario: The CTF message iterator emitted discarded
930 * packets and discarded events with synthesized beginning and end
931 * timestamps from the bounds of the last known packet and the newly
932 * decoded packet header. The CTF message iterator is not aware of
933 * stream inactivity beacons. Hence, we have to adjust the beginning
934 * timestamp of those types of messages if a stream signalled its
935 * inactivity up until _after_ the last known packet's beginning
938 * Otherwise, the monotonicity guarantee of message timestamps would
941 * In short, the only scenario in which it's okay and fixable to
942 * received a late message is when:
943 * 1. the late message is a discarded packets or discarded events
945 * 2. this stream produced an inactivity message downstream, and
946 * 3. the timestamp of the late message is within the inactivity
947 * timespan we sent downstream through the inactivity message.
950 BT_CPPLOGD_SPEC(lttng_live_msg_iter
->logger
,
951 "Handling late message on live stream iterator: "
952 "stream-name=\"{}\", viewer-stream-id={}",
953 stream_iter
->name
, stream_iter
->viewer_stream_id
);
955 if (!stream_iter
->last_inactivity_ts
.is_set
) {
956 BT_CPPLOGE_APPEND_CAUSE_SPEC(lttng_live_msg_iter
->logger
,
957 "Invalid live stream state: "
958 "have a late message when no inactivity message "
959 "was ever sent for that stream.");
960 stream_iter_status
= LTTNG_LIVE_ITERATOR_STATUS_ERROR
;
964 if (!is_discarded_packet_or_event_message(late_msg
)) {
965 BT_CPPLOGE_APPEND_CAUSE_SPEC(lttng_live_msg_iter
->logger
,
966 "Invalid live stream state: "
967 "have a late message that is not a packet discarded or "
968 "event discarded message: late-msg-type={}",
970 stream_iter_status
= LTTNG_LIVE_ITERATOR_STATUS_ERROR
;
974 stream_class
= bt_stream_borrow_class_const(stream_iter
->stream
->libObjPtr());
975 clock_class
= bt_stream_class_borrow_default_clock_class_const(stream_class
);
977 ts_ns_status
= bt_clock_class_cycles_to_ns_from_origin(
978 clock_class
, stream_iter
->last_inactivity_ts
.value
, &last_inactivity_ts_ns
);
979 if (ts_ns_status
!= BT_CLOCK_CLASS_CYCLES_TO_NS_FROM_ORIGIN_STATUS_OK
) {
980 BT_CPPLOGE_APPEND_CAUSE_SPEC(lttng_live_msg_iter
->logger
,
981 "Error converting last "
982 "inactivity message timestamp to nanoseconds");
983 stream_iter_status
= LTTNG_LIVE_ITERATOR_STATUS_ERROR
;
987 if (last_inactivity_ts_ns
<= late_msg_ts_ns
) {
988 BT_CPPLOGE_APPEND_CAUSE_SPEC(lttng_live_msg_iter
->logger
,
989 "Invalid live stream state: "
990 "have a late message that is none included in a stream "
991 "inactivity timespan: last-inactivity-ts-ns={}, "
993 last_inactivity_ts_ns
, late_msg_ts_ns
);
994 stream_iter_status
= LTTNG_LIVE_ITERATOR_STATUS_ERROR
;
999 * We now know that it's okay for this message to be late, we can now
1000 * adjust its timestamp to ensure monotonicity.
1002 BT_CPPLOGD_SPEC(lttng_live_msg_iter
->logger
,
1003 "Adjusting the timestamp of late message: late-msg-type={}, "
1005 late_msg
.type(), stream_iter
->last_inactivity_ts
.value
);
1006 switch (late_msg
.type()) {
1007 case bt2::MessageType::DiscardedEvents
:
1008 adjust_status
= adjust_discarded_events_message(
1009 lttng_live_msg_iter
->self_msg_iter
, stream_iter
->stream
->libObjPtr(),
1010 late_msg
.libObjPtr(), adjusted_message
, stream_iter
->last_inactivity_ts
.value
);
1012 case bt2::MessageType::DiscardedPackets
:
1013 adjust_status
= adjust_discarded_packets_message(
1014 lttng_live_msg_iter
->self_msg_iter
, stream_iter
->stream
->libObjPtr(),
1015 late_msg
.libObjPtr(), adjusted_message
, stream_iter
->last_inactivity_ts
.value
);
1021 if (adjust_status
!= LTTNG_LIVE_ITERATOR_STATUS_OK
) {
1022 stream_iter_status
= adjust_status
;
1026 BT_ASSERT_DBG(adjusted_message
);
1027 stream_iter
->current_msg
= adjusted_message
;
1028 stream_iter
->current_msg_ts_ns
= last_inactivity_ts_ns
;
1031 return stream_iter_status
;
1034 static enum lttng_live_iterator_status
1035 next_stream_iterator_for_trace(struct lttng_live_msg_iter
*lttng_live_msg_iter
,
1036 struct lttng_live_trace
*live_trace
,
1037 struct lttng_live_stream_iterator
**youngest_trace_stream_iter
)
1039 struct lttng_live_stream_iterator
*youngest_candidate_stream_iter
= NULL
;
1040 enum lttng_live_iterator_status stream_iter_status
;
1041 int64_t youngest_candidate_msg_ts
= INT64_MAX
;
1042 uint64_t stream_iter_idx
;
1044 BT_ASSERT_DBG(live_trace
);
1046 BT_CPPLOGD_SPEC(lttng_live_msg_iter
->logger
,
1047 "Finding the next stream iterator for trace: "
1051 * Update the current message of every stream iterators of this trace.
1052 * The current msg of every stream must have a timestamp equal or
1053 * larger than the last message returned by this iterator. We must
1054 * ensure monotonicity.
1056 stream_iter_idx
= 0;
1057 while (stream_iter_idx
< live_trace
->stream_iterators
.size()) {
1058 bool stream_iter_is_ended
= false;
1059 lttng_live_stream_iterator
*stream_iter
=
1060 live_trace
->stream_iterators
[stream_iter_idx
].get();
1063 * If there is no current message for this stream, go fetch
1066 while (!stream_iter
->current_msg
) {
1067 bt2::ConstMessage::Shared msg
;
1068 int64_t curr_msg_ts_ns
= INT64_MAX
;
1070 stream_iter_status
=
1071 lttng_live_iterator_next_msg_on_stream(lttng_live_msg_iter
, stream_iter
, msg
);
1073 if (stream_iter_status
== LTTNG_LIVE_ITERATOR_STATUS_END
) {
1074 stream_iter_is_ended
= true;
1078 if (stream_iter_status
!= LTTNG_LIVE_ITERATOR_STATUS_OK
) {
1084 BT_CPPLOGD_SPEC(lttng_live_msg_iter
->logger
,
1085 "Live stream iterator returned message: msg-type={}, "
1086 "stream-name=\"{}\", viewer-stream-id={}",
1087 msg
->type(), stream_iter
->name
, stream_iter
->viewer_stream_id
);
1090 * Get the timestamp in nanoseconds from origin of this
1093 live_get_msg_ts_ns(lttng_live_msg_iter
, msg
->libObjPtr(),
1094 lttng_live_msg_iter
->last_msg_ts_ns
, &curr_msg_ts_ns
);
1097 * Check if the message of the current live stream
1098 * iterator occurred at the exact same time or after the
1099 * last message returned by this component's message
1100 * iterator. If not, we need to handle it with care.
1102 if (curr_msg_ts_ns
>= lttng_live_msg_iter
->last_msg_ts_ns
) {
1103 stream_iter
->current_msg
= std::move(msg
);
1104 stream_iter
->current_msg_ts_ns
= curr_msg_ts_ns
;
1107 * We received a message from the past. This
1108 * may be fixable but it can also be an error.
1110 stream_iter_status
=
1111 handle_late_message(lttng_live_msg_iter
, stream_iter
, curr_msg_ts_ns
, *msg
);
1112 if (stream_iter_status
!= LTTNG_LIVE_ITERATOR_STATUS_OK
) {
1113 BT_CPPLOGE_APPEND_CAUSE_SPEC(lttng_live_msg_iter
->logger
,
1114 "Late message could not be handled correctly: "
1115 "lttng-live-msg-iter-addr={}, "
1116 "stream-name=\"{}\", "
1117 "curr-msg-ts={}, last-msg-ts={}",
1118 fmt::ptr(lttng_live_msg_iter
), stream_iter
->name
,
1120 lttng_live_msg_iter
->last_msg_ts_ns
);
1121 stream_iter_status
= LTTNG_LIVE_ITERATOR_STATUS_ERROR
;
1127 BT_ASSERT_DBG(stream_iter
!= youngest_candidate_stream_iter
);
1129 if (!stream_iter_is_ended
) {
1130 if (G_UNLIKELY(youngest_candidate_stream_iter
== NULL
) ||
1131 stream_iter
->current_msg_ts_ns
< youngest_candidate_msg_ts
) {
1133 * Update the current best candidate message
1134 * for the stream iterator of this live trace
1135 * to be forwarded downstream.
1137 youngest_candidate_msg_ts
= stream_iter
->current_msg_ts_ns
;
1138 youngest_candidate_stream_iter
= stream_iter
;
1139 } else if (stream_iter
->current_msg_ts_ns
== youngest_candidate_msg_ts
) {
1141 * Order the messages in an arbitrary but
1142 * deterministic way.
1144 BT_ASSERT_DBG(stream_iter
!= youngest_candidate_stream_iter
);
1145 int ret
= common_muxing_compare_messages(
1146 stream_iter
->current_msg
->libObjPtr(),
1147 youngest_candidate_stream_iter
->current_msg
->libObjPtr());
1150 * The `youngest_candidate_stream_iter->current_msg`
1151 * should go first. Update the next
1152 * iterator and the current timestamp.
1154 youngest_candidate_msg_ts
= stream_iter
->current_msg_ts_ns
;
1155 youngest_candidate_stream_iter
= stream_iter
;
1156 } else if (ret
== 0) {
1158 * Unable to pick which one should go
1162 lttng_live_msg_iter
->logger
,
1163 "Cannot deterministically pick next live stream message iterator because they have identical next messages: "
1164 "stream-iter-addr={}"
1165 "stream-iter-addr={}",
1166 fmt::ptr(stream_iter
), fmt::ptr(youngest_candidate_stream_iter
));
1173 * The live stream iterator has ended. That
1174 * iterator is removed from the array, but
1175 * there is no need to increment
1176 * stream_iter_idx as
1177 * g_ptr_array_remove_index_fast replaces the
1178 * removed element with the array's last
1181 bt2c::vectorFastRemove(live_trace
->stream_iterators
, stream_iter_idx
);
1185 if (youngest_candidate_stream_iter
) {
1186 *youngest_trace_stream_iter
= youngest_candidate_stream_iter
;
1187 stream_iter_status
= LTTNG_LIVE_ITERATOR_STATUS_OK
;
1190 * The only case where we don't have a candidate for this trace
1191 * is if we reached the end of all the iterators.
1193 BT_ASSERT(live_trace
->stream_iterators
.empty());
1194 stream_iter_status
= LTTNG_LIVE_ITERATOR_STATUS_END
;
1198 return stream_iter_status
;
1201 static enum lttng_live_iterator_status
1202 next_stream_iterator_for_session(struct lttng_live_msg_iter
*lttng_live_msg_iter
,
1203 struct lttng_live_session
*session
,
1204 struct lttng_live_stream_iterator
**youngest_session_stream_iter
)
1206 enum lttng_live_iterator_status stream_iter_status
;
1207 uint64_t trace_idx
= 0;
1208 int64_t youngest_candidate_msg_ts
= INT64_MAX
;
1209 struct lttng_live_stream_iterator
*youngest_candidate_stream_iter
= NULL
;
1211 BT_CPPLOGD_SPEC(lttng_live_msg_iter
->logger
,
1212 "Finding the next stream iterator for session: "
1216 * Make sure we are attached to the session and look for new streams
1219 stream_iter_status
= lttng_live_get_session(lttng_live_msg_iter
, session
);
1220 if (stream_iter_status
!= LTTNG_LIVE_ITERATOR_STATUS_OK
&&
1221 stream_iter_status
!= LTTNG_LIVE_ITERATOR_STATUS_CONTINUE
&&
1222 stream_iter_status
!= LTTNG_LIVE_ITERATOR_STATUS_END
) {
1226 while (trace_idx
< session
->traces
.size()) {
1227 bool trace_is_ended
= false;
1228 struct lttng_live_stream_iterator
*stream_iter
;
1229 lttng_live_trace
*trace
= session
->traces
[trace_idx
].get();
1231 stream_iter_status
=
1232 next_stream_iterator_for_trace(lttng_live_msg_iter
, trace
, &stream_iter
);
1233 if (stream_iter_status
== LTTNG_LIVE_ITERATOR_STATUS_END
) {
1235 * All the live stream iterators for this trace are
1236 * ENDed. Remove the trace from this session.
1238 trace_is_ended
= true;
1239 } else if (stream_iter_status
!= LTTNG_LIVE_ITERATOR_STATUS_OK
) {
1243 if (!trace_is_ended
) {
1244 BT_ASSERT_DBG(stream_iter
);
1246 if (G_UNLIKELY(youngest_candidate_stream_iter
== NULL
) ||
1247 stream_iter
->current_msg_ts_ns
< youngest_candidate_msg_ts
) {
1248 youngest_candidate_msg_ts
= stream_iter
->current_msg_ts_ns
;
1249 youngest_candidate_stream_iter
= stream_iter
;
1250 } else if (stream_iter
->current_msg_ts_ns
== youngest_candidate_msg_ts
) {
1252 * Order the messages in an arbitrary but
1253 * deterministic way.
1255 int ret
= common_muxing_compare_messages(
1256 stream_iter
->current_msg
->libObjPtr(),
1257 youngest_candidate_stream_iter
->current_msg
->libObjPtr());
1260 * The `youngest_candidate_stream_iter->current_msg`
1261 * should go first. Update the next iterator
1262 * and the current timestamp.
1264 youngest_candidate_msg_ts
= stream_iter
->current_msg_ts_ns
;
1265 youngest_candidate_stream_iter
= stream_iter
;
1266 } else if (ret
== 0) {
1267 /* Unable to pick which one should go first. */
1269 lttng_live_msg_iter
->logger
,
1270 "Cannot deterministically pick next live stream message iterator because they have identical next messages: "
1271 "stream-iter-addr={}"
1272 "youngest-candidate-stream-iter-addr={}",
1273 fmt::ptr(stream_iter
), fmt::ptr(youngest_candidate_stream_iter
));
1279 * trace_idx is not incremented since
1280 * vectorFastRemove replaces the
1281 * element at trace_idx with the array's last element.
1283 bt2c::vectorFastRemove(session
->traces
, trace_idx
);
1286 if (youngest_candidate_stream_iter
) {
1287 *youngest_session_stream_iter
= youngest_candidate_stream_iter
;
1288 stream_iter_status
= LTTNG_LIVE_ITERATOR_STATUS_OK
;
1291 * The only cases where we don't have a candidate for this
1293 * 1. if we reached the end of all the iterators of all the
1294 * traces of this session,
1295 * 2. if we never had live stream iterator in the first place.
1297 * In either cases, we return END.
1299 BT_ASSERT(session
->traces
.empty());
1300 stream_iter_status
= LTTNG_LIVE_ITERATOR_STATUS_END
;
1303 return stream_iter_status
;
1306 static inline void put_messages(bt_message_array_const msgs
, uint64_t count
)
1310 for (i
= 0; i
< count
; i
++) {
1311 BT_MESSAGE_PUT_REF_AND_RESET(msgs
[i
]);
1315 bt_message_iterator_class_next_method_status
1316 lttng_live_msg_iter_next(bt_self_message_iterator
*self_msg_it
, bt_message_array_const msgs
,
1317 uint64_t capacity
, uint64_t *count
)
1320 bt_message_iterator_class_next_method_status status
;
1321 enum lttng_live_viewer_status viewer_status
;
1322 struct lttng_live_msg_iter
*lttng_live_msg_iter
=
1323 (struct lttng_live_msg_iter
*) bt_self_message_iterator_get_data(self_msg_it
);
1324 struct lttng_live_component
*lttng_live
= lttng_live_msg_iter
->lttng_live_comp
;
1325 enum lttng_live_iterator_status stream_iter_status
;
1329 BT_ASSERT_DBG(lttng_live_msg_iter
);
1331 if (G_UNLIKELY(lttng_live_msg_iter
->was_interrupted
)) {
1333 * The iterator was interrupted in a previous call to the
1334 * `_next()` method. We currently do not support generating
1335 * messages after such event. The babeltrace2 CLI should never
1336 * be running the graph after being interrupted. So this check
1337 * is to prevent other graph users from using this live
1338 * iterator in an messed up internal state.
1340 status
= BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_ERROR
;
1341 BT_CPPLOGE_APPEND_CAUSE_SPEC(
1342 lttng_live_msg_iter
->logger
,
1343 "Message iterator was interrupted during a previous call to the `next()` and currently does not support continuing after such event.");
1348 * Clear all the invalid message reference that might be left over in
1351 memset(msgs
, 0, capacity
* sizeof(*msgs
));
1354 * If no session are exposed on the relay found at the url provided by
1355 * the user, session count will be 0. In this case, we return status
1356 * end to return gracefully.
1358 if (lttng_live_msg_iter
->sessions
.empty()) {
1359 if (lttng_live
->params
.sess_not_found_act
!= SESSION_NOT_FOUND_ACTION_CONTINUE
) {
1360 status
= BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_END
;
1364 * The are no more active session for this session
1365 * name. Retry to create a viewer session for the
1366 * requested session name.
1368 viewer_status
= lttng_live_create_viewer_session(lttng_live_msg_iter
);
1369 if (viewer_status
!= LTTNG_LIVE_VIEWER_STATUS_OK
) {
1370 if (viewer_status
== LTTNG_LIVE_VIEWER_STATUS_ERROR
) {
1371 status
= BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_ERROR
;
1372 BT_CPPLOGE_APPEND_CAUSE_SPEC(lttng_live_msg_iter
->logger
,
1373 "Error creating LTTng live viewer session");
1374 } else if (viewer_status
== LTTNG_LIVE_VIEWER_STATUS_INTERRUPTED
) {
1375 status
= BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_AGAIN
;
1384 if (lttng_live_msg_iter
->active_stream_iter
== 0) {
1385 lttng_live_force_new_streams_and_metadata(lttng_live_msg_iter
);
1389 * Here the muxing of message is done.
1391 * We need to iterate over all the streams of all the traces of all the
1392 * viewer sessions in order to get the message with the smallest
1393 * timestamp. In this case, a session is a viewer session and there is
1394 * one viewer session per consumer daemon. (UST 32bit, UST 64bit and/or
1395 * kernel). Each viewer session can have multiple traces, for example,
1396 * 64bit UST viewer sessions could have multiple per-pid traces.
1398 * We iterate over the streams of each traces to update and see what is
1399 * their next message's timestamp. From those timestamps, we select the
1400 * message with the smallest timestamp as the best candidate message
1401 * for that trace and do the same thing across all the sessions.
1403 * We then compare the timestamp of best candidate message of all the
1404 * sessions to pick the message with the smallest timestamp and we
1407 while (*count
< capacity
) {
1408 struct lttng_live_stream_iterator
*youngest_stream_iter
= NULL
,
1409 *candidate_stream_iter
= NULL
;
1410 int64_t youngest_msg_ts_ns
= INT64_MAX
;
1412 uint64_t session_idx
= 0;
1413 while (session_idx
< lttng_live_msg_iter
->sessions
.size()) {
1414 lttng_live_session
*session
= lttng_live_msg_iter
->sessions
[session_idx
].get();
1416 /* Find the best candidate message to send downstream. */
1417 stream_iter_status
= next_stream_iterator_for_session(lttng_live_msg_iter
, session
,
1418 &candidate_stream_iter
);
1420 /* If we receive an END status, it means that either:
1421 * - Those traces never had active streams (UST with no
1422 * data produced yet),
1423 * - All live stream iterators have ENDed.
1425 if (stream_iter_status
== LTTNG_LIVE_ITERATOR_STATUS_END
) {
1426 if (session
->closed
&& session
->traces
.empty()) {
1428 * Remove the session from the list.
1429 * session_idx is not modified since
1430 * g_ptr_array_remove_index_fast
1431 * replaces the the removed element with
1432 * the array's last element.
1434 bt2c::vectorFastRemove(lttng_live_msg_iter
->sessions
, session_idx
);
1441 if (stream_iter_status
!= LTTNG_LIVE_ITERATOR_STATUS_OK
) {
1445 if (G_UNLIKELY(youngest_stream_iter
== NULL
) ||
1446 candidate_stream_iter
->current_msg_ts_ns
< youngest_msg_ts_ns
) {
1447 youngest_msg_ts_ns
= candidate_stream_iter
->current_msg_ts_ns
;
1448 youngest_stream_iter
= candidate_stream_iter
;
1449 } else if (candidate_stream_iter
->current_msg_ts_ns
== youngest_msg_ts_ns
) {
1451 * The currently selected message to be sent
1452 * downstream next has the exact same timestamp
1453 * that of the current candidate message. We
1454 * must break the tie in a predictable manner.
1456 BT_CPPLOGD_STR_SPEC(
1457 lttng_live_msg_iter
->logger
,
1458 "Two of the next message candidates have the same timestamps, pick one deterministically.");
1460 * Order the messages in an arbitrary but
1461 * deterministic way.
1463 int ret
= common_muxing_compare_messages(
1464 candidate_stream_iter
->current_msg
->libObjPtr(),
1465 youngest_stream_iter
->current_msg
->libObjPtr());
1468 * The `candidate_stream_iter->current_msg`
1469 * should go first. Update the next
1470 * iterator and the current timestamp.
1472 youngest_msg_ts_ns
= candidate_stream_iter
->current_msg_ts_ns
;
1473 youngest_stream_iter
= candidate_stream_iter
;
1474 } else if (ret
== 0) {
1475 /* Unable to pick which one should go first. */
1477 lttng_live_msg_iter
->logger
,
1478 "Cannot deterministically pick next live stream message iterator because they have identical next messages: "
1479 "next-stream-iter-addr={}"
1480 "candidate-stream-iter-addr={}",
1481 fmt::ptr(youngest_stream_iter
), fmt::ptr(candidate_stream_iter
));
1488 if (!youngest_stream_iter
) {
1489 stream_iter_status
= LTTNG_LIVE_ITERATOR_STATUS_AGAIN
;
1493 BT_ASSERT_DBG(youngest_stream_iter
->current_msg
);
1494 /* Ensure monotonicity. */
1495 BT_ASSERT_DBG(lttng_live_msg_iter
->last_msg_ts_ns
<=
1496 youngest_stream_iter
->current_msg_ts_ns
);
1499 * Insert the next message to the message batch. This will set
1500 * stream iterator current message to NULL so that next time
1501 * we fetch the next message of that stream iterator
1503 msgs
[*count
] = youngest_stream_iter
->current_msg
.release().libObjPtr();
1506 /* Update the last timestamp in nanoseconds sent downstream. */
1507 lttng_live_msg_iter
->last_msg_ts_ns
= youngest_msg_ts_ns
;
1508 youngest_stream_iter
->current_msg_ts_ns
= INT64_MAX
;
1510 stream_iter_status
= LTTNG_LIVE_ITERATOR_STATUS_OK
;
1514 switch (stream_iter_status
) {
1515 case LTTNG_LIVE_ITERATOR_STATUS_OK
:
1516 case LTTNG_LIVE_ITERATOR_STATUS_AGAIN
:
1518 * If we gathered messages, return _OK even if the graph was
1519 * interrupted. This allows for the components downstream to at
1520 * least get the those messages. If the graph was indeed
1521 * interrupted there should not be another _next() call as the
1522 * application will tear down the graph. This component class
1523 * doesn't support restarting after an interruption.
1526 status
= BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_OK
;
1528 status
= BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_AGAIN
;
1531 case LTTNG_LIVE_ITERATOR_STATUS_END
:
1532 status
= BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_END
;
1534 case LTTNG_LIVE_ITERATOR_STATUS_NOMEM
:
1535 BT_CPPLOGE_APPEND_CAUSE_SPEC(lttng_live_msg_iter
->logger
,
1536 "Memory error preparing the next batch of messages: "
1537 "live-iter-status={}",
1538 stream_iter_status
);
1539 status
= BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_MEMORY_ERROR
;
1541 case LTTNG_LIVE_ITERATOR_STATUS_ERROR
:
1542 case LTTNG_LIVE_ITERATOR_STATUS_INVAL
:
1543 case LTTNG_LIVE_ITERATOR_STATUS_UNSUPPORTED
:
1544 BT_CPPLOGE_APPEND_CAUSE_SPEC(lttng_live_msg_iter
->logger
,
1545 "Error preparing the next batch of messages: "
1546 "live-iter-status={}",
1547 stream_iter_status
);
1549 status
= BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_ERROR
;
1550 /* Put all existing messages on error. */
1551 put_messages(msgs
, *count
);
1559 } catch (const std::bad_alloc
&) {
1560 return BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_MEMORY_ERROR
;
1561 } catch (const bt2::Error
&) {
1562 return BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_ERROR
;
1566 static lttng_live_msg_iter::UP
1567 lttng_live_msg_iter_create(struct lttng_live_component
*lttng_live_comp
,
1568 bt_self_message_iterator
*self_msg_it
)
1570 auto msg_iter
= bt2s::make_unique
<struct lttng_live_msg_iter
>(lttng_live_comp
->logger
);
1572 msg_iter
->self_comp
= lttng_live_comp
->self_comp
;
1573 msg_iter
->lttng_live_comp
= lttng_live_comp
;
1574 msg_iter
->self_msg_iter
= self_msg_it
;
1575 msg_iter
->active_stream_iter
= 0;
1576 msg_iter
->last_msg_ts_ns
= INT64_MIN
;
1577 msg_iter
->was_interrupted
= false;
1582 bt_message_iterator_class_initialize_method_status
1583 lttng_live_msg_iter_init(bt_self_message_iterator
*self_msg_it
,
1584 bt_self_message_iterator_configuration
*, bt_self_component_port_output
*)
1587 struct lttng_live_component
*lttng_live
;
1588 enum lttng_live_viewer_status viewer_status
;
1589 bt_self_component
*self_comp
= bt_self_message_iterator_borrow_component(self_msg_it
);
1591 lttng_live
= (lttng_live_component
*) bt_self_component_get_data(self_comp
);
1593 /* There can be only one downstream iterator at the same time. */
1594 BT_ASSERT(!lttng_live
->has_msg_iter
);
1595 lttng_live
->has_msg_iter
= true;
1597 auto lttng_live_msg_iter
= lttng_live_msg_iter_create(lttng_live
, self_msg_it
);
1598 if (!lttng_live_msg_iter
) {
1599 BT_CPPLOGE_APPEND_CAUSE_SPEC(lttng_live
->logger
,
1600 "Failed to create lttng_live_msg_iter");
1601 return BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_MEMORY_ERROR
;
1604 viewer_status
= live_viewer_connection_create(
1605 lttng_live
->params
.url
.c_str(), false, lttng_live_msg_iter
.get(),
1606 lttng_live_msg_iter
->logger
, lttng_live_msg_iter
->viewer_connection
);
1607 if (viewer_status
!= LTTNG_LIVE_VIEWER_STATUS_OK
) {
1608 if (viewer_status
== LTTNG_LIVE_VIEWER_STATUS_ERROR
) {
1609 BT_CPPLOGE_APPEND_CAUSE_SPEC(lttng_live_msg_iter
->logger
,
1610 "Failed to create viewer connection");
1611 } else if (viewer_status
== LTTNG_LIVE_VIEWER_STATUS_INTERRUPTED
) {
1613 * Interruption in the _iter_init() method is not
1614 * supported. Return an error.
1616 BT_CPPLOGE_APPEND_CAUSE_SPEC(lttng_live_msg_iter
->logger
,
1617 "Interrupted while creating viewer connection");
1620 return BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_ERROR
;
1623 viewer_status
= lttng_live_create_viewer_session(lttng_live_msg_iter
.get());
1624 if (viewer_status
!= LTTNG_LIVE_VIEWER_STATUS_OK
) {
1625 if (viewer_status
== LTTNG_LIVE_VIEWER_STATUS_ERROR
) {
1626 BT_CPPLOGE_APPEND_CAUSE_SPEC(lttng_live_msg_iter
->logger
,
1627 "Failed to create viewer session");
1628 } else if (viewer_status
== LTTNG_LIVE_VIEWER_STATUS_INTERRUPTED
) {
1630 * Interruption in the _iter_init() method is not
1631 * supported. Return an error.
1633 BT_CPPLOGE_APPEND_CAUSE_SPEC(lttng_live_msg_iter
->logger
,
1634 "Interrupted when creating viewer session");
1637 return BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_ERROR
;
1640 if (lttng_live_msg_iter
->sessions
.empty()) {
1641 switch (lttng_live
->params
.sess_not_found_act
) {
1642 case SESSION_NOT_FOUND_ACTION_CONTINUE
:
1644 lttng_live_msg_iter
->logger
,
1645 "Unable to connect to the requested live viewer session. "
1646 "Keep trying to connect because of {}=\"{}\" component parameter: url=\"{}\"",
1647 SESS_NOT_FOUND_ACTION_PARAM
, SESS_NOT_FOUND_ACTION_CONTINUE_STR
,
1648 lttng_live
->params
.url
);
1650 case SESSION_NOT_FOUND_ACTION_FAIL
:
1651 BT_CPPLOGE_APPEND_CAUSE_SPEC(
1652 lttng_live_msg_iter
->logger
,
1653 "Unable to connect to the requested live viewer session. "
1654 "Fail the message iterator initialization because of {}=\"{}\" "
1655 "component parameter: url =\"{}\"",
1656 SESS_NOT_FOUND_ACTION_PARAM
, SESS_NOT_FOUND_ACTION_FAIL_STR
,
1657 lttng_live
->params
.url
);
1658 return BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_ERROR
;
1659 case SESSION_NOT_FOUND_ACTION_END
:
1660 BT_CPPLOGI_SPEC(lttng_live_msg_iter
->logger
,
1661 "Unable to connect to the requested live viewer session. "
1662 "End gracefully at the first _next() call because of {}=\"{}\""
1663 " component parameter: url=\"{}\"",
1664 SESS_NOT_FOUND_ACTION_PARAM
, SESS_NOT_FOUND_ACTION_END_STR
,
1665 lttng_live
->params
.url
);
1672 bt_self_message_iterator_set_data(self_msg_it
, lttng_live_msg_iter
.release());
1673 return BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_OK
;
1674 } catch (const std::bad_alloc
&) {
1675 return BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_MEMORY_ERROR
;
1676 } catch (const bt2::Error
&) {
1677 return BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_ERROR
;
1681 static struct bt_param_validation_map_value_entry_descr list_sessions_params
[] = {
1682 {URL_PARAM
, BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_MANDATORY
,
1683 bt_param_validation_value_descr::makeString()},
1684 BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_END
};
1686 static bt_component_class_query_method_status
1687 lttng_live_query_list_sessions(const bt_value
*params
, const bt_value
**result
,
1688 const bt2c::Logger
& logger
)
1690 bt_component_class_query_method_status status
;
1691 const bt_value
*url_value
= NULL
;
1693 live_viewer_connection::UP viewer_connection
;
1694 enum lttng_live_viewer_status viewer_status
;
1695 enum bt_param_validation_status validation_status
;
1696 gchar
*validate_error
= NULL
;
1698 validation_status
= bt_param_validation_validate(params
, list_sessions_params
, &validate_error
);
1699 if (validation_status
== BT_PARAM_VALIDATION_STATUS_MEMORY_ERROR
) {
1700 status
= BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_MEMORY_ERROR
;
1702 } else if (validation_status
== BT_PARAM_VALIDATION_STATUS_VALIDATION_ERROR
) {
1703 status
= BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_ERROR
;
1704 BT_CPPLOGE_APPEND_CAUSE_SPEC(logger
, "{}", validate_error
);
1708 url_value
= bt_value_map_borrow_entry_value_const(params
, URL_PARAM
);
1709 url
= bt_value_string_get(url_value
);
1711 viewer_status
= live_viewer_connection_create(url
, true, NULL
, logger
, viewer_connection
);
1712 if (viewer_status
!= LTTNG_LIVE_VIEWER_STATUS_OK
) {
1713 if (viewer_status
== LTTNG_LIVE_VIEWER_STATUS_ERROR
) {
1714 BT_CPPLOGE_APPEND_CAUSE_SPEC(logger
, "Failed to create viewer connection");
1715 status
= BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_ERROR
;
1716 } else if (viewer_status
== LTTNG_LIVE_VIEWER_STATUS_INTERRUPTED
) {
1717 status
= BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_AGAIN
;
1724 status
= live_viewer_connection_list_sessions(viewer_connection
.get(), result
);
1725 if (status
!= BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_OK
) {
1726 BT_CPPLOGE_APPEND_CAUSE_SPEC(logger
, "Failed to list viewer sessions");
1733 BT_VALUE_PUT_REF_AND_RESET(*result
);
1736 status
= BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_ERROR
;
1740 g_free(validate_error
);
1745 static bt_component_class_query_method_status
1746 lttng_live_query_support_info(const bt_value
*params
, const bt_value
**result
,
1747 const bt2c::Logger
& logger
)
1749 bt_component_class_query_method_status status
= BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_OK
;
1750 const bt_value
*input_type_value
;
1751 const bt_value
*input_value
;
1753 struct bt_common_lttng_live_url_parts parts
= {};
1755 /* Used by the logging macros */
1756 __attribute__((unused
)) bt_self_component
*self_comp
= NULL
;
1759 input_type_value
= bt_value_map_borrow_entry_value_const(params
, "type");
1760 if (!input_type_value
) {
1761 BT_CPPLOGE_APPEND_CAUSE_SPEC(logger
, "Missing expected `type` parameter.");
1765 if (!bt_value_is_string(input_type_value
)) {
1766 BT_CPPLOGE_APPEND_CAUSE_SPEC(logger
, "`type` parameter is not a string value.");
1770 if (strcmp(bt_value_string_get(input_type_value
), "string") != 0) {
1771 /* We don't handle file system paths */
1775 input_value
= bt_value_map_borrow_entry_value_const(params
, "input");
1777 BT_CPPLOGE_APPEND_CAUSE_SPEC(logger
, "Missing expected `input` parameter.");
1781 if (!bt_value_is_string(input_value
)) {
1782 BT_CPPLOGE_APPEND_CAUSE_SPEC(logger
, "`input` parameter is not a string value.");
1786 parts
= bt_common_parse_lttng_live_url(bt_value_string_get(input_value
), NULL
, 0);
1787 if (parts
.session_name
) {
1789 * Looks pretty much like an LTTng live URL: we got the
1790 * session name part, which forms a complete URL.
1796 *result
= bt_value_real_create_init(weight
);
1798 status
= BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_MEMORY_ERROR
;
1806 status
= BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_ERROR
;
1809 BT_ASSERT(!*result
);
1812 bt_common_destroy_lttng_live_url_parts(&parts
);
1816 bt_component_class_query_method_status
lttng_live_query(bt_self_component_class_source
*comp_class
,
1817 bt_private_query_executor
*priv_query_exec
,
1818 const char *object
, const bt_value
*params
,
1819 __attribute__((unused
)) void *method_data
,
1820 const bt_value
**result
)
1823 bt_component_class_query_method_status status
= BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_OK
;
1824 bt2c::Logger logger
{bt2::SelfComponentClass
{comp_class
},
1825 bt2::PrivateQueryExecutor
{priv_query_exec
},
1826 "PLUGIN/SRC.CTF.LTTNG-LIVE/QUERY"};
1828 if (strcmp(object
, "sessions") == 0) {
1829 status
= lttng_live_query_list_sessions(params
, result
, logger
);
1830 } else if (strcmp(object
, "babeltrace.support-info") == 0) {
1831 status
= lttng_live_query_support_info(params
, result
, logger
);
1833 BT_CPPLOGI_SPEC(logger
, "Unknown query object `{}`", object
);
1834 status
= BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_UNKNOWN_OBJECT
;
1840 } catch (const std::bad_alloc
&) {
1841 return BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_MEMORY_ERROR
;
1842 } catch (const bt2::Error
&) {
1843 return BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_ERROR
;
1847 void lttng_live_component_finalize(bt_self_component_source
*component
)
1849 lttng_live_component::UP
{static_cast<lttng_live_component
*>(
1850 bt_self_component_get_data(bt_self_component_source_as_self_component(component
)))};
1853 static enum session_not_found_action
1854 parse_session_not_found_action_param(const bt_value
*no_session_param
)
1856 enum session_not_found_action action
;
1857 const char *no_session_act_str
= bt_value_string_get(no_session_param
);
1859 if (strcmp(no_session_act_str
, SESS_NOT_FOUND_ACTION_CONTINUE_STR
) == 0) {
1860 action
= SESSION_NOT_FOUND_ACTION_CONTINUE
;
1861 } else if (strcmp(no_session_act_str
, SESS_NOT_FOUND_ACTION_FAIL_STR
) == 0) {
1862 action
= SESSION_NOT_FOUND_ACTION_FAIL
;
1864 BT_ASSERT(strcmp(no_session_act_str
, SESS_NOT_FOUND_ACTION_END_STR
) == 0);
1865 action
= SESSION_NOT_FOUND_ACTION_END
;
1871 static bt_param_validation_value_descr inputs_elem_descr
=
1872 bt_param_validation_value_descr::makeString();
1874 static const char *sess_not_found_action_choices
[] = {
1875 SESS_NOT_FOUND_ACTION_CONTINUE_STR
,
1876 SESS_NOT_FOUND_ACTION_FAIL_STR
,
1877 SESS_NOT_FOUND_ACTION_END_STR
,
1880 static struct bt_param_validation_map_value_entry_descr params_descr
[] = {
1881 {INPUTS_PARAM
, BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_MANDATORY
,
1882 bt_param_validation_value_descr::makeArray(1, 1, inputs_elem_descr
)},
1883 {SESS_NOT_FOUND_ACTION_PARAM
, BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL
,
1884 bt_param_validation_value_descr::makeString(sess_not_found_action_choices
)},
1885 BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_END
};
1887 static bt_component_class_initialize_method_status
1888 lttng_live_component_create(const bt_value
*params
, bt_self_component_source
*self_comp
,
1889 lttng_live_component::UP
& component
)
1891 const bt_value
*inputs_value
;
1892 const bt_value
*url_value
;
1893 const bt_value
*value
;
1894 enum bt_param_validation_status validation_status
;
1895 gchar
*validation_error
= NULL
;
1896 bt2c::Logger logger
{bt2::SelfSourceComponent
{self_comp
}, "PLUGIN/SRC.CTF.LTTNG-LIVE/COMP"};
1898 validation_status
= bt_param_validation_validate(params
, params_descr
, &validation_error
);
1899 if (validation_status
== BT_PARAM_VALIDATION_STATUS_MEMORY_ERROR
) {
1900 return BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_MEMORY_ERROR
;
1901 } else if (validation_status
== BT_PARAM_VALIDATION_STATUS_VALIDATION_ERROR
) {
1902 bt2c::GCharUP errorFreer
{validation_error
};
1903 BT_CPPLOGE_APPEND_CAUSE_SPEC(logger
, "{}", validation_error
);
1904 return BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_ERROR
;
1907 auto lttng_live
= bt2s::make_unique
<lttng_live_component
>(std::move(logger
));
1908 lttng_live
->self_comp
= bt_self_component_source_as_self_component(self_comp
);
1909 lttng_live
->max_query_size
= MAX_QUERY_SIZE
;
1910 lttng_live
->has_msg_iter
= false;
1912 inputs_value
= bt_value_map_borrow_entry_value_const(params
, INPUTS_PARAM
);
1913 url_value
= bt_value_array_borrow_element_by_index_const(inputs_value
, 0);
1914 lttng_live
->params
.url
= bt_value_string_get(url_value
);
1916 value
= bt_value_map_borrow_entry_value_const(params
, SESS_NOT_FOUND_ACTION_PARAM
);
1918 lttng_live
->params
.sess_not_found_act
= parse_session_not_found_action_param(value
);
1920 BT_CPPLOGI_SPEC(lttng_live
->logger
,
1921 "Optional `{}` parameter is missing: defaulting to `{}`.",
1922 SESS_NOT_FOUND_ACTION_PARAM
, SESS_NOT_FOUND_ACTION_CONTINUE_STR
);
1923 lttng_live
->params
.sess_not_found_act
= SESSION_NOT_FOUND_ACTION_CONTINUE
;
1926 component
= std::move(lttng_live
);
1927 return BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_OK
;
1930 bt_component_class_initialize_method_status
1931 lttng_live_component_init(bt_self_component_source
*self_comp_src
,
1932 bt_self_component_source_configuration
*, const bt_value
*params
, void *)
1935 lttng_live_component::UP lttng_live
;
1936 bt_component_class_initialize_method_status ret
;
1937 bt_self_component
*self_comp
= bt_self_component_source_as_self_component(self_comp_src
);
1938 bt_self_component_add_port_status add_port_status
;
1940 ret
= lttng_live_component_create(params
, self_comp_src
, lttng_live
);
1941 if (ret
!= BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_OK
) {
1946 bt_self_component_source_add_output_port(self_comp_src
, "out", NULL
, NULL
);
1947 if (add_port_status
!= BT_SELF_COMPONENT_ADD_PORT_STATUS_OK
) {
1948 ret
= (bt_component_class_initialize_method_status
) add_port_status
;
1952 bt_self_component_set_data(self_comp
, lttng_live
.release());
1954 return BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_OK
;
1955 } catch (const std::bad_alloc
&) {
1956 return BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_MEMORY_ERROR
;
1957 } catch (const bt2::Error
&) {
1958 return BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_ERROR
;