[babeltrace.git] / src / ctf-writer / stream.c

/*
 * Copyright 2013, 2014 Jérémie Galarneau <jeremie.galarneau@efficios.com>
 * Copyright 2017-2018 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 "CTF-WRITER/STREAM"
#include "logging.h"

#include <inttypes.h>
#include <stdint.h>
#include <unistd.h>

#include <babeltrace2/ctf-writer/field-types.h>
#include <babeltrace2/ctf-writer/object.h>
#include <babeltrace2/ctf-writer/stream-class.h>
#include <babeltrace2/ctf-writer/stream.h>
#include <babeltrace2/ctf-writer/trace.h>

#include "common/align.h"
#include "common/assert.h"
#include "compat/compiler.h"
#include "ctfser/ctfser.h"

#include "assert-pre.h"
#include "event-class.h"
#include "event.h"
#include "fields.h"
#include "stream-class.h"
#include "stream.h"
#include "trace.h"
#include "writer.h"

BT_HIDDEN
void bt_ctf_stream_common_finalize(struct bt_ctf_stream_common *stream)
{
	BT_LOGD("Finalizing common stream object: addr=%p, name=\"%s\"",
		stream, bt_ctf_stream_common_get_name(stream));

	if (stream->name) {
		g_string_free(stream->name, TRUE);
	}
}

BT_HIDDEN
int bt_ctf_stream_common_initialize(
		struct bt_ctf_stream_common *stream,
		struct bt_ctf_stream_class_common *stream_class, const char *name,
		uint64_t id, bt_ctf_object_release_func release_func)
{
	int ret = 0;
	struct bt_ctf_trace_common *trace = NULL;

	bt_ctf_object_init_shared_with_parent(&stream->base, release_func);

	if (!stream_class) {
		BT_LOGW_STR("Invalid parameter: stream class is NULL.");
		goto error;
	}

	BT_LOGD("Initializing common stream object: stream-class-addr=%p, "
		"stream-class-name=\"%s\", stream-name=\"%s\", "
		"stream-id=%" PRIu64,
		stream_class, bt_ctf_stream_class_common_get_name(stream_class),
		name, id);
	trace = bt_ctf_stream_class_common_borrow_trace(stream_class);
	if (!trace) {
		BT_LOGW("Invalid parameter: cannot create stream from a stream class which is not part of trace: "
			"stream-class-addr=%p, stream-class-name=\"%s\", "
			"stream-name=\"%s\"",
			stream_class,
			bt_ctf_stream_class_common_get_name(stream_class), name);
		goto error;
	}

	if (id != -1ULL) {
		/*
		 * Validate that the given ID is unique amongst all the
		 * existing trace's streams created from the same stream
		 * class.
		 */
		size_t i;

		for (i = 0; i < trace->streams->len; i++) {
			struct bt_ctf_stream_common *trace_stream =
				g_ptr_array_index(trace->streams, i);

			if (trace_stream->stream_class != (void *) stream_class) {
				continue;
			}

			if (trace_stream->id == id) {
				BT_LOGW_STR("Invalid parameter: another stream in the same trace already has this ID.");
				goto error;
			}
		}
	}

	/*
	 * Acquire reference to parent since stream will become publicly
	 * reachable; it needs its parent to remain valid.
	 */
	bt_ctf_object_set_parent(&stream->base, &trace->base);
	stream->stream_class = stream_class;
	stream->id = (int64_t) id;

	if (name) {
		stream->name = g_string_new(name);
		if (!stream->name) {
			BT_LOGE_STR("Failed to allocate a GString.");
			goto error;
		}
	}

	BT_LOGD("Set common stream's trace parent: trace-addr=%p", trace);

	/* Add this stream to the trace's streams */
	BT_LOGD("Created common stream object: addr=%p", stream);
	goto end;

error:
	ret = -1;

end:
	return ret;
}

static
void bt_ctf_stream_destroy(struct bt_ctf_object *obj);

static
int try_set_structure_field_integer(struct bt_ctf_field *, char *, uint64_t);

static
int set_integer_field_value(struct bt_ctf_field* field, uint64_t value)
{
	int ret = 0;
	struct bt_ctf_field_type *field_type = NULL;

	if (!field) {
		BT_LOGW_STR("Invalid parameter: field is NULL.");
		ret = -1;
		goto end;
	}

	field_type = bt_ctf_field_get_type(field);
	BT_ASSERT(field_type);

	if (bt_ctf_field_type_get_type_id(field_type) !=
			BT_CTF_FIELD_TYPE_ID_INTEGER) {
		/* Not an integer and the value is unset, error. */
		BT_LOGW("Invalid parameter: field's type is not an integer field type: "
			"field-addr=%p, ft-addr=%p, ft-id=%s",
			field, field_type,
			bt_ctf_field_type_id_string((int)
				bt_ctf_field_type_get_type_id(field_type)));
		ret = -1;
		goto end;
	}

	if (bt_ctf_field_type_integer_is_signed(field_type)) {
		ret = bt_ctf_field_integer_signed_set_value(field, (int64_t) value);
		if (ret) {
			/* Value is out of range, error. */
			BT_LOGW("Cannot set signed integer field's value: "
				"addr=%p, value=%" PRId64,
				field, (int64_t) value);
			goto end;
		}
	} else {
		ret = bt_ctf_field_integer_unsigned_set_value(field, value);
		if (ret) {
			/* Value is out of range, error. */
			BT_LOGW("Cannot set unsigned integer field's value: "
				"addr=%p, value=%" PRIu64,
				field, value);
			goto end;
		}
	}
end:
	bt_ctf_object_put_ref(field_type);
	return ret;
}

static
int set_packet_header_magic(struct bt_ctf_stream *stream)
{
	int ret = 0;
	struct bt_ctf_field *magic_field = bt_ctf_field_structure_get_field_by_name(
		stream->packet_header, "magic");
	const uint32_t magic_value = 0xc1fc1fc1;

	BT_ASSERT(stream);

	if (!magic_field) {
		/* No magic field found. Not an error, skip. */
		BT_LOGT("No field named `magic` in packet header: skipping: "
			"stream-addr=%p, stream-name=\"%s\"",
			stream, bt_ctf_stream_get_name(stream));
		goto end;
	}

	ret = bt_ctf_field_integer_unsigned_set_value(magic_field,
		(uint64_t) magic_value);

	if (ret) {
		BT_LOGW("Cannot set packet header field's `magic` integer field's value: "
			"stream-addr=%p, stream-name=\"%s\", field-addr=%p, value=%" PRIu64,
			stream, bt_ctf_stream_get_name(stream),
			magic_field, (uint64_t) magic_value);
	} else {
		BT_LOGT("Set packet header field's `magic` field's value: "
			"stream-addr=%p, stream-name=\"%s\", field-addr=%p, value=%" PRIu64,
			stream, bt_ctf_stream_get_name(stream),
			magic_field, (uint64_t) magic_value);
	}
end:
	bt_ctf_object_put_ref(magic_field);
	return ret;
}

