[babeltrace.git] / src / plugins / utils / muxer / muxer.c

/*
 * Copyright 2017 Philippe Proulx <pproulx@efficios.com>
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

#define BT_LOG_TAG "PLUGIN/FLT.UTILS.MUXER"
#include "logging.h"

#include "common/macros.h"
#include "compat/uuid.h"
#include <babeltrace2/babeltrace.h>
#include <glib.h>
#include <stdbool.h>
#include <inttypes.h>
#include "common/assert.h"
#include "common/common.h"
#include <stdlib.h>
#include <string.h>

#include "muxer.h"

#define ASSUME_ABSOLUTE_CLOCK_CLASSES_PARAM_NAME	"assume-absolute-clock-classes"

struct muxer_comp {
	/* Weak ref */
	bt_self_component_filter *self_comp;

	unsigned int next_port_num;
	size_t available_input_ports;
	bool initializing_muxer_msg_iter;
	bool assume_absolute_clock_classes;
};

struct muxer_upstream_msg_iter {
	/* Owned by this, NULL if ended */
	bt_self_component_port_input_message_iterator *msg_iter;

	/* Contains `const bt_message *`, owned by this */
	GQueue *msgs;
};

enum muxer_msg_iter_clock_class_expectation {
	MUXER_MSG_ITER_CLOCK_CLASS_EXPECTATION_ANY = 0,
	MUXER_MSG_ITER_CLOCK_CLASS_EXPECTATION_NONE,
	MUXER_MSG_ITER_CLOCK_CLASS_EXPECTATION_ABSOLUTE,
	MUXER_MSG_ITER_CLOCK_CLASS_EXPECTATION_NOT_ABS_SPEC_UUID,
	MUXER_MSG_ITER_CLOCK_CLASS_EXPECTATION_NOT_ABS_NO_UUID,
};

struct muxer_msg_iter {
	/*
	 * Array of struct muxer_upstream_msg_iter * (owned by this).
	 *
	 * NOTE: This array is searched in linearly to find the youngest
	 * current message. Keep this until benchmarks confirm that
	 * another data structure is faster than this for our typical
	 * use cases.
	 */
	GPtrArray *active_muxer_upstream_msg_iters;

	/*
	 * Array of struct muxer_upstream_msg_iter * (owned by this).
	 *
	 * We move ended message iterators from
	 * `active_muxer_upstream_msg_iters` to this array so as to be
	 * able to restore them when seeking.
	 */
	GPtrArray *ended_muxer_upstream_msg_iters;

	/* Last time returned in a message */
	int64_t last_returned_ts_ns;

	/* Clock class expectation state */
	enum muxer_msg_iter_clock_class_expectation clock_class_expectation;

	/*
	 * Expected clock class UUID, only valid when
	 * clock_class_expectation is
	 * MUXER_MSG_ITER_CLOCK_CLASS_EXPECTATION_NOT_ABS_SPEC_UUID.
	 */
	unsigned char expected_clock_class_uuid[BABELTRACE_UUID_LEN];
};

static
void empty_message_queue(struct muxer_upstream_msg_iter *upstream_msg_iter)
{
	const bt_message *msg;

	while ((msg = g_queue_pop_head(upstream_msg_iter->msgs))) {
		bt_message_put_ref(msg);
	}
}

static
void destroy_muxer_upstream_msg_iter(
		struct muxer_upstream_msg_iter *muxer_upstream_msg_iter)
{
	if (!muxer_upstream_msg_iter) {
		return;
	}

	BT_LOGD("Destroying muxer's upstream message iterator wrapper: "
		"addr=%p, msg-iter-addr=%p, queue-len=%u",
		muxer_upstream_msg_iter,
		muxer_upstream_msg_iter->msg_iter,
		muxer_upstream_msg_iter->msgs->length);
	bt_self_component_port_input_message_iterator_put_ref(
		muxer_upstream_msg_iter->msg_iter);

	if (muxer_upstream_msg_iter->msgs) {
		empty_message_queue(muxer_upstream_msg_iter);
		g_queue_free(muxer_upstream_msg_iter->msgs);
	}

	g_free(muxer_upstream_msg_iter);
}

static
int muxer_msg_iter_add_upstream_msg_iter(struct muxer_msg_iter *muxer_msg_iter,
		bt_self_component_port_input_message_iterator *self_msg_iter)
{
	int ret = 0;
	struct muxer_upstream_msg_iter *muxer_upstream_msg_iter =
		g_new0(struct muxer_upstream_msg_iter, 1);

	if (!muxer_upstream_msg_iter) {
		BT_LOGE_STR("Failed to allocate one muxer's upstream message iterator wrapper.");
		goto error;
	}

	muxer_upstream_msg_iter->msg_iter = self_msg_iter;
	bt_self_component_port_input_message_iterator_get_ref(muxer_upstream_msg_iter->msg_iter);
	muxer_upstream_msg_iter->msgs = g_queue_new();
	if (!muxer_upstream_msg_iter->msgs) {
		BT_LOGE_STR("Failed to allocate a GQueue.");
		goto error;
	}

	g_ptr_array_add(muxer_msg_iter->active_muxer_upstream_msg_iters,
		muxer_upstream_msg_iter);
	BT_LOGD("Added muxer's upstream message iterator wrapper: "
		"addr=%p, muxer-msg-iter-addr=%p, msg-iter-addr=%p",
		muxer_upstream_msg_iter, muxer_msg_iter,
		self_msg_iter);

	goto end;

error:
	g_free(muxer_upstream_msg_iter);
	ret = -1;

end:
	return ret;
}

static
bt_self_component_status add_available_input_port(
		bt_self_component_filter *self_comp)
{
	struct muxer_comp *muxer_comp = bt_self_component_get_data(
		bt_self_component_filter_as_self_component(self_comp));
	bt_self_component_status status = BT_SELF_COMPONENT_STATUS_OK;
	GString *port_name = NULL;

	BT_ASSERT(muxer_comp);
	port_name = g_string_new("in");
	if (!port_name) {
		BT_LOGE_STR("Failed to allocate a GString.");
		status = BT_SELF_COMPONENT_STATUS_NOMEM;
		goto end;
	}

	g_string_append_printf(port_name, "%u", muxer_comp->next_port_num);
	status = bt_self_component_filter_add_input_port(
		self_comp, port_name->str, NULL, NULL);
	if (status != BT_SELF_COMPONENT_STATUS_OK) {
		BT_LOGE("Cannot add input port to muxer component: "
			"port-name=\"%s\", comp-addr=%p, status=%s",
			port_name->str, self_comp,
			bt_self_component_status_string(status));
		goto end;
	}

	muxer_comp->available_input_ports++;
	muxer_comp->next_port_num++;
	BT_LOGI("Added one input port to muxer component: "
		"port-name=\"%s\", comp-addr=%p",
		port_name->str, self_comp);

end:
	if (port_name) {
		g_string_free(port_name, TRUE);
	}

	return status;
}

