projects / babeltrace.git / blob
? search:


bef21b09ce38823a30456b06b06860bdfaa92c0e
[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_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_ERROR:
839 default:
840 ret = LTTNG_LIVE_ITERATOR_STATUS_ERROR;
841 BT_COMP_LOGE_APPEND_CAUSE(self_comp,
842 "CTF message iterator failed to get next message: "
843 "msg-iter=%p, msg-iter-status=%s",
844 lttng_live_stream->msg_iter,
845 ctf_msg_iter_status_string(status));
846 break;
847 }
848
849 end:
850 return ret;
851 }
852
853 static
854 enum lttng_live_iterator_status lttng_live_iterator_close_stream(
855 struct lttng_live_msg_iter *lttng_live_msg_iter,
856 struct lttng_live_stream_iterator *stream_iter,
857 const bt_message **curr_msg)
858 {
859 enum lttng_live_iterator_status live_status =
860 LTTNG_LIVE_ITERATOR_STATUS_OK;
861 bt_logging_level log_level = lttng_live_msg_iter->log_level;
862 bt_self_component *self_comp = lttng_live_msg_iter->self_comp;
863 /*
864 * The viewer has hung up on us so we are closing the stream. The
865 * `ctf_msg_iter` should simply realize that it needs to close the
866 * stream properly by emitting the necessary stream end message.
867 */
868 enum ctf_msg_iter_status status = ctf_msg_iter_get_next_message(
869 stream_iter->msg_iter, curr_msg);
870
871 if (status == CTF_MSG_ITER_STATUS_ERROR) {
872 BT_COMP_LOGE_APPEND_CAUSE(self_comp,
873 "Error getting the next message from CTF message iterator");
874 live_status = LTTNG_LIVE_ITERATOR_STATUS_ERROR;
875 goto end;
876 } else if (status == CTF_MSG_ITER_STATUS_EOF) {
877 BT_COMP_LOGI("Reached the end of the live stream iterator.");
878 live_status = LTTNG_LIVE_ITERATOR_STATUS_END;
879 goto end;
880 }
881
882 BT_ASSERT(status == CTF_MSG_ITER_STATUS_OK);
883
884 end:
885 return live_status;
886 }
887
888 /*
889 * helper function:
890 * handle_no_data_streams()
891 * retry:
892 * - for each ACTIVE_NO_DATA stream:
893 * - query relayd for stream data, or quiescence info.
894 * - if need metadata, get metadata, goto retry.
895 * - if new stream, get new stream as ACTIVE_NO_DATA, goto retry
896 * - if quiescent, move to QUIESCENT streams
897 * - if fetched data, move to ACTIVE_DATA streams
898 * (at this point each stream either has data, or is quiescent)
899 *
900 *
901 * iterator_next:
902 * handle_new_streams_and_metadata()
903 * - query relayd for known streams, add them as ACTIVE_NO_DATA
904 * - query relayd for metadata
905 *
906 * call handle_active_no_data_streams()
907 *
908 * handle_quiescent_streams()
909 * - if at least one stream is ACTIVE_DATA:
910 * - peek stream event with lowest timestamp -> next_ts
911 * - for each quiescent stream
912 * - if next_ts >= quiescent end
913 * - set state to ACTIVE_NO_DATA
914 * - else
915 * - for each quiescent stream
916 * - set state to ACTIVE_NO_DATA
917 *
918 * call handle_active_no_data_streams()
919 *
920 * handle_active_data_streams()
921 * - if at least one stream is ACTIVE_DATA:
922 * - get stream event with lowest timestamp from heap
923 * - make that stream event the current message.
924 * - move this stream heap position to its next event
925 * - if we need to fetch data from relayd, move
926 * stream to ACTIVE_NO_DATA.
927 * - return OK
928 * - return AGAIN
929 *
930 * end criterion: ctrl-c on client. If relayd exits or the session
931 * closes on the relay daemon side, we keep on waiting for streams.
932 * Eventually handle --end timestamp (also an end criterion).
933 *
934 * When disconnected from relayd: try to re-connect endlessly.
935 */
936 static
937 enum lttng_live_iterator_status lttng_live_iterator_next_msg_on_stream(
938 struct lttng_live_msg_iter *lttng_live_msg_iter,
939 struct lttng_live_stream_iterator *stream_iter,
940 const bt_message **curr_msg)
941 {
942 bt_logging_level log_level = lttng_live_msg_iter->log_level;
943 bt_self_component *self_comp = lttng_live_msg_iter->self_comp;
944 enum lttng_live_iterator_status live_status;
945
946 BT_COMP_LOGD("Finding the next message for stream iterator: "
947 "stream-name=\"%s\"", stream_iter->name->str);
948
949 if (stream_iter->has_stream_hung_up) {
950 /*
951 * The stream has hung up and the stream was properly closed
952 * during the last call to the current function. Return _END
953 * status now so that this stream iterator is removed for the
954 * stream iterator list.
955 */
956 live_status = LTTNG_LIVE_ITERATOR_STATUS_END;
957 goto end;
958 }
959
960 retry:
961 LTTNG_LIVE_LOGD_STREAM_ITER(stream_iter);
962 live_status = lttng_live_iterator_handle_new_streams_and_metadata(
963 lttng_live_msg_iter);
964 if (live_status != LTTNG_LIVE_ITERATOR_STATUS_OK) {
965 goto end;
966 }
967 live_status = lttng_live_iterator_next_handle_one_no_data_stream(
968 lttng_live_msg_iter, stream_iter);
969
970 if (live_status != LTTNG_LIVE_ITERATOR_STATUS_OK) {
971 if (live_status == LTTNG_LIVE_ITERATOR_STATUS_END) {
972 /*
973 * We overwrite `live_status` since `curr_msg` is
974 * likely set to a valid message in this function.
975 */
976 live_status = lttng_live_iterator_close_stream(
977 lttng_live_msg_iter, stream_iter, curr_msg);
978 }
979 goto end;
980 }
981 live_status = lttng_live_iterator_next_handle_one_quiescent_stream(
982 lttng_live_msg_iter, stream_iter, curr_msg);
983 if (live_status != LTTNG_LIVE_ITERATOR_STATUS_OK) {
984 BT_ASSERT(!*curr_msg);
985 goto end;
986 }
987 if (*curr_msg) {
988 goto end;
989 }
990 live_status = lttng_live_iterator_next_handle_one_active_data_stream(
991 lttng_live_msg_iter, stream_iter, curr_msg);
992 if (live_status != LTTNG_LIVE_ITERATOR_STATUS_OK) {
993 BT_ASSERT(!*curr_msg);
994 }
995
996 end:
997 if (live_status == LTTNG_LIVE_ITERATOR_STATUS_CONTINUE) {
998 goto retry;
999 }
1000
1001 return live_status;
1002 }
1003
1004 static
1005 enum lttng_live_iterator_status next_stream_iterator_for_trace(
1006 struct lttng_live_msg_iter *lttng_live_msg_iter,
1007 struct lttng_live_trace *live_trace,
1008 struct lttng_live_stream_iterator **youngest_trace_stream_iter)
1009 {
1010 struct lttng_live_stream_iterator *youngest_candidate_stream_iter = NULL;
1011 bt_logging_level log_level = lttng_live_msg_iter->log_level;
1012 bt_self_component *self_comp = lttng_live_msg_iter->self_comp;
1013 enum lttng_live_iterator_status stream_iter_status;;
1014 int64_t youngest_candidate_msg_ts = INT64_MAX;
1015 uint64_t stream_iter_idx;
1016
1017 BT_ASSERT_DBG(live_trace);
1018 BT_ASSERT_DBG(live_trace->stream_iterators);
1019
1020 BT_COMP_LOGD("Finding the next stream iterator for trace: "
1021 "trace-id=%"PRIu64, live_trace->id);
1022 /*
1023 * Update the current message of every stream iterators of this trace.
1024 * The current msg of every stream must have a timestamp equal or
1025 * larger than the last message returned by this iterator. We must
1026 * ensure monotonicity.
1027 */
1028 stream_iter_idx = 0;
1029 while (stream_iter_idx < live_trace->stream_iterators->len) {
1030 bool stream_iter_is_ended = false;
1031 struct lttng_live_stream_iterator *stream_iter =
1032 g_ptr_array_index(live_trace->stream_iterators,
1033 stream_iter_idx);
1034
1035 /*
1036 * Find if there is are now current message for this stream
1037 * iterator get it.
1038 */
1039 while (!stream_iter->current_msg) {
1040 const bt_message *msg = NULL;
1041 int64_t curr_msg_ts_ns = INT64_MAX;
1042 stream_iter_status = lttng_live_iterator_next_msg_on_stream(
1043 lttng_live_msg_iter, stream_iter, &msg);
1044
1045 BT_COMP_LOGD("live stream iterator returned status :%s",
1046 lttng_live_iterator_status_string(stream_iter_status));
1047 if (stream_iter_status == LTTNG_LIVE_ITERATOR_STATUS_END) {
1048 stream_iter_is_ended = true;
1049 break;
1050 }
1051
1052 if (stream_iter_status != LTTNG_LIVE_ITERATOR_STATUS_OK) {
1053 goto end;
1054 }
1055
1056 BT_ASSERT_DBG(msg);
1057
1058 /*
1059 * Get the timestamp in nanoseconds from origin of this
1060 * messsage.
1061 */
1062 live_get_msg_ts_ns(stream_iter, lttng_live_msg_iter,
1063 msg, lttng_live_msg_iter->last_msg_ts_ns,
1064 &curr_msg_ts_ns);
1065
1066 /*
1067 * Check if the message of the current live stream
1068 * iterator occured at the exact same time or after the
1069 * last message returned by this component's message
1070 * iterator. If not, we return an error.
1071 */
1072 if (curr_msg_ts_ns >= lttng_live_msg_iter->last_msg_ts_ns) {
1073 stream_iter->current_msg = msg;
1074 stream_iter->current_msg_ts_ns = curr_msg_ts_ns;
1075 } else {
1076 /*
1077 * We received a message in the past. To ensure
1078 * monotonicity, we can't send it forward.
1079 */
1080 BT_COMP_LOGE_APPEND_CAUSE(self_comp,
1081 "Message's timestamp is less than "
1082 "lttng-live's message iterator's last "
1083 "returned timestamp: "
1084 "lttng-live-msg-iter-addr=%p, ts=%" PRId64 ", "
1085 "last-msg-ts=%" PRId64,
1086 lttng_live_msg_iter, curr_msg_ts_ns,
1087 lttng_live_msg_iter->last_msg_ts_ns);
1088 stream_iter_status = LTTNG_LIVE_ITERATOR_STATUS_ERROR;
1089 goto end;
1090 }
1091 }
1092
1093 BT_ASSERT_DBG(stream_iter != youngest_candidate_stream_iter);
1094
1095 if (!stream_iter_is_ended) {
1096 if (G_UNLIKELY(youngest_candidate_stream_iter == NULL) ||
1097 stream_iter->current_msg_ts_ns < youngest_candidate_msg_ts) {
1098 /*
1099 * Update the current best candidate message
1100 * for the stream iterator of this live trace
1101 * to be forwarded downstream.
1102 */
1103 youngest_candidate_msg_ts = stream_iter->current_msg_ts_ns;
1104 youngest_candidate_stream_iter = stream_iter;
1105 } else if (stream_iter->current_msg_ts_ns == youngest_candidate_msg_ts) {
1106 /*
1107 * Order the messages in an arbitrary but
1108 * deterministic way.
1109 */
1110 BT_ASSERT_DBG(stream_iter != youngest_candidate_stream_iter);
1111 int ret = common_muxing_compare_messages(
1112 stream_iter->current_msg,
1113 youngest_candidate_stream_iter->current_msg);
1114 if (ret < 0) {
1115 /*
1116 * The `youngest_candidate_stream_iter->current_msg`
1117 * should go first. Update the next
1118 * iterator and the current timestamp.
1119 */
1120 youngest_candidate_msg_ts = stream_iter->current_msg_ts_ns;
1121 youngest_candidate_stream_iter = stream_iter;
1122 } else if (ret == 0) {
1123 /*
1124 * Unable to pick which one should go
1125 * first.
1126 */
1127 BT_COMP_LOGW("Cannot deterministically pick next live stream message iterator because they have identical next messages: "
1128 "stream-iter-addr=%p"
1129 "stream-iter-addr=%p",
1130 stream_iter,
1131 youngest_candidate_stream_iter);
1132 }
1133 }
1134
1135 stream_iter_idx++;
1136 } else {
1137 /*
1138 * The live stream iterator has ended. That
1139 * iterator is removed from the array, but
1140 * there is no need to increment
1141 * stream_iter_idx as
1142 * g_ptr_array_remove_index_fast replaces the
1143 * removed element with the array's last
1144 * element.
1145 */
1146 g_ptr_array_remove_index_fast(
1147 live_trace->stream_iterators,
1148 stream_iter_idx);
1149 }
1150 }
1151
1152 if (youngest_candidate_stream_iter) {
1153 *youngest_trace_stream_iter = youngest_candidate_stream_iter;
1154 stream_iter_status = LTTNG_LIVE_ITERATOR_STATUS_OK;
1155 } else {
1156 /*
1157 * The only case where we don't have a candidate for this trace
1158 * is if we reached the end of all the iterators.
1159 */
1160 BT_ASSERT(live_trace->stream_iterators->len == 0);
1161 stream_iter_status = LTTNG_LIVE_ITERATOR_STATUS_END;
1162 }
1163
1164 end:
1165 return stream_iter_status;
1166 }
1167
1168 static
1169 enum lttng_live_iterator_status next_stream_iterator_for_session(
1170 struct lttng_live_msg_iter *lttng_live_msg_iter,
1171 struct lttng_live_session *session,
1172 struct lttng_live_stream_iterator **youngest_session_stream_iter)
1173 {
1174 bt_self_component *self_comp = lttng_live_msg_iter->self_comp;
1175 bt_logging_level log_level = lttng_live_msg_iter->log_level;
1176 enum lttng_live_iterator_status stream_iter_status;
1177 uint64_t trace_idx = 0;
1178 int64_t youngest_candidate_msg_ts = INT64_MAX;
1179 struct lttng_live_stream_iterator *youngest_candidate_stream_iter = NULL;
1180
1181 BT_COMP_LOGD("Finding the next stream iterator for session: "
1182 "session-id=%"PRIu64, session->id);
1183 /*
1184 * Make sure we are attached to the session and look for new streams
1185 * and metadata.
1186 */
1187 stream_iter_status = lttng_live_get_session(lttng_live_msg_iter, session);
1188 if (stream_iter_status != LTTNG_LIVE_ITERATOR_STATUS_OK &&
1189 stream_iter_status != LTTNG_LIVE_ITERATOR_STATUS_CONTINUE &&
1190 stream_iter_status != LTTNG_LIVE_ITERATOR_STATUS_END) {
1191 goto end;
1192 }
1193
1194 BT_ASSERT_DBG(session->traces);
1195
1196 while (trace_idx < session->traces->len) {
1197 bool trace_is_ended = false;
1198 struct lttng_live_stream_iterator *stream_iter;
1199 struct lttng_live_trace *trace =
1200 g_ptr_array_index(session->traces, trace_idx);
1201
1202 stream_iter_status = next_stream_iterator_for_trace(
1203 lttng_live_msg_iter, trace, &stream_iter);
1204 if (stream_iter_status == LTTNG_LIVE_ITERATOR_STATUS_END) {
1205 /*
1206 * All the live stream iterators for this trace are
1207 * ENDed. Remove the trace from this session.
1208 */
1209 trace_is_ended = true;
1210 } else if (stream_iter_status != LTTNG_LIVE_ITERATOR_STATUS_OK) {
1211 goto end;
1212 }
1213
1214 if (!trace_is_ended) {
1215 BT_ASSERT_DBG(stream_iter);
1216
1217 if (G_UNLIKELY(youngest_candidate_stream_iter == NULL) ||
1218 stream_iter->current_msg_ts_ns < youngest_candidate_msg_ts) {
1219 youngest_candidate_msg_ts = stream_iter->current_msg_ts_ns;
1220 youngest_candidate_stream_iter = stream_iter;
1221 } else if (stream_iter->current_msg_ts_ns == youngest_candidate_msg_ts) {
1222 /*
1223 * Order the messages in an arbitrary but
1224 * deterministic way.
1225 */
1226 int ret = common_muxing_compare_messages(
1227 stream_iter->current_msg,
1228 youngest_candidate_stream_iter->current_msg);
1229 if (ret < 0) {
1230 /*
1231 * The `youngest_candidate_stream_iter->current_msg`
1232 * should go first. Update the next iterator
1233 * and the current timestamp.
1234 */
1235 youngest_candidate_msg_ts = stream_iter->current_msg_ts_ns;
1236 youngest_candidate_stream_iter = stream_iter;
1237 } else if (ret == 0) {
1238 /* Unable to pick which one should go first. */
1239 BT_COMP_LOGW("Cannot deterministically pick next live stream message iterator because they have identical next messages: "
1240 "stream-iter-addr=%p" "stream-iter-addr=%p",
1241 stream_iter, youngest_candidate_stream_iter);
1242 }
1243 }
1244 trace_idx++;
1245 } else {
1246 /*
1247 * trace_idx is not incremented since
1248 * g_ptr_array_remove_index_fast replaces the
1249 * element at trace_idx with the array's last element.
1250 */
1251 g_ptr_array_remove_index_fast(session->traces,
1252 trace_idx);
1253 }
1254 }
1255 if (youngest_candidate_stream_iter) {
1256 *youngest_session_stream_iter = youngest_candidate_stream_iter;
1257 stream_iter_status = LTTNG_LIVE_ITERATOR_STATUS_OK;
1258 } else {
1259 /*
1260 * The only cases where we don't have a candidate for this
1261 * trace is:
1262 * 1. if we reached the end of all the iterators of all the
1263 * traces of this session,
1264 * 2. if we never had live stream iterator in the first place.
1265 *
1266 * In either cases, we return END.
1267 */
1268 BT_ASSERT(session->traces->len == 0);
1269 stream_iter_status = LTTNG_LIVE_ITERATOR_STATUS_END;
1270 }
1271 end:
1272 return stream_iter_status;
1273 }
1274
1275 static inline
1276 void put_messages(bt_message_array_const msgs, uint64_t count)
1277 {
1278 uint64_t i;
1279
1280 for (i = 0; i < count; i++) {
1281 BT_MESSAGE_PUT_REF_AND_RESET(msgs[i]);
1282 }
1283 }
1284
1285 BT_HIDDEN
1286 bt_message_iterator_class_next_method_status lttng_live_msg_iter_next(
1287 bt_self_message_iterator *self_msg_it,
1288 bt_message_array_const msgs, uint64_t capacity,
1289 uint64_t *count)
1290 {
1291 bt_message_iterator_class_next_method_status status;
1292 enum lttng_live_viewer_status viewer_status;
1293 struct lttng_live_msg_iter *lttng_live_msg_iter =
1294 bt_self_message_iterator_get_data(self_msg_it);
1295 struct lttng_live_component *lttng_live =
1296 lttng_live_msg_iter->lttng_live_comp;
1297 bt_self_component *self_comp = lttng_live_msg_iter->self_comp;
1298 bt_logging_level log_level = lttng_live_msg_iter->log_level;
1299 enum lttng_live_iterator_status stream_iter_status;
1300 uint64_t session_idx;
1301
1302 *count = 0;
1303
1304 BT_ASSERT_DBG(lttng_live_msg_iter);
1305
1306 if (G_UNLIKELY(lttng_live_msg_iter->was_interrupted)) {
1307 /*
1308 * The iterator was interrupted in a previous call to the
1309 * `_next()` method. We currently do not support generating
1310 * messages after such event. The babeltrace2 CLI should never
1311 * be running the graph after being interrupted. So this check
1312 * is to prevent other graph users from using this live
1313 * iterator in an messed up internal state.
1314 */
1315 status = BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_ERROR;
1316 BT_COMP_LOGE_APPEND_CAUSE(self_comp,
1317 "Message iterator was interrupted during a previous call to the `next()` and currently does not support continuing after such event.");
1318 goto end;
1319 }
1320
1321 /*
1322 * Clear all the invalid message reference that might be left over in
1323 * the output array.
1324 */
1325 memset(msgs, 0, capacity * sizeof(*msgs));
1326
1327 /*
1328 * If no session are exposed on the relay found at the url provided by
1329 * the user, session count will be 0. In this case, we return status
1330 * end to return gracefully.
1331 */
1332 if (lttng_live_msg_iter->sessions->len == 0) {
1333 if (lttng_live->params.sess_not_found_act !=
1334 SESSION_NOT_FOUND_ACTION_CONTINUE) {
1335 status = BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_END;
1336 goto end;
1337 } else {
1338 /*
1339 * The are no more active session for this session
1340 * name. Retry to create a viewer session for the
1341 * requested session name.
1342 */
1343 viewer_status = lttng_live_create_viewer_session(lttng_live_msg_iter);
1344 if (viewer_status != LTTNG_LIVE_VIEWER_STATUS_OK) {
1345 if (viewer_status == LTTNG_LIVE_VIEWER_STATUS_ERROR) {
1346 status = BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_ERROR;
1347 BT_COMP_LOGE_APPEND_CAUSE(self_comp,
1348 "Error creating LTTng live viewer session");
1349 } else if (viewer_status == LTTNG_LIVE_VIEWER_STATUS_INTERRUPTED) {
1350 status = BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_AGAIN;
1351 } else {
1352 bt_common_abort();
1353 }
1354 goto end;
1355 }
1356 }
1357 }
1358
1359 if (lttng_live_msg_iter->active_stream_iter == 0) {
1360 lttng_live_force_new_streams_and_metadata(lttng_live_msg_iter);
1361 }
1362
1363 /*
1364 * Here the muxing of message is done.
1365 *
1366 * We need to iterate over all the streams of all the traces of all the
1367 * viewer sessions in order to get the message with the smallest
1368 * timestamp. In this case, a session is a viewer session and there is
1369 * one viewer session per consumer daemon. (UST 32bit, UST 64bit and/or
1370 * kernel). Each viewer session can have multiple traces, for example,
1371 * 64bit UST viewer sessions could have multiple per-pid traces.
1372 *
1373 * We iterate over the streams of each traces to update and see what is
1374 * their next message's timestamp. From those timestamps, we select the
1375 * message with the smallest timestamp as the best candidate message
1376 * for that trace and do the same thing across all the sessions.
1377 *
1378 * We then compare the timestamp of best candidate message of all the
1379 * sessions to pick the message with the smallest timestamp and we
1380 * return it.
1381 */
1382 while (*count < capacity) {
1383 struct lttng_live_stream_iterator *youngest_stream_iter = NULL,
1384 *candidate_stream_iter = NULL;
1385 int64_t youngest_msg_ts_ns = INT64_MAX;
1386
1387 BT_ASSERT_DBG(lttng_live_msg_iter->sessions);
1388 session_idx = 0;
1389 while (session_idx < lttng_live_msg_iter->sessions->len) {
1390 struct lttng_live_session *session =
1391 g_ptr_array_index(lttng_live_msg_iter->sessions,
1392 session_idx);
1393
1394 /* Find the best candidate message to send downstream. */
1395 stream_iter_status = next_stream_iterator_for_session(
1396 lttng_live_msg_iter, session,
1397 &candidate_stream_iter);
1398
1399 /* If we receive an END status, it means that either:
1400 * - Those traces never had active streams (UST with no
1401 * data produced yet),
1402 * - All live stream iterators have ENDed.*/
1403 if (stream_iter_status == LTTNG_LIVE_ITERATOR_STATUS_END) {
1404 if (session->closed && session->traces->len == 0) {
1405 /*
1406 * Remove the session from the list.
1407 * session_idx is not modified since
1408 * g_ptr_array_remove_index_fast
1409 * replaces the the removed element with
1410 * the array's last element.
1411 */
1412 g_ptr_array_remove_index_fast(
1413 lttng_live_msg_iter->sessions,
1414 session_idx);
1415 } else {
1416 session_idx++;
1417 }
1418 continue;
1419 }
1420
1421 if (stream_iter_status != LTTNG_LIVE_ITERATOR_STATUS_OK) {
1422 goto return_status;
1423 }
1424
1425 if (G_UNLIKELY(youngest_stream_iter == NULL) ||
1426 candidate_stream_iter->current_msg_ts_ns < youngest_msg_ts_ns) {
1427 youngest_msg_ts_ns = candidate_stream_iter->current_msg_ts_ns;
1428 youngest_stream_iter = candidate_stream_iter;
1429 } else if (candidate_stream_iter->current_msg_ts_ns == youngest_msg_ts_ns) {
1430 /*
1431 * The currently selected message to be sent
1432 * downstream next has the exact same timestamp
1433 * that of the current candidate message. We
1434 * must break the tie in a predictable manner.
1435 */
1436 BT_COMP_LOGD_STR("Two of the next message candidates have the same timestamps, pick one deterministically.");
1437 /*
1438 * Order the messages in an arbitrary but
1439 * deterministic way.
1440 */
1441 int ret = common_muxing_compare_messages(
1442 candidate_stream_iter->current_msg,
1443 youngest_stream_iter->current_msg);
1444 if (ret < 0) {
1445 /*
1446 * The `candidate_stream_iter->current_msg`
1447 * should go first. Update the next
1448 * iterator and the current timestamp.
1449 */
1450 youngest_msg_ts_ns = candidate_stream_iter->current_msg_ts_ns;
1451 youngest_stream_iter = candidate_stream_iter;
1452 } else if (ret == 0) {
1453 /* Unable to pick which one should go first. */
1454 BT_COMP_LOGW("Cannot deterministically pick next live stream message iterator because they have identical next messages: "
1455 "next-stream-iter-addr=%p" "candidate-stream-iter-addr=%p",
1456 youngest_stream_iter, candidate_stream_iter);
1457 }
1458 }
1459
1460 session_idx++;
1461 }
1462
1463 if (!youngest_stream_iter) {
1464 stream_iter_status = LTTNG_LIVE_ITERATOR_STATUS_AGAIN;
1465 goto return_status;
1466 }
1467
1468 BT_ASSERT_DBG(youngest_stream_iter->current_msg);
1469 /* Ensure monotonicity. */
1470 BT_ASSERT_DBG(lttng_live_msg_iter->last_msg_ts_ns <=
1471 youngest_stream_iter->current_msg_ts_ns);
1472
1473 /*
1474 * Insert the next message to the message batch. This will set
1475 * stream iterator current messsage to NULL so that next time
1476 * we fetch the next message of that stream iterator
1477 */
1478 BT_MESSAGE_MOVE_REF(msgs[*count], youngest_stream_iter->current_msg);
1479 (*count)++;
1480
1481 /* Update the last timestamp in nanoseconds sent downstream. */
1482 lttng_live_msg_iter->last_msg_ts_ns = youngest_msg_ts_ns;
1483 youngest_stream_iter->current_msg_ts_ns = INT64_MAX;
1484
1485 stream_iter_status = LTTNG_LIVE_ITERATOR_STATUS_OK;
1486 }
1487
1488 return_status:
1489 switch (stream_iter_status) {
1490 case LTTNG_LIVE_ITERATOR_STATUS_OK:
1491 case LTTNG_LIVE_ITERATOR_STATUS_AGAIN:
1492 /*
1493 * If we gathered messages, return _OK even if the graph was
1494 * interrupted. This allows for the components downstream to at
1495 * least get the thoses messages. If the graph was indeed
1496 * interrupted there should not be another _next() call as the
1497 * application will tear down the graph. This component class
1498 * doesn't support restarting after an interruption.
1499 */
1500 if (*count > 0) {
1501 status = BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_OK;
1502 } else {
1503 status = BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_AGAIN;
1504 }
1505 break;
1506 case LTTNG_LIVE_ITERATOR_STATUS_END:
1507 status = BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_END;
1508 break;
1509 case LTTNG_LIVE_ITERATOR_STATUS_NOMEM:
1510 BT_COMP_LOGE_APPEND_CAUSE(self_comp,
1511 "Memory error preparing the next batch of messages: "
1512 "live-iter-status=%s",
1513 lttng_live_iterator_status_string(stream_iter_status));
1514 status = BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_MEMORY_ERROR;
1515 break;
1516 case LTTNG_LIVE_ITERATOR_STATUS_ERROR:
1517 case LTTNG_LIVE_ITERATOR_STATUS_INVAL:
1518 case LTTNG_LIVE_ITERATOR_STATUS_UNSUPPORTED:
1519 BT_COMP_LOGE_APPEND_CAUSE(self_comp,
1520 "Error preparing the next batch of messages: "
1521 "live-iter-status=%s",
1522 lttng_live_iterator_status_string(stream_iter_status));
1523
1524 status = BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_ERROR;
1525 /* Put all existing messages on error. */
1526 put_messages(msgs, *count);
1527 break;
1528 default:
1529 bt_common_abort();
1530 }
1531
1532 end:
1533 return status;
1534 }
1535
1536 static
1537 struct lttng_live_msg_iter *lttng_live_msg_iter_create(
1538 struct lttng_live_component *lttng_live_comp,
1539 bt_self_message_iterator *self_msg_it)
1540 {
1541 bt_self_component *self_comp = lttng_live_comp->self_comp;
1542 bt_logging_level log_level = lttng_live_comp->log_level;
1543
1544 struct lttng_live_msg_iter *lttng_live_msg_iter =
1545 g_new0(struct lttng_live_msg_iter, 1);
1546 if (!lttng_live_msg_iter) {
1547 BT_COMP_LOGE_APPEND_CAUSE(self_comp,
1548 "Failed to allocate lttng_live_msg_iter");
1549 goto end;
1550 }
1551
1552 lttng_live_msg_iter->log_level = lttng_live_comp->log_level;
1553 lttng_live_msg_iter->self_comp = lttng_live_comp->self_comp;
1554 lttng_live_msg_iter->lttng_live_comp = lttng_live_comp;
1555 lttng_live_msg_iter->self_msg_iter = self_msg_it;
1556
1557 lttng_live_msg_iter->active_stream_iter = 0;
1558 lttng_live_msg_iter->last_msg_ts_ns = INT64_MIN;
1559 lttng_live_msg_iter->was_interrupted = false;
1560
1561 lttng_live_msg_iter->sessions = g_ptr_array_new_with_free_func(
1562 (GDestroyNotify) lttng_live_destroy_session);
1563 BT_ASSERT(lttng_live_msg_iter->sessions);
1564
1565 end:
1566 return lttng_live_msg_iter;
1567
1568 }
1569
1570 BT_HIDDEN
1571 bt_message_iterator_class_initialize_method_status lttng_live_msg_iter_init(
1572 bt_self_message_iterator *self_msg_it,
1573 bt_self_message_iterator_configuration *config,
1574 bt_self_component_port_output *self_port)
1575 {
1576 bt_message_iterator_class_initialize_method_status status;
1577 struct lttng_live_component *lttng_live;
1578 struct lttng_live_msg_iter *lttng_live_msg_iter;
1579 enum lttng_live_viewer_status viewer_status;
1580 bt_logging_level log_level;
1581 bt_self_component *self_comp =
1582 bt_self_message_iterator_borrow_component(self_msg_it);
1583
1584 lttng_live = bt_self_component_get_data(self_comp);
1585 log_level = lttng_live->log_level;
1586 self_comp = lttng_live->self_comp;
1587
1588
1589 /* There can be only one downstream iterator at the same time. */
1590 BT_ASSERT(!lttng_live->has_msg_iter);
1591 lttng_live->has_msg_iter = true;
1592
1593 lttng_live_msg_iter = lttng_live_msg_iter_create(lttng_live,
1594 self_msg_it);
1595 if (!lttng_live_msg_iter) {
1596 status = BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_MEMORY_ERROR;
1597 BT_COMP_LOGE_APPEND_CAUSE(self_comp,
1598 "Failed to create lttng_live_msg_iter");
1599 goto error;
1600 }
1601
1602 viewer_status = live_viewer_connection_create(self_comp, NULL,
1603 log_level, lttng_live->params.url->str, false,
1604 lttng_live_msg_iter, &lttng_live_msg_iter->viewer_connection);
1605 if (viewer_status != LTTNG_LIVE_VIEWER_STATUS_OK) {
1606 if (viewer_status == LTTNG_LIVE_VIEWER_STATUS_ERROR) {
1607 BT_COMP_LOGE_APPEND_CAUSE(self_comp,
1608 "Failed to create viewer connection");
1609 } else if (viewer_status == LTTNG_LIVE_VIEWER_STATUS_INTERRUPTED) {
1610 /*
1611 * Interruption in the _iter_init() method is not
1612 * supported. Return an error.
1613 */
1614 BT_COMP_LOGE_APPEND_CAUSE(self_comp,
1615 "Interrupted while creating viewer connection");
1616 }
1617 goto error;
1618 }
1619
1620 viewer_status = lttng_live_create_viewer_session(lttng_live_msg_iter);
1621 if (viewer_status != LTTNG_LIVE_VIEWER_STATUS_OK) {
1622 if (viewer_status == LTTNG_LIVE_VIEWER_STATUS_ERROR) {
1623 BT_COMP_LOGE_APPEND_CAUSE(self_comp,
1624 "Failed to create viewer session");
1625 } else if (viewer_status == LTTNG_LIVE_VIEWER_STATUS_INTERRUPTED) {
1626 /*
1627 * Interruption in the _iter_init() method is not
1628 * supported. Return an error.
1629 */
1630 BT_COMP_LOGE_APPEND_CAUSE(self_comp,
1631 "Interrupted when creating viewer session");
1632 }
1633 goto error;
1634 }
1635
1636 if (lttng_live_msg_iter->sessions->len == 0) {
1637 switch (lttng_live->params.sess_not_found_act) {
1638 case SESSION_NOT_FOUND_ACTION_CONTINUE:
1639 BT_COMP_LOGI("Unable to connect to the requested live viewer session. Keep trying to connect because of "
1640 "%s=\"%s\" component parameter: url=\"%s\"",
1641 SESS_NOT_FOUND_ACTION_PARAM,
1642 SESS_NOT_FOUND_ACTION_CONTINUE_STR,
1643 lttng_live->params.url->str);
1644 break;
1645 case SESSION_NOT_FOUND_ACTION_FAIL:
1646 BT_COMP_LOGE_APPEND_CAUSE(self_comp,
1647 "Unable to connect to the requested live viewer session. Fail the message iterator initialization because of %s=\"%s\" "
1648 "component parameter: url =\"%s\"",
1649 SESS_NOT_FOUND_ACTION_PARAM,
1650 SESS_NOT_FOUND_ACTION_FAIL_STR,
1651 lttng_live->params.url->str);
1652 goto error;
1653 case SESSION_NOT_FOUND_ACTION_END:
1654 BT_COMP_LOGI("Unable to connect to the requested live viewer session. End gracefully at the first _next() "
1655 "call because of %s=\"%s\" component parameter: "
1656 "url=\"%s\"", SESS_NOT_FOUND_ACTION_PARAM,
1657 SESS_NOT_FOUND_ACTION_END_STR,
1658 lttng_live->params.url->str);
1659 break;
1660 default:
1661 bt_common_abort();
1662 }
1663 }
1664
1665 bt_self_message_iterator_set_data(self_msg_it, lttng_live_msg_iter);
1666 status = BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_OK;
1667 goto end;
1668
1669 error:
1670 status = BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_ERROR;
1671 lttng_live_msg_iter_destroy(lttng_live_msg_iter);
1672 end:
1673 return status;
1674 }
1675
1676 static struct bt_param_validation_map_value_entry_descr list_sessions_params[] = {
1677 { URL_PARAM, BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_MANDATORY, { .type = BT_VALUE_TYPE_STRING } },
1678 BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_END
1679 };
1680
1681 static
1682 bt_component_class_query_method_status lttng_live_query_list_sessions(
1683 const bt_value *params, const bt_value **result,
1684 bt_self_component_class *self_comp_class,
1685 bt_logging_level log_level)
1686 {
1687 bt_component_class_query_method_status status;
1688 const bt_value *url_value = NULL;
1689 const char *url;
1690 struct live_viewer_connection *viewer_connection = NULL;
1691 enum lttng_live_viewer_status viewer_status;
1692 enum bt_param_validation_status validation_status;
1693 gchar *validate_error = NULL;
1694
1695 validation_status = bt_param_validation_validate(params,
1696 list_sessions_params, &validate_error);
1697 if (validation_status == BT_PARAM_VALIDATION_STATUS_MEMORY_ERROR) {
1698 status = BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_MEMORY_ERROR;
1699 goto error;
1700 } else if (validation_status == BT_PARAM_VALIDATION_STATUS_VALIDATION_ERROR) {
1701 status = BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_ERROR;
1702 BT_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp_class, "%s",
1703 validate_error);
1704 goto error;
1705 }
1706
1707 url_value = bt_value_map_borrow_entry_value_const(params, URL_PARAM);
1708 url = bt_value_string_get(url_value);
1709
1710 viewer_status = live_viewer_connection_create(NULL, self_comp_class,
1711 log_level, url, true, NULL, &viewer_connection);
1712 if (viewer_status != LTTNG_LIVE_VIEWER_STATUS_OK) {
1713 if (viewer_status == LTTNG_LIVE_VIEWER_STATUS_ERROR) {
1714 BT_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp_class,
1715 "Failed to create viewer connection");
1716 status = BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_ERROR;
1717 } else if (viewer_status == LTTNG_LIVE_VIEWER_STATUS_INTERRUPTED) {
1718 status = BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_AGAIN;
1719 } else {
1720 bt_common_abort();
1721 }
1722 goto error;
1723 }
1724
1725 status = live_viewer_connection_list_sessions(viewer_connection,
1726 result);
1727 if (status != BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_OK) {
1728 BT_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp_class,
1729 "Failed to list viewer sessions");
1730 goto error;
1731 }
1732
1733 goto end;
1734
1735 error:
1736 BT_VALUE_PUT_REF_AND_RESET(*result);
1737
1738 if (status >= 0) {
1739 status = BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_ERROR;
1740 }
1741
1742 end:
1743 if (viewer_connection) {
1744 live_viewer_connection_destroy(viewer_connection);
1745 }
1746
1747 g_free(validate_error);
1748
1749 return status;
1750 }
1751
1752 static
1753 bt_component_class_query_method_status lttng_live_query_support_info(
1754 const bt_value *params, const bt_value **result,
1755 bt_self_component_class *self_comp_class,
1756 bt_logging_level log_level)
1757 {
1758 bt_component_class_query_method_status status =
1759 BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_OK;
1760 const bt_value *input_type_value;
1761 const bt_value *input_value;
1762 double weight = 0;
1763 struct bt_common_lttng_live_url_parts parts = { 0 };
1764
1765 /* Used by the logging macros */
1766 __attribute__((unused)) bt_self_component *self_comp = NULL;
1767
1768 *result = NULL;
1769 input_type_value = bt_value_map_borrow_entry_value_const(params,
1770 "type");
1771 if (!input_type_value) {
1772 BT_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp_class,
1773 "Missing expected `type` parameter.");
1774 goto error;
1775 }
1776
1777 if (!bt_value_is_string(input_type_value)) {
1778 BT_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp_class,
1779 "`type` parameter is not a string value.");
1780 goto error;
1781 }
1782
1783 if (strcmp(bt_value_string_get(input_type_value), "string") != 0) {
1784 /* We don't handle file system paths */
1785 goto create_result;
1786 }
1787
1788 input_value = bt_value_map_borrow_entry_value_const(params, "input");
1789 if (!input_value) {
1790 BT_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp_class,
1791 "Missing expected `input` parameter.");
1792 goto error;
1793 }
1794
1795 if (!bt_value_is_string(input_value)) {
1796 BT_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp_class,
1797 "`input` parameter is not a string value.");
1798 goto error;
1799 }
1800
1801 parts = bt_common_parse_lttng_live_url(bt_value_string_get(input_value),
1802 NULL, 0);
1803 if (parts.session_name) {
1804 /*
1805 * Looks pretty much like an LTTng live URL: we got the
1806 * session name part, which forms a complete URL.
1807 */
1808 weight = .75;
1809 }
1810
1811 create_result:
1812 *result = bt_value_real_create_init(weight);
1813 if (!*result) {
1814 status = BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_MEMORY_ERROR;
1815 goto error;
1816 }
1817
1818 goto end;
1819
1820 error:
1821 if (status >= 0) {
1822 status = BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_ERROR;
1823 }
1824
1825 BT_ASSERT(!*result);
1826
1827 end:
1828 bt_common_destroy_lttng_live_url_parts(&parts);
1829 return status;
1830 }
1831
1832 BT_HIDDEN
1833 bt_component_class_query_method_status lttng_live_query(
1834 bt_self_component_class_source *comp_class,
1835 bt_private_query_executor *priv_query_exec,
1836 const char *object, const bt_value *params,
1837 __attribute__((unused)) void *method_data,
1838 const bt_value **result)
1839 {
1840 bt_component_class_query_method_status status =
1841 BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_OK;
1842 bt_self_component *self_comp = NULL;
1843 bt_self_component_class *self_comp_class =
1844 bt_self_component_class_source_as_self_component_class(comp_class);
1845 bt_logging_level log_level = bt_query_executor_get_logging_level(
1846 bt_private_query_executor_as_query_executor_const(
1847 priv_query_exec));
1848
1849 if (strcmp(object, "sessions") == 0) {
1850 status = lttng_live_query_list_sessions(params, result,
1851 self_comp_class, log_level);
1852 } else if (strcmp(object, "babeltrace.support-info") == 0) {
1853 status = lttng_live_query_support_info(params, result,
1854 self_comp_class, log_level);
1855 } else {
1856 BT_COMP_LOGI("Unknown query object `%s`", object);
1857 status = BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_UNKNOWN_OBJECT;
1858 goto end;
1859 }
1860
1861 end:
1862 return status;
1863 }
1864
1865 static
1866 void lttng_live_component_destroy_data(struct lttng_live_component *lttng_live)
1867 {
1868 if (!lttng_live) {
1869 return;
1870 }
1871 if (lttng_live->params.url) {
1872 g_string_free(lttng_live->params.url, TRUE);
1873 }
1874 g_free(lttng_live);
1875 }
1876
1877 BT_HIDDEN
1878 void lttng_live_component_finalize(bt_self_component_source *component)
1879 {
1880 void *data = bt_self_component_get_data(
1881 bt_self_component_source_as_self_component(component));
1882
1883 if (!data) {
1884 return;
1885 }
1886 lttng_live_component_destroy_data(data);
1887 }
1888
1889 static
1890 enum session_not_found_action parse_session_not_found_action_param(
1891 const bt_value *no_session_param)
1892 {
1893 enum session_not_found_action action;
1894 const char *no_session_act_str = bt_value_string_get(no_session_param);
1895
1896 if (strcmp(no_session_act_str, SESS_NOT_FOUND_ACTION_CONTINUE_STR) == 0) {
1897 action = SESSION_NOT_FOUND_ACTION_CONTINUE;
1898 } else if (strcmp(no_session_act_str, SESS_NOT_FOUND_ACTION_FAIL_STR) == 0) {
1899 action = SESSION_NOT_FOUND_ACTION_FAIL;
1900 } else {
1901 BT_ASSERT(strcmp(no_session_act_str, SESS_NOT_FOUND_ACTION_END_STR) == 0);
1902 action = SESSION_NOT_FOUND_ACTION_END;
1903 }
1904
1905 return action;
1906 }
1907
1908 static struct bt_param_validation_value_descr inputs_elem_descr = {
1909 .type = BT_VALUE_TYPE_STRING,
1910 };
1911
1912 static const char *sess_not_found_action_choices[] = {
1913 SESS_NOT_FOUND_ACTION_CONTINUE_STR,
1914 SESS_NOT_FOUND_ACTION_FAIL_STR,
1915 SESS_NOT_FOUND_ACTION_END_STR,
1916 };
1917
1918 static struct bt_param_validation_map_value_entry_descr params_descr[] = {
1919 { INPUTS_PARAM, BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_MANDATORY, { BT_VALUE_TYPE_ARRAY, .array = {
1920 .min_length = 1,
1921 .max_length = 1,
1922 .element_type = &inputs_elem_descr,
1923 } } },
1924 { SESS_NOT_FOUND_ACTION_PARAM, BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL, { BT_VALUE_TYPE_STRING, .string = {
1925 .choices = sess_not_found_action_choices,
1926 } } },
1927 BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_END
1928 };
1929
1930 static
1931 bt_component_class_initialize_method_status lttng_live_component_create(
1932 const bt_value *params,
1933 bt_logging_level log_level,
1934 bt_self_component *self_comp,
1935 struct lttng_live_component **component)
1936 {
1937 struct lttng_live_component *lttng_live = NULL;
1938 const bt_value *inputs_value;
1939 const bt_value *url_value;
1940 const bt_value *value;
1941 const char *url;
1942 enum bt_param_validation_status validation_status;
1943 gchar *validation_error = NULL;
1944 bt_component_class_initialize_method_status status;
1945
1946 validation_status = bt_param_validation_validate(params, params_descr,
1947 &validation_error);
1948 if (validation_status == BT_PARAM_VALIDATION_STATUS_MEMORY_ERROR) {
1949 status = BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_MEMORY_ERROR;
1950 goto error;
1951 } else if (validation_status == BT_PARAM_VALIDATION_STATUS_VALIDATION_ERROR) {
1952 BT_COMP_LOGE_APPEND_CAUSE(self_comp, "%s", validation_error);
1953 status = BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_ERROR;
1954 goto error;
1955 }
1956
1957 lttng_live = g_new0(struct lttng_live_component, 1);
1958 if (!lttng_live) {
1959 status = BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_MEMORY_ERROR;
1960 goto end;
1961 }
1962 lttng_live->log_level = log_level;
1963 lttng_live->self_comp = self_comp;
1964 lttng_live->max_query_size = MAX_QUERY_SIZE;
1965 lttng_live->has_msg_iter = false;
1966
1967 inputs_value =
1968 bt_value_map_borrow_entry_value_const(params, INPUTS_PARAM);
1969 url_value =
1970 bt_value_array_borrow_element_by_index_const(inputs_value, 0);
1971 url = bt_value_string_get(url_value);
1972
1973 lttng_live->params.url = g_string_new(url);
1974 if (!lttng_live->params.url) {
1975 status = BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_MEMORY_ERROR;
1976 goto error;
1977 }
1978
1979 value = bt_value_map_borrow_entry_value_const(params,
1980 SESS_NOT_FOUND_ACTION_PARAM);
1981 if (value) {
1982 lttng_live->params.sess_not_found_act =
1983 parse_session_not_found_action_param(value);
1984 } else {
1985 BT_COMP_LOGI("Optional `%s` parameter is missing: "
1986 "defaulting to `%s`.",
1987 SESS_NOT_FOUND_ACTION_PARAM,
1988 SESS_NOT_FOUND_ACTION_CONTINUE_STR);
1989 lttng_live->params.sess_not_found_act =
1990 SESSION_NOT_FOUND_ACTION_CONTINUE;
1991 }
1992
1993 status = BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_OK;
1994 goto end;
1995
1996 error:
1997 lttng_live_component_destroy_data(lttng_live);
1998 lttng_live = NULL;
1999 end:
2000 g_free(validation_error);
2001
2002 *component = lttng_live;
2003 return status;
2004 }
2005
2006 BT_HIDDEN
2007 bt_component_class_initialize_method_status lttng_live_component_init(
2008 bt_self_component_source *self_comp_src,
2009 bt_self_component_source_configuration *config,
2010 const bt_value *params,
2011 __attribute__((unused)) void *init_method_data)
2012 {
2013 struct lttng_live_component *lttng_live;
2014 bt_component_class_initialize_method_status ret;
2015 bt_self_component *self_comp =
2016 bt_self_component_source_as_self_component(self_comp_src);
2017 bt_logging_level log_level = bt_component_get_logging_level(
2018 bt_self_component_as_component(self_comp));
2019 bt_self_component_add_port_status add_port_status;
2020
2021 ret = lttng_live_component_create(params, log_level, self_comp, &lttng_live);
2022 if (ret != BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_OK) {
2023 goto error;
2024 }
2025
2026 add_port_status = bt_self_component_source_add_output_port(
2027 self_comp_src, "out", NULL, NULL);
2028 if (add_port_status != BT_SELF_COMPONENT_ADD_PORT_STATUS_OK) {
2029 ret = (int) add_port_status;
2030 goto end;
2031 }
2032
2033 bt_self_component_set_data(self_comp, lttng_live);
2034 goto end;
2035
2036 error:
2037 lttng_live_component_destroy_data(lttng_live);
2038 lttng_live = NULL;
2039 end:
2040 return ret;
2041 }
BabelTrace - Trace Format Babel Tower
This page took 0.122393 seconds and 3 git commands to generate.