4 * Babeltrace CTF LTTng-live Client Component
6 * Copyright 2019 Francis Deslauriers <francis.deslauriers@efficios.com>
7 * Copyright 2016 Jérémie Galarneau <jeremie.galarneau@efficios.com>
8 * Copyright 2016 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
10 * Author: Jérémie Galarneau <jeremie.galarneau@efficios.com>
12 * Permission is hereby granted, free of charge, to any person obtaining a copy
13 * of this software and associated documentation files (the "Software"), to deal
14 * in the Software without restriction, including without limitation the rights
15 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
16 * copies of the Software, and to permit persons to whom the Software is
17 * furnished to do so, subject to the following conditions:
19 * The above copyright notice and this permission notice shall be included in
20 * all copies or substantial portions of the Software.
22 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
23 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
24 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
25 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
26 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
27 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
31 #define BT_COMP_LOG_SELF_COMP self_comp
32 #define BT_LOG_OUTPUT_LEVEL log_level
33 #define BT_LOG_TAG "PLUGIN/SRC.CTF.LTTNG-LIVE"
34 #include "logging/comp-logging.h"
42 #include "common/assert.h"
43 #include <babeltrace2/babeltrace.h>
44 #include "compat/compiler.h"
45 #include <babeltrace2/types.h>
47 #include "plugins/common/muxing/muxing.h"
48 #include "plugins/common/param-validation/param-validation.h"
50 #include "data-stream.h"
52 #include "lttng-live.h"
54 #define MAX_QUERY_SIZE (256*1024)
55 #define URL_PARAM "url"
56 #define INPUTS_PARAM "inputs"
57 #define SESS_NOT_FOUND_ACTION_PARAM "session-not-found-action"
58 #define SESS_NOT_FOUND_ACTION_CONTINUE_STR "continue"
59 #define SESS_NOT_FOUND_ACTION_FAIL_STR "fail"
60 #define SESS_NOT_FOUND_ACTION_END_STR "end"
62 #define print_dbg(fmt, ...) BT_COMP_LOGD(fmt, ## __VA_ARGS__)
65 const char *print_live_iterator_status(enum lttng_live_iterator_status status
)
68 case LTTNG_LIVE_ITERATOR_STATUS_CONTINUE
:
69 return "LTTNG_LIVE_ITERATOR_STATUS_CONTINUE";
70 case LTTNG_LIVE_ITERATOR_STATUS_AGAIN
:
71 return "LTTNG_LIVE_ITERATOR_STATUS_AGAIN";
72 case LTTNG_LIVE_ITERATOR_STATUS_END
:
73 return "LTTNG_LIVE_ITERATOR_STATUS_END";
74 case LTTNG_LIVE_ITERATOR_STATUS_OK
:
75 return "LTTNG_LIVE_ITERATOR_STATUS_OK";
76 case LTTNG_LIVE_ITERATOR_STATUS_INVAL
:
77 return "LTTNG_LIVE_ITERATOR_STATUS_INVAL";
78 case LTTNG_LIVE_ITERATOR_STATUS_ERROR
:
79 return "LTTNG_LIVE_ITERATOR_STATUS_ERROR";
80 case LTTNG_LIVE_ITERATOR_STATUS_NOMEM
:
81 return "LTTNG_LIVE_ITERATOR_STATUS_NOMEM";
82 case LTTNG_LIVE_ITERATOR_STATUS_UNSUPPORTED
:
83 return "LTTNG_LIVE_ITERATOR_STATUS_UNSUPPORTED";
90 const char *print_state(struct lttng_live_stream_iterator
*s
)
93 case LTTNG_LIVE_STREAM_ACTIVE_NO_DATA
:
94 return "ACTIVE_NO_DATA";
95 case LTTNG_LIVE_STREAM_QUIESCENT_NO_DATA
:
96 return "QUIESCENT_NO_DATA";
97 case LTTNG_LIVE_STREAM_QUIESCENT
:
99 case LTTNG_LIVE_STREAM_ACTIVE_DATA
:
100 return "ACTIVE_DATA";
101 case LTTNG_LIVE_STREAM_EOF
:
108 #define print_stream_state(live_stream_iter) \
110 BT_COMP_LOGD("stream state %s last_inact_ts %" PRId64 \
111 ", curr_inact_ts %" PRId64, \
112 print_state(live_stream_iter), \
113 live_stream_iter->last_inactivity_ts, \
114 live_stream_iter->current_inactivity_ts); \
118 bool lttng_live_graph_is_canceled(struct lttng_live_msg_iter
*msg_iter
)
127 ret
= bt_self_message_iterator_is_interrupted(
128 msg_iter
->self_msg_iter
);
135 struct lttng_live_trace
*lttng_live_find_trace(struct lttng_live_session
*session
,
139 struct lttng_live_trace
*ret_trace
= NULL
;
141 for (trace_idx
= 0; trace_idx
< session
->traces
->len
; trace_idx
++) {
142 struct lttng_live_trace
*trace
=
143 g_ptr_array_index(session
->traces
, trace_idx
);
144 if (trace
->id
== trace_id
) {
155 void lttng_live_destroy_trace(struct lttng_live_trace
*trace
)
157 bt_logging_level log_level
= trace
->log_level
;
158 bt_self_component
*self_comp
= trace
->self_comp
;
160 BT_COMP_LOGD("Destroy lttng_live_trace");
162 BT_ASSERT(trace
->stream_iterators
);
163 g_ptr_array_free(trace
->stream_iterators
, TRUE
);
165 BT_TRACE_PUT_REF_AND_RESET(trace
->trace
);
166 BT_TRACE_CLASS_PUT_REF_AND_RESET(trace
->trace_class
);
168 lttng_live_metadata_fini(trace
);
173 struct lttng_live_trace
*lttng_live_create_trace(struct lttng_live_session
*session
,
176 struct lttng_live_trace
*trace
= NULL
;
177 bt_logging_level log_level
= session
->log_level
;
178 bt_self_component
*self_comp
= session
->self_comp
;
180 trace
= g_new0(struct lttng_live_trace
, 1);
182 BT_COMP_LOGE_APPEND_CAUSE(self_comp
,
183 "Failed to allocate live trace");
186 trace
->log_level
= session
->log_level
;
187 trace
->self_comp
= session
->self_comp
;
188 trace
->session
= session
;
189 trace
->id
= trace_id
;
190 trace
->trace_class
= NULL
;
192 trace
->stream_iterators
= g_ptr_array_new_with_free_func(
193 (GDestroyNotify
) lttng_live_stream_iterator_destroy
);
194 BT_ASSERT(trace
->stream_iterators
);
195 trace
->new_metadata_needed
= true;
196 g_ptr_array_add(session
->traces
, trace
);
198 BT_COMP_LOGI("Create trace");
208 struct lttng_live_trace
*lttng_live_borrow_trace(
209 struct lttng_live_session
*session
, uint64_t trace_id
)
211 struct lttng_live_trace
*trace
;
213 trace
= lttng_live_find_trace(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 session
= g_new0(struct lttng_live_session
, 1);
237 BT_COMP_LOGE_APPEND_CAUSE(self_comp
,
238 "Failed to allocate live session");
242 session
->log_level
= lttng_live_msg_iter
->log_level
;
243 session
->self_comp
= lttng_live_msg_iter
->self_comp
;
244 session
->id
= session_id
;
245 session
->traces
= g_ptr_array_new_with_free_func(
246 (GDestroyNotify
) lttng_live_destroy_trace
);
247 BT_ASSERT(session
->traces
);
248 session
->lttng_live_msg_iter
= lttng_live_msg_iter
;
249 session
->new_streams_needed
= true;
250 session
->hostname
= g_string_new(hostname
);
251 BT_ASSERT(session
->hostname
);
253 session
->session_name
= g_string_new(session_name
);
254 BT_ASSERT(session
->session_name
);
256 BT_COMP_LOGI("Reading from session: %" PRIu64
" hostname: %s session_name: %s",
257 session
->id
, hostname
, session_name
);
258 g_ptr_array_add(lttng_live_msg_iter
->sessions
, session
);
268 void lttng_live_destroy_session(struct lttng_live_session
*session
)
270 bt_logging_level log_level
;
271 bt_self_component
*self_comp
;
277 log_level
= session
->log_level
;
278 self_comp
= session
->self_comp
;
279 BT_COMP_LOGD("Destroy lttng live session");
280 if (session
->id
!= -1ULL) {
281 if (lttng_live_detach_session(session
)) {
282 if (!lttng_live_graph_is_canceled(
283 session
->lttng_live_msg_iter
)) {
284 /* Old relayd cannot detach sessions. */
285 BT_COMP_LOGD("Unable to detach lttng live session %" PRIu64
,
292 if (session
->traces
) {
293 g_ptr_array_free(session
->traces
, TRUE
);
296 if (session
->hostname
) {
297 g_string_free(session
->hostname
, TRUE
);
299 if (session
->session_name
) {
300 g_string_free(session
->session_name
, TRUE
);
309 void lttng_live_msg_iter_destroy(struct lttng_live_msg_iter
*lttng_live_msg_iter
)
311 if (!lttng_live_msg_iter
) {
315 if (lttng_live_msg_iter
->sessions
) {
316 g_ptr_array_free(lttng_live_msg_iter
->sessions
, TRUE
);
319 if (lttng_live_msg_iter
->viewer_connection
) {
320 live_viewer_connection_destroy(lttng_live_msg_iter
->viewer_connection
);
322 BT_ASSERT(lttng_live_msg_iter
->lttng_live_comp
);
323 BT_ASSERT(lttng_live_msg_iter
->lttng_live_comp
->has_msg_iter
);
325 /* All stream iterators must be destroyed at this point. */
326 BT_ASSERT(lttng_live_msg_iter
->active_stream_iter
== 0);
327 lttng_live_msg_iter
->lttng_live_comp
->has_msg_iter
= false;
329 g_free(lttng_live_msg_iter
);
336 void lttng_live_msg_iter_finalize(bt_self_message_iterator
*self_msg_iter
)
338 struct lttng_live_msg_iter
*lttng_live_msg_iter
;
340 BT_ASSERT(self_msg_iter
);
342 lttng_live_msg_iter
= bt_self_message_iterator_get_data(self_msg_iter
);
343 BT_ASSERT(lttng_live_msg_iter
);
344 lttng_live_msg_iter_destroy(lttng_live_msg_iter
);
348 enum lttng_live_iterator_status
lttng_live_iterator_next_check_stream_state(
349 struct lttng_live_stream_iterator
*lttng_live_stream
)
351 bt_logging_level log_level
= lttng_live_stream
->log_level
;
352 bt_self_component
*self_comp
= lttng_live_stream
->self_comp
;
354 switch (lttng_live_stream
->state
) {
355 case LTTNG_LIVE_STREAM_QUIESCENT
:
356 case LTTNG_LIVE_STREAM_ACTIVE_DATA
:
358 case LTTNG_LIVE_STREAM_ACTIVE_NO_DATA
:
360 BT_COMP_LOGF("Unexpected stream state \"ACTIVE_NO_DATA\"");
362 case LTTNG_LIVE_STREAM_QUIESCENT_NO_DATA
:
364 BT_COMP_LOGF("Unexpected stream state \"QUIESCENT_NO_DATA\"");
366 case LTTNG_LIVE_STREAM_EOF
:
369 return LTTNG_LIVE_ITERATOR_STATUS_OK
;
373 * For active no data stream, fetch next data. It can be either:
374 * - quiescent: need to put it in the prio heap at quiescent end
376 * - have data: need to wire up first event into the prio heap,
377 * - have no data on this stream at this point: need to retry (AGAIN) or
381 enum lttng_live_iterator_status
lttng_live_iterator_next_handle_one_no_data_stream(
382 struct lttng_live_msg_iter
*lttng_live_msg_iter
,
383 struct lttng_live_stream_iterator
*lttng_live_stream
)
385 bt_logging_level log_level
= lttng_live_msg_iter
->log_level
;
386 bt_self_component
*self_comp
= lttng_live_msg_iter
->self_comp
;
387 enum lttng_live_iterator_status ret
= LTTNG_LIVE_ITERATOR_STATUS_OK
;
388 enum lttng_live_stream_state orig_state
= lttng_live_stream
->state
;
389 struct packet_index index
;
391 if (lttng_live_stream
->trace
->new_metadata_needed
) {
392 ret
= LTTNG_LIVE_ITERATOR_STATUS_CONTINUE
;
395 if (lttng_live_stream
->trace
->session
->new_streams_needed
) {
396 ret
= LTTNG_LIVE_ITERATOR_STATUS_CONTINUE
;
399 if (lttng_live_stream
->state
!= LTTNG_LIVE_STREAM_ACTIVE_NO_DATA
&&
400 lttng_live_stream
->state
!= LTTNG_LIVE_STREAM_QUIESCENT_NO_DATA
) {
403 ret
= lttng_live_get_next_index(lttng_live_msg_iter
, lttng_live_stream
,
405 if (ret
!= LTTNG_LIVE_ITERATOR_STATUS_OK
) {
408 BT_ASSERT_DBG(lttng_live_stream
->state
!= LTTNG_LIVE_STREAM_EOF
);
409 if (lttng_live_stream
->state
== LTTNG_LIVE_STREAM_QUIESCENT
) {
410 uint64_t last_inact_ts
= lttng_live_stream
->last_inactivity_ts
,
411 curr_inact_ts
= lttng_live_stream
->current_inactivity_ts
;
413 if (orig_state
== LTTNG_LIVE_STREAM_QUIESCENT_NO_DATA
&&
414 last_inact_ts
== curr_inact_ts
) {
415 ret
= LTTNG_LIVE_ITERATOR_STATUS_AGAIN
;
416 print_stream_state(lttng_live_stream
);
418 ret
= LTTNG_LIVE_ITERATOR_STATUS_CONTINUE
;
422 lttng_live_stream
->base_offset
= index
.offset
;
423 lttng_live_stream
->offset
= index
.offset
;
424 lttng_live_stream
->len
= index
.packet_size
/ CHAR_BIT
;
426 if (ret
== LTTNG_LIVE_ITERATOR_STATUS_OK
) {
427 ret
= lttng_live_iterator_next_check_stream_state(lttng_live_stream
);
433 * Creation of the message requires the ctf trace class to be created
434 * beforehand, but the live protocol gives us all streams (including metadata)
435 * at once. So we split it in three steps: getting streams, getting metadata
436 * (which creates the ctf trace class), and then creating the per-stream
440 enum lttng_live_iterator_status
lttng_live_get_session(
441 struct lttng_live_msg_iter
*lttng_live_msg_iter
,
442 struct lttng_live_session
*session
)
444 bt_logging_level log_level
= lttng_live_msg_iter
->log_level
;
445 bt_self_component
*self_comp
= lttng_live_msg_iter
->self_comp
;
446 enum lttng_live_iterator_status status
;
449 if (!session
->attached
) {
450 enum lttng_live_attach_session_status attach_status
=
451 lttng_live_attach_session(session
,
452 lttng_live_msg_iter
->self_msg_iter
);
453 if (attach_status
!= LTTNG_LIVE_ATTACH_SESSION_STATUS_OK
) {
454 if (lttng_live_graph_is_canceled(lttng_live_msg_iter
)) {
456 * Clear any causes appended in
457 * `lttng_live_attach_session()` as we want to
458 * return gracefully since the graph was
461 bt_current_thread_clear_error();
462 status
= LTTNG_LIVE_ITERATOR_STATUS_AGAIN
;
464 status
= LTTNG_LIVE_ITERATOR_STATUS_ERROR
;
465 BT_COMP_LOGE_APPEND_CAUSE(self_comp
,
466 "Error attaching to LTTng live session");
472 status
= lttng_live_get_new_streams(session
,
473 lttng_live_msg_iter
->self_msg_iter
);
474 if (status
!= LTTNG_LIVE_ITERATOR_STATUS_OK
&&
475 status
!= LTTNG_LIVE_ITERATOR_STATUS_END
) {
479 while (trace_idx
< session
->traces
->len
) {
480 struct lttng_live_trace
*trace
=
481 g_ptr_array_index(session
->traces
, trace_idx
);
483 status
= lttng_live_metadata_update(trace
);
485 case LTTNG_LIVE_ITERATOR_STATUS_OK
:
488 case LTTNG_LIVE_ITERATOR_STATUS_END
:
490 * The trace has ended. Remove it of the array an
491 * continue the iteration.
492 * We can remove the trace safely when using the
493 * g_ptr_array_remove_index_fast because it replaces
494 * the element at trace_idx with the array's last
495 * element. trace_idx is not incremented because of
498 (void) g_ptr_array_remove_index_fast(session
->traces
,
505 status
= lttng_live_lazy_msg_init(session
,
506 lttng_live_msg_iter
->self_msg_iter
);
513 void lttng_live_need_new_streams(struct lttng_live_msg_iter
*lttng_live_msg_iter
)
515 uint64_t session_idx
;
517 for (session_idx
= 0; session_idx
< lttng_live_msg_iter
->sessions
->len
;
519 struct lttng_live_session
*session
=
520 g_ptr_array_index(lttng_live_msg_iter
->sessions
, session_idx
);
521 session
->new_streams_needed
= true;
526 void lttng_live_force_new_streams_and_metadata(struct lttng_live_msg_iter
*lttng_live_msg_iter
)
528 uint64_t session_idx
, trace_idx
;
530 for (session_idx
= 0; session_idx
< lttng_live_msg_iter
->sessions
->len
;
532 struct lttng_live_session
*session
=
533 g_ptr_array_index(lttng_live_msg_iter
->sessions
, session_idx
);
534 session
->new_streams_needed
= true;
535 for (trace_idx
= 0; trace_idx
< session
->traces
->len
;
537 struct lttng_live_trace
*trace
=
538 g_ptr_array_index(session
->traces
, trace_idx
);
539 trace
->new_metadata_needed
= true;
545 enum lttng_live_iterator_status
546 lttng_live_iterator_handle_new_streams_and_metadata(
547 struct lttng_live_msg_iter
*lttng_live_msg_iter
)
549 enum lttng_live_iterator_status ret
= LTTNG_LIVE_ITERATOR_STATUS_OK
;
550 bt_logging_level log_level
= lttng_live_msg_iter
->log_level
;
551 bt_self_component
*self_comp
= lttng_live_msg_iter
->self_comp
;
552 uint64_t session_idx
= 0, nr_sessions_opened
= 0;
553 struct lttng_live_session
*session
;
554 enum session_not_found_action sess_not_found_act
=
555 lttng_live_msg_iter
->lttng_live_comp
->params
.sess_not_found_act
;
558 * In a remotely distant future, we could add a "new
559 * session" flag to the protocol, which would tell us that we
560 * need to query for new sessions even though we have sessions
563 if (lttng_live_msg_iter
->sessions
->len
== 0) {
564 if (sess_not_found_act
!= SESSION_NOT_FOUND_ACTION_CONTINUE
) {
565 ret
= LTTNG_LIVE_ITERATOR_STATUS_END
;
569 * Retry to create a viewer session for the requested
572 if (lttng_live_create_viewer_session(lttng_live_msg_iter
)) {
573 ret
= LTTNG_LIVE_ITERATOR_STATUS_ERROR
;
574 BT_COMP_LOGE_APPEND_CAUSE(self_comp
,
575 "Error creating LTTng live viewer session");
581 for (session_idx
= 0; session_idx
< lttng_live_msg_iter
->sessions
->len
;
583 session
= g_ptr_array_index(lttng_live_msg_iter
->sessions
,
585 ret
= lttng_live_get_session(lttng_live_msg_iter
, session
);
587 case LTTNG_LIVE_ITERATOR_STATUS_OK
:
589 case LTTNG_LIVE_ITERATOR_STATUS_END
:
590 ret
= LTTNG_LIVE_ITERATOR_STATUS_OK
;
595 if (!session
->closed
) {
596 nr_sessions_opened
++;
600 if (ret
== LTTNG_LIVE_ITERATOR_STATUS_OK
&&
601 sess_not_found_act
!= SESSION_NOT_FOUND_ACTION_CONTINUE
&&
602 nr_sessions_opened
== 0) {
603 ret
= LTTNG_LIVE_ITERATOR_STATUS_END
;
609 enum lttng_live_iterator_status
emit_inactivity_message(
610 struct lttng_live_msg_iter
*lttng_live_msg_iter
,
611 struct lttng_live_stream_iterator
*stream_iter
,
612 bt_message
**message
, uint64_t timestamp
)
614 enum lttng_live_iterator_status ret
= LTTNG_LIVE_ITERATOR_STATUS_OK
;
615 bt_logging_level log_level
= lttng_live_msg_iter
->log_level
;
616 bt_self_component
*self_comp
= lttng_live_msg_iter
->self_comp
;
617 bt_message
*msg
= NULL
;
619 BT_ASSERT(stream_iter
->trace
->clock_class
);
621 msg
= bt_message_message_iterator_inactivity_create(
622 lttng_live_msg_iter
->self_msg_iter
,
623 stream_iter
->trace
->clock_class
, timestamp
);
625 BT_COMP_LOGE_APPEND_CAUSE(self_comp
,
626 "Error emitting message iterator inactivity message");
635 ret
= LTTNG_LIVE_ITERATOR_STATUS_ERROR
;
636 bt_message_put_ref(msg
);
641 enum lttng_live_iterator_status
lttng_live_iterator_next_handle_one_quiescent_stream(
642 struct lttng_live_msg_iter
*lttng_live_msg_iter
,
643 struct lttng_live_stream_iterator
*lttng_live_stream
,
644 bt_message
**message
)
646 enum lttng_live_iterator_status ret
= LTTNG_LIVE_ITERATOR_STATUS_OK
;
648 if (lttng_live_stream
->state
!= LTTNG_LIVE_STREAM_QUIESCENT
) {
649 return LTTNG_LIVE_ITERATOR_STATUS_OK
;
652 if (lttng_live_stream
->current_inactivity_ts
==
653 lttng_live_stream
->last_inactivity_ts
) {
654 lttng_live_stream
->state
= LTTNG_LIVE_STREAM_QUIESCENT_NO_DATA
;
655 ret
= LTTNG_LIVE_ITERATOR_STATUS_CONTINUE
;
659 ret
= emit_inactivity_message(lttng_live_msg_iter
, lttng_live_stream
,
660 message
, lttng_live_stream
->current_inactivity_ts
);
662 lttng_live_stream
->last_inactivity_ts
=
663 lttng_live_stream
->current_inactivity_ts
;
669 int live_get_msg_ts_ns(struct lttng_live_stream_iterator
*stream_iter
,
670 struct lttng_live_msg_iter
*lttng_live_msg_iter
,
671 const bt_message
*msg
, int64_t last_msg_ts_ns
,
674 const bt_clock_class
*clock_class
= NULL
;
675 const bt_clock_snapshot
*clock_snapshot
= NULL
;
677 bt_logging_level log_level
= lttng_live_msg_iter
->log_level
;
678 bt_self_component
*self_comp
= lttng_live_msg_iter
->self_comp
;
681 BT_ASSERT_DBG(ts_ns
);
683 BT_COMP_LOGD("Getting message's timestamp: iter-data-addr=%p, msg-addr=%p, "
684 "last-msg-ts=%" PRId64
, lttng_live_msg_iter
, msg
,
687 switch (bt_message_get_type(msg
)) {
688 case BT_MESSAGE_TYPE_EVENT
:
689 clock_class
= bt_message_event_borrow_stream_class_default_clock_class_const(
691 BT_ASSERT_DBG(clock_class
);
693 clock_snapshot
= bt_message_event_borrow_default_clock_snapshot_const(
696 case BT_MESSAGE_TYPE_PACKET_BEGINNING
:
697 clock_class
= bt_message_packet_beginning_borrow_stream_class_default_clock_class_const(
699 BT_ASSERT(clock_class
);
701 clock_snapshot
= bt_message_packet_beginning_borrow_default_clock_snapshot_const(
704 case BT_MESSAGE_TYPE_PACKET_END
:
705 clock_class
= bt_message_packet_end_borrow_stream_class_default_clock_class_const(
707 BT_ASSERT(clock_class
);
709 clock_snapshot
= bt_message_packet_end_borrow_default_clock_snapshot_const(
712 case BT_MESSAGE_TYPE_DISCARDED_EVENTS
:
713 clock_class
= bt_message_discarded_events_borrow_stream_class_default_clock_class_const(
715 BT_ASSERT(clock_class
);
717 clock_snapshot
= bt_message_discarded_events_borrow_beginning_default_clock_snapshot_const(
720 case BT_MESSAGE_TYPE_DISCARDED_PACKETS
:
721 clock_class
= bt_message_discarded_packets_borrow_stream_class_default_clock_class_const(
723 BT_ASSERT(clock_class
);
725 clock_snapshot
= bt_message_discarded_packets_borrow_beginning_default_clock_snapshot_const(
728 case BT_MESSAGE_TYPE_MESSAGE_ITERATOR_INACTIVITY
:
729 clock_snapshot
= bt_message_message_iterator_inactivity_borrow_default_clock_snapshot_const(
733 /* All the other messages have a higher priority */
734 BT_COMP_LOGD_STR("Message has no timestamp: using the last message timestamp.");
735 *ts_ns
= last_msg_ts_ns
;
739 clock_class
= bt_clock_snapshot_borrow_clock_class_const(clock_snapshot
);
740 BT_ASSERT_DBG(clock_class
);
742 ret
= bt_clock_snapshot_get_ns_from_origin(clock_snapshot
, ts_ns
);
744 BT_COMP_LOGE_APPEND_CAUSE(self_comp
,
745 "Cannot get nanoseconds from Epoch of clock snapshot: "
746 "clock-snapshot-addr=%p", clock_snapshot
);
757 BT_COMP_LOGD("Found message's timestamp: "
758 "iter-data-addr=%p, msg-addr=%p, "
759 "last-msg-ts=%" PRId64
", ts=%" PRId64
,
760 lttng_live_msg_iter
, msg
, last_msg_ts_ns
, *ts_ns
);
767 enum lttng_live_iterator_status
lttng_live_iterator_next_handle_one_active_data_stream(
768 struct lttng_live_msg_iter
*lttng_live_msg_iter
,
769 struct lttng_live_stream_iterator
*lttng_live_stream
,
770 bt_message
**message
)
772 enum lttng_live_iterator_status ret
= LTTNG_LIVE_ITERATOR_STATUS_OK
;
773 bt_logging_level log_level
= lttng_live_msg_iter
->log_level
;
774 bt_self_component
*self_comp
= lttng_live_msg_iter
->self_comp
;
775 enum ctf_msg_iter_status status
;
776 uint64_t session_idx
, trace_idx
;
778 for (session_idx
= 0; session_idx
< lttng_live_msg_iter
->sessions
->len
;
780 struct lttng_live_session
*session
=
781 g_ptr_array_index(lttng_live_msg_iter
->sessions
, session_idx
);
783 if (session
->new_streams_needed
) {
784 ret
= LTTNG_LIVE_ITERATOR_STATUS_CONTINUE
;
787 for (trace_idx
= 0; trace_idx
< session
->traces
->len
;
789 struct lttng_live_trace
*trace
=
790 g_ptr_array_index(session
->traces
, trace_idx
);
791 if (trace
->new_metadata_needed
) {
792 ret
= LTTNG_LIVE_ITERATOR_STATUS_CONTINUE
;
798 if (lttng_live_stream
->state
!= LTTNG_LIVE_STREAM_ACTIVE_DATA
) {
799 ret
= LTTNG_LIVE_ITERATOR_STATUS_ERROR
;
803 status
= ctf_msg_iter_get_next_message(
804 lttng_live_stream
->msg_iter
, message
);
806 case CTF_MSG_ITER_STATUS_EOF
:
807 ret
= LTTNG_LIVE_ITERATOR_STATUS_END
;
809 case CTF_MSG_ITER_STATUS_OK
:
810 ret
= LTTNG_LIVE_ITERATOR_STATUS_OK
;
812 case CTF_MSG_ITER_STATUS_AGAIN
:
814 * Continue immediately (end of packet). The next
815 * get_index may return AGAIN to delay the following
818 ret
= LTTNG_LIVE_ITERATOR_STATUS_CONTINUE
;
820 case CTF_MSG_ITER_STATUS_INVAL
:
821 /* No argument provided by the user, so don't return INVAL. */
822 case CTF_MSG_ITER_STATUS_ERROR
:
824 ret
= LTTNG_LIVE_ITERATOR_STATUS_ERROR
;
825 BT_COMP_LOGE_APPEND_CAUSE(self_comp
,
826 "CTF message iterator return an error or failed: "
827 "msg_iter=%p", lttng_live_stream
->msg_iter
);
836 enum lttng_live_iterator_status
lttng_live_iterator_close_stream(
837 struct lttng_live_msg_iter
*lttng_live_msg_iter
,
838 struct lttng_live_stream_iterator
*stream_iter
,
839 bt_message
**curr_msg
)
841 enum lttng_live_iterator_status live_status
=
842 LTTNG_LIVE_ITERATOR_STATUS_OK
;
843 bt_logging_level log_level
= lttng_live_msg_iter
->log_level
;
844 bt_self_component
*self_comp
= lttng_live_msg_iter
->self_comp
;
846 * The viewer has hung up on us so we are closing the stream. The
847 * `ctf_msg_iter` should simply realize that it needs to close the
848 * stream properly by emitting the necessary stream end message.
850 enum ctf_msg_iter_status status
= ctf_msg_iter_get_next_message(
851 stream_iter
->msg_iter
, curr_msg
);
853 if (status
== CTF_MSG_ITER_STATUS_ERROR
) {
854 BT_COMP_LOGE_APPEND_CAUSE(self_comp
,
855 "Error getting the next message from CTF message iterator");
856 live_status
= LTTNG_LIVE_ITERATOR_STATUS_ERROR
;
860 BT_ASSERT(status
== CTF_MSG_ITER_STATUS_OK
);
868 * handle_no_data_streams()
870 * - for each ACTIVE_NO_DATA stream:
871 * - query relayd for stream data, or quiescence info.
872 * - if need metadata, get metadata, goto retry.
873 * - if new stream, get new stream as ACTIVE_NO_DATA, goto retry
874 * - if quiescent, move to QUIESCENT streams
875 * - if fetched data, move to ACTIVE_DATA streams
876 * (at this point each stream either has data, or is quiescent)
880 * handle_new_streams_and_metadata()
881 * - query relayd for known streams, add them as ACTIVE_NO_DATA
882 * - query relayd for metadata
884 * call handle_active_no_data_streams()
886 * handle_quiescent_streams()
887 * - if at least one stream is ACTIVE_DATA:
888 * - peek stream event with lowest timestamp -> next_ts
889 * - for each quiescent stream
890 * - if next_ts >= quiescent end
891 * - set state to ACTIVE_NO_DATA
893 * - for each quiescent stream
894 * - set state to ACTIVE_NO_DATA
896 * call handle_active_no_data_streams()
898 * handle_active_data_streams()
899 * - if at least one stream is ACTIVE_DATA:
900 * - get stream event with lowest timestamp from heap
901 * - make that stream event the current message.
902 * - move this stream heap position to its next event
903 * - if we need to fetch data from relayd, move
904 * stream to ACTIVE_NO_DATA.
908 * end criterion: ctrl-c on client. If relayd exits or the session
909 * closes on the relay daemon side, we keep on waiting for streams.
910 * Eventually handle --end timestamp (also an end criterion).
912 * When disconnected from relayd: try to re-connect endlessly.
915 enum lttng_live_iterator_status
lttng_live_iterator_next_msg_on_stream(
916 struct lttng_live_msg_iter
*lttng_live_msg_iter
,
917 struct lttng_live_stream_iterator
*stream_iter
,
918 bt_message
**curr_msg
)
920 bt_logging_level log_level
= lttng_live_msg_iter
->log_level
;
921 bt_self_component
*self_comp
= lttng_live_msg_iter
->self_comp
;
922 enum lttng_live_iterator_status live_status
;
924 if (stream_iter
->has_stream_hung_up
) {
926 * The stream has hung up and the stream was properly closed
927 * during the last call to the current function. Return _END
928 * status now so that this stream iterator is removed for the
929 * stream iterator list.
931 live_status
= LTTNG_LIVE_ITERATOR_STATUS_END
;
936 print_stream_state(stream_iter
);
937 live_status
= lttng_live_iterator_handle_new_streams_and_metadata(
938 lttng_live_msg_iter
);
939 if (live_status
!= LTTNG_LIVE_ITERATOR_STATUS_OK
) {
942 live_status
= lttng_live_iterator_next_handle_one_no_data_stream(
943 lttng_live_msg_iter
, stream_iter
);
945 if (live_status
!= LTTNG_LIVE_ITERATOR_STATUS_OK
) {
946 if (live_status
== LTTNG_LIVE_ITERATOR_STATUS_END
) {
948 * We overwrite `live_status` since `curr_msg` is
949 * likely set to a valid message in this function.
951 live_status
= lttng_live_iterator_close_stream(
952 lttng_live_msg_iter
, stream_iter
, curr_msg
);
956 live_status
= lttng_live_iterator_next_handle_one_quiescent_stream(
957 lttng_live_msg_iter
, stream_iter
, curr_msg
);
958 if (live_status
!= LTTNG_LIVE_ITERATOR_STATUS_OK
) {
959 BT_ASSERT(!*curr_msg
);
965 live_status
= lttng_live_iterator_next_handle_one_active_data_stream(
966 lttng_live_msg_iter
, stream_iter
, curr_msg
);
967 if (live_status
!= LTTNG_LIVE_ITERATOR_STATUS_OK
) {
968 BT_ASSERT(!*curr_msg
);
972 if (live_status
== LTTNG_LIVE_ITERATOR_STATUS_CONTINUE
) {
980 enum lttng_live_iterator_status
next_stream_iterator_for_trace(
981 struct lttng_live_msg_iter
*lttng_live_msg_iter
,
982 struct lttng_live_trace
*live_trace
,
983 struct lttng_live_stream_iterator
**youngest_trace_stream_iter
)
985 struct lttng_live_stream_iterator
*youngest_candidate_stream_iter
= NULL
;
986 bt_logging_level log_level
= lttng_live_msg_iter
->log_level
;
987 bt_self_component
*self_comp
= lttng_live_msg_iter
->self_comp
;
988 enum lttng_live_iterator_status stream_iter_status
;;
989 int64_t youngest_candidate_msg_ts
= INT64_MAX
;
990 uint64_t stream_iter_idx
;
992 BT_ASSERT_DBG(live_trace
);
993 BT_ASSERT_DBG(live_trace
->stream_iterators
);
995 * Update the current message of every stream iterators of this trace.
996 * The current msg of every stream must have a timestamp equal or
997 * larger than the last message returned by this iterator. We must
998 * ensure monotonicity.
1000 stream_iter_idx
= 0;
1001 while (stream_iter_idx
< live_trace
->stream_iterators
->len
) {
1002 bool stream_iter_is_ended
= false;
1003 struct lttng_live_stream_iterator
*stream_iter
=
1004 g_ptr_array_index(live_trace
->stream_iterators
,
1008 * Find if there is are now current message for this stream
1011 while (!stream_iter
->current_msg
) {
1012 bt_message
*msg
= NULL
;
1013 int64_t curr_msg_ts_ns
= INT64_MAX
;
1014 stream_iter_status
= lttng_live_iterator_next_msg_on_stream(
1015 lttng_live_msg_iter
, stream_iter
, &msg
);
1017 BT_COMP_LOGD("live stream iterator returned status :%s",
1018 print_live_iterator_status(stream_iter_status
));
1019 if (stream_iter_status
== LTTNG_LIVE_ITERATOR_STATUS_END
) {
1020 stream_iter_is_ended
= true;
1024 if (stream_iter_status
!= LTTNG_LIVE_ITERATOR_STATUS_OK
) {
1031 * Get the timestamp in nanoseconds from origin of this
1034 live_get_msg_ts_ns(stream_iter
, lttng_live_msg_iter
,
1035 msg
, lttng_live_msg_iter
->last_msg_ts_ns
,
1039 * Check if the message of the current live stream
1040 * iterator occured at the exact same time or after the
1041 * last message returned by this component's message
1042 * iterator. If not, we return an error.
1044 if (curr_msg_ts_ns
>= lttng_live_msg_iter
->last_msg_ts_ns
) {
1045 stream_iter
->current_msg
= msg
;
1046 stream_iter
->current_msg_ts_ns
= curr_msg_ts_ns
;
1049 * We received a message in the past. To ensure
1050 * monotonicity, we can't send it forward.
1052 BT_COMP_LOGE_APPEND_CAUSE(self_comp
,
1053 "Message's timestamp is less than "
1054 "lttng-live's message iterator's last "
1055 "returned timestamp: "
1056 "lttng-live-msg-iter-addr=%p, ts=%" PRId64
", "
1057 "last-msg-ts=%" PRId64
,
1058 lttng_live_msg_iter
, curr_msg_ts_ns
,
1059 lttng_live_msg_iter
->last_msg_ts_ns
);
1060 stream_iter_status
= LTTNG_LIVE_ITERATOR_STATUS_ERROR
;
1065 BT_ASSERT_DBG(stream_iter
!= youngest_candidate_stream_iter
);
1067 if (!stream_iter_is_ended
) {
1068 if (G_UNLIKELY(youngest_candidate_stream_iter
== NULL
) ||
1069 stream_iter
->current_msg_ts_ns
< youngest_candidate_msg_ts
) {
1071 * Update the current best candidate message
1072 * for the stream iterator of this live trace
1073 * to be forwarded downstream.
1075 youngest_candidate_msg_ts
= stream_iter
->current_msg_ts_ns
;
1076 youngest_candidate_stream_iter
= stream_iter
;
1077 } else if (stream_iter
->current_msg_ts_ns
== youngest_candidate_msg_ts
) {
1079 * Order the messages in an arbitrary but
1080 * deterministic way.
1082 BT_ASSERT_DBG(stream_iter
!= youngest_candidate_stream_iter
);
1083 int ret
= common_muxing_compare_messages(
1084 stream_iter
->current_msg
,
1085 youngest_candidate_stream_iter
->current_msg
);
1088 * The `youngest_candidate_stream_iter->current_msg`
1089 * should go first. Update the next
1090 * iterator and the current timestamp.
1092 youngest_candidate_msg_ts
= stream_iter
->current_msg_ts_ns
;
1093 youngest_candidate_stream_iter
= stream_iter
;
1094 } else if (ret
== 0) {
1096 * Unable to pick which one should go
1099 BT_COMP_LOGW("Cannot deterministically pick next live stream message iterator because they have identical next messages: "
1100 "stream-iter-addr=%p"
1101 "stream-iter-addr=%p",
1103 youngest_candidate_stream_iter
);
1110 * The live stream iterator has ended. That
1111 * iterator is removed from the array, but
1112 * there is no need to increment
1113 * stream_iter_idx as
1114 * g_ptr_array_remove_index_fast replaces the
1115 * removed element with the array's last
1118 g_ptr_array_remove_index_fast(
1119 live_trace
->stream_iterators
,
1124 if (youngest_candidate_stream_iter
) {
1125 *youngest_trace_stream_iter
= youngest_candidate_stream_iter
;
1126 stream_iter_status
= LTTNG_LIVE_ITERATOR_STATUS_OK
;
1129 * The only case where we don't have a candidate for this trace
1130 * is if we reached the end of all the iterators.
1132 BT_ASSERT(live_trace
->stream_iterators
->len
== 0);
1133 stream_iter_status
= LTTNG_LIVE_ITERATOR_STATUS_END
;
1137 return stream_iter_status
;
1141 enum lttng_live_iterator_status
next_stream_iterator_for_session(
1142 struct lttng_live_msg_iter
*lttng_live_msg_iter
,
1143 struct lttng_live_session
*session
,
1144 struct lttng_live_stream_iterator
**youngest_session_stream_iter
)
1146 bt_self_component
*self_comp
= lttng_live_msg_iter
->self_comp
;
1147 bt_logging_level log_level
= lttng_live_msg_iter
->log_level
;
1148 enum lttng_live_iterator_status stream_iter_status
;
1149 uint64_t trace_idx
= 0;
1150 int64_t youngest_candidate_msg_ts
= INT64_MAX
;
1151 struct lttng_live_stream_iterator
*youngest_candidate_stream_iter
= NULL
;
1154 * Make sure we are attached to the session and look for new streams
1157 stream_iter_status
= lttng_live_get_session(lttng_live_msg_iter
, session
);
1158 if (stream_iter_status
!= LTTNG_LIVE_ITERATOR_STATUS_OK
&&
1159 stream_iter_status
!= LTTNG_LIVE_ITERATOR_STATUS_CONTINUE
&&
1160 stream_iter_status
!= LTTNG_LIVE_ITERATOR_STATUS_END
) {
1164 BT_ASSERT_DBG(session
->traces
);
1166 while (trace_idx
< session
->traces
->len
) {
1167 bool trace_is_ended
= false;
1168 struct lttng_live_stream_iterator
*stream_iter
;
1169 struct lttng_live_trace
*trace
=
1170 g_ptr_array_index(session
->traces
, trace_idx
);
1172 stream_iter_status
= next_stream_iterator_for_trace(
1173 lttng_live_msg_iter
, trace
, &stream_iter
);
1174 if (stream_iter_status
== LTTNG_LIVE_ITERATOR_STATUS_END
) {
1176 * All the live stream iterators for this trace are
1177 * ENDed. Remove the trace from this session.
1179 trace_is_ended
= true;
1180 } else if (stream_iter_status
!= LTTNG_LIVE_ITERATOR_STATUS_OK
) {
1184 if (!trace_is_ended
) {
1185 BT_ASSERT_DBG(stream_iter
);
1187 if (G_UNLIKELY(youngest_candidate_stream_iter
== NULL
) ||
1188 stream_iter
->current_msg_ts_ns
< youngest_candidate_msg_ts
) {
1189 youngest_candidate_msg_ts
= stream_iter
->current_msg_ts_ns
;
1190 youngest_candidate_stream_iter
= stream_iter
;
1191 } else if (stream_iter
->current_msg_ts_ns
== youngest_candidate_msg_ts
) {
1193 * Order the messages in an arbitrary but
1194 * deterministic way.
1196 int ret
= common_muxing_compare_messages(
1197 stream_iter
->current_msg
,
1198 youngest_candidate_stream_iter
->current_msg
);
1201 * The `youngest_candidate_stream_iter->current_msg`
1202 * should go first. Update the next iterator
1203 * and the current timestamp.
1205 youngest_candidate_msg_ts
= stream_iter
->current_msg_ts_ns
;
1206 youngest_candidate_stream_iter
= stream_iter
;
1207 } else if (ret
== 0) {
1208 /* Unable to pick which one should go first. */
1209 BT_COMP_LOGW("Cannot deterministically pick next live stream message iterator because they have identical next messages: "
1210 "stream-iter-addr=%p" "stream-iter-addr=%p",
1211 stream_iter
, youngest_candidate_stream_iter
);
1217 * trace_idx is not incremented since
1218 * g_ptr_array_remove_index_fast replaces the
1219 * element at trace_idx with the array's last element.
1221 g_ptr_array_remove_index_fast(session
->traces
,
1225 if (youngest_candidate_stream_iter
) {
1226 *youngest_session_stream_iter
= youngest_candidate_stream_iter
;
1227 stream_iter_status
= LTTNG_LIVE_ITERATOR_STATUS_OK
;
1230 * The only cases where we don't have a candidate for this
1232 * 1. if we reached the end of all the iterators of all the
1233 * traces of this session,
1234 * 2. if we never had live stream iterator in the first place.
1236 * In either cases, we return END.
1238 BT_ASSERT(session
->traces
->len
== 0);
1239 stream_iter_status
= LTTNG_LIVE_ITERATOR_STATUS_END
;
1242 return stream_iter_status
;
1246 void put_messages(bt_message_array_const msgs
, uint64_t count
)
1250 for (i
= 0; i
< count
; i
++) {
1251 BT_MESSAGE_PUT_REF_AND_RESET(msgs
[i
]);
1256 bt_component_class_message_iterator_next_method_status
lttng_live_msg_iter_next(
1257 bt_self_message_iterator
*self_msg_it
,
1258 bt_message_array_const msgs
, uint64_t capacity
,
1261 bt_component_class_message_iterator_next_method_status status
;
1262 struct lttng_live_msg_iter
*lttng_live_msg_iter
=
1263 bt_self_message_iterator_get_data(self_msg_it
);
1264 struct lttng_live_component
*lttng_live
=
1265 lttng_live_msg_iter
->lttng_live_comp
;
1266 bt_self_component
*self_comp
= lttng_live_msg_iter
->self_comp
;
1267 bt_logging_level log_level
= lttng_live_msg_iter
->log_level
;
1268 enum lttng_live_iterator_status stream_iter_status
;
1269 uint64_t session_idx
;
1273 BT_ASSERT_DBG(lttng_live_msg_iter
);
1276 * Clear all the invalid message reference that might be left over in
1279 memset(msgs
, 0, capacity
* sizeof(*msgs
));
1282 * If no session are exposed on the relay found at the url provided by
1283 * the user, session count will be 0. In this case, we return status
1284 * end to return gracefully.
1286 if (lttng_live_msg_iter
->sessions
->len
== 0) {
1287 if (lttng_live
->params
.sess_not_found_act
!=
1288 SESSION_NOT_FOUND_ACTION_CONTINUE
) {
1289 status
= BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_END
;
1293 * The are no more active session for this session
1294 * name. Retry to create a viewer session for the
1295 * requested session name.
1297 if (lttng_live_create_viewer_session(lttng_live_msg_iter
)) {
1298 status
= BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_ERROR
;
1304 if (lttng_live_msg_iter
->active_stream_iter
== 0) {
1305 lttng_live_force_new_streams_and_metadata(lttng_live_msg_iter
);
1309 * Here the muxing of message is done.
1311 * We need to iterate over all the streams of all the traces of all the
1312 * viewer sessions in order to get the message with the smallest
1313 * timestamp. In this case, a session is a viewer session and there is
1314 * one viewer session per consumer daemon. (UST 32bit, UST 64bit and/or
1315 * kernel). Each viewer session can have multiple traces, for example,
1316 * 64bit UST viewer sessions could have multiple per-pid traces.
1318 * We iterate over the streams of each traces to update and see what is
1319 * their next message's timestamp. From those timestamps, we select the
1320 * message with the smallest timestamp as the best candidate message
1321 * for that trace and do the same thing across all the sessions.
1323 * We then compare the timestamp of best candidate message of all the
1324 * sessions to pick the message with the smallest timestamp and we
1327 while (*count
< capacity
) {
1328 struct lttng_live_stream_iterator
*youngest_stream_iter
= NULL
,
1329 *candidate_stream_iter
= NULL
;
1330 int64_t youngest_msg_ts_ns
= INT64_MAX
;
1332 BT_ASSERT_DBG(lttng_live_msg_iter
->sessions
);
1334 while (session_idx
< lttng_live_msg_iter
->sessions
->len
) {
1335 struct lttng_live_session
*session
=
1336 g_ptr_array_index(lttng_live_msg_iter
->sessions
,
1339 /* Find the best candidate message to send downstream. */
1340 stream_iter_status
= next_stream_iterator_for_session(
1341 lttng_live_msg_iter
, session
,
1342 &candidate_stream_iter
);
1344 /* If we receive an END status, it means that either:
1345 * - Those traces never had active streams (UST with no
1346 * data produced yet),
1347 * - All live stream iterators have ENDed.*/
1348 if (stream_iter_status
== LTTNG_LIVE_ITERATOR_STATUS_END
) {
1349 if (session
->closed
&& session
->traces
->len
== 0) {
1351 * Remove the session from the list.
1352 * session_idx is not modified since
1353 * g_ptr_array_remove_index_fast
1354 * replaces the the removed element with
1355 * the array's last element.
1357 g_ptr_array_remove_index_fast(
1358 lttng_live_msg_iter
->sessions
,
1366 if (stream_iter_status
!= LTTNG_LIVE_ITERATOR_STATUS_OK
) {
1370 if (G_UNLIKELY(youngest_stream_iter
== NULL
) ||
1371 candidate_stream_iter
->current_msg_ts_ns
< youngest_msg_ts_ns
) {
1372 youngest_msg_ts_ns
= candidate_stream_iter
->current_msg_ts_ns
;
1373 youngest_stream_iter
= candidate_stream_iter
;
1374 } else if (candidate_stream_iter
->current_msg_ts_ns
== youngest_msg_ts_ns
) {
1376 * The currently selected message to be sent
1377 * downstream next has the exact same timestamp
1378 * that of the current candidate message. We
1379 * must break the tie in a predictable manner.
1381 BT_COMP_LOGD_STR("Two of the next message candidates have the same timestamps, pick one deterministically.");
1383 * Order the messages in an arbitrary but
1384 * deterministic way.
1386 int ret
= common_muxing_compare_messages(
1387 candidate_stream_iter
->current_msg
,
1388 youngest_stream_iter
->current_msg
);
1391 * The `candidate_stream_iter->current_msg`
1392 * should go first. Update the next
1393 * iterator and the current timestamp.
1395 youngest_msg_ts_ns
= candidate_stream_iter
->current_msg_ts_ns
;
1396 youngest_stream_iter
= candidate_stream_iter
;
1397 } else if (ret
== 0) {
1398 /* Unable to pick which one should go first. */
1399 BT_COMP_LOGW("Cannot deterministically pick next live stream message iterator because they have identical next messages: "
1400 "next-stream-iter-addr=%p" "candidate-stream-iter-addr=%p",
1401 youngest_stream_iter
, candidate_stream_iter
);
1408 if (!youngest_stream_iter
) {
1409 stream_iter_status
= LTTNG_LIVE_ITERATOR_STATUS_AGAIN
;
1413 BT_ASSERT_DBG(youngest_stream_iter
->current_msg
);
1414 /* Ensure monotonicity. */
1415 BT_ASSERT_DBG(lttng_live_msg_iter
->last_msg_ts_ns
<=
1416 youngest_stream_iter
->current_msg_ts_ns
);
1419 * Insert the next message to the message batch. This will set
1420 * stream iterator current messsage to NULL so that next time
1421 * we fetch the next message of that stream iterator
1423 BT_MESSAGE_MOVE_REF(msgs
[*count
], youngest_stream_iter
->current_msg
);
1426 /* Update the last timestamp in nanoseconds sent downstream. */
1427 lttng_live_msg_iter
->last_msg_ts_ns
= youngest_msg_ts_ns
;
1428 youngest_stream_iter
->current_msg_ts_ns
= INT64_MAX
;
1430 stream_iter_status
= LTTNG_LIVE_ITERATOR_STATUS_OK
;
1433 switch (stream_iter_status
) {
1434 case LTTNG_LIVE_ITERATOR_STATUS_OK
:
1435 case LTTNG_LIVE_ITERATOR_STATUS_AGAIN
:
1438 * We received a again status but we have some messages
1439 * to send downstream. We send them and return OK for
1440 * now. On the next call we return again if there are
1441 * still no new message to send.
1443 status
= BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK
;
1445 status
= BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_AGAIN
;
1448 case LTTNG_LIVE_ITERATOR_STATUS_END
:
1449 status
= BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_END
;
1451 case LTTNG_LIVE_ITERATOR_STATUS_NOMEM
:
1452 status
= BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_MEMORY_ERROR
;
1454 case LTTNG_LIVE_ITERATOR_STATUS_ERROR
:
1455 case LTTNG_LIVE_ITERATOR_STATUS_INVAL
:
1456 case LTTNG_LIVE_ITERATOR_STATUS_UNSUPPORTED
:
1457 status
= BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_ERROR
;
1458 /* Put all existing messages on error. */
1459 put_messages(msgs
, *count
);
1470 bt_component_class_message_iterator_initialize_method_status
lttng_live_msg_iter_init(
1471 bt_self_message_iterator
*self_msg_it
,
1472 bt_self_message_iterator_configuration
*config
,
1473 bt_self_component_source
*self_comp_src
,
1474 bt_self_component_port_output
*self_port
)
1476 bt_component_class_message_iterator_initialize_method_status ret
=
1477 BT_COMPONENT_CLASS_MESSAGE_ITERATOR_INITIALIZE_METHOD_STATUS_OK
;
1478 bt_self_component
*self_comp
=
1479 bt_self_component_source_as_self_component(self_comp_src
);
1480 struct lttng_live_component
*lttng_live
;
1481 struct lttng_live_msg_iter
*lttng_live_msg_iter
;
1482 bt_logging_level log_level
;
1484 BT_ASSERT(self_msg_it
);
1486 lttng_live
= bt_self_component_get_data(self_comp
);
1487 log_level
= lttng_live
->log_level
;
1488 self_comp
= lttng_live
->self_comp
;
1490 /* There can be only one downstream iterator at the same time. */
1491 BT_ASSERT(!lttng_live
->has_msg_iter
);
1492 lttng_live
->has_msg_iter
= true;
1494 lttng_live_msg_iter
= g_new0(struct lttng_live_msg_iter
, 1);
1495 if (!lttng_live_msg_iter
) {
1496 ret
= BT_COMPONENT_CLASS_MESSAGE_ITERATOR_INITIALIZE_METHOD_STATUS_ERROR
;
1500 lttng_live_msg_iter
->log_level
= lttng_live
->log_level
;
1501 lttng_live_msg_iter
->self_comp
= lttng_live
->self_comp
;
1502 lttng_live_msg_iter
->lttng_live_comp
= lttng_live
;
1503 lttng_live_msg_iter
->self_msg_iter
= self_msg_it
;
1505 lttng_live_msg_iter
->active_stream_iter
= 0;
1506 lttng_live_msg_iter
->last_msg_ts_ns
= INT64_MIN
;
1507 lttng_live_msg_iter
->sessions
= g_ptr_array_new_with_free_func(
1508 (GDestroyNotify
) lttng_live_destroy_session
);
1509 BT_ASSERT(lttng_live_msg_iter
->sessions
);
1511 lttng_live_msg_iter
->viewer_connection
=
1512 live_viewer_connection_create(lttng_live
->params
.url
->str
, false,
1513 lttng_live_msg_iter
, self_comp
, NULL
, log_level
);
1514 if (!lttng_live_msg_iter
->viewer_connection
) {
1518 if (lttng_live_create_viewer_session(lttng_live_msg_iter
)) {
1521 if (lttng_live_msg_iter
->sessions
->len
== 0) {
1522 switch (lttng_live
->params
.sess_not_found_act
) {
1523 case SESSION_NOT_FOUND_ACTION_CONTINUE
:
1524 BT_COMP_LOGI("Unable to connect to the requested live viewer "
1525 "session. Keep trying to connect because of "
1526 "%s=\"%s\" component parameter: url=\"%s\"",
1527 SESS_NOT_FOUND_ACTION_PARAM
,
1528 SESS_NOT_FOUND_ACTION_CONTINUE_STR
,
1529 lttng_live
->params
.url
->str
);
1531 case SESSION_NOT_FOUND_ACTION_FAIL
:
1532 BT_COMP_LOGE_APPEND_CAUSE(self_comp
, "Unable to connect to the requested live viewer "
1533 "session. Fail the message iterator"
1534 "initialization because of %s=\"%s\" "
1535 "component parameter: url =\"%s\"",
1536 SESS_NOT_FOUND_ACTION_PARAM
,
1537 SESS_NOT_FOUND_ACTION_FAIL_STR
,
1538 lttng_live
->params
.url
->str
);
1540 case SESSION_NOT_FOUND_ACTION_END
:
1541 BT_COMP_LOGI("Unable to connect to the requested live viewer "
1542 "session. End gracefully at the first _next() "
1543 "call because of %s=\"%s\" component parameter: "
1544 "url=\"%s\"", SESS_NOT_FOUND_ACTION_PARAM
,
1545 SESS_NOT_FOUND_ACTION_END_STR
,
1546 lttng_live
->params
.url
->str
);
1553 bt_self_message_iterator_set_data(self_msg_it
, lttng_live_msg_iter
);
1557 ret
= BT_COMPONENT_CLASS_MESSAGE_ITERATOR_INITIALIZE_METHOD_STATUS_ERROR
;
1558 lttng_live_msg_iter_destroy(lttng_live_msg_iter
);
1563 static struct bt_param_validation_map_value_entry_descr list_sessions_params
[] = {
1564 { URL_PARAM
, BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_MANDATORY
, { .type
= BT_VALUE_TYPE_STRING
} },
1565 BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_END
1569 bt_component_class_query_method_status
lttng_live_query_list_sessions(
1570 const bt_value
*params
, const bt_value
**result
,
1571 bt_self_component_class
*self_comp_class
,
1572 bt_logging_level log_level
)
1574 bt_component_class_query_method_status status
;
1575 const bt_value
*url_value
= NULL
;
1577 struct live_viewer_connection
*viewer_connection
= NULL
;
1578 enum bt_param_validation_status validation_status
;
1579 gchar
*validate_error
= NULL
;
1581 validation_status
= bt_param_validation_validate(params
,
1582 list_sessions_params
, &validate_error
);
1583 if (validation_status
== BT_PARAM_VALIDATION_STATUS_MEMORY_ERROR
) {
1584 status
= BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_MEMORY_ERROR
;
1586 } else if (validation_status
== BT_PARAM_VALIDATION_STATUS_VALIDATION_ERROR
) {
1587 status
= BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_ERROR
;
1588 BT_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp_class
, "%s",
1593 url_value
= bt_value_map_borrow_entry_value_const(params
, URL_PARAM
);
1594 url
= bt_value_string_get(url_value
);
1596 viewer_connection
= live_viewer_connection_create(url
, true, NULL
,
1597 NULL
, self_comp_class
, log_level
);
1598 if (!viewer_connection
) {
1599 BT_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp_class
,
1600 "Failed to create viewer connection");
1601 status
= BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_ERROR
;
1605 status
= live_viewer_connection_list_sessions(viewer_connection
,
1607 if (status
!= BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_OK
) {
1608 BT_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp_class
,
1609 "Failed to list viewer sessions");
1616 BT_VALUE_PUT_REF_AND_RESET(*result
);
1619 status
= BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_ERROR
;
1623 if (viewer_connection
) {
1624 live_viewer_connection_destroy(viewer_connection
);
1627 g_free(validate_error
);
1633 bt_component_class_query_method_status
lttng_live_query_support_info(
1634 const bt_value
*params
, const bt_value
**result
,
1635 bt_self_component_class
*self_comp_class
,
1636 bt_logging_level log_level
)
1638 bt_component_class_query_method_status status
=
1639 BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_OK
;
1640 const bt_value
*input_type_value
;
1641 const bt_value
*input_value
;
1643 struct bt_common_lttng_live_url_parts parts
= { 0 };
1645 /* Used by the logging macros */
1646 __attribute__((unused
)) bt_self_component
*self_comp
= NULL
;
1649 input_type_value
= bt_value_map_borrow_entry_value_const(params
,
1651 if (!input_type_value
) {
1652 BT_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp_class
,
1653 "Missing expected `type` parameter.");
1657 if (!bt_value_is_string(input_type_value
)) {
1658 BT_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp_class
,
1659 "`type` parameter is not a string value.");
1663 if (strcmp(bt_value_string_get(input_type_value
), "string") != 0) {
1664 /* We don't handle file system paths */
1668 input_value
= bt_value_map_borrow_entry_value_const(params
, "input");
1670 BT_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp_class
,
1671 "Missing expected `input` parameter.");
1675 if (!bt_value_is_string(input_value
)) {
1676 BT_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp_class
,
1677 "`input` parameter is not a string value.");
1681 parts
= bt_common_parse_lttng_live_url(bt_value_string_get(input_value
),
1683 if (parts
.session_name
) {
1685 * Looks pretty much like an LTTng live URL: we got the
1686 * session name part, which forms a complete URL.
1692 *result
= bt_value_real_create_init(weight
);
1694 status
= BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_MEMORY_ERROR
;
1702 status
= BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_ERROR
;
1705 BT_ASSERT(!*result
);
1708 bt_common_destroy_lttng_live_url_parts(&parts
);
1713 bt_component_class_query_method_status
lttng_live_query(
1714 bt_self_component_class_source
*comp_class
,
1715 bt_private_query_executor
*priv_query_exec
,
1716 const char *object
, const bt_value
*params
,
1717 __attribute__((unused
)) void *method_data
,
1718 const bt_value
**result
)
1720 bt_component_class_query_method_status status
=
1721 BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_OK
;
1722 bt_self_component
*self_comp
= NULL
;
1723 bt_self_component_class
*self_comp_class
=
1724 bt_self_component_class_source_as_self_component_class(comp_class
);
1725 bt_logging_level log_level
= bt_query_executor_get_logging_level(
1726 bt_private_query_executor_as_query_executor_const(
1729 if (strcmp(object
, "sessions") == 0) {
1730 status
= lttng_live_query_list_sessions(params
, result
,
1731 self_comp_class
, log_level
);
1732 } else if (strcmp(object
, "babeltrace.support-info") == 0) {
1733 status
= lttng_live_query_support_info(params
, result
,
1734 self_comp_class
, log_level
);
1736 BT_COMP_LOGI("Unknown query object `%s`", object
);
1737 status
= BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_UNKNOWN_OBJECT
;
1746 void lttng_live_component_destroy_data(struct lttng_live_component
*lttng_live
)
1751 if (lttng_live
->params
.url
) {
1752 g_string_free(lttng_live
->params
.url
, TRUE
);
1758 void lttng_live_component_finalize(bt_self_component_source
*component
)
1760 void *data
= bt_self_component_get_data(
1761 bt_self_component_source_as_self_component(component
));
1766 lttng_live_component_destroy_data(data
);
1770 enum session_not_found_action
parse_session_not_found_action_param(
1771 const bt_value
*no_session_param
)
1773 enum session_not_found_action action
;
1774 const char *no_session_act_str
= bt_value_string_get(no_session_param
);
1776 if (strcmp(no_session_act_str
, SESS_NOT_FOUND_ACTION_CONTINUE_STR
) == 0) {
1777 action
= SESSION_NOT_FOUND_ACTION_CONTINUE
;
1778 } else if (strcmp(no_session_act_str
, SESS_NOT_FOUND_ACTION_FAIL_STR
) == 0) {
1779 action
= SESSION_NOT_FOUND_ACTION_FAIL
;
1781 BT_ASSERT(strcmp(no_session_act_str
, SESS_NOT_FOUND_ACTION_END_STR
) == 0);
1782 action
= SESSION_NOT_FOUND_ACTION_END
;
1788 static struct bt_param_validation_value_descr inputs_elem_descr
= {
1789 .type
= BT_VALUE_TYPE_STRING
,
1792 static const char *sess_not_found_action_choices
[] = {
1793 SESS_NOT_FOUND_ACTION_CONTINUE_STR
,
1794 SESS_NOT_FOUND_ACTION_FAIL_STR
,
1795 SESS_NOT_FOUND_ACTION_END_STR
,
1798 static struct bt_param_validation_map_value_entry_descr params_descr
[] = {
1799 { INPUTS_PARAM
, BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_MANDATORY
, { BT_VALUE_TYPE_ARRAY
, .array
= {
1802 .element_type
= &inputs_elem_descr
,
1804 { SESS_NOT_FOUND_ACTION_PARAM
, BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL
, { BT_VALUE_TYPE_STRING
, .string
= {
1805 .choices
= sess_not_found_action_choices
,
1807 BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_END
1811 bt_component_class_initialize_method_status
lttng_live_component_create(
1812 const bt_value
*params
,
1813 bt_logging_level log_level
,
1814 bt_self_component
*self_comp
,
1815 struct lttng_live_component
**component
)
1817 struct lttng_live_component
*lttng_live
= NULL
;
1818 const bt_value
*inputs_value
;
1819 const bt_value
*url_value
;
1820 const bt_value
*value
;
1822 enum bt_param_validation_status validation_status
;
1823 gchar
*validation_error
= NULL
;
1824 bt_component_class_initialize_method_status status
;
1826 validation_status
= bt_param_validation_validate(params
, params_descr
,
1828 if (validation_status
== BT_PARAM_VALIDATION_STATUS_MEMORY_ERROR
) {
1829 status
= BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_MEMORY_ERROR
;
1831 } else if (validation_status
== BT_PARAM_VALIDATION_STATUS_VALIDATION_ERROR
) {
1832 BT_COMP_LOGE_APPEND_CAUSE(self_comp
, "%s", validation_error
);
1833 status
= BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_ERROR
;
1837 lttng_live
= g_new0(struct lttng_live_component
, 1);
1839 status
= BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_MEMORY_ERROR
;
1842 lttng_live
->log_level
= log_level
;
1843 lttng_live
->self_comp
= self_comp
;
1844 lttng_live
->max_query_size
= MAX_QUERY_SIZE
;
1845 lttng_live
->has_msg_iter
= false;
1848 bt_value_map_borrow_entry_value_const(params
, INPUTS_PARAM
);
1850 bt_value_array_borrow_element_by_index_const(inputs_value
, 0);
1851 url
= bt_value_string_get(url_value
);
1853 lttng_live
->params
.url
= g_string_new(url
);
1854 if (!lttng_live
->params
.url
) {
1855 status
= BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_MEMORY_ERROR
;
1859 value
= bt_value_map_borrow_entry_value_const(params
,
1860 SESS_NOT_FOUND_ACTION_PARAM
);
1862 lttng_live
->params
.sess_not_found_act
=
1863 parse_session_not_found_action_param(value
);
1865 BT_COMP_LOGI("Optional `%s` parameter is missing: "
1866 "defaulting to `%s`.",
1867 SESS_NOT_FOUND_ACTION_PARAM
,
1868 SESS_NOT_FOUND_ACTION_CONTINUE_STR
);
1869 lttng_live
->params
.sess_not_found_act
=
1870 SESSION_NOT_FOUND_ACTION_CONTINUE
;
1873 status
= BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_OK
;
1877 lttng_live_component_destroy_data(lttng_live
);
1880 g_free(validation_error
);
1882 *component
= lttng_live
;
1887 bt_component_class_initialize_method_status
lttng_live_component_init(
1888 bt_self_component_source
*self_comp_src
,
1889 bt_self_component_source_configuration
*config
,
1890 const bt_value
*params
,
1891 __attribute__((unused
)) void *init_method_data
)
1893 struct lttng_live_component
*lttng_live
;
1894 bt_component_class_initialize_method_status ret
;
1895 bt_self_component
*self_comp
=
1896 bt_self_component_source_as_self_component(self_comp_src
);
1897 bt_logging_level log_level
= bt_component_get_logging_level(
1898 bt_self_component_as_component(self_comp
));
1899 bt_self_component_add_port_status add_port_status
;
1901 ret
= lttng_live_component_create(params
, log_level
, self_comp
, <tng_live
);
1902 if (ret
!= BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_OK
) {
1906 add_port_status
= bt_self_component_source_add_output_port(
1907 self_comp_src
, "out", NULL
, NULL
);
1908 if (add_port_status
!= BT_SELF_COMPONENT_ADD_PORT_STATUS_OK
) {
1909 ret
= (int) add_port_status
;
1913 bt_self_component_set_data(self_comp
, lttng_live
);
1917 lttng_live_component_destroy_data(lttng_live
);