static
bt_self_component_status create_output_port(
		bt_self_component_filter *self_comp)
{
	return bt_self_component_filter_add_output_port(
		self_comp, "out", NULL, NULL);
}

static
void destroy_muxer_comp(struct muxer_comp *muxer_comp)
{
	if (!muxer_comp) {
		return;
	}

	g_free(muxer_comp);
}

static
bt_value *get_default_params(void)
{
	bt_value *params;
	int ret;

	params = bt_value_map_create();
	if (!params) {
		BT_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_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();
	if (!default_params) {
		BT_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_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_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_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_self_component_status muxer_init(
		bt_self_component_filter *self_comp,
		const bt_value *params, void *init_data)
{
	int ret;
	bt_self_component_status status = BT_SELF_COMPONENT_STATUS_OK;
	struct muxer_comp *muxer_comp = g_new0(struct muxer_comp, 1);

	BT_LOGI("Initializing muxer component: "
		"comp-addr=%p, params-addr=%p", self_comp, params);

	if (!muxer_comp) {
		BT_LOGE_STR("Failed to allocate one muxer component.");
		goto error;
	}

	ret = configure_muxer_comp(muxer_comp, params);
	if (ret) {
		BT_LOGE("Cannot configure muxer component: "
			"muxer-comp-addr=%p, params-addr=%p",
			muxer_comp, params);
		goto error;
	}

	muxer_comp->self_comp = self_comp;
	bt_self_component_set_data(
		bt_self_component_filter_as_self_component(self_comp),
		muxer_comp);
	status = add_available_input_port(self_comp);
	if (status != BT_SELF_COMPONENT_STATUS_OK) {
		BT_LOGE("Cannot ensure that at least one muxer component's input port is available: "
			"muxer-comp-addr=%p, status=%s",
			muxer_comp,
			bt_self_component_status_string(status));
		goto error;
	}

	status = create_output_port(self_comp);
	if (status) {
		BT_LOGE("Cannot create muxer component's output port: "
			"muxer-comp-addr=%p, status=%s",
			muxer_comp,
			bt_self_component_status_string(status));
		goto error;
	}

	BT_LOGI("Initialized muxer component: "
		"comp-addr=%p, params-addr=%p, muxer-comp-addr=%p",
		self_comp, params, muxer_comp);

	goto end;

error:
	destroy_muxer_comp(muxer_comp);
	bt_self_component_set_data(
		bt_self_component_filter_as_self_component(self_comp),
		NULL);

	if (status == BT_SELF_COMPONENT_STATUS_OK) {
		status = BT_SELF_COMPONENT_STATUS_ERROR;
	}

end:
	return status;
}

BT_HIDDEN
void muxer_finalize(bt_self_component_filter *self_comp)
{
	struct muxer_comp *muxer_comp = bt_self_component_get_data(
		bt_self_component_filter_as_self_component(self_comp));

	BT_LOGI("Finalizing muxer component: comp-addr=%p",
		self_comp);
	destroy_muxer_comp(muxer_comp);
}

static
bt_self_component_port_input_message_iterator *
create_msg_iter_on_input_port(bt_self_component_port_input *self_port)
{
	const bt_port *port = bt_self_component_port_as_port(
		bt_self_component_port_input_as_self_component_port(
			self_port));
	bt_self_component_port_input_message_iterator *msg_iter =
		NULL;

	BT_ASSERT(port);
	BT_ASSERT(bt_port_is_connected(port));

	// TODO: Advance the iterator to >= the time of the latest
	//       returned message by the muxer message
	//       iterator which creates it.
	msg_iter = bt_self_component_port_input_message_iterator_create(
		self_port);
	if (!msg_iter) {
		BT_LOGE("Cannot create upstream message iterator on input port: "
			"port-addr=%p, port-name=\"%s\"",
			port, bt_port_get_name(port));
		goto end;
	}

	BT_LOGI("Created upstream message iterator on input port: "
		"port-addr=%p, port-name=\"%s\", msg-iter-addr=%p",
		port, bt_port_get_name(port), msg_iter);

end:
	return msg_iter;
}

static
bt_self_message_iterator_status muxer_upstream_msg_iter_next(
		struct muxer_upstream_msg_iter *muxer_upstream_msg_iter,
		bool *is_ended)
{
	bt_self_message_iterator_status status;
	bt_message_iterator_status input_port_iter_status;
	bt_message_array_const msgs;
	uint64_t i;
	uint64_t count;

	BT_LOGD("Calling upstream message iterator's \"next\" method: "
		"muxer-upstream-msg-iter-wrap-addr=%p, msg-iter-addr=%p",
		muxer_upstream_msg_iter,
		muxer_upstream_msg_iter->msg_iter);
	input_port_iter_status = bt_self_component_port_input_message_iterator_next(
		muxer_upstream_msg_iter->msg_iter, &msgs, &count);
	BT_LOGD("Upstream message iterator's \"next\" method returned: "
		"status=%s", bt_message_iterator_status_string(input_port_iter_status));

	switch (input_port_iter_status) {
	case BT_MESSAGE_ITERATOR_STATUS_OK:
		/*
		 * Message iterator's current message is
		 * valid: it must be considered for muxing operations.
		 */
		BT_LOGD_STR("Validated upstream message iterator wrapper.");
		BT_ASSERT(count > 0);

		/* Move messages to our queue */
		for (i = 0; i < count; i++) {
			/*
			 * Push to tail in order; other side
			 * (muxer_msg_iter_do_next_one()) consumes
			 * from the head first.
			 */
			g_queue_push_tail(muxer_upstream_msg_iter->msgs,
				(void *) msgs[i]);
		}
		status = BT_SELF_MESSAGE_ITERATOR_STATUS_OK;
		break;
	case BT_MESSAGE_ITERATOR_STATUS_AGAIN:
		/*
		 * Message iterator's current message is not
		 * valid anymore. Return
		 * BT_MESSAGE_ITERATOR_STATUS_AGAIN immediately.
		 */
		status = BT_SELF_MESSAGE_ITERATOR_STATUS_AGAIN;
		break;
	case BT_MESSAGE_ITERATOR_STATUS_END:	/* Fall-through. */
		/*
		 * Message iterator reached the end: release it. It
		 * won't be considered again to find the youngest
		 * message.
		 */
		*is_ended = true;
		status = BT_SELF_MESSAGE_ITERATOR_STATUS_OK;
		break;
	default:
		/* Error or unsupported status code */
		BT_LOGE("Error or unsupported status code: "
			"status-code=%d", input_port_iter_status);
		status = BT_SELF_MESSAGE_ITERATOR_STATUS_ERROR;
		break;
	}

	return status;
}

static
int get_msg_ts_ns(struct muxer_comp *muxer_comp,
		struct muxer_msg_iter *muxer_msg_iter,
		const bt_message *msg, int64_t last_returned_ts_ns,
		int64_t *ts_ns)
{
	const bt_clock_snapshot *clock_snapshot = NULL;
	int ret = 0;
	bt_message_stream_activity_clock_snapshot_state sa_cs_state;
	const bt_stream_class *stream_class = NULL;
	bt_message_type msg_type;

	BT_ASSERT(msg);
	BT_ASSERT(ts_ns);
	BT_LOGD("Getting message's timestamp: "
		"muxer-msg-iter-addr=%p, msg-addr=%p, "
		"last-returned-ts=%" PRId64,
		muxer_msg_iter, msg, last_returned_ts_ns);

	if (G_UNLIKELY(muxer_msg_iter->clock_class_expectation ==
			MUXER_MSG_ITER_CLOCK_CLASS_EXPECTATION_NONE)) {
		*ts_ns = last_returned_ts_ns;
		goto end;
	}

	msg_type = bt_message_get_type(msg);

	if (G_UNLIKELY(msg_type == BT_MESSAGE_TYPE_PACKET_BEGINNING)) {
		stream_class = bt_stream_borrow_class_const(
			bt_packet_borrow_stream_const(
				bt_message_packet_beginning_borrow_packet_const(
					msg)));
	} else if (G_UNLIKELY(msg_type == BT_MESSAGE_TYPE_PACKET_END)) {
		stream_class = bt_stream_borrow_class_const(
			bt_packet_borrow_stream_const(
				bt_message_packet_end_borrow_packet_const(
					msg)));
	} else if (G_UNLIKELY(msg_type == BT_MESSAGE_TYPE_DISCARDED_EVENTS)) {
		stream_class = bt_stream_borrow_class_const(
			bt_message_discarded_events_borrow_stream_const(msg));
	} else if (G_UNLIKELY(msg_type == BT_MESSAGE_TYPE_DISCARDED_PACKETS)) {
		stream_class = bt_stream_borrow_class_const(
			bt_message_discarded_packets_borrow_stream_const(msg));
	}

	switch (msg_type) {
	case BT_MESSAGE_TYPE_EVENT:
		BT_ASSERT(bt_message_event_borrow_stream_class_default_clock_class_const(
				msg));
		clock_snapshot = bt_message_event_borrow_default_clock_snapshot_const(
			msg);
		break;
	case BT_MESSAGE_TYPE_PACKET_BEGINNING:
		if (bt_stream_class_packets_have_beginning_default_clock_snapshot(
				stream_class)) {
			clock_snapshot = bt_message_packet_beginning_borrow_default_clock_snapshot_const(
				msg);
		} else {
			goto no_clock_snapshot;
		}

		break;
	case BT_MESSAGE_TYPE_PACKET_END:
		if (bt_stream_class_packets_have_end_default_clock_snapshot(
				stream_class)) {
			clock_snapshot = bt_message_packet_end_borrow_default_clock_snapshot_const(
				msg);
		} else {
			goto no_clock_snapshot;
		}

		break;
	case BT_MESSAGE_TYPE_DISCARDED_EVENTS:
		if (bt_stream_class_discarded_events_have_default_clock_snapshots(
				stream_class)) {
			clock_snapshot = bt_message_discarded_events_borrow_beginning_default_clock_snapshot_const(
				msg);
		} else {
			goto no_clock_snapshot;
		}

		break;
	case BT_MESSAGE_TYPE_DISCARDED_PACKETS:
		if (bt_stream_class_discarded_packets_have_default_clock_snapshots(
				stream_class)) {
			clock_snapshot = bt_message_discarded_packets_borrow_beginning_default_clock_snapshot_const(
				msg);
		} else {
			goto no_clock_snapshot;
		}

		break;
	case BT_MESSAGE_TYPE_STREAM_ACTIVITY_BEGINNING:
		BT_ASSERT(bt_message_stream_activity_beginning_borrow_stream_class_default_clock_class_const(
				msg));
		sa_cs_state = bt_message_stream_activity_beginning_borrow_default_clock_snapshot_const(
			msg, &clock_snapshot);
		if (sa_cs_state != BT_MESSAGE_STREAM_ACTIVITY_CLOCK_SNAPSHOT_STATE_KNOWN) {
			goto no_clock_snapshot;
		}

		break;
	case BT_MESSAGE_TYPE_STREAM_ACTIVITY_END:
		BT_ASSERT(bt_message_stream_activity_end_borrow_stream_class_default_clock_class_const(
				msg));
		sa_cs_state = bt_message_stream_activity_end_borrow_default_clock_snapshot_const(
			msg, &clock_snapshot);
		if (sa_cs_state != BT_MESSAGE_STREAM_ACTIVITY_CLOCK_SNAPSHOT_STATE_KNOWN) {
			goto no_clock_snapshot;
		}

		break;
	case BT_MESSAGE_TYPE_MESSAGE_ITERATOR_INACTIVITY:
		clock_snapshot = bt_message_message_iterator_inactivity_borrow_default_clock_snapshot_const(
			msg);
		break;
	default:
		/* All the other messages have a higher priority */
		BT_LOGD_STR("Message has no timestamp: using the last returned timestamp.");
		*ts_ns = last_returned_ts_ns;
		goto end;
	}

	ret = bt_clock_snapshot_get_ns_from_origin(clock_snapshot, ts_ns);
	if (ret) {
		BT_LOGE("Cannot get nanoseconds from Epoch of clock snapshot: "
			"clock-snapshot-addr=%p", clock_snapshot);
		goto error;
	}

	goto end;

no_clock_snapshot:
	BT_LOGD_STR("Message's default clock snapshot is missing: "
		"using the last returned timestamp.");
	*ts_ns = last_returned_ts_ns;
	goto end;

error:
	ret = -1;

end:
	if (ret == 0) {
		BT_LOGD("Found message's timestamp: "
			"muxer-msg-iter-addr=%p, msg-addr=%p, "
			"last-returned-ts=%" PRId64 ", ts=%" PRId64,
			muxer_msg_iter, msg, last_returned_ts_ns,
			*ts_ns);
	}

	return ret;
}

static inline
int validate_clock_class(struct muxer_msg_iter *muxer_msg_iter,
		struct muxer_comp *muxer_comp,
		const bt_clock_class *clock_class)
{
	int ret = 0;
	const unsigned char *cc_uuid;
	const char *cc_name;

	BT_ASSERT(clock_class);
	cc_uuid = bt_clock_class_get_uuid(clock_class);
	cc_name = bt_clock_class_get_name(clock_class);

	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.
		 */
		if (bt_clock_class_origin_is_unix_epoch(clock_class)) {
			/* Expect absolute clock classes */
			muxer_msg_iter->clock_class_expectation =
				MUXER_MSG_ITER_CLOCK_CLASS_EXPECTATION_ABSOLUTE;
		} else {
			if (cc_uuid) {
				/*
				 * Expect non-absolute clock classes
				 * with a specific UUID.
				 */
				muxer_msg_iter->clock_class_expectation =
					MUXER_MSG_ITER_CLOCK_CLASS_EXPECTATION_NOT_ABS_SPEC_UUID;
				memcpy(muxer_msg_iter->expected_clock_class_uuid,
					cc_uuid, BABELTRACE_UUID_LEN);
			} else {
				/*
				 * Expect non-absolute clock classes
				 * with no UUID.
				 */
				muxer_msg_iter->clock_class_expectation =
					MUXER_MSG_ITER_CLOCK_CLASS_EXPECTATION_NOT_ABS_NO_UUID;
			}
		}
	}

	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_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_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_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=\"%02x%02x%02x%02x-%02x%02x-%02x%02x-%02x%02x-%02x%02x%02x%02x%02x%02x\"",
					clock_class, cc_name,
					(unsigned int) cc_uuid[0],
					(unsigned int) cc_uuid[1],
					(unsigned int) cc_uuid[2],
					(unsigned int) cc_uuid[3],
					(unsigned int) cc_uuid[4],
					(unsigned int) cc_uuid[5],
					(unsigned int) cc_uuid[6],
					(unsigned int) cc_uuid[7],
					(unsigned int) cc_uuid[8],
					(unsigned int) cc_uuid[9],
					(unsigned int) cc_uuid[10],
					(unsigned int) cc_uuid[11],
					(unsigned int) cc_uuid[12],
					(unsigned int) cc_uuid[13],
					(unsigned int) cc_uuid[14],
					(unsigned int) cc_uuid[15]);
				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_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 (!cc_uuid) {
				BT_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 (memcmp(muxer_msg_iter->expected_clock_class_uuid,
					cc_uuid, BABELTRACE_UUID_LEN) != 0) {
				BT_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=\"%02x%02x%02x%02x-%02x%02x-%02x%02x-%02x%02x-%02x%02x%02x%02x%02x%02x\", "
					"uuid=\"%02x%02x%02x%02x-%02x%02x-%02x%02x-%02x%02x-%02x%02x%02x%02x%02x%02x\"",
					clock_class, cc_name,
					(unsigned int) muxer_msg_iter->expected_clock_class_uuid[0],
					(unsigned int) muxer_msg_iter->expected_clock_class_uuid[1],
					(unsigned int) muxer_msg_iter->expected_clock_class_uuid[2],
					(unsigned int) muxer_msg_iter->expected_clock_class_uuid[3],
					(unsigned int) muxer_msg_iter->expected_clock_class_uuid[4],
					(unsigned int) muxer_msg_iter->expected_clock_class_uuid[5],
					(unsigned int) muxer_msg_iter->expected_clock_class_uuid[6],
					(unsigned int) muxer_msg_iter->expected_clock_class_uuid[7],
					(unsigned int) muxer_msg_iter->expected_clock_class_uuid[8],
					(unsigned int) muxer_msg_iter->expected_clock_class_uuid[9],
					(unsigned int) muxer_msg_iter->expected_clock_class_uuid[10],
					(unsigned int) muxer_msg_iter->expected_clock_class_uuid[11],
					(unsigned int) muxer_msg_iter->expected_clock_class_uuid[12],
					(unsigned int) muxer_msg_iter->expected_clock_class_uuid[13],
					(unsigned int) muxer_msg_iter->expected_clock_class_uuid[14],
					(unsigned int) muxer_msg_iter->expected_clock_class_uuid[15],
					(unsigned int) cc_uuid[0],
					(unsigned int) cc_uuid[1],
					(unsigned int) cc_uuid[2],
					(unsigned int) cc_uuid[3],
					(unsigned int) cc_uuid[4],
					(unsigned int) cc_uuid[5],
					(unsigned int) cc_uuid[6],
					(unsigned int) cc_uuid[7],
					(unsigned int) cc_uuid[8],
					(unsigned int) cc_uuid[9],
					(unsigned int) cc_uuid[10],
					(unsigned int) cc_uuid[11],
					(unsigned int) cc_uuid[12],
					(unsigned int) cc_uuid[13],
					(unsigned int) cc_uuid[14],
					(unsigned int) cc_uuid[15]);
				goto error;
			}
			break;
		case MUXER_MSG_ITER_CLOCK_CLASS_EXPECTATION_NONE:
			BT_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_LOGF("Unexpected clock class expectation: "
				"expectation-code=%d",
				muxer_msg_iter->clock_class_expectation);
			abort();
		}
	}

	goto end;

