#include <string.h>
#include "plugins/common/muxing/muxing.h"
+#include "plugins/common/param-validation/param-validation.h"
#include "muxer.h"
* MUXER_MSG_ITER_CLOCK_CLASS_EXPECTATION_NOT_ABS_SPEC_UUID.
*/
bt_uuid_t expected_clock_class_uuid;
+
+ /*
+ * Saved error. If we hit an error in the _next method, but have some
+ * messages ready to return, we save the error here and return it on
+ * the next _next call.
+ */
+ bt_component_class_message_iterator_next_method_status next_saved_status;
+ const struct bt_error *next_saved_error;
};
static
g_free(muxer_comp);
}
+static
+struct bt_param_validation_map_value_entry_descr muxer_params[] = {
+ BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_END
+};
+
BT_HIDDEN
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)
{
- bt_component_class_initialize_method_status status =
- BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_OK;
+ bt_component_class_initialize_method_status status;
bt_self_component_add_port_status add_port_status;
bt_self_component *self_comp =
bt_self_component_filter_as_self_component(self_comp_flt);
struct muxer_comp *muxer_comp = g_new0(struct muxer_comp, 1);
bt_logging_level log_level = bt_component_get_logging_level(
bt_self_component_as_component(self_comp));
+ enum bt_param_validation_status validation_status;
+ gchar *validate_error = NULL;
BT_COMP_LOG_CUR_LVL(BT_LOG_INFO, log_level, self_comp,
"Initializing muxer component: "
if (!muxer_comp) {
BT_COMP_LOG_CUR_LVL(BT_LOG_ERROR, log_level, self_comp,
"Failed to allocate one muxer component.");
+ status = BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_MEMORY_ERROR;
goto error;
}
muxer_comp->self_comp = self_comp;
muxer_comp->self_comp_flt = self_comp_flt;
+ validation_status = bt_param_validation_validate(params,
+ muxer_params, &validate_error);
+ if (validation_status == BT_PARAM_VALIDATION_STATUS_MEMORY_ERROR) {
+ status = BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_MEMORY_ERROR;
+ goto error;
+ } else if (validation_status == BT_PARAM_VALIDATION_STATUS_VALIDATION_ERROR) {
+ status = BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_ERROR;
+ BT_COMP_LOGE_APPEND_CAUSE(self_comp, "%s", validate_error);
+ goto error;
+ }
+
bt_self_component_set_data(self_comp, muxer_comp);
add_port_status = add_available_input_port(self_comp_flt);
if (add_port_status != BT_SELF_COMPONENT_ADD_PORT_STATUS_OK) {
"muxer-comp-addr=%p, status=%s",
muxer_comp,
bt_common_func_status_string(add_port_status));
- if (add_port_status ==
- BT_SELF_COMPONENT_ADD_PORT_STATUS_MEMORY_ERROR) {
- status = BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_MEMORY_ERROR;
- } else {
- status = BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_ERROR;
- }
-
+ status = (int) add_port_status;
goto error;
}
"muxer-comp-addr=%p, status=%s",
muxer_comp,
bt_common_func_status_string(add_port_status));
- if (add_port_status ==
- BT_SELF_COMPONENT_ADD_PORT_STATUS_MEMORY_ERROR) {
- status = BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_MEMORY_ERROR;
- } else {
- status = BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_ERROR;
- }
-
+ status = (int) add_port_status;
goto error;
}
"comp-addr=%p, params-addr=%p, muxer-comp-addr=%p",
self_comp, params, muxer_comp);
+ status = BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_OK;
goto end;
error:
destroy_muxer_comp(muxer_comp);
bt_self_component_set_data(self_comp, NULL);
- if (status == BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_OK) {
- status = BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_ERROR;
- }
-
end:
+ g_free(validate_error);
return status;
}
struct muxer_upstream_msg_iter *muxer_upstream_msg_iter,
bool *is_ended)
{
- struct muxer_comp *muxer_comp =
- muxer_upstream_msg_iter->muxer_comp;
+ struct muxer_comp *muxer_comp = muxer_upstream_msg_iter->muxer_comp;
bt_component_class_message_iterator_next_method_status status;
bt_message_iterator_next_status input_port_iter_status;
bt_message_array_const msgs;
* valid: it must be considered for muxing operations.
*/
BT_COMP_LOGD_STR("Validated upstream message iterator wrapper.");
- BT_ASSERT(count > 0);
+ BT_ASSERT_DBG(count > 0);
/* Move messages to our queue */
for (i = 0; i < count; i++) {
*is_ended = true;
status = BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK;
break;
+ case BT_MESSAGE_ITERATOR_NEXT_STATUS_ERROR:
+ case BT_MESSAGE_ITERATOR_NEXT_STATUS_MEMORY_ERROR:
+ /* Error status code */
+ BT_COMP_LOGE_APPEND_CAUSE(muxer_comp->self_comp,
+ "Upstream iterator's next method returned an error: status=%s",
+ bt_common_func_status_string(input_port_iter_status));
+ status = (int) input_port_iter_status;
+ break;
default:
- /* Error or unsupported status code */
- BT_COMP_LOGE("Error or unsupported status code: "
- "status-code=%d", input_port_iter_status);
+ /* Unsupported status code */
+ BT_COMP_LOGE_APPEND_CAUSE(muxer_comp->self_comp,
+ "Unsupported status code: status=%s",
+ bt_common_func_status_string(input_port_iter_status));
status = BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_ERROR;
break;
}
const bt_stream_class *stream_class = NULL;
bt_message_type msg_type;
- BT_ASSERT(msg);
- BT_ASSERT(ts_ns);
+ BT_ASSERT_DBG(msg);
+ BT_ASSERT_DBG(ts_ns);
BT_COMP_LOGD("Getting message's timestamp: "
"muxer-msg-iter-addr=%p, msg-addr=%p, "
"last-returned-ts=%" PRId64,
switch (msg_type) {
case BT_MESSAGE_TYPE_EVENT:
- BT_ASSERT(bt_message_event_borrow_stream_class_default_clock_class_const(
+ BT_ASSERT_DBG(bt_message_event_borrow_stream_class_default_clock_class_const(
msg));
clock_snapshot = bt_message_event_borrow_default_clock_snapshot_const(
msg);
const uint8_t *cc_uuid;
const char *cc_name;
- BT_ASSERT(clock_class);
+ BT_ASSERT_DBG(clock_class);
cc_uuid = bt_clock_class_get_uuid(clock_class);
cc_name = bt_clock_class_get_name(clock_class);
BT_COMP_LOGF("Unexpected clock class expectation: "
"expectation-code=%d",
muxer_msg_iter->clock_class_expectation);
- abort();
+ bt_common_abort();
}
goto end;
bt_component_class_message_iterator_next_method_status status =
BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK;
- BT_ASSERT(muxer_comp);
- BT_ASSERT(muxer_msg_iter);
- BT_ASSERT(muxer_upstream_msg_iter);
+ BT_ASSERT_DBG(muxer_comp);
+ BT_ASSERT_DBG(muxer_msg_iter);
+ BT_ASSERT_DBG(muxer_upstream_msg_iter);
*muxer_upstream_msg_iter = NULL;
for (i = 0; i < muxer_msg_iter->active_muxer_upstream_msg_iters->len;
continue;
}
- BT_ASSERT(cur_muxer_upstream_msg_iter->msgs->length > 0);
+ BT_ASSERT_DBG(cur_muxer_upstream_msg_iter->msgs->length > 0);
msg = g_queue_peek_head(cur_muxer_upstream_msg_iter->msgs);
- BT_ASSERT(msg);
+ BT_ASSERT_DBG(msg);
if (G_UNLIKELY(bt_message_get_type(msg) ==
BT_MESSAGE_TYPE_STREAM_BEGINNING)) {
struct muxer_upstream_msg_iter *muxer_upstream_msg_iter,
bool *is_ended)
{
- struct muxer_comp *muxer_comp =
- muxer_upstream_msg_iter->muxer_comp;
- bt_component_class_message_iterator_next_method_status status =
- BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK;
+ struct muxer_comp *muxer_comp = muxer_upstream_msg_iter->muxer_comp;
+ bt_component_class_message_iterator_next_method_status status;
BT_COMP_LOGD("Validating muxer's upstream message iterator wrapper: "
"muxer-upstream-msg-iter-wrap-addr=%p",
"queue-len=%u, upstream-msg-iter-addr=%p",
muxer_upstream_msg_iter->msgs->length,
muxer_upstream_msg_iter->msg_iter);
+ status = BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK;
goto end;
}
struct muxer_msg_iter *muxer_msg_iter)
{
struct muxer_comp *muxer_comp = muxer_msg_iter->muxer_comp;
- bt_component_class_message_iterator_next_method_status status =
- BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK;
+ bt_component_class_message_iterator_next_method_status status;
size_t i;
BT_COMP_LOGD("Validating muxer's upstream message iterator wrappers: "
muxer_upstream_msg_iter, &is_ended);
if (status != BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK) {
if (status < 0) {
- BT_COMP_LOGE("Cannot validate muxer's upstream message iterator wrapper: "
+ BT_COMP_LOGE_APPEND_CAUSE(muxer_comp->self_comp,
+ "Cannot validate muxer's upstream message iterator wrapper: "
"muxer-msg-iter-addr=%p, "
"muxer-upstream-msg-iter-wrap-addr=%p",
muxer_msg_iter,
}
}
+ status = BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK;
+
end:
return status;
}
&next_return_ts);
if (status < 0 || status == BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_END) {
if (status < 0) {
- BT_COMP_LOGE("Cannot find the youngest upstream message iterator wrapper: "
+ BT_COMP_LOGE_APPEND_CAUSE(muxer_comp->self_comp,
+ "Cannot find the youngest upstream message iterator wrapper: "
"status=%s",
bt_common_func_status_string(status));
} else {
}
if (next_return_ts < muxer_msg_iter->last_returned_ts_ns) {
- BT_COMP_LOGE("Youngest upstream message iterator wrapper's timestamp is less than muxer's message iterator's last returned timestamp: "
+ BT_COMP_LOGE_APPEND_CAUSE(muxer_comp->self_comp,
+ "Youngest upstream message iterator wrapper's timestamp is less than muxer's message iterator's last returned timestamp: "
"muxer-msg-iter-addr=%p, ts=%" PRId64 ", "
"last-returned-ts=%" PRId64,
muxer_msg_iter, next_return_ts,
"muxer-upstream-msg-iter-wrap-addr=%p, "
"ts=%" PRId64,
muxer_msg_iter, muxer_upstream_msg_iter, next_return_ts);
- BT_ASSERT(status == BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK);
- BT_ASSERT(muxer_upstream_msg_iter);
+ BT_ASSERT_DBG(status ==
+ BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK);
+ BT_ASSERT_DBG(muxer_upstream_msg_iter);
/*
* Consume from the queue's head: other side
* (muxer_upstream_msg_iter_next()) writes to the tail.
*/
*msg = g_queue_pop_head(muxer_upstream_msg_iter->msgs);
- BT_ASSERT(*msg);
+ BT_ASSERT_DBG(*msg);
muxer_msg_iter->last_returned_ts_ns = next_return_ts;
end:
bt_message_array_const msgs, uint64_t capacity,
uint64_t *count)
{
- bt_component_class_message_iterator_next_method_status status =
- BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK;
+ bt_component_class_message_iterator_next_method_status status;
uint64_t i = 0;
- while (i < capacity && status == BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK) {
+ if (G_UNLIKELY(muxer_msg_iter->next_saved_error)) {
+ /*
+ * Last time we were called, we hit an error but had some
+ * messages to deliver, so we stashed the error here. Return
+ * it now.
+ */
+ BT_CURRENT_THREAD_MOVE_ERROR_AND_RESET(muxer_msg_iter->next_saved_error);
+ status = muxer_msg_iter->next_saved_status;
+ goto end;
+ }
+
+ do {
status = muxer_msg_iter_do_next_one(muxer_comp,
muxer_msg_iter, &msgs[i]);
if (status == BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK) {
i++;
}
- }
+ } while (i < capacity && status == BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK);
if (i > 0) {
/*
* called, possibly without any accumulated
* message, in which case we'll return it.
*/
+ if (status < 0) {
+ /*
+ * Save this error for the next _next call. Assume that
+ * this component always appends error causes when
+ * returning an error status code, which will cause the
+ * current thread error to be non-NULL.
+ */
+ muxer_msg_iter->next_saved_error = bt_current_thread_take_error();
+ BT_ASSERT(muxer_msg_iter->next_saved_error);
+ muxer_msg_iter->next_saved_status = status;
+ }
+
*count = i;
status = BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK;
}
+end:
return status;
}
bt_self_component *self_comp = NULL;
struct muxer_comp *muxer_comp = NULL;
- BT_ASSERT(muxer_msg_iter);
+ BT_ASSERT_DBG(muxer_msg_iter);
self_comp = bt_self_message_iterator_borrow_component(
self_msg_iter);
- BT_ASSERT(self_comp);
+ BT_ASSERT_DBG(self_comp);
muxer_comp = bt_self_component_get_data(self_comp);
- BT_ASSERT(muxer_comp);
+ BT_ASSERT_DBG(muxer_comp);
BT_COMP_LOGT("Muxer component's message iterator's \"next\" method called: "
"comp-addr=%p, muxer-comp-addr=%p, muxer-msg-iter-addr=%p, "
"msg-iter-addr=%p",