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
);
261 BT_COMP_LOGE_APPEND_CAUSE(self_comp
, "Error adding session");
269 void lttng_live_destroy_session(struct lttng_live_session
*session
)
271 bt_logging_level log_level
;
272 bt_self_component
*self_comp
;
278 log_level
= session
->log_level
;
279 self_comp
= session
->self_comp
;
280 BT_COMP_LOGD("Destroy lttng live session");
281 if (session
->id
!= -1ULL) {
282 if (lttng_live_detach_session(session
)) {
283 if (!lttng_live_graph_is_canceled(
284 session
->lttng_live_msg_iter
)) {
285 /* Old relayd cannot detach sessions. */
286 BT_COMP_LOGD("Unable to detach lttng live session %" PRIu64
,
293 if (session
->traces
) {
294 g_ptr_array_free(session
->traces
, TRUE
);
297 if (session
->hostname
) {
298 g_string_free(session
->hostname
, TRUE
);
300 if (session
->session_name
) {
301 g_string_free(session
->session_name
, TRUE
);
310 void lttng_live_msg_iter_destroy(struct lttng_live_msg_iter
*lttng_live_msg_iter
)
312 if (!lttng_live_msg_iter
) {
316 if (lttng_live_msg_iter
->sessions
) {
317 g_ptr_array_free(lttng_live_msg_iter
->sessions
, TRUE
);
320 if (lttng_live_msg_iter
->viewer_connection
) {
321 live_viewer_connection_destroy(lttng_live_msg_iter
->viewer_connection
);
323 BT_ASSERT(lttng_live_msg_iter
->lttng_live_comp
);
324 BT_ASSERT(lttng_live_msg_iter
->lttng_live_comp
->has_msg_iter
);
326 /* All stream iterators must be destroyed at this point. */
327 BT_ASSERT(lttng_live_msg_iter
->active_stream_iter
== 0);
328 lttng_live_msg_iter
->lttng_live_comp
->has_msg_iter
= false;
330 g_free(lttng_live_msg_iter
);
337 void lttng_live_msg_iter_finalize(bt_self_message_iterator
*self_msg_iter
)
339 struct lttng_live_msg_iter
*lttng_live_msg_iter
;
341 BT_ASSERT(self_msg_iter
);
343 lttng_live_msg_iter
= bt_self_message_iterator_get_data(self_msg_iter
);
344 BT_ASSERT(lttng_live_msg_iter
);
345 lttng_live_msg_iter_destroy(lttng_live_msg_iter
);
349 enum lttng_live_iterator_status
lttng_live_iterator_next_check_stream_state(
350 struct lttng_live_stream_iterator
*lttng_live_stream
)
352 bt_logging_level log_level
= lttng_live_stream
->log_level
;
353 bt_self_component
*self_comp
= lttng_live_stream
->self_comp
;
355 switch (lttng_live_stream
->state
) {
356 case LTTNG_LIVE_STREAM_QUIESCENT
:
357 case LTTNG_LIVE_STREAM_ACTIVE_DATA
:
359 case LTTNG_LIVE_STREAM_ACTIVE_NO_DATA
:
361 BT_COMP_LOGF("Unexpected stream state \"ACTIVE_NO_DATA\"");
363 case LTTNG_LIVE_STREAM_QUIESCENT_NO_DATA
:
365 BT_COMP_LOGF("Unexpected stream state \"QUIESCENT_NO_DATA\"");
367 case LTTNG_LIVE_STREAM_EOF
:
370 return LTTNG_LIVE_ITERATOR_STATUS_OK
;
374 * For active no data stream, fetch next data. It can be either:
375 * - quiescent: need to put it in the prio heap at quiescent end
377 * - have data: need to wire up first event into the prio heap,
378 * - have no data on this stream at this point: need to retry (AGAIN) or
382 enum lttng_live_iterator_status
lttng_live_iterator_next_handle_one_no_data_stream(
383 struct lttng_live_msg_iter
*lttng_live_msg_iter
,
384 struct lttng_live_stream_iterator
*lttng_live_stream
)
386 bt_logging_level log_level
= lttng_live_msg_iter
->log_level
;
387 bt_self_component
*self_comp
= lttng_live_msg_iter
->self_comp
;
388 enum lttng_live_iterator_status ret
= LTTNG_LIVE_ITERATOR_STATUS_OK
;
389 enum lttng_live_stream_state orig_state
= lttng_live_stream
->state
;
390 struct packet_index index
;
392 if (lttng_live_stream
->trace
->new_metadata_needed
) {
393 ret
= LTTNG_LIVE_ITERATOR_STATUS_CONTINUE
;
396 if (lttng_live_stream
->trace
->session
->new_streams_needed
) {
397 ret
= LTTNG_LIVE_ITERATOR_STATUS_CONTINUE
;
400 if (lttng_live_stream
->state
!= LTTNG_LIVE_STREAM_ACTIVE_NO_DATA
&&
401 lttng_live_stream
->state
!= LTTNG_LIVE_STREAM_QUIESCENT_NO_DATA
) {
404 ret
= lttng_live_get_next_index(lttng_live_msg_iter
, lttng_live_stream
,
406 if (ret
!= LTTNG_LIVE_ITERATOR_STATUS_OK
) {
409 BT_ASSERT_DBG(lttng_live_stream
->state
!= LTTNG_LIVE_STREAM_EOF
);
410 if (lttng_live_stream
->state
== LTTNG_LIVE_STREAM_QUIESCENT
) {
411 uint64_t last_inact_ts
= lttng_live_stream
->last_inactivity_ts
,
412 curr_inact_ts
= lttng_live_stream
->current_inactivity_ts
;
414 if (orig_state
== LTTNG_LIVE_STREAM_QUIESCENT_NO_DATA
&&
415 last_inact_ts
== curr_inact_ts
) {
416 ret
= LTTNG_LIVE_ITERATOR_STATUS_AGAIN
;
417 print_stream_state(lttng_live_stream
);
419 ret
= LTTNG_LIVE_ITERATOR_STATUS_CONTINUE
;
423 lttng_live_stream
->base_offset
= index
.offset
;
424 lttng_live_stream
->offset
= index
.offset
;
425 lttng_live_stream
->len
= index
.packet_size
/ CHAR_BIT
;
427 if (ret
== LTTNG_LIVE_ITERATOR_STATUS_OK
) {
428 ret
= lttng_live_iterator_next_check_stream_state(lttng_live_stream
);
434 * Creation of the message requires the ctf trace class to be created
435 * beforehand, but the live protocol gives us all streams (including metadata)
436 * at once. So we split it in three steps: getting streams, getting metadata
437 * (which creates the ctf trace class), and then creating the per-stream
441 enum lttng_live_iterator_status
lttng_live_get_session(
442 struct lttng_live_msg_iter
*lttng_live_msg_iter
,
443 struct lttng_live_session
*session
)
445 bt_logging_level log_level
= lttng_live_msg_iter
->log_level
;
446 bt_self_component
*self_comp
= lttng_live_msg_iter
->self_comp
;
447 enum lttng_live_iterator_status status
;
450 if (!session
->attached
) {
451 enum lttng_live_attach_session_status attach_status
=
452 lttng_live_attach_session(session
);
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 if (status
!= LTTNG_LIVE_ITERATOR_STATUS_OK
&&
474 status
!= LTTNG_LIVE_ITERATOR_STATUS_END
) {
478 while (trace_idx
< session
->traces
->len
) {
479 struct lttng_live_trace
*trace
=
480 g_ptr_array_index(session
->traces
, trace_idx
);
482 status
= lttng_live_metadata_update(trace
);
484 case LTTNG_LIVE_ITERATOR_STATUS_OK
:
487 case LTTNG_LIVE_ITERATOR_STATUS_END
:
489 * The trace has ended. Remove it of the array an
490 * continue the iteration.
491 * We can remove the trace safely when using the
492 * g_ptr_array_remove_index_fast because it replaces
493 * the element at trace_idx with the array's last
494 * element. trace_idx is not incremented because of
497 (void) g_ptr_array_remove_index_fast(session
->traces
,
504 status
= lttng_live_lazy_msg_init(session
);
511 void lttng_live_need_new_streams(struct lttng_live_msg_iter
*lttng_live_msg_iter
)
513 uint64_t session_idx
;
515 for (session_idx
= 0; session_idx
< lttng_live_msg_iter
->sessions
->len
;
517 struct lttng_live_session
*session
=
518 g_ptr_array_index(lttng_live_msg_iter
->sessions
, session_idx
);
519 session
->new_streams_needed
= true;
524 void lttng_live_force_new_streams_and_metadata(struct lttng_live_msg_iter
*lttng_live_msg_iter
)
526 uint64_t session_idx
, trace_idx
;
528 for (session_idx
= 0; session_idx
< lttng_live_msg_iter
->sessions
->len
;
530 struct lttng_live_session
*session
=
531 g_ptr_array_index(lttng_live_msg_iter
->sessions
, session_idx
);
532 session
->new_streams_needed
= true;
533 for (trace_idx
= 0; trace_idx
< session
->traces
->len
;
535 struct lttng_live_trace
*trace
=
536 g_ptr_array_index(session
->traces
, trace_idx
);
537 trace
->new_metadata_needed
= true;
543 enum lttng_live_iterator_status
544 lttng_live_iterator_handle_new_streams_and_metadata(
545 struct lttng_live_msg_iter
*lttng_live_msg_iter
)
547 enum lttng_live_iterator_status ret
= LTTNG_LIVE_ITERATOR_STATUS_OK
;
548 bt_logging_level log_level
= lttng_live_msg_iter
->log_level
;
549 bt_self_component
*self_comp
= lttng_live_msg_iter
->self_comp
;
550 uint64_t session_idx
= 0, nr_sessions_opened
= 0;
551 struct lttng_live_session
*session
;
552 enum session_not_found_action sess_not_found_act
=
553 lttng_live_msg_iter
->lttng_live_comp
->params
.sess_not_found_act
;
556 * In a remotely distant future, we could add a "new
557 * session" flag to the protocol, which would tell us that we
558 * need to query for new sessions even though we have sessions
561 if (lttng_live_msg_iter
->sessions
->len
== 0) {
562 if (sess_not_found_act
!= SESSION_NOT_FOUND_ACTION_CONTINUE
) {
563 ret
= LTTNG_LIVE_ITERATOR_STATUS_END
;
567 * Retry to create a viewer session for the requested
570 if (lttng_live_create_viewer_session(lttng_live_msg_iter
)) {
571 ret
= LTTNG_LIVE_ITERATOR_STATUS_ERROR
;
572 BT_COMP_LOGE_APPEND_CAUSE(self_comp
,
573 "Error creating LTTng live viewer session");
579 for (session_idx
= 0; session_idx
< lttng_live_msg_iter
->sessions
->len
;
581 session
= g_ptr_array_index(lttng_live_msg_iter
->sessions
,
583 ret
= lttng_live_get_session(lttng_live_msg_iter
, session
);
585 case LTTNG_LIVE_ITERATOR_STATUS_OK
:
587 case LTTNG_LIVE_ITERATOR_STATUS_END
:
588 ret
= LTTNG_LIVE_ITERATOR_STATUS_OK
;
593 if (!session
->closed
) {
594 nr_sessions_opened
++;
598 if (ret
== LTTNG_LIVE_ITERATOR_STATUS_OK
&&
599 sess_not_found_act
!= SESSION_NOT_FOUND_ACTION_CONTINUE
&&
600 nr_sessions_opened
== 0) {
601 ret
= LTTNG_LIVE_ITERATOR_STATUS_END
;
607 enum lttng_live_iterator_status
emit_inactivity_message(
608 struct lttng_live_msg_iter
*lttng_live_msg_iter
,
609 struct lttng_live_stream_iterator
*stream_iter
,
610 bt_message
**message
, uint64_t timestamp
)
612 enum lttng_live_iterator_status ret
= LTTNG_LIVE_ITERATOR_STATUS_OK
;
613 bt_logging_level log_level
= lttng_live_msg_iter
->log_level
;
614 bt_self_component
*self_comp
= lttng_live_msg_iter
->self_comp
;
615 bt_message
*msg
= NULL
;
617 BT_ASSERT(stream_iter
->trace
->clock_class
);
619 msg
= bt_message_message_iterator_inactivity_create(
620 lttng_live_msg_iter
->self_msg_iter
,
621 stream_iter
->trace
->clock_class
, timestamp
);
623 BT_COMP_LOGE_APPEND_CAUSE(self_comp
,
624 "Error emitting message iterator inactivity message");
633 ret
= LTTNG_LIVE_ITERATOR_STATUS_ERROR
;
634 bt_message_put_ref(msg
);
639 enum lttng_live_iterator_status
lttng_live_iterator_next_handle_one_quiescent_stream(
640 struct lttng_live_msg_iter
*lttng_live_msg_iter
,
641 struct lttng_live_stream_iterator
*lttng_live_stream
,
642 bt_message
**message
)
644 enum lttng_live_iterator_status ret
= LTTNG_LIVE_ITERATOR_STATUS_OK
;
646 if (lttng_live_stream
->state
!= LTTNG_LIVE_STREAM_QUIESCENT
) {
647 return LTTNG_LIVE_ITERATOR_STATUS_OK
;
650 if (lttng_live_stream
->current_inactivity_ts
==
651 lttng_live_stream
->last_inactivity_ts
) {
652 lttng_live_stream
->state
= LTTNG_LIVE_STREAM_QUIESCENT_NO_DATA
;
653 ret
= LTTNG_LIVE_ITERATOR_STATUS_CONTINUE
;
657 ret
= emit_inactivity_message(lttng_live_msg_iter
, lttng_live_stream
,
658 message
, lttng_live_stream
->current_inactivity_ts
);
660 lttng_live_stream
->last_inactivity_ts
=
661 lttng_live_stream
->current_inactivity_ts
;
667 int live_get_msg_ts_ns(struct lttng_live_stream_iterator
*stream_iter
,
668 struct lttng_live_msg_iter
*lttng_live_msg_iter
,
669 const bt_message
*msg
, int64_t last_msg_ts_ns
,
672 const bt_clock_class
*clock_class
= NULL
;
673 const bt_clock_snapshot
*clock_snapshot
= NULL
;
675 bt_logging_level log_level
= lttng_live_msg_iter
->log_level
;
676 bt_self_component
*self_comp
= lttng_live_msg_iter
->self_comp
;
679 BT_ASSERT_DBG(ts_ns
);
681 BT_COMP_LOGD("Getting message's timestamp: iter-data-addr=%p, msg-addr=%p, "
682 "last-msg-ts=%" PRId64
, lttng_live_msg_iter
, msg
,
685 switch (bt_message_get_type(msg
)) {
686 case BT_MESSAGE_TYPE_EVENT
:
687 clock_class
= bt_message_event_borrow_stream_class_default_clock_class_const(
689 BT_ASSERT_DBG(clock_class
);
691 clock_snapshot
= bt_message_event_borrow_default_clock_snapshot_const(
694 case BT_MESSAGE_TYPE_PACKET_BEGINNING
:
695 clock_class
= bt_message_packet_beginning_borrow_stream_class_default_clock_class_const(
697 BT_ASSERT(clock_class
);
699 clock_snapshot
= bt_message_packet_beginning_borrow_default_clock_snapshot_const(
702 case BT_MESSAGE_TYPE_PACKET_END
:
703 clock_class
= bt_message_packet_end_borrow_stream_class_default_clock_class_const(
705 BT_ASSERT(clock_class
);
707 clock_snapshot
= bt_message_packet_end_borrow_default_clock_snapshot_const(
710 case BT_MESSAGE_TYPE_DISCARDED_EVENTS
:
711 clock_class
= bt_message_discarded_events_borrow_stream_class_default_clock_class_const(
713 BT_ASSERT(clock_class
);
715 clock_snapshot
= bt_message_discarded_events_borrow_beginning_default_clock_snapshot_const(
718 case BT_MESSAGE_TYPE_DISCARDED_PACKETS
:
719 clock_class
= bt_message_discarded_packets_borrow_stream_class_default_clock_class_const(
721 BT_ASSERT(clock_class
);
723 clock_snapshot
= bt_message_discarded_packets_borrow_beginning_default_clock_snapshot_const(
726 case BT_MESSAGE_TYPE_MESSAGE_ITERATOR_INACTIVITY
:
727 clock_snapshot
= bt_message_message_iterator_inactivity_borrow_default_clock_snapshot_const(
731 /* All the other messages have a higher priority */
732 BT_COMP_LOGD_STR("Message has no timestamp: using the last message timestamp.");
733 *ts_ns
= last_msg_ts_ns
;
737 clock_class
= bt_clock_snapshot_borrow_clock_class_const(clock_snapshot
);
738 BT_ASSERT_DBG(clock_class
);
740 ret
= bt_clock_snapshot_get_ns_from_origin(clock_snapshot
, ts_ns
);
742 BT_COMP_LOGE_APPEND_CAUSE(self_comp
,
743 "Cannot get nanoseconds from Epoch of clock snapshot: "
744 "clock-snapshot-addr=%p", clock_snapshot
);
755 BT_COMP_LOGD("Found message's timestamp: "
756 "iter-data-addr=%p, msg-addr=%p, "
757 "last-msg-ts=%" PRId64
", ts=%" PRId64
,
758 lttng_live_msg_iter
, msg
, last_msg_ts_ns
, *ts_ns
);
765 enum lttng_live_iterator_status
lttng_live_iterator_next_handle_one_active_data_stream(
766 struct lttng_live_msg_iter
*lttng_live_msg_iter
,
767 struct lttng_live_stream_iterator
*lttng_live_stream
,
768 bt_message
**message
)
770 enum lttng_live_iterator_status ret
= LTTNG_LIVE_ITERATOR_STATUS_OK
;
771 bt_logging_level log_level
= lttng_live_msg_iter
->log_level
;
772 bt_self_component
*self_comp
= lttng_live_msg_iter
->self_comp
;
773 enum bt_msg_iter_status status
;
774 uint64_t session_idx
, trace_idx
;
776 for (session_idx
= 0; session_idx
< lttng_live_msg_iter
->sessions
->len
;
778 struct lttng_live_session
*session
=
779 g_ptr_array_index(lttng_live_msg_iter
->sessions
, session_idx
);
781 if (session
->new_streams_needed
) {
782 ret
= LTTNG_LIVE_ITERATOR_STATUS_CONTINUE
;
785 for (trace_idx
= 0; trace_idx
< session
->traces
->len
;
787 struct lttng_live_trace
*trace
=
788 g_ptr_array_index(session
->traces
, trace_idx
);
789 if (trace
->new_metadata_needed
) {
790 ret
= LTTNG_LIVE_ITERATOR_STATUS_CONTINUE
;
796 if (lttng_live_stream
->state
!= LTTNG_LIVE_STREAM_ACTIVE_DATA
) {
797 ret
= LTTNG_LIVE_ITERATOR_STATUS_ERROR
;
801 status
= bt_msg_iter_get_next_message(lttng_live_stream
->msg_iter
,
802 lttng_live_msg_iter
->self_msg_iter
, message
);
804 case BT_MSG_ITER_STATUS_EOF
:
805 ret
= LTTNG_LIVE_ITERATOR_STATUS_END
;
807 case BT_MSG_ITER_STATUS_OK
:
808 ret
= LTTNG_LIVE_ITERATOR_STATUS_OK
;
810 case BT_MSG_ITER_STATUS_AGAIN
:
812 * Continue immediately (end of packet). The next
813 * get_index may return AGAIN to delay the following
816 ret
= LTTNG_LIVE_ITERATOR_STATUS_CONTINUE
;
818 case BT_MSG_ITER_STATUS_INVAL
:
819 /* No argument provided by the user, so don't return INVAL. */
820 case BT_MSG_ITER_STATUS_ERROR
:
822 ret
= LTTNG_LIVE_ITERATOR_STATUS_ERROR
;
823 BT_COMP_LOGE_APPEND_CAUSE(self_comp
,
824 "CTF message iterator return an error or failed: "
825 "msg_iter=%p", lttng_live_stream
->msg_iter
);
834 enum lttng_live_iterator_status
lttng_live_iterator_close_stream(
835 struct lttng_live_msg_iter
*lttng_live_msg_iter
,
836 struct lttng_live_stream_iterator
*stream_iter
,
837 bt_message
**curr_msg
)
839 enum lttng_live_iterator_status live_status
=
840 LTTNG_LIVE_ITERATOR_STATUS_OK
;
841 bt_logging_level log_level
= lttng_live_msg_iter
->log_level
;
842 bt_self_component
*self_comp
= lttng_live_msg_iter
->self_comp
;
844 * The viewer has hung up on us so we are closing the stream. The
845 * `bt_msg_iter` should simply realize that it needs to close the
846 * stream properly by emitting the necessary stream end message.
848 enum bt_msg_iter_status status
= bt_msg_iter_get_next_message(
849 stream_iter
->msg_iter
, lttng_live_msg_iter
->self_msg_iter
,
852 if (status
== BT_MSG_ITER_STATUS_ERROR
) {
853 BT_COMP_LOGE_APPEND_CAUSE(self_comp
,
854 "Error getting the next message from CTF message iterator");
855 live_status
= LTTNG_LIVE_ITERATOR_STATUS_ERROR
;
859 BT_ASSERT(status
== BT_MSG_ITER_STATUS_OK
);
867 * handle_no_data_streams()
869 * - for each ACTIVE_NO_DATA stream:
870 * - query relayd for stream data, or quiescence info.
871 * - if need metadata, get metadata, goto retry.
872 * - if new stream, get new stream as ACTIVE_NO_DATA, goto retry
873 * - if quiescent, move to QUIESCENT streams
874 * - if fetched data, move to ACTIVE_DATA streams
875 * (at this point each stream either has data, or is quiescent)
879 * handle_new_streams_and_metadata()
880 * - query relayd for known streams, add them as ACTIVE_NO_DATA
881 * - query relayd for metadata
883 * call handle_active_no_data_streams()
885 * handle_quiescent_streams()
886 * - if at least one stream is ACTIVE_DATA:
887 * - peek stream event with lowest timestamp -> next_ts
888 * - for each quiescent stream
889 * - if next_ts >= quiescent end
890 * - set state to ACTIVE_NO_DATA
892 * - for each quiescent stream
893 * - set state to ACTIVE_NO_DATA
895 * call handle_active_no_data_streams()
897 * handle_active_data_streams()
898 * - if at least one stream is ACTIVE_DATA:
899 * - get stream event with lowest timestamp from heap
900 * - make that stream event the current message.
901 * - move this stream heap position to its next event
902 * - if we need to fetch data from relayd, move
903 * stream to ACTIVE_NO_DATA.
907 * end criterion: ctrl-c on client. If relayd exits or the session
908 * closes on the relay daemon side, we keep on waiting for streams.
909 * Eventually handle --end timestamp (also an end criterion).
911 * When disconnected from relayd: try to re-connect endlessly.
914 enum lttng_live_iterator_status
lttng_live_iterator_next_msg_on_stream(
915 struct lttng_live_msg_iter
*lttng_live_msg_iter
,
916 struct lttng_live_stream_iterator
*stream_iter
,
917 bt_message
**curr_msg
)
919 bt_logging_level log_level
= lttng_live_msg_iter
->log_level
;
920 bt_self_component
*self_comp
= lttng_live_msg_iter
->self_comp
;
921 enum lttng_live_iterator_status live_status
;
923 if (stream_iter
->has_stream_hung_up
) {
925 * The stream has hung up and the stream was properly closed
926 * during the last call to the current function. Return _END
927 * status now so that this stream iterator is removed for the
928 * stream iterator list.
930 live_status
= LTTNG_LIVE_ITERATOR_STATUS_END
;
935 print_stream_state(stream_iter
);
936 live_status
= lttng_live_iterator_handle_new_streams_and_metadata(
937 lttng_live_msg_iter
);
938 if (live_status
!= LTTNG_LIVE_ITERATOR_STATUS_OK
) {
941 live_status
= lttng_live_iterator_next_handle_one_no_data_stream(
942 lttng_live_msg_iter
, stream_iter
);
944 if (live_status
!= LTTNG_LIVE_ITERATOR_STATUS_OK
) {
945 if (live_status
== LTTNG_LIVE_ITERATOR_STATUS_END
) {
947 * We overwrite `live_status` since `curr_msg` is
948 * likely set to a valid message in this function.
950 live_status
= lttng_live_iterator_close_stream(
951 lttng_live_msg_iter
, stream_iter
, curr_msg
);
955 live_status
= lttng_live_iterator_next_handle_one_quiescent_stream(
956 lttng_live_msg_iter
, stream_iter
, curr_msg
);
957 if (live_status
!= LTTNG_LIVE_ITERATOR_STATUS_OK
) {
958 BT_ASSERT(!*curr_msg
);
964 live_status
= lttng_live_iterator_next_handle_one_active_data_stream(
965 lttng_live_msg_iter
, stream_iter
, curr_msg
);
966 if (live_status
!= LTTNG_LIVE_ITERATOR_STATUS_OK
) {
967 BT_ASSERT(!*curr_msg
);
971 if (live_status
== LTTNG_LIVE_ITERATOR_STATUS_CONTINUE
) {
979 enum lttng_live_iterator_status
next_stream_iterator_for_trace(
980 struct lttng_live_msg_iter
*lttng_live_msg_iter
,
981 struct lttng_live_trace
*live_trace
,
982 struct lttng_live_stream_iterator
**youngest_trace_stream_iter
)
984 struct lttng_live_stream_iterator
*youngest_candidate_stream_iter
= NULL
;
985 bt_logging_level log_level
= lttng_live_msg_iter
->log_level
;
986 bt_self_component
*self_comp
= lttng_live_msg_iter
->self_comp
;
987 enum lttng_live_iterator_status stream_iter_status
;;
988 int64_t youngest_candidate_msg_ts
= INT64_MAX
;
989 uint64_t stream_iter_idx
;
991 BT_ASSERT_DBG(live_trace
);
992 BT_ASSERT_DBG(live_trace
->stream_iterators
);
994 * Update the current message of every stream iterators of this trace.
995 * The current msg of every stream must have a timestamp equal or
996 * larger than the last message returned by this iterator. We must
997 * ensure monotonicity.
1000 while (stream_iter_idx
< live_trace
->stream_iterators
->len
) {
1001 bool stream_iter_is_ended
= false;
1002 struct lttng_live_stream_iterator
*stream_iter
=
1003 g_ptr_array_index(live_trace
->stream_iterators
,
1007 * Find if there is are now current message for this stream
1010 while (!stream_iter
->current_msg
) {
1011 bt_message
*msg
= NULL
;
1012 int64_t curr_msg_ts_ns
= INT64_MAX
;
1013 stream_iter_status
= lttng_live_iterator_next_msg_on_stream(
1014 lttng_live_msg_iter
, stream_iter
, &msg
);
1016 BT_COMP_LOGD("live stream iterator returned status :%s",
1017 print_live_iterator_status(stream_iter_status
));
1018 if (stream_iter_status
== LTTNG_LIVE_ITERATOR_STATUS_END
) {
1019 stream_iter_is_ended
= true;
1023 if (stream_iter_status
!= LTTNG_LIVE_ITERATOR_STATUS_OK
) {
1030 * Get the timestamp in nanoseconds from origin of this
1033 live_get_msg_ts_ns(stream_iter
, lttng_live_msg_iter
,
1034 msg
, lttng_live_msg_iter
->last_msg_ts_ns
,
1038 * Check if the message of the current live stream
1039 * iterator occured at the exact same time or after the
1040 * last message returned by this component's message
1041 * iterator. If not, we return an error.
1043 if (curr_msg_ts_ns
>= lttng_live_msg_iter
->last_msg_ts_ns
) {
1044 stream_iter
->current_msg
= msg
;
1045 stream_iter
->current_msg_ts_ns
= curr_msg_ts_ns
;
1048 * We received a message in the past. To ensure
1049 * monotonicity, we can't send it forward.
1051 BT_COMP_LOGE_APPEND_CAUSE(self_comp
,
1052 "Message's timestamp is less than "
1053 "lttng-live's message iterator's last "
1054 "returned timestamp: "
1055 "lttng-live-msg-iter-addr=%p, ts=%" PRId64
", "
1056 "last-msg-ts=%" PRId64
,
1057 lttng_live_msg_iter
, curr_msg_ts_ns
,
1058 lttng_live_msg_iter
->last_msg_ts_ns
);
1059 stream_iter_status
= LTTNG_LIVE_ITERATOR_STATUS_ERROR
;
1064 BT_ASSERT_DBG(stream_iter
!= youngest_candidate_stream_iter
);
1066 if (!stream_iter_is_ended
) {
1067 if (G_UNLIKELY(youngest_candidate_stream_iter
== NULL
) ||
1068 stream_iter
->current_msg_ts_ns
< youngest_candidate_msg_ts
) {
1070 * Update the current best candidate message
1071 * for the stream iterator of this live trace
1072 * to be forwarded downstream.
1074 youngest_candidate_msg_ts
= stream_iter
->current_msg_ts_ns
;
1075 youngest_candidate_stream_iter
= stream_iter
;
1076 } else if (stream_iter
->current_msg_ts_ns
== youngest_candidate_msg_ts
) {
1078 * Order the messages in an arbitrary but
1079 * deterministic way.
1081 BT_ASSERT_DBG(stream_iter
!= youngest_candidate_stream_iter
);
1082 int ret
= common_muxing_compare_messages(
1083 stream_iter
->current_msg
,
1084 youngest_candidate_stream_iter
->current_msg
);
1087 * The `youngest_candidate_stream_iter->current_msg`
1088 * should go first. Update the next
1089 * iterator and the current timestamp.
1091 youngest_candidate_msg_ts
= stream_iter
->current_msg_ts_ns
;
1092 youngest_candidate_stream_iter
= stream_iter
;
1093 } else if (ret
== 0) {
1095 * Unable to pick which one should go
1098 BT_COMP_LOGW("Cannot deterministically pick next live stream message iterator because they have identical next messages: "
1099 "stream-iter-addr=%p"
1100 "stream-iter-addr=%p",
1102 youngest_candidate_stream_iter
);
1109 * The live stream iterator has ended. That
1110 * iterator is removed from the array, but
1111 * there is no need to increment
1112 * stream_iter_idx as
1113 * g_ptr_array_remove_index_fast replaces the
1114 * removed element with the array's last
1117 g_ptr_array_remove_index_fast(
1118 live_trace
->stream_iterators
,
1123 if (youngest_candidate_stream_iter
) {
1124 *youngest_trace_stream_iter
= youngest_candidate_stream_iter
;
1125 stream_iter_status
= LTTNG_LIVE_ITERATOR_STATUS_OK
;
1128 * The only case where we don't have a candidate for this trace
1129 * is if we reached the end of all the iterators.
1131 BT_ASSERT(live_trace
->stream_iterators
->len
== 0);
1132 stream_iter_status
= LTTNG_LIVE_ITERATOR_STATUS_END
;
1136 return stream_iter_status
;
1140 enum lttng_live_iterator_status
next_stream_iterator_for_session(
1141 struct lttng_live_msg_iter
*lttng_live_msg_iter
,
1142 struct lttng_live_session
*session
,
1143 struct lttng_live_stream_iterator
**youngest_session_stream_iter
)
1145 bt_self_component
*self_comp
= lttng_live_msg_iter
->self_comp
;
1146 bt_logging_level log_level
= lttng_live_msg_iter
->log_level
;
1147 enum lttng_live_iterator_status stream_iter_status
;
1148 uint64_t trace_idx
= 0;
1149 int64_t youngest_candidate_msg_ts
= INT64_MAX
;
1150 struct lttng_live_stream_iterator
*youngest_candidate_stream_iter
= NULL
;
1153 * Make sure we are attached to the session and look for new streams
1156 stream_iter_status
= lttng_live_get_session(lttng_live_msg_iter
, session
);
1157 if (stream_iter_status
!= LTTNG_LIVE_ITERATOR_STATUS_OK
&&
1158 stream_iter_status
!= LTTNG_LIVE_ITERATOR_STATUS_CONTINUE
&&
1159 stream_iter_status
!= LTTNG_LIVE_ITERATOR_STATUS_END
) {
1163 BT_ASSERT_DBG(session
->traces
);
1165 while (trace_idx
< session
->traces
->len
) {
1166 bool trace_is_ended
= false;
1167 struct lttng_live_stream_iterator
*stream_iter
;
1168 struct lttng_live_trace
*trace
=
1169 g_ptr_array_index(session
->traces
, trace_idx
);
1171 stream_iter_status
= next_stream_iterator_for_trace(
1172 lttng_live_msg_iter
, trace
, &stream_iter
);
1173 if (stream_iter_status
== LTTNG_LIVE_ITERATOR_STATUS_END
) {
1175 * All the live stream iterators for this trace are
1176 * ENDed. Remove the trace from this session.
1178 trace_is_ended
= true;
1179 } else if (stream_iter_status
!= LTTNG_LIVE_ITERATOR_STATUS_OK
) {
1183 if (!trace_is_ended
) {
1184 BT_ASSERT_DBG(stream_iter
);
1186 if (G_UNLIKELY(youngest_candidate_stream_iter
== NULL
) ||
1187 stream_iter
->current_msg_ts_ns
< youngest_candidate_msg_ts
) {
1188 youngest_candidate_msg_ts
= stream_iter
->current_msg_ts_ns
;
1189 youngest_candidate_stream_iter
= stream_iter
;
1190 } else if (stream_iter
->current_msg_ts_ns
== youngest_candidate_msg_ts
) {
1192 * Order the messages in an arbitrary but
1193 * deterministic way.
1195 int ret
= common_muxing_compare_messages(
1196 stream_iter
->current_msg
,
1197 youngest_candidate_stream_iter
->current_msg
);
1200 * The `youngest_candidate_stream_iter->current_msg`
1201 * should go first. Update the next iterator
1202 * and the current timestamp.
1204 youngest_candidate_msg_ts
= stream_iter
->current_msg_ts_ns
;
1205 youngest_candidate_stream_iter
= stream_iter
;
1206 } else if (ret
== 0) {
1207 /* Unable to pick which one should go first. */
1208 BT_COMP_LOGW("Cannot deterministically pick next live stream message iterator because they have identical next messages: "
1209 "stream-iter-addr=%p" "stream-iter-addr=%p",
1210 stream_iter
, youngest_candidate_stream_iter
);
1216 * trace_idx is not incremented since
1217 * g_ptr_array_remove_index_fast replaces the
1218 * element at trace_idx with the array's last element.
1220 g_ptr_array_remove_index_fast(session
->traces
,
1224 if (youngest_candidate_stream_iter
) {
1225 *youngest_session_stream_iter
= youngest_candidate_stream_iter
;
1226 stream_iter_status
= LTTNG_LIVE_ITERATOR_STATUS_OK
;
1229 * The only cases where we don't have a candidate for this
1231 * 1. if we reached the end of all the iterators of all the
1232 * traces of this session,
1233 * 2. if we never had live stream iterator in the first place.
1235 * In either cases, we return END.
1237 BT_ASSERT(session
->traces
->len
== 0);
1238 stream_iter_status
= LTTNG_LIVE_ITERATOR_STATUS_END
;
1241 return stream_iter_status
;
1245 void put_messages(bt_message_array_const msgs
, uint64_t count
)
1249 for (i
= 0; i
< count
; i
++) {
1250 BT_MESSAGE_PUT_REF_AND_RESET(msgs
[i
]);
1255 bt_component_class_message_iterator_next_method_status
lttng_live_msg_iter_next(
1256 bt_self_message_iterator
*self_msg_it
,
1257 bt_message_array_const msgs
, uint64_t capacity
,
1260 bt_component_class_message_iterator_next_method_status status
;
1261 struct lttng_live_msg_iter
*lttng_live_msg_iter
=
1262 bt_self_message_iterator_get_data(self_msg_it
);
1263 struct lttng_live_component
*lttng_live
=
1264 lttng_live_msg_iter
->lttng_live_comp
;
1265 bt_self_component
*self_comp
= lttng_live_msg_iter
->self_comp
;
1266 bt_logging_level log_level
= lttng_live_msg_iter
->log_level
;
1267 enum lttng_live_iterator_status stream_iter_status
;
1268 uint64_t session_idx
;
1272 BT_ASSERT_DBG(lttng_live_msg_iter
);
1275 * Clear all the invalid message reference that might be left over in
1278 memset(msgs
, 0, capacity
* sizeof(*msgs
));
1281 * If no session are exposed on the relay found at the url provided by
1282 * the user, session count will be 0. In this case, we return status
1283 * end to return gracefully.
1285 if (lttng_live_msg_iter
->sessions
->len
== 0) {
1286 if (lttng_live
->params
.sess_not_found_act
!=
1287 SESSION_NOT_FOUND_ACTION_CONTINUE
) {
1288 status
= BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_END
;
1292 * The are no more active session for this session
1293 * name. Retry to create a viewer session for the
1294 * requested session name.
1296 if (lttng_live_create_viewer_session(lttng_live_msg_iter
)) {
1297 status
= BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_ERROR
;
1303 if (lttng_live_msg_iter
->active_stream_iter
== 0) {
1304 lttng_live_force_new_streams_and_metadata(lttng_live_msg_iter
);
1308 * Here the muxing of message is done.
1310 * We need to iterate over all the streams of all the traces of all the
1311 * viewer sessions in order to get the message with the smallest
1312 * timestamp. In this case, a session is a viewer session and there is
1313 * one viewer session per consumer daemon. (UST 32bit, UST 64bit and/or
1314 * kernel). Each viewer session can have multiple traces, for example,
1315 * 64bit UST viewer sessions could have multiple per-pid traces.
1317 * We iterate over the streams of each traces to update and see what is
1318 * their next message's timestamp. From those timestamps, we select the
1319 * message with the smallest timestamp as the best candidate message
1320 * for that trace and do the same thing across all the sessions.
1322 * We then compare the timestamp of best candidate message of all the
1323 * sessions to pick the message with the smallest timestamp and we
1326 while (*count
< capacity
) {
1327 struct lttng_live_stream_iterator
*youngest_stream_iter
= NULL
,
1328 *candidate_stream_iter
= NULL
;
1329 int64_t youngest_msg_ts_ns
= INT64_MAX
;
1331 BT_ASSERT_DBG(lttng_live_msg_iter
->sessions
);
1333 while (session_idx
< lttng_live_msg_iter
->sessions
->len
) {
1334 struct lttng_live_session
*session
=
1335 g_ptr_array_index(lttng_live_msg_iter
->sessions
,
1338 /* Find the best candidate message to send downstream. */
1339 stream_iter_status
= next_stream_iterator_for_session(
1340 lttng_live_msg_iter
, session
,
1341 &candidate_stream_iter
);
1343 /* If we receive an END status, it means that either:
1344 * - Those traces never had active streams (UST with no
1345 * data produced yet),
1346 * - All live stream iterators have ENDed.*/
1347 if (stream_iter_status
== LTTNG_LIVE_ITERATOR_STATUS_END
) {
1348 if (session
->closed
&& session
->traces
->len
== 0) {
1350 * Remove the session from the list.
1351 * session_idx is not modified since
1352 * g_ptr_array_remove_index_fast
1353 * replaces the the removed element with
1354 * the array's last element.
1356 g_ptr_array_remove_index_fast(
1357 lttng_live_msg_iter
->sessions
,
1365 if (stream_iter_status
!= LTTNG_LIVE_ITERATOR_STATUS_OK
) {
1369 if (G_UNLIKELY(youngest_stream_iter
== NULL
) ||
1370 candidate_stream_iter
->current_msg_ts_ns
< youngest_msg_ts_ns
) {
1371 youngest_msg_ts_ns
= candidate_stream_iter
->current_msg_ts_ns
;
1372 youngest_stream_iter
= candidate_stream_iter
;
1373 } else if (candidate_stream_iter
->current_msg_ts_ns
== youngest_msg_ts_ns
) {
1375 * The currently selected message to be sent
1376 * downstream next has the exact same timestamp
1377 * that of the current candidate message. We
1378 * must break the tie in a predictable manner.
1380 BT_COMP_LOGD_STR("Two of the next message candidates have the same timestamps, pick one deterministically.");
1382 * Order the messages in an arbitrary but
1383 * deterministic way.
1385 int ret
= common_muxing_compare_messages(
1386 candidate_stream_iter
->current_msg
,
1387 youngest_stream_iter
->current_msg
);
1390 * The `candidate_stream_iter->current_msg`
1391 * should go first. Update the next
1392 * iterator and the current timestamp.
1394 youngest_msg_ts_ns
= candidate_stream_iter
->current_msg_ts_ns
;
1395 youngest_stream_iter
= candidate_stream_iter
;
1396 } else if (ret
== 0) {
1397 /* Unable to pick which one should go first. */
1398 BT_COMP_LOGW("Cannot deterministically pick next live stream message iterator because they have identical next messages: "
1399 "next-stream-iter-addr=%p" "candidate-stream-iter-addr=%p",
1400 youngest_stream_iter
, candidate_stream_iter
);
1407 if (!youngest_stream_iter
) {
1408 stream_iter_status
= LTTNG_LIVE_ITERATOR_STATUS_AGAIN
;
1412 BT_ASSERT_DBG(youngest_stream_iter
->current_msg
);
1413 /* Ensure monotonicity. */
1414 BT_ASSERT_DBG(lttng_live_msg_iter
->last_msg_ts_ns
<=
1415 youngest_stream_iter
->current_msg_ts_ns
);
1418 * Insert the next message to the message batch. This will set
1419 * stream iterator current messsage to NULL so that next time
1420 * we fetch the next message of that stream iterator
1422 BT_MESSAGE_MOVE_REF(msgs
[*count
], youngest_stream_iter
->current_msg
);
1425 /* Update the last timestamp in nanoseconds sent downstream. */
1426 lttng_live_msg_iter
->last_msg_ts_ns
= youngest_msg_ts_ns
;
1427 youngest_stream_iter
->current_msg_ts_ns
= INT64_MAX
;
1429 stream_iter_status
= LTTNG_LIVE_ITERATOR_STATUS_OK
;
1432 switch (stream_iter_status
) {
1433 case LTTNG_LIVE_ITERATOR_STATUS_OK
:
1434 case LTTNG_LIVE_ITERATOR_STATUS_AGAIN
:
1437 * We received a again status but we have some messages
1438 * to send downstream. We send them and return OK for
1439 * now. On the next call we return again if there are
1440 * still no new message to send.
1442 status
= BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK
;
1444 status
= BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_AGAIN
;
1447 case LTTNG_LIVE_ITERATOR_STATUS_END
:
1448 status
= BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_END
;
1450 case LTTNG_LIVE_ITERATOR_STATUS_NOMEM
:
1451 status
= BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_MEMORY_ERROR
;
1453 case LTTNG_LIVE_ITERATOR_STATUS_ERROR
:
1454 case LTTNG_LIVE_ITERATOR_STATUS_INVAL
:
1455 case LTTNG_LIVE_ITERATOR_STATUS_UNSUPPORTED
:
1456 status
= BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_ERROR
;
1457 /* Put all existing messages on error. */
1458 put_messages(msgs
, *count
);
1469 bt_component_class_message_iterator_initialize_method_status
lttng_live_msg_iter_init(
1470 bt_self_message_iterator
*self_msg_it
,
1471 bt_self_message_iterator_configuration
*config
,
1472 bt_self_component_source
*self_comp_src
,
1473 bt_self_component_port_output
*self_port
)
1475 bt_component_class_message_iterator_initialize_method_status ret
=
1476 BT_COMPONENT_CLASS_MESSAGE_ITERATOR_INITIALIZE_METHOD_STATUS_OK
;
1477 bt_self_component
*self_comp
=
1478 bt_self_component_source_as_self_component(self_comp_src
);
1479 struct lttng_live_component
*lttng_live
;
1480 struct lttng_live_msg_iter
*lttng_live_msg_iter
;
1481 bt_logging_level log_level
;
1483 BT_ASSERT(self_msg_it
);
1485 lttng_live
= bt_self_component_get_data(self_comp
);
1486 log_level
= lttng_live
->log_level
;
1487 self_comp
= lttng_live
->self_comp
;
1489 /* There can be only one downstream iterator at the same time. */
1490 BT_ASSERT(!lttng_live
->has_msg_iter
);
1491 lttng_live
->has_msg_iter
= true;
1493 lttng_live_msg_iter
= g_new0(struct lttng_live_msg_iter
, 1);
1494 if (!lttng_live_msg_iter
) {
1495 ret
= BT_COMPONENT_CLASS_MESSAGE_ITERATOR_INITIALIZE_METHOD_STATUS_ERROR
;
1499 lttng_live_msg_iter
->log_level
= lttng_live
->log_level
;
1500 lttng_live_msg_iter
->self_comp
= lttng_live
->self_comp
;
1501 lttng_live_msg_iter
->lttng_live_comp
= lttng_live
;
1502 lttng_live_msg_iter
->self_msg_iter
= self_msg_it
;
1504 lttng_live_msg_iter
->active_stream_iter
= 0;
1505 lttng_live_msg_iter
->last_msg_ts_ns
= INT64_MIN
;
1506 lttng_live_msg_iter
->sessions
= g_ptr_array_new_with_free_func(
1507 (GDestroyNotify
) lttng_live_destroy_session
);
1508 BT_ASSERT(lttng_live_msg_iter
->sessions
);
1510 lttng_live_msg_iter
->viewer_connection
=
1511 live_viewer_connection_create(lttng_live
->params
.url
->str
, false,
1512 lttng_live_msg_iter
, self_comp
, NULL
, log_level
);
1513 if (!lttng_live_msg_iter
->viewer_connection
) {
1517 if (lttng_live_create_viewer_session(lttng_live_msg_iter
)) {
1520 if (lttng_live_msg_iter
->sessions
->len
== 0) {
1521 switch (lttng_live
->params
.sess_not_found_act
) {
1522 case SESSION_NOT_FOUND_ACTION_CONTINUE
:
1523 BT_COMP_LOGI("Unable to connect to the requested live viewer "
1524 "session. Keep trying to connect because of "
1525 "%s=\"%s\" component parameter: url=\"%s\"",
1526 SESS_NOT_FOUND_ACTION_PARAM
,
1527 SESS_NOT_FOUND_ACTION_CONTINUE_STR
,
1528 lttng_live
->params
.url
->str
);
1530 case SESSION_NOT_FOUND_ACTION_FAIL
:
1531 BT_COMP_LOGE_APPEND_CAUSE(self_comp
, "Unable to connect to the requested live viewer "
1532 "session. Fail the message iterator"
1533 "initialization because of %s=\"%s\" "
1534 "component parameter: url =\"%s\"",
1535 SESS_NOT_FOUND_ACTION_PARAM
,
1536 SESS_NOT_FOUND_ACTION_FAIL_STR
,
1537 lttng_live
->params
.url
->str
);
1539 case SESSION_NOT_FOUND_ACTION_END
:
1540 BT_COMP_LOGI("Unable to connect to the requested live viewer "
1541 "session. End gracefully at the first _next() "
1542 "call because of %s=\"%s\" component parameter: "
1543 "url=\"%s\"", SESS_NOT_FOUND_ACTION_PARAM
,
1544 SESS_NOT_FOUND_ACTION_END_STR
,
1545 lttng_live
->params
.url
->str
);
1552 bt_self_message_iterator_set_data(self_msg_it
, lttng_live_msg_iter
);
1556 ret
= BT_COMPONENT_CLASS_MESSAGE_ITERATOR_INITIALIZE_METHOD_STATUS_ERROR
;
1557 lttng_live_msg_iter_destroy(lttng_live_msg_iter
);
1562 static struct bt_param_validation_map_value_entry_descr list_sessions_params
[] = {
1563 { URL_PARAM
, BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_MANDATORY
, { .type
= BT_VALUE_TYPE_STRING
} },
1564 BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_END
1568 bt_component_class_query_method_status
lttng_live_query_list_sessions(
1569 const bt_value
*params
, const bt_value
**result
,
1570 bt_self_component_class
*self_comp_class
,
1571 bt_logging_level log_level
)
1573 bt_component_class_query_method_status status
;
1574 const bt_value
*url_value
= NULL
;
1576 struct live_viewer_connection
*viewer_connection
= NULL
;
1577 enum bt_param_validation_status validation_status
;
1578 gchar
*validate_error
= NULL
;
1580 validation_status
= bt_param_validation_validate(params
,
1581 list_sessions_params
, &validate_error
);
1582 if (validation_status
== BT_PARAM_VALIDATION_STATUS_MEMORY_ERROR
) {
1583 status
= BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_MEMORY_ERROR
;
1585 } else if (validation_status
== BT_PARAM_VALIDATION_STATUS_VALIDATION_ERROR
) {
1586 status
= BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_ERROR
;
1587 BT_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp_class
, "%s",
1592 url_value
= bt_value_map_borrow_entry_value_const(params
, URL_PARAM
);
1593 url
= bt_value_string_get(url_value
);
1595 viewer_connection
= live_viewer_connection_create(url
, true, NULL
,
1596 NULL
, self_comp_class
, log_level
);
1597 if (!viewer_connection
) {
1598 BT_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp_class
,
1599 "Failed to create viewer connection");
1600 status
= BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_ERROR
;
1604 status
= live_viewer_connection_list_sessions(viewer_connection
,
1606 if (status
!= BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_OK
) {
1607 BT_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp_class
,
1608 "Failed to list viewer sessions");
1615 BT_VALUE_PUT_REF_AND_RESET(*result
);
1618 status
= BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_ERROR
;
1622 if (viewer_connection
) {
1623 live_viewer_connection_destroy(viewer_connection
);
1626 g_free(validate_error
);
1632 bt_component_class_query_method_status
lttng_live_query_support_info(
1633 const bt_value
*params
, const bt_value
**result
,
1634 bt_self_component_class
*self_comp_class
,
1635 bt_logging_level log_level
)
1637 bt_component_class_query_method_status status
=
1638 BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_OK
;
1639 const bt_value
*input_type_value
;
1640 const bt_value
*input_value
;
1642 struct bt_common_lttng_live_url_parts parts
= { 0 };
1644 /* Used by the logging macros */
1645 __attribute__((unused
)) bt_self_component
*self_comp
= NULL
;
1648 input_type_value
= bt_value_map_borrow_entry_value_const(params
,
1650 if (!input_type_value
) {
1651 BT_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp_class
,
1652 "Missing expected `type` parameter.");
1656 if (!bt_value_is_string(input_type_value
)) {
1657 BT_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp_class
,
1658 "`type` parameter is not a string value.");
1662 if (strcmp(bt_value_string_get(input_type_value
), "string") != 0) {
1663 /* We don't handle file system paths */
1667 input_value
= bt_value_map_borrow_entry_value_const(params
, "input");
1669 BT_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp_class
,
1670 "Missing expected `input` parameter.");
1674 if (!bt_value_is_string(input_value
)) {
1675 BT_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp_class
,
1676 "`input` parameter is not a string value.");
1680 parts
= bt_common_parse_lttng_live_url(bt_value_string_get(input_value
),
1682 if (parts
.session_name
) {
1684 * Looks pretty much like an LTTng live URL: we got the
1685 * session name part, which forms a complete URL.
1691 *result
= bt_value_real_create_init(weight
);
1693 status
= BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_MEMORY_ERROR
;
1701 status
= BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_ERROR
;
1704 BT_ASSERT(!*result
);
1707 bt_common_destroy_lttng_live_url_parts(&parts
);
1712 bt_component_class_query_method_status
lttng_live_query(
1713 bt_self_component_class_source
*comp_class
,
1714 bt_private_query_executor
*priv_query_exec
,
1715 const char *object
, const bt_value
*params
,
1716 __attribute__((unused
)) void *method_data
,
1717 const bt_value
**result
)
1719 bt_component_class_query_method_status status
=
1720 BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_OK
;
1721 bt_self_component
*self_comp
= NULL
;
1722 bt_self_component_class
*self_comp_class
=
1723 bt_self_component_class_source_as_self_component_class(comp_class
);
1724 bt_logging_level log_level
= bt_query_executor_get_logging_level(
1725 bt_private_query_executor_as_query_executor_const(
1728 if (strcmp(object
, "sessions") == 0) {
1729 status
= lttng_live_query_list_sessions(params
, result
,
1730 self_comp_class
, log_level
);
1731 } else if (strcmp(object
, "babeltrace.support-info") == 0) {
1732 status
= lttng_live_query_support_info(params
, result
,
1733 self_comp_class
, log_level
);
1735 BT_COMP_LOGI("Unknown query object `%s`", object
);
1736 status
= BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_UNKNOWN_OBJECT
;
1745 void lttng_live_component_destroy_data(struct lttng_live_component
*lttng_live
)
1750 if (lttng_live
->params
.url
) {
1751 g_string_free(lttng_live
->params
.url
, TRUE
);
1757 void lttng_live_component_finalize(bt_self_component_source
*component
)
1759 void *data
= bt_self_component_get_data(
1760 bt_self_component_source_as_self_component(component
));
1765 lttng_live_component_destroy_data(data
);
1769 enum session_not_found_action
parse_session_not_found_action_param(
1770 const bt_value
*no_session_param
)
1772 enum session_not_found_action action
;
1773 const char *no_session_act_str
= bt_value_string_get(no_session_param
);
1775 if (strcmp(no_session_act_str
, SESS_NOT_FOUND_ACTION_CONTINUE_STR
) == 0) {
1776 action
= SESSION_NOT_FOUND_ACTION_CONTINUE
;
1777 } else if (strcmp(no_session_act_str
, SESS_NOT_FOUND_ACTION_FAIL_STR
) == 0) {
1778 action
= SESSION_NOT_FOUND_ACTION_FAIL
;
1780 BT_ASSERT(strcmp(no_session_act_str
, SESS_NOT_FOUND_ACTION_END_STR
) == 0);
1781 action
= SESSION_NOT_FOUND_ACTION_END
;
1787 static struct bt_param_validation_value_descr inputs_elem_descr
= {
1788 .type
= BT_VALUE_TYPE_STRING
,
1791 static const char *sess_not_found_action_choices
[] = {
1792 SESS_NOT_FOUND_ACTION_CONTINUE_STR
,
1793 SESS_NOT_FOUND_ACTION_FAIL_STR
,
1794 SESS_NOT_FOUND_ACTION_END_STR
,
1797 static struct bt_param_validation_map_value_entry_descr params_descr
[] = {
1798 { INPUTS_PARAM
, BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_MANDATORY
, { BT_VALUE_TYPE_ARRAY
, .array
= {
1801 .element_type
= &inputs_elem_descr
,
1803 { SESS_NOT_FOUND_ACTION_PARAM
, BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL
, { BT_VALUE_TYPE_STRING
, .string
= {
1804 .choices
= sess_not_found_action_choices
,
1806 BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_END
1810 bt_component_class_initialize_method_status
lttng_live_component_create(
1811 const bt_value
*params
,
1812 bt_logging_level log_level
,
1813 bt_self_component
*self_comp
,
1814 struct lttng_live_component
**component
)
1816 struct lttng_live_component
*lttng_live
= NULL
;
1817 const bt_value
*inputs_value
;
1818 const bt_value
*url_value
;
1819 const bt_value
*value
;
1821 enum bt_param_validation_status validation_status
;
1822 gchar
*validation_error
= NULL
;
1823 bt_component_class_initialize_method_status status
;
1825 validation_status
= bt_param_validation_validate(params
, params_descr
,
1827 if (validation_status
== BT_PARAM_VALIDATION_STATUS_MEMORY_ERROR
) {
1828 status
= BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_MEMORY_ERROR
;
1830 } else if (validation_status
== BT_PARAM_VALIDATION_STATUS_VALIDATION_ERROR
) {
1831 BT_COMP_LOGE_APPEND_CAUSE(self_comp
, "%s", validation_error
);
1832 status
= BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_ERROR
;
1836 lttng_live
= g_new0(struct lttng_live_component
, 1);
1838 status
= BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_MEMORY_ERROR
;
1841 lttng_live
->log_level
= log_level
;
1842 lttng_live
->self_comp
= self_comp
;
1843 lttng_live
->max_query_size
= MAX_QUERY_SIZE
;
1844 lttng_live
->has_msg_iter
= false;
1847 bt_value_map_borrow_entry_value_const(params
, INPUTS_PARAM
);
1849 bt_value_array_borrow_element_by_index_const(inputs_value
, 0);
1850 url
= bt_value_string_get(url_value
);
1852 lttng_live
->params
.url
= g_string_new(url
);
1853 if (!lttng_live
->params
.url
) {
1854 status
= BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_MEMORY_ERROR
;
1858 value
= bt_value_map_borrow_entry_value_const(params
,
1859 SESS_NOT_FOUND_ACTION_PARAM
);
1861 lttng_live
->params
.sess_not_found_act
=
1862 parse_session_not_found_action_param(value
);
1864 BT_COMP_LOGI("Optional `%s` parameter is missing: "
1865 "defaulting to `%s`.",
1866 SESS_NOT_FOUND_ACTION_PARAM
,
1867 SESS_NOT_FOUND_ACTION_CONTINUE_STR
);
1868 lttng_live
->params
.sess_not_found_act
=
1869 SESSION_NOT_FOUND_ACTION_CONTINUE
;
1872 status
= BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_OK
;
1876 lttng_live_component_destroy_data(lttng_live
);
1879 g_free(validation_error
);
1881 *component
= lttng_live
;
1886 bt_component_class_initialize_method_status
lttng_live_component_init(
1887 bt_self_component_source
*self_comp_src
,
1888 bt_self_component_source_configuration
*config
,
1889 const bt_value
*params
,
1890 __attribute__((unused
)) void *init_method_data
)
1892 struct lttng_live_component
*lttng_live
;
1893 bt_component_class_initialize_method_status ret
;
1894 bt_self_component
*self_comp
=
1895 bt_self_component_source_as_self_component(self_comp_src
);
1896 bt_logging_level log_level
= bt_component_get_logging_level(
1897 bt_self_component_as_component(self_comp
));
1898 bt_self_component_add_port_status add_port_status
;
1900 ret
= lttng_live_component_create(params
, log_level
, self_comp
, <tng_live
);
1901 if (ret
!= BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_OK
) {
1905 add_port_status
= bt_self_component_source_add_output_port(
1906 self_comp_src
, "out", NULL
, NULL
);
1907 if (add_port_status
!= BT_SELF_COMPONENT_ADD_PORT_STATUS_OK
) {
1908 ret
= (int) add_port_status
;
1912 bt_self_component_set_data(self_comp
, lttng_live
);
1916 lttng_live_component_destroy_data(lttng_live
);