projects / babeltrace.git / blob
? search:


f3740a354b1ed5eac7363e1cc11d4f074572943a
[babeltrace.git] / plugins / utils / muxer / muxer.c
1 /*
2 * Copyright 2017 Philippe Proulx <pproulx@efficios.com>
3 *
4 * Permission is hereby granted, free of charge, to any person obtaining a copy
5 * of this software and associated documentation files (the "Software"), to deal
6 * in the Software without restriction, including without limitation the rights
7 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
8 * copies of the Software, and to permit persons to whom the Software is
9 * furnished to do so, subject to the following conditions:
10 *
11 * The above copyright notice and this permission notice shall be included in
12 * all copies or substantial portions of the Software.
13 *
14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
17 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
19 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
20 * SOFTWARE.
21 */
22
23 #define BT_LOG_TAG "PLUGIN-UTILS-MUXER-FLT"
24 #include "logging.h"
25
26 #include <babeltrace/babeltrace-internal.h>
27 #include <babeltrace/compat/uuid-internal.h>
28 #include <babeltrace/babeltrace.h>
29 #include <babeltrace/values-internal.h>
30 #include <babeltrace/graph/component-internal.h>
31 #include <babeltrace/graph/notification-iterator-internal.h>
32 #include <babeltrace/graph/connection-internal.h>
33 #include <plugins-common.h>
34 #include <glib.h>
35 #include <stdbool.h>
36 #include <inttypes.h>
37 #include <babeltrace/assert-internal.h>
38 #include <stdlib.h>
39 #include <string.h>
40
41 #define ASSUME_ABSOLUTE_CLOCK_CLASSES_PARAM_NAME "assume-absolute-clock-classes"
42
43 struct muxer_comp {
44 /*
45 * Array of struct
46 * bt_private_connection_private_notification_iterator *
47 * (weak refs)
48 */
49 GPtrArray *muxer_notif_iters;
50
51 /* Weak ref */
52 struct bt_private_component *priv_comp;
53 unsigned int next_port_num;
54 size_t available_input_ports;
55 bool initializing_muxer_notif_iter;
56 bool assume_absolute_clock_classes;
57 };
58
59 struct muxer_upstream_notif_iter {
60 /* Owned by this, NULL if ended */
61 struct bt_notification_iterator *notif_iter;
62
63 /* Contains `struct bt_notification *`, owned by this */
64 GQueue *notifs;
65 };
66
67 enum muxer_notif_iter_clock_class_expectation {
68 MUXER_NOTIF_ITER_CLOCK_CLASS_EXPECTATION_ANY = 0,
69 MUXER_NOTIF_ITER_CLOCK_CLASS_EXPECTATION_ABSOLUTE,
70 MUXER_NOTIF_ITER_CLOCK_CLASS_EXPECTATION_NOT_ABS_SPEC_UUID,
71 MUXER_NOTIF_ITER_CLOCK_CLASS_EXPECTATION_NOT_ABS_NO_UUID,
72 };
73
74 struct muxer_notif_iter {
75 /*
76 * Array of struct muxer_upstream_notif_iter * (owned by this).
77 *
78 * NOTE: This array is searched in linearly to find the youngest
79 * current notification. Keep this until benchmarks confirm that
80 * another data structure is faster than this for our typical
81 * use cases.
82 */
83 GPtrArray *muxer_upstream_notif_iters;
84
85 /*
86 * List of "recently" connected input ports (weak) to
87 * handle by this muxer notification iterator.
88 * muxer_port_connected() adds entries to this list, and the
89 * entries are removed when a notification iterator is created
90 * on the port's connection and put into
91 * muxer_upstream_notif_iters above by
92 * muxer_notif_iter_handle_newly_connected_ports().
93 */
94 GList *newly_connected_priv_ports;
95
96 /* Last time returned in a notification */
97 int64_t last_returned_ts_ns;
98
99 /* Clock class expectation state */
100 enum muxer_notif_iter_clock_class_expectation clock_class_expectation;
101
102 /*
103 * Expected clock class UUID, only valid when
104 * clock_class_expectation is
105 * MUXER_NOTIF_ITER_CLOCK_CLASS_EXPECTATION_NOT_ABS_SPEC_UUID.
106 */
107 unsigned char expected_clock_class_uuid[BABELTRACE_UUID_LEN];
108 };
109
110 static
111 void destroy_muxer_upstream_notif_iter(
112 struct muxer_upstream_notif_iter *muxer_upstream_notif_iter)
113 {
114 if (!muxer_upstream_notif_iter) {
115 return;
116 }
117
118 BT_LOGD("Destroying muxer's upstream notification iterator wrapper: "
119 "addr=%p, notif-iter-addr=%p, queue-len=%u",
120 muxer_upstream_notif_iter,
121 muxer_upstream_notif_iter->notif_iter,
122 muxer_upstream_notif_iter->notifs->length);
123 bt_put(muxer_upstream_notif_iter->notif_iter);
124
125 if (muxer_upstream_notif_iter->notifs) {
126 struct bt_notification *notif;
127
128 while ((notif = g_queue_pop_head(
129 muxer_upstream_notif_iter->notifs))) {
130 bt_put(notif);
131 }
132
133 g_queue_free(muxer_upstream_notif_iter->notifs);
134 }
135
136 g_free(muxer_upstream_notif_iter);
137 }
138
139 static
140 struct muxer_upstream_notif_iter *muxer_notif_iter_add_upstream_notif_iter(
141 struct muxer_notif_iter *muxer_notif_iter,
142 struct bt_notification_iterator *notif_iter,
143 struct bt_private_port *priv_port)
144 {
145 struct muxer_upstream_notif_iter *muxer_upstream_notif_iter =
146 g_new0(struct muxer_upstream_notif_iter, 1);
147
148 if (!muxer_upstream_notif_iter) {
149 BT_LOGE_STR("Failed to allocate one muxer's upstream notification iterator wrapper.");
150 goto end;
151 }
152
153 muxer_upstream_notif_iter->notif_iter = bt_get(notif_iter);
154 muxer_upstream_notif_iter->notifs = g_queue_new();
155 if (!muxer_upstream_notif_iter->notifs) {
156 BT_LOGE_STR("Failed to allocate a GQueue.");
157
158 goto end;
159 }
160
161 g_ptr_array_add(muxer_notif_iter->muxer_upstream_notif_iters,
162 muxer_upstream_notif_iter);
163 BT_LOGD("Added muxer's upstream notification iterator wrapper: "
164 "addr=%p, muxer-notif-iter-addr=%p, notif-iter-addr=%p",
165 muxer_upstream_notif_iter, muxer_notif_iter,
166 notif_iter);
167
168 end:
169 return muxer_upstream_notif_iter;
170 }
171
172 static
173 enum bt_component_status ensure_available_input_port(
174 struct bt_private_component *priv_comp)
175 {
176 struct muxer_comp *muxer_comp =
177 bt_private_component_get_user_data(priv_comp);
178 enum bt_component_status status = BT_COMPONENT_STATUS_OK;
179 GString *port_name = NULL;
180
181 BT_ASSERT(muxer_comp);
182
183 if (muxer_comp->available_input_ports >= 1) {
184 goto end;
185 }
186
187 port_name = g_string_new("in");
188 if (!port_name) {
189 BT_LOGE_STR("Failed to allocate a GString.");
190 status = BT_COMPONENT_STATUS_NOMEM;
191 goto end;
192 }
193
194 g_string_append_printf(port_name, "%u", muxer_comp->next_port_num);
195 status = bt_private_component_filter_add_input_private_port(
196 priv_comp, port_name->str, NULL, NULL);
197 if (status != BT_COMPONENT_STATUS_OK) {
198 BT_LOGE("Cannot add input port to muxer component: "
199 "port-name=\"%s\", comp-addr=%p, status=%s",
200 port_name->str, priv_comp,
201 bt_component_status_string(status));
202 goto end;
203 }
204
205 muxer_comp->available_input_ports++;
206 muxer_comp->next_port_num++;
207 BT_LOGD("Added one input port to muxer component: "
208 "port-name=\"%s\", comp-addr=%p",
209 port_name->str, priv_comp);
210 end:
211 if (port_name) {
212 g_string_free(port_name, TRUE);
213 }
214
215 return status;
216 }
217
218 static
219 enum bt_component_status create_output_port(
220 struct bt_private_component *priv_comp)
221 {
222 return bt_private_component_filter_add_output_private_port(
223 priv_comp, "out", NULL, NULL);
224 }
225
226 static
227 void destroy_muxer_comp(struct muxer_comp *muxer_comp)
228 {
229 if (!muxer_comp) {
230 return;
231 }
232
233 BT_LOGD("Destroying muxer component: muxer-comp-addr=%p, "
234 "muxer-notif-iter-count=%u", muxer_comp,
235 muxer_comp->muxer_notif_iters ?
236 muxer_comp->muxer_notif_iters->len : 0);
237
238 if (muxer_comp->muxer_notif_iters) {
239 g_ptr_array_free(muxer_comp->muxer_notif_iters, TRUE);
240 }
241
242 g_free(muxer_comp);
243 }
244
245 static
246 struct bt_value *get_default_params(void)
247 {
248 struct bt_value *params;
249 int ret;
250
251 params = bt_value_map_create();
252 if (!params) {
253 BT_LOGE_STR("Cannot create a map value object.");
254 goto error;
255 }
256
257 ret = bt_value_map_insert_bool(params,
258 ASSUME_ABSOLUTE_CLOCK_CLASSES_PARAM_NAME, false);
259 if (ret) {
260 BT_LOGE_STR("Cannot add boolean value to map value object.");
261 goto error;
262 }
263
264 goto end;
265
266 error:
267 BT_PUT(params);
268
269 end:
270 return params;
271 }
272
273 static
274 int configure_muxer_comp(struct muxer_comp *muxer_comp, struct bt_value *params)
275 {
276 struct bt_value *default_params = NULL;
277 struct bt_value *real_params = NULL;
278 struct bt_value *assume_absolute_clock_classes = NULL;
279 int ret = 0;
280 bt_bool bool_val;
281
282 default_params = get_default_params();
283 if (!default_params) {
284 BT_LOGE("Cannot get default parameters: "
285 "muxer-comp-addr=%p", muxer_comp);
286 goto error;
287 }
288
289 real_params = bt_value_map_extend(default_params, params);
290 if (!real_params) {
291 BT_LOGE("Cannot extend default parameters map value: "
292 "muxer-comp-addr=%p, def-params-addr=%p, "
293 "params-addr=%p", muxer_comp, default_params,
294 params);
295 goto error;
296 }
297
298 assume_absolute_clock_classes = bt_value_map_borrow(real_params,
299 ASSUME_ABSOLUTE_CLOCK_CLASSES_PARAM_NAME);
300 if (assume_absolute_clock_classes &&
301 !bt_value_is_bool(assume_absolute_clock_classes)) {
302 BT_LOGE("Expecting a boolean value for the `%s` parameter: "
303 "muxer-comp-addr=%p, value-type=%s",
304 ASSUME_ABSOLUTE_CLOCK_CLASSES_PARAM_NAME, muxer_comp,
305 bt_value_type_string(
306 bt_value_get_type(assume_absolute_clock_classes)));
307 goto error;
308 }
309
310 ret = bt_value_bool_get(assume_absolute_clock_classes, &bool_val);
311 BT_ASSERT(ret == 0);
312 muxer_comp->assume_absolute_clock_classes = (bool) bool_val;
313 BT_LOGD("Configured muxer component: muxer-comp-addr=%p, "
314 "assume-absolute-clock-classes=%d",
315 muxer_comp, muxer_comp->assume_absolute_clock_classes);
316 goto end;
317
318 error:
319 ret = -1;
320
321 end:
322 bt_put(default_params);
323 bt_put(real_params);
324 return ret;
325 }
326
327 BT_HIDDEN
328 enum bt_component_status muxer_init(
329 struct bt_private_component *priv_comp,
330 struct bt_value *params, void *init_data)
331 {
332 int ret;
333 enum bt_component_status status = BT_COMPONENT_STATUS_OK;
334 struct muxer_comp *muxer_comp = g_new0(struct muxer_comp, 1);
335
336 BT_LOGD("Initializing muxer component: "
337 "comp-addr=%p, params-addr=%p", priv_comp, params);
338
339 if (!muxer_comp) {
340 BT_LOGE_STR("Failed to allocate one muxer component.");
341 goto error;
342 }
343
344 ret = configure_muxer_comp(muxer_comp, params);
345 if (ret) {
346 BT_LOGE("Cannot configure muxer component: "
347 "muxer-comp-addr=%p, params-addr=%p",
348 muxer_comp, params);
349 goto error;
350 }
351
352 muxer_comp->muxer_notif_iters = g_ptr_array_new();
353 if (!muxer_comp->muxer_notif_iters) {
354 BT_LOGE_STR("Failed to allocate a GPtrArray.");
355 goto error;
356 }
357
358 muxer_comp->priv_comp = priv_comp;
359 ret = bt_private_component_set_user_data(priv_comp, muxer_comp);
360 BT_ASSERT(ret == 0);
361 status = ensure_available_input_port(priv_comp);
362 if (status != BT_COMPONENT_STATUS_OK) {
363 BT_LOGE("Cannot ensure that at least one muxer component's input port is available: "
364 "muxer-comp-addr=%p, status=%s",
365 muxer_comp,
366 bt_component_status_string(status));
367 goto error;
368 }
369
370 status = create_output_port(priv_comp);
371 if (status) {
372 BT_LOGE("Cannot create muxer component's output port: "
373 "muxer-comp-addr=%p, status=%s",
374 muxer_comp,
375 bt_component_status_string(status));
376 goto error;
377 }
378
379 BT_LOGD("Initialized muxer component: "
380 "comp-addr=%p, params-addr=%p, muxer-comp-addr=%p",
381 priv_comp, params, muxer_comp);
382
383 goto end;
384
385 error:
386 destroy_muxer_comp(muxer_comp);
387 ret = bt_private_component_set_user_data(priv_comp, NULL);
388 BT_ASSERT(ret == 0);
389
390 if (status == BT_COMPONENT_STATUS_OK) {
391 status = BT_COMPONENT_STATUS_ERROR;
392 }
393
394 end:
395 return status;
396 }
397
398 BT_HIDDEN
399 void muxer_finalize(struct bt_private_component *priv_comp)
400 {
401 struct muxer_comp *muxer_comp =
402 bt_private_component_get_user_data(priv_comp);
403
404 BT_LOGD("Finalizing muxer component: comp-addr=%p",
405 priv_comp);
406 destroy_muxer_comp(muxer_comp);
407 }
408
409 static
410 struct bt_notification_iterator *create_notif_iter_on_input_port(
411 struct bt_private_port *priv_port, int *ret)
412 {
413 struct bt_port *port = bt_port_borrow_from_private(priv_port);
414 struct bt_notification_iterator *notif_iter = NULL;
415 struct bt_private_connection *priv_conn = NULL;
416 enum bt_connection_status conn_status;
417
418 BT_ASSERT(ret);
419 *ret = 0;
420 BT_ASSERT(port);
421 BT_ASSERT(bt_port_is_connected(port));
422 priv_conn = bt_private_port_get_private_connection(priv_port);
423 BT_ASSERT(priv_conn);
424
425 // TODO: Advance the iterator to >= the time of the latest
426 // returned notification by the muxer notification
427 // iterator which creates it.
428 conn_status = bt_private_connection_create_notification_iterator(
429 priv_conn, &notif_iter);
430 if (conn_status != BT_CONNECTION_STATUS_OK) {
431 BT_LOGE("Cannot create upstream notification iterator on input port's connection: "
432 "port-addr=%p, port-name=\"%s\", conn-addr=%p, "
433 "status=%s",
434 port, bt_port_get_name(port), priv_conn,
435 bt_connection_status_string(conn_status));
436 *ret = -1;
437 goto end;
438 }
439
440 BT_LOGD("Created upstream notification iterator on input port's connection: "
441 "port-addr=%p, port-name=\"%s\", conn-addr=%p, "
442 "notif-iter-addr=%p",
443 port, bt_port_get_name(port), priv_conn, notif_iter);
444
445 end:
446 bt_put(priv_conn);
447 return notif_iter;
448 }
449
450 static
451 enum bt_notification_iterator_status muxer_upstream_notif_iter_next(
452 struct muxer_upstream_notif_iter *muxer_upstream_notif_iter)
453 {
454 enum bt_notification_iterator_status status;
455 bt_notification_array notifs;
456 uint64_t i;
457 uint64_t count;
458
459 BT_LOGV("Calling upstream notification iterator's \"next\" method: "
460 "muxer-upstream-notif-iter-wrap-addr=%p, notif-iter-addr=%p",
461 muxer_upstream_notif_iter,
462 muxer_upstream_notif_iter->notif_iter);
463 status = bt_private_connection_notification_iterator_next(
464 muxer_upstream_notif_iter->notif_iter, &notifs, &count);
465 BT_LOGV("Upstream notification iterator's \"next\" method returned: "
466 "status=%s", bt_notification_iterator_status_string(status));
467
468 switch (status) {
469 case BT_NOTIFICATION_ITERATOR_STATUS_OK:
470 /*
471 * Notification iterator's current notification is
472 * valid: it must be considered for muxing operations.
473 */
474 BT_LOGV_STR("Validated upstream notification iterator wrapper.");
475 BT_ASSERT(count > 0);
476
477 /* Move notifications to our queue */
478 for (i = 0; i < count; i++) {
479 /*
480 * Push to tail in order; other side
481 * (muxer_notif_iter_do_next_one()) consumes
482 * from the head first.
483 */
484 g_queue_push_tail(muxer_upstream_notif_iter->notifs,
485 notifs[i]);
486 }
487 break;
488 case BT_NOTIFICATION_ITERATOR_STATUS_AGAIN:
489 /*
490 * Notification iterator's current notification is not
491 * valid anymore. Return
492 * BT_NOTIFICATION_ITERATOR_STATUS_AGAIN immediately.
493 */
494 break;
495 case BT_NOTIFICATION_ITERATOR_STATUS_END: /* Fall-through. */
496 case BT_NOTIFICATION_ITERATOR_STATUS_CANCELED:
497 /*
498 * Notification iterator reached the end: release it. It
499 * won't be considered again to find the youngest
500 * notification.
501 */
502 BT_PUT(muxer_upstream_notif_iter->notif_iter);
503 status = BT_NOTIFICATION_ITERATOR_STATUS_OK;
504 break;
505 default:
506 /* Error or unsupported status code */
507 BT_LOGE("Error or unsupported status code: "
508 "status-code=%d", status);
509 status = BT_NOTIFICATION_ITERATOR_STATUS_ERROR;
510 break;
511 }
512
513 return status;
514 }
515
516 static
517 int muxer_notif_iter_handle_newly_connected_ports(
518 struct muxer_notif_iter *muxer_notif_iter)
519 {
520 int ret = 0;
521
522 BT_LOGV("Handling newly connected ports: "
523 "muxer-notif-iter-addr=%p", muxer_notif_iter);
524
525 /*
526 * Here we create one upstream notification iterator for each
527 * newly connected port. We do NOT perform an initial "next" on
528 * those new upstream notification iterators: they are
529 * invalidated, to be validated later. The list of newly
530 * connected ports to handle here is updated by
531 * muxer_port_connected().
532 */
533 while (true) {
534 GList *node = muxer_notif_iter->newly_connected_priv_ports;
535 struct bt_private_port *priv_port;
536 struct bt_port *port;
537 struct bt_notification_iterator *upstream_notif_iter = NULL;
538 struct muxer_upstream_notif_iter *muxer_upstream_notif_iter;
539
540 if (!node) {
541 break;
542 }
543
544 priv_port = node->data;
545 port = bt_port_borrow_from_private(priv_port);
546 BT_ASSERT(port);
547
548 if (!bt_port_is_connected(port)) {
549 /*
550 * Looks like this port is not connected
551 * anymore: we can't create an upstream
552 * notification iterator on its (non-existing)
553 * connection in this case.
554 */
555 goto remove_node;
556 }
557
558 upstream_notif_iter = create_notif_iter_on_input_port(priv_port,
559 &ret);
560 if (ret) {
561 /* create_notif_iter_on_input_port() logs errors */
562 BT_ASSERT(!upstream_notif_iter);
563 goto error;
564 }
565
566 muxer_upstream_notif_iter =
567 muxer_notif_iter_add_upstream_notif_iter(
568 muxer_notif_iter, upstream_notif_iter,
569 priv_port);
570 BT_PUT(upstream_notif_iter);
571 if (!muxer_upstream_notif_iter) {
572 /*
573 * muxer_notif_iter_add_upstream_notif_iter()
574 * logs errors.
575 */
576 goto error;
577 }
578
579 remove_node:
580 bt_put(upstream_notif_iter);
581 muxer_notif_iter->newly_connected_priv_ports =
582 g_list_delete_link(
583 muxer_notif_iter->newly_connected_priv_ports,
584 node);
585 }
586
587 goto end;
588
589 error:
590 if (ret >= 0) {
591 ret = -1;
592 }
593
594 end:
595 return ret;
596 }
597
598 static
599 int get_notif_ts_ns(struct muxer_comp *muxer_comp,
600 struct muxer_notif_iter *muxer_notif_iter,
601 struct bt_notification *notif, int64_t last_returned_ts_ns,
602 int64_t *ts_ns)
603 {
604 struct bt_clock_class *clock_class = NULL;
605 struct bt_clock_value *clock_value = NULL;
606 struct bt_event *event = NULL;
607 int ret = 0;
608 const unsigned char *cc_uuid;
609 const char *cc_name;
610
611 BT_ASSERT(notif);
612 BT_ASSERT(ts_ns);
613
614 BT_LOGV("Getting notification's timestamp: "
615 "muxer-notif-iter-addr=%p, notif-addr=%p, "
616 "last-returned-ts=%" PRId64,
617 muxer_notif_iter, notif, last_returned_ts_ns);
618
619 switch (bt_notification_get_type(notif)) {
620 case BT_NOTIFICATION_TYPE_EVENT:
621 event = bt_notification_event_borrow_event(notif);
622 BT_ASSERT(event);
623 clock_value = bt_event_borrow_default_clock_value(event);
624 break;
625
626 case BT_NOTIFICATION_TYPE_INACTIVITY:
627 clock_value =
628 bt_notification_inactivity_borrow_default_clock_value(
629 notif);
630 break;
631 default:
632 /* All the other notifications have a higher priority */
633 BT_LOGV_STR("Notification has no timestamp: using the last returned timestamp.");
634 *ts_ns = last_returned_ts_ns;
635 goto end;
636 }
637
638 /*
639 * If the clock value is missing, then we consider that this
640 * notification has no time. In this case it's always the
641 * youngest.
642 */
643 if (!clock_value) {
644 BT_LOGV_STR("Notification's default clock value is missing: "
645 "using the last returned timestamp.");
646 *ts_ns = last_returned_ts_ns;
647 goto end;
648 }
649
650 clock_class = bt_clock_value_borrow_class(clock_value);
651 BT_ASSERT(clock_class);
652 cc_uuid = bt_clock_class_get_uuid(clock_class);
653 cc_name = bt_clock_class_get_name(clock_class);
654
655 if (muxer_notif_iter->clock_class_expectation ==
656 MUXER_NOTIF_ITER_CLOCK_CLASS_EXPECTATION_ANY) {
657 /*
658 * This is the first clock class that this muxer
659 * notification iterator encounters. Its properties
660 * determine what to expect for the whole lifetime of
661 * the iterator without a true
662 * `assume-absolute-clock-classes` parameter.
663 */
664 if (bt_clock_class_is_absolute(clock_class)) {
665 /* Expect absolute clock classes */
666 muxer_notif_iter->clock_class_expectation =
667 MUXER_NOTIF_ITER_CLOCK_CLASS_EXPECTATION_ABSOLUTE;
668 } else {
669 if (cc_uuid) {
670 /*
671 * Expect non-absolute clock classes
672 * with a specific UUID.
673 */
674 muxer_notif_iter->clock_class_expectation =
675 MUXER_NOTIF_ITER_CLOCK_CLASS_EXPECTATION_NOT_ABS_SPEC_UUID;
676 memcpy(muxer_notif_iter->expected_clock_class_uuid,
677 cc_uuid, BABELTRACE_UUID_LEN);
678 } else {
679 /*
680 * Expect non-absolute clock classes
681 * with no UUID.
682 */
683 muxer_notif_iter->clock_class_expectation =
684 MUXER_NOTIF_ITER_CLOCK_CLASS_EXPECTATION_NOT_ABS_NO_UUID;
685 }
686 }
687 }
688
689 if (!muxer_comp->assume_absolute_clock_classes) {
690 switch (muxer_notif_iter->clock_class_expectation) {
691 case MUXER_NOTIF_ITER_CLOCK_CLASS_EXPECTATION_ABSOLUTE:
692 if (!bt_clock_class_is_absolute(clock_class)) {
693 BT_LOGE("Expecting an absolute clock class, "
694 "but got a non-absolute one: "
695 "clock-class-addr=%p, clock-class-name=\"%s\"",
696 clock_class, cc_name);
697 goto error;
698 }
699 break;
700 case MUXER_NOTIF_ITER_CLOCK_CLASS_EXPECTATION_NOT_ABS_NO_UUID:
701 if (bt_clock_class_is_absolute(clock_class)) {
702 BT_LOGE("Expecting a non-absolute clock class with no UUID, "
703 "but got an absolute one: "
704 "clock-class-addr=%p, clock-class-name=\"%s\"",
705 clock_class, cc_name);
706 goto error;
707 }
708
709 if (cc_uuid) {
710 BT_LOGE("Expecting a non-absolute clock class with no UUID, "
711 "but got one with a UUID: "
712 "clock-class-addr=%p, clock-class-name=\"%s\", "
713 "uuid=\"%02x%02x%02x%02x-%02x%02x-%02x%02x-%02x%02x-%02x%02x%02x%02x%02x%02x\"",
714 clock_class, cc_name,
715 (unsigned int) cc_uuid[0],
716 (unsigned int) cc_uuid[1],
717 (unsigned int) cc_uuid[2],
718 (unsigned int) cc_uuid[3],
719 (unsigned int) cc_uuid[4],
720 (unsigned int) cc_uuid[5],
721 (unsigned int) cc_uuid[6],
722 (unsigned int) cc_uuid[7],
723 (unsigned int) cc_uuid[8],
724 (unsigned int) cc_uuid[9],
725 (unsigned int) cc_uuid[10],
726 (unsigned int) cc_uuid[11],
727 (unsigned int) cc_uuid[12],
728 (unsigned int) cc_uuid[13],
729 (unsigned int) cc_uuid[14],
730 (unsigned int) cc_uuid[15]);
731 goto error;
732 }
733 break;
734 case MUXER_NOTIF_ITER_CLOCK_CLASS_EXPECTATION_NOT_ABS_SPEC_UUID:
735 if (bt_clock_class_is_absolute(clock_class)) {
736 BT_LOGE("Expecting a non-absolute clock class with a specific UUID, "
737 "but got an absolute one: "
738 "clock-class-addr=%p, clock-class-name=\"%s\"",
739 clock_class, cc_name);
740 goto error;
741 }
742
743 if (!cc_uuid) {
744 BT_LOGE("Expecting a non-absolute clock class with a specific UUID, "
745 "but got one with no UUID: "
746 "clock-class-addr=%p, clock-class-name=\"%s\"",
747 clock_class, cc_name);
748 goto error;
749 }
750
751 if (memcmp(muxer_notif_iter->expected_clock_class_uuid,
752 cc_uuid, BABELTRACE_UUID_LEN) != 0) {
753 BT_LOGE("Expecting a non-absolute clock class with a specific UUID, "
754 "but got one with different UUID: "
755 "clock-class-addr=%p, clock-class-name=\"%s\", "
756 "expected-uuid=\"%02x%02x%02x%02x-%02x%02x-%02x%02x-%02x%02x-%02x%02x%02x%02x%02x%02x\", "
757 "uuid=\"%02x%02x%02x%02x-%02x%02x-%02x%02x-%02x%02x-%02x%02x%02x%02x%02x%02x\"",
758 clock_class, cc_name,
759 (unsigned int) muxer_notif_iter->expected_clock_class_uuid[0],
760 (unsigned int) muxer_notif_iter->expected_clock_class_uuid[1],
761 (unsigned int) muxer_notif_iter->expected_clock_class_uuid[2],
762 (unsigned int) muxer_notif_iter->expected_clock_class_uuid[3],
763 (unsigned int) muxer_notif_iter->expected_clock_class_uuid[4],
764 (unsigned int) muxer_notif_iter->expected_clock_class_uuid[5],
765 (unsigned int) muxer_notif_iter->expected_clock_class_uuid[6],
766 (unsigned int) muxer_notif_iter->expected_clock_class_uuid[7],
767 (unsigned int) muxer_notif_iter->expected_clock_class_uuid[8],
768 (unsigned int) muxer_notif_iter->expected_clock_class_uuid[9],
769 (unsigned int) muxer_notif_iter->expected_clock_class_uuid[10],
770 (unsigned int) muxer_notif_iter->expected_clock_class_uuid[11],
771 (unsigned int) muxer_notif_iter->expected_clock_class_uuid[12],
772 (unsigned int) muxer_notif_iter->expected_clock_class_uuid[13],
773 (unsigned int) muxer_notif_iter->expected_clock_class_uuid[14],
774 (unsigned int) muxer_notif_iter->expected_clock_class_uuid[15],
775 (unsigned int) cc_uuid[0],
776 (unsigned int) cc_uuid[1],
777 (unsigned int) cc_uuid[2],
778 (unsigned int) cc_uuid[3],
779 (unsigned int) cc_uuid[4],
780 (unsigned int) cc_uuid[5],
781 (unsigned int) cc_uuid[6],
782 (unsigned int) cc_uuid[7],
783 (unsigned int) cc_uuid[8],
784 (unsigned int) cc_uuid[9],
785 (unsigned int) cc_uuid[10],
786 (unsigned int) cc_uuid[11],
787 (unsigned int) cc_uuid[12],
788 (unsigned int) cc_uuid[13],
789 (unsigned int) cc_uuid[14],
790 (unsigned int) cc_uuid[15]);
791 goto error;
792 }
793 break;
794 default:
795 /* Unexpected */
796 BT_LOGF("Unexpected clock class expectation: "
797 "expectation-code=%d",
798 muxer_notif_iter->clock_class_expectation);
799 abort();
800 }
801 }
802
803 ret = bt_clock_value_get_value_ns_from_epoch(clock_value, ts_ns);
804 if (ret) {
805 BT_LOGE("Cannot get nanoseconds from Epoch of clock value: "
806 "clock-value-addr=%p", clock_value);
807 goto error;
808 }
809
810 goto end;
811
812 error:
813 ret = -1;
814
815 end:
816 if (ret == 0) {
817 BT_LOGV("Found notification's timestamp: "
818 "muxer-notif-iter-addr=%p, notif-addr=%p, "
819 "last-returned-ts=%" PRId64 ", ts=%" PRId64,
820 muxer_notif_iter, notif, last_returned_ts_ns,
821 *ts_ns);
822 }
823
824 return ret;
825 }
826
827 /*
828 * This function finds the youngest available notification amongst the
829 * non-ended upstream notification iterators and returns the upstream
830 * notification iterator which has it, or
831 * BT_NOTIFICATION_ITERATOR_STATUS_END if there's no available
832 * notification.
833 *
834 * This function does NOT:
835 *
836 * * Update any upstream notification iterator.
837 * * Check for newly connected ports.
838 * * Check the upstream notification iterators to retry.
839 *
840 * On sucess, this function sets *muxer_upstream_notif_iter to the
841 * upstream notification iterator of which the current notification is
842 * the youngest, and sets *ts_ns to its time.
843 */
844 static
845 enum bt_notification_iterator_status
846 muxer_notif_iter_youngest_upstream_notif_iter(
847 struct muxer_comp *muxer_comp,
848 struct muxer_notif_iter *muxer_notif_iter,
849 struct muxer_upstream_notif_iter **muxer_upstream_notif_iter,
850 int64_t *ts_ns)
851 {
852 size_t i;
853 int ret;
854 int64_t youngest_ts_ns = INT64_MAX;
855 enum bt_notification_iterator_status status =
856 BT_NOTIFICATION_ITERATOR_STATUS_OK;
857
858 BT_ASSERT(muxer_comp);
859 BT_ASSERT(muxer_notif_iter);
860 BT_ASSERT(muxer_upstream_notif_iter);
861 *muxer_upstream_notif_iter = NULL;
862
863 for (i = 0; i < muxer_notif_iter->muxer_upstream_notif_iters->len; i++) {
864 struct bt_notification *notif;
865 struct muxer_upstream_notif_iter *cur_muxer_upstream_notif_iter =
866 g_ptr_array_index(muxer_notif_iter->muxer_upstream_notif_iters, i);
867 int64_t notif_ts_ns;
868
869 if (!cur_muxer_upstream_notif_iter->notif_iter) {
870 /* This upstream notification iterator is ended */
871 BT_LOGV("Skipping ended upstream notification iterator: "
872 "muxer-upstream-notif-iter-wrap-addr=%p",
873 cur_muxer_upstream_notif_iter);
874 continue;
875 }
876
877 BT_ASSERT(cur_muxer_upstream_notif_iter->notifs->length > 0);
878 notif = g_queue_peek_head(cur_muxer_upstream_notif_iter->notifs);
879 BT_ASSERT(notif);
880 ret = get_notif_ts_ns(muxer_comp, muxer_notif_iter, notif,
881 muxer_notif_iter->last_returned_ts_ns, &notif_ts_ns);
882 if (ret) {
883 /* get_notif_ts_ns() logs errors */
884 *muxer_upstream_notif_iter = NULL;
885 status = BT_NOTIFICATION_ITERATOR_STATUS_ERROR;
886 goto end;
887 }
888
889 if (notif_ts_ns <= youngest_ts_ns) {
890 *muxer_upstream_notif_iter =
891 cur_muxer_upstream_notif_iter;
892 youngest_ts_ns = notif_ts_ns;
893 *ts_ns = youngest_ts_ns;
894 }
895 }
896
897 if (!*muxer_upstream_notif_iter) {
898 status = BT_NOTIFICATION_ITERATOR_STATUS_END;
899 *ts_ns = INT64_MIN;
900 }
901
902 end:
903 return status;
904 }
905
906 static
907 enum bt_notification_iterator_status validate_muxer_upstream_notif_iter(
908 struct muxer_upstream_notif_iter *muxer_upstream_notif_iter)
909 {
910 enum bt_notification_iterator_status status =
911 BT_NOTIFICATION_ITERATOR_STATUS_OK;
912
913 BT_LOGV("Validating muxer's upstream notification iterator wrapper: "
914 "muxer-upstream-notif-iter-wrap-addr=%p",
915 muxer_upstream_notif_iter);
916
917 if (muxer_upstream_notif_iter->notifs->length > 0 ||
918 !muxer_upstream_notif_iter->notif_iter) {
919 BT_LOGV("Already valid or not considered: "
920 "queue-len=%u, upstream-notif-iter-addr=%p",
921 muxer_upstream_notif_iter->notifs->length,
922 muxer_upstream_notif_iter->notif_iter);
923 goto end;
924 }
925
926 /* muxer_upstream_notif_iter_next() logs details/errors */
927 status = muxer_upstream_notif_iter_next(muxer_upstream_notif_iter);
928
929 end:
930 return status;
931 }
932
933 static
934 enum bt_notification_iterator_status validate_muxer_upstream_notif_iters(
935 struct muxer_notif_iter *muxer_notif_iter)
936 {
937 enum bt_notification_iterator_status status =
938 BT_NOTIFICATION_ITERATOR_STATUS_OK;
939 size_t i;
940
941 BT_LOGV("Validating muxer's upstream notification iterator wrappers: "
942 "muxer-notif-iter-addr=%p", muxer_notif_iter);
943
944 for (i = 0; i < muxer_notif_iter->muxer_upstream_notif_iters->len; i++) {
945 struct muxer_upstream_notif_iter *muxer_upstream_notif_iter =
946 g_ptr_array_index(
947 muxer_notif_iter->muxer_upstream_notif_iters,
948 i);
949
950 status = validate_muxer_upstream_notif_iter(
951 muxer_upstream_notif_iter);
952 if (status != BT_NOTIFICATION_ITERATOR_STATUS_OK) {
953 if (status < 0) {
954 BT_LOGE("Cannot validate muxer's upstream notification iterator wrapper: "
955 "muxer-notif-iter-addr=%p, "
956 "muxer-upstream-notif-iter-wrap-addr=%p",
957 muxer_notif_iter,
958 muxer_upstream_notif_iter);
959 } else {
960 BT_LOGV("Cannot validate muxer's upstream notification iterator wrapper: "
961 "muxer-notif-iter-addr=%p, "
962 "muxer-upstream-notif-iter-wrap-addr=%p",
963 muxer_notif_iter,
964 muxer_upstream_notif_iter);
965 }
966
967 goto end;
968 }
969
970 /*
971 * Remove this muxer upstream notification iterator
972 * if it's ended or canceled.
973 */
974 if (!muxer_upstream_notif_iter->notif_iter) {
975 /*
976 * Use g_ptr_array_remove_fast() because the
977 * order of those elements is not important.
978 */
979 BT_LOGV("Removing muxer's upstream notification iterator wrapper: ended or canceled: "
980 "muxer-notif-iter-addr=%p, "
981 "muxer-upstream-notif-iter-wrap-addr=%p",
982 muxer_notif_iter, muxer_upstream_notif_iter);
983 g_ptr_array_remove_index_fast(
984 muxer_notif_iter->muxer_upstream_notif_iters,
985 i);
986 i--;
987 }
988 }
989
990 end:
991 return status;
992 }
993
994 static inline
995 enum bt_notification_iterator_status muxer_notif_iter_do_next_one(
996 struct muxer_comp *muxer_comp,
997 struct muxer_notif_iter *muxer_notif_iter,
998 struct bt_notification **notif)
999 {
1000 enum bt_notification_iterator_status status =
1001 BT_NOTIFICATION_ITERATOR_STATUS_OK;
1002 struct muxer_upstream_notif_iter *muxer_upstream_notif_iter = NULL;
1003 int64_t next_return_ts;
1004
1005 while (true) {
1006 int ret = muxer_notif_iter_handle_newly_connected_ports(
1007 muxer_notif_iter);
1008
1009 if (ret) {
1010 BT_LOGE("Cannot handle newly connected input ports for muxer's notification iterator: "
1011 "muxer-comp-addr=%p, muxer-notif-iter-addr=%p, "
1012 "ret=%d",
1013 muxer_comp, muxer_notif_iter, ret);
1014 status = BT_NOTIFICATION_ITERATOR_STATUS_ERROR;
1015 goto end;
1016 }
1017
1018 status = validate_muxer_upstream_notif_iters(muxer_notif_iter);
1019 if (status != BT_NOTIFICATION_ITERATOR_STATUS_OK) {
1020 /* validate_muxer_upstream_notif_iters() logs details */
1021 goto end;
1022 }
1023
1024 /*
1025 * At this point, we know that all the existing upstream
1026 * notification iterators are valid. However the
1027 * operations to validate them (during
1028 * validate_muxer_upstream_notif_iters()) may have
1029 * connected new ports. If no ports were connected
1030 * during this operation, exit the loop.
1031 */
1032 if (!muxer_notif_iter->newly_connected_priv_ports) {
1033 BT_LOGV("Not breaking this loop: muxer's notification iterator still has newly connected input ports to handle: "
1034 "muxer-comp-addr=%p", muxer_comp);
1035 break;
1036 }
1037 }
1038
1039 BT_ASSERT(!muxer_notif_iter->newly_connected_priv_ports);
1040
1041 /*
1042 * At this point we know that all the existing upstream
1043 * notification iterators are valid. We can find the one,
1044 * amongst those, of which the current notification is the
1045 * youngest.
1046 */
1047 status = muxer_notif_iter_youngest_upstream_notif_iter(muxer_comp,
1048 muxer_notif_iter, &muxer_upstream_notif_iter,
1049 &next_return_ts);
1050 if (status < 0 || status == BT_NOTIFICATION_ITERATOR_STATUS_END ||
1051 status == BT_NOTIFICATION_ITERATOR_STATUS_CANCELED) {
1052 if (status < 0) {
1053 BT_LOGE("Cannot find the youngest upstream notification iterator wrapper: "
1054 "status=%s",
1055 bt_notification_iterator_status_string(status));
1056 } else {
1057 BT_LOGV("Cannot find the youngest upstream notification iterator wrapper: "
1058 "status=%s",
1059 bt_notification_iterator_status_string(status));
1060 }
1061
1062 goto end;
1063 }
1064
1065 if (next_return_ts < muxer_notif_iter->last_returned_ts_ns) {
1066 BT_LOGE("Youngest upstream notification iterator wrapper's timestamp is less than muxer's notification iterator's last returned timestamp: "
1067 "muxer-notif-iter-addr=%p, ts=%" PRId64 ", "
1068 "last-returned-ts=%" PRId64,
1069 muxer_notif_iter, next_return_ts,
1070 muxer_notif_iter->last_returned_ts_ns);
1071 status = BT_NOTIFICATION_ITERATOR_STATUS_ERROR;
1072 goto end;
1073 }
1074
1075 BT_LOGV("Found youngest upstream notification iterator wrapper: "
1076 "muxer-notif-iter-addr=%p, "
1077 "muxer-upstream-notif-iter-wrap-addr=%p, "
1078 "ts=%" PRId64,
1079 muxer_notif_iter, muxer_upstream_notif_iter, next_return_ts);
1080 BT_ASSERT(status == BT_NOTIFICATION_ITERATOR_STATUS_OK);
1081 BT_ASSERT(muxer_upstream_notif_iter);
1082
1083 /*
1084 * Consume from the queue's head: other side
1085 * (muxer_upstream_notif_iter_next()) writes to the tail.
1086 */
1087 *notif = g_queue_pop_head(muxer_upstream_notif_iter->notifs);
1088 BT_ASSERT(*notif);
1089 muxer_notif_iter->last_returned_ts_ns = next_return_ts;
1090
1091 end:
1092 return status;
1093 }
1094
1095 static
1096 enum bt_notification_iterator_status muxer_notif_iter_do_next(
1097 struct muxer_comp *muxer_comp,
1098 struct muxer_notif_iter *muxer_notif_iter,
1099 bt_notification_array notifs, uint64_t capacity,
1100 uint64_t *count)
1101 {
1102 enum bt_notification_iterator_status status =
1103 BT_NOTIFICATION_ITERATOR_STATUS_OK;
1104 uint64_t i = 0;
1105
1106 while (i < capacity && status == BT_NOTIFICATION_ITERATOR_STATUS_OK) {
1107 status = muxer_notif_iter_do_next_one(muxer_comp,
1108 muxer_notif_iter, &notifs[i]);
1109 if (status == BT_NOTIFICATION_ITERATOR_STATUS_OK) {
1110 i++;
1111 }
1112 }
1113
1114 if (i > 0) {
1115 /*
1116 * Even if muxer_notif_iter_do_next_one() returned
1117 * something else than
1118 * BT_NOTIFICATION_ITERATOR_STATUS_OK, we accumulated
1119 * notification objects in the output notification
1120 * array, so we need to return
1121 * BT_NOTIFICATION_ITERATOR_STATUS_OK so that they are
1122 * transfered to downstream. This other status occurs
1123 * again the next time muxer_notif_iter_do_next() is
1124 * called, possibly without any accumulated
1125 * notification, in which case we'll return it.
1126 */
1127 *count = i;
1128 status = BT_NOTIFICATION_ITERATOR_STATUS_OK;
1129 }
1130
1131 return status;
1132 }
1133
1134 static
1135 void destroy_muxer_notif_iter(struct muxer_notif_iter *muxer_notif_iter)
1136 {
1137 if (!muxer_notif_iter) {
1138 return;
1139 }
1140
1141 BT_LOGD("Destroying muxer component's notification iterator: "
1142 "muxer-notif-iter-addr=%p", muxer_notif_iter);
1143
1144 if (muxer_notif_iter->muxer_upstream_notif_iters) {
1145 BT_LOGD_STR("Destroying muxer's upstream notification iterator wrappers.");
1146 g_ptr_array_free(
1147 muxer_notif_iter->muxer_upstream_notif_iters, TRUE);
1148 }
1149
1150 g_list_free(muxer_notif_iter->newly_connected_priv_ports);
1151 g_free(muxer_notif_iter);
1152 }
1153
1154 static
1155 int muxer_notif_iter_init_newly_connected_ports(struct muxer_comp *muxer_comp,
1156 struct muxer_notif_iter *muxer_notif_iter)
1157 {
1158 struct bt_component *comp;
1159 int64_t count;
1160 int64_t i;
1161 int ret = 0;
1162
1163 /*
1164 * Add the connected input ports to this muxer notification
1165 * iterator's list of newly connected ports. They will be
1166 * handled by muxer_notif_iter_handle_newly_connected_ports().
1167 */
1168 comp = bt_component_borrow_from_private(muxer_comp->priv_comp);
1169 BT_ASSERT(comp);
1170 count = bt_component_filter_get_input_port_count(comp);
1171 if (count < 0) {
1172 BT_LOGD("No input port to initialize for muxer component's notification iterator: "
1173 "muxer-comp-addr=%p, muxer-notif-iter-addr=%p",
1174 muxer_comp, muxer_notif_iter);
1175 goto end;
1176 }
1177
1178 for (i = 0; i < count; i++) {
1179 struct bt_private_port *priv_port =
1180 bt_private_component_filter_get_input_private_port_by_index(
1181 muxer_comp->priv_comp, i);
1182 struct bt_port *port;
1183
1184 BT_ASSERT(priv_port);
1185 port = bt_port_borrow_from_private(priv_port);
1186 BT_ASSERT(port);
1187
1188 if (!bt_port_is_connected(port)) {
1189 BT_LOGD("Skipping input port: not connected: "
1190 "muxer-comp-addr=%p, port-addr=%p, port-name\"%s\"",
1191 muxer_comp, port, bt_port_get_name(port));
1192 bt_put(priv_port);
1193 continue;
1194 }
1195
1196 bt_put(priv_port);
1197 muxer_notif_iter->newly_connected_priv_ports =
1198 g_list_append(
1199 muxer_notif_iter->newly_connected_priv_ports,
1200 priv_port);
1201 if (!muxer_notif_iter->newly_connected_priv_ports) {
1202 BT_LOGE("Cannot append port to muxer's notification iterator list of newly connected input ports: "
1203 "port-addr=%p, port-name=\"%s\", "
1204 "muxer-notif-iter-addr=%p", port,
1205 bt_port_get_name(port), muxer_notif_iter);
1206 ret = -1;
1207 goto end;
1208 }
1209
1210 BT_LOGD("Appended port to muxer's notification iterator list of newly connected input ports: "
1211 "port-addr=%p, port-name=\"%s\", "
1212 "muxer-notif-iter-addr=%p", port,
1213 bt_port_get_name(port), muxer_notif_iter);
1214 }
1215
1216 end:
1217 return ret;
1218 }
1219
1220 BT_HIDDEN
1221 enum bt_notification_iterator_status muxer_notif_iter_init(
1222 struct bt_private_connection_private_notification_iterator *priv_notif_iter,
1223 struct bt_private_port *output_priv_port)
1224 {
1225 struct muxer_comp *muxer_comp = NULL;
1226 struct muxer_notif_iter *muxer_notif_iter = NULL;
1227 struct bt_private_component *priv_comp = NULL;
1228 enum bt_notification_iterator_status status =
1229 BT_NOTIFICATION_ITERATOR_STATUS_OK;
1230 int ret;
1231
1232 priv_comp = bt_private_connection_private_notification_iterator_get_private_component(
1233 priv_notif_iter);
1234 BT_ASSERT(priv_comp);
1235 muxer_comp = bt_private_component_get_user_data(priv_comp);
1236 BT_ASSERT(muxer_comp);
1237 BT_LOGD("Initializing muxer component's notification iterator: "
1238 "comp-addr=%p, muxer-comp-addr=%p, notif-iter-addr=%p",
1239 priv_comp, muxer_comp, priv_notif_iter);
1240
1241 if (muxer_comp->initializing_muxer_notif_iter) {
1242 /*
1243 * Weird, unhandled situation detected: downstream
1244 * creates a muxer notification iterator while creating
1245 * another muxer notification iterator (same component).
1246 */
1247 BT_LOGE("Recursive initialization of muxer component's notification iterator: "
1248 "comp-addr=%p, muxer-comp-addr=%p, notif-iter-addr=%p",
1249 priv_comp, muxer_comp, priv_notif_iter);
1250 goto error;
1251 }
1252
1253 muxer_comp->initializing_muxer_notif_iter = true;
1254 muxer_notif_iter = g_new0(struct muxer_notif_iter, 1);
1255 if (!muxer_notif_iter) {
1256 BT_LOGE_STR("Failed to allocate one muxer component's notification iterator.");
1257 goto error;
1258 }
1259
1260 muxer_notif_iter->last_returned_ts_ns = INT64_MIN;
1261 muxer_notif_iter->muxer_upstream_notif_iters =
1262 g_ptr_array_new_with_free_func(
1263 (GDestroyNotify) destroy_muxer_upstream_notif_iter);
1264 if (!muxer_notif_iter->muxer_upstream_notif_iters) {
1265 BT_LOGE_STR("Failed to allocate a GPtrArray.");
1266 goto error;
1267 }
1268
1269 /*
1270 * Add the muxer notification iterator to the component's array
1271 * of muxer notification iterators here because
1272 * muxer_notif_iter_init_newly_connected_ports() can cause
1273 * muxer_port_connected() to be called, which adds the newly
1274 * connected port to each muxer notification iterator's list of
1275 * newly connected ports.
1276 */
1277 g_ptr_array_add(muxer_comp->muxer_notif_iters, muxer_notif_iter);
1278 ret = muxer_notif_iter_init_newly_connected_ports(muxer_comp,
1279 muxer_notif_iter);
1280 if (ret) {
1281 BT_LOGE("Cannot initialize newly connected input ports for muxer component's notification iterator: "
1282 "comp-addr=%p, muxer-comp-addr=%p, "
1283 "muxer-notif-iter-addr=%p, notif-iter-addr=%p, ret=%d",
1284 priv_comp, muxer_comp, muxer_notif_iter,
1285 priv_notif_iter, ret);
1286 goto error;
1287 }
1288
1289 ret = bt_private_connection_private_notification_iterator_set_user_data(priv_notif_iter,
1290 muxer_notif_iter);
1291 BT_ASSERT(ret == 0);
1292 BT_LOGD("Initialized muxer component's notification iterator: "
1293 "comp-addr=%p, muxer-comp-addr=%p, muxer-notif-iter-addr=%p, "
1294 "notif-iter-addr=%p",
1295 priv_comp, muxer_comp, muxer_notif_iter, priv_notif_iter);
1296 goto end;
1297
1298 error:
1299 if (g_ptr_array_index(muxer_comp->muxer_notif_iters,
1300 muxer_comp->muxer_notif_iters->len - 1) == muxer_notif_iter) {
1301 g_ptr_array_remove_index(muxer_comp->muxer_notif_iters,
1302 muxer_comp->muxer_notif_iters->len - 1);
1303 }
1304
1305 destroy_muxer_notif_iter(muxer_notif_iter);
1306 ret = bt_private_connection_private_notification_iterator_set_user_data(priv_notif_iter,
1307 NULL);
1308 BT_ASSERT(ret == 0);
1309 status = BT_NOTIFICATION_ITERATOR_STATUS_ERROR;
1310
1311 end:
1312 muxer_comp->initializing_muxer_notif_iter = false;
1313 bt_put(priv_comp);
1314 return status;
1315 }
1316
1317 BT_HIDDEN
1318 void muxer_notif_iter_finalize(
1319 struct bt_private_connection_private_notification_iterator *priv_notif_iter)
1320 {
1321 struct muxer_notif_iter *muxer_notif_iter =
1322 bt_private_connection_private_notification_iterator_get_user_data(priv_notif_iter);
1323 struct bt_private_component *priv_comp = NULL;
1324 struct muxer_comp *muxer_comp = NULL;
1325
1326 priv_comp = bt_private_connection_private_notification_iterator_get_private_component(
1327 priv_notif_iter);
1328 BT_ASSERT(priv_comp);
1329 muxer_comp = bt_private_component_get_user_data(priv_comp);
1330 BT_LOGD("Finalizing muxer component's notification iterator: "
1331 "comp-addr=%p, muxer-comp-addr=%p, muxer-notif-iter-addr=%p, "
1332 "notif-iter-addr=%p",
1333 priv_comp, muxer_comp, muxer_notif_iter, priv_notif_iter);
1334
1335 if (muxer_comp) {
1336 (void) g_ptr_array_remove_fast(muxer_comp->muxer_notif_iters,
1337 muxer_notif_iter);
1338 destroy_muxer_notif_iter(muxer_notif_iter);
1339 }
1340
1341 bt_put(priv_comp);
1342 }
1343
1344 BT_HIDDEN
1345 enum bt_notification_iterator_status muxer_notif_iter_next(
1346 struct bt_private_connection_private_notification_iterator *priv_notif_iter,
1347 bt_notification_array notifs, uint64_t capacity,
1348 uint64_t *count)
1349 {
1350 enum bt_notification_iterator_status status;
1351 struct muxer_notif_iter *muxer_notif_iter =
1352 bt_private_connection_private_notification_iterator_get_user_data(priv_notif_iter);
1353 struct bt_private_component *priv_comp = NULL;
1354 struct muxer_comp *muxer_comp = NULL;
1355
1356 BT_ASSERT(muxer_notif_iter);
1357 priv_comp = bt_private_connection_private_notification_iterator_get_private_component(
1358 priv_notif_iter);
1359 BT_ASSERT(priv_comp);
1360 muxer_comp = bt_private_component_get_user_data(priv_comp);
1361 BT_ASSERT(muxer_comp);
1362 BT_LOGV("Muxer component's notification iterator's \"next\" method called: "
1363 "comp-addr=%p, muxer-comp-addr=%p, muxer-notif-iter-addr=%p, "
1364 "notif-iter-addr=%p",
1365 priv_comp, muxer_comp, muxer_notif_iter, priv_notif_iter);
1366
1367 status = muxer_notif_iter_do_next(muxer_comp, muxer_notif_iter,
1368 notifs, capacity, count);
1369 if (status < 0) {
1370 BT_LOGE("Cannot get next notification: "
1371 "comp-addr=%p, muxer-comp-addr=%p, muxer-notif-iter-addr=%p, "
1372 "notif-iter-addr=%p, status=%s",
1373 priv_comp, muxer_comp, muxer_notif_iter, priv_notif_iter,
1374 bt_notification_iterator_status_string(status));
1375 } else {
1376 BT_LOGV("Returning from muxer component's notification iterator's \"next\" method: "
1377 "status=%s",
1378 bt_notification_iterator_status_string(status));
1379 }
1380
1381 bt_put(priv_comp);
1382 return status;
1383 }
1384
1385 BT_HIDDEN
1386 enum bt_component_status muxer_port_connected(
1387 struct bt_private_component *priv_comp,
1388 struct bt_private_port *self_private_port,
1389 struct bt_port *other_port)
1390 {
1391 enum bt_component_status status = BT_COMPONENT_STATUS_OK;
1392 struct bt_port *self_port =
1393 bt_port_borrow_from_private(self_private_port);
1394 struct muxer_comp *muxer_comp =
1395 bt_private_component_get_user_data(priv_comp);
1396 size_t i;
1397 int ret;
1398
1399 BT_ASSERT(self_port);
1400 BT_ASSERT(muxer_comp);
1401 BT_LOGD("Port connected: "
1402 "comp-addr=%p, muxer-comp-addr=%p, "
1403 "port-addr=%p, port-name=\"%s\", "
1404 "other-port-addr=%p, other-port-name=\"%s\"",
1405 priv_comp, muxer_comp, self_port, bt_port_get_name(self_port),
1406 other_port, bt_port_get_name(other_port));
1407
1408 if (bt_port_get_type(self_port) == BT_PORT_TYPE_OUTPUT) {
1409 goto end;
1410 }
1411
1412 for (i = 0; i < muxer_comp->muxer_notif_iters->len; i++) {
1413 struct muxer_notif_iter *muxer_notif_iter =
1414 g_ptr_array_index(muxer_comp->muxer_notif_iters, i);
1415
1416 /*
1417 * Add this port to the list of newly connected ports
1418 * for this muxer notification iterator. We append at
1419 * the end of this list while
1420 * muxer_notif_iter_handle_newly_connected_ports()
1421 * removes the nodes from the beginning.
1422 */
1423 muxer_notif_iter->newly_connected_priv_ports =
1424 g_list_append(
1425 muxer_notif_iter->newly_connected_priv_ports,
1426 self_private_port);
1427 if (!muxer_notif_iter->newly_connected_priv_ports) {
1428 BT_LOGE("Cannot append port to muxer's notification iterator list of newly connected input ports: "
1429 "port-addr=%p, port-name=\"%s\", "
1430 "muxer-notif-iter-addr=%p", self_port,
1431 bt_port_get_name(self_port), muxer_notif_iter);
1432 status = BT_COMPONENT_STATUS_ERROR;
1433 goto end;
1434 }
1435
1436 BT_LOGD("Appended port to muxer's notification iterator list of newly connected input ports: "
1437 "port-addr=%p, port-name=\"%s\", "
1438 "muxer-notif-iter-addr=%p", self_port,
1439 bt_port_get_name(self_port), muxer_notif_iter);
1440 }
1441
1442 /* One less available input port */
1443 muxer_comp->available_input_ports--;
1444 ret = ensure_available_input_port(priv_comp);
1445 if (ret) {
1446 /*
1447 * Only way to report an error later since this
1448 * method does not return anything.
1449 */
1450 BT_LOGE("Cannot ensure that at least one muxer component's input port is available: "
1451 "muxer-comp-addr=%p, status=%s",
1452 muxer_comp, bt_component_status_string(ret));
1453 status = BT_COMPONENT_STATUS_ERROR;
1454 goto end;
1455 }
1456
1457 end:
1458 return status;
1459 }
1460
1461 BT_HIDDEN
1462 void muxer_port_disconnected(struct bt_private_component *priv_comp,
1463 struct bt_private_port *priv_port)
1464 {
1465 struct bt_port *port = bt_port_borrow_from_private(priv_port);
1466 struct muxer_comp *muxer_comp =
1467 bt_private_component_get_user_data(priv_comp);
1468
1469 BT_ASSERT(port);
1470 BT_ASSERT(muxer_comp);
1471 BT_LOGD("Port disconnected: "
1472 "comp-addr=%p, muxer-comp-addr=%p, port-addr=%p, "
1473 "port-name=\"%s\"", priv_comp, muxer_comp,
1474 port, bt_port_get_name(port));
1475
1476 /*
1477 * There's nothing special to do when a port is disconnected
1478 * because this component deals with upstream notification
1479 * iterators which were already created thanks to connected
1480 * ports. The fact that the port is disconnected does not cancel
1481 * the upstream notification iterators created using its
1482 * connection: they still exist, even if the connection is dead.
1483 * The only way to remove an upstream notification iterator is
1484 * for its "next" operation to return
1485 * BT_NOTIFICATION_ITERATOR_STATUS_END.
1486 */
1487 if (bt_port_get_type(port) == BT_PORT_TYPE_INPUT) {
1488 /* One more available input port */
1489 muxer_comp->available_input_ports++;
1490 BT_LOGD("Leaving disconnected input port available for future connections: "
1491 "comp-addr=%p, muxer-comp-addr=%p, port-addr=%p, "
1492 "port-name=\"%s\", avail-input-port-count=%zu",
1493 priv_comp, muxer_comp, port, bt_port_get_name(port),
1494 muxer_comp->available_input_ports);
1495 }
1496 }
BabelTrace - Trace Format Babel Tower
This page took 0.119213 seconds and 3 git commands to generate.