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