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
11 #define BT_COMP_LOG_SELF_COMP self_comp
12 #define BT_LOG_OUTPUT_LEVEL log_level
13 #define BT_LOG_TAG "PLUGIN/SRC.CTF.LTTNG-LIVE"
14 #include "logging/comp-logging.h"
22 #include "common/assert.h"
23 #include <babeltrace2/babeltrace.h>
24 #include "compat/compiler.h"
25 #include <babeltrace2/types.h>
27 #include "plugins/common/muxing/muxing.h"
28 #include "plugins/common/param-validation/param-validation.h"
30 #include "data-stream.h"
32 #include "lttng-live.h"
34 #define MAX_QUERY_SIZE (256*1024)
35 #define URL_PARAM "url"
36 #define INPUTS_PARAM "inputs"
37 #define SESS_NOT_FOUND_ACTION_PARAM "session-not-found-action"
38 #define SESS_NOT_FOUND_ACTION_CONTINUE_STR "continue"
39 #define SESS_NOT_FOUND_ACTION_FAIL_STR "fail"
40 #define SESS_NOT_FOUND_ACTION_END_STR "end"
42 #define print_dbg(fmt, ...) BT_COMP_LOGD(fmt, ## __VA_ARGS__)
45 const char *lttng_live_iterator_status_string(
46 enum lttng_live_iterator_status status
)
49 case LTTNG_LIVE_ITERATOR_STATUS_CONTINUE
:
50 return "LTTNG_LIVE_ITERATOR_STATUS_CONTINUE";
51 case LTTNG_LIVE_ITERATOR_STATUS_AGAIN
:
52 return "LTTNG_LIVE_ITERATOR_STATUS_AGAIN";
53 case LTTNG_LIVE_ITERATOR_STATUS_END
:
54 return "LTTNG_LIVE_ITERATOR_STATUS_END";
55 case LTTNG_LIVE_ITERATOR_STATUS_OK
:
56 return "LTTNG_LIVE_ITERATOR_STATUS_OK";
57 case LTTNG_LIVE_ITERATOR_STATUS_INVAL
:
58 return "LTTNG_LIVE_ITERATOR_STATUS_INVAL";
59 case LTTNG_LIVE_ITERATOR_STATUS_ERROR
:
60 return "LTTNG_LIVE_ITERATOR_STATUS_ERROR";
61 case LTTNG_LIVE_ITERATOR_STATUS_NOMEM
:
62 return "LTTNG_LIVE_ITERATOR_STATUS_NOMEM";
63 case LTTNG_LIVE_ITERATOR_STATUS_UNSUPPORTED
:
64 return "LTTNG_LIVE_ITERATOR_STATUS_UNSUPPORTED";
71 const char *lttng_live_stream_state_string(enum lttng_live_stream_state state
)
74 case LTTNG_LIVE_STREAM_ACTIVE_NO_DATA
:
75 return "ACTIVE_NO_DATA";
76 case LTTNG_LIVE_STREAM_QUIESCENT_NO_DATA
:
77 return "QUIESCENT_NO_DATA";
78 case LTTNG_LIVE_STREAM_QUIESCENT
:
80 case LTTNG_LIVE_STREAM_ACTIVE_DATA
:
82 case LTTNG_LIVE_STREAM_EOF
:
89 void lttng_live_stream_iterator_set_state(struct lttng_live_stream_iterator
*stream_iter
,
90 enum lttng_live_stream_state new_state
)
92 bt_self_component
*self_comp
= stream_iter
->self_comp
;
93 bt_logging_level log_level
= stream_iter
->log_level
;
95 BT_COMP_LOGD("Setting live stream iterator state: viewer-stream-id=%" PRIu64
96 ", old-state=%s, new-state=%s",
97 stream_iter
->viewer_stream_id
,
98 lttng_live_stream_state_string(stream_iter
->state
),
99 lttng_live_stream_state_string(new_state
));
101 stream_iter
->state
= new_state
;
104 #define LTTNG_LIVE_LOGD_STREAM_ITER(live_stream_iter) \
106 BT_COMP_LOGD("Live stream iterator state=%s, " \
107 "last-inact-ts-is-set=%d, last-inact-ts-value=%" PRId64 ", " \
108 "curr-inact-ts=%" PRId64, \
109 lttng_live_stream_state_string(live_stream_iter->state), \
110 live_stream_iter->last_inactivity_ts.is_set, \
111 live_stream_iter->last_inactivity_ts.value, \
112 live_stream_iter->current_inactivity_ts); \
116 bool lttng_live_graph_is_canceled(struct lttng_live_msg_iter
*msg_iter
)
125 ret
= bt_self_message_iterator_is_interrupted(
126 msg_iter
->self_msg_iter
);
133 struct lttng_live_trace
*lttng_live_session_borrow_trace_by_id(struct lttng_live_session
*session
,
137 struct lttng_live_trace
*ret_trace
= NULL
;
139 for (trace_idx
= 0; trace_idx
< session
->traces
->len
; trace_idx
++) {
140 struct lttng_live_trace
*trace
=
141 g_ptr_array_index(session
->traces
, trace_idx
);
142 if (trace
->id
== trace_id
) {
153 void lttng_live_destroy_trace(struct lttng_live_trace
*trace
)
155 bt_logging_level log_level
= trace
->log_level
;
156 bt_self_component
*self_comp
= trace
->self_comp
;
158 BT_COMP_LOGD("Destroying live trace: trace-id=%"PRIu64
, trace
->id
);
160 BT_ASSERT(trace
->stream_iterators
);
161 g_ptr_array_free(trace
->stream_iterators
, TRUE
);
163 BT_TRACE_PUT_REF_AND_RESET(trace
->trace
);
164 BT_TRACE_CLASS_PUT_REF_AND_RESET(trace
->trace_class
);
166 lttng_live_metadata_fini(trace
);
171 struct lttng_live_trace
*lttng_live_create_trace(struct lttng_live_session
*session
,
174 struct lttng_live_trace
*trace
= NULL
;
175 bt_logging_level log_level
= session
->log_level
;
176 bt_self_component
*self_comp
= session
->self_comp
;
178 BT_COMP_LOGD("Creating live trace: "
179 "session-id=%"PRIu64
", trace-id=%"PRIu64
,
180 session
->id
, trace_id
);
181 trace
= g_new0(struct lttng_live_trace
, 1);
183 BT_COMP_LOGE_APPEND_CAUSE(self_comp
,
184 "Failed to allocate live trace");
187 trace
->log_level
= session
->log_level
;
188 trace
->self_comp
= session
->self_comp
;
189 trace
->session
= session
;
190 trace
->id
= trace_id
;
191 trace
->trace_class
= NULL
;
193 trace
->stream_iterators
= g_ptr_array_new_with_free_func(
194 (GDestroyNotify
) lttng_live_stream_iterator_destroy
);
195 BT_ASSERT(trace
->stream_iterators
);
196 trace
->metadata_stream_state
= LTTNG_LIVE_METADATA_STREAM_STATE_NEEDED
;
197 g_ptr_array_add(session
->traces
, trace
);
208 struct lttng_live_trace
*lttng_live_session_borrow_or_create_trace_by_id(
209 struct lttng_live_session
*session
, uint64_t trace_id
)
211 struct lttng_live_trace
*trace
;
213 trace
= lttng_live_session_borrow_trace_by_id(session
, trace_id
);
218 /* The session is the owner of the newly created trace. */
219 trace
= lttng_live_create_trace(session
, trace_id
);
226 int lttng_live_add_session(struct lttng_live_msg_iter
*lttng_live_msg_iter
,
227 uint64_t session_id
, const char *hostname
,
228 const char *session_name
)
231 struct lttng_live_session
*session
;
232 bt_logging_level log_level
= lttng_live_msg_iter
->log_level
;
233 bt_self_component
*self_comp
= lttng_live_msg_iter
->self_comp
;
235 BT_COMP_LOGD("Adding live session: "
236 "session-id=%" PRIu64
", hostname=\"%s\" session-name=\"%s\"",
237 session_id
, hostname
, session_name
);
239 session
= g_new0(struct lttng_live_session
, 1);
241 BT_COMP_LOGE_APPEND_CAUSE(self_comp
,
242 "Failed to allocate live session");
246 session
->log_level
= lttng_live_msg_iter
->log_level
;
247 session
->self_comp
= lttng_live_msg_iter
->self_comp
;
248 session
->id
= session_id
;
249 session
->traces
= g_ptr_array_new_with_free_func(
250 (GDestroyNotify
) lttng_live_destroy_trace
);
251 BT_ASSERT(session
->traces
);
252 session
->lttng_live_msg_iter
= lttng_live_msg_iter
;
253 session
->new_streams_needed
= true;
254 session
->hostname
= g_string_new(hostname
);
255 BT_ASSERT(session
->hostname
);
257 session
->session_name
= g_string_new(session_name
);
258 BT_ASSERT(session
->session_name
);
260 g_ptr_array_add(lttng_live_msg_iter
->sessions
, session
);
270 void lttng_live_destroy_session(struct lttng_live_session
*session
)
272 bt_logging_level log_level
;
273 bt_self_component
*self_comp
;
279 log_level
= session
->log_level
;
280 self_comp
= session
->self_comp
;
281 BT_COMP_LOGD("Destroying live session: "
282 "session-id=%"PRIu64
", session-name=\"%s\"",
283 session
->id
, session
->session_name
->str
);
284 if (session
->id
!= -1ULL) {
285 if (lttng_live_session_detach(session
)) {
286 if (!lttng_live_graph_is_canceled(
287 session
->lttng_live_msg_iter
)) {
288 /* Old relayd cannot detach sessions. */
289 BT_COMP_LOGD("Unable to detach lttng live session %" PRIu64
,
296 if (session
->traces
) {
297 g_ptr_array_free(session
->traces
, TRUE
);
300 if (session
->hostname
) {
301 g_string_free(session
->hostname
, TRUE
);
303 if (session
->session_name
) {
304 g_string_free(session
->session_name
, TRUE
);
313 void lttng_live_msg_iter_destroy(struct lttng_live_msg_iter
*lttng_live_msg_iter
)
315 if (!lttng_live_msg_iter
) {
319 if (lttng_live_msg_iter
->sessions
) {
320 g_ptr_array_free(lttng_live_msg_iter
->sessions
, TRUE
);
323 if (lttng_live_msg_iter
->viewer_connection
) {
324 live_viewer_connection_destroy(lttng_live_msg_iter
->viewer_connection
);
326 BT_ASSERT(lttng_live_msg_iter
->lttng_live_comp
);
327 BT_ASSERT(lttng_live_msg_iter
->lttng_live_comp
->has_msg_iter
);
329 /* All stream iterators must be destroyed at this point. */
330 BT_ASSERT(lttng_live_msg_iter
->active_stream_iter
== 0);
331 lttng_live_msg_iter
->lttng_live_comp
->has_msg_iter
= false;
333 g_free(lttng_live_msg_iter
);
340 void lttng_live_msg_iter_finalize(bt_self_message_iterator
*self_msg_iter
)
342 struct lttng_live_msg_iter
*lttng_live_msg_iter
;
344 BT_ASSERT(self_msg_iter
);
346 lttng_live_msg_iter
= bt_self_message_iterator_get_data(self_msg_iter
);
347 BT_ASSERT(lttng_live_msg_iter
);
348 lttng_live_msg_iter_destroy(lttng_live_msg_iter
);
352 enum lttng_live_iterator_status
lttng_live_iterator_next_check_stream_state(
353 struct lttng_live_stream_iterator
*lttng_live_stream
)
355 bt_logging_level log_level
= lttng_live_stream
->log_level
;
356 bt_self_component
*self_comp
= lttng_live_stream
->self_comp
;
358 switch (lttng_live_stream
->state
) {
359 case LTTNG_LIVE_STREAM_QUIESCENT
:
360 case LTTNG_LIVE_STREAM_ACTIVE_DATA
:
362 case LTTNG_LIVE_STREAM_ACTIVE_NO_DATA
:
364 BT_COMP_LOGF("Unexpected stream state \"ACTIVE_NO_DATA\"");
366 case LTTNG_LIVE_STREAM_QUIESCENT_NO_DATA
:
368 BT_COMP_LOGF("Unexpected stream state \"QUIESCENT_NO_DATA\"");
370 case LTTNG_LIVE_STREAM_EOF
:
373 return LTTNG_LIVE_ITERATOR_STATUS_OK
;
377 * For active no data stream, fetch next index. As a result of that it can
379 * - quiescent: won't have events for a bit,
380 * - have data: need to get that data and produce the event,
381 * - have no data on this stream at this point: need to retry (AGAIN) or return
385 enum lttng_live_iterator_status
lttng_live_iterator_next_handle_one_no_data_stream(
386 struct lttng_live_msg_iter
*lttng_live_msg_iter
,
387 struct lttng_live_stream_iterator
*lttng_live_stream
)
389 bt_logging_level log_level
= lttng_live_msg_iter
->log_level
;
390 bt_self_component
*self_comp
= lttng_live_msg_iter
->self_comp
;
391 enum lttng_live_iterator_status ret
= LTTNG_LIVE_ITERATOR_STATUS_OK
;
392 enum lttng_live_stream_state orig_state
= lttng_live_stream
->state
;
393 struct packet_index index
;
395 if (lttng_live_stream
->trace
->metadata_stream_state
==
396 LTTNG_LIVE_METADATA_STREAM_STATE_NEEDED
) {
397 BT_COMP_LOGD("Need to get an update for the metadata stream before proceeding further with this stream: "
398 "stream-name=\"%s\"", lttng_live_stream
->name
->str
);
399 ret
= LTTNG_LIVE_ITERATOR_STATUS_CONTINUE
;
403 if (lttng_live_stream
->trace
->session
->new_streams_needed
) {
404 BT_COMP_LOGD("Need to get an update of all streams before proceeding further with this stream: "
405 "stream-name=\"%s\"", lttng_live_stream
->name
->str
);
406 ret
= LTTNG_LIVE_ITERATOR_STATUS_CONTINUE
;
410 if (lttng_live_stream
->state
!= LTTNG_LIVE_STREAM_ACTIVE_NO_DATA
&&
411 lttng_live_stream
->state
!= LTTNG_LIVE_STREAM_QUIESCENT_NO_DATA
) {
414 ret
= lttng_live_get_next_index(lttng_live_msg_iter
, lttng_live_stream
,
416 if (ret
!= LTTNG_LIVE_ITERATOR_STATUS_OK
) {
420 BT_ASSERT_DBG(lttng_live_stream
->state
!= LTTNG_LIVE_STREAM_EOF
);
422 if (lttng_live_stream
->state
== LTTNG_LIVE_STREAM_QUIESCENT
) {
423 uint64_t last_inact_ts
= lttng_live_stream
->last_inactivity_ts
.value
,
424 curr_inact_ts
= lttng_live_stream
->current_inactivity_ts
;
426 if (orig_state
== LTTNG_LIVE_STREAM_QUIESCENT_NO_DATA
&&
427 last_inact_ts
== curr_inact_ts
) {
429 * Because the stream is in the QUIESCENT_NO_DATA
430 * state, we can assert that the last_inactivity_ts was
431 * set and can be safely used in the `if` above.
433 BT_ASSERT(lttng_live_stream
->last_inactivity_ts
.is_set
);
435 ret
= LTTNG_LIVE_ITERATOR_STATUS_AGAIN
;
436 LTTNG_LIVE_LOGD_STREAM_ITER(lttng_live_stream
);
438 ret
= LTTNG_LIVE_ITERATOR_STATUS_CONTINUE
;
443 lttng_live_stream
->base_offset
= index
.offset
;
444 lttng_live_stream
->offset
= index
.offset
;
445 lttng_live_stream
->len
= index
.packet_size
/ CHAR_BIT
;
447 BT_COMP_LOGD("Setting live stream reading info: stream-name=\"%s\", "
448 "viewer-stream-id=%" PRIu64
", stream-base-offset=%" PRIu64
449 ", stream-offset=%" PRIu64
", stream-len=%" PRIu64
,
450 lttng_live_stream
->name
->str
,
451 lttng_live_stream
->viewer_stream_id
,
452 lttng_live_stream
->base_offset
,
453 lttng_live_stream
->offset
, lttng_live_stream
->len
);
456 if (ret
== LTTNG_LIVE_ITERATOR_STATUS_OK
) {
457 ret
= lttng_live_iterator_next_check_stream_state(lttng_live_stream
);
463 * Creation of the message requires the ctf trace class to be created
464 * beforehand, but the live protocol gives us all streams (including metadata)
465 * at once. So we split it in three steps: getting streams, getting metadata
466 * (which creates the ctf trace class), and then creating the per-stream
470 enum lttng_live_iterator_status
lttng_live_get_session(
471 struct lttng_live_msg_iter
*lttng_live_msg_iter
,
472 struct lttng_live_session
*session
)
474 bt_logging_level log_level
= lttng_live_msg_iter
->log_level
;
475 bt_self_component
*self_comp
= lttng_live_msg_iter
->self_comp
;
476 enum lttng_live_iterator_status status
;
479 if (!session
->attached
) {
480 BT_COMP_LOGD("Attach to session: session-id=%" PRIu64
,
482 enum lttng_live_viewer_status attach_status
=
483 lttng_live_session_attach(session
,
484 lttng_live_msg_iter
->self_msg_iter
);
485 if (attach_status
!= LTTNG_LIVE_VIEWER_STATUS_OK
) {
486 if (lttng_live_graph_is_canceled(lttng_live_msg_iter
)) {
488 * Clear any causes appended in
489 * `lttng_live_attach_session()` as we want to
490 * return gracefully since the graph was
493 bt_current_thread_clear_error();
494 status
= LTTNG_LIVE_ITERATOR_STATUS_AGAIN
;
496 status
= LTTNG_LIVE_ITERATOR_STATUS_ERROR
;
497 BT_COMP_LOGE_APPEND_CAUSE(self_comp
,
498 "Error attaching to LTTng live session");
504 BT_COMP_LOGD("Updating all streams and metadata for session: "
505 "session-id=%" PRIu64
", session-name=\"%s\"",
506 session
->id
, session
->session_name
->str
);
508 status
= lttng_live_session_get_new_streams(session
,
509 lttng_live_msg_iter
->self_msg_iter
);
510 if (status
!= LTTNG_LIVE_ITERATOR_STATUS_OK
&&
511 status
!= LTTNG_LIVE_ITERATOR_STATUS_END
) {
516 while (trace_idx
< session
->traces
->len
) {
517 struct lttng_live_trace
*trace
=
518 g_ptr_array_index(session
->traces
, trace_idx
);
520 status
= lttng_live_metadata_update(trace
);
522 case LTTNG_LIVE_ITERATOR_STATUS_END
:
523 case LTTNG_LIVE_ITERATOR_STATUS_OK
:
526 case LTTNG_LIVE_ITERATOR_STATUS_CONTINUE
:
527 case LTTNG_LIVE_ITERATOR_STATUS_AGAIN
:
530 BT_COMP_LOGE_APPEND_CAUSE(self_comp
,
531 "Error updating trace metadata: "
532 "stream-iter-status=%s, trace-id=%"PRIu64
,
533 lttng_live_iterator_status_string(status
),
540 * Now that we have the metadata we can initialize the downstream
543 status
= lttng_live_lazy_msg_init(session
,
544 lttng_live_msg_iter
->self_msg_iter
);
551 void lttng_live_force_new_streams_and_metadata(struct lttng_live_msg_iter
*lttng_live_msg_iter
)
553 uint64_t session_idx
, trace_idx
;
554 bt_logging_level log_level
= lttng_live_msg_iter
->log_level
;
555 bt_self_component
*self_comp
= lttng_live_msg_iter
->self_comp
;
557 for (session_idx
= 0; session_idx
< lttng_live_msg_iter
->sessions
->len
;
559 struct lttng_live_session
*session
=
560 g_ptr_array_index(lttng_live_msg_iter
->sessions
, session_idx
);
561 BT_COMP_LOGD("Force marking session as needing new streams: "
562 "session-id=%" PRIu64
, session
->id
);
563 session
->new_streams_needed
= true;
564 for (trace_idx
= 0; trace_idx
< session
->traces
->len
;
566 struct lttng_live_trace
*trace
=
567 g_ptr_array_index(session
->traces
, trace_idx
);
568 BT_COMP_LOGD("Force marking trace metadata state as needing an update: "
569 "session-id=%" PRIu64
", trace-id=%" PRIu64
,
570 session
->id
, trace
->id
);
572 BT_ASSERT(trace
->metadata_stream_state
!=
573 LTTNG_LIVE_METADATA_STREAM_STATE_CLOSED
);
575 trace
->metadata_stream_state
= LTTNG_LIVE_METADATA_STREAM_STATE_NEEDED
;
581 enum lttng_live_iterator_status
582 lttng_live_iterator_handle_new_streams_and_metadata(
583 struct lttng_live_msg_iter
*lttng_live_msg_iter
)
585 enum lttng_live_iterator_status status
;
586 enum lttng_live_viewer_status viewer_status
;
587 bt_logging_level log_level
= lttng_live_msg_iter
->log_level
;
588 bt_self_component
*self_comp
= lttng_live_msg_iter
->self_comp
;
589 uint64_t session_idx
= 0, nr_sessions_opened
= 0;
590 struct lttng_live_session
*session
;
591 enum session_not_found_action sess_not_found_act
=
592 lttng_live_msg_iter
->lttng_live_comp
->params
.sess_not_found_act
;
594 BT_COMP_LOGD("Update data and metadata of all sessions: "
595 "live-msg-iter-addr=%p", lttng_live_msg_iter
);
597 * In a remotely distant future, we could add a "new
598 * session" flag to the protocol, which would tell us that we
599 * need to query for new sessions even though we have sessions
602 if (lttng_live_msg_iter
->sessions
->len
== 0) {
603 if (sess_not_found_act
!= SESSION_NOT_FOUND_ACTION_CONTINUE
) {
604 BT_COMP_LOGD("No session found. Exiting in accordance with the `session-not-found-action` parameter");
605 status
= LTTNG_LIVE_ITERATOR_STATUS_END
;
608 BT_COMP_LOGD("No session found. Try creating a new one in accordance with the `session-not-found-action` parameter");
610 * Retry to create a viewer session for the requested
613 viewer_status
= lttng_live_create_viewer_session(lttng_live_msg_iter
);
614 if (viewer_status
!= LTTNG_LIVE_VIEWER_STATUS_OK
) {
615 if (viewer_status
== LTTNG_LIVE_VIEWER_STATUS_ERROR
) {
616 status
= LTTNG_LIVE_ITERATOR_STATUS_ERROR
;
617 BT_COMP_LOGE_APPEND_CAUSE(self_comp
,
618 "Error creating LTTng live viewer session");
619 } else if (viewer_status
== LTTNG_LIVE_VIEWER_STATUS_INTERRUPTED
) {
620 status
= LTTNG_LIVE_ITERATOR_STATUS_AGAIN
;
629 for (session_idx
= 0; session_idx
< lttng_live_msg_iter
->sessions
->len
;
631 session
= g_ptr_array_index(lttng_live_msg_iter
->sessions
,
633 status
= lttng_live_get_session(lttng_live_msg_iter
, session
);
635 case LTTNG_LIVE_ITERATOR_STATUS_OK
:
637 case LTTNG_LIVE_ITERATOR_STATUS_END
:
638 status
= LTTNG_LIVE_ITERATOR_STATUS_OK
;
643 if (!session
->closed
) {
644 nr_sessions_opened
++;
648 if (sess_not_found_act
!= SESSION_NOT_FOUND_ACTION_CONTINUE
&&
649 nr_sessions_opened
== 0) {
650 status
= LTTNG_LIVE_ITERATOR_STATUS_END
;
652 status
= LTTNG_LIVE_ITERATOR_STATUS_OK
;
660 enum lttng_live_iterator_status
emit_inactivity_message(
661 struct lttng_live_msg_iter
*lttng_live_msg_iter
,
662 struct lttng_live_stream_iterator
*stream_iter
,
663 const bt_message
**message
, uint64_t timestamp
)
665 enum lttng_live_iterator_status ret
= LTTNG_LIVE_ITERATOR_STATUS_OK
;
666 bt_logging_level log_level
= lttng_live_msg_iter
->log_level
;
667 bt_self_component
*self_comp
= lttng_live_msg_iter
->self_comp
;
668 bt_message
*msg
= NULL
;
670 BT_ASSERT(stream_iter
->trace
->clock_class
);
672 BT_COMP_LOGD("Emitting inactivity message for stream: ctf-stream-id=%" PRIu64
673 ", viewer-stream-id=%" PRIu64
", timestamp=%" PRIu64
,
674 stream_iter
->ctf_stream_class_id
.value
,
675 stream_iter
->viewer_stream_id
, timestamp
);
677 msg
= bt_message_message_iterator_inactivity_create(
678 lttng_live_msg_iter
->self_msg_iter
,
679 stream_iter
->trace
->clock_class
, timestamp
);
681 BT_COMP_LOGE_APPEND_CAUSE(self_comp
,
682 "Error emitting message iterator inactivity message");
691 ret
= LTTNG_LIVE_ITERATOR_STATUS_ERROR
;
692 bt_message_put_ref(msg
);
697 enum lttng_live_iterator_status
lttng_live_iterator_next_handle_one_quiescent_stream(
698 struct lttng_live_msg_iter
*lttng_live_msg_iter
,
699 struct lttng_live_stream_iterator
*lttng_live_stream
,
700 const bt_message
**message
)
702 enum lttng_live_iterator_status ret
= LTTNG_LIVE_ITERATOR_STATUS_OK
;
704 if (lttng_live_stream
->state
!= LTTNG_LIVE_STREAM_QUIESCENT
) {
705 return LTTNG_LIVE_ITERATOR_STATUS_OK
;
709 * Check if we already sent an inactivty message downstream for this
710 * `current_inactivity_ts` value.
712 if (lttng_live_stream
->last_inactivity_ts
.is_set
&&
713 lttng_live_stream
->current_inactivity_ts
==
714 lttng_live_stream
->last_inactivity_ts
.value
) {
715 lttng_live_stream_iterator_set_state(lttng_live_stream
,
716 LTTNG_LIVE_STREAM_QUIESCENT_NO_DATA
);
718 ret
= LTTNG_LIVE_ITERATOR_STATUS_CONTINUE
;
722 ret
= emit_inactivity_message(lttng_live_msg_iter
, lttng_live_stream
,
723 message
, lttng_live_stream
->current_inactivity_ts
);
725 lttng_live_stream
->last_inactivity_ts
.value
=
726 lttng_live_stream
->current_inactivity_ts
;
727 lttng_live_stream
->last_inactivity_ts
.is_set
= true;
733 int live_get_msg_ts_ns(struct lttng_live_stream_iterator
*stream_iter
,
734 struct lttng_live_msg_iter
*lttng_live_msg_iter
,
735 const bt_message
*msg
, int64_t last_msg_ts_ns
,
738 const bt_clock_class
*clock_class
= NULL
;
739 const bt_clock_snapshot
*clock_snapshot
= NULL
;
741 bt_logging_level log_level
= lttng_live_msg_iter
->log_level
;
742 bt_self_component
*self_comp
= lttng_live_msg_iter
->self_comp
;
745 BT_ASSERT_DBG(ts_ns
);
747 BT_COMP_LOGD("Getting message's timestamp: iter-data-addr=%p, msg-addr=%p, "
748 "last-msg-ts=%" PRId64
, lttng_live_msg_iter
, msg
,
751 switch (bt_message_get_type(msg
)) {
752 case BT_MESSAGE_TYPE_EVENT
:
753 clock_class
= bt_message_event_borrow_stream_class_default_clock_class_const(
755 BT_ASSERT_DBG(clock_class
);
757 clock_snapshot
= bt_message_event_borrow_default_clock_snapshot_const(
760 case BT_MESSAGE_TYPE_PACKET_BEGINNING
:
761 clock_class
= bt_message_packet_beginning_borrow_stream_class_default_clock_class_const(
763 BT_ASSERT(clock_class
);
765 clock_snapshot
= bt_message_packet_beginning_borrow_default_clock_snapshot_const(
768 case BT_MESSAGE_TYPE_PACKET_END
:
769 clock_class
= bt_message_packet_end_borrow_stream_class_default_clock_class_const(
771 BT_ASSERT(clock_class
);
773 clock_snapshot
= bt_message_packet_end_borrow_default_clock_snapshot_const(
776 case BT_MESSAGE_TYPE_DISCARDED_EVENTS
:
777 clock_class
= bt_message_discarded_events_borrow_stream_class_default_clock_class_const(
779 BT_ASSERT(clock_class
);
781 clock_snapshot
= bt_message_discarded_events_borrow_beginning_default_clock_snapshot_const(
784 case BT_MESSAGE_TYPE_DISCARDED_PACKETS
:
785 clock_class
= bt_message_discarded_packets_borrow_stream_class_default_clock_class_const(
787 BT_ASSERT(clock_class
);
789 clock_snapshot
= bt_message_discarded_packets_borrow_beginning_default_clock_snapshot_const(
792 case BT_MESSAGE_TYPE_MESSAGE_ITERATOR_INACTIVITY
:
793 clock_snapshot
= bt_message_message_iterator_inactivity_borrow_clock_snapshot_const(
797 /* All the other messages have a higher priority */
798 BT_COMP_LOGD_STR("Message has no timestamp: using the last message timestamp.");
799 *ts_ns
= last_msg_ts_ns
;
803 clock_class
= bt_clock_snapshot_borrow_clock_class_const(clock_snapshot
);
804 BT_ASSERT_DBG(clock_class
);
806 ret
= bt_clock_snapshot_get_ns_from_origin(clock_snapshot
, ts_ns
);
808 BT_COMP_LOGE_APPEND_CAUSE(self_comp
,
809 "Cannot get nanoseconds from Epoch of clock snapshot: "
810 "clock-snapshot-addr=%p", clock_snapshot
);
821 BT_COMP_LOGD("Found message's timestamp: "
822 "iter-data-addr=%p, msg-addr=%p, "
823 "last-msg-ts=%" PRId64
", ts=%" PRId64
,
824 lttng_live_msg_iter
, msg
, last_msg_ts_ns
, *ts_ns
);
831 enum lttng_live_iterator_status
lttng_live_iterator_next_handle_one_active_data_stream(
832 struct lttng_live_msg_iter
*lttng_live_msg_iter
,
833 struct lttng_live_stream_iterator
*lttng_live_stream
,
834 const bt_message
**message
)
836 enum lttng_live_iterator_status ret
= LTTNG_LIVE_ITERATOR_STATUS_OK
;
837 bt_logging_level log_level
= lttng_live_msg_iter
->log_level
;
838 bt_self_component
*self_comp
= lttng_live_msg_iter
->self_comp
;
839 enum ctf_msg_iter_status status
;
840 uint64_t session_idx
, trace_idx
;
842 for (session_idx
= 0; session_idx
< lttng_live_msg_iter
->sessions
->len
;
844 struct lttng_live_session
*session
=
845 g_ptr_array_index(lttng_live_msg_iter
->sessions
, session_idx
);
847 if (session
->new_streams_needed
) {
848 BT_COMP_LOGD("Need an update for streams: "
849 "session-id=%" PRIu64
, session
->id
);
850 ret
= LTTNG_LIVE_ITERATOR_STATUS_CONTINUE
;
853 for (trace_idx
= 0; trace_idx
< session
->traces
->len
;
855 struct lttng_live_trace
*trace
=
856 g_ptr_array_index(session
->traces
, trace_idx
);
857 if (trace
->metadata_stream_state
== LTTNG_LIVE_METADATA_STREAM_STATE_NEEDED
) {
858 BT_COMP_LOGD("Need an update for metadata stream: "
859 "session-id=%" PRIu64
", trace-id=%" PRIu64
,
860 session
->id
, trace
->id
);
861 ret
= LTTNG_LIVE_ITERATOR_STATUS_CONTINUE
;
867 if (lttng_live_stream
->state
!= LTTNG_LIVE_STREAM_ACTIVE_DATA
) {
868 ret
= LTTNG_LIVE_ITERATOR_STATUS_ERROR
;
869 BT_COMP_LOGE_APPEND_CAUSE(self_comp
,
870 "Invalid state of live stream iterator"
871 "stream-iter-status=%s",
872 lttng_live_stream_state_string(lttng_live_stream
->state
));
876 status
= ctf_msg_iter_get_next_message(
877 lttng_live_stream
->msg_iter
, message
);
879 case CTF_MSG_ITER_STATUS_EOF
:
880 ret
= LTTNG_LIVE_ITERATOR_STATUS_END
;
882 case CTF_MSG_ITER_STATUS_OK
:
883 ret
= LTTNG_LIVE_ITERATOR_STATUS_OK
;
885 case CTF_MSG_ITER_STATUS_AGAIN
:
887 * Continue immediately (end of packet). The next
888 * get_index may return AGAIN to delay the following
891 ret
= LTTNG_LIVE_ITERATOR_STATUS_CONTINUE
;
893 case CTF_MSG_ITER_STATUS_ERROR
:
895 ret
= LTTNG_LIVE_ITERATOR_STATUS_ERROR
;
896 BT_COMP_LOGE_APPEND_CAUSE(self_comp
,
897 "CTF message iterator failed to get next message: "
898 "msg-iter=%p, msg-iter-status=%s",
899 lttng_live_stream
->msg_iter
,
900 ctf_msg_iter_status_string(status
));
909 enum lttng_live_iterator_status
lttng_live_iterator_close_stream(
910 struct lttng_live_msg_iter
*lttng_live_msg_iter
,
911 struct lttng_live_stream_iterator
*stream_iter
,
912 const bt_message
**curr_msg
)
914 enum lttng_live_iterator_status live_status
=
915 LTTNG_LIVE_ITERATOR_STATUS_OK
;
916 bt_logging_level log_level
= lttng_live_msg_iter
->log_level
;
917 bt_self_component
*self_comp
= lttng_live_msg_iter
->self_comp
;
919 BT_COMP_LOGD("Closing live stream iterator: stream-name=\"%s\", "
920 "viewer-stream-id=%" PRIu64
, stream_iter
->name
->str
,
921 stream_iter
->viewer_stream_id
);
924 * The viewer has hung up on us so we are closing the stream. The
925 * `ctf_msg_iter` should simply realize that it needs to close the
926 * stream properly by emitting the necessary stream end message.
928 enum ctf_msg_iter_status status
= ctf_msg_iter_get_next_message(
929 stream_iter
->msg_iter
, curr_msg
);
931 if (status
== CTF_MSG_ITER_STATUS_ERROR
) {
932 BT_COMP_LOGE_APPEND_CAUSE(self_comp
,
933 "Error getting the next message from CTF message iterator");
934 live_status
= LTTNG_LIVE_ITERATOR_STATUS_ERROR
;
936 } else if (status
== CTF_MSG_ITER_STATUS_EOF
) {
937 BT_COMP_LOGI("Reached the end of the live stream iterator.");
938 live_status
= LTTNG_LIVE_ITERATOR_STATUS_END
;
942 BT_ASSERT(status
== CTF_MSG_ITER_STATUS_OK
);
950 * handle_no_data_streams()
952 * - for each ACTIVE_NO_DATA stream:
953 * - query relayd for stream data, or quiescence info.
954 * - if need metadata, get metadata, goto retry.
955 * - if new stream, get new stream as ACTIVE_NO_DATA, goto retry
956 * - if quiescent, move to QUIESCENT streams
957 * - if fetched data, move to ACTIVE_DATA streams
958 * (at this point each stream either has data, or is quiescent)
962 * handle_new_streams_and_metadata()
963 * - query relayd for known streams, add them as ACTIVE_NO_DATA
964 * - query relayd for metadata
966 * call handle_active_no_data_streams()
968 * handle_quiescent_streams()
969 * - if at least one stream is ACTIVE_DATA:
970 * - peek stream event with lowest timestamp -> next_ts
971 * - for each quiescent stream
972 * - if next_ts >= quiescent end
973 * - set state to ACTIVE_NO_DATA
975 * - for each quiescent stream
976 * - set state to ACTIVE_NO_DATA
978 * call handle_active_no_data_streams()
980 * handle_active_data_streams()
981 * - if at least one stream is ACTIVE_DATA:
982 * - get stream event with lowest timestamp from heap
983 * - make that stream event the current message.
984 * - move this stream heap position to its next event
985 * - if we need to fetch data from relayd, move
986 * stream to ACTIVE_NO_DATA.
990 * end criterion: ctrl-c on client. If relayd exits or the session
991 * closes on the relay daemon side, we keep on waiting for streams.
992 * Eventually handle --end timestamp (also an end criterion).
994 * When disconnected from relayd: try to re-connect endlessly.
997 enum lttng_live_iterator_status
lttng_live_iterator_next_msg_on_stream(
998 struct lttng_live_msg_iter
*lttng_live_msg_iter
,
999 struct lttng_live_stream_iterator
*stream_iter
,
1000 const bt_message
**curr_msg
)
1002 bt_logging_level log_level
= lttng_live_msg_iter
->log_level
;
1003 bt_self_component
*self_comp
= lttng_live_msg_iter
->self_comp
;
1004 enum lttng_live_iterator_status live_status
;
1006 BT_COMP_LOGD("Advancing live stream iterator until next message if possible: "
1007 "stream-name=\"%s\", viewer-stream-id=%" PRIu64
,
1008 stream_iter
->name
->str
, stream_iter
->viewer_stream_id
);
1010 if (stream_iter
->has_stream_hung_up
) {
1012 * The stream has hung up and the stream was properly closed
1013 * during the last call to the current function. Return _END
1014 * status now so that this stream iterator is removed for the
1015 * stream iterator list.
1017 live_status
= LTTNG_LIVE_ITERATOR_STATUS_END
;
1022 LTTNG_LIVE_LOGD_STREAM_ITER(stream_iter
);
1025 * Make sure we have the most recent metadata and possibly some new
1028 live_status
= lttng_live_iterator_handle_new_streams_and_metadata(
1029 lttng_live_msg_iter
);
1030 if (live_status
!= LTTNG_LIVE_ITERATOR_STATUS_OK
) {
1034 live_status
= lttng_live_iterator_next_handle_one_no_data_stream(
1035 lttng_live_msg_iter
, stream_iter
);
1036 if (live_status
!= LTTNG_LIVE_ITERATOR_STATUS_OK
) {
1037 if (live_status
== LTTNG_LIVE_ITERATOR_STATUS_END
) {
1039 * We overwrite `live_status` since `curr_msg` is
1040 * likely set to a valid message in this function.
1042 live_status
= lttng_live_iterator_close_stream(
1043 lttng_live_msg_iter
, stream_iter
, curr_msg
);
1048 live_status
= lttng_live_iterator_next_handle_one_quiescent_stream(
1049 lttng_live_msg_iter
, stream_iter
, curr_msg
);
1050 if (live_status
!= LTTNG_LIVE_ITERATOR_STATUS_OK
) {
1051 BT_ASSERT(!*curr_msg
);
1057 live_status
= lttng_live_iterator_next_handle_one_active_data_stream(
1058 lttng_live_msg_iter
, stream_iter
, curr_msg
);
1059 if (live_status
!= LTTNG_LIVE_ITERATOR_STATUS_OK
) {
1060 BT_ASSERT(!*curr_msg
);
1064 if (live_status
== LTTNG_LIVE_ITERATOR_STATUS_CONTINUE
) {
1065 BT_COMP_LOGD("Ask the relay daemon for an updated view of the data and metadata streams");
1069 BT_COMP_LOGD("Returning from advancing live stream iterator: status=%s, "
1070 "stream-name=\"%s\", viewer-stream-id=%" PRIu64
,
1071 lttng_live_iterator_status_string(live_status
),
1072 stream_iter
->name
->str
, stream_iter
->viewer_stream_id
);
1078 bool is_discarded_packet_or_event_message(const bt_message
*msg
)
1080 const enum bt_message_type msg_type
= bt_message_get_type(msg
);
1082 return msg_type
== BT_MESSAGE_TYPE_DISCARDED_EVENTS
||
1083 msg_type
== BT_MESSAGE_TYPE_DISCARDED_PACKETS
;
1087 enum lttng_live_iterator_status
adjust_discarded_packets_message(
1088 bt_self_message_iterator
*iter
,
1089 const bt_stream
*stream
,
1090 const bt_message
*msg_in
, bt_message
**msg_out
,
1091 uint64_t new_begin_ts
)
1093 enum lttng_live_iterator_status status
= LTTNG_LIVE_ITERATOR_STATUS_OK
;
1094 enum bt_property_availability availability
;
1095 const bt_clock_snapshot
*clock_snapshot
;
1099 clock_snapshot
= bt_message_discarded_packets_borrow_end_default_clock_snapshot_const(msg_in
);
1100 end_ts
= bt_clock_snapshot_get_value(clock_snapshot
);
1102 availability
= bt_message_discarded_packets_get_count(msg_in
, &count
);
1103 BT_ASSERT_DBG(availability
== BT_PROPERTY_AVAILABILITY_AVAILABLE
);
1105 *msg_out
= bt_message_discarded_packets_create_with_default_clock_snapshots(
1106 iter
, stream
, new_begin_ts
, end_ts
);
1108 status
= LTTNG_LIVE_ITERATOR_STATUS_NOMEM
;
1112 bt_message_discarded_packets_set_count(*msg_out
, count
);
1118 enum lttng_live_iterator_status
adjust_discarded_events_message(
1119 bt_self_message_iterator
*iter
,
1120 const bt_stream
*stream
,
1121 const bt_message
*msg_in
, bt_message
**msg_out
,
1122 uint64_t new_begin_ts
)
1124 enum lttng_live_iterator_status status
= LTTNG_LIVE_ITERATOR_STATUS_OK
;
1125 enum bt_property_availability availability
;
1126 const bt_clock_snapshot
*clock_snapshot
;
1130 clock_snapshot
= bt_message_discarded_events_borrow_end_default_clock_snapshot_const(msg_in
);
1131 end_ts
= bt_clock_snapshot_get_value(clock_snapshot
);
1133 availability
= bt_message_discarded_events_get_count(msg_in
, &count
);
1134 BT_ASSERT_DBG(availability
== BT_PROPERTY_AVAILABILITY_AVAILABLE
);
1136 *msg_out
= bt_message_discarded_events_create_with_default_clock_snapshots(
1137 iter
, stream
, new_begin_ts
, end_ts
);
1139 status
= LTTNG_LIVE_ITERATOR_STATUS_NOMEM
;
1143 bt_message_discarded_events_set_count(*msg_out
, count
);
1149 enum lttng_live_iterator_status
handle_late_message(
1150 struct lttng_live_msg_iter
*lttng_live_msg_iter
,
1151 struct lttng_live_stream_iterator
*stream_iter
,
1152 int64_t late_msg_ts_ns
, const bt_message
*late_msg
)
1154 bt_self_component
*self_comp
= lttng_live_msg_iter
->self_comp
;
1155 bt_logging_level log_level
= lttng_live_msg_iter
->log_level
;
1156 const bt_clock_class
*clock_class
;
1157 const bt_stream_class
*stream_class
;
1158 enum bt_clock_class_cycles_to_ns_from_origin_status ts_ns_status
;
1159 int64_t last_inactivity_ts_ns
;
1160 enum lttng_live_iterator_status stream_iter_status
= LTTNG_LIVE_ITERATOR_STATUS_OK
;
1161 enum lttng_live_iterator_status adjust_status
;
1162 bt_message
*adjusted_message
;
1165 * The timestamp of the current message is before the last message sent
1166 * by this component. We CANNOT send it as is.
1168 * The only expected scenario in which that could happen is the
1169 * following, everything else is a bug in this component, relay deamon,
1172 * Expected scenario: The CTF message iterator emitted discarded
1173 * packets and discarded events with synthesized beginning and end
1174 * timestamps from the bounds of the last known packet and the newly
1175 * decoded packet header. The CTF message iterator is not aware of
1176 * stream inactivity beacons. Hence, we have to adjust the beginning
1177 * timestamp of those types of messages if a stream signalled its
1178 * inactivity up until _after_ the last known packet's beginning
1181 * Otherwise, the monotonicity guarantee of message timestamps would
1184 * In short, the only scenario in which it's okay and fixable to
1185 * received a late message is when:
1186 * 1. the late message is a discarded packets or discarded events
1188 * 2. this stream produced an inactivity message downstream, and
1189 * 3. the timestamp of the late message is within the inactivity
1190 * timespan we sent downstream through the inactivity message.
1193 BT_COMP_LOGD("Handling late message on live stream iterator: "
1194 "stream-name=\"%s\", viewer-stream-id=%" PRIu64
,
1195 stream_iter
->name
->str
, stream_iter
->viewer_stream_id
);
1197 if (!stream_iter
->last_inactivity_ts
.is_set
) {
1198 BT_COMP_LOGE_APPEND_CAUSE(self_comp
, "Invalid live stream state: "
1199 "have a late message when no inactivity message "
1200 "was ever sent for that stream.");
1201 stream_iter_status
= LTTNG_LIVE_ITERATOR_STATUS_ERROR
;
1205 if (!is_discarded_packet_or_event_message(late_msg
)) {
1206 BT_COMP_LOGE_APPEND_CAUSE(self_comp
, "Invalid live stream state: "
1207 "have a late message that is not a packet discarded or "
1208 "event discarded message: late-msg-type=%s",
1209 bt_common_message_type_string(bt_message_get_type(late_msg
)));
1210 stream_iter_status
= LTTNG_LIVE_ITERATOR_STATUS_ERROR
;
1214 stream_class
= bt_stream_borrow_class_const(stream_iter
->stream
);
1215 clock_class
= bt_stream_class_borrow_default_clock_class_const(stream_class
);
1217 ts_ns_status
= bt_clock_class_cycles_to_ns_from_origin(clock_class
,
1218 stream_iter
->last_inactivity_ts
.value
, &last_inactivity_ts_ns
);
1219 if (ts_ns_status
!= BT_CLOCK_CLASS_CYCLES_TO_NS_FROM_ORIGIN_STATUS_OK
) {
1220 BT_COMP_LOGE_APPEND_CAUSE(self_comp
,"Error converting last "
1221 "inactivity message timestamp to nanoseconds");
1222 stream_iter_status
= LTTNG_LIVE_ITERATOR_STATUS_ERROR
;
1226 if (last_inactivity_ts_ns
<= late_msg_ts_ns
) {
1227 BT_COMP_LOGE_APPEND_CAUSE(self_comp
, "Invalid live stream state: "
1228 "have a late message that is none included in a stream "
1229 "inactivity timespan: last-inactivity-ts-ns=%" PRIu64
1230 "late-msg-ts-ns=%" PRIu64
, last_inactivity_ts_ns
, late_msg_ts_ns
);
1231 stream_iter_status
= LTTNG_LIVE_ITERATOR_STATUS_ERROR
;
1236 * We now know that it's okay for this message to be late, we can now
1237 * adjust its timestamp to ensure monotonicity.
1239 BT_COMP_LOGD("Adjusting the timestamp of late message: late-msg-type=%s, "
1240 "msg-new-ts-ns=%" PRIu64
,
1241 bt_common_message_type_string(bt_message_get_type(late_msg
)),
1242 stream_iter
->last_inactivity_ts
.value
);
1243 switch (bt_message_get_type(late_msg
)) {
1244 case BT_MESSAGE_TYPE_DISCARDED_EVENTS
:
1245 adjust_status
= adjust_discarded_events_message(
1246 lttng_live_msg_iter
->self_msg_iter
,
1247 stream_iter
->stream
,
1248 late_msg
, &adjusted_message
,
1249 stream_iter
->last_inactivity_ts
.value
);
1251 case BT_MESSAGE_TYPE_DISCARDED_PACKETS
:
1252 adjust_status
= adjust_discarded_packets_message(
1253 lttng_live_msg_iter
->self_msg_iter
,
1254 stream_iter
->stream
,
1255 late_msg
, &adjusted_message
,
1256 stream_iter
->last_inactivity_ts
.value
);
1262 if (adjust_status
!= LTTNG_LIVE_ITERATOR_STATUS_OK
) {
1263 stream_iter_status
= adjust_status
;
1267 BT_ASSERT_DBG(adjusted_message
);
1268 stream_iter
->current_msg
= adjusted_message
;
1269 stream_iter
->current_msg_ts_ns
= last_inactivity_ts_ns
;
1270 bt_message_put_ref(late_msg
);
1273 return stream_iter_status
;
1277 enum lttng_live_iterator_status
next_stream_iterator_for_trace(
1278 struct lttng_live_msg_iter
*lttng_live_msg_iter
,
1279 struct lttng_live_trace
*live_trace
,
1280 struct lttng_live_stream_iterator
**youngest_trace_stream_iter
)
1282 struct lttng_live_stream_iterator
*youngest_candidate_stream_iter
= NULL
;
1283 bt_logging_level log_level
= lttng_live_msg_iter
->log_level
;
1284 bt_self_component
*self_comp
= lttng_live_msg_iter
->self_comp
;
1285 enum lttng_live_iterator_status stream_iter_status
;;
1286 int64_t youngest_candidate_msg_ts
= INT64_MAX
;
1287 uint64_t stream_iter_idx
;
1289 BT_ASSERT_DBG(live_trace
);
1290 BT_ASSERT_DBG(live_trace
->stream_iterators
);
1292 BT_COMP_LOGD("Finding the next stream iterator for trace: "
1293 "trace-id=%"PRIu64
, live_trace
->id
);
1295 * Update the current message of every stream iterators of this trace.
1296 * The current msg of every stream must have a timestamp equal or
1297 * larger than the last message returned by this iterator. We must
1298 * ensure monotonicity.
1300 stream_iter_idx
= 0;
1301 while (stream_iter_idx
< live_trace
->stream_iterators
->len
) {
1302 bool stream_iter_is_ended
= false;
1303 struct lttng_live_stream_iterator
*stream_iter
=
1304 g_ptr_array_index(live_trace
->stream_iterators
,
1308 * If there is no current message for this stream, go fetch
1311 while (!stream_iter
->current_msg
) {
1312 const bt_message
*msg
= NULL
;
1313 int64_t curr_msg_ts_ns
= INT64_MAX
;
1315 stream_iter_status
= lttng_live_iterator_next_msg_on_stream(
1316 lttng_live_msg_iter
, stream_iter
, &msg
);
1318 if (stream_iter_status
== LTTNG_LIVE_ITERATOR_STATUS_END
) {
1319 stream_iter_is_ended
= true;
1323 if (stream_iter_status
!= LTTNG_LIVE_ITERATOR_STATUS_OK
) {
1329 BT_COMP_LOGD("Live stream iterator returned message: msg-type=%s, "
1330 "stream-name=\"%s\", viewer-stream-id=%" PRIu64
,
1331 bt_common_message_type_string(bt_message_get_type(msg
)),
1332 stream_iter
->name
->str
, stream_iter
->viewer_stream_id
);
1335 * Get the timestamp in nanoseconds from origin of this
1338 live_get_msg_ts_ns(stream_iter
, lttng_live_msg_iter
,
1339 msg
, lttng_live_msg_iter
->last_msg_ts_ns
,
1343 * Check if the message of the current live stream
1344 * iterator occurred at the exact same time or after the
1345 * last message returned by this component's message
1346 * iterator. If not, we need to handle it with care.
1348 if (curr_msg_ts_ns
>= lttng_live_msg_iter
->last_msg_ts_ns
) {
1349 stream_iter
->current_msg
= msg
;
1350 stream_iter
->current_msg_ts_ns
= curr_msg_ts_ns
;
1353 * We received a message from the past. This
1354 * may be fixable but it can also be an error.
1356 stream_iter_status
= handle_late_message(
1357 lttng_live_msg_iter
, stream_iter
,
1358 curr_msg_ts_ns
, msg
);
1359 if (stream_iter_status
!= LTTNG_LIVE_ITERATOR_STATUS_OK
) {
1360 BT_COMP_LOGE_APPEND_CAUSE(self_comp
,
1361 "Late message could not be handled correctly: "
1362 "lttng-live-msg-iter-addr=%p, "
1363 "stream-name=\"%s\", "
1364 "curr-msg-ts=%" PRId64
1365 ", last-msg-ts=%" PRId64
,
1366 lttng_live_msg_iter
,
1367 stream_iter
->name
->str
,
1369 lttng_live_msg_iter
->last_msg_ts_ns
);
1370 stream_iter_status
= LTTNG_LIVE_ITERATOR_STATUS_ERROR
;
1376 BT_ASSERT_DBG(stream_iter
!= youngest_candidate_stream_iter
);
1378 if (!stream_iter_is_ended
) {
1379 if (G_UNLIKELY(youngest_candidate_stream_iter
== NULL
) ||
1380 stream_iter
->current_msg_ts_ns
< youngest_candidate_msg_ts
) {
1382 * Update the current best candidate message
1383 * for the stream iterator of this live trace
1384 * to be forwarded downstream.
1386 youngest_candidate_msg_ts
= stream_iter
->current_msg_ts_ns
;
1387 youngest_candidate_stream_iter
= stream_iter
;
1388 } else if (stream_iter
->current_msg_ts_ns
== youngest_candidate_msg_ts
) {
1390 * Order the messages in an arbitrary but
1391 * deterministic way.
1393 BT_ASSERT_DBG(stream_iter
!= youngest_candidate_stream_iter
);
1394 int ret
= common_muxing_compare_messages(
1395 stream_iter
->current_msg
,
1396 youngest_candidate_stream_iter
->current_msg
);
1399 * The `youngest_candidate_stream_iter->current_msg`
1400 * should go first. Update the next
1401 * iterator and the current timestamp.
1403 youngest_candidate_msg_ts
= stream_iter
->current_msg_ts_ns
;
1404 youngest_candidate_stream_iter
= stream_iter
;
1405 } else if (ret
== 0) {
1407 * Unable to pick which one should go
1410 BT_COMP_LOGW("Cannot deterministically pick next live stream message iterator because they have identical next messages: "
1411 "stream-iter-addr=%p"
1412 "stream-iter-addr=%p",
1414 youngest_candidate_stream_iter
);
1421 * The live stream iterator has ended. That
1422 * iterator is removed from the array, but
1423 * there is no need to increment
1424 * stream_iter_idx as
1425 * g_ptr_array_remove_index_fast replaces the
1426 * removed element with the array's last
1429 g_ptr_array_remove_index_fast(
1430 live_trace
->stream_iterators
,
1435 if (youngest_candidate_stream_iter
) {
1436 *youngest_trace_stream_iter
= youngest_candidate_stream_iter
;
1437 stream_iter_status
= LTTNG_LIVE_ITERATOR_STATUS_OK
;
1440 * The only case where we don't have a candidate for this trace
1441 * is if we reached the end of all the iterators.
1443 BT_ASSERT(live_trace
->stream_iterators
->len
== 0);
1444 stream_iter_status
= LTTNG_LIVE_ITERATOR_STATUS_END
;
1448 return stream_iter_status
;
1452 enum lttng_live_iterator_status
next_stream_iterator_for_session(
1453 struct lttng_live_msg_iter
*lttng_live_msg_iter
,
1454 struct lttng_live_session
*session
,
1455 struct lttng_live_stream_iterator
**youngest_session_stream_iter
)
1457 bt_self_component
*self_comp
= lttng_live_msg_iter
->self_comp
;
1458 bt_logging_level log_level
= lttng_live_msg_iter
->log_level
;
1459 enum lttng_live_iterator_status stream_iter_status
;
1460 uint64_t trace_idx
= 0;
1461 int64_t youngest_candidate_msg_ts
= INT64_MAX
;
1462 struct lttng_live_stream_iterator
*youngest_candidate_stream_iter
= NULL
;
1464 BT_COMP_LOGD("Finding the next stream iterator for session: "
1465 "session-id=%"PRIu64
, session
->id
);
1467 * Make sure we are attached to the session and look for new streams
1470 stream_iter_status
= lttng_live_get_session(lttng_live_msg_iter
, session
);
1471 if (stream_iter_status
!= LTTNG_LIVE_ITERATOR_STATUS_OK
&&
1472 stream_iter_status
!= LTTNG_LIVE_ITERATOR_STATUS_CONTINUE
&&
1473 stream_iter_status
!= LTTNG_LIVE_ITERATOR_STATUS_END
) {
1477 BT_ASSERT_DBG(session
->traces
);
1479 while (trace_idx
< session
->traces
->len
) {
1480 bool trace_is_ended
= false;
1481 struct lttng_live_stream_iterator
*stream_iter
;
1482 struct lttng_live_trace
*trace
=
1483 g_ptr_array_index(session
->traces
, trace_idx
);
1485 stream_iter_status
= next_stream_iterator_for_trace(
1486 lttng_live_msg_iter
, trace
, &stream_iter
);
1487 if (stream_iter_status
== LTTNG_LIVE_ITERATOR_STATUS_END
) {
1489 * All the live stream iterators for this trace are
1490 * ENDed. Remove the trace from this session.
1492 trace_is_ended
= true;
1493 } else if (stream_iter_status
!= LTTNG_LIVE_ITERATOR_STATUS_OK
) {
1497 if (!trace_is_ended
) {
1498 BT_ASSERT_DBG(stream_iter
);
1500 if (G_UNLIKELY(youngest_candidate_stream_iter
== NULL
) ||
1501 stream_iter
->current_msg_ts_ns
< youngest_candidate_msg_ts
) {
1502 youngest_candidate_msg_ts
= stream_iter
->current_msg_ts_ns
;
1503 youngest_candidate_stream_iter
= stream_iter
;
1504 } else if (stream_iter
->current_msg_ts_ns
== youngest_candidate_msg_ts
) {
1506 * Order the messages in an arbitrary but
1507 * deterministic way.
1509 int ret
= common_muxing_compare_messages(
1510 stream_iter
->current_msg
,
1511 youngest_candidate_stream_iter
->current_msg
);
1514 * The `youngest_candidate_stream_iter->current_msg`
1515 * should go first. Update the next iterator
1516 * and the current timestamp.
1518 youngest_candidate_msg_ts
= stream_iter
->current_msg_ts_ns
;
1519 youngest_candidate_stream_iter
= stream_iter
;
1520 } else if (ret
== 0) {
1521 /* Unable to pick which one should go first. */
1522 BT_COMP_LOGW("Cannot deterministically pick next live stream message iterator because they have identical next messages: "
1523 "stream-iter-addr=%p" "stream-iter-addr=%p",
1524 stream_iter
, youngest_candidate_stream_iter
);
1530 * trace_idx is not incremented since
1531 * g_ptr_array_remove_index_fast replaces the
1532 * element at trace_idx with the array's last element.
1534 g_ptr_array_remove_index_fast(session
->traces
,
1538 if (youngest_candidate_stream_iter
) {
1539 *youngest_session_stream_iter
= youngest_candidate_stream_iter
;
1540 stream_iter_status
= LTTNG_LIVE_ITERATOR_STATUS_OK
;
1543 * The only cases where we don't have a candidate for this
1545 * 1. if we reached the end of all the iterators of all the
1546 * traces of this session,
1547 * 2. if we never had live stream iterator in the first place.
1549 * In either cases, we return END.
1551 BT_ASSERT(session
->traces
->len
== 0);
1552 stream_iter_status
= LTTNG_LIVE_ITERATOR_STATUS_END
;
1555 return stream_iter_status
;
1559 void put_messages(bt_message_array_const msgs
, uint64_t count
)
1563 for (i
= 0; i
< count
; i
++) {
1564 BT_MESSAGE_PUT_REF_AND_RESET(msgs
[i
]);
1569 bt_message_iterator_class_next_method_status
lttng_live_msg_iter_next(
1570 bt_self_message_iterator
*self_msg_it
,
1571 bt_message_array_const msgs
, uint64_t capacity
,
1574 bt_message_iterator_class_next_method_status status
;
1575 enum lttng_live_viewer_status viewer_status
;
1576 struct lttng_live_msg_iter
*lttng_live_msg_iter
=
1577 bt_self_message_iterator_get_data(self_msg_it
);
1578 struct lttng_live_component
*lttng_live
=
1579 lttng_live_msg_iter
->lttng_live_comp
;
1580 bt_self_component
*self_comp
= lttng_live_msg_iter
->self_comp
;
1581 bt_logging_level log_level
= lttng_live_msg_iter
->log_level
;
1582 enum lttng_live_iterator_status stream_iter_status
;
1583 uint64_t session_idx
;
1587 BT_ASSERT_DBG(lttng_live_msg_iter
);
1589 if (G_UNLIKELY(lttng_live_msg_iter
->was_interrupted
)) {
1591 * The iterator was interrupted in a previous call to the
1592 * `_next()` method. We currently do not support generating
1593 * messages after such event. The babeltrace2 CLI should never
1594 * be running the graph after being interrupted. So this check
1595 * is to prevent other graph users from using this live
1596 * iterator in an messed up internal state.
1598 status
= BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_ERROR
;
1599 BT_COMP_LOGE_APPEND_CAUSE(self_comp
,
1600 "Message iterator was interrupted during a previous call to the `next()` and currently does not support continuing after such event.");
1605 * Clear all the invalid message reference that might be left over in
1608 memset(msgs
, 0, capacity
* sizeof(*msgs
));
1611 * If no session are exposed on the relay found at the url provided by
1612 * the user, session count will be 0. In this case, we return status
1613 * end to return gracefully.
1615 if (lttng_live_msg_iter
->sessions
->len
== 0) {
1616 if (lttng_live
->params
.sess_not_found_act
!=
1617 SESSION_NOT_FOUND_ACTION_CONTINUE
) {
1618 status
= BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_END
;
1622 * The are no more active session for this session
1623 * name. Retry to create a viewer session for the
1624 * requested session name.
1626 viewer_status
= lttng_live_create_viewer_session(lttng_live_msg_iter
);
1627 if (viewer_status
!= LTTNG_LIVE_VIEWER_STATUS_OK
) {
1628 if (viewer_status
== LTTNG_LIVE_VIEWER_STATUS_ERROR
) {
1629 status
= BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_ERROR
;
1630 BT_COMP_LOGE_APPEND_CAUSE(self_comp
,
1631 "Error creating LTTng live viewer session");
1632 } else if (viewer_status
== LTTNG_LIVE_VIEWER_STATUS_INTERRUPTED
) {
1633 status
= BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_AGAIN
;
1642 if (lttng_live_msg_iter
->active_stream_iter
== 0) {
1643 lttng_live_force_new_streams_and_metadata(lttng_live_msg_iter
);
1647 * Here the muxing of message is done.
1649 * We need to iterate over all the streams of all the traces of all the
1650 * viewer sessions in order to get the message with the smallest
1651 * timestamp. In this case, a session is a viewer session and there is
1652 * one viewer session per consumer daemon. (UST 32bit, UST 64bit and/or
1653 * kernel). Each viewer session can have multiple traces, for example,
1654 * 64bit UST viewer sessions could have multiple per-pid traces.
1656 * We iterate over the streams of each traces to update and see what is
1657 * their next message's timestamp. From those timestamps, we select the
1658 * message with the smallest timestamp as the best candidate message
1659 * for that trace and do the same thing across all the sessions.
1661 * We then compare the timestamp of best candidate message of all the
1662 * sessions to pick the message with the smallest timestamp and we
1665 while (*count
< capacity
) {
1666 struct lttng_live_stream_iterator
*youngest_stream_iter
= NULL
,
1667 *candidate_stream_iter
= NULL
;
1668 int64_t youngest_msg_ts_ns
= INT64_MAX
;
1670 BT_ASSERT_DBG(lttng_live_msg_iter
->sessions
);
1672 while (session_idx
< lttng_live_msg_iter
->sessions
->len
) {
1673 struct lttng_live_session
*session
=
1674 g_ptr_array_index(lttng_live_msg_iter
->sessions
,
1677 /* Find the best candidate message to send downstream. */
1678 stream_iter_status
= next_stream_iterator_for_session(
1679 lttng_live_msg_iter
, session
,
1680 &candidate_stream_iter
);
1682 /* If we receive an END status, it means that either:
1683 * - Those traces never had active streams (UST with no
1684 * data produced yet),
1685 * - All live stream iterators have ENDed.*/
1686 if (stream_iter_status
== LTTNG_LIVE_ITERATOR_STATUS_END
) {
1687 if (session
->closed
&& session
->traces
->len
== 0) {
1689 * Remove the session from the list.
1690 * session_idx is not modified since
1691 * g_ptr_array_remove_index_fast
1692 * replaces the the removed element with
1693 * the array's last element.
1695 g_ptr_array_remove_index_fast(
1696 lttng_live_msg_iter
->sessions
,
1704 if (stream_iter_status
!= LTTNG_LIVE_ITERATOR_STATUS_OK
) {
1708 if (G_UNLIKELY(youngest_stream_iter
== NULL
) ||
1709 candidate_stream_iter
->current_msg_ts_ns
< youngest_msg_ts_ns
) {
1710 youngest_msg_ts_ns
= candidate_stream_iter
->current_msg_ts_ns
;
1711 youngest_stream_iter
= candidate_stream_iter
;
1712 } else if (candidate_stream_iter
->current_msg_ts_ns
== youngest_msg_ts_ns
) {
1714 * The currently selected message to be sent
1715 * downstream next has the exact same timestamp
1716 * that of the current candidate message. We
1717 * must break the tie in a predictable manner.
1719 BT_COMP_LOGD_STR("Two of the next message candidates have the same timestamps, pick one deterministically.");
1721 * Order the messages in an arbitrary but
1722 * deterministic way.
1724 int ret
= common_muxing_compare_messages(
1725 candidate_stream_iter
->current_msg
,
1726 youngest_stream_iter
->current_msg
);
1729 * The `candidate_stream_iter->current_msg`
1730 * should go first. Update the next
1731 * iterator and the current timestamp.
1733 youngest_msg_ts_ns
= candidate_stream_iter
->current_msg_ts_ns
;
1734 youngest_stream_iter
= candidate_stream_iter
;
1735 } else if (ret
== 0) {
1736 /* Unable to pick which one should go first. */
1737 BT_COMP_LOGW("Cannot deterministically pick next live stream message iterator because they have identical next messages: "
1738 "next-stream-iter-addr=%p" "candidate-stream-iter-addr=%p",
1739 youngest_stream_iter
, candidate_stream_iter
);
1746 if (!youngest_stream_iter
) {
1747 stream_iter_status
= LTTNG_LIVE_ITERATOR_STATUS_AGAIN
;
1751 BT_ASSERT_DBG(youngest_stream_iter
->current_msg
);
1752 /* Ensure monotonicity. */
1753 BT_ASSERT_DBG(lttng_live_msg_iter
->last_msg_ts_ns
<=
1754 youngest_stream_iter
->current_msg_ts_ns
);
1757 * Insert the next message to the message batch. This will set
1758 * stream iterator current messsage to NULL so that next time
1759 * we fetch the next message of that stream iterator
1761 BT_MESSAGE_MOVE_REF(msgs
[*count
], youngest_stream_iter
->current_msg
);
1764 /* Update the last timestamp in nanoseconds sent downstream. */
1765 lttng_live_msg_iter
->last_msg_ts_ns
= youngest_msg_ts_ns
;
1766 youngest_stream_iter
->current_msg_ts_ns
= INT64_MAX
;
1768 stream_iter_status
= LTTNG_LIVE_ITERATOR_STATUS_OK
;
1772 switch (stream_iter_status
) {
1773 case LTTNG_LIVE_ITERATOR_STATUS_OK
:
1774 case LTTNG_LIVE_ITERATOR_STATUS_AGAIN
:
1776 * If we gathered messages, return _OK even if the graph was
1777 * interrupted. This allows for the components downstream to at
1778 * least get the thoses messages. If the graph was indeed
1779 * interrupted there should not be another _next() call as the
1780 * application will tear down the graph. This component class
1781 * doesn't support restarting after an interruption.
1784 status
= BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_OK
;
1786 status
= BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_AGAIN
;
1789 case LTTNG_LIVE_ITERATOR_STATUS_END
:
1790 status
= BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_END
;
1792 case LTTNG_LIVE_ITERATOR_STATUS_NOMEM
:
1793 BT_COMP_LOGE_APPEND_CAUSE(self_comp
,
1794 "Memory error preparing the next batch of messages: "
1795 "live-iter-status=%s",
1796 lttng_live_iterator_status_string(stream_iter_status
));
1797 status
= BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_MEMORY_ERROR
;
1799 case LTTNG_LIVE_ITERATOR_STATUS_ERROR
:
1800 case LTTNG_LIVE_ITERATOR_STATUS_INVAL
:
1801 case LTTNG_LIVE_ITERATOR_STATUS_UNSUPPORTED
:
1802 BT_COMP_LOGE_APPEND_CAUSE(self_comp
,
1803 "Error preparing the next batch of messages: "
1804 "live-iter-status=%s",
1805 lttng_live_iterator_status_string(stream_iter_status
));
1807 status
= BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_ERROR
;
1808 /* Put all existing messages on error. */
1809 put_messages(msgs
, *count
);
1820 struct lttng_live_msg_iter
*lttng_live_msg_iter_create(
1821 struct lttng_live_component
*lttng_live_comp
,
1822 bt_self_message_iterator
*self_msg_it
)
1824 bt_self_component
*self_comp
= lttng_live_comp
->self_comp
;
1825 bt_logging_level log_level
= lttng_live_comp
->log_level
;
1827 struct lttng_live_msg_iter
*lttng_live_msg_iter
=
1828 g_new0(struct lttng_live_msg_iter
, 1);
1829 if (!lttng_live_msg_iter
) {
1830 BT_COMP_LOGE_APPEND_CAUSE(self_comp
,
1831 "Failed to allocate lttng_live_msg_iter");
1835 lttng_live_msg_iter
->log_level
= lttng_live_comp
->log_level
;
1836 lttng_live_msg_iter
->self_comp
= lttng_live_comp
->self_comp
;
1837 lttng_live_msg_iter
->lttng_live_comp
= lttng_live_comp
;
1838 lttng_live_msg_iter
->self_msg_iter
= self_msg_it
;
1840 lttng_live_msg_iter
->active_stream_iter
= 0;
1841 lttng_live_msg_iter
->last_msg_ts_ns
= INT64_MIN
;
1842 lttng_live_msg_iter
->was_interrupted
= false;
1844 lttng_live_msg_iter
->sessions
= g_ptr_array_new_with_free_func(
1845 (GDestroyNotify
) lttng_live_destroy_session
);
1846 BT_ASSERT(lttng_live_msg_iter
->sessions
);
1849 return lttng_live_msg_iter
;
1854 bt_message_iterator_class_initialize_method_status
lttng_live_msg_iter_init(
1855 bt_self_message_iterator
*self_msg_it
,
1856 bt_self_message_iterator_configuration
*config
,
1857 bt_self_component_port_output
*self_port
)
1859 bt_message_iterator_class_initialize_method_status status
;
1860 struct lttng_live_component
*lttng_live
;
1861 struct lttng_live_msg_iter
*lttng_live_msg_iter
;
1862 enum lttng_live_viewer_status viewer_status
;
1863 bt_logging_level log_level
;
1864 bt_self_component
*self_comp
=
1865 bt_self_message_iterator_borrow_component(self_msg_it
);
1867 lttng_live
= bt_self_component_get_data(self_comp
);
1868 log_level
= lttng_live
->log_level
;
1869 self_comp
= lttng_live
->self_comp
;
1872 /* There can be only one downstream iterator at the same time. */
1873 BT_ASSERT(!lttng_live
->has_msg_iter
);
1874 lttng_live
->has_msg_iter
= true;
1876 lttng_live_msg_iter
= lttng_live_msg_iter_create(lttng_live
,
1878 if (!lttng_live_msg_iter
) {
1879 status
= BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_MEMORY_ERROR
;
1880 BT_COMP_LOGE_APPEND_CAUSE(self_comp
,
1881 "Failed to create lttng_live_msg_iter");
1885 viewer_status
= live_viewer_connection_create(self_comp
, NULL
,
1886 log_level
, lttng_live
->params
.url
->str
, false,
1887 lttng_live_msg_iter
, <tng_live_msg_iter
->viewer_connection
);
1888 if (viewer_status
!= LTTNG_LIVE_VIEWER_STATUS_OK
) {
1889 if (viewer_status
== LTTNG_LIVE_VIEWER_STATUS_ERROR
) {
1890 BT_COMP_LOGE_APPEND_CAUSE(self_comp
,
1891 "Failed to create viewer connection");
1892 } else if (viewer_status
== LTTNG_LIVE_VIEWER_STATUS_INTERRUPTED
) {
1894 * Interruption in the _iter_init() method is not
1895 * supported. Return an error.
1897 BT_COMP_LOGE_APPEND_CAUSE(self_comp
,
1898 "Interrupted while creating viewer connection");
1903 viewer_status
= lttng_live_create_viewer_session(lttng_live_msg_iter
);
1904 if (viewer_status
!= LTTNG_LIVE_VIEWER_STATUS_OK
) {
1905 if (viewer_status
== LTTNG_LIVE_VIEWER_STATUS_ERROR
) {
1906 BT_COMP_LOGE_APPEND_CAUSE(self_comp
,
1907 "Failed to create viewer session");
1908 } else if (viewer_status
== LTTNG_LIVE_VIEWER_STATUS_INTERRUPTED
) {
1910 * Interruption in the _iter_init() method is not
1911 * supported. Return an error.
1913 BT_COMP_LOGE_APPEND_CAUSE(self_comp
,
1914 "Interrupted when creating viewer session");
1919 if (lttng_live_msg_iter
->sessions
->len
== 0) {
1920 switch (lttng_live
->params
.sess_not_found_act
) {
1921 case SESSION_NOT_FOUND_ACTION_CONTINUE
:
1922 BT_COMP_LOGI("Unable to connect to the requested live viewer session. Keep trying to connect because of "
1923 "%s=\"%s\" component parameter: url=\"%s\"",
1924 SESS_NOT_FOUND_ACTION_PARAM
,
1925 SESS_NOT_FOUND_ACTION_CONTINUE_STR
,
1926 lttng_live
->params
.url
->str
);
1928 case SESSION_NOT_FOUND_ACTION_FAIL
:
1929 BT_COMP_LOGE_APPEND_CAUSE(self_comp
,
1930 "Unable to connect to the requested live viewer session. Fail the message iterator initialization because of %s=\"%s\" "
1931 "component parameter: url =\"%s\"",
1932 SESS_NOT_FOUND_ACTION_PARAM
,
1933 SESS_NOT_FOUND_ACTION_FAIL_STR
,
1934 lttng_live
->params
.url
->str
);
1936 case SESSION_NOT_FOUND_ACTION_END
:
1937 BT_COMP_LOGI("Unable to connect to the requested live viewer session. End gracefully at the first _next() "
1938 "call because of %s=\"%s\" component parameter: "
1939 "url=\"%s\"", SESS_NOT_FOUND_ACTION_PARAM
,
1940 SESS_NOT_FOUND_ACTION_END_STR
,
1941 lttng_live
->params
.url
->str
);
1948 bt_self_message_iterator_set_data(self_msg_it
, lttng_live_msg_iter
);
1949 status
= BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_OK
;
1953 status
= BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_ERROR
;
1954 lttng_live_msg_iter_destroy(lttng_live_msg_iter
);
1959 static struct bt_param_validation_map_value_entry_descr list_sessions_params
[] = {
1960 { URL_PARAM
, BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_MANDATORY
, { .type
= BT_VALUE_TYPE_STRING
} },
1961 BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_END
1965 bt_component_class_query_method_status
lttng_live_query_list_sessions(
1966 const bt_value
*params
, const bt_value
**result
,
1967 bt_self_component_class
*self_comp_class
,
1968 bt_logging_level log_level
)
1970 bt_component_class_query_method_status status
;
1971 const bt_value
*url_value
= NULL
;
1973 struct live_viewer_connection
*viewer_connection
= NULL
;
1974 enum lttng_live_viewer_status viewer_status
;
1975 enum bt_param_validation_status validation_status
;
1976 gchar
*validate_error
= NULL
;
1978 validation_status
= bt_param_validation_validate(params
,
1979 list_sessions_params
, &validate_error
);
1980 if (validation_status
== BT_PARAM_VALIDATION_STATUS_MEMORY_ERROR
) {
1981 status
= BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_MEMORY_ERROR
;
1983 } else if (validation_status
== BT_PARAM_VALIDATION_STATUS_VALIDATION_ERROR
) {
1984 status
= BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_ERROR
;
1985 BT_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp_class
, "%s",
1990 url_value
= bt_value_map_borrow_entry_value_const(params
, URL_PARAM
);
1991 url
= bt_value_string_get(url_value
);
1993 viewer_status
= live_viewer_connection_create(NULL
, self_comp_class
,
1994 log_level
, url
, true, NULL
, &viewer_connection
);
1995 if (viewer_status
!= LTTNG_LIVE_VIEWER_STATUS_OK
) {
1996 if (viewer_status
== LTTNG_LIVE_VIEWER_STATUS_ERROR
) {
1997 BT_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp_class
,
1998 "Failed to create viewer connection");
1999 status
= BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_ERROR
;
2000 } else if (viewer_status
== LTTNG_LIVE_VIEWER_STATUS_INTERRUPTED
) {
2001 status
= BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_AGAIN
;
2008 status
= live_viewer_connection_list_sessions(viewer_connection
,
2010 if (status
!= BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_OK
) {
2011 BT_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp_class
,
2012 "Failed to list viewer sessions");
2019 BT_VALUE_PUT_REF_AND_RESET(*result
);
2022 status
= BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_ERROR
;
2026 if (viewer_connection
) {
2027 live_viewer_connection_destroy(viewer_connection
);
2030 g_free(validate_error
);
2036 bt_component_class_query_method_status
lttng_live_query_support_info(
2037 const bt_value
*params
, const bt_value
**result
,
2038 bt_self_component_class
*self_comp_class
,
2039 bt_logging_level log_level
)
2041 bt_component_class_query_method_status status
=
2042 BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_OK
;
2043 const bt_value
*input_type_value
;
2044 const bt_value
*input_value
;
2046 struct bt_common_lttng_live_url_parts parts
= { 0 };
2048 /* Used by the logging macros */
2049 __attribute__((unused
)) bt_self_component
*self_comp
= NULL
;
2052 input_type_value
= bt_value_map_borrow_entry_value_const(params
,
2054 if (!input_type_value
) {
2055 BT_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp_class
,
2056 "Missing expected `type` parameter.");
2060 if (!bt_value_is_string(input_type_value
)) {
2061 BT_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp_class
,
2062 "`type` parameter is not a string value.");
2066 if (strcmp(bt_value_string_get(input_type_value
), "string") != 0) {
2067 /* We don't handle file system paths */
2071 input_value
= bt_value_map_borrow_entry_value_const(params
, "input");
2073 BT_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp_class
,
2074 "Missing expected `input` parameter.");
2078 if (!bt_value_is_string(input_value
)) {
2079 BT_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp_class
,
2080 "`input` parameter is not a string value.");
2084 parts
= bt_common_parse_lttng_live_url(bt_value_string_get(input_value
),
2086 if (parts
.session_name
) {
2088 * Looks pretty much like an LTTng live URL: we got the
2089 * session name part, which forms a complete URL.
2095 *result
= bt_value_real_create_init(weight
);
2097 status
= BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_MEMORY_ERROR
;
2105 status
= BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_ERROR
;
2108 BT_ASSERT(!*result
);
2111 bt_common_destroy_lttng_live_url_parts(&parts
);
2116 bt_component_class_query_method_status
lttng_live_query(
2117 bt_self_component_class_source
*comp_class
,
2118 bt_private_query_executor
*priv_query_exec
,
2119 const char *object
, const bt_value
*params
,
2120 __attribute__((unused
)) void *method_data
,
2121 const bt_value
**result
)
2123 bt_component_class_query_method_status status
=
2124 BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_OK
;
2125 bt_self_component
*self_comp
= NULL
;
2126 bt_self_component_class
*self_comp_class
=
2127 bt_self_component_class_source_as_self_component_class(comp_class
);
2128 bt_logging_level log_level
= bt_query_executor_get_logging_level(
2129 bt_private_query_executor_as_query_executor_const(
2132 if (strcmp(object
, "sessions") == 0) {
2133 status
= lttng_live_query_list_sessions(params
, result
,
2134 self_comp_class
, log_level
);
2135 } else if (strcmp(object
, "babeltrace.support-info") == 0) {
2136 status
= lttng_live_query_support_info(params
, result
,
2137 self_comp_class
, log_level
);
2139 BT_COMP_LOGI("Unknown query object `%s`", object
);
2140 status
= BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_UNKNOWN_OBJECT
;
2149 void lttng_live_component_destroy_data(struct lttng_live_component
*lttng_live
)
2154 if (lttng_live
->params
.url
) {
2155 g_string_free(lttng_live
->params
.url
, TRUE
);
2161 void lttng_live_component_finalize(bt_self_component_source
*component
)
2163 void *data
= bt_self_component_get_data(
2164 bt_self_component_source_as_self_component(component
));
2169 lttng_live_component_destroy_data(data
);
2173 enum session_not_found_action
parse_session_not_found_action_param(
2174 const bt_value
*no_session_param
)
2176 enum session_not_found_action action
;
2177 const char *no_session_act_str
= bt_value_string_get(no_session_param
);
2179 if (strcmp(no_session_act_str
, SESS_NOT_FOUND_ACTION_CONTINUE_STR
) == 0) {
2180 action
= SESSION_NOT_FOUND_ACTION_CONTINUE
;
2181 } else if (strcmp(no_session_act_str
, SESS_NOT_FOUND_ACTION_FAIL_STR
) == 0) {
2182 action
= SESSION_NOT_FOUND_ACTION_FAIL
;
2184 BT_ASSERT(strcmp(no_session_act_str
, SESS_NOT_FOUND_ACTION_END_STR
) == 0);
2185 action
= SESSION_NOT_FOUND_ACTION_END
;
2191 static struct bt_param_validation_value_descr inputs_elem_descr
= {
2192 .type
= BT_VALUE_TYPE_STRING
,
2195 static const char *sess_not_found_action_choices
[] = {
2196 SESS_NOT_FOUND_ACTION_CONTINUE_STR
,
2197 SESS_NOT_FOUND_ACTION_FAIL_STR
,
2198 SESS_NOT_FOUND_ACTION_END_STR
,
2201 static struct bt_param_validation_map_value_entry_descr params_descr
[] = {
2202 { INPUTS_PARAM
, BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_MANDATORY
, { BT_VALUE_TYPE_ARRAY
, .array
= {
2205 .element_type
= &inputs_elem_descr
,
2207 { SESS_NOT_FOUND_ACTION_PARAM
, BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL
, { BT_VALUE_TYPE_STRING
, .string
= {
2208 .choices
= sess_not_found_action_choices
,
2210 BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_END
2214 bt_component_class_initialize_method_status
lttng_live_component_create(
2215 const bt_value
*params
,
2216 bt_logging_level log_level
,
2217 bt_self_component
*self_comp
,
2218 struct lttng_live_component
**component
)
2220 struct lttng_live_component
*lttng_live
= NULL
;
2221 const bt_value
*inputs_value
;
2222 const bt_value
*url_value
;
2223 const bt_value
*value
;
2225 enum bt_param_validation_status validation_status
;
2226 gchar
*validation_error
= NULL
;
2227 bt_component_class_initialize_method_status status
;
2229 validation_status
= bt_param_validation_validate(params
, params_descr
,
2231 if (validation_status
== BT_PARAM_VALIDATION_STATUS_MEMORY_ERROR
) {
2232 status
= BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_MEMORY_ERROR
;
2234 } else if (validation_status
== BT_PARAM_VALIDATION_STATUS_VALIDATION_ERROR
) {
2235 BT_COMP_LOGE_APPEND_CAUSE(self_comp
, "%s", validation_error
);
2236 status
= BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_ERROR
;
2240 lttng_live
= g_new0(struct lttng_live_component
, 1);
2242 status
= BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_MEMORY_ERROR
;
2245 lttng_live
->log_level
= log_level
;
2246 lttng_live
->self_comp
= self_comp
;
2247 lttng_live
->max_query_size
= MAX_QUERY_SIZE
;
2248 lttng_live
->has_msg_iter
= false;
2251 bt_value_map_borrow_entry_value_const(params
, INPUTS_PARAM
);
2253 bt_value_array_borrow_element_by_index_const(inputs_value
, 0);
2254 url
= bt_value_string_get(url_value
);
2256 lttng_live
->params
.url
= g_string_new(url
);
2257 if (!lttng_live
->params
.url
) {
2258 status
= BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_MEMORY_ERROR
;
2262 value
= bt_value_map_borrow_entry_value_const(params
,
2263 SESS_NOT_FOUND_ACTION_PARAM
);
2265 lttng_live
->params
.sess_not_found_act
=
2266 parse_session_not_found_action_param(value
);
2268 BT_COMP_LOGI("Optional `%s` parameter is missing: "
2269 "defaulting to `%s`.",
2270 SESS_NOT_FOUND_ACTION_PARAM
,
2271 SESS_NOT_FOUND_ACTION_CONTINUE_STR
);
2272 lttng_live
->params
.sess_not_found_act
=
2273 SESSION_NOT_FOUND_ACTION_CONTINUE
;
2276 status
= BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_OK
;
2280 lttng_live_component_destroy_data(lttng_live
);
2283 g_free(validation_error
);
2285 *component
= lttng_live
;
2290 bt_component_class_initialize_method_status
lttng_live_component_init(
2291 bt_self_component_source
*self_comp_src
,
2292 bt_self_component_source_configuration
*config
,
2293 const bt_value
*params
,
2294 __attribute__((unused
)) void *init_method_data
)
2296 struct lttng_live_component
*lttng_live
;
2297 bt_component_class_initialize_method_status ret
;
2298 bt_self_component
*self_comp
=
2299 bt_self_component_source_as_self_component(self_comp_src
);
2300 bt_logging_level log_level
= bt_component_get_logging_level(
2301 bt_self_component_as_component(self_comp
));
2302 bt_self_component_add_port_status add_port_status
;
2304 ret
= lttng_live_component_create(params
, log_level
, self_comp
, <tng_live
);
2305 if (ret
!= BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_OK
) {
2309 add_port_status
= bt_self_component_source_add_output_port(
2310 self_comp_src
, "out", NULL
, NULL
);
2311 if (add_port_status
!= BT_SELF_COMPONENT_ADD_PORT_STATUS_OK
) {
2312 ret
= (int) add_port_status
;
2316 bt_self_component_set_data(self_comp
, lttng_live
);
2320 lttng_live_component_destroy_data(lttng_live
);