static
int set_packet_header_uuid(struct bt_ctf_stream *stream)
{
	int ret = 0;
	int64_t i;
	struct bt_ctf_trace *trace = NULL;
	struct bt_ctf_field *uuid_field = bt_ctf_field_structure_get_field_by_name(
		stream->packet_header, "uuid");

	BT_ASSERT(stream);

	if (!uuid_field) {
		/* No uuid field found. Not an error, skip. */
		BT_LOGT("No field named `uuid` in packet header: skipping: "
			"stream-addr=%p, stream-name=\"%s\"",
			stream, bt_ctf_stream_get_name(stream));
		goto end;
	}

	trace = (struct bt_ctf_trace *)
		bt_ctf_object_get_parent(&stream->common.base);

	for (i = 0; i < 16; i++) {
		struct bt_ctf_field *uuid_element =
			bt_ctf_field_array_get_field(uuid_field, i);

		ret = bt_ctf_field_integer_unsigned_set_value(
			uuid_element, (uint64_t) trace->common.uuid[i]);
		bt_ctf_object_put_ref(uuid_element);
		if (ret) {
			BT_LOGW("Cannot set integer field's value (for `uuid` packet header field): "
				"stream-addr=%p, stream-name=\"%s\", field-addr=%p, "
				"value=%" PRIu64 ", index=%" PRId64,
				stream, bt_ctf_stream_get_name(stream),
				uuid_element, (uint64_t) trace->common.uuid[i], i);
			goto end;
		}
	}

	BT_LOGT("Set packet header field's `uuid` field's value: "
		"stream-addr=%p, stream-name=\"%s\", field-addr=%p",
		stream, bt_ctf_stream_get_name(stream), uuid_field);

end:
	bt_ctf_object_put_ref(uuid_field);
	BT_CTF_OBJECT_PUT_REF_AND_RESET(trace);
	return ret;
}
static
int set_packet_header_stream_id(struct bt_ctf_stream *stream)
{
	int ret = 0;
	uint32_t stream_id;
	struct bt_ctf_field *stream_id_field =
		bt_ctf_field_structure_get_field_by_name(
			stream->packet_header, "stream_id");

	if (!stream_id_field) {
		/* No stream_id field found. Not an error, skip. */
		BT_LOGT("No field named `stream_id` in packet header: skipping: "
			"stream-addr=%p, stream-name=\"%s\"",
			stream, bt_ctf_stream_get_name(stream));
		goto end;
	}

	stream_id = stream->common.stream_class->id;
	ret = bt_ctf_field_integer_unsigned_set_value(stream_id_field,
		(uint64_t) stream_id);
	if (ret) {
		BT_LOGW("Cannot set packet header field's `stream_id` integer field's value: "
			"stream-addr=%p, stream-name=\"%s\", field-addr=%p, value=%" PRIu64,
			stream, bt_ctf_stream_get_name(stream),
			stream_id_field, (uint64_t) stream_id);
	} else {
		BT_LOGT("Set packet header field's `stream_id` field's value: "
			"stream-addr=%p, stream-name=\"%s\", field-addr=%p, value=%" PRIu64,
			stream, bt_ctf_stream_get_name(stream),
			stream_id_field, (uint64_t) stream_id);
	}

end:
	bt_ctf_object_put_ref(stream_id_field);
	return ret;
}

static
int auto_populate_packet_header(struct bt_ctf_stream *stream)
{
	int ret = 0;

	if (!stream->packet_header) {
		goto end;
	}

	ret = set_packet_header_magic(stream);
	if (ret) {
		BT_LOGW("Cannot set packet header's magic number field: "
			"stream-addr=%p, stream-name=\"%s\"",
			stream, bt_ctf_stream_get_name(stream));
		goto end;
	}

	ret = set_packet_header_uuid(stream);
	if (ret) {
		BT_LOGW("Cannot set packet header's UUID field: "
			"stream-addr=%p, stream-name=\"%s\"",
			stream, bt_ctf_stream_get_name(stream));
		goto end;
	}

	ret = set_packet_header_stream_id(stream);
	if (ret) {
		BT_LOGW("Cannot set packet header's stream class ID field: "
			"stream-addr=%p, stream-name=\"%s\"",
			stream, bt_ctf_stream_get_name(stream));
		goto end;
	}

	BT_LOGT("Automatically populated stream's packet header's known fields: "
		"stream-addr=%p, stream-name=\"%s\"",
		stream, bt_ctf_stream_get_name(stream));

end:
	return ret;
}

static
int set_packet_context_packet_size(struct bt_ctf_stream *stream,
		uint64_t packet_size_bits)
{
	int ret = 0;
	struct bt_ctf_field *field = bt_ctf_field_structure_get_field_by_name(
		stream->packet_context, "packet_size");

	ret = bt_ctf_field_integer_unsigned_set_value(field, packet_size_bits);
	if (ret) {
		BT_LOGW("Cannot set packet context field's `packet_size` integer field's value: "
			"stream-addr=%p, stream-name=\"%s\", field-addr=%p, value=%" PRIu64,
			stream, bt_ctf_stream_get_name(stream),
			field, packet_size_bits);
	} else {
		BT_LOGT("Set packet context field's `packet_size` field's value: "
			"stream-addr=%p, stream-name=\"%s\", field-addr=%p, value=%" PRIu64,
			stream, bt_ctf_stream_get_name(stream),
			field, packet_size_bits);
	}

	bt_ctf_object_put_ref(field);
	return ret;
}

static
int set_packet_context_content_size(struct bt_ctf_stream *stream,
		uint64_t content_size_bits)
{
	int ret = 0;
	struct bt_ctf_field *field = bt_ctf_field_structure_get_field_by_name(
		stream->packet_context, "content_size");

	BT_ASSERT(stream);

	if (!field) {
		/* No content size field found. Not an error, skip. */
		BT_LOGT("No field named `content_size` in packet context: skipping: "
			"stream-addr=%p, stream-name=\"%s\"",
			stream, bt_ctf_stream_get_name(stream));
		goto end;
	}

	ret = bt_ctf_field_integer_unsigned_set_value(field, content_size_bits);
	if (ret) {
		BT_LOGW("Cannot set packet context field's `content_size` integer field's value: "
			"stream-addr=%p, stream-name=\"%s\", field-addr=%p, value=%" PRIu64,
			stream, bt_ctf_stream_get_name(stream),
			field, content_size_bits);
	} else {
		BT_LOGT("Set packet context field's `content_size` field's value: "
			"stream-addr=%p, stream-name=\"%s\", field-addr=%p, value=%" PRIu64,
			stream, bt_ctf_stream_get_name(stream),
			field, content_size_bits);
	}

end:
	bt_ctf_object_put_ref(field);
	return ret;
}

static
int set_packet_context_events_discarded(struct bt_ctf_stream *stream)
{
	int ret = 0;
	struct bt_ctf_field *field = bt_ctf_field_structure_get_field_by_name(
		stream->packet_context, "events_discarded");

	BT_ASSERT(stream);

	if (!field) {
		/* No discarded events count field found. Not an error, skip. */
		BT_LOGT("No field named `events_discarded` in packet context: skipping: "
			"stream-addr=%p, stream-name=\"%s\"",
			stream, bt_ctf_stream_get_name(stream));
		goto end;
	}

	/*
	 * If the field is set by the user, make sure that the value is
	 * greater than or equal to the stream's current count of
	 * discarded events. We do not allow wrapping here. If it's
	 * valid, update the stream's current count.
	 */
	if (bt_ctf_field_is_set_recursive(field)) {
		uint64_t user_val;

		ret = bt_ctf_field_integer_unsigned_get_value(field,
			&user_val);
		if (ret) {
			BT_LOGW("Cannot get packet context `events_discarded` field's unsigned value: "
				"stream-addr=%p, stream-name=\"%s\", field-addr=%p",
				stream, bt_ctf_stream_get_name(stream), field);
			goto end;
		}

		if (user_val < stream->discarded_events) {
			BT_LOGW("Invalid packet context `events_discarded` field's unsigned value: "
				"value is lesser than the stream's current discarded events count: "
				"stream-addr=%p, stream-name=\"%s\", field-addr=%p, "
				"value=%" PRIu64 ", "
				"stream-discarded-events-count=%" PRIu64,
				stream, bt_ctf_stream_get_name(stream), field,
				user_val, stream->discarded_events);
			goto end;
		}

		stream->discarded_events = user_val;
	} else {
		ret = bt_ctf_field_integer_unsigned_set_value(field,
			stream->discarded_events);
		if (ret) {
			BT_LOGW("Cannot set packet context field's `events_discarded` integer field's value: "
				"stream-addr=%p, stream-name=\"%s\", field-addr=%p, value=%" PRIu64,
				stream, bt_ctf_stream_get_name(stream),
				field, stream->discarded_events);
		} else {
			BT_LOGT("Set packet context field's `events_discarded` field's value: "
				"stream-addr=%p, stream-name=\"%s\", field-addr=%p, value=%" PRIu64,
				stream, bt_ctf_stream_get_name(stream),
				field, stream->discarded_events);
		}
	}

end:
	bt_ctf_object_put_ref(field);
	return ret;
}