error:
	ret = -1;

end:
	return ret;
}

static inline
int validate_new_stream_clock_class(struct muxer_msg_iter *muxer_msg_iter,
		struct muxer_comp *muxer_comp, const bt_stream *stream)
{
	int ret = 0;
	const bt_stream_class *stream_class =
		bt_stream_borrow_class_const(stream);
	const bt_clock_class *clock_class =
		bt_stream_class_borrow_default_clock_class_const(stream_class);

	if (!clock_class) {
		if (muxer_msg_iter->clock_class_expectation ==
			MUXER_MSG_ITER_CLOCK_CLASS_EXPECTATION_ANY) {
			/* Expect no clock class */
			muxer_msg_iter->clock_class_expectation =
				MUXER_MSG_ITER_CLOCK_CLASS_EXPECTATION_NONE;
		} else {
			BT_LOGE("Expecting stream class with a default clock class: "
				"stream-class-addr=%p, stream-class-name=\"%s\", "
				"stream-class-id=%" PRIu64,
				stream_class, bt_stream_class_get_name(stream_class),
				bt_stream_class_get_id(stream_class));
			ret = -1;
		}

		goto end;
	}

	ret = validate_clock_class(muxer_msg_iter, muxer_comp, clock_class);

end:
	return ret;
}

/*
 * This function finds the youngest available message amongst the
 * non-ended upstream message iterators and returns the upstream
 * message iterator which has it, or
 * BT_MESSAGE_ITERATOR_STATUS_END if there's no available
 * message.
 *
 * This function does NOT:
 *
 * * Update any upstream message iterator.
 * * Check the upstream message iterators to retry.
 *
 * On sucess, this function sets *muxer_upstream_msg_iter to the
 * upstream message iterator of which the current message is
 * the youngest, and sets *ts_ns to its time.
 */
