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