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