static
bt_self_message_iterator_status
muxer_msg_iter_youngest_upstream_msg_iter(
		struct muxer_comp *muxer_comp,
		struct muxer_msg_iter *muxer_msg_iter,
		struct muxer_upstream_msg_iter **muxer_upstream_msg_iter,
		int64_t *ts_ns)
{
	size_t i;
	int ret;
	int64_t youngest_ts_ns = INT64_MAX;
	bt_self_message_iterator_status status =
		BT_SELF_MESSAGE_ITERATOR_STATUS_OK;

	BT_ASSERT(muxer_comp);
	BT_ASSERT(muxer_msg_iter);
	BT_ASSERT(muxer_upstream_msg_iter);
	*muxer_upstream_msg_iter = NULL;

	for (i = 0; i < muxer_msg_iter->active_muxer_upstream_msg_iters->len;
			i++) {
		const bt_message *msg;
		struct muxer_upstream_msg_iter *cur_muxer_upstream_msg_iter =
			g_ptr_array_index(
				muxer_msg_iter->active_muxer_upstream_msg_iters,
				i);
		int64_t msg_ts_ns;

		if (!cur_muxer_upstream_msg_iter->msg_iter) {
			/* This upstream message iterator is ended */
			BT_LOGV("Skipping ended upstream message iterator: "
				"muxer-upstream-msg-iter-wrap-addr=%p",
				cur_muxer_upstream_msg_iter);
			continue;
		}

		BT_ASSERT(cur_muxer_upstream_msg_iter->msgs->length > 0);
		msg = g_queue_peek_head(cur_muxer_upstream_msg_iter->msgs);
		BT_ASSERT(msg);

		if (G_UNLIKELY(bt_message_get_type(msg) ==
				BT_MESSAGE_TYPE_STREAM_BEGINNING)) {
			ret = validate_new_stream_clock_class(
				muxer_msg_iter, muxer_comp,
				bt_message_stream_beginning_borrow_stream_const(
					msg));
			if (ret) {
				/*
				 * validate_new_stream_clock_class() logs
				 * errors.
				 */
				status = BT_SELF_MESSAGE_ITERATOR_STATUS_ERROR;
				goto end;
			}
		} else if (G_UNLIKELY(bt_message_get_type(msg) ==
				BT_MESSAGE_TYPE_MESSAGE_ITERATOR_INACTIVITY)) {
			const bt_clock_snapshot *cs;

			cs = bt_message_message_iterator_inactivity_borrow_default_clock_snapshot_const(
				msg);
			ret = validate_clock_class(muxer_msg_iter, muxer_comp,
				bt_clock_snapshot_borrow_clock_class_const(cs));
			if (ret) {
				/* validate_clock_class() logs errors */
				status = BT_SELF_MESSAGE_ITERATOR_STATUS_ERROR;
				goto end;
			}
		}

		ret = get_msg_ts_ns(muxer_comp, muxer_msg_iter, msg,
			muxer_msg_iter->last_returned_ts_ns, &msg_ts_ns);
		if (ret) {
			/* get_msg_ts_ns() logs errors */
			*muxer_upstream_msg_iter = NULL;
			status = BT_SELF_MESSAGE_ITERATOR_STATUS_ERROR;
			goto end;
		}

		if (msg_ts_ns <= youngest_ts_ns) {
			*muxer_upstream_msg_iter =
				cur_muxer_upstream_msg_iter;
			youngest_ts_ns = msg_ts_ns;
			*ts_ns = youngest_ts_ns;
		}
	}

	if (!*muxer_upstream_msg_iter) {
		status = BT_SELF_MESSAGE_ITERATOR_STATUS_END;
		*ts_ns = INT64_MIN;
	}

end:
	return status;
}

