lib: make can_seek_ns_from_origin logic use `can_seek_forward` property of iterator
[babeltrace.git] / src / plugins / utils / muxer / muxer.c
index 328d3a28334a46737837a9a18ed3ea78bdbf0918..3e4d42057b1d49e0a00814cdd6f063f9f11da634 100644 (file)
@@ -40,8 +40,6 @@
 
 #include "muxer.h"
 
-#define ASSUME_ABSOLUTE_CLOCK_CLASSES_PARAM_NAME       "assume-absolute-clock-classes"
-
 struct muxer_comp {
        /* Weak refs */
        bt_self_component_filter *self_comp_flt;
@@ -50,7 +48,6 @@ struct muxer_comp {
        unsigned int next_port_num;
        size_t available_input_ports;
        bool initializing_muxer_msg_iter;
-       bool assume_absolute_clock_classes;
        bt_logging_level log_level;
 };
 
@@ -249,96 +246,14 @@ void destroy_muxer_comp(struct muxer_comp *muxer_comp)
        g_free(muxer_comp);
 }
 
-static
-bt_value *get_default_params(struct muxer_comp *muxer_comp)
-{
-       bt_value *params;
-       int ret;
-
-       params = bt_value_map_create();
-       if (!params) {
-               BT_COMP_LOGE_STR("Cannot create a map value object.");
-               goto error;
-       }
-
-       ret = bt_value_map_insert_bool_entry(params,
-               ASSUME_ABSOLUTE_CLOCK_CLASSES_PARAM_NAME, false);
-       if (ret) {
-               BT_COMP_LOGE_STR("Cannot add boolean value to map value object.");
-               goto error;
-       }
-
-       goto end;
-
-error:
-       BT_VALUE_PUT_REF_AND_RESET(params);
-
-end:
-       return params;
-}
-
-static
-int configure_muxer_comp(struct muxer_comp *muxer_comp,
-               const bt_value *params)
-{
-       bt_value *default_params = NULL;
-       bt_value *real_params = NULL;
-       const bt_value *assume_absolute_clock_classes = NULL;
-       int ret = 0;
-       bt_bool bool_val;
-
-       default_params = get_default_params(muxer_comp);
-       if (!default_params) {
-               BT_COMP_LOGE("Cannot get default parameters: "
-                       "muxer-comp-addr=%p", muxer_comp);
-               goto error;
-       }
-
-       ret = bt_value_map_extend(default_params, params, &real_params);
-       if (ret) {
-               BT_COMP_LOGE("Cannot extend default parameters map value: "
-                       "muxer-comp-addr=%p, def-params-addr=%p, "
-                       "params-addr=%p", muxer_comp, default_params,
-                       params);
-               goto error;
-       }
-
-       assume_absolute_clock_classes = bt_value_map_borrow_entry_value(real_params,
-                                                                       ASSUME_ABSOLUTE_CLOCK_CLASSES_PARAM_NAME);
-       if (assume_absolute_clock_classes &&
-                       !bt_value_is_bool(assume_absolute_clock_classes)) {
-               BT_COMP_LOGE("Expecting a boolean value for the `%s` parameter: "
-                       "muxer-comp-addr=%p, value-type=%s",
-                       ASSUME_ABSOLUTE_CLOCK_CLASSES_PARAM_NAME, muxer_comp,
-                       bt_common_value_type_string(
-                               bt_value_get_type(assume_absolute_clock_classes)));
-               goto error;
-       }
-
-       bool_val = bt_value_bool_get(assume_absolute_clock_classes);
-       muxer_comp->assume_absolute_clock_classes = (bool) bool_val;
-       BT_COMP_LOGI("Configured muxer component: muxer-comp-addr=%p, "
-               "assume-absolute-clock-classes=%d",
-               muxer_comp, muxer_comp->assume_absolute_clock_classes);
-       goto end;
-
-error:
-       ret = -1;
-
-end:
-       bt_value_put_ref(default_params);
-       bt_value_put_ref(real_params);
-       return ret;
-}
-
 BT_HIDDEN
