lib: make it mandatory to have seek_X if can_seek_X is defined
[babeltrace.git] / src / lib / graph / iterator.c
index 983f5c100ab5d1a5482742bd080739589f90128c..511a1f981ba020c18c91285ba4e139d17b806f64 100644 (file)
@@ -298,8 +298,8 @@ int create_self_component_input_port_message_iterator(
                struct bt_self_component_port_input *self_port,
                struct bt_self_component_port_input_message_iterator **message_iterator)
 {
-       typedef enum bt_component_class_message_iterator_init_method_status (*init_method_t)(
-                       void *, void *, void *);
+       typedef enum bt_component_class_message_iterator_initialize_method_status (*init_method_t)(
+                       void *, void *, void *, void *);
 
        init_method_t init_method = NULL;
        struct bt_self_component_port_input_message_iterator *iterator =
@@ -451,7 +451,7 @@ int create_self_component_input_port_message_iterator(
                        (void *) upstream_comp_cls;
 
                init_method =
-                       (init_method_t) src_comp_cls->methods.msg_iter_init;
+                       (init_method_t) src_comp_cls->methods.msg_iter_initialize;
                break;
        }
        case BT_COMPONENT_CLASS_TYPE_FILTER:
@@ -460,7 +460,7 @@ int create_self_component_input_port_message_iterator(
                        (void *) upstream_comp_cls;
 
                init_method =
-                       (init_method_t) flt_comp_cls->methods.msg_iter_init;
+                       (init_method_t) flt_comp_cls->methods.msg_iter_initialize;
                break;
        }
        default:
@@ -469,10 +469,10 @@ int create_self_component_input_port_message_iterator(
        }
 
        if (init_method) {
-               enum bt_component_class_message_iterator_init_method_status iter_status;
+               enum bt_component_class_message_iterator_initialize_method_status iter_status;
 
                BT_LIB_LOGD("Calling user's initialization method: %!+i", iterator);
-               iter_status = init_method(iterator, upstream_comp,
+               iter_status = init_method(iterator, &iterator->config, upstream_comp,
                        upstream_port);
                BT_LOGD("User method returned: status=%s",
                        bt_common_func_status_string(iter_status));
@@ -485,6 +485,8 @@ int create_self_component_input_port_message_iterator(
                        status = iter_status;
                        goto error;
                }
+
+               iterator->config.frozen = true;
        }
 
        if (downstream_msg_iter) {
@@ -561,6 +563,16 @@ void bt_self_message_iterator_set_data(
                "%!+i, user-data-addr=%p", iterator, data);
 }
 
+void bt_self_message_iterator_configuration_set_can_seek_forward(
+               bt_self_message_iterator_configuration *config,
+               bt_bool can_seek_forward)
+{
+       BT_ASSERT_PRE_NON_NULL(config, "Message iterator configuration");
+       BT_ASSERT_PRE_DEV_HOT(config, "Message iterator configuration", "");
+
+       config->can_seek_forward = can_seek_forward;
+}
+
 /*
  * Validate that the default clock snapshot in `msg` doesn't make us go back in
  * time.
@@ -989,25 +1001,46 @@ bt_self_component_port_input_message_iterator_can_seek_ns_from_origin(
                 */
                *can_seek = -1;
 
+               BT_LIB_LOGD("Calling user's \"can seek nanoseconds from origin\" method: %!+i",
+                       iterator);
+
                status = (int) iterator->methods.can_seek_ns_from_origin(iterator,
                        ns_from_origin, can_seek);
 
-               BT_ASSERT_POST(
-                       status != BT_FUNC_STATUS_OK ||
-                               *can_seek == BT_TRUE ||
-                               *can_seek == BT_FALSE,
+               if (status != BT_FUNC_STATUS_OK) {
+                       BT_LIB_LOGW_APPEND_CAUSE(
+                               "Component input port message iterator's \"can seek nanoseconds from origin\" method failed: "
+                               "%![iter-]+i, status=%s",
+                               iterator, bt_common_func_status_string(status));
+                       goto end;
+               }
+
+               BT_ASSERT_POST(*can_seek == BT_TRUE || *can_seek == BT_FALSE,
                        "Unexpected boolean value returned from user's \"can seek ns from origin\" method: val=%d, %![iter-]+i",
                        *can_seek, iterator);
 
-               goto end;
+               BT_LIB_LOGD(
+                       "User's \"can seek nanoseconds from origin\" returned successfully: "
+                       "%![iter-]+i, can-seek=%d",
+                       iterator, *can_seek);
+
+               if (*can_seek) {
+                       goto end;
+               }
        }
 
        /*
-        * Automatic seeking fall back: if we can seek to the beginning,
-        * then we can automatically seek to any message.
+        * Automatic seeking fall back: if we can seek to the beginning and the
+        * iterator supports forward seeking then we can automatically seek to
+        * any timestamp.
         */
        status = (int) bt_self_component_port_input_message_iterator_can_seek_beginning(
                iterator, can_seek);
+       if (status != BT_FUNC_STATUS_OK) {
+               goto end;
+       }
+
+       *can_seek = *can_seek && iterator->config.can_seek_forward;
 
 end:
        return status;
@@ -1150,6 +1183,15 @@ bt_self_component_port_input_message_iterator_seek_beginning(
        return status;
 }
 
+bt_bool
+bt_self_component_port_input_message_iterator_can_seek_forward(
+               bt_self_component_port_input_message_iterator *iterator)
+{
+       BT_ASSERT_PRE_NON_NULL(iterator, "Message iterator");
+
+       return iterator->config.can_seek_forward;
+}
+
 /*
  * Structure used to record the state of a given stream during the fast-forward
  * phase of an auto-seek.
@@ -1665,6 +1707,7 @@ bt_self_component_port_input_message_iterator_seek_ns_from_origin(
 {
        int status;
        GHashTable *stream_states = NULL;
+       bt_bool can_seek_by_itself;
 
        BT_ASSERT_PRE_NON_NULL(iterator, "Message iterator");
        BT_ASSERT_PRE_ITER_HAS_STATE_TO_SEEK(iterator);
@@ -1673,6 +1716,7 @@ bt_self_component_port_input_message_iterator_seek_ns_from_origin(
                        BT_GRAPH_CONFIGURATION_STATE_CONFIGURING,
                "Graph is not configured: %!+g",
                bt_component_borrow_graph(iterator->upstream_component));
+       /* The iterator must be able to seek ns from origin one way or another. */
        BT_ASSERT_PRE(
                message_iterator_can_seek_ns_from_origin(iterator, ns_from_origin),
                "Message iterator cannot seek nanoseconds from origin: %!+i, "
@@ -1686,8 +1730,25 @@ bt_self_component_port_input_message_iterator_seek_ns_from_origin(
         */
        reset_iterator_expectations(iterator);
 
-       if (iterator->methods.seek_ns_from_origin) {
+       /* Check if the iterator can seek by itself.  If not we'll use autoseek. */
+       if (iterator->methods.can_seek_ns_from_origin) {
+               bt_component_class_message_iterator_can_seek_ns_from_origin_method_status
+                       can_seek_status;
+
+               can_seek_status =
+                       iterator->methods.can_seek_ns_from_origin(
+                               iterator, ns_from_origin, &can_seek_by_itself);
+               if (can_seek_status != BT_FUNC_STATUS_OK) {
+                       status = can_seek_status;
+                       goto end;
+               }
+       } else {
+               can_seek_by_itself = false;
+       }
+
+       if (can_seek_by_itself) {
                /* The iterator knows how to seek to a particular time, let it handle this. */
+               BT_ASSERT(iterator->methods.seek_ns_from_origin);
                BT_LIB_LOGD("Calling user's \"seek nanoseconds from origin\" method: "
                        "%![iter-]+i, ns=%" PRId64, iterator, ns_from_origin);
                status = iterator->methods.seek_ns_from_origin(iterator,
@@ -1708,8 +1769,9 @@ bt_self_component_port_input_message_iterator_seek_ns_from_origin(
                }
        } else {
                /*
-                * The iterator doesn't know how to seek to a particular time.  We will
-                * seek to the beginning and fast forward to the right place.
+                * The iterator doesn't know how to seek by itself to a
+                * particular time.  We will seek to the beginning and fast
+                * forward to the right place.
                 */
                enum bt_component_class_message_iterator_can_seek_beginning_method_status
                        can_seek_status;
This page took 0.026602 seconds and 4 git commands to generate.