static
bt_self_message_iterator_status validate_muxer_upstream_msg_iter(
	struct muxer_upstream_msg_iter *muxer_upstream_msg_iter,
	bool *is_ended)
{
	bt_self_message_iterator_status status =
		BT_SELF_MESSAGE_ITERATOR_STATUS_OK;

	BT_LOGD("Validating muxer's upstream message iterator wrapper: "
		"muxer-upstream-msg-iter-wrap-addr=%p",
		muxer_upstream_msg_iter);

	if (muxer_upstream_msg_iter->msgs->length > 0 ||
			!muxer_upstream_msg_iter->msg_iter) {
		BT_LOGD("Already valid or not considered: "
			"queue-len=%u, upstream-msg-iter-addr=%p",
			muxer_upstream_msg_iter->msgs->length,
			muxer_upstream_msg_iter->msg_iter);
		goto end;
	}

	/* muxer_upstream_msg_iter_next() logs details/errors */
	status = muxer_upstream_msg_iter_next(muxer_upstream_msg_iter,
		is_ended);

end:
	return status;
}

static
bt_self_message_iterator_status validate_muxer_upstream_msg_iters(
		struct muxer_msg_iter *muxer_msg_iter)
{
	bt_self_message_iterator_status status =
		BT_SELF_MESSAGE_ITERATOR_STATUS_OK;
	size_t i;