static
void update_clock_value(uint64_t *val, uint64_t new_val,
		unsigned int new_val_size)
{
	const uint64_t pow2 = 1ULL << new_val_size;
	const uint64_t mask = pow2 - 1;
	uint64_t val_masked;

#ifdef BT_LOG_ENABLED_TRACE
	uint64_t old_val = *val;
#endif

	if (new_val_size == 64) {
		*val = new_val;
		goto end;
	}

	val_masked = *val & mask;

	if (new_val < val_masked) {
		/* Wrapped once */
		new_val |= pow2;
	}

	*val &= ~mask;
	*val |= new_val;

end:
	BT_LOGT("Updated clock value: old-val=%" PRIu64 ", new-val=%" PRIu64,
		old_val, *val);
	return;
}

static
int visit_field_update_clock_value(struct bt_ctf_field *field, uint64_t *val)
{
	int ret = 0;
	struct bt_ctf_field_common *field_common = (void *) field;

	if (!field) {
		goto end;
	}

	switch (bt_ctf_field_get_type_id(field)) {
	case BT_CTF_FIELD_TYPE_ID_INTEGER:
	{
		struct bt_ctf_clock_class *cc =
			bt_ctf_field_type_integer_get_mapped_clock_class(
				(void *) field_common->type);
		int val_size;
		uint64_t uval;

		if (!cc) {
			goto end;
		}

		bt_ctf_object_put_ref(cc);
		val_size = bt_ctf_field_type_integer_get_size(
			(void *) field_common->type);
		BT_ASSERT(val_size >= 1);

		if (bt_ctf_field_type_integer_is_signed(
				(void *) field_common->type)) {
			int64_t ival;

			ret = bt_ctf_field_integer_signed_get_value(field, &ival);
			uval = (uint64_t) ival;
		} else {
			ret = bt_ctf_field_integer_unsigned_get_value(field, &uval);
		}

		if (ret) {
			/* Not set */
			goto end;
		}

		update_clock_value(val, uval, val_size);
		break;
	}
	case BT_CTF_FIELD_TYPE_ID_ENUM:
	{
		struct bt_ctf_field *int_field =
			bt_ctf_field_enumeration_get_container(field);

		BT_ASSERT(int_field);
		ret = visit_field_update_clock_value(int_field, val);
		bt_ctf_object_put_ref(int_field);
		break;
	}
	case BT_CTF_FIELD_TYPE_ID_ARRAY:
	{
		uint64_t i;
		int64_t len = bt_ctf_field_type_array_get_length(
			(void *) field_common->type);

		BT_ASSERT(len >= 0);

		for (i = 0; i < len; i++) {
			struct bt_ctf_field *elem_field =
				bt_ctf_field_array_get_field(field, i);

			BT_ASSERT(elem_field);
			ret = visit_field_update_clock_value(elem_field, val);
			bt_ctf_object_put_ref(elem_field);
			if (ret) {
				goto end;
			}
		}
		break;
	}
	case BT_CTF_FIELD_TYPE_ID_SEQUENCE:
	{
		uint64_t i;
		int64_t len = bt_ctf_field_common_sequence_get_length(
			(void *) field);

		if (len < 0) {
			ret = -1;
			goto end;
		}

		for (i = 0; i < len; i++) {
			struct bt_ctf_field *elem_field =
				bt_ctf_field_sequence_get_field(field, i);

			BT_ASSERT(elem_field);
			ret = visit_field_update_clock_value(elem_field, val);
			bt_ctf_object_put_ref(elem_field);
			if (ret) {
				goto end;
			}
		}
		break;
	}
	case BT_CTF_FIELD_TYPE_ID_STRUCT:
	{
		uint64_t i;
		int64_t len = bt_ctf_field_type_structure_get_field_count(
			(void *) field_common->type);

		BT_ASSERT(len >= 0);

		for (i = 0; i < len; i++) {
			struct bt_ctf_field *member_field =
				bt_ctf_field_structure_get_field_by_index(field, i);

			BT_ASSERT(member_field);
			ret = visit_field_update_clock_value(member_field, val);
			bt_ctf_object_put_ref(member_field);
			if (ret) {
				goto end;
			}
		}
		break;
	}
	case BT_CTF_FIELD_TYPE_ID_VARIANT:
	{
		struct bt_ctf_field *cur_field =
			bt_ctf_field_variant_get_current_field(field);

		if (!cur_field) {
			ret = -1;
			goto end;
		}

		ret = visit_field_update_clock_value(cur_field, val);
		bt_ctf_object_put_ref(cur_field);
		break;
	}
	default:
		break;
	}

end:
	return ret;
}

int visit_event_update_clock_value(struct bt_ctf_event *event, uint64_t *val)
{
	int ret = 0;
	struct bt_ctf_field *field;

	field = bt_ctf_event_get_header(event);
	ret = visit_field_update_clock_value(field, val);
	bt_ctf_object_put_ref(field);
	if (ret) {
		BT_LOGW_STR("Cannot automatically update clock value in "
			"event's header.");
		goto end;
	}

	field = bt_ctf_event_get_stream_event_context(event);
	ret = visit_field_update_clock_value(field, val);
	bt_ctf_object_put_ref(field);
	if (ret) {
		BT_LOGW_STR("Cannot automatically update clock value in "
			"event's stream event context.");
		goto end;
	}

	field = bt_ctf_event_get_context(event);
	ret = visit_field_update_clock_value(field, val);
	bt_ctf_object_put_ref(field);
	if (ret) {
		BT_LOGW_STR("Cannot automatically update clock value in "
			"event's context.");
		goto end;
	}

	field = bt_ctf_event_get_payload_field(event);
	ret = visit_field_update_clock_value(field, val);
	bt_ctf_object_put_ref(field);
	if (ret) {
		BT_LOGW_STR("Cannot automatically update clock value in "
			"event's payload.");
		goto end;
	}

end:
	return ret;
}

