src/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 "LIB/MSG-ITER"
  25 #include "lib/logging.h"
  26
  27 #include "compat/compiler.h"
  28 #include "compat/glib.h"
  29 #include "lib/trace-ir/clock-class.h"
  30 #include "lib/trace-ir/clock-snapshot.h"
  31 #include <babeltrace2/trace-ir/field.h>
  32 #include <babeltrace2/trace-ir/event-const.h>
  33 #include "lib/trace-ir/event.h"
  34 #include <babeltrace2/trace-ir/packet-const.h>
  35 #include "lib/trace-ir/packet.h"
  36 #include "lib/trace-ir/stream.h"
  37 #include <babeltrace2/trace-ir/clock-class-const.h>
  38 #include <babeltrace2/trace-ir/stream-class-const.h>
  39 #include <babeltrace2/trace-ir/stream-const.h>
  40 #include <babeltrace2/graph/connection-const.h>
  41 #include <babeltrace2/graph/component-const.h>
  42 #include <babeltrace2/graph/component-sink-const.h>
  43 #include <babeltrace2/graph/message-const.h>
  44 #include <babeltrace2/graph/message-iterator.h>
  45 #include <babeltrace2/graph/self-component-port-input-message-iterator.h>
  46 #include <babeltrace2/graph/message-event-const.h>
  47 #include <babeltrace2/graph/message-message-iterator-inactivity-const.h>
  48 #include <babeltrace2/graph/message-packet-beginning.h>
  49 #include <babeltrace2/graph/message-packet-beginning-const.h>
  50 #include <babeltrace2/graph/message-packet-end-const.h>
  51 #include <babeltrace2/graph/message-stream-beginning.h>
  52 #include <babeltrace2/graph/message-stream-beginning-const.h>
  53 #include <babeltrace2/graph/message-stream-end-const.h>
  54 #include <babeltrace2/graph/port-const.h>
  55 #include <babeltrace2/graph/graph.h>
  56 #include <babeltrace2/graph/graph-const.h>
  57 #include <babeltrace2/types.h>
  58 #include "common/assert.h"
  59 #include "lib/assert-pre.h"
  60 #include "lib/assert-post.h"
  61 #include <stdint.h>
  62 #include <inttypes.h>
  63 #include <stdlib.h>
  64
  65 #include "component-class.h"
  66 #include "component.h"
  67 #include "component-sink.h"
  68 #include "component-source.h"
  69 #include "connection.h"
  70 #include "graph.h"
  71 #include "message/discarded-items.h"
  72 #include "message/event.h"
  73 #include "message/iterator.h"
  74 #include "message/message.h"
  75 #include "message/message-iterator-inactivity.h"
  76 #include "message/stream.h"
  77 #include "message/packet.h"
  78 #include "lib/func-status.h"
  79
  80 /*
  81  * TODO: Use graph's state (number of active iterators, etc.) and
  82  * possibly system specifications to make a better guess than this.
  83  */
  84 #define MSG_BATCH_SIZE  15
  85
  86 #define BT_ASSERT_PRE_ITER_HAS_STATE_TO_SEEK(_iter)                     \
  87         BT_ASSERT_PRE((_iter)->state == BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_ACTIVE || \
  88                 (_iter)->state == BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_ENDED || \
  89                 (_iter)->state == BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_LAST_SEEKING_RETURNED_AGAIN || \
  90                 (_iter)->state == BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_LAST_SEEKING_RETURNED_ERROR, \
  91                 "Message iterator is in the wrong state: %!+i", _iter)
  92
  93 static inline
  94 void set_self_comp_port_input_msg_iterator_state(
  95                 struct bt_self_component_port_input_message_iterator *iterator,
  96                 enum bt_self_component_port_input_message_iterator_state state)
  97 {
  98         BT_ASSERT_DBG(iterator);
  99         BT_LIB_LOGD("Updating message iterator's state: new-state=%s",
 100                 bt_self_component_port_input_message_iterator_state_string(state));
 101         iterator->state = state;
 102 }
 103
 104 static
 105 void bt_self_component_port_input_message_iterator_destroy(struct bt_object *obj)
 106 {
 107         struct bt_self_component_port_input_message_iterator *iterator;
 108
 109         BT_ASSERT(obj);
 110
 111         /*
 112          * The message iterator's reference count is 0 if we're
 113          * here. Increment it to avoid a double-destroy (possibly
 114          * infinitely recursive). This could happen for example if the
 115          * message iterator's finalization function does
 116          * bt_object_get_ref() (or anything that causes
 117          * bt_object_get_ref() to be called) on itself (ref. count goes
 118          * from 0 to 1), and then bt_object_put_ref(): the reference
 119          * count would go from 1 to 0 again and this function would be
 120          * called again.
 121          */
 122         obj->ref_count++;
 123         iterator = (void *) obj;
 124         BT_LIB_LOGI("Destroying self component input port message iterator object: "
 125                 "%!+i", iterator);
 126         bt_self_component_port_input_message_iterator_try_finalize(iterator);
 127
 128         if (iterator->connection) {
 129                 /*
 130                  * Remove ourself from the originating connection so
 131                  * that it does not try to finalize a dangling pointer
 132                  * later.
 133                  */
 134                 bt_connection_remove_iterator(iterator->connection, iterator);
 135                 iterator->connection = NULL;
 136         }
 137
 138         if (iterator->auto_seek.msgs) {
 139                 while (!g_queue_is_empty(iterator->auto_seek.msgs)) {
 140                         bt_object_put_ref_no_null_check(
 141                                 g_queue_pop_tail(iterator->auto_seek.msgs));
 142                 }
 143
 144                 g_queue_free(iterator->auto_seek.msgs);
 145                 iterator->auto_seek.msgs = NULL;
 146         }
 147
 148         if (iterator->upstream_msg_iters) {
 149                 /*
 150                  * At this point the message iterator is finalized, so
 151                  * it's detached from any upstream message iterator.
 152                  */
 153                 BT_ASSERT(iterator->upstream_msg_iters->len == 0);
 154                 g_ptr_array_free(iterator->upstream_msg_iters, TRUE);
 155                 iterator->upstream_msg_iters = NULL;
 156         }
 157
 158         if (iterator->msgs) {
 159                 g_ptr_array_free(iterator->msgs, TRUE);
 160                 iterator->msgs = NULL;
 161         }
 162
 163         g_free(iterator);
 164 }
 165
 166 BT_HIDDEN
 167 void bt_self_component_port_input_message_iterator_try_finalize(
 168                 struct bt_self_component_port_input_message_iterator *iterator)
 169 {
 170         uint64_t i;
 171         typedef void (*method_t)(void *);
 172
 173         struct bt_component_class *comp_class = NULL;
 174         method_t method = NULL;
 175
 176         BT_ASSERT(iterator);
 177
 178         switch (iterator->state) {
 179         case BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_NON_INITIALIZED:
 180                 /* Skip user finalization if user initialization failed */
 181                 BT_LIB_LOGD("Not finalizing non-initialized message iterator: "
 182                         "%!+i", iterator);
 183                 goto end;
 184         case BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_FINALIZED:
 185                 /* Already finalized */
 186                 BT_LIB_LOGD("Not finalizing message iterator: already finalized: "
 187                         "%!+i", iterator);
 188                 goto end;
 189         case BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_FINALIZING:
 190                 /* Finalizing */
 191                 BT_LIB_LOGF("Message iterator is already being finalized: "
 192                         "%!+i", iterator);
 193                 abort();
 194         default:
 195                 break;
 196         }
 197
 198         BT_LIB_LOGD("Finalizing message iterator: %!+i", iterator);
 199         set_self_comp_port_input_msg_iterator_state(iterator,
 200                 BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_FINALIZING);
 201         BT_ASSERT(iterator->upstream_component);
 202         comp_class = iterator->upstream_component->class;
 203
 204         /* Call user-defined destroy method */
 205         switch (comp_class->type) {
 206         case BT_COMPONENT_CLASS_TYPE_SOURCE:
 207         {
 208                 struct bt_component_class_source *src_comp_cls =
 209                         (void *) comp_class;
 210
 211                 method = (method_t) src_comp_cls->methods.msg_iter_finalize;
 212                 break;
 213         }
 214         case BT_COMPONENT_CLASS_TYPE_FILTER:
 215         {
 216                 struct bt_component_class_filter *flt_comp_cls =
 217                         (void *) comp_class;
 218
 219                 method = (method_t) flt_comp_cls->methods.msg_iter_finalize;
 220                 break;
 221         }
 222         default:
 223                 /* Unreachable */
 224                 abort();
 225         }
 226
 227         if (method) {
 228                 BT_LIB_LOGD("Calling user's finalization method: %!+i",
 229                         iterator);
 230                 method(iterator);
 231         }
 232
 233         /* Detach upstream message iterators */
 234         for (i = 0; i < iterator->upstream_msg_iters->len; i++) {
 235                 struct bt_self_component_port_input_message_iterator *upstream_msg_iter =
 236                         iterator->upstream_msg_iters->pdata[i];
 237
 238                 upstream_msg_iter->downstream_msg_iter = NULL;
 239         }
 240
 241         g_ptr_array_set_size(iterator->upstream_msg_iters, 0);
 242
 243         /* Detach downstream message iterator */
 244         if (iterator->downstream_msg_iter) {
 245                 gboolean existed;
 246
 247                 BT_ASSERT(iterator->downstream_msg_iter->upstream_msg_iters);
 248                 existed = g_ptr_array_remove_fast(
 249                         iterator->downstream_msg_iter->upstream_msg_iters,
 250                         iterator);
 251                 BT_ASSERT(existed);
 252         }
 253
 254         iterator->upstream_component = NULL;
 255         iterator->upstream_port = NULL;
 256         set_self_comp_port_input_msg_iterator_state(iterator,
 257                 BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_FINALIZED);
 258         BT_LIB_LOGD("Finalized message iterator: %!+i", iterator);
 259
 260 end:
 261         return;
 262 }
 263
 264 BT_HIDDEN
 265 void bt_self_component_port_input_message_iterator_set_connection(
 266                 struct bt_self_component_port_input_message_iterator *iterator,
 267                 struct bt_connection *connection)
 268 {
 269         BT_ASSERT(iterator);
 270         iterator->connection = connection;
 271         BT_LIB_LOGI("Set message iterator's connection: "
 272                 "%![iter-]+i, %![conn-]+x", iterator, connection);
 273 }
 274
 275 static
 276 enum bt_message_iterator_can_seek_beginning_status can_seek_ns_from_origin_true(
 277                 struct bt_self_component_port_input_message_iterator *iterator,
 278                 int64_t ns_from_origin, bt_bool *can_seek)
 279 {
 280         *can_seek = BT_TRUE;
 281
 282         return BT_FUNC_STATUS_OK;
 283 }
 284
 285 static
 286 enum bt_message_iterator_can_seek_beginning_status can_seek_beginning_true(
 287                 struct bt_self_component_port_input_message_iterator *iterator,
 288                 bt_bool *can_seek)
 289 {
 290         *can_seek = BT_TRUE;
 291
 292         return BT_FUNC_STATUS_OK;
 293 }
 294
 295 static
 296 int create_self_component_input_port_message_iterator(
 297                 struct bt_self_message_iterator *self_downstream_msg_iter,
 298                 struct bt_self_component_port_input *self_port,
 299                 struct bt_self_component_port_input_message_iterator **message_iterator)
 300 {
 301         typedef enum bt_component_class_message_iterator_initialize_method_status (*init_method_t)(
 302                         void *, void *, void *, void *);
 303
 304         init_method_t init_method = NULL;
 305         struct bt_self_component_port_input_message_iterator *iterator =
 306                 NULL;
 307         struct bt_self_component_port_input_message_iterator *downstream_msg_iter =
 308                 (void *) self_downstream_msg_iter;
 309         struct bt_port *port = (void *) self_port;
 310         struct bt_port *upstream_port;
 311         struct bt_component *comp;
 312         struct bt_component *upstream_comp;
 313         struct bt_component_class *upstream_comp_cls;
 314         int status;
 315
 316         BT_ASSERT_PRE_NON_NULL(message_iterator, "Created message iterator");
 317         BT_ASSERT_PRE_NON_NULL(port, "Input port");
 318         comp = bt_port_borrow_component_inline(port);
 319         BT_ASSERT_PRE(bt_port_is_connected(port),
 320                 "Input port is not connected: %![port-]+p", port);
 321         BT_ASSERT_PRE(comp, "Input port is not part of a component: %![port-]+p",
 322                 port);
 323         BT_ASSERT(port->connection);
 324         upstream_port = port->connection->upstream_port;
 325         BT_ASSERT(upstream_port);
 326         upstream_comp = bt_port_borrow_component_inline(upstream_port);
 327         BT_ASSERT(upstream_comp);
 328         BT_ASSERT_PRE(
 329                 bt_component_borrow_graph(upstream_comp)->config_state ==
 330                         BT_GRAPH_CONFIGURATION_STATE_PARTIALLY_CONFIGURED ||
 331                 bt_component_borrow_graph(upstream_comp)->config_state ==
 332                         BT_GRAPH_CONFIGURATION_STATE_CONFIGURED,
 333                 "Graph is not configured: %!+g",
 334                 bt_component_borrow_graph(upstream_comp));
 335         upstream_comp_cls = upstream_comp->class;
 336         BT_ASSERT(upstream_comp->class->type ==
 337                 BT_COMPONENT_CLASS_TYPE_SOURCE ||
 338                 upstream_comp->class->type ==
 339                 BT_COMPONENT_CLASS_TYPE_FILTER);
 340         BT_LIB_LOGI("Creating message iterator on self component input port: "
 341                 "%![up-comp-]+c, %![up-port-]+p", upstream_comp, upstream_port);
 342         iterator = g_new0(
 343                 struct bt_self_component_port_input_message_iterator, 1);
 344         if (!iterator) {
 345                 BT_LIB_LOGE_APPEND_CAUSE(
 346                         "Failed to allocate one self component input port "
 347                         "message iterator.");
 348                 status = BT_FUNC_STATUS_MEMORY_ERROR;
 349                 goto error;
 350         }
 351
 352         bt_object_init_shared(&iterator->base,
 353                 bt_self_component_port_input_message_iterator_destroy);
 354         iterator->msgs = g_ptr_array_new();
 355         if (!iterator->msgs) {
 356                 BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate a GPtrArray.");
 357                 status = BT_FUNC_STATUS_MEMORY_ERROR;
 358                 goto error;
 359         }
 360
 361         g_ptr_array_set_size(iterator->msgs, MSG_BATCH_SIZE);
 362         iterator->last_ns_from_origin = INT64_MIN;
 363         iterator->auto_seek.msgs = g_queue_new();
 364         if (!iterator->auto_seek.msgs) {
 365                 BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate a GQueue.");
 366                 status = BT_FUNC_STATUS_MEMORY_ERROR;
 367                 goto error;
 368         }
 369
 370         iterator->upstream_msg_iters = g_ptr_array_new();
 371         if (!iterator->upstream_msg_iters) {
 372                 BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate a GPtrArray.");
 373                 status = BT_FUNC_STATUS_MEMORY_ERROR;
 374                 goto error;
 375         }
 376
 377         iterator->upstream_component = upstream_comp;
 378         iterator->upstream_port = upstream_port;
 379         iterator->connection = iterator->upstream_port->connection;
 380         iterator->graph = bt_component_borrow_graph(upstream_comp);
 381         set_self_comp_port_input_msg_iterator_state(iterator,
 382                 BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_NON_INITIALIZED);
 383
 384         switch (iterator->upstream_component->class->type) {
 385         case BT_COMPONENT_CLASS_TYPE_SOURCE:
 386         {
 387                 struct bt_component_class_source *src_comp_cls =
 388                         (void *) iterator->upstream_component->class;
 389
 390                 iterator->methods.next =
 391                         (bt_self_component_port_input_message_iterator_next_method)
 392                                 src_comp_cls->methods.msg_iter_next;
 393                 iterator->methods.seek_ns_from_origin =
 394                         (bt_self_component_port_input_message_iterator_seek_ns_from_origin_method)
 395                                 src_comp_cls->methods.msg_iter_seek_ns_from_origin;
 396                 iterator->methods.seek_beginning =
 397                         (bt_self_component_port_input_message_iterator_seek_beginning_method)
 398                                 src_comp_cls->methods.msg_iter_seek_beginning;
 399                 iterator->methods.can_seek_ns_from_origin =
 400                         (bt_self_component_port_input_message_iterator_can_seek_ns_from_origin_method)
 401                                 src_comp_cls->methods.msg_iter_can_seek_ns_from_origin;
 402                 iterator->methods.can_seek_beginning =
 403                         (bt_self_component_port_input_message_iterator_can_seek_beginning_method)
 404                                 src_comp_cls->methods.msg_iter_can_seek_beginning;
 405                 break;
 406         }
 407         case BT_COMPONENT_CLASS_TYPE_FILTER:
 408         {
 409                 struct bt_component_class_filter *flt_comp_cls =
 410                         (void *) iterator->upstream_component->class;
 411
 412                 iterator->methods.next =
 413                         (bt_self_component_port_input_message_iterator_next_method)
 414                                 flt_comp_cls->methods.msg_iter_next;
 415                 iterator->methods.seek_ns_from_origin =
 416                         (bt_self_component_port_input_message_iterator_seek_ns_from_origin_method)
 417                                 flt_comp_cls->methods.msg_iter_seek_ns_from_origin;
 418                 iterator->methods.seek_beginning =
 419                         (bt_self_component_port_input_message_iterator_seek_beginning_method)
 420                                 flt_comp_cls->methods.msg_iter_seek_beginning;
 421                 iterator->methods.can_seek_ns_from_origin =
 422                         (bt_self_component_port_input_message_iterator_can_seek_ns_from_origin_method)
 423                                 flt_comp_cls->methods.msg_iter_can_seek_ns_from_origin;
 424                 iterator->methods.can_seek_beginning =
 425                         (bt_self_component_port_input_message_iterator_can_seek_beginning_method)
 426                                 flt_comp_cls->methods.msg_iter_can_seek_beginning;
 427                 break;
 428         }
 429         default:
 430                 abort();
 431         }
 432
 433         if (iterator->methods.seek_ns_from_origin &&
 434                         !iterator->methods.can_seek_ns_from_origin) {
 435                 iterator->methods.can_seek_ns_from_origin =
 436                         (bt_self_component_port_input_message_iterator_can_seek_ns_from_origin_method)
 437                                 can_seek_ns_from_origin_true;
 438         }
 439
 440         if (iterator->methods.seek_beginning &&
 441                         !iterator->methods.can_seek_beginning) {
 442                 iterator->methods.can_seek_beginning =
 443                         (bt_self_component_port_input_message_iterator_can_seek_beginning_method)
 444                                 can_seek_beginning_true;
 445         }
 446
 447         switch (upstream_comp_cls->type) {
 448         case BT_COMPONENT_CLASS_TYPE_SOURCE:
 449         {
 450                 struct bt_component_class_source *src_comp_cls =
 451                         (void *) upstream_comp_cls;
 452
 453                 init_method =
 454                         (init_method_t) src_comp_cls->methods.msg_iter_initialize;
 455                 break;
 456         }
 457         case BT_COMPONENT_CLASS_TYPE_FILTER:
 458         {
 459                 struct bt_component_class_filter *flt_comp_cls =
 460                         (void *) upstream_comp_cls;
 461
 462                 init_method =
 463                         (init_method_t) flt_comp_cls->methods.msg_iter_initialize;
 464                 break;
 465         }
 466         default:
 467                 /* Unreachable */
 468                 abort();
 469         }
 470
 471         if (init_method) {
 472                 enum bt_component_class_message_iterator_initialize_method_status iter_status;
 473
 474                 BT_LIB_LOGD("Calling user's initialization method: %!+i", iterator);
 475                 iter_status = init_method(iterator, &iterator->config, upstream_comp,
 476                         upstream_port);
 477                 BT_LOGD("User method returned: status=%s",
 478                         bt_common_func_status_string(iter_status));
 479                 if (iter_status != BT_FUNC_STATUS_OK) {
 480                         BT_LIB_LOGW_APPEND_CAUSE(
 481                                 "Component input port message iterator initialization method failed: "
 482                                 "%![iter-]+i, status=%s",
 483                                 iterator,
 484                                 bt_common_func_status_string(iter_status));
 485                         status = iter_status;
 486                         goto error;
 487                 }
 488
 489                 iterator->config.frozen = true;
 490         }
 491
 492         if (downstream_msg_iter) {
 493                 /* Set this message iterator's downstream message iterator */
 494                 iterator->downstream_msg_iter = downstream_msg_iter;
 495
 496                 /*
 497                  * Add this message iterator to the downstream message
 498                  * iterator's array of upstream message iterators.
 499                  */
 500                 g_ptr_array_add(downstream_msg_iter->upstream_msg_iters,
 501                         iterator);
 502         }
 503
 504         set_self_comp_port_input_msg_iterator_state(iterator,
 505                 BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_ACTIVE);
 506         g_ptr_array_add(port->connection->iterators, iterator);
 507         BT_LIB_LOGI("Created message iterator on self component input port: "
 508                 "%![up-port-]+p, %![up-comp-]+c, %![iter-]+i",
 509                 upstream_port, upstream_comp, iterator);
 510
 511         *message_iterator = iterator;
 512         status = BT_FUNC_STATUS_OK;
 513         goto end;
 514
 515 error:
 516         BT_OBJECT_PUT_REF_AND_RESET(iterator);
 517
 518 end:
 519         return status;
 520 }
 521
 522 bt_self_component_port_input_message_iterator_create_from_message_iterator_status
 523 bt_self_component_port_input_message_iterator_create_from_message_iterator(
 524                 struct bt_self_message_iterator *self_msg_iter,
 525                 struct bt_self_component_port_input *input_port,
 526                 struct bt_self_component_port_input_message_iterator **message_iterator)
 527 {
 528         BT_ASSERT_PRE_NON_NULL(self_msg_iter, "Message iterator");
 529         return create_self_component_input_port_message_iterator(self_msg_iter,
 530                 input_port, message_iterator);
 531 }
 532
 533 bt_self_component_port_input_message_iterator_create_from_sink_component_status
 534 bt_self_component_port_input_message_iterator_create_from_sink_component(
 535                 struct bt_self_component_sink *self_comp,
 536                 struct bt_self_component_port_input *input_port,
 537                 struct bt_self_component_port_input_message_iterator **message_iterator)
 538 {
 539         BT_ASSERT_PRE_NON_NULL(self_comp, "Sink component");
 540         return create_self_component_input_port_message_iterator(NULL,
 541                 input_port, message_iterator);
 542 }
 543
 544 void *bt_self_message_iterator_get_data(
 545                 const struct bt_self_message_iterator *self_iterator)
 546 {
 547         struct bt_self_component_port_input_message_iterator *iterator =
 548                 (void *) self_iterator;
 549
 550         BT_ASSERT_PRE_DEV_NON_NULL(iterator, "Message iterator");
 551         return iterator->user_data;
 552 }
 553
 554 void bt_self_message_iterator_set_data(
 555                 struct bt_self_message_iterator *self_iterator, void *data)
 556 {
 557         struct bt_self_component_port_input_message_iterator *iterator =
 558                 (void *) self_iterator;
 559
 560         BT_ASSERT_PRE_DEV_NON_NULL(iterator, "Message iterator");
 561         iterator->user_data = data;
 562         BT_LIB_LOGD("Set message iterator's user data: "
 563                 "%!+i, user-data-addr=%p", iterator, data);
 564 }
 565
 566 void bt_self_message_iterator_configuration_set_can_seek_forward(
 567                 bt_self_message_iterator_configuration *config,
 568                 bt_bool can_seek_forward)
 569 {
 570         BT_ASSERT_PRE_NON_NULL(config, "Message iterator configuration");
 571         BT_ASSERT_PRE_DEV_HOT(config, "Message iterator configuration", "");
 572
 573         config->can_seek_forward = can_seek_forward;
 574 }
 575
 576 /*
 577  * Validate that the default clock snapshot in `msg` doesn't make us go back in
 578  * time.
 579  */
 580
 581 BT_ASSERT_POST_DEV_FUNC
 582 static
 583 bool clock_snapshots_are_monotonic_one(
 584                 struct bt_self_component_port_input_message_iterator *iterator,
 585                 const bt_message *msg)
 586 {
 587         const struct bt_clock_snapshot *clock_snapshot = NULL;
 588         bt_message_type message_type = bt_message_get_type(msg);
 589         int64_t ns_from_origin;
 590         enum bt_clock_snapshot_get_ns_from_origin_status clock_snapshot_status;
 591
 592         /*
 593          * The default is true: if we can't figure out the clock snapshot
 594          * (or there is none), assume it is fine.
 595          */
 596         bool result = true;
 597
 598         switch (message_type) {
 599         case BT_MESSAGE_TYPE_EVENT:
 600         {
 601                 struct bt_message_event *event_msg = (struct bt_message_event *) msg;
 602                 clock_snapshot = event_msg->default_cs;
 603                 break;
 604         }
 605         case BT_MESSAGE_TYPE_MESSAGE_ITERATOR_INACTIVITY:
 606         {
 607                 struct bt_message_message_iterator_inactivity *inactivity_msg =
 608                         (struct bt_message_message_iterator_inactivity *) msg;
 609                 clock_snapshot = inactivity_msg->default_cs;
 610                 break;
 611         }
 612         case BT_MESSAGE_TYPE_PACKET_BEGINNING:
 613         case BT_MESSAGE_TYPE_PACKET_END:
 614         {
 615                 struct bt_message_packet *packet_msg = (struct bt_message_packet *) msg;
 616                 clock_snapshot = packet_msg->default_cs;
 617                 break;
 618         }
 619         case BT_MESSAGE_TYPE_STREAM_BEGINNING:
 620         case BT_MESSAGE_TYPE_STREAM_END:
 621         {
 622                 struct bt_message_stream *stream_msg = (struct bt_message_stream *) msg;
 623                 if (stream_msg->default_cs_state != BT_MESSAGE_STREAM_CLOCK_SNAPSHOT_STATE_KNOWN) {
 624                         goto end;
 625                 }
 626
 627                 clock_snapshot = stream_msg->default_cs;
 628                 break;
 629         }
 630         case BT_MESSAGE_TYPE_DISCARDED_EVENTS:
 631         case BT_MESSAGE_TYPE_DISCARDED_PACKETS:
 632         {
 633                 struct bt_message_discarded_items *discarded_msg =
 634                         (struct bt_message_discarded_items *) msg;
 635
 636                 clock_snapshot = discarded_msg->default_begin_cs;
 637                 break;
 638         }
 639         }
 640
 641         if (!clock_snapshot) {
 642                 goto end;
 643         }
 644
 645         clock_snapshot_status = bt_clock_snapshot_get_ns_from_origin(clock_snapshot, &ns_from_origin);
 646         if (clock_snapshot_status != BT_FUNC_STATUS_OK) {
 647                 goto end;
 648         }
 649
 650         result = ns_from_origin >= iterator->last_ns_from_origin;
 651         iterator->last_ns_from_origin = ns_from_origin;
 652 end:
 653         return result;
 654 }
 655
 656 BT_ASSERT_POST_DEV_FUNC
 657 static
 658 bool clock_snapshots_are_monotonic(
 659                 struct bt_self_component_port_input_message_iterator *iterator,
 660                 bt_message_array_const msgs, uint64_t msg_count)
 661 {
 662         uint64_t i;
 663         bool result;
 664
 665         for (i = 0; i < msg_count; i++) {
 666                 if (!clock_snapshots_are_monotonic_one(iterator, msgs[i])) {
 667                         result = false;
 668                         goto end;
 669                 }
 670         }
 671
 672         result = true;
 673
 674 end:
 675         return result;
 676 }
 677
 678 /*
 679  * When a new stream begins, verify that the clock class tied to this
 680  * stream is compatible with what we've seen before.
 681  */
 682
 683 BT_ASSERT_POST_DEV_FUNC
 684 static
 685 bool clock_classes_are_compatible_one(struct bt_self_component_port_input_message_iterator *iterator,
 686                 const struct bt_message *msg)
 687 {
 688         enum bt_message_type message_type = bt_message_get_type(msg);
 689         bool result;
 690
 691         if (message_type == BT_MESSAGE_TYPE_STREAM_BEGINNING) {
 692                 const struct bt_message_stream *stream_msg = (struct bt_message_stream *) msg;
 693                 const struct bt_clock_class *clock_class = stream_msg->stream->class->default_clock_class;
 694                 bt_uuid clock_class_uuid = NULL;
 695
 696                 if (clock_class) {
 697                         clock_class_uuid = bt_clock_class_get_uuid(clock_class);
 698                 }
 699
 700                 switch (iterator->clock_expectation.type) {
 701                 case CLOCK_EXPECTATION_UNSET:
 702                         /*
 703                          * This is the first time we see a message with a clock
 704                          * snapshot: record the properties of that clock, against
 705                          * which we'll compare the clock properties of the following
 706                          * messages.
 707                          */
 708
 709                         if (!clock_class) {
 710                                 iterator->clock_expectation.type = CLOCK_EXPECTATION_NONE;
 711                         } else if (bt_clock_class_origin_is_unix_epoch(clock_class)) {
 712                                 iterator->clock_expectation.type = CLOCK_EXPECTATION_ORIGIN_UNIX;
 713                         } else if (clock_class_uuid) {
 714                                 iterator->clock_expectation.type = CLOCK_EXPECTATION_ORIGIN_OTHER_UUID;
 715                                 bt_uuid_copy(iterator->clock_expectation.uuid, clock_class_uuid);
 716                         } else {
 717                                 iterator->clock_expectation.type = CLOCK_EXPECTATION_ORIGIN_OTHER_NO_UUID;
 718                         }
 719                         break;
 720
 721                 case CLOCK_EXPECTATION_NONE:
 722                         if (clock_class) {
 723                                 BT_ASSERT_POST_DEV_MSG(
 724                                         "Expecting no clock class, got one: %![cc-]+K",
 725                                         clock_class);
 726                                 result = false;
 727                                 goto end;
 728                         }
 729
 730                         break;
 731
 732                 case CLOCK_EXPECTATION_ORIGIN_UNIX:
 733                         if (!clock_class) {
 734                                 BT_ASSERT_POST_DEV_MSG(
 735                                         "Expecting a clock class, got none.");
 736                                 result = false;
 737                                 goto end;
 738                         }
 739
 740                         if (!bt_clock_class_origin_is_unix_epoch(clock_class)) {
 741                                 BT_ASSERT_POST_DEV_MSG(
 742                                         "Expecting a clock class with Unix epoch origin: %![cc-]+K",
 743                                         clock_class);
 744                                 result = false;
 745                                 goto end;
 746                         }
 747                         break;
 748
 749                 case CLOCK_EXPECTATION_ORIGIN_OTHER_UUID:
 750                         if (!clock_class) {
 751                                 BT_ASSERT_POST_DEV_MSG(
 752                                         "Expecting a clock class, got none.");
 753                                 result = false;
 754                                 goto end;
 755                         }
 756
 757                         if (bt_clock_class_origin_is_unix_epoch(clock_class)) {
 758                                 BT_ASSERT_POST_DEV_MSG(
 759                                         "Expecting a clock class without Unix epoch origin: %![cc-]+K",
 760                                         clock_class);
 761                                 result = false;
 762                                 goto end;
 763                         }
 764
 765                         if (!clock_class_uuid) {
 766                                 BT_ASSERT_POST_DEV_MSG(
 767                                         "Expecting a clock class with UUID: %![cc-]+K",
 768                                         clock_class);
 769                                 result = false;
 770                                 goto end;
 771                         }
 772
 773                         if (bt_uuid_compare(iterator->clock_expectation.uuid, clock_class_uuid)) {
 774                                 BT_ASSERT_POST_DEV_MSG(
 775                                         "Expecting a clock class with UUID, got one "
 776                                         "with a different UUID: %![cc-]+K, expected-uuid=%!u",
 777                                         clock_class, iterator->clock_expectation.uuid);
 778                                 result = false;
 779                                 goto end;
 780                         }
 781                         break;
 782
 783                 case CLOCK_EXPECTATION_ORIGIN_OTHER_NO_UUID:
 784                         if (!clock_class) {
 785                                 BT_ASSERT_POST_DEV_MSG(
 786                                         "Expecting a clock class, got none.");
 787                                 result = false;
 788                                 goto end;
 789                         }
 790
 791                         if (bt_clock_class_origin_is_unix_epoch(clock_class)) {
 792                                 BT_ASSERT_POST_DEV_MSG(
 793                                         "Expecting a clock class without Unix epoch origin: %![cc-]+K",
 794                                         clock_class);
 795                                 result = false;
 796                                 goto end;
 797                         }
 798
 799                         if (clock_class_uuid) {
 800                                 BT_ASSERT_POST_DEV_MSG(
 801                                         "Expecting a clock class without UUID: %![cc-]+K",
 802                                         clock_class);
 803                                 result = false;
 804                                 goto end;
 805                         }
 806                         break;
 807                 }
 808         }
 809
 810         result = true;
 811
 812 end:
 813         return result;
 814 }
 815
 816 BT_ASSERT_POST_DEV_FUNC
 817 static
 818 bool clock_classes_are_compatible(
 819                 struct bt_self_component_port_input_message_iterator *iterator,
 820                 bt_message_array_const msgs, uint64_t msg_count)
 821 {
 822         uint64_t i;
 823         bool result;
 824
 825         for (i = 0; i < msg_count; i++) {
 826                 if (!clock_classes_are_compatible_one(iterator, msgs[i])) {
 827                         result = false;
 828                         goto end;
 829                 }
 830         }
 831
 832         result = true;
 833
 834 end:
 835         return result;
 836 }
 837
 838 /*
 839  * Call the `next` method of the iterator.  Do some validation on the returned
 840  * messages.
 841  */
 842
 843 static
 844 enum bt_component_class_message_iterator_next_method_status
 845 call_iterator_next_method(
 846                 struct bt_self_component_port_input_message_iterator *iterator,
 847                 bt_message_array_const msgs, uint64_t capacity, uint64_t *user_count)
 848 {
 849         enum bt_component_class_message_iterator_next_method_status status;
 850
 851         BT_ASSERT_DBG(iterator->methods.next);
 852         BT_LOGD_STR("Calling user's \"next\" method.");
 853         status = iterator->methods.next(iterator, msgs, capacity, user_count);
 854         BT_LOGD("User method returned: status=%s, msg-count=%" PRIu64,
 855                 bt_common_func_status_string(status), *user_count);
 856
 857         if (status == BT_FUNC_STATUS_OK) {
 858                 BT_ASSERT_POST_DEV(clock_classes_are_compatible(iterator, msgs, *user_count),
 859                         "Clocks are not compatible");
 860                 BT_ASSERT_POST_DEV(clock_snapshots_are_monotonic(iterator, msgs, *user_count),
 861                         "Clock snapshots are not monotonic");
 862         }
 863
 864         return status;
 865 }
 866
 867 enum bt_message_iterator_next_status
 868 bt_self_component_port_input_message_iterator_next(
 869                 struct bt_self_component_port_input_message_iterator *iterator,
 870                 bt_message_array_const *msgs, uint64_t *user_count)
 871 {
 872         enum bt_message_iterator_next_status status = BT_FUNC_STATUS_OK;
 873
 874         BT_ASSERT_PRE_DEV_NON_NULL(iterator, "Message iterator");
 875         BT_ASSERT_PRE_DEV_NON_NULL(msgs, "Message array (output)");
 876         BT_ASSERT_PRE_DEV_NON_NULL(user_count, "Message count (output)");
 877         BT_ASSERT_PRE_DEV(iterator->state ==
 878                 BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_ACTIVE,
 879                 "Message iterator's \"next\" called, but "
 880                 "message iterator is in the wrong state: %!+i", iterator);
 881         BT_ASSERT_DBG(iterator->upstream_component);
 882         BT_ASSERT_DBG(iterator->upstream_component->class);
 883         BT_ASSERT_PRE_DEV(
 884                 bt_component_borrow_graph(iterator->upstream_component)->config_state !=
 885                         BT_GRAPH_CONFIGURATION_STATE_CONFIGURING,
 886                 "Graph is not configured: %!+g",
 887                 bt_component_borrow_graph(iterator->upstream_component));
 888         BT_LIB_LOGD("Getting next self component input port "
 889                 "message iterator's messages: %!+i, batch-size=%u",
 890                 iterator, MSG_BATCH_SIZE);
 891
 892         /*
 893          * Call the user's "next" method to get the next messages
 894          * and status.
 895          */
 896         *user_count = 0;
 897         status = (int) call_iterator_next_method(iterator,
 898                 (void *) iterator->msgs->pdata, MSG_BATCH_SIZE,
 899                 user_count);
 900         BT_LOGD("User method returned: status=%s, msg-count=%" PRIu64,
 901                 bt_common_func_status_string(status), *user_count);
 902         if (status < 0) {
 903                 BT_LIB_LOGW_APPEND_CAUSE(
 904                         "Component input port message iterator's \"next\" method failed: "
 905                         "%![iter-]+i, status=%s",
 906                         iterator, bt_common_func_status_string(status));
 907                 goto end;
 908         }
 909
 910         /*
 911          * There is no way that this iterator could have been finalized
 912          * during its "next" method, as the only way to do this is to
 913          * put the last iterator's reference, and this can only be done
 914          * by its downstream owner.
 915          *
 916          * For the same reason, there is no way that this iterator could
 917          * have seeked (cannot seek a self message iterator).
 918          */
 919         BT_ASSERT_DBG(iterator->state ==
 920                 BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_ACTIVE);
 921
 922         switch (status) {
 923         case BT_FUNC_STATUS_OK:
 924                 BT_ASSERT_POST_DEV(*user_count <= MSG_BATCH_SIZE,
 925                         "Invalid returned message count: greater than "
 926                         "batch size: count=%" PRIu64 ", batch-size=%u",
 927                         *user_count, MSG_BATCH_SIZE);
 928                 *msgs = (void *) iterator->msgs->pdata;
 929                 break;
 930         case BT_FUNC_STATUS_AGAIN:
 931                 goto end;
 932         case BT_FUNC_STATUS_END:
 933                 set_self_comp_port_input_msg_iterator_state(iterator,
 934                         BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_ENDED);
 935                 goto end;
 936         default:
 937                 /* Unknown non-error status */
 938                 abort();
 939         }
 940
 941 end:
 942         return status;
 943 }
 944
 945 struct bt_component *
 946 bt_self_component_port_input_message_iterator_borrow_component(
 947                 struct bt_self_component_port_input_message_iterator *iterator)
 948 {
 949         BT_ASSERT_PRE_DEV_NON_NULL(iterator, "Message iterator");
 950         return iterator->upstream_component;
 951 }
 952
 953 struct bt_self_component *bt_self_message_iterator_borrow_component(
 954                 struct bt_self_message_iterator *self_iterator)
 955 {
 956         struct bt_self_component_port_input_message_iterator *iterator =
 957                 (void *) self_iterator;
 958
 959         BT_ASSERT_PRE_DEV_NON_NULL(iterator, "Message iterator");
 960         return (void *) iterator->upstream_component;
 961 }
 962
 963 struct bt_self_component_port_output *bt_self_message_iterator_borrow_port(
 964                 struct bt_self_message_iterator *self_iterator)
 965 {
 966         struct bt_self_component_port_input_message_iterator *iterator =
 967                 (void *) self_iterator;
 968
 969         BT_ASSERT_PRE_DEV_NON_NULL(iterator, "Message iterator");
 970         return (void *) iterator->upstream_port;
 971 }
 972
 973 enum bt_message_iterator_can_seek_ns_from_origin_status
 974 bt_self_component_port_input_message_iterator_can_seek_ns_from_origin(
 975                 struct bt_self_component_port_input_message_iterator *iterator,
 976                 int64_t ns_from_origin, bt_bool *can_seek)
 977 {
 978         enum bt_message_iterator_can_seek_ns_from_origin_status status;
 979
 980         BT_ASSERT_PRE_NON_NULL(iterator, "Message iterator");
 981         BT_ASSERT_PRE_NON_NULL(can_seek, "Result (output)");
 982         BT_ASSERT_PRE_ITER_HAS_STATE_TO_SEEK(iterator);
 983         BT_ASSERT_PRE(
 984                 bt_component_borrow_graph(iterator->upstream_component)->config_state !=
 985                         BT_GRAPH_CONFIGURATION_STATE_CONFIGURING,
 986                 "Graph is not configured: %!+g",
 987                 bt_component_borrow_graph(iterator->upstream_component));
 988
 989         if (iterator->methods.can_seek_ns_from_origin) {
 990                 /*
 991                  * Initialize to an invalid value, so we can post-assert that
 992                  * the method returned a valid value.
 993                  */
 994                 *can_seek = -1;
 995
 996                 BT_LIB_LOGD("Calling user's \"can seek nanoseconds from origin\" method: %!+i",
 997                         iterator);
 998
 999                 status = (int) iterator->methods.can_seek_ns_from_origin(iterator,
1000                         ns_from_origin, can_seek);
1001
1002                 if (status != BT_FUNC_STATUS_OK) {
1003                         BT_LIB_LOGW_APPEND_CAUSE(
1004                                 "Component input port message iterator's \"can seek nanoseconds from origin\" method failed: "
1005                                 "%![iter-]+i, status=%s",
1006                                 iterator, bt_common_func_status_string(status));
1007                         goto end;
1008                 }
1009
1010                 BT_ASSERT_POST(*can_seek == BT_TRUE || *can_seek == BT_FALSE,
1011                         "Unexpected boolean value returned from user's \"can seek ns from origin\" method: val=%d, %![iter-]+i",
1012                         *can_seek, iterator);
1013
1014                 BT_LIB_LOGD(
1015                         "User's \"can seek nanoseconds from origin\" returned successfully: "
1016                         "%![iter-]+i, can-seek=%d",
1017                         iterator, *can_seek);
1018
1019                 if (*can_seek) {
1020                         goto end;
1021                 }
1022         }
1023
1024         /*
1025          * Automatic seeking fall back: if we can seek to the beginning and the
1026          * iterator supports forward seeking then we can automatically seek to
1027          * any timestamp.
1028          */
1029         status = (int) bt_self_component_port_input_message_iterator_can_seek_beginning(
1030                 iterator, can_seek);
1031         if (status != BT_FUNC_STATUS_OK) {
1032                 goto end;
1033         }
1034
1035         *can_seek = *can_seek && iterator->config.can_seek_forward;
1036
1037 end:
1038         return status;
1039 }
1040
1041 enum bt_message_iterator_can_seek_beginning_status
1042 bt_self_component_port_input_message_iterator_can_seek_beginning(
1043                 struct bt_self_component_port_input_message_iterator *iterator,
1044                 bt_bool *can_seek)
1045 {
1046         enum bt_message_iterator_can_seek_beginning_status status;
1047
1048         BT_ASSERT_PRE_NON_NULL(iterator, "Message iterator");
1049         BT_ASSERT_PRE_NON_NULL(can_seek, "Result (output)");
1050         BT_ASSERT_PRE_ITER_HAS_STATE_TO_SEEK(iterator);
1051         BT_ASSERT_PRE(
1052                 bt_component_borrow_graph(iterator->upstream_component)->config_state !=
1053                         BT_GRAPH_CONFIGURATION_STATE_CONFIGURING,
1054                 "Graph is not configured: %!+g",
1055                 bt_component_borrow_graph(iterator->upstream_component));
1056
1057         if (iterator->methods.can_seek_beginning) {
1058                 /*
1059                  * Initialize to an invalid value, so we can post-assert that
1060                  * the method returned a valid value.
1061                  */
1062                 *can_seek = -1;
1063
1064                 status = (int) iterator->methods.can_seek_beginning(iterator, can_seek);
1065
1066                 BT_ASSERT_POST(
1067                         status != BT_FUNC_STATUS_OK ||
1068                                 *can_seek == BT_TRUE ||
1069                                 *can_seek == BT_FALSE,
1070                         "Unexpected boolean value returned from user's \"can seek beginning\" method: val=%d, %![iter-]+i",
1071                         *can_seek, iterator);
1072         } else {
1073                 *can_seek = BT_FALSE;
1074                 status = BT_FUNC_STATUS_OK;
1075         }
1076
1077         return status;
1078 }
1079
1080 static inline
1081 void set_iterator_state_after_seeking(
1082                 struct bt_self_component_port_input_message_iterator *iterator,
1083                 int status)
1084 {
1085         enum bt_self_component_port_input_message_iterator_state new_state = 0;
1086
1087         /* Set iterator's state depending on seeking status */
1088         switch (status) {
1089         case BT_FUNC_STATUS_OK:
1090                 new_state = BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_ACTIVE;
1091                 break;
1092         case BT_FUNC_STATUS_AGAIN:
1093                 new_state = BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_LAST_SEEKING_RETURNED_AGAIN;
1094                 break;
1095         case BT_FUNC_STATUS_ERROR:
1096         case BT_FUNC_STATUS_MEMORY_ERROR:
1097                 new_state = BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_LAST_SEEKING_RETURNED_ERROR;
1098                 break;
1099         case BT_FUNC_STATUS_END:
1100                 new_state = BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_ENDED;
1101                 break;
1102         default:
1103                 abort();
1104         }
1105
1106         set_self_comp_port_input_msg_iterator_state(iterator, new_state);
1107 }
1108
1109 static
1110 void reset_iterator_expectations(
1111                 struct bt_self_component_port_input_message_iterator *iterator)
1112 {
1113         iterator->last_ns_from_origin = INT64_MIN;
1114         iterator->clock_expectation.type = CLOCK_EXPECTATION_UNSET;
1115 }
1116
1117 static
1118 bool message_iterator_can_seek_beginning(
1119                 struct bt_self_component_port_input_message_iterator *iterator)
1120 {
1121         enum bt_message_iterator_can_seek_beginning_status status;
1122         bt_bool can_seek;
1123
1124         status = bt_self_component_port_input_message_iterator_can_seek_beginning(
1125                 iterator, &can_seek);
1126         if (status != BT_FUNC_STATUS_OK) {
1127                 can_seek = BT_FALSE;
1128         }
1129
1130         return can_seek;
1131 }
1132
1133 enum bt_message_iterator_seek_beginning_status
1134 bt_self_component_port_input_message_iterator_seek_beginning(
1135                 struct bt_self_component_port_input_message_iterator *iterator)
1136 {
1137         int status;
1138
1139         BT_ASSERT_PRE_NON_NULL(iterator, "Message iterator");
1140         BT_ASSERT_PRE_ITER_HAS_STATE_TO_SEEK(iterator);
1141         BT_ASSERT_PRE(
1142                 bt_component_borrow_graph(iterator->upstream_component)->config_state !=
1143                         BT_GRAPH_CONFIGURATION_STATE_CONFIGURING,
1144                 "Graph is not configured: %!+g",
1145                 bt_component_borrow_graph(iterator->upstream_component));
1146         BT_ASSERT_PRE(message_iterator_can_seek_beginning(iterator),
1147                 "Message iterator cannot seek beginning: %!+i", iterator);
1148
1149         /*
1150          * We are seeking, reset our expectations about how the following
1151          * messages should look like.
1152          */
1153         reset_iterator_expectations(iterator);
1154
1155         BT_LIB_LOGD("Calling user's \"seek beginning\" method: %!+i", iterator);
1156         set_self_comp_port_input_msg_iterator_state(iterator,
1157                 BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_SEEKING);
1158         status = iterator->methods.seek_beginning(iterator);
1159         BT_LOGD("User method returned: status=%s",
1160                 bt_common_func_status_string(status));
1161         BT_ASSERT_POST(status == BT_FUNC_STATUS_OK ||
1162                 status == BT_FUNC_STATUS_ERROR ||
1163                 status == BT_FUNC_STATUS_MEMORY_ERROR ||
1164                 status == BT_FUNC_STATUS_AGAIN,
1165                 "Unexpected status: %![iter-]+i, status=%s",
1166                 iterator, bt_common_func_status_string(status));
1167         if (status < 0) {
1168                 BT_LIB_LOGW_APPEND_CAUSE(
1169                         "Component input port message iterator's \"seek beginning\" method failed: "
1170                         "%![iter-]+i, status=%s",
1171                         iterator, bt_common_func_status_string(status));
1172         }
1173
1174         set_iterator_state_after_seeking(iterator, status);
1175         return status;
1176 }
1177
1178 bt_bool
1179 bt_self_component_port_input_message_iterator_can_seek_forward(
1180                 bt_self_component_port_input_message_iterator *iterator)
1181 {
1182         BT_ASSERT_PRE_NON_NULL(iterator, "Message iterator");
1183
1184         return iterator->config.can_seek_forward;
1185 }
1186
1187 /*
1188  * Structure used to record the state of a given stream during the fast-forward
1189  * phase of an auto-seek.
1190  */
1191 struct auto_seek_stream_state {
1192         /*
1193          * Value representing which step of this timeline we are at.
1194          *
1195          *      time --->
1196          *   [SB]  1  [PB]  2  [PE]  1  [SE]
1197          *
1198          * At each point in the timeline, the messages we need to replicate are:
1199          *
1200          *   1: Stream beginning
1201          *   2: Stream beginning, packet beginning
1202          *
1203          * Before "Stream beginning" and after "Stream end", we don't need to
1204          * replicate anything as the stream doesn't exist.
1205          */
1206         enum {
1207                 AUTO_SEEK_STREAM_STATE_STREAM_BEGAN,
1208                 AUTO_SEEK_STREAM_STATE_PACKET_BEGAN,
1209         } state;
1210
1211         /*
1212          * If `state` is AUTO_SEEK_STREAM_STATE_PACKET_BEGAN, the packet we are
1213          * in.  This is a weak reference, since the packet will always be
1214          * alive by the time we use it.
1215          */
1216         struct bt_packet *packet;
1217
1218         /* Have we see a message with a clock snapshot yet? */
1219         bool seen_clock_snapshot;
1220 };
1221
1222 static
1223 struct auto_seek_stream_state *create_auto_seek_stream_state(void)
1224 {
1225         return g_new0(struct auto_seek_stream_state, 1);
1226 }
1227
1228 static
1229 void destroy_auto_seek_stream_state(void *ptr)
1230 {
1231         g_free(ptr);
1232 }
1233
1234 static
1235 GHashTable *create_auto_seek_stream_states(void)
1236 {
1237         return g_hash_table_new_full(g_direct_hash, g_direct_equal, NULL,
1238                 destroy_auto_seek_stream_state);
1239 }
1240
1241 static
1242 void destroy_auto_seek_stream_states(GHashTable *stream_states)
1243 {
1244         g_hash_table_destroy(stream_states);
1245 }
1246
1247 /*
1248  * Handle one message while we are in the fast-forward phase of an auto-seek.
1249  *
1250  * Sets `*got_first` to true if the message's timestamp is greater or equal to
1251  * `ns_from_origin`.  In other words, if this is the first message after our
1252  * seek point.
1253  *
1254  * `stream_states` is an hash table of `bt_stream *` (weak reference) to
1255  * `struct auto_seek_stream_state` used to keep the state of each stream
1256  * during the fast-forward.
1257  */
1258
1259 static inline
1260 int auto_seek_handle_message(
1261                 struct bt_self_component_port_input_message_iterator *iterator,
1262                 int64_t ns_from_origin, const struct bt_message *msg,
1263                 bool *got_first, GHashTable *stream_states)
1264 {
1265         int status = BT_FUNC_STATUS_OK;
1266         int64_t msg_ns_from_origin;
1267         const struct bt_clock_snapshot *clk_snapshot = NULL;
1268         int ret;
1269
1270         BT_ASSERT_DBG(msg);
1271         BT_ASSERT_DBG(got_first);
1272
1273         switch (msg->type) {
1274         case BT_MESSAGE_TYPE_EVENT:
1275         {
1276                 const struct bt_message_event *event_msg =
1277                         (const void *) msg;
1278
1279                 clk_snapshot = event_msg->default_cs;
1280                 BT_ASSERT_POST_DEV(clk_snapshot,
1281                         "Event message has no default clock snapshot: %!+n",
1282                         event_msg);
1283                 break;
1284         }
1285         case BT_MESSAGE_TYPE_MESSAGE_ITERATOR_INACTIVITY:
1286         {
1287                 const struct bt_message_message_iterator_inactivity *inactivity_msg =
1288                         (const void *) msg;
1289
1290                 clk_snapshot = inactivity_msg->default_cs;
1291                 BT_ASSERT_DBG(clk_snapshot);
1292                 break;
1293         }
1294         case BT_MESSAGE_TYPE_PACKET_BEGINNING:
1295         case BT_MESSAGE_TYPE_PACKET_END:
1296         {
1297                 const struct bt_message_packet *packet_msg =
1298                         (const void *) msg;
1299
1300                 clk_snapshot = packet_msg->default_cs;
1301                 BT_ASSERT_POST_DEV(clk_snapshot,
1302                         "Packet message has no default clock snapshot: %!+n",
1303                         packet_msg);
1304                 break;
1305         }
1306         case BT_MESSAGE_TYPE_DISCARDED_EVENTS:
1307         case BT_MESSAGE_TYPE_DISCARDED_PACKETS:
1308         {
1309                 struct bt_message_discarded_items *msg_disc_items =
1310                         (void *) msg;
1311
1312                 BT_ASSERT_POST_DEV(msg_disc_items->default_begin_cs &&
1313                         msg_disc_items->default_end_cs,
1314                         "Discarded events/packets message has no default clock snapshots: %!+n",
1315                         msg_disc_items);
1316                 ret = bt_clock_snapshot_get_ns_from_origin(
1317                         msg_disc_items->default_begin_cs,
1318                         &msg_ns_from_origin);
1319                 if (ret) {
1320                         status = BT_FUNC_STATUS_ERROR;
1321                         goto end;
1322                 }
1323
1324                 if (msg_ns_from_origin >= ns_from_origin) {
1325                         *got_first = true;
1326                         goto push_msg;
1327                 }
1328
1329                 ret = bt_clock_snapshot_get_ns_from_origin(
1330                         msg_disc_items->default_end_cs,
1331                         &msg_ns_from_origin);
1332                 if (ret) {
1333                         status = BT_FUNC_STATUS_ERROR;
1334                         goto end;
1335                 }
1336
1337                 if (msg_ns_from_origin >= ns_from_origin) {
1338                         /*
1339                          * The discarded items message's beginning time
1340                          * is before the requested seeking time, but its
1341                          * end time is after. Modify the message so as
1342                          * to set its beginning time to the requested
1343                          * seeking time, and make its item count unknown
1344                          * as we don't know if items were really
1345                          * discarded within the new time range.
1346                          */
1347                         uint64_t new_begin_raw_value = 0;
1348
1349                         ret = bt_clock_class_clock_value_from_ns_from_origin(
1350                                 msg_disc_items->default_end_cs->clock_class,
1351                                 ns_from_origin, &new_begin_raw_value);
1352                         if (ret) {
1353                                 status = BT_FUNC_STATUS_ERROR;
1354                                 goto end;
1355                         }
1356
1357                         bt_clock_snapshot_set_raw_value(
1358                                 msg_disc_items->default_begin_cs,
1359                                 new_begin_raw_value);
1360                         msg_disc_items->count.base.avail =
1361                                 BT_PROPERTY_AVAILABILITY_NOT_AVAILABLE;
1362
1363                         /*
1364                          * It is safe to push it because its beginning
1365                          * time is exactly the requested seeking time.
1366                          */
1367                         goto push_msg;
1368                 } else {
1369                         goto skip_msg;
1370                 }
1371         }
1372         case BT_MESSAGE_TYPE_STREAM_BEGINNING:
1373         case BT_MESSAGE_TYPE_STREAM_END:
1374         {
1375                 struct bt_message_stream *stream_msg =
1376                         (struct bt_message_stream *) msg;
1377
1378                 if (stream_msg->default_cs_state != BT_MESSAGE_STREAM_CLOCK_SNAPSHOT_STATE_KNOWN) {
1379                         /* Ignore */
1380                         goto skip_msg;
1381                 }
1382
1383                 clk_snapshot = stream_msg->default_cs;
1384                 break;
1385         }
1386         default:
1387                 abort();
1388         }
1389
1390         BT_ASSERT_DBG(clk_snapshot);
1391         ret = bt_clock_snapshot_get_ns_from_origin(clk_snapshot,
1392                 &msg_ns_from_origin);
1393         if (ret) {
1394                 status = BT_FUNC_STATUS_ERROR;
1395                 goto end;
1396         }
1397
1398         if (msg_ns_from_origin >= ns_from_origin) {
1399                 *got_first = true;
1400                 goto push_msg;
1401         }
1402
1403 skip_msg:
1404         /* This message won't be sent downstream. */
1405         switch (msg->type) {
1406         case BT_MESSAGE_TYPE_STREAM_BEGINNING:
1407         {
1408                 const struct bt_message_stream *stream_msg = (const void *) msg;
1409                 struct auto_seek_stream_state *stream_state;
1410
1411                 /* Update stream's state: stream began. */
1412                 stream_state = create_auto_seek_stream_state();
1413                 if (!stream_state) {
1414                         status = BT_FUNC_STATUS_MEMORY_ERROR;
1415                         goto end;
1416                 }
1417
1418                 stream_state->state = AUTO_SEEK_STREAM_STATE_STREAM_BEGAN;
1419
1420                 if (stream_msg->default_cs_state == BT_MESSAGE_STREAM_CLOCK_SNAPSHOT_STATE_KNOWN) {
1421                         stream_state->seen_clock_snapshot = true;
1422                 }
1423
1424                 BT_ASSERT_DBG(!bt_g_hash_table_contains(stream_states, stream_msg->stream));
1425                 g_hash_table_insert(stream_states, stream_msg->stream, stream_state);
1426                 break;
1427         }
1428         case BT_MESSAGE_TYPE_PACKET_BEGINNING:
1429         {
1430                 const struct bt_message_packet *packet_msg =
1431                         (const void *) msg;
1432                 struct auto_seek_stream_state *stream_state;
1433
1434                 /* Update stream's state: packet began. */
1435                 stream_state = g_hash_table_lookup(stream_states, packet_msg->packet->stream);
1436                 BT_ASSERT_DBG(stream_state);
1437                 BT_ASSERT_DBG(stream_state->state == AUTO_SEEK_STREAM_STATE_STREAM_BEGAN);
1438                 stream_state->state = AUTO_SEEK_STREAM_STATE_PACKET_BEGAN;
1439                 BT_ASSERT_DBG(!stream_state->packet);
1440                 stream_state->packet = packet_msg->packet;
1441
1442                 if (packet_msg->packet->stream->class->packets_have_beginning_default_clock_snapshot) {
1443                         stream_state->seen_clock_snapshot = true;
1444                 }
1445
1446                 break;
1447         }
1448         case BT_MESSAGE_TYPE_EVENT:
1449         {
1450                 const struct bt_message_event *event_msg = (const void *) msg;
1451                 struct auto_seek_stream_state *stream_state;
1452
1453                 stream_state = g_hash_table_lookup(stream_states,
1454                         event_msg->event->packet->stream);
1455                 BT_ASSERT_DBG(stream_state);
1456
1457                 // HELPME: are we sure that event messages have clock snapshots at this point?
1458                 stream_state->seen_clock_snapshot = true;
1459
1460                 break;
1461         }
1462         case BT_MESSAGE_TYPE_PACKET_END:
1463         {
1464                 const struct bt_message_packet *packet_msg =
1465                         (const void *) msg;
1466                 struct auto_seek_stream_state *stream_state;
1467
1468                 /* Update stream's state: packet ended. */
1469                 stream_state = g_hash_table_lookup(stream_states, packet_msg->packet->stream);
1470                 BT_ASSERT_DBG(stream_state);
1471                 BT_ASSERT_DBG(stream_state->state == AUTO_SEEK_STREAM_STATE_PACKET_BEGAN);
1472                 stream_state->state = AUTO_SEEK_STREAM_STATE_STREAM_BEGAN;
1473                 BT_ASSERT_DBG(stream_state->packet);
1474                 stream_state->packet = NULL;
1475
1476                 if (packet_msg->packet->stream->class->packets_have_end_default_clock_snapshot) {
1477                         stream_state->seen_clock_snapshot = true;
1478                 }
1479
1480                 break;
1481         }
1482         case BT_MESSAGE_TYPE_STREAM_END:
1483         {
1484                 const struct bt_message_stream *stream_msg = (const void *) msg;
1485                 struct auto_seek_stream_state *stream_state;
1486
1487                 stream_state = g_hash_table_lookup(stream_states, stream_msg->stream);
1488                 BT_ASSERT_DBG(stream_state);
1489                 BT_ASSERT_DBG(stream_state->state == AUTO_SEEK_STREAM_STATE_STREAM_BEGAN);
1490                 BT_ASSERT_DBG(!stream_state->packet);
1491
1492                 /* Update stream's state: this stream doesn't exist anymore. */
1493                 g_hash_table_remove(stream_states, stream_msg->stream);
1494                 break;
1495         }
1496         case BT_MESSAGE_TYPE_DISCARDED_EVENTS:
1497         case BT_MESSAGE_TYPE_DISCARDED_PACKETS:
1498         {
1499                 const struct bt_message_discarded_items *discarded_msg =
1500                         (const void *) msg;
1501                 struct auto_seek_stream_state *stream_state;
1502
1503                 stream_state = g_hash_table_lookup(stream_states, discarded_msg->stream);
1504                 BT_ASSERT_DBG(stream_state);
1505
1506                 if ((msg->type == BT_MESSAGE_TYPE_DISCARDED_EVENTS && discarded_msg->stream->class->discarded_events_have_default_clock_snapshots) ||
1507                         (msg->type == BT_MESSAGE_TYPE_DISCARDED_PACKETS && discarded_msg->stream->class->discarded_packets_have_default_clock_snapshots)) {
1508                         stream_state->seen_clock_snapshot = true;
1509                 }
1510
1511                 break;
1512         }
1513         default:
1514                 break;
1515         }
1516
1517         bt_object_put_ref_no_null_check(msg);
1518         msg = NULL;
1519         goto end;
1520
1521 push_msg:
1522         g_queue_push_tail(iterator->auto_seek.msgs, (void *) msg);
1523         msg = NULL;
1524
1525 end:
1526         BT_ASSERT_DBG(!msg || status != BT_FUNC_STATUS_OK);
1527         return status;
1528 }
1529
1530 static
1531 int find_message_ge_ns_from_origin(
1532                 struct bt_self_component_port_input_message_iterator *iterator,
1533                 int64_t ns_from_origin, GHashTable *stream_states)
1534 {
1535         int status = BT_FUNC_STATUS_OK;
1536         enum bt_self_component_port_input_message_iterator_state init_state =
1537                 iterator->state;
1538         const struct bt_message *messages[MSG_BATCH_SIZE];
1539         uint64_t user_count = 0;
1540         uint64_t i;
1541         bool got_first = false;
1542
1543         BT_ASSERT_DBG(iterator);
1544         memset(&messages[0], 0, sizeof(messages[0]) * MSG_BATCH_SIZE);
1545
1546         /*
1547          * Make this iterator temporarily active (not seeking) to call
1548          * the "next" method.
1549          */
1550         set_self_comp_port_input_msg_iterator_state(iterator,
1551                 BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_ACTIVE);
1552
1553         BT_ASSERT_DBG(iterator->methods.next);
1554
1555         while (!got_first) {
1556                 /*
1557                  * Call the user's "next" method to get the next
1558                  * messages and status.
1559                  */
1560                 status = call_iterator_next_method(iterator,
1561                         &messages[0], MSG_BATCH_SIZE, &user_count);
1562                 BT_LOGD("User method returned: status=%s",
1563                         bt_common_func_status_string(status));
1564                 if (status < 0) {
1565                         BT_LIB_LOGW_APPEND_CAUSE(
1566                                 "Component input port message iterator's \"next\" method failed: "
1567                                 "%![iter-]+i, status=%s",
1568                                 iterator, bt_common_func_status_string(status));
1569                 }
1570
1571                 /*
1572                  * The user's "next" method must not do any action which
1573                  * would change the iterator's state.
1574                  */
1575                 BT_ASSERT_DBG(iterator->state ==
1576                         BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_ACTIVE);
1577
1578                 switch (status) {
1579                 case BT_FUNC_STATUS_OK:
1580                         BT_ASSERT_POST_DEV(user_count <= MSG_BATCH_SIZE,
1581                                 "Invalid returned message count: greater than "
1582                                 "batch size: count=%" PRIu64 ", batch-size=%u",
1583                                 user_count, MSG_BATCH_SIZE);
1584                         break;
1585                 case BT_FUNC_STATUS_AGAIN:
1586                 case BT_FUNC_STATUS_ERROR:
1587                 case BT_FUNC_STATUS_MEMORY_ERROR:
1588                 case BT_FUNC_STATUS_END:
1589                         goto end;
1590                 default:
1591                         abort();
1592                 }
1593
1594                 for (i = 0; i < user_count; i++) {
1595                         if (got_first) {
1596                                 g_queue_push_tail(iterator->auto_seek.msgs,
1597                                         (void *) messages[i]);
1598                                 messages[i] = NULL;
1599                                 continue;
1600                         }
1601
1602                         status = auto_seek_handle_message(iterator,
1603                                 ns_from_origin, messages[i], &got_first,
1604                                 stream_states);
1605                         if (status == BT_FUNC_STATUS_OK) {
1606                                 /* Message was either pushed or moved */
1607                                 messages[i] = NULL;
1608                         } else {
1609                                 goto end;
1610                         }
1611                 }
1612         }
1613
1614 end:
1615         for (i = 0; i < user_count; i++) {
1616                 if (messages[i]) {
1617                         bt_object_put_ref_no_null_check(messages[i]);
1618                 }
1619         }
1620
1621         set_self_comp_port_input_msg_iterator_state(iterator, init_state);
1622         return status;
1623 }
1624
1625 /*
1626  * This function is installed as the iterator's next callback after we have
1627  * auto-seeked (seeked to the beginning and fast-forwarded) to send the
1628  * messages saved in iterator->auto_seek.msgs.  Once this is done, the original
1629  * next callback is put back.
1630  */
1631
1632 static
1633 enum bt_component_class_message_iterator_next_method_status post_auto_seek_next(
1634                 struct bt_self_component_port_input_message_iterator *iterator,
1635                 bt_message_array_const msgs, uint64_t capacity,
1636                 uint64_t *count)
1637 {
1638         BT_ASSERT(!g_queue_is_empty(iterator->auto_seek.msgs));
1639         *count = 0;
1640
1641         /*
1642          * Move auto-seek messages to the output array (which is this
1643          * iterator's base message array).
1644          */
1645         while (capacity > 0 && !g_queue_is_empty(iterator->auto_seek.msgs)) {
1646                 msgs[*count] = g_queue_pop_head(iterator->auto_seek.msgs);
1647                 capacity--;
1648                 (*count)++;
1649         }
1650
1651         BT_ASSERT(*count > 0);
1652
1653         if (g_queue_is_empty(iterator->auto_seek.msgs)) {
1654                 /* No more auto-seek messages, restore user's next callback. */
1655                 BT_ASSERT(iterator->auto_seek.original_next_callback);
1656                 iterator->methods.next = iterator->auto_seek.original_next_callback;
1657                 iterator->auto_seek.original_next_callback = NULL;
1658         }
1659
1660         return BT_FUNC_STATUS_OK;
1661 }
1662
1663 static inline
1664 int clock_raw_value_from_ns_from_origin(const bt_clock_class *clock_class,
1665                 int64_t ns_from_origin, uint64_t *raw_value)
1666 {
1667
1668         int64_t cc_offset_s = clock_class->offset_seconds;
1669         uint64_t cc_offset_cycles = clock_class->offset_cycles;
1670         uint64_t cc_freq = clock_class->frequency;
1671
1672         return bt_common_clock_value_from_ns_from_origin(cc_offset_s,
1673                 cc_offset_cycles, cc_freq, ns_from_origin, raw_value);
1674 }
1675
1676 static
1677 bool message_iterator_can_seek_ns_from_origin(
1678                 struct bt_self_component_port_input_message_iterator *iterator,
1679                 int64_t ns_from_origin)
1680 {
1681         enum bt_message_iterator_can_seek_ns_from_origin_status status;
1682         bt_bool can_seek;
1683
1684         status = bt_self_component_port_input_message_iterator_can_seek_ns_from_origin(
1685                 iterator, ns_from_origin, &can_seek);
1686         if (status != BT_FUNC_STATUS_OK) {
1687                 can_seek = BT_FALSE;
1688         }
1689
1690         return can_seek;
1691 }
1692
1693 enum bt_message_iterator_seek_ns_from_origin_status
1694 bt_self_component_port_input_message_iterator_seek_ns_from_origin(
1695                 struct bt_self_component_port_input_message_iterator *iterator,
1696                 int64_t ns_from_origin)
1697 {
1698         int status;
1699         GHashTable *stream_states = NULL;
1700         bt_bool can_seek_by_itself;
1701
1702         BT_ASSERT_PRE_NON_NULL(iterator, "Message iterator");
1703         BT_ASSERT_PRE_ITER_HAS_STATE_TO_SEEK(iterator);
1704         BT_ASSERT_PRE(
1705                 bt_component_borrow_graph(iterator->upstream_component)->config_state !=
1706                         BT_GRAPH_CONFIGURATION_STATE_CONFIGURING,
1707                 "Graph is not configured: %!+g",
1708                 bt_component_borrow_graph(iterator->upstream_component));
1709         /* The iterator must be able to seek ns from origin one way or another. */
1710         BT_ASSERT_PRE(
1711                 message_iterator_can_seek_ns_from_origin(iterator, ns_from_origin),
1712                 "Message iterator cannot seek nanoseconds from origin: %!+i, "
1713                 "ns-from-origin=%" PRId64, iterator, ns_from_origin);
1714         set_self_comp_port_input_msg_iterator_state(iterator,
1715                 BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_SEEKING);
1716
1717         /*
1718          * We are seeking, reset our expectations about how the following
1719          * messages should look like.
1720          */
1721         reset_iterator_expectations(iterator);
1722
1723         /* Check if the iterator can seek by itself.  If not we'll use autoseek. */
1724         if (iterator->methods.can_seek_ns_from_origin) {
1725                 bt_component_class_message_iterator_can_seek_ns_from_origin_method_status
1726                         can_seek_status;
1727
1728                 can_seek_status =
1729                         iterator->methods.can_seek_ns_from_origin(
1730                                 iterator, ns_from_origin, &can_seek_by_itself);
1731                 if (can_seek_status != BT_FUNC_STATUS_OK) {
1732                         status = can_seek_status;
1733                         goto end;
1734                 }
1735         } else {
1736                 can_seek_by_itself = false;
1737         }
1738
1739         if (can_seek_by_itself) {
1740                 /* The iterator knows how to seek to a particular time, let it handle this. */
1741                 BT_ASSERT(iterator->methods.seek_ns_from_origin);
1742                 BT_LIB_LOGD("Calling user's \"seek nanoseconds from origin\" method: "
1743                         "%![iter-]+i, ns=%" PRId64, iterator, ns_from_origin);
1744                 status = iterator->methods.seek_ns_from_origin(iterator,
1745                         ns_from_origin);
1746                 BT_LOGD("User method returned: status=%s",
1747                         bt_common_func_status_string(status));
1748                 BT_ASSERT_POST(status == BT_FUNC_STATUS_OK ||
1749                         status == BT_FUNC_STATUS_ERROR ||
1750                         status == BT_FUNC_STATUS_MEMORY_ERROR ||
1751                         status == BT_FUNC_STATUS_AGAIN,
1752                         "Unexpected status: %![iter-]+i, status=%s",
1753                         iterator, bt_common_func_status_string(status));
1754                 if (status < 0) {
1755                         BT_LIB_LOGW_APPEND_CAUSE(
1756                                 "Component input port message iterator's \"seek nanoseconds from origin\" method failed: "
1757                                 "%![iter-]+i, status=%s",
1758                                 iterator, bt_common_func_status_string(status));
1759                 }
1760         } else {
1761                 /*
1762                  * The iterator doesn't know how to seek by itself to a
1763                  * particular time.  We will seek to the beginning and fast
1764                  * forward to the right place.
1765                  */
1766                 enum bt_component_class_message_iterator_can_seek_beginning_method_status
1767                         can_seek_status;
1768                 bt_bool can_seek_beginning;
1769
1770                 can_seek_status = iterator->methods.can_seek_beginning(iterator,
1771                         &can_seek_beginning);
1772                 BT_ASSERT(can_seek_status == BT_FUNC_STATUS_OK);
1773                 BT_ASSERT(can_seek_beginning);
1774                 BT_ASSERT(iterator->methods.seek_beginning);
1775                 BT_LIB_LOGD("Calling user's \"seek beginning\" method: %!+i",
1776                         iterator);
1777                 status = iterator->methods.seek_beginning(iterator);
1778                 BT_LOGD("User method returned: status=%s",
1779                         bt_common_func_status_string(status));
1780                 BT_ASSERT_POST(status == BT_FUNC_STATUS_OK ||
1781                         status == BT_FUNC_STATUS_ERROR ||
1782                         status == BT_FUNC_STATUS_MEMORY_ERROR ||
1783                         status == BT_FUNC_STATUS_AGAIN,
1784                         "Unexpected status: %![iter-]+i, status=%s",
1785                         iterator, bt_common_func_status_string(status));
1786                 if (status < 0) {
1787                         BT_LIB_LOGW_APPEND_CAUSE(
1788                                 "Component input port message iterator's \"seek beginning\" method failed: "
1789                                 "%![iter-]+i, status=%s",
1790                                 iterator, bt_common_func_status_string(status));
1791                 }
1792
1793                 switch (status) {
1794                 case BT_FUNC_STATUS_OK:
1795                         break;
1796                 case BT_FUNC_STATUS_ERROR:
1797                 case BT_FUNC_STATUS_MEMORY_ERROR:
1798                 case BT_FUNC_STATUS_AGAIN:
1799                         goto end;
1800                 default:
1801                         abort();
1802                 }
1803
1804                 /*
1805                  * Find the first message which has a default clock
1806                  * snapshot greater than or equal to the requested
1807                  * seeking time, and move the received messages from
1808                  * this point in the batch to this iterator's auto-seek
1809                  * message queue.
1810                  */
1811                 while (!g_queue_is_empty(iterator->auto_seek.msgs)) {
1812                         bt_object_put_ref_no_null_check(
1813                                 g_queue_pop_tail(iterator->auto_seek.msgs));
1814                 }
1815
1816                 stream_states = create_auto_seek_stream_states();
1817                 if (!stream_states) {
1818                         BT_LIB_LOGE_APPEND_CAUSE(
1819                                 "Failed to allocate one GHashTable.");
1820                         status = BT_FUNC_STATUS_MEMORY_ERROR;
1821                         goto end;
1822                 }
1823
1824                 status = find_message_ge_ns_from_origin(iterator,
1825                         ns_from_origin, stream_states);
1826                 switch (status) {
1827                 case BT_FUNC_STATUS_OK:
1828                 case BT_FUNC_STATUS_END:
1829                 {
1830                         GHashTableIter iter;
1831                         gpointer key, value;
1832
1833                         /*
1834                          * If some streams exist at the seek time, prepend the
1835                          * required messages to put those streams in the right
1836                          * state.
1837                          */
1838                         g_hash_table_iter_init(&iter, stream_states);
1839                         while (g_hash_table_iter_next (&iter, &key, &value)) {
1840                                 const bt_stream *stream = key;
1841                                 struct auto_seek_stream_state *stream_state =
1842                                         (struct auto_seek_stream_state *) value;
1843                                 bt_message *msg;
1844                                 const bt_clock_class *clock_class = bt_stream_class_borrow_default_clock_class_const(
1845                                         bt_stream_borrow_class_const(stream));
1846                                 /* Initialize to silence maybe-uninitialized warning. */
1847                                 uint64_t raw_value = 0;
1848
1849                                 /*
1850                                  * If we haven't seen a message with a clock snapshot, we don't know if our seek time is within
1851                                  * the clock's range, so it wouldn't be safe to try to convert ns_from_origin to a clock value.
1852                                  *
1853                                  * Also, it would be a bit of a lie to generate a stream begin message with the seek time as its
1854                                  * clock snapshot, because we don't really know if the stream existed at that time.  If we have
1855                                  * seen a message with a clock snapshot in our seeking, then we are sure that the
1856                                  * seek time is not below the clock range, and we know the stream was active at that
1857                                  * time (and that we cut it short).
1858                                  */
1859                                 if (stream_state->seen_clock_snapshot) {
1860                                         if (clock_raw_value_from_ns_from_origin(clock_class, ns_from_origin, &raw_value) != 0) {
1861                                                 BT_LIB_LOGW("Could not convert nanoseconds from origin to clock value: ns-from-origin=%" PRId64 ", %![cc-]+K",
1862                                                         ns_from_origin, clock_class);
1863                                                 status = BT_FUNC_STATUS_ERROR;
1864                                                 goto end;
1865                                         }
1866                                 }
1867
1868                                 switch (stream_state->state) {
1869                                 case AUTO_SEEK_STREAM_STATE_PACKET_BEGAN:
1870                                         BT_ASSERT(stream_state->packet);
1871                                         BT_LIB_LOGD("Creating packet message: %![packet-]+a", stream_state->packet);
1872
1873                                         if (stream->class->packets_have_beginning_default_clock_snapshot) {
1874                                                 /*
1875                                                  * If we are in the PACKET_BEGAN state, it means we have seen a "packet beginning"
1876                                                  * message.  If "packet beginning" packets have clock snapshots, then we must have
1877                                                  * seen a clock snapshot.
1878                                                  */
1879                                                 BT_ASSERT(stream_state->seen_clock_snapshot);
1880
1881                                                 msg = bt_message_packet_beginning_create_with_default_clock_snapshot(
1882                                                         (bt_self_message_iterator *) iterator, stream_state->packet, raw_value);
1883                                         } else {
1884                                                 msg = bt_message_packet_beginning_create((bt_self_message_iterator *) iterator,
1885                                                                 stream_state->packet);
1886                                         }
1887
1888                                         if (!msg) {
1889                                                 status = BT_FUNC_STATUS_MEMORY_ERROR;
1890                                                 goto end;
1891                                         }
1892
1893                                         g_queue_push_head(iterator->auto_seek.msgs, msg);
1894                                         msg = NULL;
1895                                         /* fall-thru */
1896
1897                                 case AUTO_SEEK_STREAM_STATE_STREAM_BEGAN:
1898                                         msg = bt_message_stream_beginning_create(
1899                                                 (bt_self_message_iterator *) iterator, stream);
1900                                         if (!msg) {
1901                                                 status = BT_FUNC_STATUS_MEMORY_ERROR;
1902                                                 goto end;
1903                                         }
1904
1905                                         if (stream_state->seen_clock_snapshot) {
1906                                                 bt_message_stream_beginning_set_default_clock_snapshot(msg, raw_value);
1907                                         }
1908
1909                                         g_queue_push_head(iterator->auto_seek.msgs, msg);
1910                                         msg = NULL;
1911                                         break;
1912                                 }
1913                         }
1914
1915                         /*
1916                          * If there are messages in the auto-seek
1917                          * message queue, replace the user's "next"
1918                          * method with a custom, temporary "next" method
1919                          * which returns them.
1920                          */
1921                         if (!g_queue_is_empty(iterator->auto_seek.msgs)) {
1922                                 BT_ASSERT(!iterator->auto_seek.original_next_callback);
1923                                 iterator->auto_seek.original_next_callback = iterator->methods.next;
1924
1925                                 iterator->methods.next =
1926                                         (bt_self_component_port_input_message_iterator_next_method)
1927                                                 post_auto_seek_next;
1928                         }
1929
1930                         /*
1931                          * `BT_FUNC_STATUS_END` becomes
1932                          * `BT_FUNC_STATUS_OK`: the next
1933                          * time this iterator's "next" method is called,
1934                          * it will return
1935                          * `BT_FUNC_STATUS_END`.
1936                          */
1937                         status = BT_FUNC_STATUS_OK;
1938                         break;
1939                 }
1940                 case BT_FUNC_STATUS_ERROR:
1941                 case BT_FUNC_STATUS_MEMORY_ERROR:
1942                 case BT_FUNC_STATUS_AGAIN:
1943                         goto end;
1944                 default:
1945                         abort();
1946                 }
1947         }
1948
1949         /*
1950          * The following messages returned by the next method (including
1951          * post_auto_seek_next) must be after (or at) `ns_from_origin`.
1952          */
1953         iterator->last_ns_from_origin = ns_from_origin;
1954
1955 end:
1956         if (stream_states) {
1957                 destroy_auto_seek_stream_states(stream_states);
1958                 stream_states = NULL;
1959         }
1960
1961         set_iterator_state_after_seeking(iterator, status);
1962         return status;
1963 }
1964
1965 bt_bool bt_self_message_iterator_is_interrupted(
1966                 const struct bt_self_message_iterator *self_msg_iter)
1967 {
1968         const struct bt_self_component_port_input_message_iterator *iterator =
1969                 (const void *) self_msg_iter;
1970
1971         BT_ASSERT_PRE_NON_NULL(iterator, "Message iterator");
1972         return (bt_bool) bt_graph_is_interrupted(iterator->graph);
1973 }
1974
1975 void bt_self_component_port_input_message_iterator_get_ref(
1976                 const struct bt_self_component_port_input_message_iterator *iterator)
1977 {
1978         bt_object_get_ref(iterator);
1979 }
1980
1981 void bt_self_component_port_input_message_iterator_put_ref(
1982                 const struct bt_self_component_port_input_message_iterator *iterator)
1983 {
1984         bt_object_put_ref(iterator);
1985 }