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 struct lttng_live_msg_iter
*lttng_live_msg_iter
;
173 BT_ASSERT(self_msg_iter
);
175 lttng_live_msg_iter
=
176 (struct lttng_live_msg_iter
*) bt_self_message_iterator_get_data(self_msg_iter
);
177 BT_ASSERT(lttng_live_msg_iter
);
178 delete lttng_live_msg_iter
;
181 static enum lttng_live_iterator_status
182 lttng_live_iterator_next_check_stream_state(struct lttng_live_stream_iterator
*lttng_live_stream
)
184 switch (lttng_live_stream
->state
) {
185 case LTTNG_LIVE_STREAM_QUIESCENT
:
186 case LTTNG_LIVE_STREAM_ACTIVE_DATA
:
188 case LTTNG_LIVE_STREAM_ACTIVE_NO_DATA
:
190 BT_CPPLOGF_SPEC(lttng_live_stream
->logger
, "Unexpected stream state \"ACTIVE_NO_DATA\"");
192 case LTTNG_LIVE_STREAM_QUIESCENT_NO_DATA
:
194 BT_CPPLOGF_SPEC(lttng_live_stream
->logger
, "Unexpected stream state \"QUIESCENT_NO_DATA\"");
196 case LTTNG_LIVE_STREAM_EOF
:
199 return LTTNG_LIVE_ITERATOR_STATUS_OK
;
203 * For active no data stream, fetch next index. As a result of that it can
205 * - quiescent: won't have events for a bit,
206 * - have data: need to get that data and produce the event,
207 * - have no data on this stream at this point: need to retry (AGAIN) or return
210 static enum lttng_live_iterator_status
lttng_live_iterator_next_handle_one_no_data_stream(
211 struct lttng_live_msg_iter
*lttng_live_msg_iter
,
212 struct lttng_live_stream_iterator
*lttng_live_stream
)
214 enum lttng_live_iterator_status ret
= LTTNG_LIVE_ITERATOR_STATUS_OK
;
215 enum lttng_live_stream_state orig_state
= lttng_live_stream
->state
;
216 struct packet_index index
;
218 if (lttng_live_stream
->trace
->metadata_stream_state
==
219 LTTNG_LIVE_METADATA_STREAM_STATE_NEEDED
) {
220 BT_CPPLOGD_SPEC(lttng_live_msg_iter
->logger
,
221 "Need to get an update for the metadata stream before proceeding "
222 "further with this stream: stream-name=\"{}\"",
223 lttng_live_stream
->name
);
224 ret
= LTTNG_LIVE_ITERATOR_STATUS_CONTINUE
;
228 if (lttng_live_stream
->trace
->session
->new_streams_needed
) {
229 BT_CPPLOGD_SPEC(lttng_live_msg_iter
->logger
,
230 "Need to get an update of all streams before proceeding further "
231 "with this stream: stream-name=\"{}\"",
232 lttng_live_stream
->name
);
233 ret
= LTTNG_LIVE_ITERATOR_STATUS_CONTINUE
;
237 if (lttng_live_stream
->state
!= LTTNG_LIVE_STREAM_ACTIVE_NO_DATA
&&
238 lttng_live_stream
->state
!= LTTNG_LIVE_STREAM_QUIESCENT_NO_DATA
) {
241 ret
= lttng_live_get_next_index(lttng_live_msg_iter
, lttng_live_stream
, &index
);
242 if (ret
!= LTTNG_LIVE_ITERATOR_STATUS_OK
) {
246 BT_ASSERT_DBG(lttng_live_stream
->state
!= LTTNG_LIVE_STREAM_EOF
);
248 if (lttng_live_stream
->state
== LTTNG_LIVE_STREAM_QUIESCENT
) {
249 uint64_t last_inact_ts
= lttng_live_stream
->last_inactivity_ts
.value
,
250 curr_inact_ts
= lttng_live_stream
->current_inactivity_ts
;
252 if (orig_state
== LTTNG_LIVE_STREAM_QUIESCENT_NO_DATA
&& last_inact_ts
== curr_inact_ts
) {
254 * Because the stream is in the QUIESCENT_NO_DATA
255 * state, we can assert that the last_inactivity_ts was
256 * set and can be safely used in the `if` above.
258 BT_ASSERT(lttng_live_stream
->last_inactivity_ts
.is_set
);
260 ret
= LTTNG_LIVE_ITERATOR_STATUS_AGAIN
;
261 LTTNG_LIVE_LOGD_STREAM_ITER(lttng_live_stream
);
263 ret
= LTTNG_LIVE_ITERATOR_STATUS_CONTINUE
;
268 lttng_live_stream
->base_offset
= index
.offset
;
269 lttng_live_stream
->offset
= index
.offset
;
270 lttng_live_stream
->len
= index
.packet_size
/ CHAR_BIT
;
272 BT_CPPLOGD_SPEC(lttng_live_msg_iter
->logger
,
273 "Setting live stream reading info: stream-name=\"{}\", "
274 "viewer-stream-id={}, stream-base-offset={}, stream-offset={}, stream-len={}",
275 lttng_live_stream
->name
, lttng_live_stream
->viewer_stream_id
,
276 lttng_live_stream
->base_offset
, lttng_live_stream
->offset
,
277 lttng_live_stream
->len
);
280 if (ret
== LTTNG_LIVE_ITERATOR_STATUS_OK
) {
281 ret
= lttng_live_iterator_next_check_stream_state(lttng_live_stream
);
287 * Creation of the message requires the ctf trace class to be created
288 * beforehand, but the live protocol gives us all streams (including metadata)
289 * at once. So we split it in three steps: getting streams, getting metadata
290 * (which creates the ctf trace class), and then creating the per-stream
293 static enum lttng_live_iterator_status
294 lttng_live_get_session(struct lttng_live_msg_iter
*lttng_live_msg_iter
,
295 struct lttng_live_session
*session
)
297 enum lttng_live_iterator_status status
;
299 if (!session
->attached
) {
300 BT_CPPLOGD_SPEC(lttng_live_msg_iter
->logger
, "Attach to session: session-id={}",
302 enum lttng_live_viewer_status attach_status
=
303 lttng_live_session_attach(session
, lttng_live_msg_iter
->self_msg_iter
);
304 if (attach_status
!= LTTNG_LIVE_VIEWER_STATUS_OK
) {
305 if (lttng_live_graph_is_canceled(lttng_live_msg_iter
)) {
307 * Clear any causes appended in
308 * `lttng_live_attach_session()` as we want to
309 * return gracefully since the graph was
312 bt_current_thread_clear_error();
313 status
= LTTNG_LIVE_ITERATOR_STATUS_AGAIN
;
315 status
= LTTNG_LIVE_ITERATOR_STATUS_ERROR
;
316 BT_CPPLOGE_APPEND_CAUSE_SPEC(lttng_live_msg_iter
->logger
,
317 "Error attaching to LTTng live session");
323 BT_CPPLOGD_SPEC(lttng_live_msg_iter
->logger
,
324 "Updating all data streams: session-id={}, session-name=\"{}\"", session
->id
,
325 session
->session_name
);
327 status
= lttng_live_session_get_new_streams(session
, lttng_live_msg_iter
->self_msg_iter
);
329 case LTTNG_LIVE_ITERATOR_STATUS_OK
:
331 case LTTNG_LIVE_ITERATOR_STATUS_END
:
333 * We received a `_END` from the `_get_new_streams()` function,
334 * which means no more data will ever be received from the data
335 * streams of this session. But it's possible that the metadata
337 * The live protocol guarantees that we receive all the
338 * metadata needed before we receive data streams needing it.
339 * But it's possible to receive metadata NOT needed by
340 * data streams after the session was closed. For example, this
341 * could happen if a new event is registered and the session is
342 * stopped before any tracepoint for that event is actually
346 lttng_live_msg_iter
->logger
,
347 "Updating streams returned _END status. Override status to _OK in order fetch any remaining metadata:"
348 "session-id={}, session-name=\"{}\"",
349 session
->id
, session
->session_name
);
350 status
= LTTNG_LIVE_ITERATOR_STATUS_OK
;
356 BT_CPPLOGD_SPEC(lttng_live_msg_iter
->logger
,
357 "Updating metadata stream for session: session-id={}, session-name=\"{}\"",
358 session
->id
, session
->session_name
);
360 for (lttng_live_trace::UP
& trace
: session
->traces
) {
361 status
= lttng_live_metadata_update(trace
.get());
363 case LTTNG_LIVE_ITERATOR_STATUS_END
:
364 case LTTNG_LIVE_ITERATOR_STATUS_OK
:
366 case LTTNG_LIVE_ITERATOR_STATUS_CONTINUE
:
367 case LTTNG_LIVE_ITERATOR_STATUS_AGAIN
:
370 BT_CPPLOGE_APPEND_CAUSE_SPEC(lttng_live_msg_iter
->logger
,
371 "Error updating trace metadata: "
372 "stream-iter-status={}, trace-id={}",
379 * Now that we have the metadata we can initialize the downstream
382 status
= lttng_live_lazy_msg_init(session
, lttng_live_msg_iter
->self_msg_iter
);
389 lttng_live_force_new_streams_and_metadata(struct lttng_live_msg_iter
*lttng_live_msg_iter
)
391 for (const auto& session
: lttng_live_msg_iter
->sessions
) {
392 BT_CPPLOGD_SPEC(lttng_live_msg_iter
->logger
,
393 "Force marking session as needing new streams: "
396 session
->new_streams_needed
= true;
397 for (lttng_live_trace::UP
& trace
: session
->traces
) {
398 BT_CPPLOGD_SPEC(lttng_live_msg_iter
->logger
,
399 "Force marking trace metadata state as needing an update: "
400 "session-id={}, trace-id={}",
401 session
->id
, trace
->id
);
403 BT_ASSERT(trace
->metadata_stream_state
!= LTTNG_LIVE_METADATA_STREAM_STATE_CLOSED
);
405 trace
->metadata_stream_state
= LTTNG_LIVE_METADATA_STREAM_STATE_NEEDED
;
410 static enum lttng_live_iterator_status
411 lttng_live_iterator_handle_new_streams_and_metadata(struct lttng_live_msg_iter
*lttng_live_msg_iter
)
413 enum lttng_live_iterator_status status
;
414 enum lttng_live_viewer_status viewer_status
;
415 uint64_t nr_sessions_opened
= 0;
416 enum session_not_found_action sess_not_found_act
=
417 lttng_live_msg_iter
->lttng_live_comp
->params
.sess_not_found_act
;
419 BT_CPPLOGD_SPEC(lttng_live_msg_iter
->logger
,
420 "Update data and metadata of all sessions: "
421 "live-msg-iter-addr={}",
422 fmt::ptr(lttng_live_msg_iter
));
424 * In a remotely distant future, we could add a "new
425 * session" flag to the protocol, which would tell us that we
426 * need to query for new sessions even though we have sessions
429 if (lttng_live_msg_iter
->sessions
.empty()) {
430 if (sess_not_found_act
!= SESSION_NOT_FOUND_ACTION_CONTINUE
) {
432 lttng_live_msg_iter
->logger
,
433 "No session found. Exiting in accordance with the `session-not-found-action` parameter");
434 status
= LTTNG_LIVE_ITERATOR_STATUS_END
;
438 lttng_live_msg_iter
->logger
,
439 "No session found. Try creating a new one in accordance with the `session-not-found-action` parameter");
441 * Retry to create a viewer session for the requested
444 viewer_status
= lttng_live_create_viewer_session(lttng_live_msg_iter
);
445 if (viewer_status
!= LTTNG_LIVE_VIEWER_STATUS_OK
) {
446 if (viewer_status
== LTTNG_LIVE_VIEWER_STATUS_ERROR
) {
447 status
= LTTNG_LIVE_ITERATOR_STATUS_ERROR
;
448 BT_CPPLOGE_APPEND_CAUSE_SPEC(lttng_live_msg_iter
->logger
,
449 "Error creating LTTng live viewer session");
450 } else if (viewer_status
== LTTNG_LIVE_VIEWER_STATUS_INTERRUPTED
) {
451 status
= LTTNG_LIVE_ITERATOR_STATUS_AGAIN
;
460 for (const auto& session
: lttng_live_msg_iter
->sessions
) {
461 status
= lttng_live_get_session(lttng_live_msg_iter
, session
.get());
463 case LTTNG_LIVE_ITERATOR_STATUS_OK
:
464 case LTTNG_LIVE_ITERATOR_STATUS_END
:
466 * A session returned `_END`. Other sessions may still
467 * be active so we override the status and continue
474 if (!session
->closed
) {
475 nr_sessions_opened
++;
479 if (sess_not_found_act
!= SESSION_NOT_FOUND_ACTION_CONTINUE
&& nr_sessions_opened
== 0) {
480 status
= LTTNG_LIVE_ITERATOR_STATUS_END
;
482 status
= LTTNG_LIVE_ITERATOR_STATUS_OK
;
489 static enum lttng_live_iterator_status
490 emit_inactivity_message(struct lttng_live_msg_iter
*lttng_live_msg_iter
,
491 struct lttng_live_stream_iterator
*stream_iter
,
492 bt2::ConstMessage::Shared
& message
, uint64_t timestamp
)
494 BT_ASSERT(stream_iter
->trace
->clock_class
);
495 BT_CPPLOGD_SPEC(lttng_live_msg_iter
->logger
,
496 "Emitting inactivity message for stream: ctf-stream-id={}, "
497 "viewer-stream-id={}, timestamp={}",
498 stream_iter
->ctf_stream_class_id
.value
, stream_iter
->viewer_stream_id
,
501 const auto msg
= bt_message_message_iterator_inactivity_create(
502 lttng_live_msg_iter
->self_msg_iter
, stream_iter
->trace
->clock_class
, timestamp
);
505 BT_CPPLOGE_APPEND_CAUSE_SPEC(lttng_live_msg_iter
->logger
,
506 "Error emitting message iterator inactivity message");
507 return LTTNG_LIVE_ITERATOR_STATUS_ERROR
;
510 message
= bt2::ConstMessage::Shared::createWithoutRef(msg
);
511 return LTTNG_LIVE_ITERATOR_STATUS_OK
;
514 static enum lttng_live_iterator_status
lttng_live_iterator_next_handle_one_quiescent_stream(
515 struct lttng_live_msg_iter
*lttng_live_msg_iter
,
516 struct lttng_live_stream_iterator
*lttng_live_stream
, bt2::ConstMessage::Shared
& message
)
518 enum lttng_live_iterator_status ret
= LTTNG_LIVE_ITERATOR_STATUS_OK
;
520 if (lttng_live_stream
->state
!= LTTNG_LIVE_STREAM_QUIESCENT
) {
521 return LTTNG_LIVE_ITERATOR_STATUS_OK
;
525 * Check if we already sent an inactivty message downstream for this
526 * `current_inactivity_ts` value.
528 if (lttng_live_stream
->last_inactivity_ts
.is_set
&&
529 lttng_live_stream
->current_inactivity_ts
== lttng_live_stream
->last_inactivity_ts
.value
) {
530 lttng_live_stream_iterator_set_state(lttng_live_stream
,
531 LTTNG_LIVE_STREAM_QUIESCENT_NO_DATA
);
533 ret
= LTTNG_LIVE_ITERATOR_STATUS_CONTINUE
;
537 ret
= emit_inactivity_message(lttng_live_msg_iter
, lttng_live_stream
, message
,
538 lttng_live_stream
->current_inactivity_ts
);
540 lttng_live_stream
->last_inactivity_ts
.value
= lttng_live_stream
->current_inactivity_ts
;
541 lttng_live_stream
->last_inactivity_ts
.is_set
= true;
546 static int live_get_msg_ts_ns(struct lttng_live_msg_iter
*lttng_live_msg_iter
,
547 const bt_message
*msg
, int64_t last_msg_ts_ns
, int64_t *ts_ns
)
549 const bt_clock_snapshot
*clock_snapshot
= NULL
;
553 BT_ASSERT_DBG(ts_ns
);
555 BT_CPPLOGD_SPEC(lttng_live_msg_iter
->logger
,
556 "Getting message's timestamp: iter-data-addr={}, msg-addr={}, "
558 fmt::ptr(lttng_live_msg_iter
), fmt::ptr(msg
), last_msg_ts_ns
);
560 switch (bt_message_get_type(msg
)) {
561 case BT_MESSAGE_TYPE_EVENT
:
562 clock_snapshot
= bt_message_event_borrow_default_clock_snapshot_const(msg
);
564 case BT_MESSAGE_TYPE_PACKET_BEGINNING
:
565 clock_snapshot
= bt_message_packet_beginning_borrow_default_clock_snapshot_const(msg
);
567 case BT_MESSAGE_TYPE_PACKET_END
:
568 clock_snapshot
= bt_message_packet_end_borrow_default_clock_snapshot_const(msg
);
570 case BT_MESSAGE_TYPE_DISCARDED_EVENTS
:
572 bt_message_discarded_events_borrow_beginning_default_clock_snapshot_const(msg
);
574 case BT_MESSAGE_TYPE_DISCARDED_PACKETS
:
576 bt_message_discarded_packets_borrow_beginning_default_clock_snapshot_const(msg
);
578 case BT_MESSAGE_TYPE_MESSAGE_ITERATOR_INACTIVITY
:
579 clock_snapshot
= bt_message_message_iterator_inactivity_borrow_clock_snapshot_const(msg
);
582 /* All the other messages have a higher priority */
583 BT_CPPLOGD_STR_SPEC(lttng_live_msg_iter
->logger
,
584 "Message has no timestamp: using the last message timestamp.");
585 *ts_ns
= last_msg_ts_ns
;
589 ret
= bt_clock_snapshot_get_ns_from_origin(clock_snapshot
, ts_ns
);
591 BT_CPPLOGE_APPEND_CAUSE_SPEC(lttng_live_msg_iter
->logger
,
592 "Cannot get nanoseconds from Epoch of clock snapshot: "
593 "clock-snapshot-addr={}",
594 fmt::ptr(clock_snapshot
));
605 BT_CPPLOGD_SPEC(lttng_live_msg_iter
->logger
,
606 "Found message's timestamp: iter-data-addr={}, msg-addr={}, "
607 "last-msg-ts={}, ts={}",
608 fmt::ptr(lttng_live_msg_iter
), fmt::ptr(msg
), last_msg_ts_ns
, *ts_ns
);
614 static enum lttng_live_iterator_status
lttng_live_iterator_next_handle_one_active_data_stream(
615 struct lttng_live_msg_iter
*lttng_live_msg_iter
,
616 struct lttng_live_stream_iterator
*lttng_live_stream
, bt2::ConstMessage::Shared
& message
)
618 enum lttng_live_iterator_status ret
= LTTNG_LIVE_ITERATOR_STATUS_OK
;
619 enum ctf_msg_iter_status status
;
621 for (const auto& session
: lttng_live_msg_iter
->sessions
) {
622 if (session
->new_streams_needed
) {
623 BT_CPPLOGD_SPEC(lttng_live_msg_iter
->logger
,
624 "Need an update for streams: "
627 ret
= LTTNG_LIVE_ITERATOR_STATUS_CONTINUE
;
630 for (lttng_live_trace::UP
& trace
: session
->traces
) {
631 if (trace
->metadata_stream_state
== LTTNG_LIVE_METADATA_STREAM_STATE_NEEDED
) {
632 BT_CPPLOGD_SPEC(lttng_live_msg_iter
->logger
,
633 "Need an update for metadata stream: "
634 "session-id={}, trace-id={}",
635 session
->id
, trace
->id
);
636 ret
= LTTNG_LIVE_ITERATOR_STATUS_CONTINUE
;
642 if (lttng_live_stream
->state
!= LTTNG_LIVE_STREAM_ACTIVE_DATA
) {
643 ret
= LTTNG_LIVE_ITERATOR_STATUS_ERROR
;
644 BT_CPPLOGE_APPEND_CAUSE_SPEC(lttng_live_msg_iter
->logger
,
645 "Invalid state of live stream iterator"
646 "stream-iter-status={}",
647 lttng_live_stream
->state
);
651 const bt_message
*msg
;
652 status
= ctf_msg_iter_get_next_message(lttng_live_stream
->msg_iter
.get(), &msg
);
654 case CTF_MSG_ITER_STATUS_EOF
:
655 ret
= LTTNG_LIVE_ITERATOR_STATUS_END
;
657 case CTF_MSG_ITER_STATUS_OK
:
658 message
= bt2::ConstMessage::Shared::createWithoutRef(msg
);
659 ret
= LTTNG_LIVE_ITERATOR_STATUS_OK
;
661 case CTF_MSG_ITER_STATUS_AGAIN
:
663 * Continue immediately (end of packet). The next
664 * get_index may return AGAIN to delay the following
667 ret
= LTTNG_LIVE_ITERATOR_STATUS_CONTINUE
;
669 case CTF_MSG_ITER_STATUS_ERROR
:
671 ret
= LTTNG_LIVE_ITERATOR_STATUS_ERROR
;
672 BT_CPPLOGE_APPEND_CAUSE_SPEC(lttng_live_msg_iter
->logger
,
673 "CTF message iterator failed to get next message: "
674 "msg-iter={}, msg-iter-status={}",
675 fmt::ptr(lttng_live_stream
->msg_iter
), status
);
683 static enum lttng_live_iterator_status
684 lttng_live_iterator_close_stream(struct lttng_live_msg_iter
*lttng_live_msg_iter
,
685 struct lttng_live_stream_iterator
*stream_iter
,
686 bt2::ConstMessage::Shared
& curr_msg
)
688 enum lttng_live_iterator_status live_status
= LTTNG_LIVE_ITERATOR_STATUS_OK
;
690 BT_CPPLOGD_SPEC(lttng_live_msg_iter
->logger
,
691 "Closing live stream iterator: stream-name=\"{}\", "
692 "viewer-stream-id={}",
693 stream_iter
->name
, stream_iter
->viewer_stream_id
);
696 * The viewer has hung up on us so we are closing the stream. The
697 * `ctf_msg_iter` should simply realize that it needs to close the
698 * stream properly by emitting the necessary stream end message.
700 const bt_message
*msg
;
701 enum ctf_msg_iter_status status
=
702 ctf_msg_iter_get_next_message(stream_iter
->msg_iter
.get(), &msg
);
704 if (status
== CTF_MSG_ITER_STATUS_ERROR
) {
705 BT_CPPLOGE_APPEND_CAUSE_SPEC(lttng_live_msg_iter
->logger
,
706 "Error getting the next message from CTF message iterator");
707 live_status
= LTTNG_LIVE_ITERATOR_STATUS_ERROR
;
709 } else if (status
== CTF_MSG_ITER_STATUS_EOF
) {
710 BT_CPPLOGI_SPEC(lttng_live_msg_iter
->logger
,
711 "Reached the end of the live stream iterator.");
712 live_status
= LTTNG_LIVE_ITERATOR_STATUS_END
;
716 BT_ASSERT(status
== CTF_MSG_ITER_STATUS_OK
);
718 curr_msg
= bt2::ConstMessage::Shared::createWithoutRef(msg
);
726 * handle_no_data_streams()
728 * - for each ACTIVE_NO_DATA stream:
729 * - query relayd for stream data, or quiescence info.
730 * - if need metadata, get metadata, goto retry.
731 * - if new stream, get new stream as ACTIVE_NO_DATA, goto retry
732 * - if quiescent, move to QUIESCENT streams
733 * - if fetched data, move to ACTIVE_DATA streams
734 * (at this point each stream either has data, or is quiescent)
738 * handle_new_streams_and_metadata()
739 * - query relayd for known streams, add them as ACTIVE_NO_DATA
740 * - query relayd for metadata
742 * call handle_active_no_data_streams()
744 * handle_quiescent_streams()
745 * - if at least one stream is ACTIVE_DATA:
746 * - peek stream event with lowest timestamp -> next_ts
747 * - for each quiescent stream
748 * - if next_ts >= quiescent end
749 * - set state to ACTIVE_NO_DATA
751 * - for each quiescent stream
752 * - set state to ACTIVE_NO_DATA
754 * call handle_active_no_data_streams()
756 * handle_active_data_streams()
757 * - if at least one stream is ACTIVE_DATA:
758 * - get stream event with lowest timestamp from heap
759 * - make that stream event the current message.
760 * - move this stream heap position to its next event
761 * - if we need to fetch data from relayd, move
762 * stream to ACTIVE_NO_DATA.
766 * end criterion: ctrl-c on client. If relayd exits or the session
767 * closes on the relay daemon side, we keep on waiting for streams.
768 * Eventually handle --end timestamp (also an end criterion).
770 * When disconnected from relayd: try to re-connect endlessly.
772 static enum lttng_live_iterator_status
773 lttng_live_iterator_next_msg_on_stream(struct lttng_live_msg_iter
*lttng_live_msg_iter
,
774 struct lttng_live_stream_iterator
*stream_iter
,
775 bt2::ConstMessage::Shared
& curr_msg
)
777 enum lttng_live_iterator_status live_status
;
779 BT_CPPLOGD_SPEC(lttng_live_msg_iter
->logger
,
780 "Advancing live stream iterator until next message if possible: "
781 "stream-name=\"{}\", viewer-stream-id={}",
782 stream_iter
->name
, stream_iter
->viewer_stream_id
);
784 if (stream_iter
->has_stream_hung_up
) {
786 * The stream has hung up and the stream was properly closed
787 * during the last call to the current function. Return _END
788 * status now so that this stream iterator is removed for the
789 * stream iterator list.
791 live_status
= LTTNG_LIVE_ITERATOR_STATUS_END
;
796 LTTNG_LIVE_LOGD_STREAM_ITER(stream_iter
);
799 * Make sure we have the most recent metadata and possibly some new
802 live_status
= lttng_live_iterator_handle_new_streams_and_metadata(lttng_live_msg_iter
);
803 if (live_status
!= LTTNG_LIVE_ITERATOR_STATUS_OK
) {
808 lttng_live_iterator_next_handle_one_no_data_stream(lttng_live_msg_iter
, stream_iter
);
809 if (live_status
!= LTTNG_LIVE_ITERATOR_STATUS_OK
) {
810 if (live_status
== LTTNG_LIVE_ITERATOR_STATUS_END
) {
812 * We overwrite `live_status` since `curr_msg` is
813 * likely set to a valid message in this function.
816 lttng_live_iterator_close_stream(lttng_live_msg_iter
, stream_iter
, curr_msg
);
821 live_status
= lttng_live_iterator_next_handle_one_quiescent_stream(lttng_live_msg_iter
,
822 stream_iter
, curr_msg
);
823 if (live_status
!= LTTNG_LIVE_ITERATOR_STATUS_OK
) {
824 BT_ASSERT(!curr_msg
);
830 live_status
= lttng_live_iterator_next_handle_one_active_data_stream(lttng_live_msg_iter
,
831 stream_iter
, curr_msg
);
832 if (live_status
!= LTTNG_LIVE_ITERATOR_STATUS_OK
) {
833 BT_ASSERT(!curr_msg
);
837 if (live_status
== LTTNG_LIVE_ITERATOR_STATUS_CONTINUE
) {
839 lttng_live_msg_iter
->logger
,
840 "Ask the relay daemon for an updated view of the data and metadata streams");
844 BT_CPPLOGD_SPEC(lttng_live_msg_iter
->logger
,
845 "Returning from advancing live stream iterator: status={}, "
846 "stream-name=\"{}\", viewer-stream-id={}",
847 live_status
, stream_iter
->name
, stream_iter
->viewer_stream_id
);
852 static bool is_discarded_packet_or_event_message(const bt2::ConstMessage msg
)
854 return msg
.type() == bt2::MessageType::DiscardedEvents
||
855 msg
.type() == bt2::MessageType::DiscardedPackets
;
858 static enum lttng_live_iterator_status
859 adjust_discarded_packets_message(bt_self_message_iterator
*iter
, const bt_stream
*stream
,
860 const bt_message
*msg_in
, bt2::ConstMessage::Shared
& msg_out
,
861 uint64_t new_begin_ts
)
863 enum bt_property_availability availability
;
864 const bt_clock_snapshot
*clock_snapshot
;
868 clock_snapshot
= bt_message_discarded_packets_borrow_end_default_clock_snapshot_const(msg_in
);
869 end_ts
= bt_clock_snapshot_get_value(clock_snapshot
);
871 availability
= bt_message_discarded_packets_get_count(msg_in
, &count
);
872 BT_ASSERT_DBG(availability
== BT_PROPERTY_AVAILABILITY_AVAILABLE
);
874 const auto msg
= bt_message_discarded_packets_create_with_default_clock_snapshots(
875 iter
, stream
, new_begin_ts
, end_ts
);
878 return LTTNG_LIVE_ITERATOR_STATUS_NOMEM
;
881 bt_message_discarded_packets_set_count(msg
, count
);
882 msg_out
= bt2::ConstMessage::Shared::createWithoutRef(msg
);
883 return LTTNG_LIVE_ITERATOR_STATUS_OK
;
886 static enum lttng_live_iterator_status
887 adjust_discarded_events_message(bt_self_message_iterator
*iter
, const bt_stream
*stream
,
888 const bt_message
*msg_in
, bt2::ConstMessage::Shared
& msg_out
,
889 uint64_t new_begin_ts
)
891 enum bt_property_availability availability
;
892 const bt_clock_snapshot
*clock_snapshot
;
896 clock_snapshot
= bt_message_discarded_events_borrow_end_default_clock_snapshot_const(msg_in
);
897 end_ts
= bt_clock_snapshot_get_value(clock_snapshot
);
899 availability
= bt_message_discarded_events_get_count(msg_in
, &count
);
900 BT_ASSERT_DBG(availability
== BT_PROPERTY_AVAILABILITY_AVAILABLE
);
902 const auto msg
= bt_message_discarded_events_create_with_default_clock_snapshots(
903 iter
, stream
, new_begin_ts
, end_ts
);
906 return LTTNG_LIVE_ITERATOR_STATUS_NOMEM
;
909 bt_message_discarded_events_set_count(msg
, count
);
910 msg_out
= bt2::ConstMessage::Shared::createWithoutRef(msg
);
911 return LTTNG_LIVE_ITERATOR_STATUS_OK
;
914 static enum lttng_live_iterator_status
915 handle_late_message(struct lttng_live_msg_iter
*lttng_live_msg_iter
,
916 struct lttng_live_stream_iterator
*stream_iter
, int64_t late_msg_ts_ns
,
917 const bt2::ConstMessage
& late_msg
)
919 const bt_clock_class
*clock_class
;
920 const bt_stream_class
*stream_class
;
921 enum bt_clock_class_cycles_to_ns_from_origin_status ts_ns_status
;
922 int64_t last_inactivity_ts_ns
;
923 enum lttng_live_iterator_status stream_iter_status
= LTTNG_LIVE_ITERATOR_STATUS_OK
;
924 enum lttng_live_iterator_status adjust_status
;
925 bt2::ConstMessage::Shared adjusted_message
;
928 * The timestamp of the current message is before the last message sent
929 * by this component. We CANNOT send it as is.
931 * The only expected scenario in which that could happen is the
932 * following, everything else is a bug in this component, relay daemon,
935 * Expected scenario: The CTF message iterator emitted discarded
936 * packets and discarded events with synthesized beginning and end
937 * timestamps from the bounds of the last known packet and the newly
938 * decoded packet header. The CTF message iterator is not aware of
939 * stream inactivity beacons. Hence, we have to adjust the beginning
940 * timestamp of those types of messages if a stream signalled its
941 * inactivity up until _after_ the last known packet's beginning
944 * Otherwise, the monotonicity guarantee of message timestamps would
947 * In short, the only scenario in which it's okay and fixable to
948 * received a late message is when:
949 * 1. the late message is a discarded packets or discarded events
951 * 2. this stream produced an inactivity message downstream, and
952 * 3. the timestamp of the late message is within the inactivity
953 * timespan we sent downstream through the inactivity message.
956 BT_CPPLOGD_SPEC(lttng_live_msg_iter
->logger
,
957 "Handling late message on live stream iterator: "
958 "stream-name=\"{}\", viewer-stream-id={}",
959 stream_iter
->name
, stream_iter
->viewer_stream_id
);
961 if (!stream_iter
->last_inactivity_ts
.is_set
) {
962 BT_CPPLOGE_APPEND_CAUSE_SPEC(lttng_live_msg_iter
->logger
,
963 "Invalid live stream state: "
964 "have a late message when no inactivity message "
965 "was ever sent for that stream.");
966 stream_iter_status
= LTTNG_LIVE_ITERATOR_STATUS_ERROR
;
970 if (!is_discarded_packet_or_event_message(late_msg
)) {
971 BT_CPPLOGE_APPEND_CAUSE_SPEC(lttng_live_msg_iter
->logger
,
972 "Invalid live stream state: "
973 "have a late message that is not a packet discarded or "
974 "event discarded message: late-msg-type={}",
976 stream_iter_status
= LTTNG_LIVE_ITERATOR_STATUS_ERROR
;
980 stream_class
= bt_stream_borrow_class_const(stream_iter
->stream
->libObjPtr());
981 clock_class
= bt_stream_class_borrow_default_clock_class_const(stream_class
);
983 ts_ns_status
= bt_clock_class_cycles_to_ns_from_origin(
984 clock_class
, stream_iter
->last_inactivity_ts
.value
, &last_inactivity_ts_ns
);
985 if (ts_ns_status
!= BT_CLOCK_CLASS_CYCLES_TO_NS_FROM_ORIGIN_STATUS_OK
) {
986 BT_CPPLOGE_APPEND_CAUSE_SPEC(lttng_live_msg_iter
->logger
,
987 "Error converting last "
988 "inactivity message timestamp to nanoseconds");
989 stream_iter_status
= LTTNG_LIVE_ITERATOR_STATUS_ERROR
;
993 if (last_inactivity_ts_ns
<= late_msg_ts_ns
) {
994 BT_CPPLOGE_APPEND_CAUSE_SPEC(lttng_live_msg_iter
->logger
,
995 "Invalid live stream state: "
996 "have a late message that is none included in a stream "
997 "inactivity timespan: last-inactivity-ts-ns={}, "
999 last_inactivity_ts_ns
, late_msg_ts_ns
);
1000 stream_iter_status
= LTTNG_LIVE_ITERATOR_STATUS_ERROR
;
1005 * We now know that it's okay for this message to be late, we can now
1006 * adjust its timestamp to ensure monotonicity.
1008 BT_CPPLOGD_SPEC(lttng_live_msg_iter
->logger
,
1009 "Adjusting the timestamp of late message: late-msg-type={}, "
1011 late_msg
.type(), stream_iter
->last_inactivity_ts
.value
);
1012 switch (late_msg
.type()) {
1013 case bt2::MessageType::DiscardedEvents
:
1014 adjust_status
= adjust_discarded_events_message(
1015 lttng_live_msg_iter
->self_msg_iter
, stream_iter
->stream
->libObjPtr(),
1016 late_msg
.libObjPtr(), adjusted_message
, stream_iter
->last_inactivity_ts
.value
);
1018 case bt2::MessageType::DiscardedPackets
:
1019 adjust_status
= adjust_discarded_packets_message(
1020 lttng_live_msg_iter
->self_msg_iter
, stream_iter
->stream
->libObjPtr(),
1021 late_msg
.libObjPtr(), adjusted_message
, stream_iter
->last_inactivity_ts
.value
);
1027 if (adjust_status
!= LTTNG_LIVE_ITERATOR_STATUS_OK
) {
1028 stream_iter_status
= adjust_status
;
1032 BT_ASSERT_DBG(adjusted_message
);
1033 stream_iter
->current_msg
= adjusted_message
;
1034 stream_iter
->current_msg_ts_ns
= last_inactivity_ts_ns
;
1037 return stream_iter_status
;
1040 static enum lttng_live_iterator_status
1041 next_stream_iterator_for_trace(struct lttng_live_msg_iter
*lttng_live_msg_iter
,
1042 struct lttng_live_trace
*live_trace
,
1043 struct lttng_live_stream_iterator
**youngest_trace_stream_iter
)
1045 struct lttng_live_stream_iterator
*youngest_candidate_stream_iter
= NULL
;
1046 enum lttng_live_iterator_status stream_iter_status
;
1047 int64_t youngest_candidate_msg_ts
= INT64_MAX
;
1048 uint64_t stream_iter_idx
;
1050 BT_ASSERT_DBG(live_trace
);
1052 BT_CPPLOGD_SPEC(lttng_live_msg_iter
->logger
,
1053 "Finding the next stream iterator for trace: "
1057 * Update the current message of every stream iterators of this trace.
1058 * The current msg of every stream must have a timestamp equal or
1059 * larger than the last message returned by this iterator. We must
1060 * ensure monotonicity.
1062 stream_iter_idx
= 0;
1063 while (stream_iter_idx
< live_trace
->stream_iterators
.size()) {
1064 bool stream_iter_is_ended
= false;
1065 lttng_live_stream_iterator
*stream_iter
=
1066 live_trace
->stream_iterators
[stream_iter_idx
].get();
1069 * If there is no current message for this stream, go fetch
1072 while (!stream_iter
->current_msg
) {
1073 bt2::ConstMessage::Shared msg
;
1074 int64_t curr_msg_ts_ns
= INT64_MAX
;
1076 stream_iter_status
=
1077 lttng_live_iterator_next_msg_on_stream(lttng_live_msg_iter
, stream_iter
, msg
);
1079 if (stream_iter_status
== LTTNG_LIVE_ITERATOR_STATUS_END
) {
1080 stream_iter_is_ended
= true;
1084 if (stream_iter_status
!= LTTNG_LIVE_ITERATOR_STATUS_OK
) {
1090 BT_CPPLOGD_SPEC(lttng_live_msg_iter
->logger
,
1091 "Live stream iterator returned message: msg-type={}, "
1092 "stream-name=\"{}\", viewer-stream-id={}",
1093 msg
->type(), stream_iter
->name
, stream_iter
->viewer_stream_id
);
1096 * Get the timestamp in nanoseconds from origin of this
1099 live_get_msg_ts_ns(lttng_live_msg_iter
, msg
->libObjPtr(),
1100 lttng_live_msg_iter
->last_msg_ts_ns
, &curr_msg_ts_ns
);
1103 * Check if the message of the current live stream
1104 * iterator occurred at the exact same time or after the
1105 * last message returned by this component's message
1106 * iterator. If not, we need to handle it with care.
1108 if (curr_msg_ts_ns
>= lttng_live_msg_iter
->last_msg_ts_ns
) {
1109 stream_iter
->current_msg
= std::move(msg
);
1110 stream_iter
->current_msg_ts_ns
= curr_msg_ts_ns
;
1113 * We received a message from the past. This
1114 * may be fixable but it can also be an error.
1116 stream_iter_status
=
1117 handle_late_message(lttng_live_msg_iter
, stream_iter
, curr_msg_ts_ns
, *msg
);
1118 if (stream_iter_status
!= LTTNG_LIVE_ITERATOR_STATUS_OK
) {
1119 BT_CPPLOGE_APPEND_CAUSE_SPEC(lttng_live_msg_iter
->logger
,
1120 "Late message could not be handled correctly: "
1121 "lttng-live-msg-iter-addr={}, "
1122 "stream-name=\"{}\", "
1123 "curr-msg-ts={}, last-msg-ts={}",
1124 fmt::ptr(lttng_live_msg_iter
), stream_iter
->name
,
1126 lttng_live_msg_iter
->last_msg_ts_ns
);
1127 stream_iter_status
= LTTNG_LIVE_ITERATOR_STATUS_ERROR
;
1133 BT_ASSERT_DBG(stream_iter
!= youngest_candidate_stream_iter
);
1135 if (!stream_iter_is_ended
) {
1136 if (G_UNLIKELY(youngest_candidate_stream_iter
== NULL
) ||
1137 stream_iter
->current_msg_ts_ns
< youngest_candidate_msg_ts
) {
1139 * Update the current best candidate message
1140 * for the stream iterator of this live trace
1141 * to be forwarded downstream.
1143 youngest_candidate_msg_ts
= stream_iter
->current_msg_ts_ns
;
1144 youngest_candidate_stream_iter
= stream_iter
;
1145 } else if (stream_iter
->current_msg_ts_ns
== youngest_candidate_msg_ts
) {
1147 * Order the messages in an arbitrary but
1148 * deterministic way.
1150 BT_ASSERT_DBG(stream_iter
!= youngest_candidate_stream_iter
);
1151 int ret
= common_muxing_compare_messages(
1152 stream_iter
->current_msg
->libObjPtr(),
1153 youngest_candidate_stream_iter
->current_msg
->libObjPtr());
1156 * The `youngest_candidate_stream_iter->current_msg`
1157 * should go first. Update the next
1158 * iterator and the current timestamp.
1160 youngest_candidate_msg_ts
= stream_iter
->current_msg_ts_ns
;
1161 youngest_candidate_stream_iter
= stream_iter
;
1162 } else if (ret
== 0) {
1164 * Unable to pick which one should go
1168 lttng_live_msg_iter
->logger
,
1169 "Cannot deterministically pick next live stream message iterator because they have identical next messages: "
1170 "stream-iter-addr={}"
1171 "stream-iter-addr={}",
1172 fmt::ptr(stream_iter
), fmt::ptr(youngest_candidate_stream_iter
));
1179 * The live stream iterator has ended. That
1180 * iterator is removed from the array, but
1181 * there is no need to increment
1182 * stream_iter_idx as
1183 * g_ptr_array_remove_index_fast replaces the
1184 * removed element with the array's last
1187 bt2c::vectorFastRemove(live_trace
->stream_iterators
, stream_iter_idx
);
1191 if (youngest_candidate_stream_iter
) {
1192 *youngest_trace_stream_iter
= youngest_candidate_stream_iter
;
1193 stream_iter_status
= LTTNG_LIVE_ITERATOR_STATUS_OK
;
1196 * The only case where we don't have a candidate for this trace
1197 * is if we reached the end of all the iterators.
1199 BT_ASSERT(live_trace
->stream_iterators
.empty());
1200 stream_iter_status
= LTTNG_LIVE_ITERATOR_STATUS_END
;
1204 return stream_iter_status
;
1207 static enum lttng_live_iterator_status
1208 next_stream_iterator_for_session(struct lttng_live_msg_iter
*lttng_live_msg_iter
,
1209 struct lttng_live_session
*session
,
1210 struct lttng_live_stream_iterator
**youngest_session_stream_iter
)
1212 enum lttng_live_iterator_status stream_iter_status
;
1213 uint64_t trace_idx
= 0;
1214 int64_t youngest_candidate_msg_ts
= INT64_MAX
;
1215 struct lttng_live_stream_iterator
*youngest_candidate_stream_iter
= NULL
;
1217 BT_CPPLOGD_SPEC(lttng_live_msg_iter
->logger
,
1218 "Finding the next stream iterator for session: "
1222 * Make sure we are attached to the session and look for new streams
1225 stream_iter_status
= lttng_live_get_session(lttng_live_msg_iter
, session
);
1226 if (stream_iter_status
!= LTTNG_LIVE_ITERATOR_STATUS_OK
&&
1227 stream_iter_status
!= LTTNG_LIVE_ITERATOR_STATUS_CONTINUE
&&
1228 stream_iter_status
!= LTTNG_LIVE_ITERATOR_STATUS_END
) {
1232 while (trace_idx
< session
->traces
.size()) {
1233 bool trace_is_ended
= false;
1234 struct lttng_live_stream_iterator
*stream_iter
;
1235 lttng_live_trace
*trace
= session
->traces
[trace_idx
].get();
1237 stream_iter_status
=
1238 next_stream_iterator_for_trace(lttng_live_msg_iter
, trace
, &stream_iter
);
1239 if (stream_iter_status
== LTTNG_LIVE_ITERATOR_STATUS_END
) {
1241 * All the live stream iterators for this trace are
1242 * ENDed. Remove the trace from this session.
1244 trace_is_ended
= true;
1245 } else if (stream_iter_status
!= LTTNG_LIVE_ITERATOR_STATUS_OK
) {
1249 if (!trace_is_ended
) {
1250 BT_ASSERT_DBG(stream_iter
);
1252 if (G_UNLIKELY(youngest_candidate_stream_iter
== NULL
) ||
1253 stream_iter
->current_msg_ts_ns
< youngest_candidate_msg_ts
) {
1254 youngest_candidate_msg_ts
= stream_iter
->current_msg_ts_ns
;
1255 youngest_candidate_stream_iter
= stream_iter
;
1256 } else if (stream_iter
->current_msg_ts_ns
== youngest_candidate_msg_ts
) {
1258 * Order the messages in an arbitrary but
1259 * deterministic way.
1261 int ret
= common_muxing_compare_messages(
1262 stream_iter
->current_msg
->libObjPtr(),
1263 youngest_candidate_stream_iter
->current_msg
->libObjPtr());
1266 * The `youngest_candidate_stream_iter->current_msg`
1267 * should go first. Update the next iterator
1268 * and the current timestamp.
1270 youngest_candidate_msg_ts
= stream_iter
->current_msg_ts_ns
;
1271 youngest_candidate_stream_iter
= stream_iter
;
1272 } else if (ret
== 0) {
1273 /* Unable to pick which one should go first. */
1275 lttng_live_msg_iter
->logger
,
1276 "Cannot deterministically pick next live stream message iterator because they have identical next messages: "
1277 "stream-iter-addr={}"
1278 "youngest-candidate-stream-iter-addr={}",
1279 fmt::ptr(stream_iter
), fmt::ptr(youngest_candidate_stream_iter
));
1285 * trace_idx is not incremented since
1286 * vectorFastRemove replaces the
1287 * element at trace_idx with the array's last element.
1289 bt2c::vectorFastRemove(session
->traces
, trace_idx
);
1292 if (youngest_candidate_stream_iter
) {
1293 *youngest_session_stream_iter
= youngest_candidate_stream_iter
;
1294 stream_iter_status
= LTTNG_LIVE_ITERATOR_STATUS_OK
;
1297 * The only cases where we don't have a candidate for this
1299 * 1. if we reached the end of all the iterators of all the
1300 * traces of this session,
1301 * 2. if we never had live stream iterator in the first place.
1303 * In either cases, we return END.
1305 BT_ASSERT(session
->traces
.empty());
1306 stream_iter_status
= LTTNG_LIVE_ITERATOR_STATUS_END
;
1309 return stream_iter_status
;
1312 static inline void put_messages(bt_message_array_const msgs
, uint64_t count
)
1316 for (i
= 0; i
< count
; i
++) {
1317 BT_MESSAGE_PUT_REF_AND_RESET(msgs
[i
]);
1321 bt_message_iterator_class_next_method_status
1322 lttng_live_msg_iter_next(bt_self_message_iterator
*self_msg_it
, bt_message_array_const msgs
,
1323 uint64_t capacity
, uint64_t *count
)
1326 bt_message_iterator_class_next_method_status status
;
1327 enum lttng_live_viewer_status viewer_status
;
1328 struct lttng_live_msg_iter
*lttng_live_msg_iter
=
1329 (struct lttng_live_msg_iter
*) bt_self_message_iterator_get_data(self_msg_it
);
1330 struct lttng_live_component
*lttng_live
= lttng_live_msg_iter
->lttng_live_comp
;
1331 enum lttng_live_iterator_status stream_iter_status
;
1335 BT_ASSERT_DBG(lttng_live_msg_iter
);
1337 if (G_UNLIKELY(lttng_live_msg_iter
->was_interrupted
)) {
1339 * The iterator was interrupted in a previous call to the
1340 * `_next()` method. We currently do not support generating
1341 * messages after such event. The babeltrace2 CLI should never
1342 * be running the graph after being interrupted. So this check
1343 * is to prevent other graph users from using this live
1344 * iterator in an messed up internal state.
1346 status
= BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_ERROR
;
1347 BT_CPPLOGE_APPEND_CAUSE_SPEC(
1348 lttng_live_msg_iter
->logger
,
1349 "Message iterator was interrupted during a previous call to the `next()` and currently does not support continuing after such event.");
1354 * Clear all the invalid message reference that might be left over in
1357 memset(msgs
, 0, capacity
* sizeof(*msgs
));
1360 * If no session are exposed on the relay found at the url provided by
1361 * the user, session count will be 0. In this case, we return status
1362 * end to return gracefully.
1364 if (lttng_live_msg_iter
->sessions
.empty()) {
1365 if (lttng_live
->params
.sess_not_found_act
!= SESSION_NOT_FOUND_ACTION_CONTINUE
) {
1366 status
= BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_END
;
1370 * The are no more active session for this session
1371 * name. Retry to create a viewer session for the
1372 * requested session name.
1374 viewer_status
= lttng_live_create_viewer_session(lttng_live_msg_iter
);
1375 if (viewer_status
!= LTTNG_LIVE_VIEWER_STATUS_OK
) {
1376 if (viewer_status
== LTTNG_LIVE_VIEWER_STATUS_ERROR
) {
1377 status
= BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_ERROR
;
1378 BT_CPPLOGE_APPEND_CAUSE_SPEC(lttng_live_msg_iter
->logger
,
1379 "Error creating LTTng live viewer session");
1380 } else if (viewer_status
== LTTNG_LIVE_VIEWER_STATUS_INTERRUPTED
) {
1381 status
= BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_AGAIN
;
1390 if (lttng_live_msg_iter
->active_stream_iter
== 0) {
1391 lttng_live_force_new_streams_and_metadata(lttng_live_msg_iter
);
1395 * Here the muxing of message is done.
1397 * We need to iterate over all the streams of all the traces of all the
1398 * viewer sessions in order to get the message with the smallest
1399 * timestamp. In this case, a session is a viewer session and there is
1400 * one viewer session per consumer daemon. (UST 32bit, UST 64bit and/or
1401 * kernel). Each viewer session can have multiple traces, for example,
1402 * 64bit UST viewer sessions could have multiple per-pid traces.
1404 * We iterate over the streams of each traces to update and see what is
1405 * their next message's timestamp. From those timestamps, we select the
1406 * message with the smallest timestamp as the best candidate message
1407 * for that trace and do the same thing across all the sessions.
1409 * We then compare the timestamp of best candidate message of all the
1410 * sessions to pick the message with the smallest timestamp and we
1413 while (*count
< capacity
) {
1414 struct lttng_live_stream_iterator
*youngest_stream_iter
= NULL
,
1415 *candidate_stream_iter
= NULL
;
1416 int64_t youngest_msg_ts_ns
= INT64_MAX
;
1418 uint64_t session_idx
= 0;
1419 while (session_idx
< lttng_live_msg_iter
->sessions
.size()) {
1420 lttng_live_session
*session
= lttng_live_msg_iter
->sessions
[session_idx
].get();
1422 /* Find the best candidate message to send downstream. */
1423 stream_iter_status
= next_stream_iterator_for_session(lttng_live_msg_iter
, session
,
1424 &candidate_stream_iter
);
1426 /* If we receive an END status, it means that either:
1427 * - Those traces never had active streams (UST with no
1428 * data produced yet),
1429 * - All live stream iterators have ENDed.
1431 if (stream_iter_status
== LTTNG_LIVE_ITERATOR_STATUS_END
) {
1432 if (session
->closed
&& session
->traces
.empty()) {
1434 * Remove the session from the list.
1435 * session_idx is not modified since
1436 * g_ptr_array_remove_index_fast
1437 * replaces the the removed element with
1438 * the array's last element.
1440 bt2c::vectorFastRemove(lttng_live_msg_iter
->sessions
, session_idx
);
1447 if (stream_iter_status
!= LTTNG_LIVE_ITERATOR_STATUS_OK
) {
1451 if (G_UNLIKELY(youngest_stream_iter
== NULL
) ||
1452 candidate_stream_iter
->current_msg_ts_ns
< youngest_msg_ts_ns
) {
1453 youngest_msg_ts_ns
= candidate_stream_iter
->current_msg_ts_ns
;
1454 youngest_stream_iter
= candidate_stream_iter
;
1455 } else if (candidate_stream_iter
->current_msg_ts_ns
== youngest_msg_ts_ns
) {
1457 * The currently selected message to be sent
1458 * downstream next has the exact same timestamp
1459 * that of the current candidate message. We
1460 * must break the tie in a predictable manner.
1462 BT_CPPLOGD_STR_SPEC(
1463 lttng_live_msg_iter
->logger
,
1464 "Two of the next message candidates have the same timestamps, pick one deterministically.");
1466 * Order the messages in an arbitrary but
1467 * deterministic way.
1469 int ret
= common_muxing_compare_messages(
1470 candidate_stream_iter
->current_msg
->libObjPtr(),
1471 youngest_stream_iter
->current_msg
->libObjPtr());
1474 * The `candidate_stream_iter->current_msg`
1475 * should go first. Update the next
1476 * iterator and the current timestamp.
1478 youngest_msg_ts_ns
= candidate_stream_iter
->current_msg_ts_ns
;
1479 youngest_stream_iter
= candidate_stream_iter
;
1480 } else if (ret
== 0) {
1481 /* Unable to pick which one should go first. */
1483 lttng_live_msg_iter
->logger
,
1484 "Cannot deterministically pick next live stream message iterator because they have identical next messages: "
1485 "next-stream-iter-addr={}"
1486 "candidate-stream-iter-addr={}",
1487 fmt::ptr(youngest_stream_iter
), fmt::ptr(candidate_stream_iter
));
1494 if (!youngest_stream_iter
) {
1495 stream_iter_status
= LTTNG_LIVE_ITERATOR_STATUS_AGAIN
;
1499 BT_ASSERT_DBG(youngest_stream_iter
->current_msg
);
1500 /* Ensure monotonicity. */
1501 BT_ASSERT_DBG(lttng_live_msg_iter
->last_msg_ts_ns
<=
1502 youngest_stream_iter
->current_msg_ts_ns
);
1505 * Insert the next message to the message batch. This will set
1506 * stream iterator current message to NULL so that next time
1507 * we fetch the next message of that stream iterator
1509 msgs
[*count
] = youngest_stream_iter
->current_msg
.release().libObjPtr();
1512 /* Update the last timestamp in nanoseconds sent downstream. */
1513 lttng_live_msg_iter
->last_msg_ts_ns
= youngest_msg_ts_ns
;
1514 youngest_stream_iter
->current_msg_ts_ns
= INT64_MAX
;
1516 stream_iter_status
= LTTNG_LIVE_ITERATOR_STATUS_OK
;
1520 switch (stream_iter_status
) {
1521 case LTTNG_LIVE_ITERATOR_STATUS_OK
:
1522 case LTTNG_LIVE_ITERATOR_STATUS_AGAIN
:
1524 * If we gathered messages, return _OK even if the graph was
1525 * interrupted. This allows for the components downstream to at
1526 * least get the those messages. If the graph was indeed
1527 * interrupted there should not be another _next() call as the
1528 * application will tear down the graph. This component class
1529 * doesn't support restarting after an interruption.
1532 status
= BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_OK
;
1534 status
= BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_AGAIN
;
1537 case LTTNG_LIVE_ITERATOR_STATUS_END
:
1538 status
= BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_END
;
1540 case LTTNG_LIVE_ITERATOR_STATUS_NOMEM
:
1541 BT_CPPLOGE_APPEND_CAUSE_SPEC(lttng_live_msg_iter
->logger
,
1542 "Memory error preparing the next batch of messages: "
1543 "live-iter-status={}",
1544 stream_iter_status
);
1545 status
= BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_MEMORY_ERROR
;
1547 case LTTNG_LIVE_ITERATOR_STATUS_ERROR
:
1548 case LTTNG_LIVE_ITERATOR_STATUS_INVAL
:
1549 case LTTNG_LIVE_ITERATOR_STATUS_UNSUPPORTED
:
1550 BT_CPPLOGE_APPEND_CAUSE_SPEC(lttng_live_msg_iter
->logger
,
1551 "Error preparing the next batch of messages: "
1552 "live-iter-status={}",
1553 stream_iter_status
);
1555 status
= BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_ERROR
;
1556 /* Put all existing messages on error. */
1557 put_messages(msgs
, *count
);
1565 } catch (const std::bad_alloc
&) {
1566 return BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_MEMORY_ERROR
;
1567 } catch (const bt2::Error
&) {
1568 return BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_ERROR
;
1572 static struct lttng_live_msg_iter
*
1573 lttng_live_msg_iter_create(struct lttng_live_component
*lttng_live_comp
,
1574 bt_self_message_iterator
*self_msg_it
)
1576 lttng_live_msg_iter
*msg_iter
= new lttng_live_msg_iter
{lttng_live_comp
->logger
};
1577 msg_iter
->self_comp
= lttng_live_comp
->self_comp
;
1578 msg_iter
->lttng_live_comp
= lttng_live_comp
;
1579 msg_iter
->self_msg_iter
= self_msg_it
;
1581 msg_iter
->active_stream_iter
= 0;
1582 msg_iter
->last_msg_ts_ns
= INT64_MIN
;
1583 msg_iter
->was_interrupted
= false;
1588 bt_message_iterator_class_initialize_method_status
1589 lttng_live_msg_iter_init(bt_self_message_iterator
*self_msg_it
,
1590 bt_self_message_iterator_configuration
*, bt_self_component_port_output
*)
1593 bt_message_iterator_class_initialize_method_status status
;
1594 struct lttng_live_component
*lttng_live
;
1595 struct lttng_live_msg_iter
*lttng_live_msg_iter
;
1596 enum lttng_live_viewer_status viewer_status
;
1597 bt_self_component
*self_comp
= bt_self_message_iterator_borrow_component(self_msg_it
);
1599 lttng_live
= (lttng_live_component
*) bt_self_component_get_data(self_comp
);
1601 /* There can be only one downstream iterator at the same time. */
1602 BT_ASSERT(!lttng_live
->has_msg_iter
);
1603 lttng_live
->has_msg_iter
= true;
1605 lttng_live_msg_iter
= lttng_live_msg_iter_create(lttng_live
, self_msg_it
);
1606 if (!lttng_live_msg_iter
) {
1607 BT_CPPLOGE_APPEND_CAUSE_SPEC(lttng_live
->logger
,
1608 "Failed to create lttng_live_msg_iter");
1609 status
= BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_MEMORY_ERROR
;
1613 viewer_status
= live_viewer_connection_create(
1614 lttng_live
->params
.url
.c_str(), false, lttng_live_msg_iter
, lttng_live_msg_iter
->logger
,
1615 lttng_live_msg_iter
->viewer_connection
);
1616 if (viewer_status
!= LTTNG_LIVE_VIEWER_STATUS_OK
) {
1617 if (viewer_status
== LTTNG_LIVE_VIEWER_STATUS_ERROR
) {
1618 BT_CPPLOGE_APPEND_CAUSE_SPEC(lttng_live_msg_iter
->logger
,
1619 "Failed to create viewer connection");
1620 } else if (viewer_status
== LTTNG_LIVE_VIEWER_STATUS_INTERRUPTED
) {
1622 * Interruption in the _iter_init() method is not
1623 * supported. Return an error.
1625 BT_CPPLOGE_APPEND_CAUSE_SPEC(lttng_live_msg_iter
->logger
,
1626 "Interrupted while creating viewer connection");
1629 status
= BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_ERROR
;
1633 viewer_status
= lttng_live_create_viewer_session(lttng_live_msg_iter
);
1634 if (viewer_status
!= LTTNG_LIVE_VIEWER_STATUS_OK
) {
1635 if (viewer_status
== LTTNG_LIVE_VIEWER_STATUS_ERROR
) {
1636 BT_CPPLOGE_APPEND_CAUSE_SPEC(lttng_live_msg_iter
->logger
,
1637 "Failed to create viewer session");
1638 } else if (viewer_status
== LTTNG_LIVE_VIEWER_STATUS_INTERRUPTED
) {
1640 * Interruption in the _iter_init() method is not
1641 * supported. Return an error.
1643 BT_CPPLOGE_APPEND_CAUSE_SPEC(lttng_live_msg_iter
->logger
,
1644 "Interrupted when creating viewer session");
1647 status
= BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_ERROR
;
1651 if (lttng_live_msg_iter
->sessions
.empty()) {
1652 switch (lttng_live
->params
.sess_not_found_act
) {
1653 case SESSION_NOT_FOUND_ACTION_CONTINUE
:
1655 lttng_live_msg_iter
->logger
,
1656 "Unable to connect to the requested live viewer session. "
1657 "Keep trying to connect because of {}=\"{}\" component parameter: url=\"{}\"",
1658 SESS_NOT_FOUND_ACTION_PARAM
, SESS_NOT_FOUND_ACTION_CONTINUE_STR
,
1659 lttng_live
->params
.url
);
1661 case SESSION_NOT_FOUND_ACTION_FAIL
:
1662 BT_CPPLOGE_APPEND_CAUSE_SPEC(
1663 lttng_live_msg_iter
->logger
,
1664 "Unable to connect to the requested live viewer session. "
1665 "Fail the message iterator initialization because of {}=\"{}\" "
1666 "component parameter: url =\"{}\"",
1667 SESS_NOT_FOUND_ACTION_PARAM
, SESS_NOT_FOUND_ACTION_FAIL_STR
,
1668 lttng_live
->params
.url
);
1669 status
= BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_ERROR
;
1671 case SESSION_NOT_FOUND_ACTION_END
:
1672 BT_CPPLOGI_SPEC(lttng_live_msg_iter
->logger
,
1673 "Unable to connect to the requested live viewer session. "
1674 "End gracefully at the first _next() call because of {}=\"{}\""
1675 " component parameter: url=\"{}\"",
1676 SESS_NOT_FOUND_ACTION_PARAM
, SESS_NOT_FOUND_ACTION_END_STR
,
1677 lttng_live
->params
.url
);
1684 bt_self_message_iterator_set_data(self_msg_it
, lttng_live_msg_iter
);
1685 status
= BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_OK
;
1689 delete lttng_live_msg_iter
;
1692 } catch (const std::bad_alloc
&) {
1693 return BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_MEMORY_ERROR
;
1694 } catch (const bt2::Error
&) {
1695 return BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_ERROR
;
1699 static struct bt_param_validation_map_value_entry_descr list_sessions_params
[] = {
1700 {URL_PARAM
, BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_MANDATORY
,
1701 bt_param_validation_value_descr::makeString()},
1702 BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_END
};
1704 static bt_component_class_query_method_status
1705 lttng_live_query_list_sessions(const bt_value
*params
, const bt_value
**result
,
1706 const bt2c::Logger
& logger
)
1708 bt_component_class_query_method_status status
;
1709 const bt_value
*url_value
= NULL
;
1711 live_viewer_connection::UP viewer_connection
;
1712 enum lttng_live_viewer_status viewer_status
;
1713 enum bt_param_validation_status validation_status
;
1714 gchar
*validate_error
= NULL
;
1716 validation_status
= bt_param_validation_validate(params
, list_sessions_params
, &validate_error
);
1717 if (validation_status
== BT_PARAM_VALIDATION_STATUS_MEMORY_ERROR
) {
1718 status
= BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_MEMORY_ERROR
;
1720 } else if (validation_status
== BT_PARAM_VALIDATION_STATUS_VALIDATION_ERROR
) {
1721 status
= BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_ERROR
;
1722 BT_CPPLOGE_APPEND_CAUSE_SPEC(logger
, "{}", validate_error
);
1726 url_value
= bt_value_map_borrow_entry_value_const(params
, URL_PARAM
);
1727 url
= bt_value_string_get(url_value
);
1729 viewer_status
= live_viewer_connection_create(url
, true, NULL
, logger
, viewer_connection
);
1730 if (viewer_status
!= LTTNG_LIVE_VIEWER_STATUS_OK
) {
1731 if (viewer_status
== LTTNG_LIVE_VIEWER_STATUS_ERROR
) {
1732 BT_CPPLOGE_APPEND_CAUSE_SPEC(logger
, "Failed to create viewer connection");
1733 status
= BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_ERROR
;
1734 } else if (viewer_status
== LTTNG_LIVE_VIEWER_STATUS_INTERRUPTED
) {
1735 status
= BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_AGAIN
;
1742 status
= live_viewer_connection_list_sessions(viewer_connection
.get(), result
);
1743 if (status
!= BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_OK
) {
1744 BT_CPPLOGE_APPEND_CAUSE_SPEC(logger
, "Failed to list viewer sessions");
1751 BT_VALUE_PUT_REF_AND_RESET(*result
);
1754 status
= BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_ERROR
;
1758 g_free(validate_error
);
1763 static bt_component_class_query_method_status
1764 lttng_live_query_support_info(const bt_value
*params
, const bt_value
**result
,
1765 const bt2c::Logger
& logger
)
1767 bt_component_class_query_method_status status
= BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_OK
;
1768 const bt_value
*input_type_value
;
1769 const bt_value
*input_value
;
1771 struct bt_common_lttng_live_url_parts parts
= {};
1773 /* Used by the logging macros */
1774 __attribute__((unused
)) bt_self_component
*self_comp
= NULL
;
1777 input_type_value
= bt_value_map_borrow_entry_value_const(params
, "type");
1778 if (!input_type_value
) {
1779 BT_CPPLOGE_APPEND_CAUSE_SPEC(logger
, "Missing expected `type` parameter.");
1783 if (!bt_value_is_string(input_type_value
)) {
1784 BT_CPPLOGE_APPEND_CAUSE_SPEC(logger
, "`type` parameter is not a string value.");
1788 if (strcmp(bt_value_string_get(input_type_value
), "string") != 0) {
1789 /* We don't handle file system paths */
1793 input_value
= bt_value_map_borrow_entry_value_const(params
, "input");
1795 BT_CPPLOGE_APPEND_CAUSE_SPEC(logger
, "Missing expected `input` parameter.");
1799 if (!bt_value_is_string(input_value
)) {
1800 BT_CPPLOGE_APPEND_CAUSE_SPEC(logger
, "`input` parameter is not a string value.");
1804 parts
= bt_common_parse_lttng_live_url(bt_value_string_get(input_value
), NULL
, 0);
1805 if (parts
.session_name
) {
1807 * Looks pretty much like an LTTng live URL: we got the
1808 * session name part, which forms a complete URL.
1814 *result
= bt_value_real_create_init(weight
);
1816 status
= BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_MEMORY_ERROR
;
1824 status
= BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_ERROR
;
1827 BT_ASSERT(!*result
);
1830 bt_common_destroy_lttng_live_url_parts(&parts
);
1834 bt_component_class_query_method_status
lttng_live_query(bt_self_component_class_source
*comp_class
,
1835 bt_private_query_executor
*priv_query_exec
,
1836 const char *object
, const bt_value
*params
,
1837 __attribute__((unused
)) void *method_data
,
1838 const bt_value
**result
)
1841 bt_component_class_query_method_status status
= BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_OK
;
1842 bt2c::Logger logger
{bt2::SelfComponentClass
{comp_class
},
1843 bt2::PrivateQueryExecutor
{priv_query_exec
},
1844 "PLUGIN/SRC.CTF.LTTNG-LIVE/QUERY"};
1846 if (strcmp(object
, "sessions") == 0) {
1847 status
= lttng_live_query_list_sessions(params
, result
, logger
);
1848 } else if (strcmp(object
, "babeltrace.support-info") == 0) {
1849 status
= lttng_live_query_support_info(params
, result
, logger
);
1851 BT_CPPLOGI_SPEC(logger
, "Unknown query object `{}`", object
);
1852 status
= BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_UNKNOWN_OBJECT
;
1858 } catch (const std::bad_alloc
&) {
1859 return BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_MEMORY_ERROR
;
1860 } catch (const bt2::Error
&) {
1861 return BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_ERROR
;
1865 void lttng_live_component_finalize(bt_self_component_source
*component
)
1867 lttng_live_component::UP
{static_cast<lttng_live_component
*>(
1868 bt_self_component_get_data(bt_self_component_source_as_self_component(component
)))};
1871 static enum session_not_found_action
1872 parse_session_not_found_action_param(const bt_value
*no_session_param
)
1874 enum session_not_found_action action
;
1875 const char *no_session_act_str
= bt_value_string_get(no_session_param
);
1877 if (strcmp(no_session_act_str
, SESS_NOT_FOUND_ACTION_CONTINUE_STR
) == 0) {
1878 action
= SESSION_NOT_FOUND_ACTION_CONTINUE
;
1879 } else if (strcmp(no_session_act_str
, SESS_NOT_FOUND_ACTION_FAIL_STR
) == 0) {
1880 action
= SESSION_NOT_FOUND_ACTION_FAIL
;
1882 BT_ASSERT(strcmp(no_session_act_str
, SESS_NOT_FOUND_ACTION_END_STR
) == 0);
1883 action
= SESSION_NOT_FOUND_ACTION_END
;
1889 static bt_param_validation_value_descr inputs_elem_descr
=
1890 bt_param_validation_value_descr::makeString();
1892 static const char *sess_not_found_action_choices
[] = {
1893 SESS_NOT_FOUND_ACTION_CONTINUE_STR
,
1894 SESS_NOT_FOUND_ACTION_FAIL_STR
,
1895 SESS_NOT_FOUND_ACTION_END_STR
,
1898 static struct bt_param_validation_map_value_entry_descr params_descr
[] = {
1899 {INPUTS_PARAM
, BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_MANDATORY
,
1900 bt_param_validation_value_descr::makeArray(1, 1, inputs_elem_descr
)},
1901 {SESS_NOT_FOUND_ACTION_PARAM
, BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL
,
1902 bt_param_validation_value_descr::makeString(sess_not_found_action_choices
)},
1903 BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_END
};
1905 static bt_component_class_initialize_method_status
1906 lttng_live_component_create(const bt_value
*params
, bt_self_component_source
*self_comp
,
1907 lttng_live_component::UP
& component
)
1909 const bt_value
*inputs_value
;
1910 const bt_value
*url_value
;
1911 const bt_value
*value
;
1912 enum bt_param_validation_status validation_status
;
1913 gchar
*validation_error
= NULL
;
1914 bt2c::Logger logger
{bt2::SelfSourceComponent
{self_comp
}, "PLUGIN/SRC.CTF.LTTNG-LIVE/COMP"};
1916 validation_status
= bt_param_validation_validate(params
, params_descr
, &validation_error
);
1917 if (validation_status
== BT_PARAM_VALIDATION_STATUS_MEMORY_ERROR
) {
1918 return BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_MEMORY_ERROR
;
1919 } else if (validation_status
== BT_PARAM_VALIDATION_STATUS_VALIDATION_ERROR
) {
1920 bt2c::GCharUP errorFreer
{validation_error
};
1921 BT_CPPLOGE_APPEND_CAUSE_SPEC(logger
, "{}", validation_error
);
1922 return BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_ERROR
;
1925 auto lttng_live
= bt2s::make_unique
<lttng_live_component
>(std::move(logger
));
1926 lttng_live
->self_comp
= bt_self_component_source_as_self_component(self_comp
);
1927 lttng_live
->max_query_size
= MAX_QUERY_SIZE
;
1928 lttng_live
->has_msg_iter
= false;
1930 inputs_value
= bt_value_map_borrow_entry_value_const(params
, INPUTS_PARAM
);
1931 url_value
= bt_value_array_borrow_element_by_index_const(inputs_value
, 0);
1932 lttng_live
->params
.url
= bt_value_string_get(url_value
);
1934 value
= bt_value_map_borrow_entry_value_const(params
, SESS_NOT_FOUND_ACTION_PARAM
);
1936 lttng_live
->params
.sess_not_found_act
= parse_session_not_found_action_param(value
);
1938 BT_CPPLOGI_SPEC(lttng_live
->logger
,
1939 "Optional `{}` parameter is missing: defaulting to `{}`.",
1940 SESS_NOT_FOUND_ACTION_PARAM
, SESS_NOT_FOUND_ACTION_CONTINUE_STR
);
1941 lttng_live
->params
.sess_not_found_act
= SESSION_NOT_FOUND_ACTION_CONTINUE
;
1944 component
= std::move(lttng_live
);
1945 return BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_OK
;
1948 bt_component_class_initialize_method_status
1949 lttng_live_component_init(bt_self_component_source
*self_comp_src
,
1950 bt_self_component_source_configuration
*, const bt_value
*params
, void *)
1953 lttng_live_component::UP lttng_live
;
1954 bt_component_class_initialize_method_status ret
;
1955 bt_self_component
*self_comp
= bt_self_component_source_as_self_component(self_comp_src
);
1956 bt_self_component_add_port_status add_port_status
;
1958 ret
= lttng_live_component_create(params
, self_comp_src
, lttng_live
);
1959 if (ret
!= BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_OK
) {
1964 bt_self_component_source_add_output_port(self_comp_src
, "out", NULL
, NULL
);
1965 if (add_port_status
!= BT_SELF_COMPONENT_ADD_PORT_STATUS_OK
) {
1966 ret
= (bt_component_class_initialize_method_status
) add_port_status
;
1970 bt_self_component_set_data(self_comp
, lttng_live
.release());
1972 return BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_OK
;
1973 } catch (const std::bad_alloc
&) {
1974 return BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_MEMORY_ERROR
;
1975 } catch (const bt2::Error
&) {
1976 return BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_ERROR
;