static
int set_packet_context_timestamps(struct bt_ctf_stream *stream)
{
	int ret = 0;
	uint64_t val;
	uint64_t cur_clock_value;
	uint64_t init_clock_value = 0;
	struct bt_ctf_field *ts_begin_field = bt_ctf_field_structure_get_field_by_name(
		stream->packet_context, "timestamp_begin");
	struct bt_ctf_field *ts_end_field = bt_ctf_field_structure_get_field_by_name(
		stream->packet_context, "timestamp_end");
	struct bt_ctf_field_common *packet_context =
		(void *) stream->packet_context;
	uint64_t i;
	int64_t len;

	if (ts_begin_field && bt_ctf_field_is_set_recursive(ts_begin_field)) {
		/* Use provided `timestamp_begin` value as starting value */
		ret = bt_ctf_field_integer_unsigned_get_value(ts_begin_field, &val);
		BT_ASSERT(ret == 0);
		init_clock_value = val;
	} else if (stream->last_ts_end != -1ULL) {
		/* Use last packet's ending timestamp as starting value */
		init_clock_value = stream->last_ts_end;
	}

	cur_clock_value = init_clock_value;

	if (stream->last_ts_end != -1ULL &&
			cur_clock_value < stream->last_ts_end) {
		BT_LOGW("Packet's initial timestamp is less than previous "
			"packet's final timestamp: "
			"stream-addr=%p, stream-name=\"%s\", "
			"cur-packet-ts-begin=%" PRIu64 ", "
			"prev-packet-ts-end=%" PRIu64,
			stream, bt_ctf_stream_get_name(stream),
			cur_clock_value, stream->last_ts_end);
		ret = -1;
		goto end;
	}

	/*
	 * Visit all the packet context fields, followed by all the
	 * fields of all the events, in order, updating our current
	 * clock value as we visit.
	 *
	 * While visiting the packet context fields, do not consider
	 * `timestamp_begin` and `timestamp_end` because this function's
	 * purpose is to set them anyway. Also do not consider
	 * `packet_size`, `content_size`, `events_discarded`, and
	 * `packet_seq_num` if they are not set because those are
	 * autopopulating fields.
	 */
	len = bt_ctf_field_type_structure_get_field_count(
		(void *) packet_context->type);
	BT_ASSERT(len >= 0);

	for (i = 0; i < len; i++) {
		const char *member_name;
		struct bt_ctf_field *member_field;

		ret = bt_ctf_field_type_structure_get_field_by_index(
			(void *) packet_context->type, &member_name, NULL, i);
		BT_ASSERT(ret == 0);

		if (strcmp(member_name, "timestamp_begin") == 0 ||
				strcmp(member_name, "timestamp_end") == 0) {
			continue;
		}

		member_field = bt_ctf_field_structure_get_field_by_index(
			stream->packet_context, i);
		BT_ASSERT(member_field);

		if (strcmp(member_name, "packet_size") == 0 &&
				!bt_ctf_field_is_set_recursive(member_field)) {
			bt_ctf_object_put_ref(member_field);
			continue;
		}

		if (strcmp(member_name, "content_size") == 0 &&
				!bt_ctf_field_is_set_recursive(member_field)) {
			bt_ctf_object_put_ref(member_field);
			continue;
		}

		if (strcmp(member_name, "events_discarded") == 0 &&
				!bt_ctf_field_is_set_recursive(member_field)) {
			bt_ctf_object_put_ref(member_field);
			continue;
		}

		if (strcmp(member_name, "packet_seq_num") == 0 &&
				!bt_ctf_field_is_set_recursive(member_field)) {
			bt_ctf_object_put_ref(member_field);
			continue;
		}

		ret = visit_field_update_clock_value(member_field,
			&cur_clock_value);
		bt_ctf_object_put_ref(member_field);
		if (ret) {
			BT_LOGW("Cannot automatically update clock value "
				"in stream's packet context: "
				"stream-addr=%p, stream-name=\"%s\", "
				"field-name=\"%s\"",
				stream, bt_ctf_stream_get_name(stream),
				member_name);
			goto end;
		}
	}

	for (i = 0; i < stream->events->len; i++) {
		struct bt_ctf_event *event = g_ptr_array_index(stream->events, i);

		BT_ASSERT(event);
		ret = visit_event_update_clock_value(event, &cur_clock_value);
		if (ret) {
			BT_LOGW("Cannot automatically update clock value "
				"in stream's packet context: "
				"stream-addr=%p, stream-name=\"%s\", "
				"index=%" PRIu64 ", event-addr=%p, "
				"event-class-id=%" PRId64 ", "
				"event-class-name=\"%s\"",
				stream, bt_ctf_stream_get_name(stream),
				i, event,
				bt_ctf_event_class_common_get_id(event->common.class),
				bt_ctf_event_class_common_get_name(event->common.class));
			goto end;
		}
	}

	/*
	 * Everything is visited, thus the current clock value
	 * corresponds to the ending timestamp. Validate this value
	 * against the provided value of `timestamp_end`, if any,
	 * otherwise set it.
	 */
	if (ts_end_field && bt_ctf_field_is_set_recursive(ts_end_field)) {
		ret = bt_ctf_field_integer_unsigned_get_value(ts_end_field, &val);
		BT_ASSERT(ret == 0);

		if (val < cur_clock_value) {
			BT_LOGW("Packet's final timestamp is less than "
				"computed packet's final timestamp: "
				"stream-addr=%p, stream-name=\"%s\", "
				"cur-packet-ts-end=%" PRIu64 ", "
				"computed-packet-ts-end=%" PRIu64,
				stream, bt_ctf_stream_get_name(stream),
				val, cur_clock_value);
			ret = -1;
			goto end;
		}

		stream->last_ts_end = val;
	}

	if (ts_end_field && !bt_ctf_field_is_set_recursive(ts_end_field)) {
		ret = set_integer_field_value(ts_end_field, cur_clock_value);
		BT_ASSERT(ret == 0);
		stream->last_ts_end = cur_clock_value;
	}

	if (!ts_end_field) {
		stream->last_ts_end = cur_clock_value;
	}

	/* Set `timestamp_begin` field to initial clock value */
	if (ts_begin_field && !bt_ctf_field_is_set_recursive(ts_begin_field)) {
		ret = set_integer_field_value(ts_begin_field, init_clock_value);
		BT_ASSERT(ret == 0);
	}

end:
	bt_ctf_object_put_ref(ts_begin_field);
	bt_ctf_object_put_ref(ts_end_field);
	return ret;
}

static
int auto_populate_packet_context(struct bt_ctf_stream *stream, bool set_ts,
		uint64_t packet_size_bits, uint64_t content_size_bits)
{
	int ret = 0;

	if (!stream->packet_context) {
		goto end;
	}

	ret = set_packet_context_packet_size(stream, packet_size_bits);
	if (ret) {
		BT_LOGW("Cannot set packet context's packet size field: "
			"stream-addr=%p, stream-name=\"%s\"",
			stream, bt_ctf_stream_get_name(stream));
		goto end;
	}

	ret = set_packet_context_content_size(stream, content_size_bits);
	if (ret) {
		BT_LOGW("Cannot set packet context's content size field: "
			"stream-addr=%p, stream-name=\"%s\"",
			stream, bt_ctf_stream_get_name(stream));
		goto end;
	}

	if (set_ts) {
		ret = set_packet_context_timestamps(stream);
		if (ret) {
			BT_LOGW("Cannot set packet context's timestamp fields: "
				"stream-addr=%p, stream-name=\"%s\"",
				stream, bt_ctf_stream_get_name(stream));
			goto end;
		}
	}

	ret = set_packet_context_events_discarded(stream);
	if (ret) {
		BT_LOGW("Cannot set packet context's discarded events count field: "
			"stream-addr=%p, stream-name=\"%s\"",
			stream, bt_ctf_stream_get_name(stream));
		goto end;
	}

	BT_LOGT("Automatically populated stream's packet context's known fields: "
		"stream-addr=%p, stream-name=\"%s\"",
		stream, bt_ctf_stream_get_name(stream));

end:
	return ret;
}

static
void release_event(struct bt_ctf_event *event)
{
	if (bt_ctf_object_get_ref_count(&event->common.base)) {
		/*
		 * The event is being orphaned, but it must guarantee the
		 * existence of its event class for the duration of its
		 * lifetime.
		 */
		bt_ctf_object_get_ref(event->common.class);
		BT_CTF_OBJECT_PUT_REF_AND_RESET(event->common.base.parent);
	} else {
		bt_ctf_object_try_spec_release(&event->common.base);
	}
}

static
int create_stream_file(struct bt_ctf_writer *writer,
		struct bt_ctf_stream *stream)
{
	int ret = 0;
	GString *filename = g_string_new(NULL);
	int64_t stream_class_id;
	char *file_path = NULL;

	BT_LOGD("Creating stream file: writer-addr=%p, stream-addr=%p, "
		"stream-name=\"%s\", stream-class-addr=%p, stream-class-name=\"%s\"",
		writer, stream, bt_ctf_stream_get_name(stream),
		stream->common.stream_class,
		stream->common.stream_class->name->str);

	if (stream->common.name && stream->common.name->len > 0) {
		/* Use stream name's base name as prefix */
		gchar *basename = g_path_get_basename(stream->common.name->str);

		BT_ASSERT(basename);

		if (strcmp(basename, G_DIR_SEPARATOR_S) == 0) {
			g_string_assign(filename, "stream");
		} else {
			g_string_assign(filename, basename);
		}

		g_free(basename);
		goto append_ids;
	}

	if (stream->common.stream_class->name &&
			stream->common.stream_class->name->len > 0) {
		/* Use stream class name's base name as prefix */
		gchar *basename =
			g_path_get_basename(
				stream->common.stream_class->name->str);

		BT_ASSERT(basename);

		if (strcmp(basename, G_DIR_SEPARATOR_S) == 0) {
			g_string_assign(filename, "stream");
		} else {
			g_string_assign(filename, basename);
		}

		g_free(basename);
		goto append_ids;
	}

