projects / babeltrace.git / blob
? search:
summary | shortlog | log | commit | commitdiff | tree
blame | history | raw | HEAD
Cleanup: src.ctf.lttng-live: missing space in debug statement
[babeltrace.git] / src / plugins / ctf / lttng-live / lttng-live.c
1 /*
2 * SPDX-License-Identifier: MIT
3 *
4 * Copyright 2019 Francis Deslauriers <francis.deslauriers@efficios.com>
5 * Copyright 2016 Jérémie Galarneau <jeremie.galarneau@efficios.com>
6 * Copyright 2016 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
7 *
8 * Babeltrace CTF LTTng-live Client Component
9 */
10
11 #define BT_COMP_LOG_SELF_COMP self_comp
12 #define BT_LOG_OUTPUT_LEVEL log_level
13 #define BT_LOG_TAG "PLUGIN/SRC.CTF.LTTNG-LIVE"
14 #include "logging/comp-logging.h"
15
16 #include <inttypes.h>
17 #include <stdbool.h>
18 #include <unistd.h>
19
20 #include <glib.h>
21
22 #include "common/assert.h"
23 #include <babeltrace2/babeltrace.h>
24 #include "compat/compiler.h"
25 #include <babeltrace2/types.h>
26
27 #include "plugins/common/muxing/muxing.h"
28 #include "plugins/common/param-validation/param-validation.h"
29
30 #include "data-stream.h"
31 #include "metadata.h"
32 #include "lttng-live.h"
33
34 #define MAX_QUERY_SIZE (256*1024)
35 #define URL_PARAM "url"
36 #define INPUTS_PARAM "inputs"
37 #define SESS_NOT_FOUND_ACTION_PARAM "session-not-found-action"
38 #define SESS_NOT_FOUND_ACTION_CONTINUE_STR "continue"
39 #define SESS_NOT_FOUND_ACTION_FAIL_STR "fail"
40 #define SESS_NOT_FOUND_ACTION_END_STR "end"
41
42 #define print_dbg(fmt, ...) BT_COMP_LOGD(fmt, ## __VA_ARGS__)
43
44 static
45 const char *lttng_live_iterator_status_string(
46 enum lttng_live_iterator_status status)
47 {
48 switch (status) {
49 case LTTNG_LIVE_ITERATOR_STATUS_CONTINUE:
50 return "LTTNG_LIVE_ITERATOR_STATUS_CONTINUE";
51 case LTTNG_LIVE_ITERATOR_STATUS_AGAIN:
52 return "LTTNG_LIVE_ITERATOR_STATUS_AGAIN";
53 case LTTNG_LIVE_ITERATOR_STATUS_END:
54 return "LTTNG_LIVE_ITERATOR_STATUS_END";
55 case LTTNG_LIVE_ITERATOR_STATUS_OK:
56 return "LTTNG_LIVE_ITERATOR_STATUS_OK";
57 case LTTNG_LIVE_ITERATOR_STATUS_INVAL:
58 return "LTTNG_LIVE_ITERATOR_STATUS_INVAL";
59 case LTTNG_LIVE_ITERATOR_STATUS_ERROR:
60 return "LTTNG_LIVE_ITERATOR_STATUS_ERROR";
61 case LTTNG_LIVE_ITERATOR_STATUS_NOMEM:
62 return "LTTNG_LIVE_ITERATOR_STATUS_NOMEM";
63 case LTTNG_LIVE_ITERATOR_STATUS_UNSUPPORTED:
64 return "LTTNG_LIVE_ITERATOR_STATUS_UNSUPPORTED";
65 default:
66 bt_common_abort();
67 }
68 }
69
70 static
71 const char *lttng_live_stream_state_string(enum lttng_live_stream_state state)
72 {
73 switch (state) {
74 case LTTNG_LIVE_STREAM_ACTIVE_NO_DATA:
75 return "ACTIVE_NO_DATA";
76 case LTTNG_LIVE_STREAM_QUIESCENT_NO_DATA:
77 return "QUIESCENT_NO_DATA";
78 case LTTNG_LIVE_STREAM_QUIESCENT:
79 return "QUIESCENT";
80 case LTTNG_LIVE_STREAM_ACTIVE_DATA:
81 return "ACTIVE_DATA";
82 case LTTNG_LIVE_STREAM_EOF:
83 return "EOF";
84 default:
85 return "ERROR";
86 }
87 }
88
89 #define LTTNG_LIVE_LOGD_STREAM_ITER(live_stream_iter) \
90 do { \
91 BT_COMP_LOGD("Live stream iterator state=%s, last-inact-ts=%" PRId64 \
92 ", curr-inact-ts %" PRId64, \
93 lttng_live_stream_state_string(live_stream_iter->state), \
94 live_stream_iter->last_inactivity_ts, \
95 live_stream_iter->current_inactivity_ts); \
96 } while (0);
97
98 BT_HIDDEN
99 bool lttng_live_graph_is_canceled(struct lttng_live_msg_iter *msg_iter)
100 {
101 bool ret;
102
103 if (!msg_iter) {
104 ret = false;
105 goto end;
106 }
107
108 ret = bt_self_message_iterator_is_interrupted(
109 msg_iter->self_msg_iter);
110
111 end:
112 return ret;
113 }
114
115 static
116 struct lttng_live_trace *lttng_live_session_borrow_trace_by_id(struct lttng_live_session *session,
117 uint64_t trace_id)
118 {
119 uint64_t trace_idx;
120 struct lttng_live_trace *ret_trace = NULL;
121
122 for (trace_idx = 0; trace_idx < session->traces->len; trace_idx++) {
123 struct lttng_live_trace *trace =
124 g_ptr_array_index(session->traces, trace_idx);
125 if (trace->id == trace_id) {
126 ret_trace = trace;
127 goto end;
128 }
129 }
130
131 end:
132 return ret_trace;
133 }
134
135 static
136 void lttng_live_destroy_trace(struct lttng_live_trace *trace)
137 {
138 bt_logging_level log_level = trace->log_level;
139 bt_self_component *self_comp = trace->self_comp;
140
141 BT_COMP_LOGD("Destroying live trace: trace-id=%"PRIu64, trace->id);
142
143 BT_ASSERT(trace->stream_iterators);
144 g_ptr_array_free(trace->stream_iterators, TRUE);
145
146 BT_TRACE_PUT_REF_AND_RESET(trace->trace);
147 BT_TRACE_CLASS_PUT_REF_AND_RESET(trace->trace_class);
148
149 lttng_live_metadata_fini(trace);
150 g_free(trace);
151 }
152
153 static
154 struct lttng_live_trace *lttng_live_create_trace(struct lttng_live_session *session,
155 uint64_t trace_id)
156 {
157 struct lttng_live_trace *trace = NULL;
158 bt_logging_level log_level = session->log_level;
159 bt_self_component *self_comp = session->self_comp;
160
161 BT_COMP_LOGD("Creating live trace: "
162 "session-id=%"PRIu64", trace-id=%"PRIu64,
163 session->id, trace_id);
164 trace = g_new0(struct lttng_live_trace, 1);
165 if (!trace) {
166 BT_COMP_LOGE_APPEND_CAUSE(self_comp,
167 "Failed to allocate live trace");
168 goto error;
169 }
170 trace->log_level = session->log_level;
171 trace->self_comp = session->self_comp;
172 trace->session = session;
173 trace->id = trace_id;
174 trace->trace_class = NULL;
175 trace->trace = NULL;
176 trace->stream_iterators = g_ptr_array_new_with_free_func(
177 (GDestroyNotify) lttng_live_stream_iterator_destroy);
178 BT_ASSERT(trace->stream_iterators);
179 trace->metadata_stream_state = LTTNG_LIVE_METADATA_STREAM_STATE_NEEDED;
180 g_ptr_array_add(session->traces, trace);
181
182 goto end;
183 error:
184 g_free(trace);
185 trace = NULL;
186 end:
187 return trace;
188 }
189
190 BT_HIDDEN
191 struct lttng_live_trace *lttng_live_session_borrow_or_create_trace_by_id(
192 struct lttng_live_session *session, uint64_t trace_id)
193 {
194 struct lttng_live_trace *trace;
195
196 trace = lttng_live_session_borrow_trace_by_id(session, trace_id);
197 if (trace) {
198 goto end;
199 }
200
201 /* The session is the owner of the newly created trace. */
202 trace = lttng_live_create_trace(session, trace_id);
203
204 end:
205 return trace;
206 }
207
208 BT_HIDDEN
209 int lttng_live_add_session(struct lttng_live_msg_iter *lttng_live_msg_iter,
210 uint64_t session_id, const char *hostname,
211 const char *session_name)
212 {
213 int ret = 0;
214 struct lttng_live_session *session;
215 bt_logging_level log_level = lttng_live_msg_iter->log_level;
216 bt_self_component *self_comp = lttng_live_msg_iter->self_comp;
217
218 BT_COMP_LOGD("Adding live session: "
219 "session-id=%" PRIu64 ", hostname=\"%s\" session-name=\"%s\"",
220 session_id, hostname, session_name);
221
222 session = g_new0(struct lttng_live_session, 1);
223 if (!session) {
224 BT_COMP_LOGE_APPEND_CAUSE(self_comp,
225 "Failed to allocate live session");
226 goto error;
227 }
228
229 session->log_level = lttng_live_msg_iter->log_level;
230 session->self_comp = lttng_live_msg_iter->self_comp;
231 session->id = session_id;
232 session->traces = g_ptr_array_new_with_free_func(
233 (GDestroyNotify) lttng_live_destroy_trace);
234 BT_ASSERT(session->traces);
235 session->lttng_live_msg_iter = lttng_live_msg_iter;
236 session->new_streams_needed = true;
237 session->hostname = g_string_new(hostname);
238 BT_ASSERT(session->hostname);
239
240 session->session_name = g_string_new(session_name);
241 BT_ASSERT(session->session_name);
242
243 g_ptr_array_add(lttng_live_msg_iter->sessions, session);
244 goto end;
245 error:
246 g_free(session);
247 ret = -1;
248 end:
249 return ret;
250 }
251
252 static
253 void lttng_live_destroy_session(struct lttng_live_session *session)
254 {
255 bt_logging_level log_level;
256 bt_self_component *self_comp;
257
258 if (!session) {
259 goto end;
260 }
261
262 log_level = session->log_level;
263 self_comp = session->self_comp;
264 BT_COMP_LOGD("Destroying live session: "
265 "session-id=%"PRIu64", session-name=\"%s\"",
266 session->id, session->session_name->str);
267 if (session->id != -1ULL) {
268 if (lttng_live_session_detach(session)) {
269 if (!lttng_live_graph_is_canceled(
270 session->lttng_live_msg_iter)) {
271 /* Old relayd cannot detach sessions. */
272 BT_COMP_LOGD("Unable to detach lttng live session %" PRIu64,
273 session->id);
274 }
275 }
276 session->id = -1ULL;
277 }
278
279 if (session->traces) {
280 g_ptr_array_free(session->traces, TRUE);
281 }
282
283 if (session->hostname) {
284 g_string_free(session->hostname, TRUE);
285 }
286 if (session->session_name) {
287 g_string_free(session->session_name, TRUE);
288 }
289 g_free(session);
290
291 end:
292 return;
293 }
294
295 static
296 void lttng_live_msg_iter_destroy(struct lttng_live_msg_iter *lttng_live_msg_iter)
297 {
298 if (!lttng_live_msg_iter) {
299 goto end;
300 }
301
302 if (lttng_live_msg_iter->sessions) {
303 g_ptr_array_free(lttng_live_msg_iter->sessions, TRUE);
304 }
305
306 if (lttng_live_msg_iter->viewer_connection) {
307 live_viewer_connection_destroy(lttng_live_msg_iter->viewer_connection);
308 }
309 BT_ASSERT(lttng_live_msg_iter->lttng_live_comp);
310 BT_ASSERT(lttng_live_msg_iter->lttng_live_comp->has_msg_iter);
311
312 /* All stream iterators must be destroyed at this point. */
313 BT_ASSERT(lttng_live_msg_iter->active_stream_iter == 0);
314 lttng_live_msg_iter->lttng_live_comp->has_msg_iter = false;
315
316 g_free(lttng_live_msg_iter);
317
318 end:
319 return;
320 }
321
322 BT_HIDDEN
323 void lttng_live_msg_iter_finalize(bt_self_message_iterator *self_msg_iter)
324 {
325 struct lttng_live_msg_iter *lttng_live_msg_iter;
326
327 BT_ASSERT(self_msg_iter);
328
329 lttng_live_msg_iter = bt_self_message_iterator_get_data(self_msg_iter);
330 BT_ASSERT(lttng_live_msg_iter);
331 lttng_live_msg_iter_destroy(lttng_live_msg_iter);
332 }
333
334 static
335 enum lttng_live_iterator_status lttng_live_iterator_next_check_stream_state(
336 struct lttng_live_stream_iterator *lttng_live_stream)
337 {
338 bt_logging_level log_level = lttng_live_stream->log_level;
339 bt_self_component *self_comp = lttng_live_stream->self_comp;
340
341 switch (lttng_live_stream->state) {
342 case LTTNG_LIVE_STREAM_QUIESCENT:
343 case LTTNG_LIVE_STREAM_ACTIVE_DATA:
344 break;
345 case LTTNG_LIVE_STREAM_ACTIVE_NO_DATA:
346 /* Invalid state. */
347 BT_COMP_LOGF("Unexpected stream state \"ACTIVE_NO_DATA\"");
348 bt_common_abort();
349 case LTTNG_LIVE_STREAM_QUIESCENT_NO_DATA:
350 /* Invalid state. */
351 BT_COMP_LOGF("Unexpected stream state \"QUIESCENT_NO_DATA\"");
352 bt_common_abort();
353 case LTTNG_LIVE_STREAM_EOF:
354 break;
355 }
356 return LTTNG_LIVE_ITERATOR_STATUS_OK;
357 }
358
359 /*
360 * For active no data stream, fetch next data. It can be either:
361 * - quiescent: need to put it in the prio heap at quiescent end
362 * timestamp,
363 * - have data: need to wire up first event into the prio heap,
364 * - have no data on this stream at this point: need to retry (AGAIN) or
365 * return EOF.
366 */
367 static
368 enum lttng_live_iterator_status lttng_live_iterator_next_handle_one_no_data_stream(
369 struct lttng_live_msg_iter *lttng_live_msg_iter,
370 struct lttng_live_stream_iterator *lttng_live_stream)
371 {
372 bt_logging_level log_level = lttng_live_msg_iter->log_level;
373 bt_self_component *self_comp = lttng_live_msg_iter->self_comp;
374 enum lttng_live_iterator_status ret = LTTNG_LIVE_ITERATOR_STATUS_OK;
375 enum lttng_live_stream_state orig_state = lttng_live_stream->state;
376 struct packet_index index;
377
378 if (lttng_live_stream->trace->metadata_stream_state ==
379 LTTNG_LIVE_METADATA_STREAM_STATE_NEEDED) {
380 ret = LTTNG_LIVE_ITERATOR_STATUS_CONTINUE;
381 goto end;
382 }
383 if (lttng_live_stream->trace->session->new_streams_needed) {
384 ret = LTTNG_LIVE_ITERATOR_STATUS_CONTINUE;
385 goto end;
386 }
387 if (lttng_live_stream->state != LTTNG_LIVE_STREAM_ACTIVE_NO_DATA &&
388 lttng_live_stream->state != LTTNG_LIVE_STREAM_QUIESCENT_NO_DATA) {
389 goto end;
390 }
391 ret = lttng_live_get_next_index(lttng_live_msg_iter, lttng_live_stream,
392 &index);
393 if (ret != LTTNG_LIVE_ITERATOR_STATUS_OK) {
394 goto end;
395 }
396 BT_ASSERT_DBG(lttng_live_stream->state != LTTNG_LIVE_STREAM_EOF);
397 if (lttng_live_stream->state == LTTNG_LIVE_STREAM_QUIESCENT) {
398 uint64_t last_inact_ts = lttng_live_stream->last_inactivity_ts,
399 curr_inact_ts = lttng_live_stream->current_inactivity_ts;
400
401 if (orig_state == LTTNG_LIVE_STREAM_QUIESCENT_NO_DATA &&
402 last_inact_ts == curr_inact_ts) {
403 ret = LTTNG_LIVE_ITERATOR_STATUS_AGAIN;
404 LTTNG_LIVE_LOGD_STREAM_ITER(lttng_live_stream);
405 } else {
406 ret = LTTNG_LIVE_ITERATOR_STATUS_CONTINUE;
407 }
408 goto end;
409 }
410 lttng_live_stream->base_offset = index.offset;
411 lttng_live_stream->offset = index.offset;
412 lttng_live_stream->len = index.packet_size / CHAR_BIT;
413 end:
414 if (ret == LTTNG_LIVE_ITERATOR_STATUS_OK) {
415 ret = lttng_live_iterator_next_check_stream_state(lttng_live_stream);
416 }
417 return ret;
418 }
419
420 /*
421 * Creation of the message requires the ctf trace class to be created
422 * beforehand, but the live protocol gives us all streams (including metadata)
423 * at once. So we split it in three steps: getting streams, getting metadata
424 * (which creates the ctf trace class), and then creating the per-stream
425 * messages.
426 */
427 static
428 enum lttng_live_iterator_status lttng_live_get_session(
429 struct lttng_live_msg_iter *lttng_live_msg_iter,
430 struct lttng_live_session *session)
431 {
432 bt_logging_level log_level = lttng_live_msg_iter->log_level;
433 bt_self_component *self_comp = lttng_live_msg_iter->self_comp;
434 enum lttng_live_iterator_status status;
435 uint64_t trace_idx;
436
437 BT_COMP_LOGD("Updating all streams for session: "
438 "session-id=%"PRIu64", session-name=\"%s\"",
439 session->id, session->session_name->str);
440
441 if (!session->attached) {
442 enum lttng_live_viewer_status attach_status =
443 lttng_live_session_attach(session,
444 lttng_live_msg_iter->self_msg_iter);
445 if (attach_status != LTTNG_LIVE_VIEWER_STATUS_OK) {
446 if (lttng_live_graph_is_canceled(lttng_live_msg_iter)) {
447 /*
448 * Clear any causes appended in
449 * `lttng_live_attach_session()` as we want to
450 * return gracefully since the graph was
451 * cancelled.
452 */
453 bt_current_thread_clear_error();
454 status = LTTNG_LIVE_ITERATOR_STATUS_AGAIN;
455 } else {
456 status = LTTNG_LIVE_ITERATOR_STATUS_ERROR;
457 BT_COMP_LOGE_APPEND_CAUSE(self_comp,
458 "Error attaching to LTTng live session");
459 }
460 goto end;
461 }
462 }
463
464 status = lttng_live_session_get_new_streams(session,
465 lttng_live_msg_iter->self_msg_iter);
466 if (status != LTTNG_LIVE_ITERATOR_STATUS_OK &&
467 status != LTTNG_LIVE_ITERATOR_STATUS_END) {
468 goto end;
469 }
470 trace_idx = 0;
471 while (trace_idx < session->traces->len) {
472 struct lttng_live_trace *trace =
473 g_ptr_array_index(session->traces, trace_idx);
474
475 status = lttng_live_metadata_update(trace);
476 switch (status) {
477 case LTTNG_LIVE_ITERATOR_STATUS_END:
478 case LTTNG_LIVE_ITERATOR_STATUS_OK:
479 trace_idx++;
480 break;
481 case LTTNG_LIVE_ITERATOR_STATUS_CONTINUE:
482 case LTTNG_LIVE_ITERATOR_STATUS_AGAIN:
483 goto end;
484 default:
485 BT_COMP_LOGE_APPEND_CAUSE(self_comp,
486 "Error updating trace metadata: "
487 "stream-iter-status=%s, trace-id=%"PRIu64,
488 lttng_live_iterator_status_string(status),
489 trace->id);
490 goto end;
491 }
492 }
493 status = lttng_live_lazy_msg_init(session,
494 lttng_live_msg_iter->self_msg_iter);
495
496 end:
497 return status;
498 }
499
500 static
501 void lttng_live_force_new_streams_and_metadata(struct lttng_live_msg_iter *lttng_live_msg_iter)
502 {
503 uint64_t session_idx, trace_idx;
504
505 for (session_idx = 0; session_idx < lttng_live_msg_iter->sessions->len;
506 session_idx++) {
507 struct lttng_live_session *session =
508 g_ptr_array_index(lttng_live_msg_iter->sessions, session_idx);
509 session->new_streams_needed = true;
510 for (trace_idx = 0; trace_idx < session->traces->len;
511 trace_idx++) {
512 struct lttng_live_trace *trace =
513 g_ptr_array_index(session->traces, trace_idx);
514
515 BT_ASSERT(trace->metadata_stream_state !=
516 LTTNG_LIVE_METADATA_STREAM_STATE_CLOSED);
517
518 trace->metadata_stream_state = LTTNG_LIVE_METADATA_STREAM_STATE_NEEDED;
519 }
520 }
521 }
522
523 static
524 enum lttng_live_iterator_status
525 lttng_live_iterator_handle_new_streams_and_metadata(
526 struct lttng_live_msg_iter *lttng_live_msg_iter)
527 {
528 enum lttng_live_iterator_status status;
529 enum lttng_live_viewer_status viewer_status;
530 bt_logging_level log_level = lttng_live_msg_iter->log_level;
531 bt_self_component *self_comp = lttng_live_msg_iter->self_comp;
532 uint64_t session_idx = 0, nr_sessions_opened = 0;
533 struct lttng_live_session *session;
534 enum session_not_found_action sess_not_found_act =
535 lttng_live_msg_iter->lttng_live_comp->params.sess_not_found_act;
536
537 BT_COMP_LOGD("Update data and metadata of all sessions: "
538 "live-msg-iter-addr=%p", lttng_live_msg_iter);
539 /*
540 * In a remotely distant future, we could add a "new
541 * session" flag to the protocol, which would tell us that we
542 * need to query for new sessions even though we have sessions
543 * currently ongoing.
544 */
545 if (lttng_live_msg_iter->sessions->len == 0) {
546 if (sess_not_found_act != SESSION_NOT_FOUND_ACTION_CONTINUE) {
547 BT_COMP_LOGD("No session found. Exiting in accordance with the `session-not-found-action` parameter");
548 status = LTTNG_LIVE_ITERATOR_STATUS_END;
549 goto end;
550 } else {
551 BT_COMP_LOGD("No session found. Try creating a new one in accordance with the `session-not-found-action` parameter");
552 /*
553 * Retry to create a viewer session for the requested
554 * session name.
555 */
556 viewer_status = lttng_live_create_viewer_session(lttng_live_msg_iter);
557 if (viewer_status != LTTNG_LIVE_VIEWER_STATUS_OK) {
558 if (viewer_status == LTTNG_LIVE_VIEWER_STATUS_ERROR) {
559 status = LTTNG_LIVE_ITERATOR_STATUS_ERROR;
560 BT_COMP_LOGE_APPEND_CAUSE(self_comp,
561 "Error creating LTTng live viewer session");
562 } else if (viewer_status == LTTNG_LIVE_VIEWER_STATUS_INTERRUPTED) {
563 status = LTTNG_LIVE_ITERATOR_STATUS_AGAIN;
564 } else {
565 bt_common_abort();
566 }
567 goto end;
568 }
569 }
570 }
571
572 for (session_idx = 0; session_idx < lttng_live_msg_iter->sessions->len;
573 session_idx++) {
574 session = g_ptr_array_index(lttng_live_msg_iter->sessions,
575 session_idx);
576 status = lttng_live_get_session(lttng_live_msg_iter, session);
577 switch (status) {
578 case LTTNG_LIVE_ITERATOR_STATUS_OK:
579 break;
580 case LTTNG_LIVE_ITERATOR_STATUS_END:
581 status = LTTNG_LIVE_ITERATOR_STATUS_OK;
582 break;
583 default:
584 goto end;
585 }
586 if (!session->closed) {
587 nr_sessions_opened++;
588 }
589 }
590
591 if (sess_not_found_act != SESSION_NOT_FOUND_ACTION_CONTINUE &&
592 nr_sessions_opened == 0) {
593 status = LTTNG_LIVE_ITERATOR_STATUS_END;
594 } else {
595 status = LTTNG_LIVE_ITERATOR_STATUS_OK;
596 }
597
598 end:
599 return status;
600 }
601
602 static
603 enum lttng_live_iterator_status emit_inactivity_message(
604 struct lttng_live_msg_iter *lttng_live_msg_iter,
605 struct lttng_live_stream_iterator *stream_iter,
606 const bt_message **message, uint64_t timestamp)
607 {
608 enum lttng_live_iterator_status ret = LTTNG_LIVE_ITERATOR_STATUS_OK;
609 bt_logging_level log_level = lttng_live_msg_iter->log_level;
610 bt_self_component *self_comp = lttng_live_msg_iter->self_comp;
611 bt_message *msg = NULL;
612
613 BT_ASSERT(stream_iter->trace->clock_class);
614
615 msg = bt_message_message_iterator_inactivity_create(
616 lttng_live_msg_iter->self_msg_iter,
617 stream_iter->trace->clock_class, timestamp);
618 if (!msg) {
619 BT_COMP_LOGE_APPEND_CAUSE(self_comp,
620 "Error emitting message iterator inactivity message");
621 goto error;
622 }
623
624 *message = msg;
625 end:
626 return ret;
627
628 error:
629 ret = LTTNG_LIVE_ITERATOR_STATUS_ERROR;
630 bt_message_put_ref(msg);
631 goto end;
632 }
633
634 static
635 enum lttng_live_iterator_status lttng_live_iterator_next_handle_one_quiescent_stream(
636 struct lttng_live_msg_iter *lttng_live_msg_iter,
637 struct lttng_live_stream_iterator *lttng_live_stream,
638 const bt_message **message)
639 {
640 enum lttng_live_iterator_status ret = LTTNG_LIVE_ITERATOR_STATUS_OK;
641
642 if (lttng_live_stream->state != LTTNG_LIVE_STREAM_QUIESCENT) {
643 return LTTNG_LIVE_ITERATOR_STATUS_OK;
644 }
645
646 if (lttng_live_stream->current_inactivity_ts ==
647 lttng_live_stream->last_inactivity_ts) {
648 lttng_live_stream->state = LTTNG_LIVE_STREAM_QUIESCENT_NO_DATA;
649 ret = LTTNG_LIVE_ITERATOR_STATUS_CONTINUE;
650 goto end;
651 }
652
653 ret = emit_inactivity_message(lttng_live_msg_iter, lttng_live_stream,
654 message, lttng_live_stream->current_inactivity_ts);
655
656 lttng_live_stream->last_inactivity_ts =
657 lttng_live_stream->current_inactivity_ts;
658 end:
659 return ret;
660 }
661
662 static
663 int live_get_msg_ts_ns(struct lttng_live_stream_iterator *stream_iter,
664 struct lttng_live_msg_iter *lttng_live_msg_iter,
665 const bt_message *msg, int64_t last_msg_ts_ns,
666 int64_t *ts_ns)
667 {
668 const bt_clock_class *clock_class = NULL;
669 const bt_clock_snapshot *clock_snapshot = NULL;
670 int ret = 0;
671 bt_logging_level log_level = lttng_live_msg_iter->log_level;
672 bt_self_component *self_comp = lttng_live_msg_iter->self_comp;
673
674 BT_ASSERT_DBG(msg);
675 BT_ASSERT_DBG(ts_ns);
676
677 BT_COMP_LOGD("Getting message's timestamp: iter-data-addr=%p, msg-addr=%p, "
678 "last-msg-ts=%" PRId64, lttng_live_msg_iter, msg,
679 last_msg_ts_ns);
680
681 switch (bt_message_get_type(msg)) {
682 case BT_MESSAGE_TYPE_EVENT:
683 clock_class = bt_message_event_borrow_stream_class_default_clock_class_const(
684 msg);
685 BT_ASSERT_DBG(clock_class);
686
687 clock_snapshot = bt_message_event_borrow_default_clock_snapshot_const(
688 msg);
689 break;
690 case BT_MESSAGE_TYPE_PACKET_BEGINNING:
691 clock_class = bt_message_packet_beginning_borrow_stream_class_default_clock_class_const(
692 msg);
693 BT_ASSERT(clock_class);
694
695 clock_snapshot = bt_message_packet_beginning_borrow_default_clock_snapshot_const(
696 msg);
697 break;
698 case BT_MESSAGE_TYPE_PACKET_END:
699 clock_class = bt_message_packet_end_borrow_stream_class_default_clock_class_const(
700 msg);
701 BT_ASSERT(clock_class);
702
703 clock_snapshot = bt_message_packet_end_borrow_default_clock_snapshot_const(
704 msg);
705 break;
706 case BT_MESSAGE_TYPE_DISCARDED_EVENTS:
707 clock_class = bt_message_discarded_events_borrow_stream_class_default_clock_class_const(
708 msg);
709 BT_ASSERT(clock_class);
710
711 clock_snapshot = bt_message_discarded_events_borrow_beginning_default_clock_snapshot_const(
712 msg);
713 break;
714 case BT_MESSAGE_TYPE_DISCARDED_PACKETS:
715 clock_class = bt_message_discarded_packets_borrow_stream_class_default_clock_class_const(
716 msg);
717 BT_ASSERT(clock_class);
718
719 clock_snapshot = bt_message_discarded_packets_borrow_beginning_default_clock_snapshot_const(
720 msg);
721 break;
722 case BT_MESSAGE_TYPE_MESSAGE_ITERATOR_INACTIVITY:
723 clock_snapshot = bt_message_message_iterator_inactivity_borrow_clock_snapshot_const(
724 msg);
725 break;
726 default:
727 /* All the other messages have a higher priority */
728 BT_COMP_LOGD_STR("Message has no timestamp: using the last message timestamp.");
729 *ts_ns = last_msg_ts_ns;
730 goto end;
731 }
732
733 clock_class = bt_clock_snapshot_borrow_clock_class_const(clock_snapshot);
734 BT_ASSERT_DBG(clock_class);
735
736 ret = bt_clock_snapshot_get_ns_from_origin(clock_snapshot, ts_ns);
737 if (ret) {
738 BT_COMP_LOGE_APPEND_CAUSE(self_comp,
739 "Cannot get nanoseconds from Epoch of clock snapshot: "
740 "clock-snapshot-addr=%p", clock_snapshot);
741 goto error;
742 }
743
744 goto end;
745
746 error:
747 ret = -1;
748
749 end:
750 if (ret == 0) {
751 BT_COMP_LOGD("Found message's timestamp: "
752 "iter-data-addr=%p, msg-addr=%p, "
753 "last-msg-ts=%" PRId64 ", ts=%" PRId64,
754 lttng_live_msg_iter, msg, last_msg_ts_ns, *ts_ns);
755 }
756
757 return ret;
758 }
759
760 static
761 enum lttng_live_iterator_status lttng_live_iterator_next_handle_one_active_data_stream(
762 struct lttng_live_msg_iter *lttng_live_msg_iter,
763 struct lttng_live_stream_iterator *lttng_live_stream,
764 const bt_message **message)
765 {
766 enum lttng_live_iterator_status ret = LTTNG_LIVE_ITERATOR_STATUS_OK;
767 bt_logging_level log_level = lttng_live_msg_iter->log_level;
768 bt_self_component *self_comp = lttng_live_msg_iter->self_comp;
769 enum ctf_msg_iter_status status;
770 uint64_t session_idx, trace_idx;
771
772 for (session_idx = 0; session_idx < lttng_live_msg_iter->sessions->len;
773 session_idx++) {
774 struct lttng_live_session *session =
775 g_ptr_array_index(lttng_live_msg_iter->sessions, session_idx);
776
777 if (session->new_streams_needed) {
778 ret = LTTNG_LIVE_ITERATOR_STATUS_CONTINUE;
779 goto end;
780 }
781 for (trace_idx = 0; trace_idx < session->traces->len;
782 trace_idx++) {
783 struct lttng_live_trace *trace =
784 g_ptr_array_index(session->traces, trace_idx);
785 if (trace->metadata_stream_state == LTTNG_LIVE_METADATA_STREAM_STATE_NEEDED) {
786 ret = LTTNG_LIVE_ITERATOR_STATUS_CONTINUE;
787 goto end;
788 }
789 }
790 }
791
792 if (lttng_live_stream->state != LTTNG_LIVE_STREAM_ACTIVE_DATA) {
793 ret = LTTNG_LIVE_ITERATOR_STATUS_ERROR;
794 BT_COMP_LOGE_APPEND_CAUSE(self_comp,
795 "Invalid state of live stream iterator"
796 "stream-iter-status=%s",
797 lttng_live_stream_state_string(lttng_live_stream->state));
798 goto end;
799 }
800
801 status = ctf_msg_iter_get_next_message(
802 lttng_live_stream->msg_iter, message);
803 switch (status) {
804 case CTF_MSG_ITER_STATUS_EOF:
805 ret = LTTNG_LIVE_ITERATOR_STATUS_END;
806 break;
807 case CTF_MSG_ITER_STATUS_OK:
808 ret = LTTNG_LIVE_ITERATOR_STATUS_OK;
809 break;
810 case CTF_MSG_ITER_STATUS_AGAIN:
811 /*
812 * Continue immediately (end of packet). The next
813 * get_index may return AGAIN to delay the following
814 * attempt.
815 */
816 ret = LTTNG_LIVE_ITERATOR_STATUS_CONTINUE;
817 break;
818 case CTF_MSG_ITER_STATUS_ERROR:
819 default:
820 ret = LTTNG_LIVE_ITERATOR_STATUS_ERROR;
821 BT_COMP_LOGE_APPEND_CAUSE(self_comp,
822 "CTF message iterator failed to get next message: "
823 "msg-iter=%p, msg-iter-status=%s",
824 lttng_live_stream->msg_iter,
825 ctf_msg_iter_status_string(status));
826 break;
827 }
828
829 end:
830 return ret;
831 }
832
833 static
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 const bt_message **curr_msg)
838 {
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;
843 /*
844 * The viewer has hung up on us so we are closing the stream. The
845 * `ctf_msg_iter` should simply realize that it needs to close the
846 * stream properly by emitting the necessary stream end message.
847 */
848 enum ctf_msg_iter_status status = ctf_msg_iter_get_next_message(
849 stream_iter->msg_iter, curr_msg);
850
851 if (status == CTF_MSG_ITER_STATUS_ERROR) {
852 BT_COMP_LOGE_APPEND_CAUSE(self_comp,
853 "Error getting the next message from CTF message iterator");
854 live_status = LTTNG_LIVE_ITERATOR_STATUS_ERROR;
855 goto end;
856 } else if (status == CTF_MSG_ITER_STATUS_EOF) {
857 BT_COMP_LOGI("Reached the end of the live stream iterator.");
858 live_status = LTTNG_LIVE_ITERATOR_STATUS_END;
859 goto end;
860 }
861
862 BT_ASSERT(status == CTF_MSG_ITER_STATUS_OK);
863
864 end:
865 return live_status;
866 }
867
868 /*
869 * helper function:
870 * handle_no_data_streams()
871 * retry:
872 * - for each ACTIVE_NO_DATA stream:
873 * - query relayd for stream data, or quiescence info.
874 * - if need metadata, get metadata, goto retry.
875 * - if new stream, get new stream as ACTIVE_NO_DATA, goto retry
876 * - if quiescent, move to QUIESCENT streams
877 * - if fetched data, move to ACTIVE_DATA streams
878 * (at this point each stream either has data, or is quiescent)
879 *
880 *
881 * iterator_next:
882 * handle_new_streams_and_metadata()
883 * - query relayd for known streams, add them as ACTIVE_NO_DATA
884 * - query relayd for metadata
885 *
886 * call handle_active_no_data_streams()
887 *
888 * handle_quiescent_streams()
889 * - if at least one stream is ACTIVE_DATA:
890 * - peek stream event with lowest timestamp -> next_ts
891 * - for each quiescent stream
892 * - if next_ts >= quiescent end
893 * - set state to ACTIVE_NO_DATA
894 * - else
895 * - for each quiescent stream
896 * - set state to ACTIVE_NO_DATA
897 *
898 * call handle_active_no_data_streams()
899 *
900 * handle_active_data_streams()
901 * - if at least one stream is ACTIVE_DATA:
902 * - get stream event with lowest timestamp from heap
903 * - make that stream event the current message.
904 * - move this stream heap position to its next event
905 * - if we need to fetch data from relayd, move
906 * stream to ACTIVE_NO_DATA.
907 * - return OK
908 * - return AGAIN
909 *
910 * end criterion: ctrl-c on client. If relayd exits or the session
911 * closes on the relay daemon side, we keep on waiting for streams.
912 * Eventually handle --end timestamp (also an end criterion).
913 *
914 * When disconnected from relayd: try to re-connect endlessly.
915 */
916 static
917 enum lttng_live_iterator_status lttng_live_iterator_next_msg_on_stream(
918 struct lttng_live_msg_iter *lttng_live_msg_iter,
919 struct lttng_live_stream_iterator *stream_iter,
920 const bt_message **curr_msg)
921 {
922 bt_logging_level log_level = lttng_live_msg_iter->log_level;
923 bt_self_component *self_comp = lttng_live_msg_iter->self_comp;
924 enum lttng_live_iterator_status live_status;
925
926 BT_COMP_LOGD("Finding the next message for stream iterator: "
927 "stream-name=\"%s\"", stream_iter->name->str);
928
929 if (stream_iter->has_stream_hung_up) {
930 /*
931 * The stream has hung up and the stream was properly closed
932 * during the last call to the current function. Return _END
933 * status now so that this stream iterator is removed for the
934 * stream iterator list.
935 */
936 live_status = LTTNG_LIVE_ITERATOR_STATUS_END;
937 goto end;
938 }
939
940 retry:
941 LTTNG_LIVE_LOGD_STREAM_ITER(stream_iter);
942 live_status = lttng_live_iterator_handle_new_streams_and_metadata(
943 lttng_live_msg_iter);
944 if (live_status != LTTNG_LIVE_ITERATOR_STATUS_OK) {
945 goto end;
946 }
947 live_status = lttng_live_iterator_next_handle_one_no_data_stream(
948 lttng_live_msg_iter, stream_iter);
949
950 if (live_status != LTTNG_LIVE_ITERATOR_STATUS_OK) {
951 if (live_status == LTTNG_LIVE_ITERATOR_STATUS_END) {
952 /*
953 * We overwrite `live_status` since `curr_msg` is
954 * likely set to a valid message in this function.
955 */
956 live_status = lttng_live_iterator_close_stream(
957 lttng_live_msg_iter, stream_iter, curr_msg);
958 }
959 goto end;
960 }
961 live_status = lttng_live_iterator_next_handle_one_quiescent_stream(
962 lttng_live_msg_iter, stream_iter, curr_msg);
963 if (live_status != LTTNG_LIVE_ITERATOR_STATUS_OK) {
964 BT_ASSERT(!*curr_msg);
965 goto end;
966 }
967 if (*curr_msg) {
968 goto end;
969 }
970 live_status = lttng_live_iterator_next_handle_one_active_data_stream(
971 lttng_live_msg_iter, stream_iter, curr_msg);
972 if (live_status != LTTNG_LIVE_ITERATOR_STATUS_OK) {
973 BT_ASSERT(!*curr_msg);
974 }
975
976 end:
977 if (live_status == LTTNG_LIVE_ITERATOR_STATUS_CONTINUE) {
978 goto retry;
979 }
980
981 return live_status;
982 }
983
984 static
985 bool is_discarded_packet_or_event_message(const bt_message *msg)
986 {
987 const enum bt_message_type msg_type = bt_message_get_type(msg);
988
989 return msg_type == BT_MESSAGE_TYPE_DISCARDED_EVENTS ||
990 msg_type == BT_MESSAGE_TYPE_DISCARDED_PACKETS;
991 }
992
993 static
994 enum lttng_live_iterator_status adjust_discarded_packets_message(
995 bt_self_message_iterator *iter,
996 const bt_stream *stream,
997 const bt_message *msg_in, bt_message **msg_out,
998 uint64_t new_begin_ts)
999 {
1000 enum lttng_live_iterator_status status = LTTNG_LIVE_ITERATOR_STATUS_OK;
1001 enum bt_property_availability availability;
1002 const bt_clock_snapshot *clock_snapshot;
1003 uint64_t end_ts;
1004 uint64_t count;
1005
1006 clock_snapshot = bt_message_discarded_packets_borrow_end_default_clock_snapshot_const(msg_in);
1007 end_ts = bt_clock_snapshot_get_value(clock_snapshot);
1008
1009 availability = bt_message_discarded_packets_get_count(msg_in, &count);
1010 BT_ASSERT_DBG(availability == BT_PROPERTY_AVAILABILITY_AVAILABLE);
1011
1012 *msg_out = bt_message_discarded_packets_create_with_default_clock_snapshots(
1013 iter, stream, new_begin_ts, end_ts);
1014 if (!*msg_out) {
1015 status = LTTNG_LIVE_ITERATOR_STATUS_NOMEM;
1016 goto end;
1017 }
1018
1019 bt_message_discarded_packets_set_count(*msg_out, count);
1020 end:
1021 return status;
1022 }
1023
1024 static
1025 enum lttng_live_iterator_status adjust_discarded_events_message(
1026 bt_self_message_iterator *iter,
1027 const bt_stream *stream,
1028 const bt_message *msg_in, bt_message **msg_out,
1029 uint64_t new_begin_ts)
1030 {
1031 enum lttng_live_iterator_status status = LTTNG_LIVE_ITERATOR_STATUS_OK;
1032 enum bt_property_availability availability;
1033 const bt_clock_snapshot *clock_snapshot;
1034 uint64_t end_ts;
1035 uint64_t count;
1036
1037 clock_snapshot = bt_message_discarded_events_borrow_end_default_clock_snapshot_const(msg_in);
1038 end_ts = bt_clock_snapshot_get_value(clock_snapshot);
1039
1040 availability = bt_message_discarded_events_get_count(msg_in, &count);
1041 BT_ASSERT_DBG(availability == BT_PROPERTY_AVAILABILITY_AVAILABLE);
1042
1043 *msg_out = bt_message_discarded_events_create_with_default_clock_snapshots(
1044 iter, stream, new_begin_ts, end_ts);
1045 if (!*msg_out) {
1046 status = LTTNG_LIVE_ITERATOR_STATUS_NOMEM;
1047 goto end;
1048 }
1049
1050 bt_message_discarded_events_set_count(*msg_out, count);
1051 end:
1052 return status;
1053 }
1054
1055 static
1056 enum lttng_live_iterator_status next_stream_iterator_for_trace(
1057 struct lttng_live_msg_iter *lttng_live_msg_iter,
1058 struct lttng_live_trace *live_trace,
1059 struct lttng_live_stream_iterator **youngest_trace_stream_iter)
1060 {
1061 struct lttng_live_stream_iterator *youngest_candidate_stream_iter = NULL;
1062 bt_logging_level log_level = lttng_live_msg_iter->log_level;
1063 bt_self_component *self_comp = lttng_live_msg_iter->self_comp;
1064 enum lttng_live_iterator_status stream_iter_status;;
1065 int64_t youngest_candidate_msg_ts = INT64_MAX;
1066 uint64_t stream_iter_idx;
1067
1068 BT_ASSERT_DBG(live_trace);
1069 BT_ASSERT_DBG(live_trace->stream_iterators);
1070
1071 BT_COMP_LOGD("Finding the next stream iterator for trace: "
1072 "trace-id=%"PRIu64, live_trace->id);
1073 /*
1074 * Update the current message of every stream iterators of this trace.
1075 * The current msg of every stream must have a timestamp equal or
1076 * larger than the last message returned by this iterator. We must
1077 * ensure monotonicity.
1078 */
1079 stream_iter_idx = 0;
1080 while (stream_iter_idx < live_trace->stream_iterators->len) {
1081 bool stream_iter_is_ended = false;
1082 struct lttng_live_stream_iterator *stream_iter =
1083 g_ptr_array_index(live_trace->stream_iterators,
1084 stream_iter_idx);
1085
1086 /*
1087 * If there is no current message for this stream, go fetch
1088 * one.
1089 */
1090 while (!stream_iter->current_msg) {
1091 const bt_message *msg = NULL;
1092 int64_t curr_msg_ts_ns = INT64_MAX;
1093 stream_iter_status = lttng_live_iterator_next_msg_on_stream(
1094 lttng_live_msg_iter, stream_iter, &msg);
1095
1096 BT_COMP_LOGD("live stream iterator returned status :%s",
1097 lttng_live_iterator_status_string(stream_iter_status));
1098 if (stream_iter_status == LTTNG_LIVE_ITERATOR_STATUS_END) {
1099 stream_iter_is_ended = true;
1100 break;
1101 }
1102
1103 if (stream_iter_status != LTTNG_LIVE_ITERATOR_STATUS_OK) {
1104 goto end;
1105 }
1106
1107 BT_ASSERT_DBG(msg);
1108
1109 /*
1110 * Get the timestamp in nanoseconds from origin of this
1111 * messsage.
1112 */
1113 live_get_msg_ts_ns(stream_iter, lttng_live_msg_iter,
1114 msg, lttng_live_msg_iter->last_msg_ts_ns,
1115 &curr_msg_ts_ns);
1116
1117 /*
1118 * Check if the message of the current live stream
1119 * iterator occurred at the exact same time or after the
1120 * last message returned by this component's message
1121 * iterator. If not, we return an error.
1122 */
1123 if (curr_msg_ts_ns >= lttng_live_msg_iter->last_msg_ts_ns) {
1124 stream_iter->current_msg = msg;
1125 stream_iter->current_msg_ts_ns = curr_msg_ts_ns;
1126 } else if (stream_iter->last_inactivity_ts > curr_msg_ts_ns &&
1127 is_discarded_packet_or_event_message(msg)) {
1128 /*
1129 * The CTF message iterator emits Discarded
1130 * Packets and Events with synthesized begin and
1131 * end timestamps from the bounds of the last
1132 * known packet and the newly decoded packet
1133 * header.
1134 *
1135 * The CTF message iterator is not aware of
1136 * stream inactivity beacons. Hence, we have
1137 * to adjust the begin timestamp of those types
1138 * of messages if a stream signaled its
1139 * inactivity up until _after_ the last known
1140 * packet's begin timestamp.
1141 *
1142 * Otherwise, the monotonicity guarantee would
1143 * not be preserved.
1144 */
1145 const enum bt_message_type msg_type =
1146 bt_message_get_type(msg);
1147 enum lttng_live_iterator_status adjust_status =
1148 LTTNG_LIVE_ITERATOR_STATUS_OK;
1149 bt_message *adjusted_message;
1150
1151 switch (msg_type) {
1152 case BT_MESSAGE_TYPE_DISCARDED_EVENTS:
1153 adjust_status = adjust_discarded_events_message(
1154 lttng_live_msg_iter->self_msg_iter,
1155 stream_iter->stream,
1156 msg, &adjusted_message,
1157 stream_iter->last_inactivity_ts);
1158 break;
1159 case BT_MESSAGE_TYPE_DISCARDED_PACKETS:
1160 adjust_status = adjust_discarded_packets_message(
1161 lttng_live_msg_iter->self_msg_iter,
1162 stream_iter->stream,
1163 msg, &adjusted_message,
1164 stream_iter->last_inactivity_ts);
1165 break;
1166 default:
1167 bt_common_abort();
1168 }
1169
1170 if (adjust_status != LTTNG_LIVE_ITERATOR_STATUS_OK) {
1171 stream_iter_status = adjust_status;
1172 goto end;
1173 }
1174
1175 BT_ASSERT_DBG(adjusted_message);
1176 stream_iter->current_msg = adjusted_message;
1177 stream_iter->current_msg_ts_ns =
1178 stream_iter->last_inactivity_ts;
1179 } else {
1180 /*
1181 * We received a message in the past. To ensure
1182 * monotonicity, we can't send it forward.
1183 */
1184 BT_COMP_LOGE_APPEND_CAUSE(self_comp,
1185 "Message's timestamp is less than "
1186 "lttng-live's message iterator's last "
1187 "returned timestamp: "
1188 "lttng-live-msg-iter-addr=%p, ts=%" PRId64 ", "
1189 "last-msg-ts=%" PRId64,
1190 lttng_live_msg_iter, curr_msg_ts_ns,
1191 lttng_live_msg_iter->last_msg_ts_ns);
1192 stream_iter_status = LTTNG_LIVE_ITERATOR_STATUS_ERROR;
1193 goto end;
1194 }
1195 }
1196
1197 BT_ASSERT_DBG(stream_iter != youngest_candidate_stream_iter);
1198
1199 if (!stream_iter_is_ended) {
1200 if (G_UNLIKELY(youngest_candidate_stream_iter == NULL) ||
1201 stream_iter->current_msg_ts_ns < youngest_candidate_msg_ts) {
1202 /*
1203 * Update the current best candidate message
1204 * for the stream iterator of this live trace
1205 * to be forwarded downstream.
1206 */
1207 youngest_candidate_msg_ts = stream_iter->current_msg_ts_ns;
1208 youngest_candidate_stream_iter = stream_iter;
1209 } else if (stream_iter->current_msg_ts_ns == youngest_candidate_msg_ts) {
1210 /*
1211 * Order the messages in an arbitrary but
1212 * deterministic way.
1213 */
1214 BT_ASSERT_DBG(stream_iter != youngest_candidate_stream_iter);
1215 int ret = common_muxing_compare_messages(
1216 stream_iter->current_msg,
1217 youngest_candidate_stream_iter->current_msg);
1218 if (ret < 0) {
1219 /*
1220 * The `youngest_candidate_stream_iter->current_msg`
1221 * should go first. Update the next
1222 * iterator and the current timestamp.
1223 */
1224 youngest_candidate_msg_ts = stream_iter->current_msg_ts_ns;
1225 youngest_candidate_stream_iter = stream_iter;
1226 } else if (ret == 0) {
1227 /*
1228 * Unable to pick which one should go
1229 * first.
1230 */
1231 BT_COMP_LOGW("Cannot deterministically pick next live stream message iterator because they have identical next messages: "
1232 "stream-iter-addr=%p"
1233 "stream-iter-addr=%p",
1234 stream_iter,
1235 youngest_candidate_stream_iter);
1236 }
1237 }
1238
1239 stream_iter_idx++;
1240 } else {
1241 /*
1242 * The live stream iterator has ended. That
1243 * iterator is removed from the array, but
1244 * there is no need to increment
1245 * stream_iter_idx as
1246 * g_ptr_array_remove_index_fast replaces the
1247 * removed element with the array's last
1248 * element.
1249 */
1250 g_ptr_array_remove_index_fast(
1251 live_trace->stream_iterators,
1252 stream_iter_idx);
1253 }
1254 }
1255
1256 if (youngest_candidate_stream_iter) {
1257 *youngest_trace_stream_iter = youngest_candidate_stream_iter;
1258 stream_iter_status = LTTNG_LIVE_ITERATOR_STATUS_OK;
1259 } else {
1260 /*
1261 * The only case where we don't have a candidate for this trace
1262 * is if we reached the end of all the iterators.
1263 */
1264 BT_ASSERT(live_trace->stream_iterators->len == 0);
1265 stream_iter_status = LTTNG_LIVE_ITERATOR_STATUS_END;
1266 }
1267
1268 end:
1269 return stream_iter_status;
1270 }
1271
1272 static
1273 enum lttng_live_iterator_status next_stream_iterator_for_session(
1274 struct lttng_live_msg_iter *lttng_live_msg_iter,
1275 struct lttng_live_session *session,
1276 struct lttng_live_stream_iterator **youngest_session_stream_iter)
1277 {
1278 bt_self_component *self_comp = lttng_live_msg_iter->self_comp;
1279 bt_logging_level log_level = lttng_live_msg_iter->log_level;
1280 enum lttng_live_iterator_status stream_iter_status;
1281 uint64_t trace_idx = 0;
1282 int64_t youngest_candidate_msg_ts = INT64_MAX;
1283 struct lttng_live_stream_iterator *youngest_candidate_stream_iter = NULL;
1284
1285 BT_COMP_LOGD("Finding the next stream iterator for session: "
1286 "session-id=%"PRIu64, session->id);
1287 /*
1288 * Make sure we are attached to the session and look for new streams
1289 * and metadata.
1290 */
1291 stream_iter_status = lttng_live_get_session(lttng_live_msg_iter, session);
1292 if (stream_iter_status != LTTNG_LIVE_ITERATOR_STATUS_OK &&
1293 stream_iter_status != LTTNG_LIVE_ITERATOR_STATUS_CONTINUE &&
1294 stream_iter_status != LTTNG_LIVE_ITERATOR_STATUS_END) {
1295 goto end;
1296 }
1297
1298 BT_ASSERT_DBG(session->traces);
1299
1300 while (trace_idx < session->traces->len) {
1301 bool trace_is_ended = false;
1302 struct lttng_live_stream_iterator *stream_iter;
1303 struct lttng_live_trace *trace =
1304 g_ptr_array_index(session->traces, trace_idx);
1305
1306 stream_iter_status = next_stream_iterator_for_trace(
1307 lttng_live_msg_iter, trace, &stream_iter);
1308 if (stream_iter_status == LTTNG_LIVE_ITERATOR_STATUS_END) {
1309 /*
1310 * All the live stream iterators for this trace are
1311 * ENDed. Remove the trace from this session.
1312 */
1313 trace_is_ended = true;
1314 } else if (stream_iter_status != LTTNG_LIVE_ITERATOR_STATUS_OK) {
1315 goto end;
1316 }
1317
1318 if (!trace_is_ended) {
1319 BT_ASSERT_DBG(stream_iter);
1320
1321 if (G_UNLIKELY(youngest_candidate_stream_iter == NULL) ||
1322 stream_iter->current_msg_ts_ns < youngest_candidate_msg_ts) {
1323 youngest_candidate_msg_ts = stream_iter->current_msg_ts_ns;
1324 youngest_candidate_stream_iter = stream_iter;
1325 } else if (stream_iter->current_msg_ts_ns == youngest_candidate_msg_ts) {
1326 /*
1327 * Order the messages in an arbitrary but
1328 * deterministic way.
1329 */
1330 int ret = common_muxing_compare_messages(
1331 stream_iter->current_msg,
1332 youngest_candidate_stream_iter->current_msg);
1333 if (ret < 0) {
1334 /*
1335 * The `youngest_candidate_stream_iter->current_msg`
1336 * should go first. Update the next iterator
1337 * and the current timestamp.
1338 */
1339 youngest_candidate_msg_ts = stream_iter->current_msg_ts_ns;
1340 youngest_candidate_stream_iter = stream_iter;
1341 } else if (ret == 0) {
1342 /* Unable to pick which one should go first. */
1343 BT_COMP_LOGW("Cannot deterministically pick next live stream message iterator because they have identical next messages: "
1344 "stream-iter-addr=%p" "stream-iter-addr=%p",
1345 stream_iter, youngest_candidate_stream_iter);
1346 }
1347 }
1348 trace_idx++;
1349 } else {
1350 /*
1351 * trace_idx is not incremented since
1352 * g_ptr_array_remove_index_fast replaces the
1353 * element at trace_idx with the array's last element.
1354 */
1355 g_ptr_array_remove_index_fast(session->traces,
1356 trace_idx);
1357 }
1358 }
1359 if (youngest_candidate_stream_iter) {
1360 *youngest_session_stream_iter = youngest_candidate_stream_iter;
1361 stream_iter_status = LTTNG_LIVE_ITERATOR_STATUS_OK;
1362 } else {
1363 /*
1364 * The only cases where we don't have a candidate for this
1365 * trace is:
1366 * 1. if we reached the end of all the iterators of all the
1367 * traces of this session,
1368 * 2. if we never had live stream iterator in the first place.
1369 *
1370 * In either cases, we return END.
1371 */
1372 BT_ASSERT(session->traces->len == 0);
1373 stream_iter_status = LTTNG_LIVE_ITERATOR_STATUS_END;
1374 }
1375 end:
1376 return stream_iter_status;
1377 }
1378
1379 static inline
1380 void put_messages(bt_message_array_const msgs, uint64_t count)
1381 {
1382 uint64_t i;
1383
1384 for (i = 0; i < count; i++) {
1385 BT_MESSAGE_PUT_REF_AND_RESET(msgs[i]);
1386 }
1387 }
1388
1389 BT_HIDDEN
1390 bt_message_iterator_class_next_method_status lttng_live_msg_iter_next(
1391 bt_self_message_iterator *self_msg_it,
1392 bt_message_array_const msgs, uint64_t capacity,
1393 uint64_t *count)
1394 {
1395 bt_message_iterator_class_next_method_status status;
1396 enum lttng_live_viewer_status viewer_status;
1397 struct lttng_live_msg_iter *lttng_live_msg_iter =
1398 bt_self_message_iterator_get_data(self_msg_it);
1399 struct lttng_live_component *lttng_live =
1400 lttng_live_msg_iter->lttng_live_comp;
1401 bt_self_component *self_comp = lttng_live_msg_iter->self_comp;
1402 bt_logging_level log_level = lttng_live_msg_iter->log_level;
1403 enum lttng_live_iterator_status stream_iter_status;
1404 uint64_t session_idx;
1405
1406 *count = 0;
1407
1408 BT_ASSERT_DBG(lttng_live_msg_iter);
1409
1410 if (G_UNLIKELY(lttng_live_msg_iter->was_interrupted)) {
1411 /*
1412 * The iterator was interrupted in a previous call to the
1413 * `_next()` method. We currently do not support generating
1414 * messages after such event. The babeltrace2 CLI should never
1415 * be running the graph after being interrupted. So this check
1416 * is to prevent other graph users from using this live
1417 * iterator in an messed up internal state.
1418 */
1419 status = BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_ERROR;
1420 BT_COMP_LOGE_APPEND_CAUSE(self_comp,
1421 "Message iterator was interrupted during a previous call to the `next()` and currently does not support continuing after such event.");
1422 goto end;
1423 }
1424
1425 /*
1426 * Clear all the invalid message reference that might be left over in
1427 * the output array.
1428 */
1429 memset(msgs, 0, capacity * sizeof(*msgs));
1430
1431 /*
1432 * If no session are exposed on the relay found at the url provided by
1433 * the user, session count will be 0. In this case, we return status
1434 * end to return gracefully.
1435 */
1436 if (lttng_live_msg_iter->sessions->len == 0) {
1437 if (lttng_live->params.sess_not_found_act !=
1438 SESSION_NOT_FOUND_ACTION_CONTINUE) {
1439 status = BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_END;
1440 goto end;
1441 } else {
1442 /*
1443 * The are no more active session for this session
1444 * name. Retry to create a viewer session for the
1445 * requested session name.
1446 */
1447 viewer_status = lttng_live_create_viewer_session(lttng_live_msg_iter);
1448 if (viewer_status != LTTNG_LIVE_VIEWER_STATUS_OK) {
1449 if (viewer_status == LTTNG_LIVE_VIEWER_STATUS_ERROR) {
1450 status = BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_ERROR;
1451 BT_COMP_LOGE_APPEND_CAUSE(self_comp,
1452 "Error creating LTTng live viewer session");
1453 } else if (viewer_status == LTTNG_LIVE_VIEWER_STATUS_INTERRUPTED) {
1454 status = BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_AGAIN;
1455 } else {
1456 bt_common_abort();
1457 }
1458 goto end;
1459 }
1460 }
1461 }
1462
1463 if (lttng_live_msg_iter->active_stream_iter == 0) {
1464 lttng_live_force_new_streams_and_metadata(lttng_live_msg_iter);
1465 }
1466
1467 /*
1468 * Here the muxing of message is done.
1469 *
1470 * We need to iterate over all the streams of all the traces of all the
1471 * viewer sessions in order to get the message with the smallest
1472 * timestamp. In this case, a session is a viewer session and there is
1473 * one viewer session per consumer daemon. (UST 32bit, UST 64bit and/or
1474 * kernel). Each viewer session can have multiple traces, for example,
1475 * 64bit UST viewer sessions could have multiple per-pid traces.
1476 *
1477 * We iterate over the streams of each traces to update and see what is
1478 * their next message's timestamp. From those timestamps, we select the
1479 * message with the smallest timestamp as the best candidate message
1480 * for that trace and do the same thing across all the sessions.
1481 *
1482 * We then compare the timestamp of best candidate message of all the
1483 * sessions to pick the message with the smallest timestamp and we
1484 * return it.
1485 */
1486 while (*count < capacity) {
1487 struct lttng_live_stream_iterator *youngest_stream_iter = NULL,
1488 *candidate_stream_iter = NULL;
1489 int64_t youngest_msg_ts_ns = INT64_MAX;
1490
1491 BT_ASSERT_DBG(lttng_live_msg_iter->sessions);
1492 session_idx = 0;
1493 while (session_idx < lttng_live_msg_iter->sessions->len) {
1494 struct lttng_live_session *session =
1495 g_ptr_array_index(lttng_live_msg_iter->sessions,
1496 session_idx);
1497
1498 /* Find the best candidate message to send downstream. */
1499 stream_iter_status = next_stream_iterator_for_session(
1500 lttng_live_msg_iter, session,
1501 &candidate_stream_iter);
1502
1503 /* If we receive an END status, it means that either:
1504 * - Those traces never had active streams (UST with no
1505 * data produced yet),
1506 * - All live stream iterators have ENDed.*/
1507 if (stream_iter_status == LTTNG_LIVE_ITERATOR_STATUS_END) {
1508 if (session->closed && session->traces->len == 0) {
1509 /*
1510 * Remove the session from the list.
1511 * session_idx is not modified since
1512 * g_ptr_array_remove_index_fast
1513 * replaces the the removed element with
1514 * the array's last element.
1515 */
1516 g_ptr_array_remove_index_fast(
1517 lttng_live_msg_iter->sessions,
1518 session_idx);
1519 } else {
1520 session_idx++;
1521 }
1522 continue;
1523 }
1524
1525 if (stream_iter_status != LTTNG_LIVE_ITERATOR_STATUS_OK) {
1526 goto return_status;
1527 }
1528
1529 if (G_UNLIKELY(youngest_stream_iter == NULL) ||
1530 candidate_stream_iter->current_msg_ts_ns < youngest_msg_ts_ns) {
1531 youngest_msg_ts_ns = candidate_stream_iter->current_msg_ts_ns;
1532 youngest_stream_iter = candidate_stream_iter;
1533 } else if (candidate_stream_iter->current_msg_ts_ns == youngest_msg_ts_ns) {
1534 /*
1535 * The currently selected message to be sent
1536 * downstream next has the exact same timestamp
1537 * that of the current candidate message. We
1538 * must break the tie in a predictable manner.
1539 */
1540 BT_COMP_LOGD_STR("Two of the next message candidates have the same timestamps, pick one deterministically.");
1541 /*
1542 * Order the messages in an arbitrary but
1543 * deterministic way.
1544 */
1545 int ret = common_muxing_compare_messages(
1546 candidate_stream_iter->current_msg,
1547 youngest_stream_iter->current_msg);
1548 if (ret < 0) {
1549 /*
1550 * The `candidate_stream_iter->current_msg`
1551 * should go first. Update the next
1552 * iterator and the current timestamp.
1553 */
1554 youngest_msg_ts_ns = candidate_stream_iter->current_msg_ts_ns;
1555 youngest_stream_iter = candidate_stream_iter;
1556 } else if (ret == 0) {
1557 /* Unable to pick which one should go first. */
1558 BT_COMP_LOGW("Cannot deterministically pick next live stream message iterator because they have identical next messages: "
1559 "next-stream-iter-addr=%p" "candidate-stream-iter-addr=%p",
1560 youngest_stream_iter, candidate_stream_iter);
1561 }
1562 }
1563
1564 session_idx++;
1565 }
1566
1567 if (!youngest_stream_iter) {
1568 stream_iter_status = LTTNG_LIVE_ITERATOR_STATUS_AGAIN;
1569 goto return_status;
1570 }
1571
1572 BT_ASSERT_DBG(youngest_stream_iter->current_msg);
1573 /* Ensure monotonicity. */
1574 BT_ASSERT_DBG(lttng_live_msg_iter->last_msg_ts_ns <=
1575 youngest_stream_iter->current_msg_ts_ns);
1576
1577 /*
1578 * Insert the next message to the message batch. This will set
1579 * stream iterator current messsage to NULL so that next time
1580 * we fetch the next message of that stream iterator
1581 */
1582 BT_MESSAGE_MOVE_REF(msgs[*count], youngest_stream_iter->current_msg);
1583 (*count)++;
1584
1585 /* Update the last timestamp in nanoseconds sent downstream. */
1586 lttng_live_msg_iter->last_msg_ts_ns = youngest_msg_ts_ns;
1587 youngest_stream_iter->current_msg_ts_ns = INT64_MAX;
1588
1589 stream_iter_status = LTTNG_LIVE_ITERATOR_STATUS_OK;
1590 }
1591
1592 return_status:
1593 switch (stream_iter_status) {
1594 case LTTNG_LIVE_ITERATOR_STATUS_OK:
1595 case LTTNG_LIVE_ITERATOR_STATUS_AGAIN:
1596 /*
1597 * If we gathered messages, return _OK even if the graph was
1598 * interrupted. This allows for the components downstream to at
1599 * least get the thoses messages. If the graph was indeed
1600 * interrupted there should not be another _next() call as the
1601 * application will tear down the graph. This component class
1602 * doesn't support restarting after an interruption.
1603 */
1604 if (*count > 0) {
1605 status = BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_OK;
1606 } else {
1607 status = BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_AGAIN;
1608 }
1609 break;
1610 case LTTNG_LIVE_ITERATOR_STATUS_END:
1611 status = BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_END;
1612 break;
1613 case LTTNG_LIVE_ITERATOR_STATUS_NOMEM:
1614 BT_COMP_LOGE_APPEND_CAUSE(self_comp,
1615 "Memory error preparing the next batch of messages: "
1616 "live-iter-status=%s",
1617 lttng_live_iterator_status_string(stream_iter_status));
1618 status = BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_MEMORY_ERROR;
1619 break;
1620 case LTTNG_LIVE_ITERATOR_STATUS_ERROR:
1621 case LTTNG_LIVE_ITERATOR_STATUS_INVAL:
1622 case LTTNG_LIVE_ITERATOR_STATUS_UNSUPPORTED:
1623 BT_COMP_LOGE_APPEND_CAUSE(self_comp,
1624 "Error preparing the next batch of messages: "
1625 "live-iter-status=%s",
1626 lttng_live_iterator_status_string(stream_iter_status));
1627
1628 status = BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_ERROR;
1629 /* Put all existing messages on error. */
1630 put_messages(msgs, *count);
1631 break;
1632 default:
1633 bt_common_abort();
1634 }
1635
1636 end:
1637 return status;
1638 }
1639
1640 static
1641 struct lttng_live_msg_iter *lttng_live_msg_iter_create(
1642 struct lttng_live_component *lttng_live_comp,
1643 bt_self_message_iterator *self_msg_it)
1644 {
1645 bt_self_component *self_comp = lttng_live_comp->self_comp;
1646 bt_logging_level log_level = lttng_live_comp->log_level;
1647
1648 struct lttng_live_msg_iter *lttng_live_msg_iter =
1649 g_new0(struct lttng_live_msg_iter, 1);
1650 if (!lttng_live_msg_iter) {
1651 BT_COMP_LOGE_APPEND_CAUSE(self_comp,
1652 "Failed to allocate lttng_live_msg_iter");
1653 goto end;
1654 }
1655
1656 lttng_live_msg_iter->log_level = lttng_live_comp->log_level;
1657 lttng_live_msg_iter->self_comp = lttng_live_comp->self_comp;
1658 lttng_live_msg_iter->lttng_live_comp = lttng_live_comp;
1659 lttng_live_msg_iter->self_msg_iter = self_msg_it;
1660
1661 lttng_live_msg_iter->active_stream_iter = 0;
1662 lttng_live_msg_iter->last_msg_ts_ns = INT64_MIN;
1663 lttng_live_msg_iter->was_interrupted = false;
1664
1665 lttng_live_msg_iter->sessions = g_ptr_array_new_with_free_func(
1666 (GDestroyNotify) lttng_live_destroy_session);
1667 BT_ASSERT(lttng_live_msg_iter->sessions);
1668
1669 end:
1670 return lttng_live_msg_iter;
1671
1672 }
1673
1674 BT_HIDDEN
1675 bt_message_iterator_class_initialize_method_status lttng_live_msg_iter_init(
1676 bt_self_message_iterator *self_msg_it,
1677 bt_self_message_iterator_configuration *config,
1678 bt_self_component_port_output *self_port)
1679 {
1680 bt_message_iterator_class_initialize_method_status status;
1681 struct lttng_live_component *lttng_live;
1682 struct lttng_live_msg_iter *lttng_live_msg_iter;
1683 enum lttng_live_viewer_status viewer_status;
1684 bt_logging_level log_level;
1685 bt_self_component *self_comp =
1686 bt_self_message_iterator_borrow_component(self_msg_it);
1687
1688 lttng_live = bt_self_component_get_data(self_comp);
1689 log_level = lttng_live->log_level;
1690 self_comp = lttng_live->self_comp;
1691
1692
1693 /* There can be only one downstream iterator at the same time. */
1694 BT_ASSERT(!lttng_live->has_msg_iter);
1695 lttng_live->has_msg_iter = true;
1696
1697 lttng_live_msg_iter = lttng_live_msg_iter_create(lttng_live,
1698 self_msg_it);
1699 if (!lttng_live_msg_iter) {
1700 status = BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_MEMORY_ERROR;
1701 BT_COMP_LOGE_APPEND_CAUSE(self_comp,
1702 "Failed to create lttng_live_msg_iter");
1703 goto error;
1704 }
1705
1706 viewer_status = live_viewer_connection_create(self_comp, NULL,
1707 log_level, lttng_live->params.url->str, false,
1708 lttng_live_msg_iter, &lttng_live_msg_iter->viewer_connection);
1709 if (viewer_status != LTTNG_LIVE_VIEWER_STATUS_OK) {
1710 if (viewer_status == LTTNG_LIVE_VIEWER_STATUS_ERROR) {
1711 BT_COMP_LOGE_APPEND_CAUSE(self_comp,
1712 "Failed to create viewer connection");
1713 } else if (viewer_status == LTTNG_LIVE_VIEWER_STATUS_INTERRUPTED) {
1714 /*
1715 * Interruption in the _iter_init() method is not
1716 * supported. Return an error.
1717 */
1718 BT_COMP_LOGE_APPEND_CAUSE(self_comp,
1719 "Interrupted while creating viewer connection");
1720 }
1721 goto error;
1722 }
1723
1724 viewer_status = lttng_live_create_viewer_session(lttng_live_msg_iter);
1725 if (viewer_status != LTTNG_LIVE_VIEWER_STATUS_OK) {
1726 if (viewer_status == LTTNG_LIVE_VIEWER_STATUS_ERROR) {
1727 BT_COMP_LOGE_APPEND_CAUSE(self_comp,
1728 "Failed to create viewer session");
1729 } else if (viewer_status == LTTNG_LIVE_VIEWER_STATUS_INTERRUPTED) {
1730 /*
1731 * Interruption in the _iter_init() method is not
1732 * supported. Return an error.
1733 */
1734 BT_COMP_LOGE_APPEND_CAUSE(self_comp,
1735 "Interrupted when creating viewer session");
1736 }
1737 goto error;
1738 }
1739
1740 if (lttng_live_msg_iter->sessions->len == 0) {
1741 switch (lttng_live->params.sess_not_found_act) {
1742 case SESSION_NOT_FOUND_ACTION_CONTINUE:
1743 BT_COMP_LOGI("Unable to connect to the requested live viewer session. Keep trying to connect because of "
1744 "%s=\"%s\" component parameter: url=\"%s\"",
1745 SESS_NOT_FOUND_ACTION_PARAM,
1746 SESS_NOT_FOUND_ACTION_CONTINUE_STR,
1747 lttng_live->params.url->str);
1748 break;
1749 case SESSION_NOT_FOUND_ACTION_FAIL:
1750 BT_COMP_LOGE_APPEND_CAUSE(self_comp,
1751 "Unable to connect to the requested live viewer session. Fail the message iterator initialization because of %s=\"%s\" "
1752 "component parameter: url =\"%s\"",
1753 SESS_NOT_FOUND_ACTION_PARAM,
1754 SESS_NOT_FOUND_ACTION_FAIL_STR,
1755 lttng_live->params.url->str);
1756 goto error;
1757 case SESSION_NOT_FOUND_ACTION_END:
1758 BT_COMP_LOGI("Unable to connect to the requested live viewer session. End gracefully at the first _next() "
1759 "call because of %s=\"%s\" component parameter: "
1760 "url=\"%s\"", SESS_NOT_FOUND_ACTION_PARAM,
1761 SESS_NOT_FOUND_ACTION_END_STR,
1762 lttng_live->params.url->str);
1763 break;
1764 default:
1765 bt_common_abort();
1766 }
1767 }
1768
1769 bt_self_message_iterator_set_data(self_msg_it, lttng_live_msg_iter);
1770 status = BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_OK;
1771 goto end;
1772
1773 error:
1774 status = BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_ERROR;
1775 lttng_live_msg_iter_destroy(lttng_live_msg_iter);
1776 end:
1777 return status;
1778 }
1779
1780 static struct bt_param_validation_map_value_entry_descr list_sessions_params[] = {
1781 { URL_PARAM, BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_MANDATORY, { .type = BT_VALUE_TYPE_STRING } },
1782 BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_END
1783 };
1784
1785 static
1786 bt_component_class_query_method_status lttng_live_query_list_sessions(
1787 const bt_value *params, const bt_value **result,
1788 bt_self_component_class *self_comp_class,
1789 bt_logging_level log_level)
1790 {
1791 bt_component_class_query_method_status status;
1792 const bt_value *url_value = NULL;
1793 const char *url;
1794 struct live_viewer_connection *viewer_connection = NULL;
1795 enum lttng_live_viewer_status viewer_status;
1796 enum bt_param_validation_status validation_status;
1797 gchar *validate_error = NULL;
1798
1799 validation_status = bt_param_validation_validate(params,
1800 list_sessions_params, &validate_error);
1801 if (validation_status == BT_PARAM_VALIDATION_STATUS_MEMORY_ERROR) {
1802 status = BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_MEMORY_ERROR;
1803 goto error;
1804 } else if (validation_status == BT_PARAM_VALIDATION_STATUS_VALIDATION_ERROR) {
1805 status = BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_ERROR;
1806 BT_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp_class, "%s",
1807 validate_error);
1808 goto error;
1809 }
1810
1811 url_value = bt_value_map_borrow_entry_value_const(params, URL_PARAM);
1812 url = bt_value_string_get(url_value);
1813
1814 viewer_status = live_viewer_connection_create(NULL, self_comp_class,
1815 log_level, url, true, NULL, &viewer_connection);
1816 if (viewer_status != LTTNG_LIVE_VIEWER_STATUS_OK) {
1817 if (viewer_status == LTTNG_LIVE_VIEWER_STATUS_ERROR) {
1818 BT_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp_class,
1819 "Failed to create viewer connection");
1820 status = BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_ERROR;
1821 } else if (viewer_status == LTTNG_LIVE_VIEWER_STATUS_INTERRUPTED) {
1822 status = BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_AGAIN;
1823 } else {
1824 bt_common_abort();
1825 }
1826 goto error;
1827 }
1828
1829 status = live_viewer_connection_list_sessions(viewer_connection,
1830 result);
1831 if (status != BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_OK) {
1832 BT_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp_class,
1833 "Failed to list viewer sessions");
1834 goto error;
1835 }
1836
1837 goto end;
1838
1839 error:
1840 BT_VALUE_PUT_REF_AND_RESET(*result);
1841
1842 if (status >= 0) {
1843 status = BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_ERROR;
1844 }
1845
1846 end:
1847 if (viewer_connection) {
1848 live_viewer_connection_destroy(viewer_connection);
1849 }
1850
1851 g_free(validate_error);
1852
1853 return status;
1854 }
1855
1856 static
1857 bt_component_class_query_method_status lttng_live_query_support_info(
1858 const bt_value *params, const bt_value **result,
1859 bt_self_component_class *self_comp_class,
1860 bt_logging_level log_level)
1861 {
1862 bt_component_class_query_method_status status =
1863 BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_OK;
1864 const bt_value *input_type_value;
1865 const bt_value *input_value;
1866 double weight = 0;
1867 struct bt_common_lttng_live_url_parts parts = { 0 };
1868
1869 /* Used by the logging macros */
1870 __attribute__((unused)) bt_self_component *self_comp = NULL;
1871
1872 *result = NULL;
1873 input_type_value = bt_value_map_borrow_entry_value_const(params,
1874 "type");
1875 if (!input_type_value) {
1876 BT_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp_class,
1877 "Missing expected `type` parameter.");
1878 goto error;
1879 }
1880
1881 if (!bt_value_is_string(input_type_value)) {
1882 BT_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp_class,
1883 "`type` parameter is not a string value.");
1884 goto error;
1885 }
1886
1887 if (strcmp(bt_value_string_get(input_type_value), "string") != 0) {
1888 /* We don't handle file system paths */
1889 goto create_result;
1890 }
1891
1892 input_value = bt_value_map_borrow_entry_value_const(params, "input");
1893 if (!input_value) {
1894 BT_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp_class,
1895 "Missing expected `input` parameter.");
1896 goto error;
1897 }
1898
1899 if (!bt_value_is_string(input_value)) {
1900 BT_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp_class,
1901 "`input` parameter is not a string value.");
1902 goto error;
1903 }
1904
1905 parts = bt_common_parse_lttng_live_url(bt_value_string_get(input_value),
1906 NULL, 0);
1907 if (parts.session_name) {
1908 /*
1909 * Looks pretty much like an LTTng live URL: we got the
1910 * session name part, which forms a complete URL.
1911 */
1912 weight = .75;
1913 }
1914
1915 create_result:
1916 *result = bt_value_real_create_init(weight);
1917 if (!*result) {
1918 status = BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_MEMORY_ERROR;
1919 goto error;
1920 }
1921
1922 goto end;
1923
1924 error:
1925 if (status >= 0) {
1926 status = BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_ERROR;
1927 }
1928
1929 BT_ASSERT(!*result);
1930
1931 end:
1932 bt_common_destroy_lttng_live_url_parts(&parts);
1933 return status;
1934 }
1935
1936 BT_HIDDEN
1937 bt_component_class_query_method_status lttng_live_query(
1938 bt_self_component_class_source *comp_class,
1939 bt_private_query_executor *priv_query_exec,
1940 const char *object, const bt_value *params,
1941 __attribute__((unused)) void *method_data,
1942 const bt_value **result)
1943 {
1944 bt_component_class_query_method_status status =
1945 BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_OK;
1946 bt_self_component *self_comp = NULL;
1947 bt_self_component_class *self_comp_class =
1948 bt_self_component_class_source_as_self_component_class(comp_class);
1949 bt_logging_level log_level = bt_query_executor_get_logging_level(
1950 bt_private_query_executor_as_query_executor_const(
1951 priv_query_exec));
1952
1953 if (strcmp(object, "sessions") == 0) {
1954 status = lttng_live_query_list_sessions(params, result,
1955 self_comp_class, log_level);
1956 } else if (strcmp(object, "babeltrace.support-info") == 0) {
1957 status = lttng_live_query_support_info(params, result,
1958 self_comp_class, log_level);
1959 } else {
1960 BT_COMP_LOGI("Unknown query object `%s`", object);
1961 status = BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_UNKNOWN_OBJECT;
1962 goto end;
1963 }
1964
1965 end:
1966 return status;
1967 }
1968
1969 static
1970 void lttng_live_component_destroy_data(struct lttng_live_component *lttng_live)
1971 {
1972 if (!lttng_live) {
1973 return;
1974 }
1975 if (lttng_live->params.url) {
1976 g_string_free(lttng_live->params.url, TRUE);
1977 }
1978 g_free(lttng_live);
1979 }
1980
1981 BT_HIDDEN
1982 void lttng_live_component_finalize(bt_self_component_source *component)
1983 {
1984 void *data = bt_self_component_get_data(
1985 bt_self_component_source_as_self_component(component));
1986
1987 if (!data) {
1988 return;
1989 }
1990 lttng_live_component_destroy_data(data);
1991 }
1992
1993 static
1994 enum session_not_found_action parse_session_not_found_action_param(
1995 const bt_value *no_session_param)
1996 {
1997 enum session_not_found_action action;
1998 const char *no_session_act_str = bt_value_string_get(no_session_param);
1999
2000 if (strcmp(no_session_act_str, SESS_NOT_FOUND_ACTION_CONTINUE_STR) == 0) {
2001 action = SESSION_NOT_FOUND_ACTION_CONTINUE;
2002 } else if (strcmp(no_session_act_str, SESS_NOT_FOUND_ACTION_FAIL_STR) == 0) {
2003 action = SESSION_NOT_FOUND_ACTION_FAIL;
2004 } else {
2005 BT_ASSERT(strcmp(no_session_act_str, SESS_NOT_FOUND_ACTION_END_STR) == 0);
2006 action = SESSION_NOT_FOUND_ACTION_END;
2007 }
2008
2009 return action;
2010 }
2011
2012 static struct bt_param_validation_value_descr inputs_elem_descr = {
2013 .type = BT_VALUE_TYPE_STRING,
2014 };
2015
2016 static const char *sess_not_found_action_choices[] = {
2017 SESS_NOT_FOUND_ACTION_CONTINUE_STR,
2018 SESS_NOT_FOUND_ACTION_FAIL_STR,
2019 SESS_NOT_FOUND_ACTION_END_STR,
2020 };
2021
2022 static struct bt_param_validation_map_value_entry_descr params_descr[] = {
2023 { INPUTS_PARAM, BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_MANDATORY, { BT_VALUE_TYPE_ARRAY, .array = {
2024 .min_length = 1,
2025 .max_length = 1,
2026 .element_type = &inputs_elem_descr,
2027 } } },
2028 { SESS_NOT_FOUND_ACTION_PARAM, BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL, { BT_VALUE_TYPE_STRING, .string = {
2029 .choices = sess_not_found_action_choices,
2030 } } },
2031 BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_END
2032 };
2033
2034 static
2035 bt_component_class_initialize_method_status lttng_live_component_create(
2036 const bt_value *params,
2037 bt_logging_level log_level,
2038 bt_self_component *self_comp,
2039 struct lttng_live_component **component)
2040 {
2041 struct lttng_live_component *lttng_live = NULL;
2042 const bt_value *inputs_value;
2043 const bt_value *url_value;
2044 const bt_value *value;
2045 const char *url;
2046 enum bt_param_validation_status validation_status;
2047 gchar *validation_error = NULL;
2048 bt_component_class_initialize_method_status status;
2049
2050 validation_status = bt_param_validation_validate(params, params_descr,
2051 &validation_error);
2052 if (validation_status == BT_PARAM_VALIDATION_STATUS_MEMORY_ERROR) {
2053 status = BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_MEMORY_ERROR;
2054 goto error;
2055 } else if (validation_status == BT_PARAM_VALIDATION_STATUS_VALIDATION_ERROR) {
2056 BT_COMP_LOGE_APPEND_CAUSE(self_comp, "%s", validation_error);
2057 status = BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_ERROR;
2058 goto error;
2059 }
2060
2061 lttng_live = g_new0(struct lttng_live_component, 1);
2062 if (!lttng_live) {
2063 status = BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_MEMORY_ERROR;
2064 goto end;
2065 }
2066 lttng_live->log_level = log_level;
2067 lttng_live->self_comp = self_comp;
2068 lttng_live->max_query_size = MAX_QUERY_SIZE;
2069 lttng_live->has_msg_iter = false;
2070
2071 inputs_value =
2072 bt_value_map_borrow_entry_value_const(params, INPUTS_PARAM);
2073 url_value =
2074 bt_value_array_borrow_element_by_index_const(inputs_value, 0);
2075 url = bt_value_string_get(url_value);
2076
2077 lttng_live->params.url = g_string_new(url);
2078 if (!lttng_live->params.url) {
2079 status = BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_MEMORY_ERROR;
2080 goto error;
2081 }
2082
2083 value = bt_value_map_borrow_entry_value_const(params,
2084 SESS_NOT_FOUND_ACTION_PARAM);
2085 if (value) {
2086 lttng_live->params.sess_not_found_act =
2087 parse_session_not_found_action_param(value);
2088 } else {
2089 BT_COMP_LOGI("Optional `%s` parameter is missing: "
2090 "defaulting to `%s`.",
2091 SESS_NOT_FOUND_ACTION_PARAM,
2092 SESS_NOT_FOUND_ACTION_CONTINUE_STR);
2093 lttng_live->params.sess_not_found_act =
2094 SESSION_NOT_FOUND_ACTION_CONTINUE;
2095 }
2096
2097 status = BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_OK;
2098 goto end;
2099
2100 error:
2101 lttng_live_component_destroy_data(lttng_live);
2102 lttng_live = NULL;
2103 end:
2104 g_free(validation_error);
2105
2106 *component = lttng_live;
2107 return status;
2108 }
2109
2110 BT_HIDDEN
2111 bt_component_class_initialize_method_status lttng_live_component_init(
2112 bt_self_component_source *self_comp_src,
2113 bt_self_component_source_configuration *config,
2114 const bt_value *params,
2115 __attribute__((unused)) void *init_method_data)
2116 {
2117 struct lttng_live_component *lttng_live;
2118 bt_component_class_initialize_method_status ret;
2119 bt_self_component *self_comp =
2120 bt_self_component_source_as_self_component(self_comp_src);
2121 bt_logging_level log_level = bt_component_get_logging_level(
2122 bt_self_component_as_component(self_comp));
2123 bt_self_component_add_port_status add_port_status;
2124
2125 ret = lttng_live_component_create(params, log_level, self_comp, &lttng_live);
2126 if (ret != BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_OK) {
2127 goto error;
2128 }
2129
2130 add_port_status = bt_self_component_source_add_output_port(
2131 self_comp_src, "out", NULL, NULL);
2132 if (add_port_status != BT_SELF_COMPONENT_ADD_PORT_STATUS_OK) {
2133 ret = (int) add_port_status;
2134 goto end;
2135 }
2136
2137 bt_self_component_set_data(self_comp, lttng_live);
2138 goto end;
2139
2140 error:
2141 lttng_live_component_destroy_data(lttng_live);
2142 lttng_live = NULL;
2143 end:
2144 return ret;
2145 }
BabelTrace - Trace Format Babel Tower
This page took 0.107849 seconds and 4 git commands to generate.