lib/graph/iterator.c

   1 /*
   2  * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
   3  * Copyright 2015 Jérémie Galarneau <jeremie.galarneau@efficios.com>
   4  *
   5  * Permission is hereby granted, free of charge, to any person obtaining a copy
   6  * of this software and associated documentation files (the "Software"), to deal
   7  * in the Software without restriction, including without limitation the rights
   8  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
   9  * copies of the Software, and to permit persons to whom the Software is
  10  * furnished to do so, subject to the following conditions:
  11  *
  12  * The above copyright notice and this permission notice shall be included in
  13  * all copies or substantial portions of the Software.
  14  *
  15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  16  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  17  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  18  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  19  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  20  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  21  * SOFTWARE.
  22  */
  23
  24 #define BT_LOG_TAG "MSG-ITER"
  25 #include <babeltrace/lib-logging-internal.h>
  26
  27 #include <babeltrace/compiler-internal.h>
  28 #include <babeltrace/trace-ir/clock-class-internal.h>
  29 #include <babeltrace/trace-ir/clock-snapshot-internal.h>
  30 #include <babeltrace/trace-ir/field.h>
  31 #include <babeltrace/trace-ir/event-const.h>
  32 #include <babeltrace/trace-ir/event-internal.h>
  33 #include <babeltrace/trace-ir/packet-const.h>
  34 #include <babeltrace/trace-ir/packet-internal.h>
  35 #include <babeltrace/trace-ir/stream-internal.h>
  36 #include <babeltrace/graph/connection-const.h>
  37 #include <babeltrace/graph/connection-internal.h>
  38 #include <babeltrace/graph/component-const.h>
  39 #include <babeltrace/graph/component-internal.h>
  40 #include <babeltrace/graph/component-source-internal.h>
  41 #include <babeltrace/graph/component-class-internal.h>
  42 #include <babeltrace/graph/component-class-sink-colander-internal.h>
  43 #include <babeltrace/graph/component-sink-const.h>
  44 #include <babeltrace/graph/component-sink-internal.h>
  45 #include <babeltrace/graph/message-const.h>
  46 #include <babeltrace/graph/message-iterator-const.h>
  47 #include <babeltrace/graph/message-iterator-internal.h>
  48 #include <babeltrace/graph/self-component-port-input-message-iterator.h>
  49 #include <babeltrace/graph/port-output-message-iterator.h>
  50 #include <babeltrace/graph/message-internal.h>
  51 #include <babeltrace/graph/message-event-const.h>
  52 #include <babeltrace/graph/message-event-internal.h>
  53 #include <babeltrace/graph/message-packet-beginning-const.h>
  54 #include <babeltrace/graph/message-packet-end-const.h>
  55 #include <babeltrace/graph/message-packet-internal.h>
  56 #include <babeltrace/graph/message-stream-beginning-const.h>
  57 #include <babeltrace/graph/message-stream-end-const.h>
  58 #include <babeltrace/graph/message-stream-internal.h>
  59 #include <babeltrace/graph/message-message-iterator-inactivity-internal.h>
  60 #include <babeltrace/graph/message-discarded-items-internal.h>
  61 #include <babeltrace/graph/message-stream-activity-internal.h>
  62 #include <babeltrace/graph/port-const.h>
  63 #include <babeltrace/graph/graph.h>
  64 #include <babeltrace/graph/graph-const.h>
  65 #include <babeltrace/graph/graph-internal.h>
  66 #include <babeltrace/types.h>
  67 #include <babeltrace/assert-internal.h>
  68 #include <babeltrace/assert-pre-internal.h>
  69 #include <stdint.h>
  70 #include <inttypes.h>
  71 #include <stdlib.h>
  72
  73 /*
  74  * TODO: Use graph's state (number of active iterators, etc.) and
  75  * possibly system specifications to make a better guess than this.
  76  */
  77 #define MSG_BATCH_SIZE  15
  78
  79 #define BT_ASSERT_PRE_ITER_HAS_STATE_TO_SEEK(_iter)                     \
  80         BT_ASSERT_PRE((_iter)->state == BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_ACTIVE || \
  81                 (_iter)->state == BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_ENDED || \
  82                 (_iter)->state == BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_LAST_SEEKING_RETURNED_AGAIN || \
  83                 (_iter)->state == BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_LAST_SEEKING_RETURNED_ERROR, \
  84                 "Message iterator is in the wrong state: %!+i", _iter)
  85
  86 static inline
  87 void _set_self_comp_port_input_msg_iterator_state(
  88                 struct bt_self_component_port_input_message_iterator *iterator,
  89                 enum bt_self_component_port_input_message_iterator_state state)
  90 {
  91         BT_ASSERT(iterator);
  92         BT_LIB_LOGD("Updating message iterator's state: new-state=%s",
  93                 bt_self_component_port_input_message_iterator_state_string(state));
  94         iterator->state = state;
  95 }
  96
  97 #ifdef BT_DEV_MODE
  98 # define set_self_comp_port_input_msg_iterator_state _set_self_comp_port_input_msg_iterator_state
  99 #else
 100 # define set_self_comp_port_input_msg_iterator_state(_a, _b)
 101 #endif
 102
 103 static
 104 void destroy_base_message_iterator(struct bt_object *obj)
 105 {
 106         struct bt_message_iterator *iterator = (void *) obj;
 107
 108         BT_ASSERT(iterator);
 109
 110         if (iterator->msgs) {
 111                 g_ptr_array_free(iterator->msgs, TRUE);
 112                 iterator->msgs = NULL;
 113         }
 114
 115         g_free(iterator);
 116 }
 117
 118 static
 119 void bt_self_component_port_input_message_iterator_destroy(struct bt_object *obj)
 120 {
 121         struct bt_self_component_port_input_message_iterator *iterator;
 122
 123         BT_ASSERT(obj);
 124
 125         /*
 126          * The message iterator's reference count is 0 if we're
 127          * here. Increment it to avoid a double-destroy (possibly
 128          * infinitely recursive). This could happen for example if the
 129          * message iterator's finalization function does
 130          * bt_object_get_ref() (or anything that causes
 131          * bt_object_get_ref() to be called) on itself (ref. count goes
 132          * from 0 to 1), and then bt_object_put_ref(): the reference
 133          * count would go from 1 to 0 again and this function would be
 134          * called again.
 135          */
 136         obj->ref_count++;
 137         iterator = (void *) obj;
 138         BT_LIB_LOGD("Destroying self component input port message iterator object: "
 139                 "%!+i", iterator);
 140         bt_self_component_port_input_message_iterator_try_finalize(iterator);
 141
 142         if (iterator->connection) {
 143                 /*
 144                  * Remove ourself from the originating connection so
 145                  * that it does not try to finalize a dangling pointer
 146                  * later.
 147                  */
 148                 bt_connection_remove_iterator(iterator->connection, iterator);
 149                 iterator->connection = NULL;
 150         }
 151
 152         if (iterator->auto_seek_msgs) {
 153                 while (!g_queue_is_empty(iterator->auto_seek_msgs)) {
 154                         bt_object_put_no_null_check(
 155                                 g_queue_pop_tail(iterator->auto_seek_msgs));
 156                 }
 157
 158                 g_queue_free(iterator->auto_seek_msgs);
 159                 iterator->auto_seek_msgs = NULL;
 160         }
 161
 162         destroy_base_message_iterator(obj);
 163 }
 164
 165 BT_HIDDEN
 166 void bt_self_component_port_input_message_iterator_try_finalize(
 167                 struct bt_self_component_port_input_message_iterator *iterator)
 168 {
 169         typedef void (*method_t)(void *);
 170
 171         struct bt_component_class *comp_class = NULL;
 172         method_t method = NULL;
 173
 174         BT_ASSERT(iterator);
 175
 176         switch (iterator->state) {
 177         case BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_NON_INITIALIZED:
 178                 /* Skip user finalization if user initialization failed */
 179                 BT_LIB_LOGD("Not finalizing non-initialized message iterator: "
 180                         "%!+i", iterator);
 181                 goto end;
 182         case BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_FINALIZED:
 183                 /* Already finalized */
 184                 BT_LIB_LOGD("Not finalizing message iterator: already finalized: "
 185                         "%!+i", iterator);
 186                 goto end;
 187         case BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_FINALIZING:
 188                 /* Already finalized */
 189                 BT_LIB_LOGF("Message iterator is already being finalized: "
 190                         "%!+i", iterator);
 191                 abort();
 192         default:
 193                 break;
 194         }
 195
 196         BT_LIB_LOGD("Finalizing message iterator: %!+i", iterator);
 197         set_self_comp_port_input_msg_iterator_state(iterator,
 198                 BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_FINALIZING);
 199         BT_ASSERT(iterator->upstream_component);
 200         comp_class = iterator->upstream_component->class;
 201
 202         /* Call user-defined destroy method */
 203         switch (comp_class->type) {
 204         case BT_COMPONENT_CLASS_TYPE_SOURCE:
 205         {
 206                 struct bt_component_class_source *src_comp_cls =
 207                         (void *) comp_class;
 208
 209                 method = (method_t) src_comp_cls->methods.msg_iter_finalize;
 210                 break;
 211         }
 212         case BT_COMPONENT_CLASS_TYPE_FILTER:
 213         {
 214                 struct bt_component_class_filter *flt_comp_cls =
 215                         (void *) comp_class;
 216
 217                 method = (method_t) flt_comp_cls->methods.msg_iter_finalize;
 218                 break;
 219         }
 220         default:
 221                 /* Unreachable */
 222                 abort();
 223         }
 224
 225         if (method) {
 226                 BT_LIB_LOGD("Calling user's finalization method: %!+i",
 227                         iterator);
 228                 method(iterator);
 229         }
 230
 231         iterator->upstream_component = NULL;
 232         iterator->upstream_port = NULL;
 233         set_self_comp_port_input_msg_iterator_state(iterator,
 234                 BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_FINALIZED);
 235         BT_LIB_LOGD("Finalized message iterator: %!+i", iterator);
 236
 237 end:
 238         return;
 239 }
 240
 241 BT_HIDDEN
 242 void bt_self_component_port_input_message_iterator_set_connection(
 243                 struct bt_self_component_port_input_message_iterator *iterator,
 244                 struct bt_connection *connection)
 245 {
 246         BT_ASSERT(iterator);
 247         iterator->connection = connection;
 248         BT_LIB_LOGV("Set message iterator's connection: "
 249                 "%![iter-]+i, %![conn-]+x", iterator, connection);
 250 }
 251
 252 static
 253 int init_message_iterator(struct bt_message_iterator *iterator,
 254                 enum bt_message_iterator_type type,
 255                 bt_object_release_func destroy)
 256 {
 257         int ret = 0;
 258
 259         bt_object_init_shared(&iterator->base, destroy);
 260         iterator->type = type;
 261         iterator->msgs = g_ptr_array_new();
 262         if (!iterator->msgs) {
 263                 BT_LOGE_STR("Failed to allocate a GPtrArray.");
 264                 ret = -1;
 265                 goto end;
 266         }
 267
 268         g_ptr_array_set_size(iterator->msgs, MSG_BATCH_SIZE);
 269
 270 end:
 271         return ret;
 272 }
 273
 274 static
 275 bt_bool can_seek_ns_from_origin_true(
 276                 struct bt_self_component_port_input_message_iterator *iterator,
 277                 int64_t ns_from_origin)
 278 {
 279         return BT_TRUE;
 280 }
 281
 282 static
 283 bt_bool can_seek_beginning_true(
 284                 struct bt_self_component_port_input_message_iterator *iterator)
 285 {
 286         return BT_TRUE;
 287 }
 288
 289 static
 290 struct bt_self_component_port_input_message_iterator *
 291 bt_self_component_port_input_message_iterator_create_initial(
 292                 struct bt_component *upstream_comp,
 293                 struct bt_port *upstream_port)
 294 {
 295         int ret;
 296         struct bt_self_component_port_input_message_iterator *iterator = NULL;
 297
 298         BT_ASSERT(upstream_comp);
 299         BT_ASSERT(upstream_port);
 300         BT_ASSERT(bt_port_is_connected(upstream_port));
 301         BT_LIB_LOGD("Creating initial message iterator on self component input port: "
 302                 "%![up-comp-]+c, %![up-port-]+p", upstream_comp, upstream_port);
 303         BT_ASSERT(bt_component_get_class_type(upstream_comp) ==
 304                 BT_COMPONENT_CLASS_TYPE_SOURCE ||
 305                 bt_component_get_class_type(upstream_comp) ==
 306                 BT_COMPONENT_CLASS_TYPE_FILTER);
 307         iterator = g_new0(
 308                 struct bt_self_component_port_input_message_iterator, 1);
 309         if (!iterator) {
 310                 BT_LOGE_STR("Failed to allocate one self component input port "
 311                         "message iterator.");
 312                 goto end;
 313         }
 314
 315         ret = init_message_iterator((void *) iterator,
 316                 BT_MESSAGE_ITERATOR_TYPE_SELF_COMPONENT_PORT_INPUT,
 317                 bt_self_component_port_input_message_iterator_destroy);
 318         if (ret) {
 319                 /* init_message_iterator() logs errors */
 320                 BT_OBJECT_PUT_REF_AND_RESET(iterator);
 321                 goto end;
 322         }
 323
 324         iterator->auto_seek_msgs = g_queue_new();
 325         if (!iterator->auto_seek_msgs) {
 326                 BT_LOGE_STR("Failed to allocate a GQueue.");
 327                 ret = -1;
 328                 goto end;
 329         }
 330
 331         iterator->upstream_component = upstream_comp;
 332         iterator->upstream_port = upstream_port;
 333         iterator->connection = iterator->upstream_port->connection;
 334         iterator->graph = bt_component_borrow_graph(upstream_comp);
 335         set_self_comp_port_input_msg_iterator_state(iterator,
 336                 BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_NON_INITIALIZED);
 337
 338         switch (iterator->upstream_component->class->type) {
 339         case BT_COMPONENT_CLASS_TYPE_SOURCE:
 340         {
 341                 struct bt_component_class_source *src_comp_cls =
 342                         (void *) iterator->upstream_component->class;
 343
 344                 iterator->methods.next =
 345                         (bt_self_component_port_input_message_iterator_next_method)
 346                                 src_comp_cls->methods.msg_iter_next;
 347                 iterator->methods.seek_ns_from_origin =
 348                         (bt_self_component_port_input_message_iterator_seek_ns_from_origin_method)
 349                                 src_comp_cls->methods.msg_iter_seek_ns_from_origin;
 350                 iterator->methods.seek_beginning =
 351                         (bt_self_component_port_input_message_iterator_seek_beginning_method)
 352                                 src_comp_cls->methods.msg_iter_seek_beginning;
 353                 iterator->methods.can_seek_ns_from_origin =
 354                         (bt_self_component_port_input_message_iterator_can_seek_ns_from_origin_method)
 355                                 src_comp_cls->methods.msg_iter_can_seek_ns_from_origin;
 356                 iterator->methods.can_seek_beginning =
 357                         (bt_self_component_port_input_message_iterator_can_seek_beginning_method)
 358                                 src_comp_cls->methods.msg_iter_can_seek_beginning;
 359                 break;
 360         }
 361         case BT_COMPONENT_CLASS_TYPE_FILTER:
 362         {
 363                 struct bt_component_class_filter *flt_comp_cls =
 364                         (void *) iterator->upstream_component->class;
 365
 366                 iterator->methods.next =
 367                         (bt_self_component_port_input_message_iterator_next_method)
 368                                 flt_comp_cls->methods.msg_iter_next;
 369                 iterator->methods.seek_ns_from_origin =
 370                         (bt_self_component_port_input_message_iterator_seek_ns_from_origin_method)
 371                                 flt_comp_cls->methods.msg_iter_seek_ns_from_origin;
 372                 iterator->methods.seek_beginning =
 373                         (bt_self_component_port_input_message_iterator_seek_beginning_method)
 374                                 flt_comp_cls->methods.msg_iter_seek_beginning;
 375                 iterator->methods.can_seek_ns_from_origin =
 376                         (bt_self_component_port_input_message_iterator_can_seek_ns_from_origin_method)
 377                                 flt_comp_cls->methods.msg_iter_can_seek_ns_from_origin;
 378                 iterator->methods.can_seek_beginning =
 379                         (bt_self_component_port_input_message_iterator_can_seek_beginning_method)
 380                                 flt_comp_cls->methods.msg_iter_can_seek_beginning;
 381                 break;
 382         }
 383         default:
 384                 abort();
 385         }
 386
 387         if (iterator->methods.seek_ns_from_origin &&
 388                         !iterator->methods.can_seek_ns_from_origin) {
 389                 iterator->methods.can_seek_ns_from_origin =
 390                         (bt_self_component_port_input_message_iterator_can_seek_ns_from_origin_method)
 391                                 can_seek_ns_from_origin_true;
 392         }
 393
 394         if (iterator->methods.seek_beginning &&
 395                         !iterator->methods.can_seek_beginning) {
 396                 iterator->methods.can_seek_beginning =
 397                         (bt_self_component_port_input_message_iterator_seek_beginning_method)
 398                                 can_seek_beginning_true;
 399         }
 400
 401         BT_LIB_LOGD("Created initial message iterator on self component input port: "
 402                 "%![up-port-]+p, %![up-comp-]+c, %![iter-]+i",
 403                 upstream_port, upstream_comp, iterator);
 404
 405 end:
 406         return iterator;
 407 }
 408
 409 struct bt_self_component_port_input_message_iterator *
 410 bt_self_component_port_input_message_iterator_create(
 411                 struct bt_self_component_port_input *self_port)
 412 {
 413         typedef enum bt_self_message_iterator_status (*init_method_t)(
 414                         void *, void *, void *);
 415
 416         init_method_t init_method = NULL;
 417         struct bt_self_component_port_input_message_iterator *iterator =
 418                 NULL;
 419         struct bt_port *port = (void *) self_port;
 420         struct bt_port *upstream_port;
 421         struct bt_component *comp;
 422         struct bt_component *upstream_comp;
 423         struct bt_component_class *upstream_comp_cls;
 424
 425         BT_ASSERT_PRE_NON_NULL(port, "Port");
 426         comp = bt_port_borrow_component_inline(port);
 427         BT_ASSERT_PRE(bt_port_is_connected(port),
 428                 "Port is not connected: %![port-]+p", port);
 429         BT_ASSERT_PRE(comp, "Port is not part of a component: %![port-]+p",
 430                 port);
 431         BT_ASSERT_PRE(!bt_component_graph_is_canceled(comp),
 432                 "Port's component's graph is canceled: "
 433                 "%![port-]+p, %![comp-]+c", port, comp);
 434         BT_ASSERT(port->connection);
 435         upstream_port = port->connection->upstream_port;
 436         BT_ASSERT(upstream_port);
 437         upstream_comp = bt_port_borrow_component_inline(upstream_port);
 438         BT_ASSERT(upstream_comp);
 439         BT_ASSERT_PRE(
 440                 bt_component_borrow_graph(upstream_comp)->config_state !=
 441                         BT_GRAPH_CONFIGURATION_STATE_CONFIGURING,
 442                 "Graph is not configured: %!+g",
 443                 bt_component_borrow_graph(upstream_comp));
 444         upstream_comp_cls = upstream_comp->class;
 445         BT_ASSERT(upstream_comp->class->type ==
 446                 BT_COMPONENT_CLASS_TYPE_SOURCE ||
 447                 upstream_comp->class->type ==
 448                 BT_COMPONENT_CLASS_TYPE_FILTER);
 449         iterator = bt_self_component_port_input_message_iterator_create_initial(
 450                 upstream_comp, upstream_port);
 451         if (!iterator) {
 452                 BT_LOGW_STR("Cannot create self component input port "
 453                         "message iterator.");
 454                 goto end;
 455         }
 456
 457         switch (upstream_comp_cls->type) {
 458         case BT_COMPONENT_CLASS_TYPE_SOURCE:
 459         {
 460                 struct bt_component_class_source *src_comp_cls =
 461                         (void *) upstream_comp_cls;
 462
 463                 init_method =
 464                         (init_method_t) src_comp_cls->methods.msg_iter_init;
 465                 break;
 466         }
 467         case BT_COMPONENT_CLASS_TYPE_FILTER:
 468         {
 469                 struct bt_component_class_filter *flt_comp_cls =
 470                         (void *) upstream_comp_cls;
 471
 472                 init_method =
 473                         (init_method_t) flt_comp_cls->methods.msg_iter_init;
 474                 break;
 475         }
 476         default:
 477                 /* Unreachable */
 478                 abort();
 479         }
 480
 481         if (init_method) {
 482                 int iter_status;
 483
 484                 BT_LIB_LOGD("Calling user's initialization method: %!+i", iterator);
 485                 iter_status = init_method(iterator, upstream_comp,
 486                         upstream_port);
 487                 BT_LOGD("User method returned: status=%s",
 488                         bt_message_iterator_status_string(iter_status));
 489                 if (iter_status != BT_MESSAGE_ITERATOR_STATUS_OK) {
 490                         BT_LOGW_STR("Initialization method failed.");
 491                         BT_OBJECT_PUT_REF_AND_RESET(iterator);
 492                         goto end;
 493                 }
 494         }
 495
 496         set_self_comp_port_input_msg_iterator_state(iterator,
 497                 BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_ACTIVE);
 498         g_ptr_array_add(port->connection->iterators, iterator);
 499         BT_LIB_LOGD("Created message iterator on self component input port: "
 500                 "%![up-port-]+p, %![up-comp-]+c, %![iter-]+i",
 501                 upstream_port, upstream_comp, iterator);
 502
 503 end:
 504         return iterator;
 505 }
 506
 507 void *bt_self_message_iterator_get_data(
 508                 const struct bt_self_message_iterator *self_iterator)
 509 {
 510         struct bt_self_component_port_input_message_iterator *iterator =
 511                 (void *) self_iterator;
 512
 513         BT_ASSERT_PRE_NON_NULL(iterator, "Message iterator");
 514         return iterator->user_data;
 515 }
 516
 517 void bt_self_message_iterator_set_data(
 518                 struct bt_self_message_iterator *self_iterator, void *data)
 519 {
 520         struct bt_self_component_port_input_message_iterator *iterator =
 521                 (void *) self_iterator;
 522
 523         BT_ASSERT_PRE_NON_NULL(iterator, "Message iterator");
 524         iterator->user_data = data;
 525         BT_LIB_LOGV("Set message iterator's user data: "
 526                 "%!+i, user-data-addr=%p", iterator, data);
 527 }
 528
 529 BT_ASSERT_PRE_FUNC
 530 static inline
 531 void bt_message_borrow_packet_stream(const struct bt_message *msg,
 532                 const struct bt_stream **stream,
 533                 const struct bt_packet **packet)
 534 {
 535         BT_ASSERT(msg);
 536
 537         switch (msg->type) {
 538         case BT_MESSAGE_TYPE_EVENT:
 539                 *packet = bt_event_borrow_packet_const(
 540                         bt_message_event_borrow_event_const(msg));
 541                 *stream = bt_packet_borrow_stream_const(*packet);
 542                 break;
 543         case BT_MESSAGE_TYPE_STREAM_BEGINNING:
 544                 *stream = bt_message_stream_beginning_borrow_stream_const(msg);
 545                 break;
 546         case BT_MESSAGE_TYPE_STREAM_END:
 547                 *stream = bt_message_stream_end_borrow_stream_const(msg);
 548                 break;
 549         case BT_MESSAGE_TYPE_PACKET_BEGINNING:
 550                 *packet = bt_message_packet_beginning_borrow_packet_const(msg);
 551                 *stream = bt_packet_borrow_stream_const(*packet);
 552                 break;
 553         case BT_MESSAGE_TYPE_PACKET_END:
 554                 *packet = bt_message_packet_end_borrow_packet_const(msg);
 555                 *stream = bt_packet_borrow_stream_const(*packet);
 556                 break;
 557         default:
 558                 break;
 559         }
 560 }
 561
 562 enum bt_message_iterator_status
 563 bt_self_component_port_input_message_iterator_next(
 564                 struct bt_self_component_port_input_message_iterator *iterator,
 565                 bt_message_array_const *msgs, uint64_t *user_count)
 566 {
 567         int status = BT_MESSAGE_ITERATOR_STATUS_OK;
 568
 569         BT_ASSERT_PRE_NON_NULL(iterator, "Message iterator");
 570         BT_ASSERT_PRE_NON_NULL(msgs, "Message array (output)");
 571         BT_ASSERT_PRE_NON_NULL(user_count, "Message count (output)");
 572         BT_ASSERT_PRE(iterator->state ==
 573                 BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_ACTIVE,
 574                 "Message iterator's \"next\" called, but "
 575                 "message iterator is in the wrong state: %!+i", iterator);
 576         BT_ASSERT(iterator->upstream_component);
 577         BT_ASSERT(iterator->upstream_component->class);
 578         BT_ASSERT_PRE(
 579                 bt_component_borrow_graph(iterator->upstream_component)->config_state !=
 580                         BT_GRAPH_CONFIGURATION_STATE_CONFIGURING,
 581                 "Graph is not configured: %!+g",
 582                 bt_component_borrow_graph(iterator->upstream_component));
 583         BT_LIB_LOGD("Getting next self component input port "
 584                 "message iterator's messages: %!+i", iterator);
 585
 586         /*
 587          * Call the user's "next" method to get the next messages
 588          * and status.
 589          */
 590         BT_ASSERT(iterator->methods.next);
 591         BT_LOGD_STR("Calling user's \"next\" method.");
 592         status = iterator->methods.next(iterator,
 593                 (void *) iterator->base.msgs->pdata, MSG_BATCH_SIZE,
 594                 user_count);
 595         BT_LOGD("User method returned: status=%s",
 596                 bt_message_iterator_status_string(status));
 597         if (status < 0) {
 598                 BT_LOGW_STR("User method failed.");
 599                 goto end;
 600         }
 601
 602 #ifdef BT_DEV_MODE
 603         /*
 604          * There is no way that this iterator could have been finalized
 605          * during its "next" method, as the only way to do this is to
 606          * put the last iterator's reference, and this can only be done
 607          * by its downstream owner.
 608          *
 609          * For the same reason, there is no way that this iterator could
 610          * have seeked (cannot seek a self message iterator).
 611          */
 612         BT_ASSERT(iterator->state ==
 613                 BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_ACTIVE);
 614 #endif
 615
 616         switch (status) {
 617         case BT_MESSAGE_ITERATOR_STATUS_OK:
 618                 BT_ASSERT_PRE(*user_count <= MSG_BATCH_SIZE,
 619                         "Invalid returned message count: greater than "
 620                         "batch size: count=%" PRIu64 ", batch-size=%u",
 621                         *user_count, MSG_BATCH_SIZE);
 622                 *msgs = (void *) iterator->base.msgs->pdata;
 623                 break;
 624         case BT_MESSAGE_ITERATOR_STATUS_AGAIN:
 625                 goto end;
 626         case BT_MESSAGE_ITERATOR_STATUS_END:
 627                 set_self_comp_port_input_msg_iterator_state(iterator,
 628                         BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_ENDED);
 629                 goto end;
 630         default:
 631                 /* Unknown non-error status */
 632                 abort();
 633         }
 634
 635 end:
 636         return status;
 637 }
 638
 639 enum bt_message_iterator_status bt_port_output_message_iterator_next(
 640                 struct bt_port_output_message_iterator *iterator,
 641                 bt_message_array_const *msgs_to_user,
 642                 uint64_t *count_to_user)
 643 {
 644         enum bt_message_iterator_status status;
 645         enum bt_graph_status graph_status;
 646
 647         BT_ASSERT_PRE_NON_NULL(iterator, "Message iterator");
 648         BT_ASSERT_PRE_NON_NULL(msgs_to_user, "Message array (output)");
 649         BT_ASSERT_PRE_NON_NULL(count_to_user, "Message count (output)");
 650         BT_LIB_LOGD("Getting next output port message iterator's messages: "
 651                 "%!+i", iterator);
 652         graph_status = bt_graph_consume_sink_no_check(iterator->graph,
 653                 iterator->colander);
 654         switch (graph_status) {
 655         case BT_GRAPH_STATUS_CANCELED:
 656         case BT_GRAPH_STATUS_AGAIN:
 657         case BT_GRAPH_STATUS_END:
 658         case BT_GRAPH_STATUS_NOMEM:
 659                 status = (int) graph_status;
 660                 break;
 661         case BT_GRAPH_STATUS_OK:
 662                 status = BT_MESSAGE_ITERATOR_STATUS_OK;
 663
 664                 /*
 665                  * On success, the colander sink moves the messages
 666                  * to this iterator's array and sets this iterator's
 667                  * message count: move them to the user.
 668                  */
 669                 *msgs_to_user = (void *) iterator->base.msgs->pdata;
 670                 *count_to_user = iterator->count;
 671                 break;
 672         default:
 673                 /* Other errors */
 674                 status = BT_MESSAGE_ITERATOR_STATUS_ERROR;
 675         }
 676
 677         return status;
 678 }
 679
 680 struct bt_component *
 681 bt_self_component_port_input_message_iterator_borrow_component(
 682                 struct bt_self_component_port_input_message_iterator *iterator)
 683 {
 684         BT_ASSERT_PRE_NON_NULL(iterator, "Message iterator");
 685         return iterator->upstream_component;
 686 }
 687
 688 const struct bt_component *
 689 bt_self_component_port_input_message_iterator_borrow_component_const(
 690                 const struct bt_self_component_port_input_message_iterator *iterator)
 691 {
 692         BT_ASSERT_PRE_NON_NULL(iterator, "Message iterator");
 693         return iterator->upstream_component;
 694 }
 695
 696 struct bt_self_component *bt_self_message_iterator_borrow_component(
 697                 struct bt_self_message_iterator *self_iterator)
 698 {
 699         struct bt_self_component_port_input_message_iterator *iterator =
 700                 (void *) self_iterator;
 701
 702         BT_ASSERT_PRE_NON_NULL(iterator, "Message iterator");
 703         return (void *) iterator->upstream_component;
 704 }
 705
 706 struct bt_self_port_output *bt_self_message_iterator_borrow_port(
 707                 struct bt_self_message_iterator *self_iterator)
 708 {
 709         struct bt_self_component_port_input_message_iterator *iterator =
 710                 (void *) self_iterator;
 711
 712         BT_ASSERT_PRE_NON_NULL(iterator, "Message iterator");
 713         return (void *) iterator->upstream_port;
 714 }
 715
 716 static
 717 void bt_port_output_message_iterator_destroy(struct bt_object *obj)
 718 {
 719         struct bt_port_output_message_iterator *iterator = (void *) obj;
 720
 721         BT_LIB_LOGD("Destroying output port message iterator object: %!+i",
 722                 iterator);
 723         BT_LOGD_STR("Putting graph.");
 724         BT_OBJECT_PUT_REF_AND_RESET(iterator->graph);
 725         BT_LOGD_STR("Putting colander sink component.");
 726         BT_OBJECT_PUT_REF_AND_RESET(iterator->colander);
 727         destroy_base_message_iterator(obj);
 728 }
 729
 730 struct bt_port_output_message_iterator *
 731 bt_port_output_message_iterator_create(struct bt_graph *graph,
 732                 const struct bt_port_output *output_port)
 733 {
 734         struct bt_port_output_message_iterator *iterator = NULL;
 735         struct bt_component_class_sink *colander_comp_cls = NULL;
 736         struct bt_component *output_port_comp = NULL;
 737         struct bt_component_sink *colander_comp;
 738         enum bt_graph_status graph_status;
 739         struct bt_port_input *colander_in_port = NULL;
 740         struct bt_component_class_sink_colander_data colander_data;
 741         int ret;
 742
 743         BT_ASSERT_PRE_NON_NULL(graph, "Graph");
 744         BT_ASSERT_PRE_NON_NULL(output_port, "Output port");
 745         output_port_comp = bt_port_borrow_component_inline(
 746                 (const void *) output_port);
 747         BT_ASSERT_PRE(output_port_comp,
 748                 "Output port has no component: %!+p", output_port);
 749         BT_ASSERT_PRE(bt_component_borrow_graph(output_port_comp) ==
 750                 (void *) graph,
 751                 "Output port is not part of graph: %![graph-]+g, %![port-]+p",
 752                 graph, output_port);
 753
 754         /* Create message iterator */
 755         BT_LIB_LOGD("Creating message iterator on output port: "
 756                 "%![port-]+p, %![comp-]+c", output_port, output_port_comp);
 757         iterator = g_new0(struct bt_port_output_message_iterator, 1);
 758         if (!iterator) {
 759                 BT_LOGE_STR("Failed to allocate one output port message iterator.");
 760                 goto error;
 761         }
 762
 763         ret = init_message_iterator((void *) iterator,
 764                 BT_MESSAGE_ITERATOR_TYPE_PORT_OUTPUT,
 765                 bt_port_output_message_iterator_destroy);
 766         if (ret) {
 767                 /* init_message_iterator() logs errors */
 768                 BT_OBJECT_PUT_REF_AND_RESET(iterator);
 769                 goto end;
 770         }
 771
 772         /* Create colander component */
 773         colander_comp_cls = bt_component_class_sink_colander_get();
 774         if (!colander_comp_cls) {
 775                 BT_LOGW("Cannot get colander sink component class.");
 776                 goto error;
 777         }
 778
 779         iterator->graph = graph;
 780         bt_object_get_no_null_check(iterator->graph);
 781         colander_data.msgs = (void *) iterator->base.msgs->pdata;
 782         colander_data.count_addr = &iterator->count;
 783
 784         /* Hope that nobody uses this very unique name */
 785         graph_status =
 786                 bt_graph_add_sink_component_with_init_method_data(
 787                         (void *) graph, colander_comp_cls,
 788                         "colander-36ac3409-b1a8-4d60-ab1f-4fdf341a8fb1",
 789                         NULL, &colander_data, (void *) &iterator->colander);
 790         if (graph_status != BT_GRAPH_STATUS_OK) {
 791                 BT_LIB_LOGW("Cannot add colander sink component to graph: "
 792                         "%1[graph-]+g, status=%s", graph,
 793                         bt_graph_status_string(graph_status));
 794                 goto error;
 795         }
 796
 797         /*
 798          * Connect provided output port to the colander component's
 799          * input port.
 800          */
 801         colander_in_port =
 802                 (void *) bt_component_sink_borrow_input_port_by_index_const(
 803                         (void *) iterator->colander, 0);
 804         BT_ASSERT(colander_in_port);
 805         graph_status = bt_graph_connect_ports(graph,
 806                 output_port, colander_in_port, NULL);
 807         if (graph_status != BT_GRAPH_STATUS_OK) {
 808                 BT_LIB_LOGW("Cannot add colander sink component to graph: "
 809                         "%![graph-]+g, %![comp-]+c, status=%s", graph,
 810                         iterator->colander,
 811                         bt_graph_status_string(graph_status));
 812                 goto error;
 813         }
 814
 815         /*
 816          * At this point everything went fine. Make the graph
 817          * nonconsumable forever so that only this message iterator
 818          * can consume (thanks to bt_graph_consume_sink_no_check()).
 819          * This avoids leaking the message created by the colander
 820          * sink and moved to the message iterator's message
 821          * member.
 822          */
 823         bt_graph_set_can_consume(iterator->graph, false);
 824
 825         /*
 826          * Also set the graph as being configured: it has no active sink
 827          * anyway, so we don't need to call bt_graph_configure().
 828          */
 829         graph->config_state = BT_GRAPH_CONFIGURATION_STATE_CONFIGURED;
 830         goto end;
 831
 832 error:
 833         if (iterator && iterator->graph && iterator->colander) {
 834                 int ret;
 835
 836                 /* Remove created colander component from graph if any */
 837                 colander_comp = iterator->colander;
 838                 BT_OBJECT_PUT_REF_AND_RESET(iterator->colander);
 839
 840                 /*
 841                  * At this point the colander component's reference
 842                  * count is 0 because iterator->colander was the only
 843                  * owner. We also know that it is not connected because
 844                  * this is the last operation before this function
 845                  * succeeds.
 846                  *
 847                  * Since we honor the preconditions here,
 848                  * bt_graph_remove_unconnected_component() always
 849                  * succeeds.
 850                  */
 851                 ret = bt_graph_remove_unconnected_component(iterator->graph,
 852                         (void *) colander_comp);
 853                 BT_ASSERT(ret == 0);
 854         }
 855
 856         BT_OBJECT_PUT_REF_AND_RESET(iterator);
 857
 858 end:
 859         bt_object_put_ref(colander_comp_cls);
 860         return (void *) iterator;
 861 }
 862
 863 bt_bool bt_self_component_port_input_message_iterator_can_seek_ns_from_origin(
 864                 struct bt_self_component_port_input_message_iterator *iterator,
 865                 int64_t ns_from_origin)
 866 {
 867         bt_bool can = BT_FALSE;
 868
 869         BT_ASSERT_PRE_NON_NULL(iterator, "Message iterator");
 870         BT_ASSERT_PRE_ITER_HAS_STATE_TO_SEEK(iterator);
 871         BT_ASSERT_PRE(
 872                 bt_component_borrow_graph(iterator->upstream_component)->config_state !=
 873                         BT_GRAPH_CONFIGURATION_STATE_CONFIGURING,
 874                 "Graph is not configured: %!+g",
 875                 bt_component_borrow_graph(iterator->upstream_component));
 876
 877         if (iterator->methods.can_seek_ns_from_origin) {
 878                 can = iterator->methods.can_seek_ns_from_origin(iterator,
 879                         ns_from_origin);
 880                 goto end;
 881         }
 882
 883         /*
 884          * Automatic seeking fall back: if we can seek to the beginning,
 885          * then we can automatically seek to any message.
 886          */
 887         if (iterator->methods.can_seek_beginning) {
 888                 can = iterator->methods.can_seek_beginning(iterator);
 889         }
 890
 891 end:
 892         return can;
 893 }
 894
 895 bt_bool bt_self_component_port_input_message_iterator_can_seek_beginning(
 896                 struct bt_self_component_port_input_message_iterator *iterator)
 897 {
 898         bt_bool can = BT_FALSE;
 899
 900         BT_ASSERT_PRE_NON_NULL(iterator, "Message iterator");
 901         BT_ASSERT_PRE_ITER_HAS_STATE_TO_SEEK(iterator);
 902         BT_ASSERT_PRE(
 903                 bt_component_borrow_graph(iterator->upstream_component)->config_state !=
 904                         BT_GRAPH_CONFIGURATION_STATE_CONFIGURING,
 905                 "Graph is not configured: %!+g",
 906                 bt_component_borrow_graph(iterator->upstream_component));
 907
 908         if (iterator->methods.can_seek_beginning) {
 909                 can = iterator->methods.can_seek_beginning(iterator);
 910         }
 911
 912         return can;
 913 }
 914
 915 static inline
 916 void _set_iterator_state_after_seeking(
 917                 struct bt_self_component_port_input_message_iterator *iterator,
 918                 enum bt_message_iterator_status status)
 919 {
 920         enum bt_self_component_port_input_message_iterator_state new_state = 0;
 921
 922         /* Set iterator's state depending on seeking status */
 923         switch (status) {
 924         case BT_MESSAGE_ITERATOR_STATUS_OK:
 925                 new_state = BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_ACTIVE;
 926                 break;
 927         case BT_MESSAGE_ITERATOR_STATUS_AGAIN:
 928                 new_state = BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_LAST_SEEKING_RETURNED_AGAIN;
 929                 break;
 930         case BT_MESSAGE_ITERATOR_STATUS_ERROR:
 931         case BT_MESSAGE_ITERATOR_STATUS_NOMEM:
 932                 new_state = BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_LAST_SEEKING_RETURNED_ERROR;
 933                 break;
 934         case BT_MESSAGE_ITERATOR_STATUS_END:
 935                 new_state = BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_ENDED;
 936                 break;
 937         default:
 938                 abort();
 939         }
 940
 941         set_self_comp_port_input_msg_iterator_state(iterator, new_state);
 942 }
 943
 944 #ifdef BT_DEV_MODE
 945 # define set_iterator_state_after_seeking       _set_iterator_state_after_seeking
 946 #else
 947 # define set_iterator_state_after_seeking(_iter, _status)
 948 #endif
 949
 950 enum bt_message_iterator_status
 951 bt_self_component_port_input_message_iterator_seek_beginning(
 952                 struct bt_self_component_port_input_message_iterator *iterator)
 953 {
 954         int status;
 955
 956         BT_ASSERT_PRE_NON_NULL(iterator, "Message iterator");
 957         BT_ASSERT_PRE_ITER_HAS_STATE_TO_SEEK(iterator);
 958         BT_ASSERT_PRE(
 959                 bt_component_borrow_graph(iterator->upstream_component)->config_state !=
 960                         BT_GRAPH_CONFIGURATION_STATE_CONFIGURING,
 961                 "Graph is not configured: %!+g",
 962                 bt_component_borrow_graph(iterator->upstream_component));
 963         BT_ASSERT_PRE(
 964                 bt_self_component_port_input_message_iterator_can_seek_beginning(
 965                         iterator),
 966                 "Message iterator cannot seek beginning: %!+i", iterator);
 967         BT_LIB_LOGD("Calling user's \"seek beginning\" method: %!+i", iterator);
 968         set_self_comp_port_input_msg_iterator_state(iterator,
 969                 BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_SEEKING);
 970         status = iterator->methods.seek_beginning(iterator);
 971         BT_LOGD("User method returned: status=%s",
 972                 bt_message_iterator_status_string(status));
 973         BT_ASSERT_PRE(status == BT_MESSAGE_ITERATOR_STATUS_OK ||
 974                 status == BT_MESSAGE_ITERATOR_STATUS_ERROR ||
 975                 status == BT_MESSAGE_ITERATOR_STATUS_NOMEM ||
 976                 status == BT_MESSAGE_ITERATOR_STATUS_AGAIN,
 977                 "Unexpected status: %![iter-]+i, status=%s",
 978                 iterator, bt_self_message_iterator_status_string(status));
 979         set_iterator_state_after_seeking(iterator, status);
 980         return status;
 981 }
 982
 983 static inline
 984 enum bt_message_iterator_status auto_seek_handle_message(
 985                 struct bt_self_component_port_input_message_iterator *iterator,
 986                 int64_t ns_from_origin, const struct bt_message *msg,
 987                 bool *got_first)
 988 {
 989         enum bt_message_iterator_status status = BT_MESSAGE_ITERATOR_STATUS_OK;
 990         int64_t msg_ns_from_origin;
 991         const struct bt_clock_snapshot *clk_snapshot = NULL;
 992         int ret;
 993
 994         BT_ASSERT(msg);
 995         BT_ASSERT(got_first);
 996
 997         switch (msg->type) {
 998         case BT_MESSAGE_TYPE_EVENT:
 999         {
1000                 const struct bt_message_event *event_msg =
1001                         (const void *) msg;
1002
1003                 clk_snapshot = event_msg->default_cs;
1004                 BT_ASSERT_PRE(clk_snapshot,
1005                         "Event message has no default clock snapshot: %!+n",
1006                         event_msg);
1007                 break;
1008         }
1009         case BT_MESSAGE_TYPE_MESSAGE_ITERATOR_INACTIVITY:
1010         {
1011                 const struct bt_message_message_iterator_inactivity *inactivity_msg =
1012                         (const void *) msg;
1013
1014                 clk_snapshot = inactivity_msg->default_cs;
1015                 BT_ASSERT(clk_snapshot);
1016                 break;
1017         }
1018         case BT_MESSAGE_TYPE_PACKET_BEGINNING:
1019         case BT_MESSAGE_TYPE_PACKET_END:
1020         {
1021                 const struct bt_message_packet *packet_msg =
1022                         (const void *) msg;
1023
1024                 clk_snapshot = packet_msg->default_cs;
1025                 BT_ASSERT_PRE(clk_snapshot,
1026                         "Packet message has no default clock snapshot: %!+n",
1027                         packet_msg);
1028                 break;
1029         }
1030         case BT_MESSAGE_TYPE_DISCARDED_EVENTS:
1031         case BT_MESSAGE_TYPE_DISCARDED_PACKETS:
1032         {
1033                 struct bt_message_discarded_items *msg_disc_items =
1034                         (void *) msg;
1035
1036                 BT_ASSERT_PRE(msg_disc_items->default_begin_cs &&
1037                         msg_disc_items->default_end_cs,
1038                         "Discarded events/packets message has no default clock snapshots: %!+n",
1039                         msg_disc_items);
1040                 ret = bt_clock_snapshot_get_ns_from_origin(
1041                         msg_disc_items->default_begin_cs,
1042                         &msg_ns_from_origin);
1043                 if (ret) {
1044                         status = BT_MESSAGE_ITERATOR_STATUS_ERROR;
1045                         goto end;
1046                 }
1047
1048                 if (msg_ns_from_origin >= ns_from_origin) {
1049                         *got_first = true;
1050                         goto push_msg;
1051                 }
1052
1053                 ret = bt_clock_snapshot_get_ns_from_origin(
1054                         msg_disc_items->default_end_cs,
1055                         &msg_ns_from_origin);
1056                 if (ret) {
1057                         status = BT_MESSAGE_ITERATOR_STATUS_ERROR;
1058                         goto end;
1059                 }
1060
1061                 if (msg_ns_from_origin >= ns_from_origin) {
1062                         /*
1063                          * The discarded items message's beginning time
1064                          * is before the requested seeking time, but its
1065                          * end time is after. Modify the message so as
1066                          * to set its beginning time to the requested
1067                          * seeking time, and make its item count unknown
1068                          * as we don't know if items were really
1069                          * discarded within the new time range.
1070                          */
1071                         uint64_t new_begin_raw_value;
1072
1073                         ret = bt_clock_class_clock_value_from_ns_from_origin(
1074                                 msg_disc_items->default_end_cs->clock_class,
1075                                 ns_from_origin, &new_begin_raw_value);
1076                         if (ret) {
1077                                 status = BT_MESSAGE_ITERATOR_STATUS_ERROR;
1078                                 goto end;
1079                         }
1080
1081                         bt_clock_snapshot_set_raw_value(
1082                                 msg_disc_items->default_begin_cs,
1083                                 new_begin_raw_value);
1084                         msg_disc_items->count.base.avail =
1085                                 BT_PROPERTY_AVAILABILITY_NOT_AVAILABLE;
1086
1087                         /*
1088                          * It is safe to push it because its beginning
1089                          * time is exactly the requested seeking time.
1090                          */
1091                         goto push_msg;
1092                 } else {
1093                         goto skip_msg;
1094                 }
1095         }
1096         case BT_MESSAGE_TYPE_STREAM_ACTIVITY_BEGINNING:
1097         {
1098                 const struct bt_message_stream_activity *stream_act_msg =
1099                         (const void *) msg;
1100
1101                 switch (stream_act_msg->default_cs_state) {
1102                 case BT_MESSAGE_STREAM_ACTIVITY_CLOCK_SNAPSHOT_STATE_UNKNOWN:
1103                 case BT_MESSAGE_STREAM_ACTIVITY_CLOCK_SNAPSHOT_STATE_INFINITE:
1104                         /*
1105                          * -inf is always less than any requested time,
1106                          * and we can't assume any specific time for an
1107                          * unknown clock snapshot, so skip this.
1108                          */
1109                         goto skip_msg;
1110                 case BT_MESSAGE_STREAM_ACTIVITY_CLOCK_SNAPSHOT_STATE_KNOWN:
1111                         clk_snapshot = stream_act_msg->default_cs;
1112                         BT_ASSERT(clk_snapshot);
1113                         break;
1114                 default:
1115                         abort();
1116                 }
1117
1118                 break;
1119         }
1120         case BT_MESSAGE_TYPE_STREAM_ACTIVITY_END:
1121         {
1122                 const struct bt_message_stream_activity *stream_act_msg =
1123                         (const void *) msg;
1124
1125                 switch (stream_act_msg->default_cs_state) {
1126                 case BT_MESSAGE_STREAM_ACTIVITY_CLOCK_SNAPSHOT_STATE_UNKNOWN:
1127                         /*
1128                          * We can't assume any specific time for an
1129                          * unknown clock snapshot, so skip this.
1130                          */
1131                         goto skip_msg;
1132                 case BT_MESSAGE_STREAM_ACTIVITY_CLOCK_SNAPSHOT_STATE_INFINITE:
1133                         /*
1134                          * +inf is always greater than any requested
1135                          * time.
1136                          */
1137                         *got_first = true;
1138                         goto push_msg;
1139                 case BT_MESSAGE_STREAM_ACTIVITY_CLOCK_SNAPSHOT_STATE_KNOWN:
1140                         clk_snapshot = stream_act_msg->default_cs;
1141                         BT_ASSERT(clk_snapshot);
1142                         break;
1143                 default:
1144                         abort();
1145                 }
1146
1147                 break;
1148         }
1149         case BT_MESSAGE_TYPE_STREAM_BEGINNING:
1150         case BT_MESSAGE_TYPE_STREAM_END:
1151                 /* Ignore */
1152                 goto skip_msg;
1153         default:
1154                 abort();
1155         }
1156
1157         BT_ASSERT(clk_snapshot);
1158         ret = bt_clock_snapshot_get_ns_from_origin(clk_snapshot,
1159                 &msg_ns_from_origin);
1160         if (ret) {
1161                 status = BT_MESSAGE_ITERATOR_STATUS_ERROR;
1162                 goto end;
1163         }
1164
1165         if (msg_ns_from_origin >= ns_from_origin) {
1166                 *got_first = true;
1167                 goto push_msg;
1168         }
1169
1170 skip_msg:
1171         bt_object_put_no_null_check(msg);
1172         goto end;
1173
1174 push_msg:
1175         g_queue_push_head(iterator->auto_seek_msgs, (void *) msg);
1176         msg = NULL;
1177
1178 end:
1179         BT_ASSERT(!msg || status != BT_MESSAGE_ITERATOR_STATUS_OK);
1180         return status;
1181 }
1182
1183 static
1184 enum bt_message_iterator_status find_message_ge_ns_from_origin(
1185                 struct bt_self_component_port_input_message_iterator *iterator,
1186                 int64_t ns_from_origin)
1187 {
1188         int status;
1189         enum bt_self_component_port_input_message_iterator_state init_state =
1190                 iterator->state;
1191         const struct bt_message *messages[MSG_BATCH_SIZE];
1192         uint64_t user_count = 0;
1193         uint64_t i;
1194         bool got_first = false;
1195
1196         BT_ASSERT(iterator);
1197         memset(&messages[0], 0, sizeof(messages[0]) * MSG_BATCH_SIZE);
1198
1199         /*
1200          * Make this iterator temporarily active (not seeking) to call
1201          * the "next" method.
1202          */
1203         set_self_comp_port_input_msg_iterator_state(iterator,
1204                 BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_ACTIVE);
1205
1206         BT_ASSERT(iterator->methods.next);
1207
1208         while (true) {
1209                 /*
1210                  * Call the user's "next" method to get the next
1211                  * messages and status.
1212                  */
1213                 BT_LOGD_STR("Calling user's \"next\" method.");
1214                 status = iterator->methods.next(iterator,
1215                         &messages[0], MSG_BATCH_SIZE, &user_count);
1216                 BT_LOGD("User method returned: status=%s",
1217                         bt_message_iterator_status_string(status));
1218
1219 #ifdef BT_DEV_MODE
1220                 /*
1221                  * The user's "next" method must not do any action which
1222                  * would change the iterator's state.
1223                  */
1224                 BT_ASSERT(iterator->state ==
1225                         BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_ACTIVE);
1226 #endif
1227
1228                 switch (status) {
1229                 case BT_MESSAGE_ITERATOR_STATUS_OK:
1230                         BT_ASSERT_PRE(user_count <= MSG_BATCH_SIZE,
1231                                 "Invalid returned message count: greater than "
1232                                 "batch size: count=%" PRIu64 ", batch-size=%u",
1233                                 user_count, MSG_BATCH_SIZE);
1234                         break;
1235                 case BT_MESSAGE_ITERATOR_STATUS_AGAIN:
1236                 case BT_MESSAGE_ITERATOR_STATUS_ERROR:
1237                 case BT_MESSAGE_ITERATOR_STATUS_NOMEM:
1238                 case BT_MESSAGE_ITERATOR_STATUS_END:
1239                         goto end;
1240                 default:
1241                         abort();
1242                 }
1243
1244                 for (i = 0; i < user_count; i++) {
1245                         if (got_first) {
1246                                 g_queue_push_head(iterator->auto_seek_msgs,
1247                                         (void *) messages[i]);
1248                                 messages[i] = NULL;
1249                                 continue;
1250                         }
1251
1252                         status = auto_seek_handle_message(iterator,
1253                                 ns_from_origin, messages[i], &got_first);
1254                         if (status == BT_MESSAGE_ITERATOR_STATUS_OK) {
1255                                 /* Message was either put or moved */
1256                                 messages[i] = NULL;
1257                         } else {
1258                                 goto end;
1259                         }
1260                 }
1261         }
1262
1263 end:
1264         for (i = 0; i < user_count; i++) {
1265                 if (messages[i]) {
1266                         bt_object_put_no_null_check(messages[i]);
1267                 }
1268         }
1269
1270         set_self_comp_port_input_msg_iterator_state(iterator, init_state);
1271         return status;
1272 }
1273
1274 static
1275 enum bt_self_message_iterator_status post_auto_seek_next(
1276                 struct bt_self_component_port_input_message_iterator *iterator,
1277                 bt_message_array_const msgs, uint64_t capacity,
1278                 uint64_t *count)
1279 {
1280         BT_ASSERT(!g_queue_is_empty(iterator->auto_seek_msgs));
1281         *count = 0;
1282
1283         /*
1284          * Move auto-seek messages to the output array (which is this
1285          * iterator's base message array).
1286          */
1287         while (capacity > 0 && !g_queue_is_empty(iterator->auto_seek_msgs)) {
1288                 msgs[*count] = g_queue_pop_tail(iterator->auto_seek_msgs);
1289                 capacity--;
1290                 (*count)++;
1291         }
1292
1293         BT_ASSERT(*count > 0);
1294
1295         if (g_queue_is_empty(iterator->auto_seek_msgs)) {
1296                 /* No more auto-seek messages */
1297                 switch (iterator->upstream_component->class->type) {
1298                 case BT_COMPONENT_CLASS_TYPE_SOURCE:
1299                 {
1300                         struct bt_component_class_source *src_comp_cls =
1301                                 (void *) iterator->upstream_component->class;
1302
1303                         iterator->methods.next =
1304                                 (bt_self_component_port_input_message_iterator_next_method)
1305                                         src_comp_cls->methods.msg_iter_next;
1306                         break;
1307                 }
1308                 case BT_COMPONENT_CLASS_TYPE_FILTER:
1309                 {
1310                         struct bt_component_class_filter *flt_comp_cls =
1311                                 (void *) iterator->upstream_component->class;
1312
1313                         iterator->methods.next =
1314                                 (bt_self_component_port_input_message_iterator_next_method)
1315                                         flt_comp_cls->methods.msg_iter_next;
1316                         break;
1317                 }
1318                 default:
1319                         abort();
1320                 }
1321         }
1322
1323         return BT_SELF_MESSAGE_ITERATOR_STATUS_OK;
1324 }
1325
1326 enum bt_message_iterator_status
1327 bt_self_component_port_input_message_iterator_seek_ns_from_origin(
1328                 struct bt_self_component_port_input_message_iterator *iterator,
1329                 int64_t ns_from_origin)
1330 {
1331         int status;
1332
1333         BT_ASSERT_PRE_NON_NULL(iterator, "Message iterator");
1334         BT_ASSERT_PRE_ITER_HAS_STATE_TO_SEEK(iterator);
1335         BT_ASSERT_PRE(
1336                 bt_component_borrow_graph(iterator->upstream_component)->config_state !=
1337                         BT_GRAPH_CONFIGURATION_STATE_CONFIGURING,
1338                 "Graph is not configured: %!+g",
1339                 bt_component_borrow_graph(iterator->upstream_component));
1340         BT_ASSERT_PRE(
1341                 bt_self_component_port_input_message_iterator_can_seek_ns_from_origin(
1342                         iterator, ns_from_origin),
1343                 "Message iterator cannot seek nanoseconds from origin: %!+i, "
1344                 "ns-from-origin=%" PRId64, iterator, ns_from_origin);
1345         set_self_comp_port_input_msg_iterator_state(iterator,
1346                 BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_SEEKING);
1347
1348         if (iterator->methods.seek_ns_from_origin) {
1349                 BT_LIB_LOGD("Calling user's \"seek nanoseconds from origin\" method: "
1350                         "%![iter-]+i, ns=%" PRId64, iterator, ns_from_origin);
1351                 status = iterator->methods.seek_ns_from_origin(iterator,
1352                         ns_from_origin);
1353                 BT_LOGD("User method returned: status=%s",
1354                         bt_message_iterator_status_string(status));
1355                 BT_ASSERT_PRE(status == BT_MESSAGE_ITERATOR_STATUS_OK ||
1356                         status == BT_MESSAGE_ITERATOR_STATUS_ERROR ||
1357                         status == BT_MESSAGE_ITERATOR_STATUS_NOMEM ||
1358                         status == BT_MESSAGE_ITERATOR_STATUS_AGAIN,
1359                         "Unexpected status: %![iter-]+i, status=%s",
1360                         iterator,
1361                         bt_self_message_iterator_status_string(status));
1362         } else {
1363                 /* Start automatic seeking: seek beginning first */
1364                 BT_ASSERT(iterator->methods.can_seek_beginning(iterator));
1365                 BT_ASSERT(iterator->methods.seek_beginning);
1366                 BT_LIB_LOGD("Calling user's \"seek beginning\" method: %!+i",
1367                         iterator);
1368                 status = iterator->methods.seek_beginning(iterator);
1369                 BT_LOGD("User method returned: status=%s",
1370                         bt_message_iterator_status_string(status));
1371                 BT_ASSERT_PRE(status == BT_MESSAGE_ITERATOR_STATUS_OK ||
1372                         status == BT_MESSAGE_ITERATOR_STATUS_ERROR ||
1373                         status == BT_MESSAGE_ITERATOR_STATUS_NOMEM ||
1374                         status == BT_MESSAGE_ITERATOR_STATUS_AGAIN,
1375                         "Unexpected status: %![iter-]+i, status=%s",
1376                         iterator,
1377                         bt_self_message_iterator_status_string(status));
1378                 switch (status) {
1379                 case BT_MESSAGE_ITERATOR_STATUS_OK:
1380                         break;
1381                 case BT_MESSAGE_ITERATOR_STATUS_ERROR:
1382                 case BT_MESSAGE_ITERATOR_STATUS_NOMEM:
1383                 case BT_MESSAGE_ITERATOR_STATUS_AGAIN:
1384                         goto end;
1385                 default:
1386                         abort();
1387                 }
1388
1389                 /*
1390                  * Find the first message which has a default clock
1391                  * snapshot greater than or equal to the requested
1392                  * seeking time, and move the received messages from
1393                  * this point in the batch to this iterator's auto-seek
1394                  * message queue.
1395                  */
1396                 while (!g_queue_is_empty(iterator->auto_seek_msgs)) {
1397                         bt_object_put_no_null_check(
1398                                 g_queue_pop_tail(iterator->auto_seek_msgs));
1399                 }
1400
1401                 status = find_message_ge_ns_from_origin(iterator,
1402                         ns_from_origin);
1403                 switch (status) {
1404                 case BT_MESSAGE_ITERATOR_STATUS_OK:
1405                 case BT_MESSAGE_ITERATOR_STATUS_END:
1406                         /*
1407                          * If there are messages in the auto-seek
1408                          * message queue, replace the user's "next"
1409                          * method with a custom, temporary "next" method
1410                          * which returns them.
1411                          */
1412                         if (!g_queue_is_empty(iterator->auto_seek_msgs)) {
1413                                 iterator->methods.next =
1414                                         (bt_self_component_port_input_message_iterator_next_method)
1415                                                 post_auto_seek_next;
1416                         }
1417
1418                         /*
1419                          * `BT_MESSAGE_ITERATOR_STATUS_END` becomes
1420                          * `BT_MESSAGE_ITERATOR_STATUS_OK`: the next
1421                          * time this iterator's "next" method is called,
1422                          * it will return
1423                          * `BT_MESSAGE_ITERATOR_STATUS_END`.
1424                          */
1425                         status = BT_MESSAGE_ITERATOR_STATUS_OK;
1426                         break;
1427                 case BT_MESSAGE_ITERATOR_STATUS_ERROR:
1428                 case BT_MESSAGE_ITERATOR_STATUS_NOMEM:
1429                 case BT_MESSAGE_ITERATOR_STATUS_AGAIN:
1430                         goto end;
1431                 default:
1432                         abort();
1433                 }
1434         }
1435
1436 end:
1437         set_iterator_state_after_seeking(iterator, status);
1438         return status;
1439 }
1440
1441 static inline
1442 bt_self_component_port_input_message_iterator *
1443 borrow_output_port_message_iterator_upstream_iterator(
1444                 struct bt_port_output_message_iterator *iterator)
1445 {
1446         struct bt_component_class_sink_colander_priv_data *colander_data;
1447
1448         BT_ASSERT(iterator);
1449         colander_data = (void *) iterator->colander->parent.user_data;
1450         BT_ASSERT(colander_data);
1451         BT_ASSERT(colander_data->msg_iter);
1452         return colander_data->msg_iter;
1453 }
1454
1455 bt_bool bt_port_output_message_iterator_can_seek_ns_from_origin(
1456                 struct bt_port_output_message_iterator *iterator,
1457                 int64_t ns_from_origin)
1458 {
1459         BT_ASSERT_PRE_NON_NULL(iterator, "Message iterator");
1460         return bt_self_component_port_input_message_iterator_can_seek_ns_from_origin(
1461                 borrow_output_port_message_iterator_upstream_iterator(
1462                         iterator), ns_from_origin);
1463 }
1464
1465 bt_bool bt_port_output_message_iterator_can_seek_beginning(
1466                 struct bt_port_output_message_iterator *iterator)
1467 {
1468         BT_ASSERT_PRE_NON_NULL(iterator, "Message iterator");
1469         return bt_self_component_port_input_message_iterator_can_seek_beginning(
1470                 borrow_output_port_message_iterator_upstream_iterator(
1471                         iterator));
1472 }
1473
1474 enum bt_message_iterator_status bt_port_output_message_iterator_seek_ns_from_origin(
1475                 struct bt_port_output_message_iterator *iterator,
1476                 int64_t ns_from_origin)
1477 {
1478         BT_ASSERT_PRE_NON_NULL(iterator, "Message iterator");
1479         return bt_self_component_port_input_message_iterator_seek_ns_from_origin(
1480                 borrow_output_port_message_iterator_upstream_iterator(iterator),
1481                 ns_from_origin);
1482 }
1483
1484 enum bt_message_iterator_status bt_port_output_message_iterator_seek_beginning(
1485                 struct bt_port_output_message_iterator *iterator)
1486 {
1487         BT_ASSERT_PRE_NON_NULL(iterator, "Message iterator");
1488         return bt_self_component_port_input_message_iterator_seek_beginning(
1489                 borrow_output_port_message_iterator_upstream_iterator(
1490                         iterator));
1491 }
1492
1493 void bt_port_output_message_iterator_get_ref(
1494                 const struct bt_port_output_message_iterator *iterator)
1495 {
1496         bt_object_get_ref(iterator);
1497 }
1498
1499 void bt_port_output_message_iterator_put_ref(
1500                 const struct bt_port_output_message_iterator *iterator)
1501 {
1502         bt_object_put_ref(iterator);
1503 }
1504
1505 void bt_self_component_port_input_message_iterator_get_ref(
1506                 const struct bt_self_component_port_input_message_iterator *iterator)
1507 {
1508         bt_object_get_ref(iterator);
1509 }
1510
1511 void bt_self_component_port_input_message_iterator_put_ref(
1512                 const struct bt_self_component_port_input_message_iterator *iterator)
1513 {
1514         bt_object_put_ref(iterator);
1515 }