	/* Default to using `stream-` as prefix */
	g_string_assign(filename, "stream");

append_ids:
	stream_class_id = bt_ctf_stream_class_common_get_id(stream->common.stream_class);
	BT_ASSERT(stream_class_id >= 0);
	BT_ASSERT(stream->common.id >= 0);
	g_string_append_printf(filename, "-%" PRId64 "-%" PRId64,
		stream_class_id, stream->common.id);

	file_path = g_build_filename(writer->path->str, filename->str, NULL);
	if (file_path == NULL) {
		ret = -1;
		goto end;
	}

	ret = bt_ctfser_init(&stream->ctfser, file_path,
		BT_LOG_OUTPUT_LEVEL);
	g_free(file_path);
	if (ret) {
		/* bt_ctfser_init() logs errors */
		goto end;
	}

	BT_LOGD("Created stream file for writing: "
		"stream-addr=%p, stream-name=\"%s\", "
		"filename=\"%s\"", stream, bt_ctf_stream_get_name(stream),
		filename->str);

end:
	g_string_free(filename, TRUE);
	return ret;
}

BT_HIDDEN
struct bt_ctf_stream *bt_ctf_stream_create_with_id(
		struct bt_ctf_stream_class *stream_class,
		const char *name, uint64_t id)
{
	int ret;
	int fd;
	struct bt_ctf_stream *stream = NULL;
	struct bt_ctf_trace *trace = NULL;
	struct bt_ctf_writer *writer = NULL;

	BT_LOGD("Creating CTF writer stream object: stream-class-addr=%p, "
		"stream-class-name=\"%s\", stream-name=\"%s\", "
		"stream-id=%" PRIu64,
		stream_class, bt_ctf_stream_class_get_name(stream_class),
		name, id);
	stream = g_new0(struct bt_ctf_stream, 1);
	if (!stream) {
		BT_LOGE_STR("Failed to allocate one stream.");
		goto error;
	}

	if (id == -1ULL) {
		id = stream_class->next_stream_id;
	}

	ret = bt_ctf_stream_common_initialize(BT_CTF_TO_COMMON(stream),
		BT_CTF_TO_COMMON(stream_class), name, id, bt_ctf_stream_destroy);
	if (ret) {
		/* bt_ctf_stream_common_initialize() logs errors */
		goto error;
	}

	trace = BT_CTF_FROM_COMMON(bt_ctf_stream_class_common_borrow_trace(
		BT_CTF_TO_COMMON(stream_class)));
	if (!trace) {
		BT_LOGW("Invalid parameter: cannot create stream from a stream class which is not part of trace: "
			"stream-class-addr=%p, stream-class-name=\"%s\", "
			"stream-name=\"%s\"",
			stream_class, bt_ctf_stream_class_get_name(stream_class),
			name);
		goto error;
	}

	writer = (struct bt_ctf_writer *)
		bt_ctf_object_get_parent(&trace->common.base);
	stream->last_ts_end = -1ULL;
	BT_LOGD("CTF writer stream object belongs writer's trace: "
		"writer-addr=%p", writer);
	BT_ASSERT(writer);

	if (stream_class->common.packet_context_field_type) {
		BT_LOGD("Creating stream's packet context field: "
			"ft-addr=%p",
			stream_class->common.packet_context_field_type);
		stream->packet_context = bt_ctf_field_create(
			(void *) stream_class->common.packet_context_field_type);
		if (!stream->packet_context) {
			BT_LOGW_STR("Cannot create stream's packet context field.");
			goto error;
		}

		/* Initialize events_discarded */
		ret = try_set_structure_field_integer(
			stream->packet_context, "events_discarded", 0);
		if (ret < 0) {
			BT_LOGW("Cannot set `events_discarded` field in packet context: "
				"ret=%d, packet-context-field-addr=%p",
				ret, stream->packet_context);
			goto error;
		}
	}

	stream->events = g_ptr_array_new_with_free_func(
		(GDestroyNotify) release_event);
	if (!stream->events) {
		BT_LOGE_STR("Failed to allocate a GPtrArray.");
		goto error;
	}

	if (trace->common.packet_header_field_type) {
		BT_LOGD("Creating stream's packet header field: "
			"ft-addr=%p", trace->common.packet_header_field_type);
		stream->packet_header =
			bt_ctf_field_create(
				(void *) trace->common.packet_header_field_type);
		if (!stream->packet_header) {
			BT_LOGW_STR("Cannot create stream's packet header field.");
			goto error;
		}
	}

	/*
	 * Attempt to populate the default trace packet header fields
	 * (magic, uuid and stream_id). This will _not_ fail shall the
	 * fields not be found or be of an incompatible type; they will
	 * simply not be populated automatically. The user will have to
	 * make sure to set the trace packet header fields himself
	 * before flushing.
	 */
	ret = auto_populate_packet_header(stream);
	if (ret) {
		BT_LOGW_STR("Cannot automatically populate the stream's packet header.");
		goto error;
	}

	/* Create file associated with this stream */
	fd = create_stream_file(writer, stream);
	if (fd < 0) {
		BT_LOGW_STR("Cannot create stream file.");
		goto error;
	}

	/* Freeze the writer */
	BT_LOGD_STR("Freezing stream's CTF writer.");
	bt_ctf_writer_freeze(writer);

	/* Add this stream to the trace's streams */
	g_ptr_array_add(trace->common.streams, stream);
	stream_class->next_stream_id++;
	BT_LOGD("Created stream object: addr=%p", stream);
	goto end;

error:
	BT_CTF_OBJECT_PUT_REF_AND_RESET(stream);

end:
	bt_ctf_object_put_ref(writer);
	return stream;
}

struct bt_ctf_stream *bt_ctf_stream_create(
		struct bt_ctf_stream_class *stream_class,
		const char *name, uint64_t id_param)
{
	return bt_ctf_stream_create_with_id(stream_class,
		name, id_param);
}

int bt_ctf_stream_get_discarded_events_count(
		struct bt_ctf_stream *stream, uint64_t *count)
{
	int ret = 0;

	if (!stream) {
		BT_LOGW_STR("Invalid parameter: stream is NULL.");
		ret = -1;
		goto end;
	}

	if (!count) {
		BT_LOGW_STR("Invalid parameter: count is NULL.");
		ret = -1;
		goto end;
	}

	*count = (uint64_t) stream->discarded_events;

end:
	return ret;
}

static
int set_packet_context_events_discarded_field(struct bt_ctf_stream *stream,
	uint64_t count)
{
	int ret = 0;
	struct bt_ctf_field *events_discarded_field = NULL;

	if (!stream->packet_context) {
		goto end;
	}

	events_discarded_field = bt_ctf_field_structure_get_field_by_name(
		stream->packet_context, "events_discarded");
	if (!events_discarded_field) {
		goto end;
	}

	ret = bt_ctf_field_integer_unsigned_set_value(
		events_discarded_field, count);
	if (ret) {
		BT_LOGW("Cannot set packet context's `events_discarded` field: "
			"field-addr=%p, value=%" PRIu64,
			events_discarded_field, count);
		goto end;
	}

end:
	bt_ctf_object_put_ref(events_discarded_field);
	return ret;
}

