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 static void lttng_live_msg_iter_destroy(struct lttng_live_msg_iter
*lttng_live_msg_iter
)
161 if (!lttng_live_msg_iter
) {
165 if (lttng_live_msg_iter
->viewer_connection
) {
166 delete lttng_live_msg_iter
->viewer_connection
;
168 BT_ASSERT(lttng_live_msg_iter
->lttng_live_comp
);
169 BT_ASSERT(lttng_live_msg_iter
->lttng_live_comp
->has_msg_iter
);
171 /* All stream iterators must be destroyed at this point. */
172 BT_ASSERT(lttng_live_msg_iter
->active_stream_iter
== 0);
173 lttng_live_msg_iter
->lttng_live_comp
->has_msg_iter
= false;
175 delete lttng_live_msg_iter
;
181 void lttng_live_msg_iter_finalize(bt_self_message_iterator
*self_msg_iter
)
183 struct lttng_live_msg_iter
*lttng_live_msg_iter
;
185 BT_ASSERT(self_msg_iter
);
187 lttng_live_msg_iter
=
188 (struct lttng_live_msg_iter
*) bt_self_message_iterator_get_data(self_msg_iter
);
189 BT_ASSERT(lttng_live_msg_iter
);
190 lttng_live_msg_iter_destroy(lttng_live_msg_iter
);
193 static enum lttng_live_iterator_status
194 lttng_live_iterator_next_check_stream_state(struct lttng_live_stream_iterator
*lttng_live_stream
)
196 switch (lttng_live_stream
->state
) {
197 case LTTNG_LIVE_STREAM_QUIESCENT
:
198 case LTTNG_LIVE_STREAM_ACTIVE_DATA
:
200 case LTTNG_LIVE_STREAM_ACTIVE_NO_DATA
:
202 BT_CPPLOGF_SPEC(lttng_live_stream
->logger
, "Unexpected stream state \"ACTIVE_NO_DATA\"");
204 case LTTNG_LIVE_STREAM_QUIESCENT_NO_DATA
:
206 BT_CPPLOGF_SPEC(lttng_live_stream
->logger
, "Unexpected stream state \"QUIESCENT_NO_DATA\"");
208 case LTTNG_LIVE_STREAM_EOF
:
211 return LTTNG_LIVE_ITERATOR_STATUS_OK
;
215 * For active no data stream, fetch next index. As a result of that it can
217 * - quiescent: won't have events for a bit,
218 * - have data: need to get that data and produce the event,
219 * - have no data on this stream at this point: need to retry (AGAIN) or return
222 static enum lttng_live_iterator_status
lttng_live_iterator_next_handle_one_no_data_stream(
223 struct lttng_live_msg_iter
*lttng_live_msg_iter
,
224 struct lttng_live_stream_iterator
*lttng_live_stream
)
226 enum lttng_live_iterator_status ret
= LTTNG_LIVE_ITERATOR_STATUS_OK
;
227 enum lttng_live_stream_state orig_state
= lttng_live_stream
->state
;
228 struct packet_index index
;
230 if (lttng_live_stream
->trace
->metadata_stream_state
==
231 LTTNG_LIVE_METADATA_STREAM_STATE_NEEDED
) {
232 BT_CPPLOGD_SPEC(lttng_live_msg_iter
->logger
,
233 "Need to get an update for the metadata stream before proceeding "
234 "further with this stream: stream-name=\"{}\"",
235 lttng_live_stream
->name
);
236 ret
= LTTNG_LIVE_ITERATOR_STATUS_CONTINUE
;
240 if (lttng_live_stream
->trace
->session
->new_streams_needed
) {
241 BT_CPPLOGD_SPEC(lttng_live_msg_iter
->logger
,
242 "Need to get an update of all streams before proceeding further "
243 "with this stream: stream-name=\"{}\"",
244 lttng_live_stream
->name
);
245 ret
= LTTNG_LIVE_ITERATOR_STATUS_CONTINUE
;
249 if (lttng_live_stream
->state
!= LTTNG_LIVE_STREAM_ACTIVE_NO_DATA
&&
250 lttng_live_stream
->state
!= LTTNG_LIVE_STREAM_QUIESCENT_NO_DATA
) {
253 ret
= lttng_live_get_next_index(lttng_live_msg_iter
, lttng_live_stream
, &index
);
254 if (ret
!= LTTNG_LIVE_ITERATOR_STATUS_OK
) {
258 BT_ASSERT_DBG(lttng_live_stream
->state
!= LTTNG_LIVE_STREAM_EOF
);
260 if (lttng_live_stream
->state
== LTTNG_LIVE_STREAM_QUIESCENT
) {
261 uint64_t last_inact_ts
= lttng_live_stream
->last_inactivity_ts
.value
,
262 curr_inact_ts
= lttng_live_stream
->current_inactivity_ts
;
264 if (orig_state
== LTTNG_LIVE_STREAM_QUIESCENT_NO_DATA
&& last_inact_ts
== curr_inact_ts
) {
266 * Because the stream is in the QUIESCENT_NO_DATA
267 * state, we can assert that the last_inactivity_ts was
268 * set and can be safely used in the `if` above.
270 BT_ASSERT(lttng_live_stream
->last_inactivity_ts
.is_set
);
272 ret
= LTTNG_LIVE_ITERATOR_STATUS_AGAIN
;
273 LTTNG_LIVE_LOGD_STREAM_ITER(lttng_live_stream
);
275 ret
= LTTNG_LIVE_ITERATOR_STATUS_CONTINUE
;
280 lttng_live_stream
->base_offset
= index
.offset
;
281 lttng_live_stream
->offset
= index
.offset
;
282 lttng_live_stream
->len
= index
.packet_size
/ CHAR_BIT
;
284 BT_CPPLOGD_SPEC(lttng_live_msg_iter
->logger
,
285 "Setting live stream reading info: stream-name=\"{}\", "
286 "viewer-stream-id={}, stream-base-offset={}, stream-offset={}, stream-len={}",
287 lttng_live_stream
->name
, lttng_live_stream
->viewer_stream_id
,
288 lttng_live_stream
->base_offset
, lttng_live_stream
->offset
,
289 lttng_live_stream
->len
);
292 if (ret
== LTTNG_LIVE_ITERATOR_STATUS_OK
) {
293 ret
= lttng_live_iterator_next_check_stream_state(lttng_live_stream
);
299 * Creation of the message requires the ctf trace class to be created
300 * beforehand, but the live protocol gives us all streams (including metadata)
301 * at once. So we split it in three steps: getting streams, getting metadata
302 * (which creates the ctf trace class), and then creating the per-stream
305 static enum lttng_live_iterator_status
306 lttng_live_get_session(struct lttng_live_msg_iter
*lttng_live_msg_iter
,
307 struct lttng_live_session
*session
)
309 enum lttng_live_iterator_status status
;
311 if (!session
->attached
) {
312 BT_CPPLOGD_SPEC(lttng_live_msg_iter
->logger
, "Attach to session: session-id={}",
314 enum lttng_live_viewer_status attach_status
=
315 lttng_live_session_attach(session
, lttng_live_msg_iter
->self_msg_iter
);
316 if (attach_status
!= LTTNG_LIVE_VIEWER_STATUS_OK
) {
317 if (lttng_live_graph_is_canceled(lttng_live_msg_iter
)) {
319 * Clear any causes appended in
320 * `lttng_live_attach_session()` as we want to
321 * return gracefully since the graph was
324 bt_current_thread_clear_error();
325 status
= LTTNG_LIVE_ITERATOR_STATUS_AGAIN
;
327 status
= LTTNG_LIVE_ITERATOR_STATUS_ERROR
;
328 BT_CPPLOGE_APPEND_CAUSE_SPEC(lttng_live_msg_iter
->logger
,
329 "Error attaching to LTTng live session");
335 BT_CPPLOGD_SPEC(lttng_live_msg_iter
->logger
,
336 "Updating all data streams: session-id={}, session-name=\"{}\"", session
->id
,
337 session
->session_name
);
339 status
= lttng_live_session_get_new_streams(session
, lttng_live_msg_iter
->self_msg_iter
);
341 case LTTNG_LIVE_ITERATOR_STATUS_OK
:
343 case LTTNG_LIVE_ITERATOR_STATUS_END
:
345 * We received a `_END` from the `_get_new_streams()` function,
346 * which means no more data will ever be received from the data
347 * streams of this session. But it's possible that the metadata
349 * The live protocol guarantees that we receive all the
350 * metadata needed before we receive data streams needing it.
351 * But it's possible to receive metadata NOT needed by
352 * data streams after the session was closed. For example, this
353 * could happen if a new event is registered and the session is
354 * stopped before any tracepoint for that event is actually
358 lttng_live_msg_iter
->logger
,
359 "Updating streams returned _END status. Override status to _OK in order fetch any remaining metadata:"
360 "session-id={}, session-name=\"{}\"",
361 session
->id
, session
->session_name
);
362 status
= LTTNG_LIVE_ITERATOR_STATUS_OK
;
368 BT_CPPLOGD_SPEC(lttng_live_msg_iter
->logger
,
369 "Updating metadata stream for session: session-id={}, session-name=\"{}\"",
370 session
->id
, session
->session_name
);
372 for (lttng_live_trace::UP
& trace
: session
->traces
) {
373 status
= lttng_live_metadata_update(trace
.get());
375 case LTTNG_LIVE_ITERATOR_STATUS_END
:
376 case LTTNG_LIVE_ITERATOR_STATUS_OK
:
378 case LTTNG_LIVE_ITERATOR_STATUS_CONTINUE
:
379 case LTTNG_LIVE_ITERATOR_STATUS_AGAIN
:
382 BT_CPPLOGE_APPEND_CAUSE_SPEC(lttng_live_msg_iter
->logger
,
383 "Error updating trace metadata: "
384 "stream-iter-status={}, trace-id={}",
391 * Now that we have the metadata we can initialize the downstream
394 status
= lttng_live_lazy_msg_init(session
, lttng_live_msg_iter
->self_msg_iter
);
401 lttng_live_force_new_streams_and_metadata(struct lttng_live_msg_iter
*lttng_live_msg_iter
)
403 for (const auto& session
: lttng_live_msg_iter
->sessions
) {
404 BT_CPPLOGD_SPEC(lttng_live_msg_iter
->logger
,
405 "Force marking session as needing new streams: "
408 session
->new_streams_needed
= true;
409 for (lttng_live_trace::UP
& trace
: session
->traces
) {
410 BT_CPPLOGD_SPEC(lttng_live_msg_iter
->logger
,
411 "Force marking trace metadata state as needing an update: "
412 "session-id={}, trace-id={}",
413 session
->id
, trace
->id
);
415 BT_ASSERT(trace
->metadata_stream_state
!= LTTNG_LIVE_METADATA_STREAM_STATE_CLOSED
);
417 trace
->metadata_stream_state
= LTTNG_LIVE_METADATA_STREAM_STATE_NEEDED
;
422 static enum lttng_live_iterator_status
423 lttng_live_iterator_handle_new_streams_and_metadata(struct lttng_live_msg_iter
*lttng_live_msg_iter
)
425 enum lttng_live_iterator_status status
;
426 enum lttng_live_viewer_status viewer_status
;
427 uint64_t nr_sessions_opened
= 0;
428 enum session_not_found_action sess_not_found_act
=
429 lttng_live_msg_iter
->lttng_live_comp
->params
.sess_not_found_act
;
431 BT_CPPLOGD_SPEC(lttng_live_msg_iter
->logger
,
432 "Update data and metadata of all sessions: "
433 "live-msg-iter-addr={}",
434 fmt::ptr(lttng_live_msg_iter
));
436 * In a remotely distant future, we could add a "new
437 * session" flag to the protocol, which would tell us that we
438 * need to query for new sessions even though we have sessions
441 if (lttng_live_msg_iter
->sessions
.empty()) {
442 if (sess_not_found_act
!= SESSION_NOT_FOUND_ACTION_CONTINUE
) {
444 lttng_live_msg_iter
->logger
,
445 "No session found. Exiting in accordance with the `session-not-found-action` parameter");
446 status
= LTTNG_LIVE_ITERATOR_STATUS_END
;
450 lttng_live_msg_iter
->logger
,
451 "No session found. Try creating a new one in accordance with the `session-not-found-action` parameter");
453 * Retry to create a viewer session for the requested
456 viewer_status
= lttng_live_create_viewer_session(lttng_live_msg_iter
);
457 if (viewer_status
!= LTTNG_LIVE_VIEWER_STATUS_OK
) {
458 if (viewer_status
== LTTNG_LIVE_VIEWER_STATUS_ERROR
) {
459 status
= LTTNG_LIVE_ITERATOR_STATUS_ERROR
;
460 BT_CPPLOGE_APPEND_CAUSE_SPEC(lttng_live_msg_iter
->logger
,
461 "Error creating LTTng live viewer session");
462 } else if (viewer_status
== LTTNG_LIVE_VIEWER_STATUS_INTERRUPTED
) {
463 status
= LTTNG_LIVE_ITERATOR_STATUS_AGAIN
;
472 for (const auto& session
: lttng_live_msg_iter
->sessions
) {
473 status
= lttng_live_get_session(lttng_live_msg_iter
, session
.get());
475 case LTTNG_LIVE_ITERATOR_STATUS_OK
:
476 case LTTNG_LIVE_ITERATOR_STATUS_END
:
478 * A session returned `_END`. Other sessions may still
479 * be active so we override the status and continue
486 if (!session
->closed
) {
487 nr_sessions_opened
++;
491 if (sess_not_found_act
!= SESSION_NOT_FOUND_ACTION_CONTINUE
&& nr_sessions_opened
== 0) {
492 status
= LTTNG_LIVE_ITERATOR_STATUS_END
;
494 status
= LTTNG_LIVE_ITERATOR_STATUS_OK
;
501 static enum lttng_live_iterator_status
502 emit_inactivity_message(struct lttng_live_msg_iter
*lttng_live_msg_iter
,
503 struct lttng_live_stream_iterator
*stream_iter
,
504 bt2::ConstMessage::Shared
& message
, uint64_t timestamp
)
506 BT_ASSERT(stream_iter
->trace
->clock_class
);
507 BT_CPPLOGD_SPEC(lttng_live_msg_iter
->logger
,
508 "Emitting inactivity message for stream: ctf-stream-id={}, "
509 "viewer-stream-id={}, timestamp={}",
510 stream_iter
->ctf_stream_class_id
.value
, stream_iter
->viewer_stream_id
,
513 const auto msg
= bt_message_message_iterator_inactivity_create(
514 lttng_live_msg_iter
->self_msg_iter
, stream_iter
->trace
->clock_class
, timestamp
);
517 BT_CPPLOGE_APPEND_CAUSE_SPEC(lttng_live_msg_iter
->logger
,
518 "Error emitting message iterator inactivity message");
519 return LTTNG_LIVE_ITERATOR_STATUS_ERROR
;
522 message
= bt2::ConstMessage::Shared::createWithoutRef(msg
);
523 return LTTNG_LIVE_ITERATOR_STATUS_OK
;
526 static enum lttng_live_iterator_status
lttng_live_iterator_next_handle_one_quiescent_stream(
527 struct lttng_live_msg_iter
*lttng_live_msg_iter
,
528 struct lttng_live_stream_iterator
*lttng_live_stream
, bt2::ConstMessage::Shared
& message
)
530 enum lttng_live_iterator_status ret
= LTTNG_LIVE_ITERATOR_STATUS_OK
;
532 if (lttng_live_stream
->state
!= LTTNG_LIVE_STREAM_QUIESCENT
) {
533 return LTTNG_LIVE_ITERATOR_STATUS_OK
;
537 * Check if we already sent an inactivty message downstream for this
538 * `current_inactivity_ts` value.
540 if (lttng_live_stream
->last_inactivity_ts
.is_set
&&
541 lttng_live_stream
->current_inactivity_ts
== lttng_live_stream
->last_inactivity_ts
.value
) {
542 lttng_live_stream_iterator_set_state(lttng_live_stream
,
543 LTTNG_LIVE_STREAM_QUIESCENT_NO_DATA
);
545 ret
= LTTNG_LIVE_ITERATOR_STATUS_CONTINUE
;
549 ret
= emit_inactivity_message(lttng_live_msg_iter
, lttng_live_stream
, message
,
550 lttng_live_stream
->current_inactivity_ts
);
552 lttng_live_stream
->last_inactivity_ts
.value
= lttng_live_stream
->current_inactivity_ts
;
553 lttng_live_stream
->last_inactivity_ts
.is_set
= true;
558 static int live_get_msg_ts_ns(struct lttng_live_msg_iter
*lttng_live_msg_iter
,
559 const bt_message
*msg
, int64_t last_msg_ts_ns
, int64_t *ts_ns
)
561 const bt_clock_snapshot
*clock_snapshot
= NULL
;
565 BT_ASSERT_DBG(ts_ns
);
567 BT_CPPLOGD_SPEC(lttng_live_msg_iter
->logger
,
568 "Getting message's timestamp: iter-data-addr={}, msg-addr={}, "
570 fmt::ptr(lttng_live_msg_iter
), fmt::ptr(msg
), last_msg_ts_ns
);
572 switch (bt_message_get_type(msg
)) {
573 case BT_MESSAGE_TYPE_EVENT
:
574 clock_snapshot
= bt_message_event_borrow_default_clock_snapshot_const(msg
);
576 case BT_MESSAGE_TYPE_PACKET_BEGINNING
:
577 clock_snapshot
= bt_message_packet_beginning_borrow_default_clock_snapshot_const(msg
);
579 case BT_MESSAGE_TYPE_PACKET_END
:
580 clock_snapshot
= bt_message_packet_end_borrow_default_clock_snapshot_const(msg
);
582 case BT_MESSAGE_TYPE_DISCARDED_EVENTS
:
584 bt_message_discarded_events_borrow_beginning_default_clock_snapshot_const(msg
);
586 case BT_MESSAGE_TYPE_DISCARDED_PACKETS
:
588 bt_message_discarded_packets_borrow_beginning_default_clock_snapshot_const(msg
);
590 case BT_MESSAGE_TYPE_MESSAGE_ITERATOR_INACTIVITY
:
591 clock_snapshot
= bt_message_message_iterator_inactivity_borrow_clock_snapshot_const(msg
);
594 /* All the other messages have a higher priority */
595 BT_CPPLOGD_STR_SPEC(lttng_live_msg_iter
->logger
,
596 "Message has no timestamp: using the last message timestamp.");
597 *ts_ns
= last_msg_ts_ns
;
601 ret
= bt_clock_snapshot_get_ns_from_origin(clock_snapshot
, ts_ns
);
603 BT_CPPLOGE_APPEND_CAUSE_SPEC(lttng_live_msg_iter
->logger
,
604 "Cannot get nanoseconds from Epoch of clock snapshot: "
605 "clock-snapshot-addr={}",
606 fmt::ptr(clock_snapshot
));
617 BT_CPPLOGD_SPEC(lttng_live_msg_iter
->logger
,
618 "Found message's timestamp: iter-data-addr={}, msg-addr={}, "
619 "last-msg-ts={}, ts={}",
620 fmt::ptr(lttng_live_msg_iter
), fmt::ptr(msg
), last_msg_ts_ns
, *ts_ns
);
626 static enum lttng_live_iterator_status
lttng_live_iterator_next_handle_one_active_data_stream(
627 struct lttng_live_msg_iter
*lttng_live_msg_iter
,
628 struct lttng_live_stream_iterator
*lttng_live_stream
, bt2::ConstMessage::Shared
& message
)
630 enum lttng_live_iterator_status ret
= LTTNG_LIVE_ITERATOR_STATUS_OK
;
631 enum ctf_msg_iter_status status
;
633 for (const auto& session
: lttng_live_msg_iter
->sessions
) {
634 if (session
->new_streams_needed
) {
635 BT_CPPLOGD_SPEC(lttng_live_msg_iter
->logger
,
636 "Need an update for streams: "
639 ret
= LTTNG_LIVE_ITERATOR_STATUS_CONTINUE
;
642 for (lttng_live_trace::UP
& trace
: session
->traces
) {
643 if (trace
->metadata_stream_state
== LTTNG_LIVE_METADATA_STREAM_STATE_NEEDED
) {
644 BT_CPPLOGD_SPEC(lttng_live_msg_iter
->logger
,
645 "Need an update for metadata stream: "
646 "session-id={}, trace-id={}",
647 session
->id
, trace
->id
);
648 ret
= LTTNG_LIVE_ITERATOR_STATUS_CONTINUE
;
654 if (lttng_live_stream
->state
!= LTTNG_LIVE_STREAM_ACTIVE_DATA
) {
655 ret
= LTTNG_LIVE_ITERATOR_STATUS_ERROR
;
656 BT_CPPLOGE_APPEND_CAUSE_SPEC(lttng_live_msg_iter
->logger
,
657 "Invalid state of live stream iterator"
658 "stream-iter-status={}",
659 lttng_live_stream
->state
);
663 const bt_message
*msg
;
664 status
= ctf_msg_iter_get_next_message(lttng_live_stream
->msg_iter
.get(), &msg
);
666 case CTF_MSG_ITER_STATUS_EOF
:
667 ret
= LTTNG_LIVE_ITERATOR_STATUS_END
;
669 case CTF_MSG_ITER_STATUS_OK
:
670 message
= bt2::ConstMessage::Shared::createWithoutRef(msg
);
671 ret
= LTTNG_LIVE_ITERATOR_STATUS_OK
;
673 case CTF_MSG_ITER_STATUS_AGAIN
:
675 * Continue immediately (end of packet). The next
676 * get_index may return AGAIN to delay the following
679 ret
= LTTNG_LIVE_ITERATOR_STATUS_CONTINUE
;
681 case CTF_MSG_ITER_STATUS_ERROR
:
683 ret
= LTTNG_LIVE_ITERATOR_STATUS_ERROR
;
684 BT_CPPLOGE_APPEND_CAUSE_SPEC(lttng_live_msg_iter
->logger
,
685 "CTF message iterator failed to get next message: "
686 "msg-iter={}, msg-iter-status={}",
687 fmt::ptr(lttng_live_stream
->msg_iter
), status
);
695 static enum lttng_live_iterator_status
696 lttng_live_iterator_close_stream(struct lttng_live_msg_iter
*lttng_live_msg_iter
,
697 struct lttng_live_stream_iterator
*stream_iter
,
698 bt2::ConstMessage::Shared
& curr_msg
)
700 enum lttng_live_iterator_status live_status
= LTTNG_LIVE_ITERATOR_STATUS_OK
;
702 BT_CPPLOGD_SPEC(lttng_live_msg_iter
->logger
,
703 "Closing live stream iterator: stream-name=\"{}\", "
704 "viewer-stream-id={}",
705 stream_iter
->name
, stream_iter
->viewer_stream_id
);
708 * The viewer has hung up on us so we are closing the stream. The
709 * `ctf_msg_iter` should simply realize that it needs to close the
710 * stream properly by emitting the necessary stream end message.
712 const bt_message
*msg
;
713 enum ctf_msg_iter_status status
=
714 ctf_msg_iter_get_next_message(stream_iter
->msg_iter
.get(), &msg
);
716 if (status
== CTF_MSG_ITER_STATUS_ERROR
) {
717 BT_CPPLOGE_APPEND_CAUSE_SPEC(lttng_live_msg_iter
->logger
,
718 "Error getting the next message from CTF message iterator");
719 live_status
= LTTNG_LIVE_ITERATOR_STATUS_ERROR
;
721 } else if (status
== CTF_MSG_ITER_STATUS_EOF
) {
722 BT_CPPLOGI_SPEC(lttng_live_msg_iter
->logger
,
723 "Reached the end of the live stream iterator.");
724 live_status
= LTTNG_LIVE_ITERATOR_STATUS_END
;
728 BT_ASSERT(status
== CTF_MSG_ITER_STATUS_OK
);
730 curr_msg
= bt2::ConstMessage::Shared::createWithoutRef(msg
);
738 * handle_no_data_streams()
740 * - for each ACTIVE_NO_DATA stream:
741 * - query relayd for stream data, or quiescence info.
742 * - if need metadata, get metadata, goto retry.
743 * - if new stream, get new stream as ACTIVE_NO_DATA, goto retry
744 * - if quiescent, move to QUIESCENT streams
745 * - if fetched data, move to ACTIVE_DATA streams
746 * (at this point each stream either has data, or is quiescent)
750 * handle_new_streams_and_metadata()
751 * - query relayd for known streams, add them as ACTIVE_NO_DATA
752 * - query relayd for metadata
754 * call handle_active_no_data_streams()
756 * handle_quiescent_streams()
757 * - if at least one stream is ACTIVE_DATA:
758 * - peek stream event with lowest timestamp -> next_ts
759 * - for each quiescent stream
760 * - if next_ts >= quiescent end
761 * - set state to ACTIVE_NO_DATA
763 * - for each quiescent stream
764 * - set state to ACTIVE_NO_DATA
766 * call handle_active_no_data_streams()
768 * handle_active_data_streams()
769 * - if at least one stream is ACTIVE_DATA:
770 * - get stream event with lowest timestamp from heap
771 * - make that stream event the current message.
772 * - move this stream heap position to its next event
773 * - if we need to fetch data from relayd, move
774 * stream to ACTIVE_NO_DATA.
778 * end criterion: ctrl-c on client. If relayd exits or the session
779 * closes on the relay daemon side, we keep on waiting for streams.
780 * Eventually handle --end timestamp (also an end criterion).
782 * When disconnected from relayd: try to re-connect endlessly.
784 static enum lttng_live_iterator_status
785 lttng_live_iterator_next_msg_on_stream(struct lttng_live_msg_iter
*lttng_live_msg_iter
,
786 struct lttng_live_stream_iterator
*stream_iter
,
787 bt2::ConstMessage::Shared
& curr_msg
)
789 enum lttng_live_iterator_status live_status
;
791 BT_CPPLOGD_SPEC(lttng_live_msg_iter
->logger
,
792 "Advancing live stream iterator until next message if possible: "
793 "stream-name=\"{}\", viewer-stream-id={}",
794 stream_iter
->name
, stream_iter
->viewer_stream_id
);
796 if (stream_iter
->has_stream_hung_up
) {
798 * The stream has hung up and the stream was properly closed
799 * during the last call to the current function. Return _END
800 * status now so that this stream iterator is removed for the
801 * stream iterator list.
803 live_status
= LTTNG_LIVE_ITERATOR_STATUS_END
;
808 LTTNG_LIVE_LOGD_STREAM_ITER(stream_iter
);
811 * Make sure we have the most recent metadata and possibly some new
814 live_status
= lttng_live_iterator_handle_new_streams_and_metadata(lttng_live_msg_iter
);
815 if (live_status
!= LTTNG_LIVE_ITERATOR_STATUS_OK
) {
820 lttng_live_iterator_next_handle_one_no_data_stream(lttng_live_msg_iter
, stream_iter
);
821 if (live_status
!= LTTNG_LIVE_ITERATOR_STATUS_OK
) {
822 if (live_status
== LTTNG_LIVE_ITERATOR_STATUS_END
) {
824 * We overwrite `live_status` since `curr_msg` is
825 * likely set to a valid message in this function.
828 lttng_live_iterator_close_stream(lttng_live_msg_iter
, stream_iter
, curr_msg
);
833 live_status
= lttng_live_iterator_next_handle_one_quiescent_stream(lttng_live_msg_iter
,
834 stream_iter
, curr_msg
);
835 if (live_status
!= LTTNG_LIVE_ITERATOR_STATUS_OK
) {
836 BT_ASSERT(!curr_msg
);
842 live_status
= lttng_live_iterator_next_handle_one_active_data_stream(lttng_live_msg_iter
,
843 stream_iter
, curr_msg
);
844 if (live_status
!= LTTNG_LIVE_ITERATOR_STATUS_OK
) {
845 BT_ASSERT(!curr_msg
);
849 if (live_status
== LTTNG_LIVE_ITERATOR_STATUS_CONTINUE
) {
851 lttng_live_msg_iter
->logger
,
852 "Ask the relay daemon for an updated view of the data and metadata streams");
856 BT_CPPLOGD_SPEC(lttng_live_msg_iter
->logger
,
857 "Returning from advancing live stream iterator: status={}, "
858 "stream-name=\"{}\", viewer-stream-id={}",
859 live_status
, stream_iter
->name
, stream_iter
->viewer_stream_id
);
864 static bool is_discarded_packet_or_event_message(const bt2::ConstMessage msg
)
866 return msg
.type() == bt2::MessageType::DiscardedEvents
||
867 msg
.type() == bt2::MessageType::DiscardedPackets
;
870 static enum lttng_live_iterator_status
871 adjust_discarded_packets_message(bt_self_message_iterator
*iter
, const bt_stream
*stream
,
872 const bt_message
*msg_in
, bt2::ConstMessage::Shared
& msg_out
,
873 uint64_t new_begin_ts
)
875 enum bt_property_availability availability
;
876 const bt_clock_snapshot
*clock_snapshot
;
880 clock_snapshot
= bt_message_discarded_packets_borrow_end_default_clock_snapshot_const(msg_in
);
881 end_ts
= bt_clock_snapshot_get_value(clock_snapshot
);
883 availability
= bt_message_discarded_packets_get_count(msg_in
, &count
);
884 BT_ASSERT_DBG(availability
== BT_PROPERTY_AVAILABILITY_AVAILABLE
);
886 const auto msg
= bt_message_discarded_packets_create_with_default_clock_snapshots(
887 iter
, stream
, new_begin_ts
, end_ts
);
890 return LTTNG_LIVE_ITERATOR_STATUS_NOMEM
;
893 bt_message_discarded_packets_set_count(msg
, count
);
894 msg_out
= bt2::ConstMessage::Shared::createWithoutRef(msg
);
895 return LTTNG_LIVE_ITERATOR_STATUS_OK
;
898 static enum lttng_live_iterator_status
899 adjust_discarded_events_message(bt_self_message_iterator
*iter
, const bt_stream
*stream
,
900 const bt_message
*msg_in
, bt2::ConstMessage::Shared
& msg_out
,
901 uint64_t new_begin_ts
)
903 enum bt_property_availability availability
;
904 const bt_clock_snapshot
*clock_snapshot
;
908 clock_snapshot
= bt_message_discarded_events_borrow_end_default_clock_snapshot_const(msg_in
);
909 end_ts
= bt_clock_snapshot_get_value(clock_snapshot
);
911 availability
= bt_message_discarded_events_get_count(msg_in
, &count
);
912 BT_ASSERT_DBG(availability
== BT_PROPERTY_AVAILABILITY_AVAILABLE
);
914 const auto msg
= bt_message_discarded_events_create_with_default_clock_snapshots(
915 iter
, stream
, new_begin_ts
, end_ts
);
918 return LTTNG_LIVE_ITERATOR_STATUS_NOMEM
;
921 bt_message_discarded_events_set_count(msg
, count
);
922 msg_out
= bt2::ConstMessage::Shared::createWithoutRef(msg
);
923 return LTTNG_LIVE_ITERATOR_STATUS_OK
;
926 static enum lttng_live_iterator_status
927 handle_late_message(struct lttng_live_msg_iter
*lttng_live_msg_iter
,
928 struct lttng_live_stream_iterator
*stream_iter
, int64_t late_msg_ts_ns
,
929 const bt2::ConstMessage
& late_msg
)
931 const bt_clock_class
*clock_class
;
932 const bt_stream_class
*stream_class
;
933 enum bt_clock_class_cycles_to_ns_from_origin_status ts_ns_status
;
934 int64_t last_inactivity_ts_ns
;
935 enum lttng_live_iterator_status stream_iter_status
= LTTNG_LIVE_ITERATOR_STATUS_OK
;
936 enum lttng_live_iterator_status adjust_status
;
937 bt2::ConstMessage::Shared adjusted_message
;
940 * The timestamp of the current message is before the last message sent
941 * by this component. We CANNOT send it as is.
943 * The only expected scenario in which that could happen is the
944 * following, everything else is a bug in this component, relay daemon,
947 * Expected scenario: The CTF message iterator emitted discarded
948 * packets and discarded events with synthesized beginning and end
949 * timestamps from the bounds of the last known packet and the newly
950 * decoded packet header. The CTF message iterator is not aware of
951 * stream inactivity beacons. Hence, we have to adjust the beginning
952 * timestamp of those types of messages if a stream signalled its
953 * inactivity up until _after_ the last known packet's beginning
956 * Otherwise, the monotonicity guarantee of message timestamps would
959 * In short, the only scenario in which it's okay and fixable to
960 * received a late message is when:
961 * 1. the late message is a discarded packets or discarded events
963 * 2. this stream produced an inactivity message downstream, and
964 * 3. the timestamp of the late message is within the inactivity
965 * timespan we sent downstream through the inactivity message.
968 BT_CPPLOGD_SPEC(lttng_live_msg_iter
->logger
,
969 "Handling late message on live stream iterator: "
970 "stream-name=\"{}\", viewer-stream-id={}",
971 stream_iter
->name
, stream_iter
->viewer_stream_id
);
973 if (!stream_iter
->last_inactivity_ts
.is_set
) {
974 BT_CPPLOGE_APPEND_CAUSE_SPEC(lttng_live_msg_iter
->logger
,
975 "Invalid live stream state: "
976 "have a late message when no inactivity message "
977 "was ever sent for that stream.");
978 stream_iter_status
= LTTNG_LIVE_ITERATOR_STATUS_ERROR
;
982 if (!is_discarded_packet_or_event_message(late_msg
)) {
983 BT_CPPLOGE_APPEND_CAUSE_SPEC(lttng_live_msg_iter
->logger
,
984 "Invalid live stream state: "
985 "have a late message that is not a packet discarded or "
986 "event discarded message: late-msg-type={}",
988 stream_iter_status
= LTTNG_LIVE_ITERATOR_STATUS_ERROR
;
992 stream_class
= bt_stream_borrow_class_const(stream_iter
->stream
->libObjPtr());
993 clock_class
= bt_stream_class_borrow_default_clock_class_const(stream_class
);
995 ts_ns_status
= bt_clock_class_cycles_to_ns_from_origin(
996 clock_class
, stream_iter
->last_inactivity_ts
.value
, &last_inactivity_ts_ns
);
997 if (ts_ns_status
!= BT_CLOCK_CLASS_CYCLES_TO_NS_FROM_ORIGIN_STATUS_OK
) {
998 BT_CPPLOGE_APPEND_CAUSE_SPEC(lttng_live_msg_iter
->logger
,
999 "Error converting last "
1000 "inactivity message timestamp to nanoseconds");
1001 stream_iter_status
= LTTNG_LIVE_ITERATOR_STATUS_ERROR
;
1005 if (last_inactivity_ts_ns
<= late_msg_ts_ns
) {
1006 BT_CPPLOGE_APPEND_CAUSE_SPEC(lttng_live_msg_iter
->logger
,
1007 "Invalid live stream state: "
1008 "have a late message that is none included in a stream "
1009 "inactivity timespan: last-inactivity-ts-ns={}, "
1010 "late-msg-ts-ns={}",
1011 last_inactivity_ts_ns
, late_msg_ts_ns
);
1012 stream_iter_status
= LTTNG_LIVE_ITERATOR_STATUS_ERROR
;
1017 * We now know that it's okay for this message to be late, we can now
1018 * adjust its timestamp to ensure monotonicity.
1020 BT_CPPLOGD_SPEC(lttng_live_msg_iter
->logger
,
1021 "Adjusting the timestamp of late message: late-msg-type={}, "
1023 late_msg
.type(), stream_iter
->last_inactivity_ts
.value
);
1024 switch (late_msg
.type()) {
1025 case bt2::MessageType::DiscardedEvents
:
1026 adjust_status
= adjust_discarded_events_message(
1027 lttng_live_msg_iter
->self_msg_iter
, stream_iter
->stream
->libObjPtr(),
1028 late_msg
.libObjPtr(), adjusted_message
, stream_iter
->last_inactivity_ts
.value
);
1030 case bt2::MessageType::DiscardedPackets
:
1031 adjust_status
= adjust_discarded_packets_message(
1032 lttng_live_msg_iter
->self_msg_iter
, stream_iter
->stream
->libObjPtr(),
1033 late_msg
.libObjPtr(), adjusted_message
, stream_iter
->last_inactivity_ts
.value
);
1039 if (adjust_status
!= LTTNG_LIVE_ITERATOR_STATUS_OK
) {
1040 stream_iter_status
= adjust_status
;
1044 BT_ASSERT_DBG(adjusted_message
);
1045 stream_iter
->current_msg
= adjusted_message
;
1046 stream_iter
->current_msg_ts_ns
= last_inactivity_ts_ns
;
1049 return stream_iter_status
;
1052 static enum lttng_live_iterator_status
1053 next_stream_iterator_for_trace(struct lttng_live_msg_iter
*lttng_live_msg_iter
,
1054 struct lttng_live_trace
*live_trace
,
1055 struct lttng_live_stream_iterator
**youngest_trace_stream_iter
)
1057 struct lttng_live_stream_iterator
*youngest_candidate_stream_iter
= NULL
;
1058 enum lttng_live_iterator_status stream_iter_status
;
1059 int64_t youngest_candidate_msg_ts
= INT64_MAX
;
1060 uint64_t stream_iter_idx
;
1062 BT_ASSERT_DBG(live_trace
);
1064 BT_CPPLOGD_SPEC(lttng_live_msg_iter
->logger
,
1065 "Finding the next stream iterator for trace: "
1069 * Update the current message of every stream iterators of this trace.
1070 * The current msg of every stream must have a timestamp equal or
1071 * larger than the last message returned by this iterator. We must
1072 * ensure monotonicity.
1074 stream_iter_idx
= 0;
1075 while (stream_iter_idx
< live_trace
->stream_iterators
.size()) {
1076 bool stream_iter_is_ended
= false;
1077 lttng_live_stream_iterator
*stream_iter
=
1078 live_trace
->stream_iterators
[stream_iter_idx
].get();
1081 * If there is no current message for this stream, go fetch
1084 while (!stream_iter
->current_msg
) {
1085 bt2::ConstMessage::Shared msg
;
1086 int64_t curr_msg_ts_ns
= INT64_MAX
;
1088 stream_iter_status
=
1089 lttng_live_iterator_next_msg_on_stream(lttng_live_msg_iter
, stream_iter
, msg
);
1091 if (stream_iter_status
== LTTNG_LIVE_ITERATOR_STATUS_END
) {
1092 stream_iter_is_ended
= true;
1096 if (stream_iter_status
!= LTTNG_LIVE_ITERATOR_STATUS_OK
) {
1102 BT_CPPLOGD_SPEC(lttng_live_msg_iter
->logger
,
1103 "Live stream iterator returned message: msg-type={}, "
1104 "stream-name=\"{}\", viewer-stream-id={}",
1105 msg
->type(), stream_iter
->name
, stream_iter
->viewer_stream_id
);
1108 * Get the timestamp in nanoseconds from origin of this
1111 live_get_msg_ts_ns(lttng_live_msg_iter
, msg
->libObjPtr(),
1112 lttng_live_msg_iter
->last_msg_ts_ns
, &curr_msg_ts_ns
);
1115 * Check if the message of the current live stream
1116 * iterator occurred at the exact same time or after the
1117 * last message returned by this component's message
1118 * iterator. If not, we need to handle it with care.
1120 if (curr_msg_ts_ns
>= lttng_live_msg_iter
->last_msg_ts_ns
) {
1121 stream_iter
->current_msg
= std::move(msg
);
1122 stream_iter
->current_msg_ts_ns
= curr_msg_ts_ns
;
1125 * We received a message from the past. This
1126 * may be fixable but it can also be an error.
1128 stream_iter_status
=
1129 handle_late_message(lttng_live_msg_iter
, stream_iter
, curr_msg_ts_ns
, *msg
);
1130 if (stream_iter_status
!= LTTNG_LIVE_ITERATOR_STATUS_OK
) {
1131 BT_CPPLOGE_APPEND_CAUSE_SPEC(lttng_live_msg_iter
->logger
,
1132 "Late message could not be handled correctly: "
1133 "lttng-live-msg-iter-addr={}, "
1134 "stream-name=\"{}\", "
1135 "curr-msg-ts={}, last-msg-ts={}",
1136 fmt::ptr(lttng_live_msg_iter
), stream_iter
->name
,
1138 lttng_live_msg_iter
->last_msg_ts_ns
);
1139 stream_iter_status
= LTTNG_LIVE_ITERATOR_STATUS_ERROR
;
1145 BT_ASSERT_DBG(stream_iter
!= youngest_candidate_stream_iter
);
1147 if (!stream_iter_is_ended
) {
1148 if (G_UNLIKELY(youngest_candidate_stream_iter
== NULL
) ||
1149 stream_iter
->current_msg_ts_ns
< youngest_candidate_msg_ts
) {
1151 * Update the current best candidate message
1152 * for the stream iterator of this live trace
1153 * to be forwarded downstream.
1155 youngest_candidate_msg_ts
= stream_iter
->current_msg_ts_ns
;
1156 youngest_candidate_stream_iter
= stream_iter
;
1157 } else if (stream_iter
->current_msg_ts_ns
== youngest_candidate_msg_ts
) {
1159 * Order the messages in an arbitrary but
1160 * deterministic way.
1162 BT_ASSERT_DBG(stream_iter
!= youngest_candidate_stream_iter
);
1163 int ret
= common_muxing_compare_messages(
1164 stream_iter
->current_msg
->libObjPtr(),
1165 youngest_candidate_stream_iter
->current_msg
->libObjPtr());
1168 * The `youngest_candidate_stream_iter->current_msg`
1169 * should go first. Update the next
1170 * iterator and the current timestamp.
1172 youngest_candidate_msg_ts
= stream_iter
->current_msg_ts_ns
;
1173 youngest_candidate_stream_iter
= stream_iter
;
1174 } else if (ret
== 0) {
1176 * Unable to pick which one should go
1180 lttng_live_msg_iter
->logger
,
1181 "Cannot deterministically pick next live stream message iterator because they have identical next messages: "
1182 "stream-iter-addr={}"
1183 "stream-iter-addr={}",
1184 fmt::ptr(stream_iter
), fmt::ptr(youngest_candidate_stream_iter
));
1191 * The live stream iterator has ended. That
1192 * iterator is removed from the array, but
1193 * there is no need to increment
1194 * stream_iter_idx as
1195 * g_ptr_array_remove_index_fast replaces the
1196 * removed element with the array's last
1199 bt2c::vectorFastRemove(live_trace
->stream_iterators
, stream_iter_idx
);
1203 if (youngest_candidate_stream_iter
) {
1204 *youngest_trace_stream_iter
= youngest_candidate_stream_iter
;
1205 stream_iter_status
= LTTNG_LIVE_ITERATOR_STATUS_OK
;
1208 * The only case where we don't have a candidate for this trace
1209 * is if we reached the end of all the iterators.
1211 BT_ASSERT(live_trace
->stream_iterators
.empty());
1212 stream_iter_status
= LTTNG_LIVE_ITERATOR_STATUS_END
;
1216 return stream_iter_status
;
1219 static enum lttng_live_iterator_status
1220 next_stream_iterator_for_session(struct lttng_live_msg_iter
*lttng_live_msg_iter
,
1221 struct lttng_live_session
*session
,
1222 struct lttng_live_stream_iterator
**youngest_session_stream_iter
)
1224 enum lttng_live_iterator_status stream_iter_status
;
1225 uint64_t trace_idx
= 0;
1226 int64_t youngest_candidate_msg_ts
= INT64_MAX
;
1227 struct lttng_live_stream_iterator
*youngest_candidate_stream_iter
= NULL
;
1229 BT_CPPLOGD_SPEC(lttng_live_msg_iter
->logger
,
1230 "Finding the next stream iterator for session: "
1234 * Make sure we are attached to the session and look for new streams
1237 stream_iter_status
= lttng_live_get_session(lttng_live_msg_iter
, session
);
1238 if (stream_iter_status
!= LTTNG_LIVE_ITERATOR_STATUS_OK
&&
1239 stream_iter_status
!= LTTNG_LIVE_ITERATOR_STATUS_CONTINUE
&&
1240 stream_iter_status
!= LTTNG_LIVE_ITERATOR_STATUS_END
) {
1244 while (trace_idx
< session
->traces
.size()) {
1245 bool trace_is_ended
= false;
1246 struct lttng_live_stream_iterator
*stream_iter
;
1247 lttng_live_trace
*trace
= session
->traces
[trace_idx
].get();
1249 stream_iter_status
=
1250 next_stream_iterator_for_trace(lttng_live_msg_iter
, trace
, &stream_iter
);
1251 if (stream_iter_status
== LTTNG_LIVE_ITERATOR_STATUS_END
) {
1253 * All the live stream iterators for this trace are
1254 * ENDed. Remove the trace from this session.
1256 trace_is_ended
= true;
1257 } else if (stream_iter_status
!= LTTNG_LIVE_ITERATOR_STATUS_OK
) {
1261 if (!trace_is_ended
) {
1262 BT_ASSERT_DBG(stream_iter
);
1264 if (G_UNLIKELY(youngest_candidate_stream_iter
== NULL
) ||
1265 stream_iter
->current_msg_ts_ns
< youngest_candidate_msg_ts
) {
1266 youngest_candidate_msg_ts
= stream_iter
->current_msg_ts_ns
;
1267 youngest_candidate_stream_iter
= stream_iter
;
1268 } else if (stream_iter
->current_msg_ts_ns
== youngest_candidate_msg_ts
) {
1270 * Order the messages in an arbitrary but
1271 * deterministic way.
1273 int ret
= common_muxing_compare_messages(
1274 stream_iter
->current_msg
->libObjPtr(),
1275 youngest_candidate_stream_iter
->current_msg
->libObjPtr());
1278 * The `youngest_candidate_stream_iter->current_msg`
1279 * should go first. Update the next iterator
1280 * and the current timestamp.
1282 youngest_candidate_msg_ts
= stream_iter
->current_msg_ts_ns
;
1283 youngest_candidate_stream_iter
= stream_iter
;
1284 } else if (ret
== 0) {
1285 /* Unable to pick which one should go first. */
1287 lttng_live_msg_iter
->logger
,
1288 "Cannot deterministically pick next live stream message iterator because they have identical next messages: "
1289 "stream-iter-addr={}"
1290 "youngest-candidate-stream-iter-addr={}",
1291 fmt::ptr(stream_iter
), fmt::ptr(youngest_candidate_stream_iter
));
1297 * trace_idx is not incremented since
1298 * vectorFastRemove replaces the
1299 * element at trace_idx with the array's last element.
1301 bt2c::vectorFastRemove(session
->traces
, trace_idx
);
1304 if (youngest_candidate_stream_iter
) {
1305 *youngest_session_stream_iter
= youngest_candidate_stream_iter
;
1306 stream_iter_status
= LTTNG_LIVE_ITERATOR_STATUS_OK
;
1309 * The only cases where we don't have a candidate for this
1311 * 1. if we reached the end of all the iterators of all the
1312 * traces of this session,
1313 * 2. if we never had live stream iterator in the first place.
1315 * In either cases, we return END.
1317 BT_ASSERT(session
->traces
.empty());
1318 stream_iter_status
= LTTNG_LIVE_ITERATOR_STATUS_END
;
1321 return stream_iter_status
;
1324 static inline void put_messages(bt_message_array_const msgs
, uint64_t count
)
1328 for (i
= 0; i
< count
; i
++) {
1329 BT_MESSAGE_PUT_REF_AND_RESET(msgs
[i
]);
1333 bt_message_iterator_class_next_method_status
1334 lttng_live_msg_iter_next(bt_self_message_iterator
*self_msg_it
, bt_message_array_const msgs
,
1335 uint64_t capacity
, uint64_t *count
)
1338 bt_message_iterator_class_next_method_status status
;
1339 enum lttng_live_viewer_status viewer_status
;
1340 struct lttng_live_msg_iter
*lttng_live_msg_iter
=
1341 (struct lttng_live_msg_iter
*) bt_self_message_iterator_get_data(self_msg_it
);
1342 struct lttng_live_component
*lttng_live
= lttng_live_msg_iter
->lttng_live_comp
;
1343 enum lttng_live_iterator_status stream_iter_status
;
1347 BT_ASSERT_DBG(lttng_live_msg_iter
);
1349 if (G_UNLIKELY(lttng_live_msg_iter
->was_interrupted
)) {
1351 * The iterator was interrupted in a previous call to the
1352 * `_next()` method. We currently do not support generating
1353 * messages after such event. The babeltrace2 CLI should never
1354 * be running the graph after being interrupted. So this check
1355 * is to prevent other graph users from using this live
1356 * iterator in an messed up internal state.
1358 status
= BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_ERROR
;
1359 BT_CPPLOGE_APPEND_CAUSE_SPEC(
1360 lttng_live_msg_iter
->logger
,
1361 "Message iterator was interrupted during a previous call to the `next()` and currently does not support continuing after such event.");
1366 * Clear all the invalid message reference that might be left over in
1369 memset(msgs
, 0, capacity
* sizeof(*msgs
));
1372 * If no session are exposed on the relay found at the url provided by
1373 * the user, session count will be 0. In this case, we return status
1374 * end to return gracefully.
1376 if (lttng_live_msg_iter
->sessions
.empty()) {
1377 if (lttng_live
->params
.sess_not_found_act
!= SESSION_NOT_FOUND_ACTION_CONTINUE
) {
1378 status
= BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_END
;
1382 * The are no more active session for this session
1383 * name. Retry to create a viewer session for the
1384 * requested session name.
1386 viewer_status
= lttng_live_create_viewer_session(lttng_live_msg_iter
);
1387 if (viewer_status
!= LTTNG_LIVE_VIEWER_STATUS_OK
) {
1388 if (viewer_status
== LTTNG_LIVE_VIEWER_STATUS_ERROR
) {
1389 status
= BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_ERROR
;
1390 BT_CPPLOGE_APPEND_CAUSE_SPEC(lttng_live_msg_iter
->logger
,
1391 "Error creating LTTng live viewer session");
1392 } else if (viewer_status
== LTTNG_LIVE_VIEWER_STATUS_INTERRUPTED
) {
1393 status
= BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_AGAIN
;
1402 if (lttng_live_msg_iter
->active_stream_iter
== 0) {
1403 lttng_live_force_new_streams_and_metadata(lttng_live_msg_iter
);
1407 * Here the muxing of message is done.
1409 * We need to iterate over all the streams of all the traces of all the
1410 * viewer sessions in order to get the message with the smallest
1411 * timestamp. In this case, a session is a viewer session and there is
1412 * one viewer session per consumer daemon. (UST 32bit, UST 64bit and/or
1413 * kernel). Each viewer session can have multiple traces, for example,
1414 * 64bit UST viewer sessions could have multiple per-pid traces.
1416 * We iterate over the streams of each traces to update and see what is
1417 * their next message's timestamp. From those timestamps, we select the
1418 * message with the smallest timestamp as the best candidate message
1419 * for that trace and do the same thing across all the sessions.
1421 * We then compare the timestamp of best candidate message of all the
1422 * sessions to pick the message with the smallest timestamp and we
1425 while (*count
< capacity
) {
1426 struct lttng_live_stream_iterator
*youngest_stream_iter
= NULL
,
1427 *candidate_stream_iter
= NULL
;
1428 int64_t youngest_msg_ts_ns
= INT64_MAX
;
1430 uint64_t session_idx
= 0;
1431 while (session_idx
< lttng_live_msg_iter
->sessions
.size()) {
1432 lttng_live_session
*session
= lttng_live_msg_iter
->sessions
[session_idx
].get();
1434 /* Find the best candidate message to send downstream. */
1435 stream_iter_status
= next_stream_iterator_for_session(lttng_live_msg_iter
, session
,
1436 &candidate_stream_iter
);
1438 /* If we receive an END status, it means that either:
1439 * - Those traces never had active streams (UST with no
1440 * data produced yet),
1441 * - All live stream iterators have ENDed.
1443 if (stream_iter_status
== LTTNG_LIVE_ITERATOR_STATUS_END
) {
1444 if (session
->closed
&& session
->traces
.empty()) {
1446 * Remove the session from the list.
1447 * session_idx is not modified since
1448 * g_ptr_array_remove_index_fast
1449 * replaces the the removed element with
1450 * the array's last element.
1452 bt2c::vectorFastRemove(lttng_live_msg_iter
->sessions
, session_idx
);
1459 if (stream_iter_status
!= LTTNG_LIVE_ITERATOR_STATUS_OK
) {
1463 if (G_UNLIKELY(youngest_stream_iter
== NULL
) ||
1464 candidate_stream_iter
->current_msg_ts_ns
< youngest_msg_ts_ns
) {
1465 youngest_msg_ts_ns
= candidate_stream_iter
->current_msg_ts_ns
;
1466 youngest_stream_iter
= candidate_stream_iter
;
1467 } else if (candidate_stream_iter
->current_msg_ts_ns
== youngest_msg_ts_ns
) {
1469 * The currently selected message to be sent
1470 * downstream next has the exact same timestamp
1471 * that of the current candidate message. We
1472 * must break the tie in a predictable manner.
1474 BT_CPPLOGD_STR_SPEC(
1475 lttng_live_msg_iter
->logger
,
1476 "Two of the next message candidates have the same timestamps, pick one deterministically.");
1478 * Order the messages in an arbitrary but
1479 * deterministic way.
1481 int ret
= common_muxing_compare_messages(
1482 candidate_stream_iter
->current_msg
->libObjPtr(),
1483 youngest_stream_iter
->current_msg
->libObjPtr());
1486 * The `candidate_stream_iter->current_msg`
1487 * should go first. Update the next
1488 * iterator and the current timestamp.
1490 youngest_msg_ts_ns
= candidate_stream_iter
->current_msg_ts_ns
;
1491 youngest_stream_iter
= candidate_stream_iter
;
1492 } else if (ret
== 0) {
1493 /* Unable to pick which one should go first. */
1495 lttng_live_msg_iter
->logger
,
1496 "Cannot deterministically pick next live stream message iterator because they have identical next messages: "
1497 "next-stream-iter-addr={}"
1498 "candidate-stream-iter-addr={}",
1499 fmt::ptr(youngest_stream_iter
), fmt::ptr(candidate_stream_iter
));
1506 if (!youngest_stream_iter
) {
1507 stream_iter_status
= LTTNG_LIVE_ITERATOR_STATUS_AGAIN
;
1511 BT_ASSERT_DBG(youngest_stream_iter
->current_msg
);
1512 /* Ensure monotonicity. */
1513 BT_ASSERT_DBG(lttng_live_msg_iter
->last_msg_ts_ns
<=
1514 youngest_stream_iter
->current_msg_ts_ns
);
1517 * Insert the next message to the message batch. This will set
1518 * stream iterator current message to NULL so that next time
1519 * we fetch the next message of that stream iterator
1521 msgs
[*count
] = youngest_stream_iter
->current_msg
.release().libObjPtr();
1524 /* Update the last timestamp in nanoseconds sent downstream. */
1525 lttng_live_msg_iter
->last_msg_ts_ns
= youngest_msg_ts_ns
;
1526 youngest_stream_iter
->current_msg_ts_ns
= INT64_MAX
;
1528 stream_iter_status
= LTTNG_LIVE_ITERATOR_STATUS_OK
;
1532 switch (stream_iter_status
) {
1533 case LTTNG_LIVE_ITERATOR_STATUS_OK
:
1534 case LTTNG_LIVE_ITERATOR_STATUS_AGAIN
:
1536 * If we gathered messages, return _OK even if the graph was
1537 * interrupted. This allows for the components downstream to at
1538 * least get the those messages. If the graph was indeed
1539 * interrupted there should not be another _next() call as the
1540 * application will tear down the graph. This component class
1541 * doesn't support restarting after an interruption.
1544 status
= BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_OK
;
1546 status
= BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_AGAIN
;
1549 case LTTNG_LIVE_ITERATOR_STATUS_END
:
1550 status
= BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_END
;
1552 case LTTNG_LIVE_ITERATOR_STATUS_NOMEM
:
1553 BT_CPPLOGE_APPEND_CAUSE_SPEC(lttng_live_msg_iter
->logger
,
1554 "Memory error preparing the next batch of messages: "
1555 "live-iter-status={}",
1556 stream_iter_status
);
1557 status
= BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_MEMORY_ERROR
;
1559 case LTTNG_LIVE_ITERATOR_STATUS_ERROR
:
1560 case LTTNG_LIVE_ITERATOR_STATUS_INVAL
:
1561 case LTTNG_LIVE_ITERATOR_STATUS_UNSUPPORTED
:
1562 BT_CPPLOGE_APPEND_CAUSE_SPEC(lttng_live_msg_iter
->logger
,
1563 "Error preparing the next batch of messages: "
1564 "live-iter-status={}",
1565 stream_iter_status
);
1567 status
= BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_ERROR
;
1568 /* Put all existing messages on error. */
1569 put_messages(msgs
, *count
);
1577 } catch (const std::bad_alloc
&) {
1578 return BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_MEMORY_ERROR
;
1579 } catch (const bt2::Error
&) {
1580 return BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_ERROR
;
1584 static struct lttng_live_msg_iter
*
1585 lttng_live_msg_iter_create(struct lttng_live_component
*lttng_live_comp
,
1586 bt_self_message_iterator
*self_msg_it
)
1588 lttng_live_msg_iter
*msg_iter
= new lttng_live_msg_iter
{lttng_live_comp
->logger
};
1589 msg_iter
->self_comp
= lttng_live_comp
->self_comp
;
1590 msg_iter
->lttng_live_comp
= lttng_live_comp
;
1591 msg_iter
->self_msg_iter
= self_msg_it
;
1593 msg_iter
->active_stream_iter
= 0;
1594 msg_iter
->last_msg_ts_ns
= INT64_MIN
;
1595 msg_iter
->was_interrupted
= false;
1600 bt_message_iterator_class_initialize_method_status
1601 lttng_live_msg_iter_init(bt_self_message_iterator
*self_msg_it
,
1602 bt_self_message_iterator_configuration
*, bt_self_component_port_output
*)
1605 bt_message_iterator_class_initialize_method_status status
;
1606 struct lttng_live_component
*lttng_live
;
1607 struct lttng_live_msg_iter
*lttng_live_msg_iter
;
1608 enum lttng_live_viewer_status viewer_status
;
1609 bt_self_component
*self_comp
= bt_self_message_iterator_borrow_component(self_msg_it
);
1611 lttng_live
= (lttng_live_component
*) bt_self_component_get_data(self_comp
);
1613 /* There can be only one downstream iterator at the same time. */
1614 BT_ASSERT(!lttng_live
->has_msg_iter
);
1615 lttng_live
->has_msg_iter
= true;
1617 lttng_live_msg_iter
= lttng_live_msg_iter_create(lttng_live
, self_msg_it
);
1618 if (!lttng_live_msg_iter
) {
1619 BT_CPPLOGE_APPEND_CAUSE_SPEC(lttng_live
->logger
,
1620 "Failed to create lttng_live_msg_iter");
1621 status
= BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_MEMORY_ERROR
;
1625 viewer_status
= live_viewer_connection_create(
1626 lttng_live
->params
.url
.c_str(), false, lttng_live_msg_iter
, lttng_live_msg_iter
->logger
,
1627 <tng_live_msg_iter
->viewer_connection
);
1628 if (viewer_status
!= LTTNG_LIVE_VIEWER_STATUS_OK
) {
1629 if (viewer_status
== LTTNG_LIVE_VIEWER_STATUS_ERROR
) {
1630 BT_CPPLOGE_APPEND_CAUSE_SPEC(lttng_live_msg_iter
->logger
,
1631 "Failed to create viewer connection");
1632 } else if (viewer_status
== LTTNG_LIVE_VIEWER_STATUS_INTERRUPTED
) {
1634 * Interruption in the _iter_init() method is not
1635 * supported. Return an error.
1637 BT_CPPLOGE_APPEND_CAUSE_SPEC(lttng_live_msg_iter
->logger
,
1638 "Interrupted while creating viewer connection");
1641 status
= BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_ERROR
;
1645 viewer_status
= lttng_live_create_viewer_session(lttng_live_msg_iter
);
1646 if (viewer_status
!= LTTNG_LIVE_VIEWER_STATUS_OK
) {
1647 if (viewer_status
== LTTNG_LIVE_VIEWER_STATUS_ERROR
) {
1648 BT_CPPLOGE_APPEND_CAUSE_SPEC(lttng_live_msg_iter
->logger
,
1649 "Failed to create viewer session");
1650 } else if (viewer_status
== LTTNG_LIVE_VIEWER_STATUS_INTERRUPTED
) {
1652 * Interruption in the _iter_init() method is not
1653 * supported. Return an error.
1655 BT_CPPLOGE_APPEND_CAUSE_SPEC(lttng_live_msg_iter
->logger
,
1656 "Interrupted when creating viewer session");
1659 status
= BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_ERROR
;
1663 if (lttng_live_msg_iter
->sessions
.empty()) {
1664 switch (lttng_live
->params
.sess_not_found_act
) {
1665 case SESSION_NOT_FOUND_ACTION_CONTINUE
:
1667 lttng_live_msg_iter
->logger
,
1668 "Unable to connect to the requested live viewer session. "
1669 "Keep trying to connect because of {}=\"{}\" component parameter: url=\"{}\"",
1670 SESS_NOT_FOUND_ACTION_PARAM
, SESS_NOT_FOUND_ACTION_CONTINUE_STR
,
1671 lttng_live
->params
.url
);
1673 case SESSION_NOT_FOUND_ACTION_FAIL
:
1674 BT_CPPLOGE_APPEND_CAUSE_SPEC(
1675 lttng_live_msg_iter
->logger
,
1676 "Unable to connect to the requested live viewer session. "
1677 "Fail the message iterator initialization because of {}=\"{}\" "
1678 "component parameter: url =\"{}\"",
1679 SESS_NOT_FOUND_ACTION_PARAM
, SESS_NOT_FOUND_ACTION_FAIL_STR
,
1680 lttng_live
->params
.url
);
1681 status
= BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_ERROR
;
1683 case SESSION_NOT_FOUND_ACTION_END
:
1684 BT_CPPLOGI_SPEC(lttng_live_msg_iter
->logger
,
1685 "Unable to connect to the requested live viewer session. "
1686 "End gracefully at the first _next() call because of {}=\"{}\""
1687 " component parameter: url=\"{}\"",
1688 SESS_NOT_FOUND_ACTION_PARAM
, SESS_NOT_FOUND_ACTION_END_STR
,
1689 lttng_live
->params
.url
);
1696 bt_self_message_iterator_set_data(self_msg_it
, lttng_live_msg_iter
);
1697 status
= BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_OK
;
1701 lttng_live_msg_iter_destroy(lttng_live_msg_iter
);
1704 } catch (const std::bad_alloc
&) {
1705 return BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_MEMORY_ERROR
;
1706 } catch (const bt2::Error
&) {
1707 return BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_ERROR
;
1711 static struct bt_param_validation_map_value_entry_descr list_sessions_params
[] = {
1712 {URL_PARAM
, BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_MANDATORY
,
1713 bt_param_validation_value_descr::makeString()},
1714 BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_END
};
1716 static bt_component_class_query_method_status
1717 lttng_live_query_list_sessions(const bt_value
*params
, const bt_value
**result
,
1718 const bt2c::Logger
& logger
)
1720 bt_component_class_query_method_status status
;
1721 const bt_value
*url_value
= NULL
;
1723 struct live_viewer_connection
*viewer_connection
= NULL
;
1724 enum lttng_live_viewer_status viewer_status
;
1725 enum bt_param_validation_status validation_status
;
1726 gchar
*validate_error
= NULL
;
1728 validation_status
= bt_param_validation_validate(params
, list_sessions_params
, &validate_error
);
1729 if (validation_status
== BT_PARAM_VALIDATION_STATUS_MEMORY_ERROR
) {
1730 status
= BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_MEMORY_ERROR
;
1732 } else if (validation_status
== BT_PARAM_VALIDATION_STATUS_VALIDATION_ERROR
) {
1733 status
= BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_ERROR
;
1734 BT_CPPLOGE_APPEND_CAUSE_SPEC(logger
, "{}", validate_error
);
1738 url_value
= bt_value_map_borrow_entry_value_const(params
, URL_PARAM
);
1739 url
= bt_value_string_get(url_value
);
1741 viewer_status
= live_viewer_connection_create(url
, true, NULL
, logger
, &viewer_connection
);
1742 if (viewer_status
!= LTTNG_LIVE_VIEWER_STATUS_OK
) {
1743 if (viewer_status
== LTTNG_LIVE_VIEWER_STATUS_ERROR
) {
1744 BT_CPPLOGE_APPEND_CAUSE_SPEC(logger
, "Failed to create viewer connection");
1745 status
= BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_ERROR
;
1746 } else if (viewer_status
== LTTNG_LIVE_VIEWER_STATUS_INTERRUPTED
) {
1747 status
= BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_AGAIN
;
1754 status
= live_viewer_connection_list_sessions(viewer_connection
, result
);
1755 if (status
!= BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_OK
) {
1756 BT_CPPLOGE_APPEND_CAUSE_SPEC(logger
, "Failed to list viewer sessions");
1763 BT_VALUE_PUT_REF_AND_RESET(*result
);
1766 status
= BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_ERROR
;
1770 delete viewer_connection
;
1772 g_free(validate_error
);
1777 static bt_component_class_query_method_status
1778 lttng_live_query_support_info(const bt_value
*params
, const bt_value
**result
,
1779 const bt2c::Logger
& logger
)
1781 bt_component_class_query_method_status status
= BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_OK
;
1782 const bt_value
*input_type_value
;
1783 const bt_value
*input_value
;
1785 struct bt_common_lttng_live_url_parts parts
= {};
1787 /* Used by the logging macros */
1788 __attribute__((unused
)) bt_self_component
*self_comp
= NULL
;
1791 input_type_value
= bt_value_map_borrow_entry_value_const(params
, "type");
1792 if (!input_type_value
) {
1793 BT_CPPLOGE_APPEND_CAUSE_SPEC(logger
, "Missing expected `type` parameter.");
1797 if (!bt_value_is_string(input_type_value
)) {
1798 BT_CPPLOGE_APPEND_CAUSE_SPEC(logger
, "`type` parameter is not a string value.");
1802 if (strcmp(bt_value_string_get(input_type_value
), "string") != 0) {
1803 /* We don't handle file system paths */
1807 input_value
= bt_value_map_borrow_entry_value_const(params
, "input");
1809 BT_CPPLOGE_APPEND_CAUSE_SPEC(logger
, "Missing expected `input` parameter.");
1813 if (!bt_value_is_string(input_value
)) {
1814 BT_CPPLOGE_APPEND_CAUSE_SPEC(logger
, "`input` parameter is not a string value.");
1818 parts
= bt_common_parse_lttng_live_url(bt_value_string_get(input_value
), NULL
, 0);
1819 if (parts
.session_name
) {
1821 * Looks pretty much like an LTTng live URL: we got the
1822 * session name part, which forms a complete URL.
1828 *result
= bt_value_real_create_init(weight
);
1830 status
= BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_MEMORY_ERROR
;
1838 status
= BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_ERROR
;
1841 BT_ASSERT(!*result
);
1844 bt_common_destroy_lttng_live_url_parts(&parts
);
1848 bt_component_class_query_method_status
lttng_live_query(bt_self_component_class_source
*comp_class
,
1849 bt_private_query_executor
*priv_query_exec
,
1850 const char *object
, const bt_value
*params
,
1851 __attribute__((unused
)) void *method_data
,
1852 const bt_value
**result
)
1855 bt_component_class_query_method_status status
= BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_OK
;
1856 bt2c::Logger logger
{bt2::SelfComponentClass
{comp_class
},
1857 bt2::PrivateQueryExecutor
{priv_query_exec
},
1858 "PLUGIN/SRC.CTF.LTTNG-LIVE/QUERY"};
1860 if (strcmp(object
, "sessions") == 0) {
1861 status
= lttng_live_query_list_sessions(params
, result
, logger
);
1862 } else if (strcmp(object
, "babeltrace.support-info") == 0) {
1863 status
= lttng_live_query_support_info(params
, result
, logger
);
1865 BT_CPPLOGI_SPEC(logger
, "Unknown query object `{}`", object
);
1866 status
= BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_UNKNOWN_OBJECT
;
1872 } catch (const std::bad_alloc
&) {
1873 return BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_MEMORY_ERROR
;
1874 } catch (const bt2::Error
&) {
1875 return BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_ERROR
;
1879 void lttng_live_component_finalize(bt_self_component_source
*component
)
1881 lttng_live_component::UP
{static_cast<lttng_live_component
*>(
1882 bt_self_component_get_data(bt_self_component_source_as_self_component(component
)))};
1885 static enum session_not_found_action
1886 parse_session_not_found_action_param(const bt_value
*no_session_param
)
1888 enum session_not_found_action action
;
1889 const char *no_session_act_str
= bt_value_string_get(no_session_param
);
1891 if (strcmp(no_session_act_str
, SESS_NOT_FOUND_ACTION_CONTINUE_STR
) == 0) {
1892 action
= SESSION_NOT_FOUND_ACTION_CONTINUE
;
1893 } else if (strcmp(no_session_act_str
, SESS_NOT_FOUND_ACTION_FAIL_STR
) == 0) {
1894 action
= SESSION_NOT_FOUND_ACTION_FAIL
;
1896 BT_ASSERT(strcmp(no_session_act_str
, SESS_NOT_FOUND_ACTION_END_STR
) == 0);
1897 action
= SESSION_NOT_FOUND_ACTION_END
;
1903 static bt_param_validation_value_descr inputs_elem_descr
=
1904 bt_param_validation_value_descr::makeString();
1906 static const char *sess_not_found_action_choices
[] = {
1907 SESS_NOT_FOUND_ACTION_CONTINUE_STR
,
1908 SESS_NOT_FOUND_ACTION_FAIL_STR
,
1909 SESS_NOT_FOUND_ACTION_END_STR
,
1912 static struct bt_param_validation_map_value_entry_descr params_descr
[] = {
1913 {INPUTS_PARAM
, BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_MANDATORY
,
1914 bt_param_validation_value_descr::makeArray(1, 1, inputs_elem_descr
)},
1915 {SESS_NOT_FOUND_ACTION_PARAM
, BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL
,
1916 bt_param_validation_value_descr::makeString(sess_not_found_action_choices
)},
1917 BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_END
};
1919 static bt_component_class_initialize_method_status
1920 lttng_live_component_create(const bt_value
*params
, bt_self_component_source
*self_comp
,
1921 lttng_live_component::UP
& component
)
1923 const bt_value
*inputs_value
;
1924 const bt_value
*url_value
;
1925 const bt_value
*value
;
1926 enum bt_param_validation_status validation_status
;
1927 gchar
*validation_error
= NULL
;
1928 bt2c::Logger logger
{bt2::SelfSourceComponent
{self_comp
}, "PLUGIN/SRC.CTF.LTTNG-LIVE/COMP"};
1930 validation_status
= bt_param_validation_validate(params
, params_descr
, &validation_error
);
1931 if (validation_status
== BT_PARAM_VALIDATION_STATUS_MEMORY_ERROR
) {
1932 return BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_MEMORY_ERROR
;
1933 } else if (validation_status
== BT_PARAM_VALIDATION_STATUS_VALIDATION_ERROR
) {
1934 bt2c::GCharUP errorFreer
{validation_error
};
1935 BT_CPPLOGE_APPEND_CAUSE_SPEC(logger
, "{}", validation_error
);
1936 return BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_ERROR
;
1939 auto lttng_live
= bt2s::make_unique
<lttng_live_component
>(std::move(logger
));
1940 lttng_live
->self_comp
= bt_self_component_source_as_self_component(self_comp
);
1941 lttng_live
->max_query_size
= MAX_QUERY_SIZE
;
1942 lttng_live
->has_msg_iter
= false;
1944 inputs_value
= bt_value_map_borrow_entry_value_const(params
, INPUTS_PARAM
);
1945 url_value
= bt_value_array_borrow_element_by_index_const(inputs_value
, 0);
1946 lttng_live
->params
.url
= bt_value_string_get(url_value
);
1948 value
= bt_value_map_borrow_entry_value_const(params
, SESS_NOT_FOUND_ACTION_PARAM
);
1950 lttng_live
->params
.sess_not_found_act
= parse_session_not_found_action_param(value
);
1952 BT_CPPLOGI_SPEC(lttng_live
->logger
,
1953 "Optional `{}` parameter is missing: defaulting to `{}`.",
1954 SESS_NOT_FOUND_ACTION_PARAM
, SESS_NOT_FOUND_ACTION_CONTINUE_STR
);
1955 lttng_live
->params
.sess_not_found_act
= SESSION_NOT_FOUND_ACTION_CONTINUE
;
1958 component
= std::move(lttng_live
);
1959 return BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_OK
;
1962 bt_component_class_initialize_method_status
1963 lttng_live_component_init(bt_self_component_source
*self_comp_src
,
1964 bt_self_component_source_configuration
*, const bt_value
*params
, void *)
1967 lttng_live_component::UP lttng_live
;
1968 bt_component_class_initialize_method_status ret
;
1969 bt_self_component
*self_comp
= bt_self_component_source_as_self_component(self_comp_src
);
1970 bt_self_component_add_port_status add_port_status
;
1972 ret
= lttng_live_component_create(params
, self_comp_src
, lttng_live
);
1973 if (ret
!= BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_OK
) {
1978 bt_self_component_source_add_output_port(self_comp_src
, "out", NULL
, NULL
);
1979 if (add_port_status
!= BT_SELF_COMPONENT_ADD_PORT_STATUS_OK
) {
1980 ret
= (bt_component_class_initialize_method_status
) add_port_status
;
1984 bt_self_component_set_data(self_comp
, lttng_live
.release());
1986 return BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_OK
;
1987 } catch (const std::bad_alloc
&) {
1988 return BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_MEMORY_ERROR
;
1989 } catch (const bt2::Error
&) {
1990 return BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_ERROR
;