-bt_component_class_init_method_status muxer_init(
+bt_component_class_initialize_method_status muxer_init(
                bt_self_component_filter *self_comp_flt,
+               bt_self_component_filter_configuration *config,
                const bt_value *params, void *init_data)
 {
-       int ret;
-       bt_component_class_init_method_status status =
-               BT_COMPONENT_CLASS_INIT_METHOD_STATUS_OK;
+       bt_component_class_initialize_method_status status =
+               BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_OK;
        bt_self_component_add_port_status add_port_status;
        bt_self_component *self_comp =
                bt_self_component_filter_as_self_component(self_comp_flt);
@@ -359,13 +274,6 @@ bt_component_class_init_method_status muxer_init(
        muxer_comp->log_level = log_level;
        muxer_comp->self_comp = self_comp;
        muxer_comp->self_comp_flt = self_comp_flt;
-       ret = configure_muxer_comp(muxer_comp, params);
-       if (ret) {
-               BT_COMP_LOGE("Cannot configure muxer component: "
-                       "muxer-comp-addr=%p, params-addr=%p",
-                       muxer_comp, params);
-               goto error;
-       }
 
        bt_self_component_set_data(self_comp, muxer_comp);
        add_port_status = add_available_input_port(self_comp_flt);
@@ -376,9 +284,9 @@ bt_component_class_init_method_status muxer_init(
                        bt_common_func_status_string(add_port_status));
                if (add_port_status ==
                                BT_SELF_COMPONENT_ADD_PORT_STATUS_MEMORY_ERROR) {
-                       status = BT_COMPONENT_CLASS_INIT_METHOD_STATUS_MEMORY_ERROR;
+                       status = BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_MEMORY_ERROR;
                } else {
-                       status = BT_COMPONENT_CLASS_INIT_METHOD_STATUS_ERROR;
+                       status = BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_ERROR;
                }
 
                goto error;
@@ -392,9 +300,9 @@ bt_component_class_init_method_status muxer_init(
                        bt_common_func_status_string(add_port_status));
                if (add_port_status ==
                                BT_SELF_COMPONENT_ADD_PORT_STATUS_MEMORY_ERROR) {
-                       status = BT_COMPONENT_CLASS_INIT_METHOD_STATUS_MEMORY_ERROR;
+                       status = BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_MEMORY_ERROR;
                } else {
-                       status = BT_COMPONENT_CLASS_INIT_METHOD_STATUS_ERROR;
+                       status = BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_ERROR;
                }
 
                goto error;
@@ -410,8 +318,8 @@ error:
        destroy_muxer_comp(muxer_comp);
        bt_self_component_set_data(self_comp, NULL);
 
-       if (status == BT_COMPONENT_CLASS_INIT_METHOD_STATUS_OK) {
-               status = BT_COMPONENT_CLASS_INIT_METHOD_STATUS_ERROR;
+       if (status == BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_OK) {
+               status = BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_ERROR;
        }
 
 end:
@@ -707,11 +615,9 @@ int validate_clock_class(struct muxer_msg_iter *muxer_msg_iter,
        if (muxer_msg_iter->clock_class_expectation ==
                        MUXER_MSG_ITER_CLOCK_CLASS_EXPECTATION_ANY) {
                /*
-                * This is the first clock class that this muxer
-                * message iterator encounters. Its properties
-                * determine what to expect for the whole lifetime of
-                * the iterator without a true
-                * `assume-absolute-clock-classes` parameter.
+                * This is the first clock class that this muxer message
+                * iterator encounters. Its properties determine what to expect
+                * for the whole lifetime of the iterator.
                 */
                if (bt_clock_class_origin_is_unix_epoch(clock_class)) {
                        /* Expect absolute clock classes */
@@ -737,76 +643,74 @@ int validate_clock_class(struct muxer_msg_iter *muxer_msg_iter,
                }
        }
 
-       if (!muxer_comp->assume_absolute_clock_classes) {
-               switch (muxer_msg_iter->clock_class_expectation) {
-               case MUXER_MSG_ITER_CLOCK_CLASS_EXPECTATION_ABSOLUTE:
-                       if (!bt_clock_class_origin_is_unix_epoch(clock_class)) {
-                               BT_COMP_LOGE("Expecting an absolute clock class, "
-                                       "but got a non-absolute one: "
-                                       "clock-class-addr=%p, clock-class-name=\"%s\"",
-                                       clock_class, cc_name);
-                               goto error;
-                       }
-                       break;
-               case MUXER_MSG_ITER_CLOCK_CLASS_EXPECTATION_NOT_ABS_NO_UUID:
-                       if (bt_clock_class_origin_is_unix_epoch(clock_class)) {
-                               BT_COMP_LOGE("Expecting a non-absolute clock class with no UUID, "
-                                       "but got an absolute one: "
-                                       "clock-class-addr=%p, clock-class-name=\"%s\"",
-                                       clock_class, cc_name);
-                               goto error;
-                       }
-
-                       if (cc_uuid) {
-                               BT_COMP_LOGE("Expecting a non-absolute clock class with no UUID, "
-                                       "but got one with a UUID: "
-                                       "clock-class-addr=%p, clock-class-name=\"%s\", "
-                                       "uuid=\"" BT_UUID_FMT "\"",
-                                       clock_class, cc_name, BT_UUID_FMT_VALUES(cc_uuid));
-                               goto error;
-                       }
-                       break;
-               case MUXER_MSG_ITER_CLOCK_CLASS_EXPECTATION_NOT_ABS_SPEC_UUID:
-                       if (bt_clock_class_origin_is_unix_epoch(clock_class)) {
-                               BT_COMP_LOGE("Expecting a non-absolute clock class with a specific UUID, "
-                                       "but got an absolute one: "
-                                       "clock-class-addr=%p, clock-class-name=\"%s\"",
-                                       clock_class, cc_name);
-                               goto error;
-                       }
+       switch (muxer_msg_iter->clock_class_expectation) {
+       case MUXER_MSG_ITER_CLOCK_CLASS_EXPECTATION_ABSOLUTE:
+               if (!bt_clock_class_origin_is_unix_epoch(clock_class)) {
+                       BT_COMP_LOGE("Expecting an absolute clock class, "
+                               "but got a non-absolute one: "
+                               "clock-class-addr=%p, clock-class-name=\"%s\"",
+                               clock_class, cc_name);
+                       goto error;
+               }
+               break;
+       case MUXER_MSG_ITER_CLOCK_CLASS_EXPECTATION_NOT_ABS_NO_UUID:
+               if (bt_clock_class_origin_is_unix_epoch(clock_class)) {
+                       BT_COMP_LOGE("Expecting a non-absolute clock class with no UUID, "
+                               "but got an absolute one: "
+                               "clock-class-addr=%p, clock-class-name=\"%s\"",
+                               clock_class, cc_name);
+                       goto error;
+               }
 
-                       if (!cc_uuid) {
-                               BT_COMP_LOGE("Expecting a non-absolute clock class with a specific UUID, "
-                                       "but got one with no UUID: "
-                                       "clock-class-addr=%p, clock-class-name=\"%s\"",
-                                       clock_class, cc_name);
-                               goto error;
-                       }
+               if (cc_uuid) {
+                       BT_COMP_LOGE("Expecting a non-absolute clock class with no UUID, "
+                               "but got one with a UUID: "
+                               "clock-class-addr=%p, clock-class-name=\"%s\", "
+                               "uuid=\"" BT_UUID_FMT "\"",
+                               clock_class, cc_name, BT_UUID_FMT_VALUES(cc_uuid));
+                       goto error;
+               }
+               break;
+       case MUXER_MSG_ITER_CLOCK_CLASS_EXPECTATION_NOT_ABS_SPEC_UUID:
+               if (bt_clock_class_origin_is_unix_epoch(clock_class)) {
+                       BT_COMP_LOGE("Expecting a non-absolute clock class with a specific UUID, "
+                               "but got an absolute one: "
+                               "clock-class-addr=%p, clock-class-name=\"%s\"",
+                               clock_class, cc_name);
+                       goto error;
+               }
 
-                       if (bt_uuid_compare(muxer_msg_iter->expected_clock_class_uuid, cc_uuid) != 0) {
-                               BT_COMP_LOGE("Expecting a non-absolute clock class with a specific UUID, "
-                                       "but got one with different UUID: "
-                                       "clock-class-addr=%p, clock-class-name=\"%s\", "
-                                       "expected-uuid=\"" BT_UUID_FMT "\", "
-                                       "uuid=\"" BT_UUID_FMT "\"",
-                                       clock_class, cc_name,
-                                       BT_UUID_FMT_VALUES(muxer_msg_iter->expected_clock_class_uuid),
-                                       BT_UUID_FMT_VALUES(cc_uuid));
-                               goto error;
-                       }
-                       break;
-               case MUXER_MSG_ITER_CLOCK_CLASS_EXPECTATION_NONE:
-                       BT_COMP_LOGE("Expecting no clock class, but got one: "
+               if (!cc_uuid) {
+                       BT_COMP_LOGE("Expecting a non-absolute clock class with a specific UUID, "
+                               "but got one with no UUID: "
                                "clock-class-addr=%p, clock-class-name=\"%s\"",
                                clock_class, cc_name);
                        goto error;
-               default:
-                       /* Unexpected */
-                       BT_COMP_LOGF("Unexpected clock class expectation: "
-                               "expectation-code=%d",
-                               muxer_msg_iter->clock_class_expectation);
-                       abort();
                }
+
+               if (bt_uuid_compare(muxer_msg_iter->expected_clock_class_uuid, cc_uuid) != 0) {
+                       BT_COMP_LOGE("Expecting a non-absolute clock class with a specific UUID, "
+                               "but got one with different UUID: "
+                               "clock-class-addr=%p, clock-class-name=\"%s\", "
+                               "expected-uuid=\"" BT_UUID_FMT "\", "
+                               "uuid=\"" BT_UUID_FMT "\"",
+                               clock_class, cc_name,
+                               BT_UUID_FMT_VALUES(muxer_msg_iter->expected_clock_class_uuid),
+                               BT_UUID_FMT_VALUES(cc_uuid));
+                       goto error;
+               }
+               break;
+       case MUXER_MSG_ITER_CLOCK_CLASS_EXPECTATION_NONE:
+               BT_COMP_LOGE("Expecting no clock class, but got one: "
+                       "clock-class-addr=%p, clock-class-name=\"%s\"",
+                       clock_class, cc_name);
+               goto error;
+       default:
+               /* Unexpected */
+               BT_COMP_LOGF("Unexpected clock class expectation: "
+                       "expectation-code=%d",
+                       muxer_msg_iter->clock_class_expectation);
+               abort();
        }
 
        goto end;
@@ -1242,13 +1146,15 @@ void destroy_muxer_msg_iter(struct muxer_msg_iter *muxer_msg_iter)
 }
 
 static
-bt_component_class_message_iterator_init_method_status
+bt_component_class_message_iterator_initialize_method_status
 muxer_msg_iter_init_upstream_iterators(struct muxer_comp *muxer_comp,
-               struct muxer_msg_iter *muxer_msg_iter)
+               struct muxer_msg_iter *muxer_msg_iter,
+               struct bt_self_message_iterator_configuration *config)
 {
        int64_t count;
        int64_t i;
-       bt_component_class_message_iterator_init_method_status status;
+       bt_component_class_message_iterator_initialize_method_status status;
+       bool can_seek_forward = true;
 
        count = bt_component_filter_get_input_port_count(
                bt_self_component_filter_as_component_filter(
@@ -1257,7 +1163,7 @@ muxer_msg_iter_init_upstream_iterators(struct muxer_comp *muxer_comp,
                BT_COMP_LOGD("No input port to initialize for muxer component's message iterator: "
                        "muxer-comp-addr=%p, muxer-msg-iter-addr=%p",
                        muxer_comp, muxer_msg_iter);
-               status = BT_COMPONENT_CLASS_MESSAGE_ITERATOR_INIT_METHOD_STATUS_OK;
+               status = BT_COMPONENT_CLASS_MESSAGE_ITERATOR_INITIALIZE_METHOD_STATUS_OK;
                goto end;
        }
 
@@ -1295,27 +1201,39 @@ muxer_msg_iter_init_upstream_iterators(struct muxer_comp *muxer_comp,
                bt_self_component_port_input_message_iterator_put_ref(
                        upstream_msg_iter);
                if (int_status) {
-                       status = BT_COMPONENT_CLASS_MESSAGE_ITERATOR_INIT_METHOD_STATUS_ERROR;
+                       status = BT_COMPONENT_CLASS_MESSAGE_ITERATOR_INITIALIZE_METHOD_STATUS_ERROR;
                        /* muxer_msg_iter_add_upstream_msg_iter() logs errors */
                        goto end;
                }
+
+               can_seek_forward = can_seek_forward &&
+                       bt_self_component_port_input_message_iterator_can_seek_forward(
+                               upstream_msg_iter);
        }
 
-       status = BT_COMPONENT_CLASS_MESSAGE_ITERATOR_INIT_METHOD_STATUS_OK;
+       /*
+        * This iterator can seek forward if all of its iterators can seek
+        * forward.
+        */
+       bt_self_message_iterator_configuration_set_can_seek_forward(
+               config, can_seek_forward);
+
+       status = BT_COMPONENT_CLASS_MESSAGE_ITERATOR_INITIALIZE_METHOD_STATUS_OK;
 
 end:
        return status;
 }
 
 BT_HIDDEN
-bt_component_class_message_iterator_init_method_status muxer_msg_iter_init(
+bt_component_class_message_iterator_initialize_method_status muxer_msg_iter_init(
                bt_self_message_iterator *self_msg_iter,
+               bt_self_message_iterator_configuration *config,
                bt_self_component_filter *self_comp,
                bt_self_component_port_output *port)
 {
        struct muxer_comp *muxer_comp = NULL;
        struct muxer_msg_iter *muxer_msg_iter = NULL;
-       bt_component_class_message_iterator_init_method_status status;
+       bt_component_class_message_iterator_initialize_method_status status;
 
        muxer_comp = bt_self_component_get_data(
                bt_self_component_filter_as_self_component(self_comp));
@@ -1333,7 +1251,7 @@ bt_component_class_message_iterator_init_method_status muxer_msg_iter_init(
                BT_COMP_LOGE("Recursive initialization of muxer component's message iterator: "
                        "comp-addr=%p, muxer-comp-addr=%p, msg-iter-addr=%p",
                        self_comp, muxer_comp, self_msg_iter);
-               status = BT_COMPONENT_CLASS_MESSAGE_ITERATOR_INIT_METHOD_STATUS_ERROR;
+               status = BT_COMPONENT_CLASS_MESSAGE_ITERATOR_INITIALIZE_METHOD_STATUS_ERROR;
                goto error;
        }
 
@@ -1341,7 +1259,7 @@ bt_component_class_message_iterator_init_method_status muxer_msg_iter_init(
        muxer_msg_iter = g_new0(struct muxer_msg_iter, 1);
        if (!muxer_msg_iter) {
                BT_COMP_LOGE_STR("Failed to allocate one muxer component's message iterator.");
-               status = BT_COMPONENT_CLASS_MESSAGE_ITERATOR_INIT_METHOD_STATUS_MEMORY_ERROR;
+               status = BT_COMPONENT_CLASS_MESSAGE_ITERATOR_INITIALIZE_METHOD_STATUS_MEMORY_ERROR;
                goto error;
        }
 
@@ -1353,7 +1271,7 @@ bt_component_class_message_iterator_init_method_status muxer_msg_iter_init(
                        (GDestroyNotify) destroy_muxer_upstream_msg_iter);
        if (!muxer_msg_iter->active_muxer_upstream_msg_iters) {
                BT_COMP_LOGE_STR("Failed to allocate a GPtrArray.");
-               status = BT_COMPONENT_CLASS_MESSAGE_ITERATOR_INIT_METHOD_STATUS_MEMORY_ERROR;
+               status = BT_COMPONENT_CLASS_MESSAGE_ITERATOR_INITIALIZE_METHOD_STATUS_MEMORY_ERROR;
                goto error;
        }
 
@@ -1362,12 +1280,12 @@ bt_component_class_message_iterator_init_method_status muxer_msg_iter_init(
                        (GDestroyNotify) destroy_muxer_upstream_msg_iter);
        if (!muxer_msg_iter->ended_muxer_upstream_msg_iters) {
                BT_COMP_LOGE_STR("Failed to allocate a GPtrArray.");
-               status = BT_COMPONENT_CLASS_MESSAGE_ITERATOR_INIT_METHOD_STATUS_MEMORY_ERROR;
+               status = BT_COMPONENT_CLASS_MESSAGE_ITERATOR_INITIALIZE_METHOD_STATUS_MEMORY_ERROR;
                goto error;
        }
 
        status = muxer_msg_iter_init_upstream_iterators(muxer_comp,
-               muxer_msg_iter);
+               muxer_msg_iter, config);
        if (status) {
                BT_COMP_LOGE("Cannot initialize connected input ports for muxer component's message iterator: "
                        "comp-addr=%p, muxer-comp-addr=%p, "
@@ -1488,49 +1406,58 @@ end:
 }
 
 static inline
-bt_bool muxer_upstream_msg_iters_can_all_seek_beginning(
-               GPtrArray *muxer_upstream_msg_iters)
+bt_component_class_message_iterator_can_seek_beginning_method_status
+muxer_upstream_msg_iters_can_all_seek_beginning(
+               GPtrArray *muxer_upstream_msg_iters, bt_bool *can_seek)
 {
+       bt_component_class_message_iterator_can_seek_beginning_method_status status =
+               BT_COMPONENT_CLASS_MESSAGE_ITERATOR_CAN_SEEK_BEGINNING_METHOD_STATUS_OK;
        uint64_t i;
-       bt_bool ret = BT_TRUE;
 
        for (i = 0; i < muxer_upstream_msg_iters->len; i++) {
                struct muxer_upstream_msg_iter *upstream_msg_iter =
                        muxer_upstream_msg_iters->pdata[i];
+               status = (int) bt_self_component_port_input_message_iterator_can_seek_beginning(
+                       upstream_msg_iter->msg_iter, can_seek);
+               if (status != BT_COMPONENT_CLASS_MESSAGE_ITERATOR_CAN_SEEK_BEGINNING_METHOD_STATUS_OK) {
+                       goto end;
+               }
 
-               if (!bt_self_component_port_input_message_iterator_can_seek_beginning(
-                               upstream_msg_iter->msg_iter)) {
-                       ret = BT_FALSE;
+               if (!*can_seek) {
                        goto end;
                }
        }
 
+       *can_seek = BT_TRUE;
+
 end:
-       return ret;
+       return status;
 }
 
 BT_HIDDEN
-bt_bool muxer_msg_iter_can_seek_beginning(
-               bt_self_message_iterator *self_msg_iter)
+bt_component_class_message_iterator_can_seek_beginning_method_status
+muxer_msg_iter_can_seek_beginning(
+               bt_self_message_iterator *self_msg_iter, bt_bool *can_seek)
 {
        struct muxer_msg_iter *muxer_msg_iter =
                bt_self_message_iterator_get_data(self_msg_iter);
-       bt_bool ret = BT_TRUE;
+       bt_component_class_message_iterator_can_seek_beginning_method_status status;
 
-       if (!muxer_upstream_msg_iters_can_all_seek_beginning(
-                       muxer_msg_iter->active_muxer_upstream_msg_iters)) {
-               ret = BT_FALSE;
+       status = muxer_upstream_msg_iters_can_all_seek_beginning(
+               muxer_msg_iter->active_muxer_upstream_msg_iters, can_seek);
+       if (status != BT_COMPONENT_CLASS_MESSAGE_ITERATOR_CAN_SEEK_BEGINNING_METHOD_STATUS_OK) {
                goto end;
        }
 
-       if (!muxer_upstream_msg_iters_can_all_seek_beginning(
-                       muxer_msg_iter->ended_muxer_upstream_msg_iters)) {
-               ret = BT_FALSE;
+       if (!*can_seek) {
                goto end;
        }
 
+       status = muxer_upstream_msg_iters_can_all_seek_beginning(
+               muxer_msg_iter->ended_muxer_upstream_msg_iters, can_seek);
+
 end:
-       return ret;
+       return status;
 }
 
 BT_HIDDEN
This page took 0.030782 seconds and 4 git commands to generate.