void bt_ctf_stream_append_discarded_events(struct bt_ctf_stream *stream,
		uint64_t event_count)
{
	int ret;
	uint64_t new_count;
	struct bt_ctf_field *events_discarded_field = NULL;

	if (!stream) {
		BT_LOGW_STR("Invalid parameter: stream is NULL.");
		goto end;
	}

	BT_LOGT("Appending discarded events to stream: "
		"stream-addr=%p, stream-name=\"%s\", append-count=%" PRIu64,
		stream, bt_ctf_stream_get_name(stream), event_count);

	if (!stream->packet_context) {
		BT_LOGW_STR("Invalid parameter: stream has no packet context field.");
		goto end;
	}

	events_discarded_field = bt_ctf_field_structure_get_field_by_name(
		stream->packet_context, "events_discarded");
	if (!events_discarded_field) {
		BT_LOGW_STR("No field named `events_discarded` in stream's packet context.");
		goto end;
	}

	new_count = stream->discarded_events + event_count;
	if (new_count < stream->discarded_events) {
		BT_LOGW("New discarded events count is less than the stream's current discarded events count: "
			"cur-count=%" PRIu64 ", new-count=%" PRIu64,
			stream->discarded_events, new_count);
		goto end;
	}

	ret = set_packet_context_events_discarded_field(stream, new_count);
	if (ret) {
		/* set_packet_context_events_discarded_field() logs errors */
		goto end;
	}

	stream->discarded_events = new_count;
	BT_LOGT("Appended discarded events to stream: "
		"stream-addr=%p, stream-name=\"%s\", append-count=%" PRIu64,
		stream, bt_ctf_stream_get_name(stream), event_count);

end:
	bt_ctf_object_put_ref(events_discarded_field);
}

static int auto_populate_event_header(struct bt_ctf_stream *stream,
		struct bt_ctf_event *event)
{
	int ret = 0;
	struct bt_ctf_field *id_field = NULL, *timestamp_field = NULL;
	struct bt_ctf_clock_class *mapped_clock_class = NULL;
	struct bt_ctf_stream_class *stream_class =
		BT_CTF_FROM_COMMON(bt_ctf_stream_common_borrow_class(
			BT_CTF_TO_COMMON(stream)));
	int64_t event_class_id;

	BT_ASSERT(event);

	if (!event->common.header_field) {
		goto end;
	}

	if (event->common.frozen) {
		BT_LOGW_STR("Cannot populate event header field: event is frozen.");
		ret = -1;
		goto end;
	}

	BT_LOGT("Automatically populating event's header field: "
		"stream-addr=%p, stream-name=\"%s\", event-addr=%p",
		stream, bt_ctf_stream_get_name(stream), event);

	id_field = bt_ctf_field_structure_get_field_by_name(
		(void *) event->common.header_field->field, "id");
	event_class_id = bt_ctf_event_class_common_get_id(event->common.class);
	BT_ASSERT(event_class_id >= 0);

	if (id_field && bt_ctf_field_get_type_id(id_field) == BT_CTF_FIELD_TYPE_ID_INTEGER) {
		ret = set_integer_field_value(id_field, event_class_id);
		if (ret) {
			BT_LOGW("Cannot set event header's `id` field's value: "
				"addr=%p, value=%" PRIu64, id_field,
				event_class_id);
			goto end;
		}
	}

	/*
	 * The conditions to automatically set the timestamp are:
	 *
	 * 1. The event header field "timestamp" exists and is an
	 *    integer field.
	 * 2. This stream's class has a registered clock (set with
	 *    bt_ctf_stream_class_set_clock()).
	 * 3. The "timestamp" field is not set.
	 */
	timestamp_field = bt_ctf_field_structure_get_field_by_name(
			(void *) event->common.header_field->field, "timestamp");
	if (timestamp_field && stream_class->clock &&
			bt_ctf_field_get_type_id(id_field) == BT_CTF_FIELD_TYPE_ID_INTEGER &&
			!bt_ctf_field_is_set_recursive(timestamp_field)) {
		mapped_clock_class =
			bt_ctf_field_type_integer_get_mapped_clock_class(
				(void *) ((struct bt_ctf_field_common *) timestamp_field)->type);
		if (mapped_clock_class) {
			uint64_t timestamp;

			BT_ASSERT(mapped_clock_class ==
				stream_class->clock->clock_class);
			ret = bt_ctf_clock_get_value(
				stream_class->clock,
				&timestamp);
			BT_ASSERT(ret == 0);
			ret = set_integer_field_value(timestamp_field,
					timestamp);
			if (ret) {
				BT_LOGW("Cannot set event header's `timestamp` field's value: "
					"addr=%p, value=%" PRIu64,
					timestamp_field, timestamp);
				goto end;
			}
		}
	}

	BT_LOGT("Automatically populated event's header field: "
		"stream-addr=%p, stream-name=\"%s\", event-addr=%p",
		stream, bt_ctf_stream_get_name(stream), event);

end:
	bt_ctf_object_put_ref(id_field);
	bt_ctf_object_put_ref(timestamp_field);
	bt_ctf_object_put_ref(mapped_clock_class);
	return ret;
}

int bt_ctf_stream_append_event(struct bt_ctf_stream *stream,
		struct bt_ctf_event *event)
{
	int ret = 0;

	if (!stream) {
		BT_LOGW_STR("Invalid parameter: stream is NULL.");
		ret = -1;
		goto end;
	}

	if (!event) {
		BT_LOGW_STR("Invalid parameter: event is NULL.");
		ret = -1;
		goto end;
	}

	BT_LOGT("Appending event to stream: "
		"stream-addr=%p, stream-name=\"%s\", event-addr=%p, "
		"event-class-name=\"%s\", event-class-id=%" PRId64,
		stream, bt_ctf_stream_get_name(stream), event,
		bt_ctf_event_class_common_get_name(
			bt_ctf_event_common_borrow_class(BT_CTF_TO_COMMON(event))),
		bt_ctf_event_class_common_get_id(
			bt_ctf_event_common_borrow_class(BT_CTF_TO_COMMON(event))));

	/*
	 * The event is not supposed to have a parent stream at this
	 * point. The only other way an event can have a parent stream
	 * is if it was assigned when setting a packet to the event,
	 * in which case the packet's stream is not a writer stream,
	 * and thus the user is trying to append an event which belongs
	 * to another stream.
	 */
	if (event->common.base.parent) {
		ret = -1;
		goto end;
	}

	bt_ctf_object_set_parent(&event->common.base, &stream->common.base);
	BT_LOGT_STR("Automatically populating the header of the event to append.");
	ret = auto_populate_event_header(stream, event);
	if (ret) {
		/* auto_populate_event_header() reports errors */
		goto error;
	}

	/* Make sure the various scopes of the event are set */
	BT_LOGT_STR("Validating event to append.");
	BT_CTF_ASSERT_PRE(bt_ctf_event_common_validate(BT_CTF_TO_COMMON(event)) == 0,
		"Invalid event: event-addr=%p", event);

	/* Save the new event and freeze it */
	BT_LOGT_STR("Freezing the event to append.");
	bt_ctf_event_common_set_is_frozen(BT_CTF_TO_COMMON(event), true);
	g_ptr_array_add(stream->events, event);

	/*
	 * Event had to hold a reference to its event class as long as it wasn't
	 * part of the same trace hierarchy. From now on, the event and its
	 * class share the same lifetime guarantees and the reference is no
	 * longer needed.
	 */
	BT_LOGT_STR("Putting the event's class.");
	bt_ctf_object_put_ref(event->common.class);
	BT_LOGT("Appended event to stream: "
		"stream-addr=%p, stream-name=\"%s\", event-addr=%p, "
		"event-class-name=\"%s\", event-class-id=%" PRId64,
		stream, bt_ctf_stream_get_name(stream), event,
		bt_ctf_event_class_common_get_name(
			bt_ctf_event_common_borrow_class(BT_CTF_TO_COMMON(event))),
		bt_ctf_event_class_common_get_id(
			bt_ctf_event_common_borrow_class(BT_CTF_TO_COMMON(event))));

end:
	return ret;

error:
	/*
	 * Orphan the event; we were not successful in associating it to
	 * a stream.
	 */
	bt_ctf_object_set_parent(&event->common.base, NULL);
	return ret;
}

struct bt_ctf_field *bt_ctf_stream_get_packet_context(struct bt_ctf_stream *stream)
{
	struct bt_ctf_field *packet_context = NULL;

	if (!stream) {
		BT_LOGW_STR("Invalid parameter: stream is NULL.");
		goto end;
	}

	packet_context = stream->packet_context;
	if (packet_context) {
		bt_ctf_object_get_ref(packet_context);
	}
end:
	return packet_context;
}

int bt_ctf_stream_set_packet_context(struct bt_ctf_stream *stream,
		struct bt_ctf_field *field)
{
	int ret = 0;
	struct bt_ctf_field_type *field_type;