	BT_LOGD("Validating muxer's upstream message iterator wrappers: "
		"muxer-msg-iter-addr=%p", muxer_msg_iter);

	for (i = 0; i < muxer_msg_iter->active_muxer_upstream_msg_iters->len;
			i++) {
		bool is_ended = false;
		struct muxer_upstream_msg_iter *muxer_upstream_msg_iter =
			g_ptr_array_index(
				muxer_msg_iter->active_muxer_upstream_msg_iters,
				i);

		status = validate_muxer_upstream_msg_iter(
			muxer_upstream_msg_iter, &is_ended);
		if (status != BT_SELF_MESSAGE_ITERATOR_STATUS_OK) {
			if (status < 0) {
				BT_LOGE("Cannot validate muxer's upstream message iterator wrapper: "
					"muxer-msg-iter-addr=%p, "
					"muxer-upstream-msg-iter-wrap-addr=%p",
					muxer_msg_iter,
					muxer_upstream_msg_iter);
			} else {
				BT_LOGD("Cannot validate muxer's upstream message iterator wrapper: "
					"muxer-msg-iter-addr=%p, "
					"muxer-upstream-msg-iter-wrap-addr=%p",
					muxer_msg_iter,
					muxer_upstream_msg_iter);
			}

			goto end;
		}

		/*
		 * Move this muxer upstream message iterator to the
		 * array of ended iterators if it's ended.
		 */
		if (G_UNLIKELY(is_ended)) {
			BT_LOGD("Muxer's upstream message iterator wrapper: ended or canceled: "
				"muxer-msg-iter-addr=%p, "
				"muxer-upstream-msg-iter-wrap-addr=%p",
				muxer_msg_iter, muxer_upstream_msg_iter);
			g_ptr_array_add(
				muxer_msg_iter->ended_muxer_upstream_msg_iters,
				muxer_upstream_msg_iter);
			muxer_msg_iter->active_muxer_upstream_msg_iters->pdata[i] = NULL;

			/*
			 * Use g_ptr_array_remove_fast() because the
			 * order of those elements is not important.
			 */
			g_ptr_array_remove_index_fast(
				muxer_msg_iter->active_muxer_upstream_msg_iters,
				i);
			i--;
		}
	}

end:
	return status;
}

static inline
bt_self_message_iterator_status muxer_msg_iter_do_next_one(
		struct muxer_comp *muxer_comp,
		struct muxer_msg_iter *muxer_msg_iter,
		const bt_message **msg)
{
	bt_self_message_iterator_status status;
	struct muxer_upstream_msg_iter *muxer_upstream_msg_iter = NULL;
	int64_t next_return_ts;

	status = validate_muxer_upstream_msg_iters(muxer_msg_iter);
	if (status != BT_SELF_MESSAGE_ITERATOR_STATUS_OK) {
		/* validate_muxer_upstream_msg_iters() logs details */
		goto end;
	}

	/*
	 * At this point we know that all the existing upstream
	 * message iterators are valid. We can find the one,
	 * amongst those, of which the current message is the
	 * youngest.
	 */
	status = muxer_msg_iter_youngest_upstream_msg_iter(muxer_comp,
			muxer_msg_iter, &muxer_upstream_msg_iter,
			&next_return_ts);
	if (status < 0 || status == BT_SELF_MESSAGE_ITERATOR_STATUS_END) {
		if (status < 0) {
			BT_LOGE("Cannot find the youngest upstream message iterator wrapper: "
				"status=%s",
				bt_common_self_message_iterator_status_string(status));
		} else {
			BT_LOGD("Cannot find the youngest upstream message iterator wrapper: "
				"status=%s",
				bt_common_self_message_iterator_status_string(status));
		}

		goto end;
	}

	if (next_return_ts < muxer_msg_iter->last_returned_ts_ns) {
		BT_LOGE("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_msg_iter->last_returned_ts_ns);
		status = BT_SELF_MESSAGE_ITERATOR_STATUS_ERROR;
		goto end;
	}

	BT_LOGD("Found youngest upstream message iterator wrapper: "
		"muxer-msg-iter-addr=%p, "
		"muxer-upstream-msg-iter-wrap-addr=%p, "
		"ts=%" PRId64,
		muxer_msg_iter, muxer_upstream_msg_iter, next_return_ts);
	BT_ASSERT(status == BT_SELF_MESSAGE_ITERATOR_STATUS_OK);
	BT_ASSERT(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);
	muxer_msg_iter->last_returned_ts_ns = next_return_ts;

end:
	return status;
}

static
bt_self_message_iterator_status muxer_msg_iter_do_next(
		struct muxer_comp *muxer_comp,
		struct muxer_msg_iter *muxer_msg_iter,
		bt_message_array_const msgs, uint64_t capacity,
		uint64_t *count)
{
	bt_self_message_iterator_status status =
		BT_SELF_MESSAGE_ITERATOR_STATUS_OK;
	uint64_t i = 0;

	while (i < capacity && status == BT_SELF_MESSAGE_ITERATOR_STATUS_OK) {
		status = muxer_msg_iter_do_next_one(muxer_comp,
			muxer_msg_iter, &msgs[i]);
		if (status == BT_SELF_MESSAGE_ITERATOR_STATUS_OK) {
			i++;
		}
	}

	if (i > 0) {
		/*
		 * Even if muxer_msg_iter_do_next_one() returned
		 * something else than
		 * BT_MESSAGE_ITERATOR_STATUS_OK, we accumulated
		 * message objects in the output message
		 * array, so we need to return
		 * BT_MESSAGE_ITERATOR_STATUS_OK so that they are
		 * transfered to downstream. This other status occurs
		 * again the next time muxer_msg_iter_do_next() is
		 * called, possibly without any accumulated
		 * message, in which case we'll return it.
		 */
		*count = i;
		status = BT_SELF_MESSAGE_ITERATOR_STATUS_OK;
	}

	return status;
}

static
void destroy_muxer_msg_iter(struct muxer_msg_iter *muxer_msg_iter)
{
	if (!muxer_msg_iter) {
		return;
	}

	BT_LOGD("Destroying muxer component's message iterator: "
		"muxer-msg-iter-addr=%p", muxer_msg_iter);

	if (muxer_msg_iter->active_muxer_upstream_msg_iters) {
		BT_LOGD_STR("Destroying muxer's active upstream message iterator wrappers.");
		g_ptr_array_free(
			muxer_msg_iter->active_muxer_upstream_msg_iters, TRUE);
	}

	if (muxer_msg_iter->ended_muxer_upstream_msg_iters) {
		BT_LOGD_STR("Destroying muxer's ended upstream message iterator wrappers.");
		g_ptr_array_free(
			muxer_msg_iter->ended_muxer_upstream_msg_iters, TRUE);
	}

	g_free(muxer_msg_iter);
}

static
int muxer_msg_iter_init_upstream_iterators(struct muxer_comp *muxer_comp,
		struct muxer_msg_iter *muxer_msg_iter)
{
	int64_t count;
	int64_t i;
	int ret = 0;

	count = bt_component_filter_get_input_port_count(
		bt_self_component_filter_as_component_filter(
			muxer_comp->self_comp));
	if (count < 0) {
		BT_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);
		goto end;
	}

	for (i = 0; i < count; i++) {
		bt_self_component_port_input_message_iterator *upstream_msg_iter;
		bt_self_component_port_input *self_port =
			bt_self_component_filter_borrow_input_port_by_index(
				muxer_comp->self_comp, i);
		const bt_port *port;

		BT_ASSERT(self_port);
		port = bt_self_component_port_as_port(
			bt_self_component_port_input_as_self_component_port(
				self_port));
		BT_ASSERT(port);

		if (!bt_port_is_connected(port)) {
			/* Skip non-connected port */
			continue;
		}

		upstream_msg_iter = create_msg_iter_on_input_port(self_port);
		if (!upstream_msg_iter) {
			/* create_msg_iter_on_input_port() logs errors */
			BT_ASSERT(!upstream_msg_iter);
			ret = -1;
			goto end;
		}

		ret = muxer_msg_iter_add_upstream_msg_iter(muxer_msg_iter,
			upstream_msg_iter);
		bt_self_component_port_input_message_iterator_put_ref(
			upstream_msg_iter);
		if (ret) {
			/* muxer_msg_iter_add_upstream_msg_iter() logs errors */
			goto end;
		}
	}

end:
	return ret;
}

