projects / babeltrace.git / blob
? search:


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