	if (!stream) {
		BT_LOGW_STR("Invalid parameter: stream is NULL.");
		ret = -1;
		goto end;
	}

	field_type = bt_ctf_field_get_type(field);
	if (bt_ctf_field_type_common_compare((void *) field_type,
			stream->common.stream_class->packet_context_field_type)) {
		BT_LOGW("Invalid parameter: packet context's field type is different from the stream's packet context field type: "
			"stream-addr=%p, stream-name=\"%s\", "
			"packet-context-field-addr=%p, "
			"packet-context-ft-addr=%p",
			stream, bt_ctf_stream_get_name(stream),
			field, field_type);
		ret = -1;
		goto end;
	}

	bt_ctf_object_put_ref(field_type);
	bt_ctf_object_put_ref(stream->packet_context);
	stream->packet_context = bt_ctf_object_get_ref(field);
	BT_LOGT("Set stream's packet context field: "
		"stream-addr=%p, stream-name=\"%s\", "
		"packet-context-field-addr=%p",
		stream, bt_ctf_stream_get_name(stream), field);
end:
	return ret;
}

struct bt_ctf_field *bt_ctf_stream_get_packet_header(struct bt_ctf_stream *stream)
{
	struct bt_ctf_field *packet_header = NULL;

	if (!stream) {
		BT_LOGW_STR("Invalid parameter: stream is NULL.");
		goto end;
	}

	packet_header = stream->packet_header;
	if (packet_header) {
		bt_ctf_object_get_ref(packet_header);
	}
end:
	return packet_header;
}

int bt_ctf_stream_set_packet_header(struct bt_ctf_stream *stream,
		struct bt_ctf_field *field)
{
	int ret = 0;
	struct bt_ctf_trace *trace = NULL;
	struct bt_ctf_field_type *field_type = NULL;

	if (!stream) {
		BT_LOGW_STR("Invalid parameter: stream is NULL.");
		ret = -1;
		goto end;
	}

	trace = (struct bt_ctf_trace *)
		bt_ctf_object_get_parent(&stream->common.base);

	if (!field) {
		if (trace->common.packet_header_field_type) {
			BT_LOGW("Invalid parameter: setting no packet header but packet header field type is not NULL: "
				"stream-addr=%p, stream-name=\"%s\", "
				"packet-header-field-addr=%p, "
				"expected-ft-addr=%p",
				stream, bt_ctf_stream_get_name(stream),
				field, trace->common.packet_header_field_type);
			ret = -1;
			goto end;
		}

		goto skip_validation;
	}

	field_type = bt_ctf_field_get_type(field);
	BT_ASSERT(field_type);

	if (bt_ctf_field_type_common_compare((void *) field_type,
			trace->common.packet_header_field_type)) {
		BT_LOGW("Invalid parameter: packet header's field type is different from the stream's packet header field type: "
			"stream-addr=%p, stream-name=\"%s\", "
			"packet-header-field-addr=%p, "
			"packet-header-ft-addr=%p",
			stream, bt_ctf_stream_get_name(stream),
			field, field_type);
		ret = -1;
		goto end;
	}

skip_validation:
	bt_ctf_object_put_ref(stream->packet_header);
	stream->packet_header = bt_ctf_object_get_ref(field);
	BT_LOGT("Set stream's packet header field: "
		"stream-addr=%p, stream-name=\"%s\", "
		"packet-header-field-addr=%p",
		stream, bt_ctf_stream_get_name(stream), field);
end:
	BT_CTF_OBJECT_PUT_REF_AND_RESET(trace);
	bt_ctf_object_put_ref(field_type);
	return ret;
}

static
void reset_structure_field(struct bt_ctf_field *structure, const char *name)
{
	struct bt_ctf_field *member;

	member = bt_ctf_field_structure_get_field_by_name(structure, name);
	if (member) {
		bt_ctf_field_common_reset_recursive((void *) member);
		bt_ctf_object_put_ref(member);
	}
}