BT_HIDDEN
bt_self_message_iterator_status muxer_msg_iter_init(
		bt_self_message_iterator *self_msg_iter,
		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_self_message_iterator_status status =
		BT_SELF_MESSAGE_ITERATOR_STATUS_OK;
	int ret;

	muxer_comp = bt_self_component_get_data(
		bt_self_component_filter_as_self_component(self_comp));
	BT_ASSERT(muxer_comp);
	BT_LOGD("Initializing muxer component's message iterator: "
		"comp-addr=%p, muxer-comp-addr=%p, msg-iter-addr=%p",
		self_comp, muxer_comp, self_msg_iter);

	if (muxer_comp->initializing_muxer_msg_iter) {
		/*
		 * Weird, unhandled situation detected: downstream
		 * creates a muxer message iterator while creating
		 * another muxer message iterator (same component).
		 */
		BT_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);
		goto error;
	}

	muxer_comp->initializing_muxer_msg_iter = true;
	muxer_msg_iter = g_new0(struct muxer_msg_iter, 1);
	if (!muxer_msg_iter) {
		BT_LOGE_STR("Failed to allocate one muxer component's message iterator.");
		goto error;
	}

	muxer_msg_iter->last_returned_ts_ns = INT64_MIN;
	muxer_msg_iter->active_muxer_upstream_msg_iters =
		g_ptr_array_new_with_free_func(
			(GDestroyNotify) destroy_muxer_upstream_msg_iter);
	if (!muxer_msg_iter->active_muxer_upstream_msg_iters) {
		BT_LOGE_STR("Failed to allocate a GPtrArray.");
		goto error;
	}

	muxer_msg_iter->ended_muxer_upstream_msg_iters =
		g_ptr_array_new_with_free_func(
			(GDestroyNotify) destroy_muxer_upstream_msg_iter);
	if (!muxer_msg_iter->ended_muxer_upstream_msg_iters) {
		BT_LOGE_STR("Failed to allocate a GPtrArray.");
		goto error;
	}

	ret = muxer_msg_iter_init_upstream_iterators(muxer_comp,
		muxer_msg_iter);
	if (ret) {
		BT_LOGE("Cannot initialize connected input ports for muxer component's message iterator: "
			"comp-addr=%p, muxer-comp-addr=%p, "
			"muxer-msg-iter-addr=%p, msg-iter-addr=%p, ret=%d",
			self_comp, muxer_comp, muxer_msg_iter,
			self_msg_iter, ret);
		goto error;
	}

	bt_self_message_iterator_set_data(self_msg_iter, muxer_msg_iter);
	BT_LOGD("Initialized muxer component's message iterator: "
		"comp-addr=%p, muxer-comp-addr=%p, muxer-msg-iter-addr=%p, "
		"msg-iter-addr=%p",
		self_comp, muxer_comp, muxer_msg_iter, self_msg_iter);
	goto end;

error:
	destroy_muxer_msg_iter(muxer_msg_iter);
	bt_self_message_iterator_set_data(self_msg_iter, NULL);
	status = BT_SELF_MESSAGE_ITERATOR_STATUS_ERROR;

end:
	muxer_comp->initializing_muxer_msg_iter = false;
	return status;
}

