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"
40 #include "common/assert.h"
41 #include <babeltrace2/babeltrace.h>
42 #include "compat/compiler.h"
43 #include <babeltrace2/types.h>
45 #include "plugins/common/muxing/muxing.h"
47 #include "data-stream.h"
49 #include "lttng-live.h"
51 #define MAX_QUERY_SIZE (256*1024)
52 #define URL_PARAM "url"
53 #define SESS_NOT_FOUND_ACTION_PARAM "session-not-found-action"
54 #define SESS_NOT_FOUND_ACTION_CONTINUE_STR "continue"
55 #define SESS_NOT_FOUND_ACTION_FAIL_STR "fail"
56 #define SESS_NOT_FOUND_ACTION_END_STR "end"
58 #define print_dbg(fmt, ...) BT_COMP_LOGD(fmt, ## __VA_ARGS__)
61 const char *print_live_iterator_status(enum lttng_live_iterator_status status
)
64 case LTTNG_LIVE_ITERATOR_STATUS_CONTINUE
:
65 return "LTTNG_LIVE_ITERATOR_STATUS_CONTINUE";
66 case LTTNG_LIVE_ITERATOR_STATUS_AGAIN
:
67 return "LTTNG_LIVE_ITERATOR_STATUS_AGAIN";
68 case LTTNG_LIVE_ITERATOR_STATUS_END
:
69 return "LTTNG_LIVE_ITERATOR_STATUS_END";
70 case LTTNG_LIVE_ITERATOR_STATUS_OK
:
71 return "LTTNG_LIVE_ITERATOR_STATUS_OK";
72 case LTTNG_LIVE_ITERATOR_STATUS_INVAL
:
73 return "LTTNG_LIVE_ITERATOR_STATUS_INVAL";
74 case LTTNG_LIVE_ITERATOR_STATUS_ERROR
:
75 return "LTTNG_LIVE_ITERATOR_STATUS_ERROR";
76 case LTTNG_LIVE_ITERATOR_STATUS_NOMEM
:
77 return "LTTNG_LIVE_ITERATOR_STATUS_NOMEM";
78 case LTTNG_LIVE_ITERATOR_STATUS_UNSUPPORTED
:
79 return "LTTNG_LIVE_ITERATOR_STATUS_UNSUPPORTED";
86 const char *print_state(struct lttng_live_stream_iterator
*s
)
89 case LTTNG_LIVE_STREAM_ACTIVE_NO_DATA
:
90 return "ACTIVE_NO_DATA";
91 case LTTNG_LIVE_STREAM_QUIESCENT_NO_DATA
:
92 return "QUIESCENT_NO_DATA";
93 case LTTNG_LIVE_STREAM_QUIESCENT
:
95 case LTTNG_LIVE_STREAM_ACTIVE_DATA
:
97 case LTTNG_LIVE_STREAM_EOF
:
104 #define print_stream_state(live_stream_iter) \
106 BT_COMP_LOGD("stream state %s last_inact_ts %" PRId64 \
107 ", curr_inact_ts %" PRId64, \
108 print_state(live_stream_iter), \
109 live_stream_iter->last_inactivity_ts, \
110 live_stream_iter->current_inactivity_ts); \
114 bool lttng_live_graph_is_canceled(struct lttng_live_msg_iter
*msg_iter
)
123 ret
= bt_self_message_iterator_is_interrupted(
124 msg_iter
->self_msg_iter
);
131 struct lttng_live_trace
*lttng_live_find_trace(struct lttng_live_session
*session
,
135 struct lttng_live_trace
*ret_trace
= NULL
;
137 for (trace_idx
= 0; trace_idx
< session
->traces
->len
; trace_idx
++) {
138 struct lttng_live_trace
*trace
=
139 g_ptr_array_index(session
->traces
, trace_idx
);
140 if (trace
->id
== trace_id
) {
151 void lttng_live_destroy_trace(struct lttng_live_trace
*trace
)
153 bt_logging_level log_level
= trace
->log_level
;
154 bt_self_component
*self_comp
= trace
->self_comp
;
156 BT_COMP_LOGD("Destroy lttng_live_trace");
158 BT_ASSERT(trace
->stream_iterators
);
159 g_ptr_array_free(trace
->stream_iterators
, TRUE
);
161 BT_TRACE_PUT_REF_AND_RESET(trace
->trace
);
162 BT_TRACE_CLASS_PUT_REF_AND_RESET(trace
->trace_class
);
164 lttng_live_metadata_fini(trace
);
169 struct lttng_live_trace
*lttng_live_create_trace(struct lttng_live_session
*session
,
172 struct lttng_live_trace
*trace
= NULL
;
173 bt_logging_level log_level
= session
->log_level
;
174 bt_self_component
*self_comp
= session
->self_comp
;
176 trace
= g_new0(struct lttng_live_trace
, 1);
180 trace
->log_level
= session
->log_level
;
181 trace
->self_comp
= session
->self_comp
;
182 trace
->session
= session
;
183 trace
->id
= trace_id
;
184 trace
->trace_class
= NULL
;
186 trace
->stream_iterators
= g_ptr_array_new_with_free_func(
187 (GDestroyNotify
) lttng_live_stream_iterator_destroy
);
188 BT_ASSERT(trace
->stream_iterators
);
189 trace
->new_metadata_needed
= true;
190 g_ptr_array_add(session
->traces
, trace
);
192 BT_COMP_LOGI("Create trace");
202 struct lttng_live_trace
*lttng_live_borrow_trace(
203 struct lttng_live_session
*session
, uint64_t trace_id
)
205 struct lttng_live_trace
*trace
;
207 trace
= lttng_live_find_trace(session
, trace_id
);
212 /* The session is the owner of the newly created trace. */
213 trace
= lttng_live_create_trace(session
, trace_id
);
220 int lttng_live_add_session(struct lttng_live_msg_iter
*lttng_live_msg_iter
,
221 uint64_t session_id
, const char *hostname
,
222 const char *session_name
)
225 struct lttng_live_session
*session
;
226 bt_logging_level log_level
= lttng_live_msg_iter
->log_level
;
227 bt_self_component
*self_comp
= lttng_live_msg_iter
->self_comp
;
229 session
= g_new0(struct lttng_live_session
, 1);
234 session
->log_level
= lttng_live_msg_iter
->log_level
;
235 session
->self_comp
= lttng_live_msg_iter
->self_comp
;
236 session
->id
= session_id
;
237 session
->traces
= g_ptr_array_new_with_free_func(
238 (GDestroyNotify
) lttng_live_destroy_trace
);
239 BT_ASSERT(session
->traces
);
240 session
->lttng_live_msg_iter
= lttng_live_msg_iter
;
241 session
->new_streams_needed
= true;
242 session
->hostname
= g_string_new(hostname
);
243 BT_ASSERT(session
->hostname
);
245 session
->session_name
= g_string_new(session_name
);
246 BT_ASSERT(session
->session_name
);
248 BT_COMP_LOGI("Reading from session: %" PRIu64
" hostname: %s session_name: %s",
249 session
->id
, hostname
, session_name
);
250 g_ptr_array_add(lttng_live_msg_iter
->sessions
, session
);
253 BT_COMP_LOGE("Error adding session");
261 void lttng_live_destroy_session(struct lttng_live_session
*session
)
263 bt_logging_level log_level
;
264 bt_self_component
*self_comp
;
270 log_level
= session
->log_level
;
271 self_comp
= session
->self_comp
;
272 BT_COMP_LOGD("Destroy lttng live session");
273 if (session
->id
!= -1ULL) {
274 if (lttng_live_detach_session(session
)) {
275 if (session
->lttng_live_msg_iter
&&
276 !lttng_live_graph_is_canceled(
277 session
->lttng_live_msg_iter
)) {
278 /* Old relayd cannot detach sessions. */
279 BT_COMP_LOGD("Unable to detach lttng live session %" PRIu64
,
286 if (session
->traces
) {
287 g_ptr_array_free(session
->traces
, TRUE
);
290 if (session
->hostname
) {
291 g_string_free(session
->hostname
, TRUE
);
293 if (session
->session_name
) {
294 g_string_free(session
->session_name
, TRUE
);
303 void lttng_live_msg_iter_destroy(struct lttng_live_msg_iter
*lttng_live_msg_iter
)
305 if (!lttng_live_msg_iter
) {
309 if (lttng_live_msg_iter
->sessions
) {
310 g_ptr_array_free(lttng_live_msg_iter
->sessions
, TRUE
);
313 BT_OBJECT_PUT_REF_AND_RESET(lttng_live_msg_iter
->viewer_connection
);
314 BT_ASSERT(lttng_live_msg_iter
->lttng_live_comp
);
315 BT_ASSERT(lttng_live_msg_iter
->lttng_live_comp
->has_msg_iter
);
317 /* All stream iterators must be destroyed at this point. */
318 BT_ASSERT(lttng_live_msg_iter
->active_stream_iter
== 0);
319 lttng_live_msg_iter
->lttng_live_comp
->has_msg_iter
= false;
321 g_free(lttng_live_msg_iter
);
328 void lttng_live_msg_iter_finalize(bt_self_message_iterator
*self_msg_iter
)
330 struct lttng_live_msg_iter
*lttng_live_msg_iter
;
332 BT_ASSERT(self_msg_iter
);
334 lttng_live_msg_iter
= bt_self_message_iterator_get_data(self_msg_iter
);
335 BT_ASSERT(lttng_live_msg_iter
);
336 lttng_live_msg_iter_destroy(lttng_live_msg_iter
);
340 enum lttng_live_iterator_status
lttng_live_iterator_next_check_stream_state(
341 struct lttng_live_stream_iterator
*lttng_live_stream
)
343 bt_logging_level log_level
= lttng_live_stream
->log_level
;
344 bt_self_component
*self_comp
= lttng_live_stream
->self_comp
;
346 switch (lttng_live_stream
->state
) {
347 case LTTNG_LIVE_STREAM_QUIESCENT
:
348 case LTTNG_LIVE_STREAM_ACTIVE_DATA
:
350 case LTTNG_LIVE_STREAM_ACTIVE_NO_DATA
:
352 BT_COMP_LOGF("Unexpected stream state \"ACTIVE_NO_DATA\"");
354 case LTTNG_LIVE_STREAM_QUIESCENT_NO_DATA
:
356 BT_COMP_LOGF("Unexpected stream state \"QUIESCENT_NO_DATA\"");
358 case LTTNG_LIVE_STREAM_EOF
:
361 return LTTNG_LIVE_ITERATOR_STATUS_OK
;
365 * For active no data stream, fetch next data. It can be either:
366 * - quiescent: need to put it in the prio heap at quiescent end
368 * - have data: need to wire up first event into the prio heap,
369 * - have no data on this stream at this point: need to retry (AGAIN) or
373 enum lttng_live_iterator_status
lttng_live_iterator_next_handle_one_no_data_stream(
374 struct lttng_live_msg_iter
*lttng_live_msg_iter
,
375 struct lttng_live_stream_iterator
*lttng_live_stream
)
377 bt_logging_level log_level
= lttng_live_msg_iter
->log_level
;
378 bt_self_component
*self_comp
= lttng_live_msg_iter
->self_comp
;
379 enum lttng_live_iterator_status ret
=
380 LTTNG_LIVE_ITERATOR_STATUS_OK
;
381 struct packet_index index
;
382 enum lttng_live_stream_state orig_state
= lttng_live_stream
->state
;
384 if (lttng_live_stream
->trace
->new_metadata_needed
) {
385 ret
= LTTNG_LIVE_ITERATOR_STATUS_CONTINUE
;
388 if (lttng_live_stream
->trace
->session
->new_streams_needed
) {
389 ret
= LTTNG_LIVE_ITERATOR_STATUS_CONTINUE
;
392 if (lttng_live_stream
->state
!= LTTNG_LIVE_STREAM_ACTIVE_NO_DATA
&&
393 lttng_live_stream
->state
!= LTTNG_LIVE_STREAM_QUIESCENT_NO_DATA
) {
396 ret
= lttng_live_get_next_index(lttng_live_msg_iter
, lttng_live_stream
,
398 if (ret
!= LTTNG_LIVE_ITERATOR_STATUS_OK
) {
401 BT_ASSERT(lttng_live_stream
->state
!= LTTNG_LIVE_STREAM_EOF
);
402 if (lttng_live_stream
->state
== LTTNG_LIVE_STREAM_QUIESCENT
) {
403 uint64_t last_inact_ts
= lttng_live_stream
->last_inactivity_ts
,
404 curr_inact_ts
= lttng_live_stream
->current_inactivity_ts
;
406 if (orig_state
== LTTNG_LIVE_STREAM_QUIESCENT_NO_DATA
&&
407 last_inact_ts
== curr_inact_ts
) {
408 ret
= LTTNG_LIVE_ITERATOR_STATUS_AGAIN
;
409 print_stream_state(lttng_live_stream
);
411 ret
= LTTNG_LIVE_ITERATOR_STATUS_CONTINUE
;
415 lttng_live_stream
->base_offset
= index
.offset
;
416 lttng_live_stream
->offset
= index
.offset
;
417 lttng_live_stream
->len
= index
.packet_size
/ CHAR_BIT
;
419 if (ret
== LTTNG_LIVE_ITERATOR_STATUS_OK
) {
420 ret
= lttng_live_iterator_next_check_stream_state(lttng_live_stream
);
426 * Creation of the message requires the ctf trace class to be created
427 * beforehand, but the live protocol gives us all streams (including metadata)
428 * at once. So we split it in three steps: getting streams, getting metadata
429 * (which creates the ctf trace class), and then creating the per-stream
433 enum lttng_live_iterator_status
lttng_live_get_session(
434 struct lttng_live_msg_iter
*lttng_live_msg_iter
,
435 struct lttng_live_session
*session
)
437 enum lttng_live_iterator_status status
;
441 if (!session
->attached
) {
442 ret
= lttng_live_attach_session(session
);
444 if (lttng_live_msg_iter
&& lttng_live_graph_is_canceled(
445 lttng_live_msg_iter
)) {
446 status
= LTTNG_LIVE_ITERATOR_STATUS_AGAIN
;
448 status
= LTTNG_LIVE_ITERATOR_STATUS_ERROR
;
454 status
= lttng_live_get_new_streams(session
);
455 if (status
!= LTTNG_LIVE_ITERATOR_STATUS_OK
&&
456 status
!= LTTNG_LIVE_ITERATOR_STATUS_END
) {
459 for (trace_idx
= 0; trace_idx
< session
->traces
->len
; trace_idx
++) {
460 struct lttng_live_trace
*trace
=
461 g_ptr_array_index(session
->traces
, trace_idx
);
463 status
= lttng_live_metadata_update(trace
);
464 if (status
!= LTTNG_LIVE_ITERATOR_STATUS_OK
&&
465 status
!= LTTNG_LIVE_ITERATOR_STATUS_END
) {
469 status
= lttng_live_lazy_msg_init(session
);
476 void lttng_live_need_new_streams(struct lttng_live_msg_iter
*lttng_live_msg_iter
)
478 uint64_t session_idx
;
480 for (session_idx
= 0; session_idx
< lttng_live_msg_iter
->sessions
->len
;
482 struct lttng_live_session
*session
=
483 g_ptr_array_index(lttng_live_msg_iter
->sessions
, session_idx
);
484 session
->new_streams_needed
= true;
489 void lttng_live_force_new_streams_and_metadata(struct lttng_live_msg_iter
*lttng_live_msg_iter
)
491 uint64_t session_idx
, trace_idx
;
493 for (session_idx
= 0; session_idx
< lttng_live_msg_iter
->sessions
->len
;
495 struct lttng_live_session
*session
=
496 g_ptr_array_index(lttng_live_msg_iter
->sessions
, session_idx
);
497 session
->new_streams_needed
= true;
498 for (trace_idx
= 0; trace_idx
< session
->traces
->len
;
500 struct lttng_live_trace
*trace
=
501 g_ptr_array_index(session
->traces
, trace_idx
);
502 trace
->new_metadata_needed
= true;
508 enum lttng_live_iterator_status
509 lttng_live_iterator_handle_new_streams_and_metadata(
510 struct lttng_live_msg_iter
*lttng_live_msg_iter
)
512 enum lttng_live_iterator_status ret
=
513 LTTNG_LIVE_ITERATOR_STATUS_OK
;
514 uint64_t session_idx
= 0, nr_sessions_opened
= 0;
515 struct lttng_live_session
*session
;
516 enum session_not_found_action sess_not_found_act
=
517 lttng_live_msg_iter
->lttng_live_comp
->params
.sess_not_found_act
;
520 * In a remotely distant future, we could add a "new
521 * session" flag to the protocol, which would tell us that we
522 * need to query for new sessions even though we have sessions
525 if (lttng_live_msg_iter
->sessions
->len
== 0) {
526 if (sess_not_found_act
!= SESSION_NOT_FOUND_ACTION_CONTINUE
) {
527 ret
= LTTNG_LIVE_ITERATOR_STATUS_END
;
531 * Retry to create a viewer session for the requested
534 if (lttng_live_create_viewer_session(lttng_live_msg_iter
)) {
535 ret
= LTTNG_LIVE_ITERATOR_STATUS_ERROR
;
541 for (session_idx
= 0; session_idx
< lttng_live_msg_iter
->sessions
->len
;
543 session
= g_ptr_array_index(lttng_live_msg_iter
->sessions
,
545 ret
= lttng_live_get_session(lttng_live_msg_iter
, session
);
547 case LTTNG_LIVE_ITERATOR_STATUS_OK
:
549 case LTTNG_LIVE_ITERATOR_STATUS_END
:
550 ret
= LTTNG_LIVE_ITERATOR_STATUS_OK
;
555 if (!session
->closed
) {
556 nr_sessions_opened
++;
560 if (ret
== LTTNG_LIVE_ITERATOR_STATUS_OK
&&
561 sess_not_found_act
!= SESSION_NOT_FOUND_ACTION_CONTINUE
&&
562 nr_sessions_opened
== 0) {
563 ret
= LTTNG_LIVE_ITERATOR_STATUS_END
;
569 enum lttng_live_iterator_status
emit_inactivity_message(
570 struct lttng_live_msg_iter
*lttng_live_msg_iter
,
571 struct lttng_live_stream_iterator
*stream_iter
,
572 bt_message
**message
, uint64_t timestamp
)
574 enum lttng_live_iterator_status ret
=
575 LTTNG_LIVE_ITERATOR_STATUS_OK
;
576 bt_message
*msg
= NULL
;
578 BT_ASSERT(stream_iter
->trace
->clock_class
);
580 msg
= bt_message_message_iterator_inactivity_create(
581 lttng_live_msg_iter
->self_msg_iter
,
582 stream_iter
->trace
->clock_class
,
593 ret
= LTTNG_LIVE_ITERATOR_STATUS_ERROR
;
594 bt_message_put_ref(msg
);
599 enum lttng_live_iterator_status
lttng_live_iterator_next_handle_one_quiescent_stream(
600 struct lttng_live_msg_iter
*lttng_live_msg_iter
,
601 struct lttng_live_stream_iterator
*lttng_live_stream
,
602 bt_message
**message
)
604 enum lttng_live_iterator_status ret
=
605 LTTNG_LIVE_ITERATOR_STATUS_OK
;
607 if (lttng_live_stream
->state
!= LTTNG_LIVE_STREAM_QUIESCENT
) {
608 return LTTNG_LIVE_ITERATOR_STATUS_OK
;
611 if (lttng_live_stream
->current_inactivity_ts
==
612 lttng_live_stream
->last_inactivity_ts
) {
613 lttng_live_stream
->state
= LTTNG_LIVE_STREAM_QUIESCENT_NO_DATA
;
614 ret
= LTTNG_LIVE_ITERATOR_STATUS_CONTINUE
;
618 ret
= emit_inactivity_message(lttng_live_msg_iter
, lttng_live_stream
,
619 message
, lttng_live_stream
->current_inactivity_ts
);
621 lttng_live_stream
->last_inactivity_ts
=
622 lttng_live_stream
->current_inactivity_ts
;
628 int live_get_msg_ts_ns(struct lttng_live_stream_iterator
*stream_iter
,
629 struct lttng_live_msg_iter
*lttng_live_msg_iter
,
630 const bt_message
*msg
, int64_t last_msg_ts_ns
,
633 const bt_clock_class
*clock_class
= NULL
;
634 const bt_clock_snapshot
*clock_snapshot
= NULL
;
636 bt_logging_level log_level
= lttng_live_msg_iter
->log_level
;
637 bt_self_component
*self_comp
= lttng_live_msg_iter
->self_comp
;
642 BT_COMP_LOGD("Getting message's timestamp: iter-data-addr=%p, msg-addr=%p, "
643 "last-msg-ts=%" PRId64
, lttng_live_msg_iter
, msg
,
646 switch (bt_message_get_type(msg
)) {
647 case BT_MESSAGE_TYPE_EVENT
:
649 bt_message_event_borrow_stream_class_default_clock_class_const(
651 BT_ASSERT(clock_class
);
653 clock_snapshot
= bt_message_event_borrow_default_clock_snapshot_const(
656 case BT_MESSAGE_TYPE_PACKET_BEGINNING
:
658 bt_message_packet_beginning_borrow_stream_class_default_clock_class_const(
660 BT_ASSERT(clock_class
);
662 clock_snapshot
= bt_message_packet_beginning_borrow_default_clock_snapshot_const(
665 case BT_MESSAGE_TYPE_PACKET_END
:
667 bt_message_packet_end_borrow_stream_class_default_clock_class_const(
669 BT_ASSERT(clock_class
);
671 clock_snapshot
= bt_message_packet_end_borrow_default_clock_snapshot_const(
674 case BT_MESSAGE_TYPE_DISCARDED_EVENTS
:
676 bt_message_discarded_events_borrow_stream_class_default_clock_class_const(
678 BT_ASSERT(clock_class
);
680 clock_snapshot
= bt_message_discarded_events_borrow_beginning_default_clock_snapshot_const(
683 case BT_MESSAGE_TYPE_DISCARDED_PACKETS
:
685 bt_message_discarded_packets_borrow_stream_class_default_clock_class_const(
687 BT_ASSERT(clock_class
);
689 clock_snapshot
= bt_message_discarded_packets_borrow_beginning_default_clock_snapshot_const(
692 case BT_MESSAGE_TYPE_MESSAGE_ITERATOR_INACTIVITY
:
694 bt_message_message_iterator_inactivity_borrow_default_clock_snapshot_const(
698 /* All the other messages have a higher priority */
699 BT_COMP_LOGD_STR("Message has no timestamp: using the last message timestamp.");
700 *ts_ns
= last_msg_ts_ns
;
704 clock_class
= bt_clock_snapshot_borrow_clock_class_const(clock_snapshot
);
705 BT_ASSERT(clock_class
);
707 ret
= bt_clock_snapshot_get_ns_from_origin(clock_snapshot
, ts_ns
);
709 BT_COMP_LOGE("Cannot get nanoseconds from Epoch of clock snapshot: "
710 "clock-snapshot-addr=%p", clock_snapshot
);
721 BT_COMP_LOGD("Found message's timestamp: "
722 "iter-data-addr=%p, msg-addr=%p, "
723 "last-msg-ts=%" PRId64
", ts=%" PRId64
,
724 lttng_live_msg_iter
, msg
, last_msg_ts_ns
, *ts_ns
);
731 enum lttng_live_iterator_status
lttng_live_iterator_next_handle_one_active_data_stream(
732 struct lttng_live_msg_iter
*lttng_live_msg_iter
,
733 struct lttng_live_stream_iterator
*lttng_live_stream
,
734 bt_message
**message
)
736 enum lttng_live_iterator_status ret
= LTTNG_LIVE_ITERATOR_STATUS_OK
;
737 enum bt_msg_iter_status status
;
738 uint64_t session_idx
, trace_idx
;
739 bt_logging_level log_level
= lttng_live_msg_iter
->log_level
;
740 bt_self_component
*self_comp
= lttng_live_msg_iter
->self_comp
;
742 for (session_idx
= 0; session_idx
< lttng_live_msg_iter
->sessions
->len
;
744 struct lttng_live_session
*session
=
745 g_ptr_array_index(lttng_live_msg_iter
->sessions
, session_idx
);
747 if (session
->new_streams_needed
) {
748 ret
= LTTNG_LIVE_ITERATOR_STATUS_CONTINUE
;
751 for (trace_idx
= 0; trace_idx
< session
->traces
->len
;
753 struct lttng_live_trace
*trace
=
754 g_ptr_array_index(session
->traces
, trace_idx
);
755 if (trace
->new_metadata_needed
) {
756 ret
= LTTNG_LIVE_ITERATOR_STATUS_CONTINUE
;
762 if (lttng_live_stream
->state
!= LTTNG_LIVE_STREAM_ACTIVE_DATA
) {
763 ret
= LTTNG_LIVE_ITERATOR_STATUS_ERROR
;
767 status
= bt_msg_iter_get_next_message(lttng_live_stream
->msg_iter
,
768 lttng_live_msg_iter
->self_msg_iter
, message
);
770 case BT_MSG_ITER_STATUS_EOF
:
771 ret
= LTTNG_LIVE_ITERATOR_STATUS_END
;
773 case BT_MSG_ITER_STATUS_OK
:
774 ret
= LTTNG_LIVE_ITERATOR_STATUS_OK
;
776 case BT_MSG_ITER_STATUS_AGAIN
:
778 * Continue immediately (end of packet). The next
779 * get_index may return AGAIN to delay the following
782 ret
= LTTNG_LIVE_ITERATOR_STATUS_CONTINUE
;
784 case BT_MSG_ITER_STATUS_INVAL
:
785 /* No argument provided by the user, so don't return INVAL. */
786 case BT_MSG_ITER_STATUS_ERROR
:
788 ret
= LTTNG_LIVE_ITERATOR_STATUS_ERROR
;
789 BT_COMP_LOGW("CTF msg iterator return an error or failed msg_iter=%p",
790 lttng_live_stream
->msg_iter
);
799 enum lttng_live_iterator_status
lttng_live_iterator_close_stream(
800 struct lttng_live_msg_iter
*lttng_live_msg_iter
,
801 struct lttng_live_stream_iterator
*stream_iter
,
802 bt_message
**curr_msg
)
804 enum lttng_live_iterator_status live_status
=
805 LTTNG_LIVE_ITERATOR_STATUS_OK
;
807 * The viewer has hung up on us so we are closing the stream. The
808 * `bt_msg_iter` should simply realize that it needs to close the
809 * stream properly by emitting the necessary stream end message.
811 enum bt_msg_iter_status status
=
812 bt_msg_iter_get_next_message(stream_iter
->msg_iter
,
813 lttng_live_msg_iter
->self_msg_iter
, curr_msg
);
815 if (status
== BT_MSG_ITER_STATUS_ERROR
) {
816 live_status
= LTTNG_LIVE_ITERATOR_STATUS_ERROR
;
820 BT_ASSERT(status
== BT_MSG_ITER_STATUS_OK
);
828 * handle_no_data_streams()
830 * - for each ACTIVE_NO_DATA stream:
831 * - query relayd for stream data, or quiescence info.
832 * - if need metadata, get metadata, goto retry.
833 * - if new stream, get new stream as ACTIVE_NO_DATA, goto retry
834 * - if quiescent, move to QUIESCENT streams
835 * - if fetched data, move to ACTIVE_DATA streams
836 * (at this point each stream either has data, or is quiescent)
840 * handle_new_streams_and_metadata()
841 * - query relayd for known streams, add them as ACTIVE_NO_DATA
842 * - query relayd for metadata
844 * call handle_active_no_data_streams()
846 * handle_quiescent_streams()
847 * - if at least one stream is ACTIVE_DATA:
848 * - peek stream event with lowest timestamp -> next_ts
849 * - for each quiescent stream
850 * - if next_ts >= quiescent end
851 * - set state to ACTIVE_NO_DATA
853 * - for each quiescent stream
854 * - set state to ACTIVE_NO_DATA
856 * call handle_active_no_data_streams()
858 * handle_active_data_streams()
859 * - if at least one stream is ACTIVE_DATA:
860 * - get stream event with lowest timestamp from heap
861 * - make that stream event the current message.
862 * - move this stream heap position to its next event
863 * - if we need to fetch data from relayd, move
864 * stream to ACTIVE_NO_DATA.
868 * end criterion: ctrl-c on client. If relayd exits or the session
869 * closes on the relay daemon side, we keep on waiting for streams.
870 * Eventually handle --end timestamp (also an end criterion).
872 * When disconnected from relayd: try to re-connect endlessly.
875 enum lttng_live_iterator_status
lttng_live_iterator_next_on_stream(
876 struct lttng_live_msg_iter
*lttng_live_msg_iter
,
877 struct lttng_live_stream_iterator
*stream_iter
,
878 bt_message
**curr_msg
)
880 bt_logging_level log_level
= lttng_live_msg_iter
->log_level
;
881 bt_self_component
*self_comp
= lttng_live_msg_iter
->self_comp
;
882 enum lttng_live_iterator_status live_status
;
884 if (stream_iter
->has_stream_hung_up
) {
886 * The stream has hung up and the stream was properly closed
887 * during the last call to the current function. Return _END
888 * status now so that this stream iterator is removed for the
889 * stream iterator list.
891 live_status
= LTTNG_LIVE_ITERATOR_STATUS_END
;
896 print_stream_state(stream_iter
);
897 live_status
= lttng_live_iterator_handle_new_streams_and_metadata(
898 lttng_live_msg_iter
);
899 if (live_status
!= LTTNG_LIVE_ITERATOR_STATUS_OK
) {
902 live_status
= lttng_live_iterator_next_handle_one_no_data_stream(
903 lttng_live_msg_iter
, stream_iter
);
905 if (live_status
!= LTTNG_LIVE_ITERATOR_STATUS_OK
) {
906 if (live_status
== LTTNG_LIVE_ITERATOR_STATUS_END
) {
908 * We overwrite `live_status` since `curr_msg` is
909 * likely set to a valid message in this function.
911 live_status
= lttng_live_iterator_close_stream(
912 lttng_live_msg_iter
, stream_iter
, curr_msg
);
916 live_status
= lttng_live_iterator_next_handle_one_quiescent_stream(
917 lttng_live_msg_iter
, stream_iter
, curr_msg
);
918 if (live_status
!= LTTNG_LIVE_ITERATOR_STATUS_OK
) {
919 BT_ASSERT(!*curr_msg
);
925 live_status
= lttng_live_iterator_next_handle_one_active_data_stream(
926 lttng_live_msg_iter
, stream_iter
, curr_msg
);
927 if (live_status
!= LTTNG_LIVE_ITERATOR_STATUS_OK
) {
928 BT_ASSERT(!*curr_msg
);
932 if (live_status
== LTTNG_LIVE_ITERATOR_STATUS_CONTINUE
) {
940 enum lttng_live_iterator_status
next_stream_iterator_for_trace(
941 struct lttng_live_msg_iter
*lttng_live_msg_iter
,
942 struct lttng_live_trace
*live_trace
,
943 struct lttng_live_stream_iterator
**candidate_stream_iter
)
945 struct lttng_live_stream_iterator
*curr_candidate_stream_iter
= NULL
;
946 enum lttng_live_iterator_status stream_iter_status
;;
947 int64_t curr_candidate_msg_ts
= INT64_MAX
;
948 uint64_t stream_iter_idx
;
949 bt_logging_level log_level
= lttng_live_msg_iter
->log_level
;
950 bt_self_component
*self_comp
= lttng_live_msg_iter
->self_comp
;
952 BT_ASSERT(live_trace
);
953 BT_ASSERT(live_trace
->stream_iterators
);
955 * Update the current message of every stream iterators of this trace.
956 * The current msg of every stream must have a timestamp equal or
957 * larger than the last message returned by this iterator. We must
958 * ensure monotonicity.
961 while (stream_iter_idx
< live_trace
->stream_iterators
->len
) {
962 bool stream_iter_is_ended
= false;
963 struct lttng_live_stream_iterator
*stream_iter
=
964 g_ptr_array_index(live_trace
->stream_iterators
,
968 * Find if there is are now current message for this stream
971 while (!stream_iter
->current_msg
) {
972 bt_message
*msg
= NULL
;
973 int64_t curr_msg_ts_ns
= INT64_MAX
;
974 stream_iter_status
= lttng_live_iterator_next_on_stream(
975 lttng_live_msg_iter
, stream_iter
, &msg
);
977 BT_COMP_LOGD("live stream iterator returned status :%s",
978 print_live_iterator_status(stream_iter_status
));
979 if (stream_iter_status
== LTTNG_LIVE_ITERATOR_STATUS_END
) {
980 stream_iter_is_ended
= true;
984 if (stream_iter_status
!= LTTNG_LIVE_ITERATOR_STATUS_OK
) {
991 * Get the timestamp in nanoseconds from origin of this
994 live_get_msg_ts_ns(stream_iter
, lttng_live_msg_iter
,
995 msg
, lttng_live_msg_iter
->last_msg_ts_ns
,
999 * Check if the message of the current live stream
1000 * iterator occured at the exact same time or after the
1001 * last message returned by this component's message
1002 * iterator. If not, we return an error.
1004 if (curr_msg_ts_ns
>= lttng_live_msg_iter
->last_msg_ts_ns
) {
1005 stream_iter
->current_msg
= msg
;
1006 stream_iter
->current_msg_ts_ns
= curr_msg_ts_ns
;
1009 * We received a message in the past. To ensure
1010 * monotonicity, we can't send it forward.
1012 BT_COMP_LOGE("Message's timestamp is less than "
1013 "lttng-live's message iterator's last "
1014 "returned timestamp: "
1015 "lttng-live-msg-iter-addr=%p, ts=%" PRId64
", "
1016 "last-msg-ts=%" PRId64
,
1017 lttng_live_msg_iter
, curr_msg_ts_ns
,
1018 lttng_live_msg_iter
->last_msg_ts_ns
);
1019 stream_iter_status
= LTTNG_LIVE_ITERATOR_STATUS_ERROR
;
1024 if (!stream_iter_is_ended
&&
1025 stream_iter
->current_msg_ts_ns
<= curr_candidate_msg_ts
) {
1027 * Update the current best candidate message for the
1028 * stream iterator of thise live trace to be forwarded
1031 curr_candidate_msg_ts
= stream_iter
->current_msg_ts_ns
;
1032 curr_candidate_stream_iter
= stream_iter
;
1035 if (stream_iter_is_ended
) {
1037 * The live stream iterator is ENDed. We remove that
1038 * iterator from the list and we restart the iteration
1039 * at the beginning of the live stream iterator array
1040 * to because the removal will shuffle the array.
1042 g_ptr_array_remove_index_fast(live_trace
->stream_iterators
,
1044 stream_iter_idx
= 0;
1050 if (curr_candidate_stream_iter
) {
1051 *candidate_stream_iter
= curr_candidate_stream_iter
;
1052 stream_iter_status
= LTTNG_LIVE_ITERATOR_STATUS_OK
;
1055 * The only case where we don't have a candidate for this trace
1056 * is if we reached the end of all the iterators.
1058 BT_ASSERT(live_trace
->stream_iterators
->len
== 0);
1059 stream_iter_status
= LTTNG_LIVE_ITERATOR_STATUS_END
;
1063 return stream_iter_status
;
1067 enum lttng_live_iterator_status
next_stream_iterator_for_session(
1068 struct lttng_live_msg_iter
*lttng_live_msg_iter
,
1069 struct lttng_live_session
*session
,
1070 struct lttng_live_stream_iterator
**candidate_session_stream_iter
)
1072 enum lttng_live_iterator_status stream_iter_status
;
1073 uint64_t trace_idx
= 0;
1074 int64_t curr_candidate_msg_ts
= INT64_MAX
;
1075 struct lttng_live_stream_iterator
*curr_candidate_stream_iter
= NULL
;
1078 * Make sure we are attached to the session and look for new streams
1081 stream_iter_status
= lttng_live_get_session(lttng_live_msg_iter
, session
);
1082 if (stream_iter_status
!= LTTNG_LIVE_ITERATOR_STATUS_OK
&&
1083 stream_iter_status
!= LTTNG_LIVE_ITERATOR_STATUS_CONTINUE
&&
1084 stream_iter_status
!= LTTNG_LIVE_ITERATOR_STATUS_END
) {
1088 BT_ASSERT(session
->traces
);
1091 * Use while loops here rather then for loops so we can restart the
1092 * iteration if an element is removed from the array during the
1095 while (trace_idx
< session
->traces
->len
) {
1096 bool trace_is_ended
= false;
1097 struct lttng_live_stream_iterator
*stream_iter
;
1098 struct lttng_live_trace
*trace
=
1099 g_ptr_array_index(session
->traces
, trace_idx
);
1101 stream_iter_status
= next_stream_iterator_for_trace(
1102 lttng_live_msg_iter
, trace
, &stream_iter
);
1103 if (stream_iter_status
== LTTNG_LIVE_ITERATOR_STATUS_END
) {
1105 * All the live stream iterators for this trace are
1106 * ENDed. Remove the trace from this session.
1108 trace_is_ended
= true;
1109 } else if (stream_iter_status
!= LTTNG_LIVE_ITERATOR_STATUS_OK
) {
1113 if (!trace_is_ended
) {
1114 BT_ASSERT(stream_iter
);
1116 if (stream_iter
->current_msg_ts_ns
<= curr_candidate_msg_ts
) {
1117 curr_candidate_msg_ts
= stream_iter
->current_msg_ts_ns
;
1118 curr_candidate_stream_iter
= stream_iter
;
1122 g_ptr_array_remove_index_fast(session
->traces
, trace_idx
);
1126 if (curr_candidate_stream_iter
) {
1127 *candidate_session_stream_iter
= curr_candidate_stream_iter
;
1128 stream_iter_status
= LTTNG_LIVE_ITERATOR_STATUS_OK
;
1131 * The only cases where we don't have a candidate for this
1133 * 1. if we reached the end of all the iterators of all the
1134 * traces of this session,
1135 * 2. if we never had live stream iterator in the first place.
1137 * In either cases, we return END.
1139 BT_ASSERT(session
->traces
->len
== 0);
1140 stream_iter_status
= LTTNG_LIVE_ITERATOR_STATUS_END
;
1143 return stream_iter_status
;
1147 void put_messages(bt_message_array_const msgs
, uint64_t count
)
1151 for (i
= 0; i
< count
; i
++) {
1152 BT_MESSAGE_PUT_REF_AND_RESET(msgs
[i
]);
1157 bt_component_class_message_iterator_next_method_status
lttng_live_msg_iter_next(
1158 bt_self_message_iterator
*self_msg_it
,
1159 bt_message_array_const msgs
, uint64_t capacity
,
1162 bt_component_class_message_iterator_next_method_status status
;
1163 struct lttng_live_msg_iter
*lttng_live_msg_iter
=
1164 bt_self_message_iterator_get_data(self_msg_it
);
1165 struct lttng_live_component
*lttng_live
=
1166 lttng_live_msg_iter
->lttng_live_comp
;
1167 bt_self_component
*self_comp
= lttng_live_msg_iter
->self_comp
;
1168 bt_logging_level log_level
= lttng_live_msg_iter
->log_level
;
1169 enum lttng_live_iterator_status stream_iter_status
;
1170 uint64_t session_idx
;
1174 BT_ASSERT(lttng_live_msg_iter
);
1177 * Clear all the invalid message reference that might be left over in
1180 memset(msgs
, 0, capacity
* sizeof(*msgs
));
1183 * If no session are exposed on the relay found at the url provided by
1184 * the user, session count will be 0. In this case, we return status
1185 * end to return gracefully.
1187 if (lttng_live_msg_iter
->sessions
->len
== 0) {
1188 if (lttng_live
->params
.sess_not_found_act
!=
1189 SESSION_NOT_FOUND_ACTION_CONTINUE
) {
1190 status
= BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_END
;
1194 * The are no more active session for this session
1195 * name. Retry to create a viewer session for the
1196 * requested session name.
1198 if (lttng_live_create_viewer_session(lttng_live_msg_iter
)) {
1199 status
= BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_ERROR
;
1205 if (lttng_live_msg_iter
->active_stream_iter
== 0) {
1206 lttng_live_force_new_streams_and_metadata(lttng_live_msg_iter
);
1210 * Here the muxing of message is done.
1212 * We need to iterate over all the streams of all the traces of all the
1213 * viewer sessions in order to get the message with the smallest
1214 * timestamp. In this case, a session is a viewer session and there is
1215 * one viewer session per consumer daemon. (UST 32bit, UST 64bit and/or
1216 * kernel). Each viewer session can have multiple traces, for example,
1217 * 64bit UST viewer sessions could have multiple per-pid traces.
1219 * We iterate over the streams of each traces to update and see what is
1220 * their next message's timestamp. From those timestamps, we select the
1221 * message with the smallest timestamp as the best candidate message
1222 * for that trace and do the same thing across all the sessions.
1224 * We then compare the timestamp of best candidate message of all the
1225 * sessions to pick the message with the smallest timestamp and we
1228 while (*count
< capacity
) {
1229 struct lttng_live_stream_iterator
*next_stream_iter
= NULL
,
1230 *candidate_stream_iter
= NULL
;
1231 int64_t next_msg_ts_ns
= INT64_MAX
;
1233 BT_ASSERT(lttng_live_msg_iter
->sessions
);
1236 * Use a while loop instead of a for loop so we can restart the
1237 * iteration if we remove an element. We can safely call
1238 * next_stream_iterator_for_session() multiple times on the
1239 * same session as we only fetch a new message if there is no
1240 * current next message for each live stream iterator.
1241 * If all live stream iterator of that session already have a
1242 * current next message, the function will simply exit return
1243 * the same candidate live stream iterator every time.
1245 while (session_idx
< lttng_live_msg_iter
->sessions
->len
) {
1246 struct lttng_live_session
*session
=
1247 g_ptr_array_index(lttng_live_msg_iter
->sessions
,
1250 /* Find the best candidate message to send downstream. */
1251 stream_iter_status
= next_stream_iterator_for_session(
1252 lttng_live_msg_iter
, session
,
1253 &candidate_stream_iter
);
1255 /* If we receive an END status, it means that either:
1256 * - Those traces never had active streams (UST with no
1257 * data produced yet),
1258 * - All live stream iterators have ENDed.*/
1259 if (stream_iter_status
== LTTNG_LIVE_ITERATOR_STATUS_END
) {
1260 if (session
->closed
&& session
->traces
->len
== 0) {
1262 * Remove the session from the list and restart the
1263 * iteration at the beginning of the array since the
1264 * removal shuffle the elements of the array.
1266 g_ptr_array_remove_index_fast(
1267 lttng_live_msg_iter
->sessions
,
1276 if (stream_iter_status
!= LTTNG_LIVE_ITERATOR_STATUS_OK
) {
1280 if (G_UNLIKELY(next_stream_iter
== NULL
) ||
1281 candidate_stream_iter
->current_msg_ts_ns
<= next_msg_ts_ns
) {
1282 next_msg_ts_ns
= candidate_stream_iter
->current_msg_ts_ns
;
1283 next_stream_iter
= candidate_stream_iter
;
1284 } else if (candidate_stream_iter
->current_msg_ts_ns
== next_msg_ts_ns
) {
1286 * The currently selected message to be sent
1287 * downstream next has the exact same timestamp
1288 * that of the current candidate message. We
1289 * must break the tie in a predictable manner.
1291 BT_COMP_LOGD_STR("Two of the next message candidates have the same timestamps, pick one deterministically.");
1293 * Order the messages in an arbitrary but
1296 int ret
= common_muxing_compare_messages(candidate_stream_iter
->current_msg
,
1297 next_stream_iter
->current_msg
);
1300 * The `candidate_stream_iter->current_msg`
1301 * should go first. Update the next
1302 * iterator and the current timestamp.
1304 next_msg_ts_ns
= candidate_stream_iter
->current_msg_ts_ns
;
1305 next_stream_iter
= candidate_stream_iter
;
1306 } else if (ret
== 0) {
1307 /* Unable to pick which one should go first. */
1308 BT_COMP_LOGW("Cannot deterministically pick next live stream message iterator because they have identical next messages: "
1309 "next-stream-iter-addr=%p" "candidate-stream-iter-addr=%p",
1310 next_stream_iter
, candidate_stream_iter
);
1317 if (!next_stream_iter
) {
1318 stream_iter_status
= LTTNG_LIVE_ITERATOR_STATUS_AGAIN
;
1322 BT_ASSERT(next_stream_iter
->current_msg
);
1323 /* Ensure monotonicity. */
1324 BT_ASSERT(lttng_live_msg_iter
->last_msg_ts_ns
<=
1325 next_stream_iter
->current_msg_ts_ns
);
1328 * Insert the next message to the message batch. This will set
1329 * stream iterator current messsage to NULL so that next time
1330 * we fetch the next message of that stream iterator
1332 BT_MESSAGE_MOVE_REF(msgs
[*count
], next_stream_iter
->current_msg
);
1335 /* Update the last timestamp in nanoseconds sent downstream. */
1336 lttng_live_msg_iter
->last_msg_ts_ns
= next_msg_ts_ns
;
1337 next_stream_iter
->current_msg_ts_ns
= INT64_MAX
;
1339 stream_iter_status
= LTTNG_LIVE_ITERATOR_STATUS_OK
;
1342 switch (stream_iter_status
) {
1343 case LTTNG_LIVE_ITERATOR_STATUS_OK
:
1344 case LTTNG_LIVE_ITERATOR_STATUS_AGAIN
:
1347 * We received a again status but we have some messages
1348 * to send downstream. We send them and return OK for
1349 * now. On the next call we return again if there are
1350 * still no new message to send.
1352 status
= BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK
;
1354 status
= BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_AGAIN
;
1357 case LTTNG_LIVE_ITERATOR_STATUS_END
:
1358 status
= BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_END
;
1360 case LTTNG_LIVE_ITERATOR_STATUS_NOMEM
:
1361 status
= BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_MEMORY_ERROR
;
1363 case LTTNG_LIVE_ITERATOR_STATUS_ERROR
:
1364 case LTTNG_LIVE_ITERATOR_STATUS_INVAL
:
1365 case LTTNG_LIVE_ITERATOR_STATUS_UNSUPPORTED
:
1366 status
= BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_ERROR
;
1367 /* Put all existing messages on error. */
1368 put_messages(msgs
, *count
);
1379 bt_component_class_message_iterator_init_method_status
lttng_live_msg_iter_init(
1380 bt_self_message_iterator
*self_msg_it
,
1381 bt_self_component_source
*self_comp_src
,
1382 bt_self_component_port_output
*self_port
)
1384 bt_component_class_message_iterator_init_method_status ret
=
1385 BT_COMPONENT_CLASS_MESSAGE_ITERATOR_INIT_METHOD_STATUS_OK
;
1386 bt_self_component
*self_comp
=
1387 bt_self_component_source_as_self_component(self_comp_src
);
1388 struct lttng_live_component
*lttng_live
;
1389 struct lttng_live_msg_iter
*lttng_live_msg_iter
;
1390 bt_logging_level log_level
;
1392 BT_ASSERT(self_msg_it
);
1394 lttng_live
= bt_self_component_get_data(self_comp
);
1395 log_level
= lttng_live
->log_level
;
1396 self_comp
= lttng_live
->self_comp
;
1398 /* There can be only one downstream iterator at the same time. */
1399 BT_ASSERT(!lttng_live
->has_msg_iter
);
1400 lttng_live
->has_msg_iter
= true;
1402 lttng_live_msg_iter
= g_new0(struct lttng_live_msg_iter
, 1);
1403 if (!lttng_live_msg_iter
) {
1404 ret
= BT_COMPONENT_CLASS_MESSAGE_ITERATOR_INIT_METHOD_STATUS_ERROR
;
1408 lttng_live_msg_iter
->log_level
= lttng_live
->log_level
;
1409 lttng_live_msg_iter
->self_comp
= lttng_live
->self_comp
;
1410 lttng_live_msg_iter
->lttng_live_comp
= lttng_live
;
1411 lttng_live_msg_iter
->self_msg_iter
= self_msg_it
;
1413 lttng_live_msg_iter
->active_stream_iter
= 0;
1414 lttng_live_msg_iter
->last_msg_ts_ns
= INT64_MIN
;
1415 lttng_live_msg_iter
->sessions
= g_ptr_array_new_with_free_func(
1416 (GDestroyNotify
) lttng_live_destroy_session
);
1417 BT_ASSERT(lttng_live_msg_iter
->sessions
);
1419 lttng_live_msg_iter
->viewer_connection
=
1420 live_viewer_connection_create(lttng_live
->params
.url
->str
, false,
1421 lttng_live_msg_iter
, log_level
);
1422 if (!lttng_live_msg_iter
->viewer_connection
) {
1426 if (lttng_live_create_viewer_session(lttng_live_msg_iter
)) {
1429 if (lttng_live_msg_iter
->sessions
->len
== 0) {
1430 switch (lttng_live
->params
.sess_not_found_act
) {
1431 case SESSION_NOT_FOUND_ACTION_CONTINUE
:
1432 BT_COMP_LOGI("Unable to connect to the requested live viewer "
1433 "session. Keep trying to connect because of "
1434 "%s=\"%s\" component parameter: url=\"%s\"",
1435 SESS_NOT_FOUND_ACTION_PARAM
,
1436 SESS_NOT_FOUND_ACTION_CONTINUE_STR
,
1437 lttng_live
->params
.url
->str
);
1439 case SESSION_NOT_FOUND_ACTION_FAIL
:
1440 BT_COMP_LOGE("Unable to connect to the requested live viewer "
1441 "session. Fail the message iterator"
1442 "initialization because of %s=\"%s\" "
1443 "component parameter: url =\"%s\"",
1444 SESS_NOT_FOUND_ACTION_PARAM
,
1445 SESS_NOT_FOUND_ACTION_FAIL_STR
,
1446 lttng_live
->params
.url
->str
);
1448 case SESSION_NOT_FOUND_ACTION_END
:
1449 BT_COMP_LOGI("Unable to connect to the requested live viewer "
1450 "session. End gracefully at the first _next() "
1451 "call because of %s=\"%s\" component parameter: "
1452 "url=\"%s\"", SESS_NOT_FOUND_ACTION_PARAM
,
1453 SESS_NOT_FOUND_ACTION_END_STR
,
1454 lttng_live
->params
.url
->str
);
1456 case SESSION_NOT_FOUND_ACTION_UNKNOWN
:
1459 BT_COMP_LOGE("Unknown action for session not found"
1460 "error. Fail the message iterator"
1461 "initialization because of %s=\"%s\" "
1462 "component parameter: url =\"%s\"",
1463 SESS_NOT_FOUND_ACTION_PARAM
,
1464 SESS_NOT_FOUND_ACTION_FAIL_STR
,
1465 lttng_live
->params
.url
->str
);
1470 bt_self_message_iterator_set_data(self_msg_it
, lttng_live_msg_iter
);
1474 ret
= BT_COMPONENT_CLASS_MESSAGE_ITERATOR_INIT_METHOD_STATUS_ERROR
;
1475 lttng_live_msg_iter_destroy(lttng_live_msg_iter
);
1481 bt_component_class_query_method_status
lttng_live_query_list_sessions(
1482 const bt_value
*params
, const bt_value
**result
,
1483 bt_logging_level log_level
)
1485 bt_component_class_query_method_status status
=
1486 BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_OK
;
1487 const bt_value
*url_value
= NULL
;
1489 struct live_viewer_connection
*viewer_connection
= NULL
;
1490 bt_self_component
*self_comp
= NULL
;
1492 url_value
= bt_value_map_borrow_entry_value_const(params
, URL_PARAM
);
1494 BT_COMP_LOGE("Mandatory `%s` parameter missing", URL_PARAM
);
1495 status
= BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_ERROR
;
1499 if (!bt_value_is_string(url_value
)) {
1500 BT_COMP_LOGE("`%s` parameter is required to be a string value",
1502 status
= BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_ERROR
;
1506 url
= bt_value_string_get(url_value
);
1508 viewer_connection
= live_viewer_connection_create(url
, true, NULL
,
1510 if (!viewer_connection
) {
1514 status
= live_viewer_connection_list_sessions(viewer_connection
,
1516 if (status
!= BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_OK
) {
1523 BT_VALUE_PUT_REF_AND_RESET(*result
);
1526 status
= BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_ERROR
;
1530 if (viewer_connection
) {
1531 live_viewer_connection_destroy(viewer_connection
);
1537 bt_component_class_query_method_status
lttng_live_query(
1538 bt_self_component_class_source
*comp_class
,
1539 bt_private_query_executor
*priv_query_exec
,
1540 const char *object
, const bt_value
*params
,
1541 __attribute__((unused
)) void *method_data
,
1542 const bt_value
**result
)
1544 bt_component_class_query_method_status status
=
1545 BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_OK
;
1546 bt_self_component
*self_comp
= NULL
;
1547 bt_logging_level log_level
= bt_query_executor_get_logging_level(
1548 bt_private_query_executor_as_query_executor_const(
1551 if (strcmp(object
, "sessions") == 0) {
1552 status
= lttng_live_query_list_sessions(params
, result
,
1555 BT_COMP_LOGI("Unknown query object `%s`", object
);
1556 status
= BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_UNKNOWN_OBJECT
;
1565 void lttng_live_component_destroy_data(struct lttng_live_component
*lttng_live
)
1570 if (lttng_live
->params
.url
) {
1571 g_string_free(lttng_live
->params
.url
, TRUE
);
1577 void lttng_live_component_finalize(bt_self_component_source
*component
)
1579 void *data
= bt_self_component_get_data(
1580 bt_self_component_source_as_self_component(component
));
1585 lttng_live_component_destroy_data(data
);
1589 enum session_not_found_action
parse_session_not_found_action_param(
1590 const bt_value
*no_session_param
)
1592 enum session_not_found_action action
;
1593 const char *no_session_act_str
;
1594 no_session_act_str
= bt_value_string_get(no_session_param
);
1595 if (strcmp(no_session_act_str
, SESS_NOT_FOUND_ACTION_CONTINUE_STR
) == 0) {
1596 action
= SESSION_NOT_FOUND_ACTION_CONTINUE
;
1597 } else if (strcmp(no_session_act_str
, SESS_NOT_FOUND_ACTION_FAIL_STR
) == 0) {
1598 action
= SESSION_NOT_FOUND_ACTION_FAIL
;
1599 } else if (strcmp(no_session_act_str
, SESS_NOT_FOUND_ACTION_END_STR
) == 0) {
1600 action
= SESSION_NOT_FOUND_ACTION_END
;
1602 action
= SESSION_NOT_FOUND_ACTION_UNKNOWN
;
1608 struct lttng_live_component
*lttng_live_component_create(const bt_value
*params
,
1609 bt_logging_level log_level
, bt_self_component
*self_comp
)
1611 struct lttng_live_component
*lttng_live
;
1612 const bt_value
*value
= NULL
;
1615 lttng_live
= g_new0(struct lttng_live_component
, 1);
1619 lttng_live
->log_level
= log_level
;
1620 lttng_live
->self_comp
= self_comp
;
1621 lttng_live
->max_query_size
= MAX_QUERY_SIZE
;
1622 lttng_live
->has_msg_iter
= false;
1624 value
= bt_value_map_borrow_entry_value_const(params
, URL_PARAM
);
1625 if (!value
|| !bt_value_is_string(value
)) {
1626 BT_COMP_LOGW("Mandatory `%s` parameter missing or not a string",
1630 url
= bt_value_string_get(value
);
1631 lttng_live
->params
.url
= g_string_new(url
);
1632 if (!lttng_live
->params
.url
) {
1636 value
= bt_value_map_borrow_entry_value_const(params
,
1637 SESS_NOT_FOUND_ACTION_PARAM
);
1639 if (value
&& bt_value_is_string(value
)) {
1640 lttng_live
->params
.sess_not_found_act
=
1641 parse_session_not_found_action_param(value
);
1642 if (lttng_live
->params
.sess_not_found_act
== SESSION_NOT_FOUND_ACTION_UNKNOWN
) {
1643 BT_COMP_LOGE("Unexpected value for `%s` parameter: "
1644 "value=\"%s\"", SESS_NOT_FOUND_ACTION_PARAM
,
1645 bt_value_string_get(value
));
1649 BT_COMP_LOGW("Optional `%s` parameter is missing or "
1650 "not a string value. Defaulting to %s=\"%s\".",
1651 SESS_NOT_FOUND_ACTION_PARAM
,
1652 SESS_NOT_FOUND_ACTION_PARAM
,
1653 SESS_NOT_FOUND_ACTION_CONTINUE_STR
);
1654 lttng_live
->params
.sess_not_found_act
=
1655 SESSION_NOT_FOUND_ACTION_CONTINUE
;
1661 lttng_live_component_destroy_data(lttng_live
);
1668 bt_component_class_init_method_status
lttng_live_component_init(
1669 bt_self_component_source
*self_comp_src
,
1670 const bt_value
*params
, __attribute__((unused
)) void *init_method_data
)
1672 struct lttng_live_component
*lttng_live
;
1673 bt_component_class_init_method_status ret
=
1674 BT_COMPONENT_CLASS_INIT_METHOD_STATUS_OK
;
1675 bt_self_component
*self_comp
=
1676 bt_self_component_source_as_self_component(self_comp_src
);
1677 bt_logging_level log_level
= bt_component_get_logging_level(
1678 bt_self_component_as_component(self_comp
));
1679 bt_self_component_add_port_status add_port_status
;
1681 lttng_live
= lttng_live_component_create(params
, log_level
, self_comp
);
1683 ret
= BT_COMPONENT_CLASS_INIT_METHOD_STATUS_MEMORY_ERROR
;
1687 add_port_status
= bt_self_component_source_add_output_port(
1688 self_comp_src
, "out", NULL
, NULL
);
1689 switch (add_port_status
) {
1690 case BT_SELF_COMPONENT_ADD_PORT_STATUS_ERROR
:
1691 ret
= BT_COMPONENT_CLASS_INIT_METHOD_STATUS_ERROR
;
1693 case BT_SELF_COMPONENT_ADD_PORT_STATUS_MEMORY_ERROR
:
1694 ret
= BT_COMPONENT_CLASS_INIT_METHOD_STATUS_MEMORY_ERROR
;
1700 bt_self_component_set_data(self_comp
, lttng_live
);
1704 lttng_live_component_destroy_data(lttng_live
);