int bt_ctf_stream_flush(struct bt_ctf_stream *stream)
{
	int ret = 0;
	size_t i;
	uint64_t packet_context_offset_bits = 0;
	struct bt_ctf_trace *trace;
	enum bt_ctf_byte_order native_byte_order;
	bool has_packet_size = false;
	uint64_t packet_size_bits = 0;
	uint64_t content_size_bits = 0;

	if (!stream) {
		BT_LOGW_STR("Invalid parameter: stream is NULL.");
		ret = -1;
		goto end_no_stream;
	}

	if (stream->packet_context) {
		struct bt_ctf_field *packet_size_field;

		packet_size_field = bt_ctf_field_structure_get_field_by_name(
				stream->packet_context, "packet_size");
		has_packet_size = (packet_size_field != NULL);
		bt_ctf_object_put_ref(packet_size_field);
	}

	if (stream->flushed_packet_count == 1) {
		if (!stream->packet_context) {
			BT_LOGW_STR("Cannot flush a stream which has no packet context field more than once.");
			ret = -1;
			goto end;
		}

		if (!has_packet_size) {
			BT_LOGW_STR("Cannot flush a stream which has no packet context's `packet_size` field more than once.");
			ret = -1;
			goto end;
		}
	}

	BT_LOGT("Flushing stream's current packet: stream-addr=%p, "
		"stream-name=\"%s\", packet-index=%u", stream,
		bt_ctf_stream_get_name(stream), stream->flushed_packet_count);
	trace = BT_CTF_FROM_COMMON(bt_ctf_stream_class_common_borrow_trace(
		stream->common.stream_class));
	BT_ASSERT(trace);
	native_byte_order = bt_ctf_trace_get_native_byte_order(trace);

	ret = auto_populate_packet_header(stream);
	if (ret) {
		BT_LOGW_STR("Cannot automatically populate the stream's packet header field.");
		ret = -1;
		goto end;
	}

	/* Initialize packet/content sizes to `0`; we will overwrite later */
	ret = auto_populate_packet_context(stream, true, 0, 0);
	if (ret) {
		BT_LOGW_STR("Cannot automatically populate the stream's packet context field.");
		ret = -1;
		goto end;
	}

	ret = bt_ctfser_open_packet(&stream->ctfser);
	if (ret) {
		/* bt_ctfser_open_packet() logs errors */
		ret = -1;
		goto end;
	}

	if (stream->packet_header) {
		BT_LOGT_STR("Serializing packet header field (initial).");
		ret = bt_ctf_field_serialize_recursive(stream->packet_header,
			&stream->ctfser, native_byte_order);
		if (ret) {
			BT_LOGW("Cannot serialize stream's packet header field: "
				"field-addr=%p", stream->packet_header);
			goto end;
		}
	}

	if (stream->packet_context) {
		/* Save packet context's position to overwrite it later */
		packet_context_offset_bits =
			bt_ctfser_get_offset_in_current_packet_bits(
				&stream->ctfser);

		/* Write packet context */
		BT_LOGT_STR("Serializing packet context field (initial).");
		ret = bt_ctf_field_serialize_recursive(stream->packet_context,
			&stream->ctfser, native_byte_order);
		if (ret) {
			BT_LOGW("Cannot serialize stream's packet context field: "
				"field-addr=%p", stream->packet_context);
			goto end;
		}
	}

	BT_LOGT("Serializing events: count=%u", stream->events->len);

	for (i = 0; i < stream->events->len; i++) {
		struct bt_ctf_event *event = g_ptr_array_index(
			stream->events, i);
		struct bt_ctf_event_class *event_class =
			BT_CTF_FROM_COMMON(bt_ctf_event_common_borrow_class(
				BT_CTF_TO_COMMON(event)));

		BT_LOGT("Serializing event: index=%zu, event-addr=%p, "
			"event-class-name=\"%s\", event-class-id=%" PRId64 ", "
			"ser-offset=%" PRIu64,
			i, event, bt_ctf_event_class_get_name(event_class),
			bt_ctf_event_class_get_id(event_class),
			bt_ctfser_get_offset_in_current_packet_bits(
				&stream->ctfser));

		/* Write event header */
		if (event->common.header_field) {
			BT_LOGT_STR("Serializing event's header field.");
			ret = bt_ctf_field_serialize_recursive(
				(void *) event->common.header_field->field,
				&stream->ctfser, native_byte_order);
			if (ret) {
				BT_LOGW("Cannot serialize event's header field: "
					"field-addr=%p",
					event->common.header_field->field);
				goto end;
			}
		}

		/* Write stream event context */
		if (event->common.stream_event_context_field) {
			BT_LOGT_STR("Serializing event's stream event context field.");
			ret = bt_ctf_field_serialize_recursive(
				(void *) event->common.stream_event_context_field,
				&stream->ctfser, native_byte_order);
			if (ret) {
				BT_LOGW("Cannot serialize event's stream event context field: "
					"field-addr=%p",
					event->common.stream_event_context_field);
				goto end;
			}
		}

		/* Write event content */
		ret = bt_ctf_event_serialize(event, &stream->ctfser,
			native_byte_order);
		if (ret) {
			/* bt_ctf_event_serialize() logs errors */
			goto end;
		}
	}

	content_size_bits = bt_ctfser_get_offset_in_current_packet_bits(
		&stream->ctfser);

	if (!has_packet_size && content_size_bits % 8 != 0) {
		BT_LOGW("Stream's packet context field type has no `packet_size` field, "
			"but current content size is not a multiple of 8 bits: "
			"content-size=%" PRIu64 ", "
			"packet-size=%" PRIu64,
			content_size_bits,
			packet_size_bits);
		ret = -1;
		goto end;
	}

	/* Set packet size; make it a multiple of 8 */
	packet_size_bits = (content_size_bits + 7) & ~UINT64_C(7);

	if (stream->packet_context) {
		/*
		 * The whole packet is serialized at this point. Make
		 * sure that, if `packet_size` is missing, the current
		 * content size is equal to the current packet size.
		 */
		struct bt_ctf_field *field =
			bt_ctf_field_structure_get_field_by_name(
				stream->packet_context, "content_size");

		bt_ctf_object_put_ref(field);
		if (!field) {
			if (content_size_bits != packet_size_bits) {
				BT_LOGW("Stream's packet context's `content_size` field is missing, "
					"but current packet's content size is not equal to its packet size: "
					"content-size=%" PRIu64 ", "
					"packet-size=%" PRIu64,
					bt_ctfser_get_offset_in_current_packet_bits(&stream->ctfser),
					packet_size_bits);
				ret = -1;
				goto end;
			}
		}

		/*
		 * Overwrite the packet context now that the stream
		 * position's packet and content sizes have the correct
		 * values.
		 */
		bt_ctfser_set_offset_in_current_packet_bits(&stream->ctfser,
			packet_context_offset_bits);
		ret = auto_populate_packet_context(stream, false,
			packet_size_bits, content_size_bits);
		if (ret) {
			BT_LOGW_STR("Cannot automatically populate the stream's packet context field.");
			ret = -1;
			goto end;
		}

		BT_LOGT("Rewriting (serializing) packet context field.");
		ret = bt_ctf_field_serialize_recursive(stream->packet_context,
			&stream->ctfser, native_byte_order);
		if (ret) {
			BT_LOGW("Cannot serialize stream's packet context field: "
				"field-addr=%p", stream->packet_context);
			goto end;
		}
	}

	g_ptr_array_set_size(stream->events, 0);
	stream->flushed_packet_count++;
	bt_ctfser_close_current_packet(&stream->ctfser, packet_size_bits / 8);

end:
	/* Reset automatically-set fields. */
	if (stream->packet_context) {
		reset_structure_field(stream->packet_context, "timestamp_begin");
		reset_structure_field(stream->packet_context, "timestamp_end");
		reset_structure_field(stream->packet_context, "packet_size");
		reset_structure_field(stream->packet_context, "content_size");
		reset_structure_field(stream->packet_context, "events_discarded");
	}

	if (ret == 0) {
		BT_LOGT("Flushed stream's current packet: "
			"content-size=%" PRIu64 ", packet-size=%" PRIu64,
			content_size_bits, packet_size_bits);
	}

end_no_stream:
	return ret;
}

static
void bt_ctf_stream_destroy(struct bt_ctf_object *obj)
{
	struct bt_ctf_stream *stream = (void *) obj;

	BT_LOGD("Destroying CTF writer stream object: addr=%p, name=\"%s\"",
		stream, bt_ctf_stream_get_name(stream));

	bt_ctf_stream_common_finalize(BT_CTF_TO_COMMON(stream));
	bt_ctfser_fini(&stream->ctfser);

	if (stream->events) {
		BT_LOGD_STR("Putting events.");
		g_ptr_array_free(stream->events, TRUE);
	}

	BT_LOGD_STR("Putting packet header field.");
	bt_ctf_object_put_ref(stream->packet_header);
	BT_LOGD_STR("Putting packet context field.");
	bt_ctf_object_put_ref(stream->packet_context);
	g_free(stream);
}

static
int _set_structure_field_integer(struct bt_ctf_field *structure, char *name,
		uint64_t value, bt_bool force)
{
	int ret = 0;
	struct bt_ctf_field_type *field_type = NULL;
	struct bt_ctf_field *integer;

	BT_ASSERT(structure);
	BT_ASSERT(name);

	integer = bt_ctf_field_structure_get_field_by_name(structure, name);
	if (!integer) {
		/* Field not found, not an error. */
		BT_LOGT("Field not found: struct-field-addr=%p, "
			"name=\"%s\", force=%d", structure, name, force);
		goto end;
	}

	/* Make sure the payload has not already been set. */
	if (!force && bt_ctf_field_is_set_recursive(integer)) {
		/* Payload already set, not an error */
		BT_LOGT("Field's payload is already set: struct-field-addr=%p, "
			"name=\"%s\", force=%d", structure, name, force);
		goto end;
	}

	field_type = bt_ctf_field_get_type(integer);
	BT_ASSERT(field_type);
	if (bt_ctf_field_type_get_type_id(field_type) != BT_CTF_FIELD_TYPE_ID_INTEGER) {
		/*
		 * The user most likely meant for us to populate this field
		 * automatically. However, we can only do this if the field
		 * is an integer. Return an error.
		 */
		BT_LOGW("Invalid parameter: field's type is not an integer field type: "
			"field-addr=%p, ft-addr=%p, ft-id=%s",
			integer, field_type,
			bt_ctf_field_type_id_string((int)
				bt_ctf_field_type_get_type_id(field_type)));
		ret = -1;
		goto end;
	}

	if (bt_ctf_field_type_integer_is_signed(field_type)) {
		ret = bt_ctf_field_integer_signed_set_value(integer,
			(int64_t) value);
	} else {
		ret = bt_ctf_field_integer_unsigned_set_value(integer, value);
	}
	ret = !ret ? 1 : ret;
end:
	bt_ctf_object_put_ref(integer);
	bt_ctf_object_put_ref(field_type);
	return ret;
}

/*
 * Returns the following codes:
 * 1 if the field was found and set,
 * 0 if nothing was done (field not found, or was already set),
 * <0 if an error was encoutered
 */
static
int try_set_structure_field_integer(struct bt_ctf_field *structure, char *name,
		uint64_t value)
{
	return _set_structure_field_integer(structure, name, value, BT_FALSE);
}

struct bt_ctf_stream_class *bt_ctf_stream_get_class(
		struct bt_ctf_stream *stream)
{
	return bt_ctf_object_get_ref(bt_ctf_stream_common_borrow_class(BT_CTF_TO_COMMON(stream)));
}

const char *bt_ctf_stream_get_name(struct bt_ctf_stream *stream)
{
	return bt_ctf_stream_common_get_name(BT_CTF_TO_COMMON(stream));
}

int64_t bt_ctf_stream_get_id(struct bt_ctf_stream *stream)
{
	return bt_ctf_stream_common_get_id(BT_CTF_TO_COMMON(stream));
}