BT_HIDDEN
void muxer_msg_iter_finalize(bt_self_message_iterator *self_msg_iter)
{
	struct muxer_msg_iter *muxer_msg_iter =
		bt_self_message_iterator_get_data(self_msg_iter);
	bt_self_component *self_comp = NULL;
	struct muxer_comp *muxer_comp = NULL;

	self_comp = bt_self_message_iterator_borrow_component(
		self_msg_iter);
	BT_ASSERT(self_comp);
	muxer_comp = bt_self_component_get_data(self_comp);
	BT_LOGD("Finalizing muxer component's message iterator: "
		"comp-addr=%p, muxer-comp-addr=%p, muxer-msg-iter-addr=%p, "
		"msg-iter-addr=%p",
		self_comp, muxer_comp, muxer_msg_iter, self_msg_iter);

	if (muxer_msg_iter) {
		destroy_muxer_msg_iter(muxer_msg_iter);
	}
}

BT_HIDDEN
bt_self_message_iterator_status muxer_msg_iter_next(
		bt_self_message_iterator *self_msg_iter,
		bt_message_array_const msgs, uint64_t capacity,
		uint64_t *count)
{
	bt_self_message_iterator_status status;
	struct muxer_msg_iter *muxer_msg_iter =
		bt_self_message_iterator_get_data(self_msg_iter);
	bt_self_component *self_comp = NULL;
	struct muxer_comp *muxer_comp = NULL;

	BT_ASSERT(muxer_msg_iter);
	self_comp = bt_self_message_iterator_borrow_component(
		self_msg_iter);
	BT_ASSERT(self_comp);
	muxer_comp = bt_self_component_get_data(self_comp);
	BT_ASSERT(muxer_comp);
	BT_LOGV("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",
		self_comp, muxer_comp, muxer_msg_iter, self_msg_iter);

	status = muxer_msg_iter_do_next(muxer_comp, muxer_msg_iter,
		msgs, capacity, count);
	if (status < 0) {
		BT_LOGE("Cannot get next message: "
			"comp-addr=%p, muxer-comp-addr=%p, muxer-msg-iter-addr=%p, "
			"msg-iter-addr=%p, status=%s",
			self_comp, muxer_comp, muxer_msg_iter, self_msg_iter,
			bt_common_self_message_iterator_status_string(status));
	} else {
		BT_LOGV("Returning from muxer component's message iterator's \"next\" method: "
			"status=%s",
			bt_common_self_message_iterator_status_string(status));
	}

	return status;
}

BT_HIDDEN
bt_self_component_status muxer_input_port_connected(
		bt_self_component_filter *self_comp,
		bt_self_component_port_input *self_port,
		const bt_port_output *other_port)
{
	bt_self_component_status status;

	status = add_available_input_port(self_comp);
	if (status) {
		/*
		 * Only way to report an error later since this
		 * method does not return anything.
		 */
		BT_LOGE("Cannot add one muxer component's input port: "
			"status=%s",
			bt_self_component_status_string(status));
		goto end;
	}

end:
	return status;
}

static inline
bt_bool muxer_upstream_msg_iters_can_all_seek_beginning(
		GPtrArray *muxer_upstream_msg_iters)
{
	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];

		if (!bt_self_component_port_input_message_iterator_can_seek_beginning(
				upstream_msg_iter->msg_iter)) {
			ret = BT_FALSE;
			goto end;
		}
	}

end:
	return ret;
}

BT_HIDDEN
bt_bool muxer_msg_iter_can_seek_beginning(
		bt_self_message_iterator *self_msg_iter)
{
	struct muxer_msg_iter *muxer_msg_iter =
		bt_self_message_iterator_get_data(self_msg_iter);
	bt_bool ret = BT_TRUE;

	if (!muxer_upstream_msg_iters_can_all_seek_beginning(
			muxer_msg_iter->active_muxer_upstream_msg_iters)) {
		ret = BT_FALSE;
		goto end;
	}

	if (!muxer_upstream_msg_iters_can_all_seek_beginning(
			muxer_msg_iter->ended_muxer_upstream_msg_iters)) {
		ret = BT_FALSE;
		goto end;
	}

end:
	return ret;
}

BT_HIDDEN
bt_self_message_iterator_status muxer_msg_iter_seek_beginning(
		bt_self_message_iterator *self_msg_iter)
{
	struct muxer_msg_iter *muxer_msg_iter =
		bt_self_message_iterator_get_data(self_msg_iter);
	bt_message_iterator_status status = BT_MESSAGE_ITERATOR_STATUS_OK;
	uint64_t i;

	/* Seek all ended upstream iterators first */
	for (i = 0; i < muxer_msg_iter->ended_muxer_upstream_msg_iters->len;
			i++) {
		struct muxer_upstream_msg_iter *upstream_msg_iter =
			muxer_msg_iter->ended_muxer_upstream_msg_iters->pdata[i];

		status = bt_self_component_port_input_message_iterator_seek_beginning(
			upstream_msg_iter->msg_iter);
		if (status != BT_MESSAGE_ITERATOR_STATUS_OK) {
			goto end;
		}

		empty_message_queue(upstream_msg_iter);
	}

	/* Seek all previously active upstream iterators */
	for (i = 0; i < muxer_msg_iter->active_muxer_upstream_msg_iters->len;
			i++) {
		struct muxer_upstream_msg_iter *upstream_msg_iter =
			muxer_msg_iter->active_muxer_upstream_msg_iters->pdata[i];

		status = bt_self_component_port_input_message_iterator_seek_beginning(
			upstream_msg_iter->msg_iter);
		if (status != BT_MESSAGE_ITERATOR_STATUS_OK) {
			goto end;
		}

		empty_message_queue(upstream_msg_iter);
	}

	/* Make them all active */
	for (i = 0; i < muxer_msg_iter->ended_muxer_upstream_msg_iters->len;
			i++) {
		struct muxer_upstream_msg_iter *upstream_msg_iter =
			muxer_msg_iter->ended_muxer_upstream_msg_iters->pdata[i];

		g_ptr_array_add(muxer_msg_iter->active_muxer_upstream_msg_iters,
			upstream_msg_iter);
		muxer_msg_iter->ended_muxer_upstream_msg_iters->pdata[i] = NULL;
	}

	g_ptr_array_remove_range(muxer_msg_iter->ended_muxer_upstream_msg_iters,
		0, muxer_msg_iter->ended_muxer_upstream_msg_iters->len);
	muxer_msg_iter->last_returned_ts_ns = INT64_MIN;
	muxer_msg_iter->clock_class_expectation =
		MUXER_MSG_ITER_CLOCK_CLASS_EXPECTATION_ANY;

end:
	return (bt_self_message_iterator_status) status;
}