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

/*
 * SPDX-License-Identifier: MIT
 *
 * Copyright 2013, 2014 Jérémie Galarneau <jeremie.galarneau@efficios.com>
 */

#define BT_LOG_TAG "CTF-WRITER/FIELDS"
#include "logging.h"

#include <float.h>
#include <inttypes.h>
#include <stdbool.h>
#include <stdlib.h>

#include <babeltrace2-ctf-writer/object.h>

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

#include "assert-pre.h"
#include "fields.h"
#include "field-types.h"
#include "object.h"

#define BT_CTF_ASSERT_PRE_CTF_FIELD_IS_INT_OR_ENUM(_field, _name)		\
	BT_CTF_ASSERT_PRE((_field)->type->id == BT_CTF_FIELD_TYPE_ID_INTEGER || \
		(_field)->type->id == BT_CTF_FIELD_TYPE_ID_ENUM,	\
		_name " is not an integer or an enumeration field: "	\
		"field-addr=%p", (_field))

BT_HIDDEN
struct bt_ctf_field_common *bt_ctf_field_common_copy(struct bt_ctf_field_common *field)
{
	struct bt_ctf_field_common *copy = NULL;

	BT_CTF_ASSERT_PRE_NON_NULL(field, "Field");
	BT_ASSERT_DBG(field_type_common_has_known_id(field->type));
	BT_ASSERT_DBG(field->methods->copy);
	copy = field->methods->copy(field);
	if (!copy) {
		BT_LOGW("Cannot create field: ft-addr=%p", field->type);
		goto end;
	}

	bt_ctf_field_common_set(copy, field->payload_set);

end:
	return copy;
}

BT_HIDDEN
int bt_ctf_field_common_structure_initialize(struct bt_ctf_field_common *field,
		struct bt_ctf_field_type_common *type,
		bool is_shared, bt_ctf_object_release_func release_func,
		struct bt_ctf_field_common_methods *methods,
		bt_ctf_field_common_create_func field_create_func,
		GDestroyNotify field_release_func)
{
	int ret = 0;
	struct bt_ctf_field_type_common_structure *structure_type =
		BT_CTF_FROM_COMMON(type);
	struct bt_ctf_field_common_structure *structure = BT_CTF_FROM_COMMON(field);
	size_t i;

	BT_LOGD("Initializing common structure field object: ft-addr=%p", type);
	bt_ctf_field_common_initialize(field, type, is_shared,
		release_func, methods);
	structure->fields = g_ptr_array_new_with_free_func(field_release_func);
	g_ptr_array_set_size(structure->fields, structure_type->fields->len);

	/* Create all fields contained in the structure field. */
	for (i = 0; i < structure_type->fields->len; i++) {
		struct bt_ctf_field_common *member_field;
		struct bt_ctf_field_type_common_structure_field *struct_field =
			BT_CTF_FIELD_TYPE_COMMON_STRUCTURE_FIELD_AT_INDEX(
				structure_type, i);
		member_field = field_create_func(struct_field->type);
		if (!member_field) {
			BT_LOGE("Failed to create structure field's member: name=\"%s\", index=%zu",
				g_quark_to_string(struct_field->name), i);
			ret = -1;
			goto end;
		}

		g_ptr_array_index(structure->fields, i) = member_field;
	}

	BT_LOGD("Initialized common structure field object: addr=%p, ft-addr=%p",
		field, type);

end:
	return ret;
}

BT_HIDDEN
int bt_ctf_field_common_variant_initialize(struct bt_ctf_field_common *field,
		struct bt_ctf_field_type_common *type,
		bool is_shared, bt_ctf_object_release_func release_func,
		struct bt_ctf_field_common_methods *methods,
		bt_ctf_field_common_create_func field_create_func,
		GDestroyNotify field_release_func)
{
	int ret = 0;
	struct bt_ctf_field_type_common_variant *variant_type =
		BT_CTF_FROM_COMMON(type);
	struct bt_ctf_field_common_variant *variant = BT_CTF_FROM_COMMON(field);
	size_t i;

	BT_LOGD("Initializing common variant field object: ft-addr=%p", type);
	bt_ctf_field_common_initialize(field, type, is_shared,
		release_func, methods);
	ret = bt_ctf_field_type_common_variant_update_choices(type);
	if (ret) {
		BT_LOGE("Cannot update common variant field type choices: "
			"ret=%d", ret);
		goto end;
	}

	variant->fields = g_ptr_array_new_with_free_func(field_release_func);
	g_ptr_array_set_size(variant->fields, variant_type->choices->len);

	/* Create all fields contained in the variant field. */
	for (i = 0; i < variant_type->choices->len; i++) {
		struct bt_ctf_field_common *member_field;
		struct bt_ctf_field_type_common_variant_choice *var_choice =
			BT_CTF_FIELD_TYPE_COMMON_VARIANT_CHOICE_AT_INDEX(
				variant_type, i);

		member_field = field_create_func(var_choice->type);
		if (!member_field) {
			BT_LOGE("Failed to create variant field's member: name=\"%s\", index=%zu",
				g_quark_to_string(var_choice->name), i);
			ret = -1;
			goto end;
		}

		g_ptr_array_index(variant->fields, i) = member_field;
	}

	BT_LOGD("Initialized common variant field object: addr=%p, ft-addr=%p",
		field, type);

end:
	return ret;
}

BT_HIDDEN
int bt_ctf_field_common_string_initialize(struct bt_ctf_field_common *field,
		struct bt_ctf_field_type_common *type,
		bool is_shared, bt_ctf_object_release_func release_func,
		struct bt_ctf_field_common_methods *methods)
{
	int ret = 0;
	struct bt_ctf_field_common_string *string = BT_CTF_FROM_COMMON(field);

	BT_LOGD("Initializing common string field object: ft-addr=%p", type);
	bt_ctf_field_common_initialize(field, type, is_shared,
		release_func, methods);
	string->buf = g_array_sized_new(FALSE, FALSE, sizeof(char), 1);
	if (!string->buf) {
		ret = -1;
		goto end;
	}

	g_array_index(string->buf, char, 0) = '\0';
	BT_LOGD("Initialized common string field object: addr=%p, ft-addr=%p",
		field, type);

end:
	return ret;
}

BT_HIDDEN
int bt_ctf_field_common_array_initialize(struct bt_ctf_field_common *field,
		struct bt_ctf_field_type_common *type,
		bool is_shared, bt_ctf_object_release_func release_func,
		struct bt_ctf_field_common_methods *methods,
		bt_ctf_field_common_create_func field_create_func,
		GDestroyNotify field_destroy_func)
{
	struct bt_ctf_field_type_common_array *array_type = BT_CTF_FROM_COMMON(type);
	struct bt_ctf_field_common_array *array = BT_CTF_FROM_COMMON(field);
	unsigned int array_length;
	int ret = 0;
	uint64_t i;

	BT_LOGD("Initializing common array field object: ft-addr=%p", type);
	BT_ASSERT_DBG(type);
	bt_ctf_field_common_initialize(field, type, is_shared,
		release_func, methods);
	array_length = array_type->length;
	array->elements = g_ptr_array_sized_new(array_length);
	if (!array->elements) {
		ret = -1;
		goto end;
	}

	g_ptr_array_set_free_func(array->elements, field_destroy_func);
	g_ptr_array_set_size(array->elements, array_length);

	for (i = 0; i < array_length; i++) {
		array->elements->pdata[i] = field_create_func(
			array_type->element_ft);
		if (!array->elements->pdata[i]) {
			ret = -1;
			goto end;
		}
	}

	BT_LOGD("Initialized common array field object: addr=%p, ft-addr=%p",
		field, type);

end:
	return ret;
}

BT_HIDDEN
int bt_ctf_field_common_sequence_initialize(struct bt_ctf_field_common *field,
		struct bt_ctf_field_type_common *type,
		bool is_shared, bt_ctf_object_release_func release_func,
		struct bt_ctf_field_common_methods *methods,
		GDestroyNotify field_destroy_func)
{
	struct bt_ctf_field_common_sequence *sequence = BT_CTF_FROM_COMMON(field);
	int ret = 0;

	BT_LOGD("Initializing common sequence field object: ft-addr=%p", type);
	BT_ASSERT_DBG(type);
	bt_ctf_field_common_initialize(field, type, is_shared,
		release_func, methods);
	sequence->elements = g_ptr_array_new();
	if (!sequence->elements) {
		ret = -1;
		goto end;
	}

	g_ptr_array_set_free_func(sequence->elements, field_destroy_func);
	BT_LOGD("Initialized common sequence field object: addr=%p, ft-addr=%p",
		field, type);

end:
	return ret;
}

BT_HIDDEN
int bt_ctf_field_common_generic_validate(struct bt_ctf_field_common *field)
{
	return (field && field->payload_set) ? 0 : -1;
}

BT_HIDDEN
int bt_ctf_field_common_structure_validate_recursive(struct bt_ctf_field_common *field)
{
	int64_t i;
	int ret = 0;
	struct bt_ctf_field_common_structure *structure = BT_CTF_FROM_COMMON(field);

	BT_ASSERT_DBG(field);

	for (i = 0; i < structure->fields->len; i++) {
		ret = bt_ctf_field_common_validate_recursive(
			(void *) structure->fields->pdata[i]);

		if (ret) {
			int this_ret;
			const char *name;

			this_ret = bt_ctf_field_type_common_structure_borrow_field_by_index(
				field->type, &name, NULL, i);
			BT_ASSERT_DBG(this_ret == 0);
			BT_CTF_ASSERT_PRE_MSG("Invalid structure field's field: "
				"struct-field-addr=%p, field-name=\"%s\", "
				"index=%" PRId64 ", field-addr=%p",
				field, name, i, structure->fields->pdata[i]);
			goto end;
		}
	}

end:
	return ret;
}

BT_HIDDEN
int bt_ctf_field_common_variant_validate_recursive(struct bt_ctf_field_common *field)
{
	int ret = 0;
	struct bt_ctf_field_common_variant *variant = BT_CTF_FROM_COMMON(field);

	BT_ASSERT_DBG(field);

	if (!variant->current_field) {
		ret = -1;
		goto end;
	}

	ret = bt_ctf_field_common_validate_recursive(variant->current_field);

end:
	return ret;
}

BT_HIDDEN
int bt_ctf_field_common_array_validate_recursive(struct bt_ctf_field_common *field)
{
	int64_t i;
	int ret = 0;
	struct bt_ctf_field_common_array *array = BT_CTF_FROM_COMMON(field);

	BT_ASSERT_DBG(field);

	for (i = 0; i < array->elements->len; i++) {
		ret = bt_ctf_field_common_validate_recursive((void *) array->elements->pdata[i]);
		if (ret) {
			BT_CTF_ASSERT_PRE_MSG("Invalid array field's element field: "
				"array-field-addr=%p, %" PRId64 ", "
				"elem-field-addr=%p",
				field, i, array->elements->pdata[i]);
			goto end;
		}
	}

end:
	return ret;
}

BT_HIDDEN
int bt_ctf_field_common_sequence_validate_recursive(struct bt_ctf_field_common *field)
{
	int64_t i;
	int ret = 0;
	struct bt_ctf_field_common_sequence *sequence = BT_CTF_FROM_COMMON(field);

	BT_ASSERT_DBG(field);

	for (i = 0; i < sequence->elements->len; i++) {
		ret = bt_ctf_field_common_validate_recursive(
			(void *) sequence->elements->pdata[i]);
		if (ret) {
			BT_CTF_ASSERT_PRE_MSG("Invalid sequence field's element field: "
				"seq-field-addr=%p, %" PRId64 ", "
				"elem-field-addr=%p",
				field, i, sequence->elements->pdata[i]);
			goto end;
		}
	}
end:
	return ret;
}

BT_HIDDEN
void bt_ctf_field_common_generic_reset(struct bt_ctf_field_common *field)
{
	BT_ASSERT_DBG(field);
	field->payload_set = false;
}

BT_HIDDEN
void bt_ctf_field_common_structure_reset_recursive(struct bt_ctf_field_common *field)
{
	int64_t i;
	struct bt_ctf_field_common_structure *structure = BT_CTF_FROM_COMMON(field);

	BT_ASSERT_DBG(field);

	for (i = 0; i < structure->fields->len; i++) {
		struct bt_ctf_field_common *member = structure->fields->pdata[i];

		if (!member) {
			/*
			 * Structure members are lazily initialized;
			 * skip if this member has not been allocated
			 * yet.
			 */
			continue;
		}

		bt_ctf_field_common_reset_recursive(member);
	}
}

BT_HIDDEN
void bt_ctf_field_common_variant_reset_recursive(struct bt_ctf_field_common *field)
{
	struct bt_ctf_field_common_variant *variant = BT_CTF_FROM_COMMON(field);

	BT_ASSERT_DBG(field);
	variant->current_field = NULL;
}

BT_HIDDEN
void bt_ctf_field_common_array_reset_recursive(struct bt_ctf_field_common *field)
{
	size_t i;
	struct bt_ctf_field_common_array *array = BT_CTF_FROM_COMMON(field);

	BT_ASSERT_DBG(field);

	for (i = 0; i < array->elements->len; i++) {
		struct bt_ctf_field_common *member = array->elements->pdata[i];

		if (!member) {
			/*
			 * Array elements are lazily initialized; skip
			 * if this member has not been allocated yet.
			 */
			continue;
		}

		bt_ctf_field_common_reset_recursive(member);
	}
}

BT_HIDDEN
void bt_ctf_field_common_sequence_reset_recursive(struct bt_ctf_field_common *field)
{
	struct bt_ctf_field_common_sequence *sequence = BT_CTF_FROM_COMMON(field);
	uint64_t i;

	BT_ASSERT_DBG(field);

	for (i = 0; i < sequence->elements->len; i++) {
		if (sequence->elements->pdata[i]) {
			bt_ctf_field_common_reset_recursive(
				sequence->elements->pdata[i]);
		}
	}

	sequence->length = 0;
}

BT_HIDDEN
void bt_ctf_field_common_generic_set_is_frozen(struct bt_ctf_field_common *field,
		bool is_frozen)
{
	field->frozen = is_frozen;
}

BT_HIDDEN
void bt_ctf_field_common_structure_set_is_frozen_recursive(
		struct bt_ctf_field_common *field, bool is_frozen)
{
	uint64_t i;
	struct bt_ctf_field_common_structure *structure_field =
		BT_CTF_FROM_COMMON(field);

	BT_LOGD("Freezing structure field object: addr=%p", field);

	for (i = 0; i < structure_field->fields->len; i++) {
		struct bt_ctf_field_common *struct_field =
			g_ptr_array_index(structure_field->fields, i);

		BT_LOGD("Freezing structure field's field: field-addr=%p, index=%" PRId64,
			struct_field, i);
		bt_ctf_field_common_set_is_frozen_recursive(struct_field,
			is_frozen);
	}

	bt_ctf_field_common_generic_set_is_frozen(field, is_frozen);
}

BT_HIDDEN
void bt_ctf_field_common_variant_set_is_frozen_recursive(
		struct bt_ctf_field_common *field, bool is_frozen)
{
	uint64_t i;
	struct bt_ctf_field_common_variant *variant_field = BT_CTF_FROM_COMMON(field);

	BT_LOGD("Freezing variant field object: addr=%p", field);

	for (i = 0; i < variant_field->fields->len; i++) {
		struct bt_ctf_field_common *var_field =
			g_ptr_array_index(variant_field->fields, i);

		BT_LOGD("Freezing variant field's field: field-addr=%p, index=%" PRId64,
			var_field, i);
		bt_ctf_field_common_set_is_frozen_recursive(var_field, is_frozen);
	}

	bt_ctf_field_common_generic_set_is_frozen(field, is_frozen);
}

BT_HIDDEN
void bt_ctf_field_common_array_set_is_frozen_recursive(
		struct bt_ctf_field_common *field, bool is_frozen)
{
	int64_t i;
	struct bt_ctf_field_common_array *array_field = BT_CTF_FROM_COMMON(field);

	BT_LOGD("Freezing array field object: addr=%p", field);

	for (i = 0; i < array_field->elements->len; i++) {
		struct bt_ctf_field_common *elem_field =
			g_ptr_array_index(array_field->elements, i);

		BT_LOGD("Freezing array field object's element field: "
			"element-field-addr=%p, index=%" PRId64,
			elem_field, i);
		bt_ctf_field_common_set_is_frozen_recursive(elem_field, is_frozen);
	}

	bt_ctf_field_common_generic_set_is_frozen(field, is_frozen);
}

BT_HIDDEN
void bt_ctf_field_common_sequence_set_is_frozen_recursive(
		struct bt_ctf_field_common *field, bool is_frozen)
{
	int64_t i;
	struct bt_ctf_field_common_sequence *sequence_field =
		BT_CTF_FROM_COMMON(field);

	BT_LOGD("Freezing sequence field object: addr=%p", field);

	for (i = 0; i < sequence_field->length; i++) {
		struct bt_ctf_field_common *elem_field =
			g_ptr_array_index(sequence_field->elements, i);

		BT_LOGD("Freezing sequence field object's element field: "
			"element-field-addr=%p, index=%" PRId64,
			elem_field, i);
		bt_ctf_field_common_set_is_frozen_recursive(elem_field, is_frozen);
	}

	bt_ctf_field_common_generic_set_is_frozen(field, is_frozen);
}

BT_HIDDEN
void _bt_ctf_field_common_set_is_frozen_recursive(struct bt_ctf_field_common *field,
		bool is_frozen)
{
	if (!field) {
		goto end;
	}

	BT_LOGD("Setting field object's frozen state: addr=%p, is-frozen=%d",
		field, is_frozen);
	BT_ASSERT_DBG(field_type_common_has_known_id(field->type));
	BT_ASSERT_DBG(field->methods->set_is_frozen);
	field->methods->set_is_frozen(field, is_frozen);

end:
	return;
}

BT_HIDDEN
bt_ctf_bool bt_ctf_field_common_generic_is_set(struct bt_ctf_field_common *field)
{
	return field && field->payload_set;
}

BT_HIDDEN
bt_ctf_bool bt_ctf_field_common_structure_is_set_recursive(
		struct bt_ctf_field_common *field)
{
	bt_ctf_bool is_set = BT_CTF_FALSE;
	size_t i;
	struct bt_ctf_field_common_structure *structure = BT_CTF_FROM_COMMON(field);

	BT_ASSERT_DBG(field);

	for (i = 0; i < structure->fields->len; i++) {
		is_set = bt_ctf_field_common_is_set_recursive(
			structure->fields->pdata[i]);
		if (!is_set) {
			goto end;
		}
	}

end:
	return is_set;
}

BT_HIDDEN
bt_ctf_bool bt_ctf_field_common_variant_is_set_recursive(struct bt_ctf_field_common *field)
{
	struct bt_ctf_field_common_variant *variant = BT_CTF_FROM_COMMON(field);
	bt_ctf_bool is_set = BT_CTF_FALSE;

	BT_ASSERT_DBG(field);

	if (variant->current_field) {
		is_set = bt_ctf_field_common_is_set_recursive(
			variant->current_field);
	}

	return is_set;
}

BT_HIDDEN
bt_ctf_bool bt_ctf_field_common_array_is_set_recursive(struct bt_ctf_field_common *field)
{
	size_t i;
	bt_ctf_bool is_set = BT_CTF_FALSE;
	struct bt_ctf_field_common_array *array = BT_CTF_FROM_COMMON(field);

	BT_ASSERT_DBG(field);

	for (i = 0; i < array->elements->len; i++) {
		is_set = bt_ctf_field_common_is_set_recursive(array->elements->pdata[i]);
		if (!is_set) {
			goto end;
		}
	}

end:
	return is_set;
}

BT_HIDDEN
bt_ctf_bool bt_ctf_field_common_sequence_is_set_recursive(struct bt_ctf_field_common *field)
{
	size_t i;
	bt_ctf_bool is_set = BT_CTF_FALSE;
	struct bt_ctf_field_common_sequence *sequence = BT_CTF_FROM_COMMON(field);

	BT_ASSERT_DBG(field);

	if (!sequence->elements) {
		goto end;
	}

	for (i = 0; i < sequence->elements->len; i++) {
		is_set = bt_ctf_field_common_is_set_recursive(
			sequence->elements->pdata[i]);
		if (!is_set) {
			goto end;
		}
	}

end:
	return is_set;
}

static struct bt_ctf_field_common_methods bt_ctf_field_integer_methods = {
	.set_is_frozen = bt_ctf_field_common_generic_set_is_frozen,
	.validate = bt_ctf_field_common_generic_validate,
	.copy = NULL,
	.is_set = bt_ctf_field_common_generic_is_set,
	.reset = bt_ctf_field_common_generic_reset,
};

static struct bt_ctf_field_common_methods bt_ctf_field_floating_point_methods = {
	.set_is_frozen = bt_ctf_field_common_generic_set_is_frozen,
	.validate = bt_ctf_field_common_generic_validate,
	.copy = NULL,
	.is_set = bt_ctf_field_common_generic_is_set,
	.reset = bt_ctf_field_common_generic_reset,
};

static
void bt_ctf_field_enumeration_set_is_frozen_recursive(
		struct bt_ctf_field_common *field, bool is_frozen);

static
int bt_ctf_field_enumeration_validate_recursive(struct bt_ctf_field_common *field);

static
bt_ctf_bool bt_ctf_field_enumeration_is_set_recursive(
		struct bt_ctf_field_common *field);

static
void bt_ctf_field_enumeration_reset_recursive(struct bt_ctf_field_common *field);

static struct bt_ctf_field_common_methods bt_ctf_field_enumeration_methods = {
	.set_is_frozen = bt_ctf_field_enumeration_set_is_frozen_recursive,
	.validate = bt_ctf_field_enumeration_validate_recursive,
	.copy = NULL,
	.is_set = bt_ctf_field_enumeration_is_set_recursive,
	.reset = bt_ctf_field_enumeration_reset_recursive,
};

static struct bt_ctf_field_common_methods bt_ctf_field_string_methods = {
	.set_is_frozen = bt_ctf_field_common_generic_set_is_frozen,
	.validate = bt_ctf_field_common_generic_validate,
	.copy = NULL,
	.is_set = bt_ctf_field_common_generic_is_set,
	.reset = bt_ctf_field_common_generic_reset,
};

static struct bt_ctf_field_common_methods bt_ctf_field_structure_methods = {
	.set_is_frozen = bt_ctf_field_common_structure_set_is_frozen_recursive,
	.validate = bt_ctf_field_common_structure_validate_recursive,
	.copy = NULL,
	.is_set = bt_ctf_field_common_structure_is_set_recursive,
	.reset = bt_ctf_field_common_structure_reset_recursive,
};

static struct bt_ctf_field_common_methods bt_ctf_field_sequence_methods = {
	.set_is_frozen = bt_ctf_field_common_sequence_set_is_frozen_recursive,
	.validate = bt_ctf_field_common_sequence_validate_recursive,
	.copy = NULL,
	.is_set = bt_ctf_field_common_sequence_is_set_recursive,
	.reset = bt_ctf_field_common_sequence_reset_recursive,
};

static struct bt_ctf_field_common_methods bt_ctf_field_array_methods = {
	.set_is_frozen = bt_ctf_field_common_array_set_is_frozen_recursive,
	.validate = bt_ctf_field_common_array_validate_recursive,
	.copy = NULL,
	.is_set = bt_ctf_field_common_array_is_set_recursive,
	.reset = bt_ctf_field_common_array_reset_recursive,
};

static
void bt_ctf_field_variant_set_is_frozen_recursive(struct bt_ctf_field_common *field,
		bool is_frozen);

static
int bt_ctf_field_variant_validate_recursive(struct bt_ctf_field_common *field);

static
bt_ctf_bool bt_ctf_field_variant_is_set_recursive(struct bt_ctf_field_common *field);

static
void bt_ctf_field_variant_reset_recursive(struct bt_ctf_field_common *field);

static struct bt_ctf_field_common_methods bt_ctf_field_variant_methods = {
	.set_is_frozen = bt_ctf_field_variant_set_is_frozen_recursive,
	.validate = bt_ctf_field_variant_validate_recursive,
	.copy = NULL,
	.is_set = bt_ctf_field_variant_is_set_recursive,
	.reset = bt_ctf_field_variant_reset_recursive,
};

static
struct bt_ctf_field *bt_ctf_field_integer_create(struct bt_ctf_field_type *);

static
struct bt_ctf_field *bt_ctf_field_enumeration_create(struct bt_ctf_field_type *);

static
struct bt_ctf_field *bt_ctf_field_floating_point_create(struct bt_ctf_field_type *);

static
struct bt_ctf_field *bt_ctf_field_structure_create(struct bt_ctf_field_type *);

static
struct bt_ctf_field *bt_ctf_field_variant_create(struct bt_ctf_field_type *);

static
struct bt_ctf_field *bt_ctf_field_array_create(struct bt_ctf_field_type *);

static
struct bt_ctf_field *bt_ctf_field_sequence_create(struct bt_ctf_field_type *);

static
struct bt_ctf_field *bt_ctf_field_string_create(struct bt_ctf_field_type *);

static
struct bt_ctf_field *(* const field_create_funcs[])(struct bt_ctf_field_type *) = {
	[BT_CTF_FIELD_TYPE_ID_INTEGER] =	bt_ctf_field_integer_create,
	[BT_CTF_FIELD_TYPE_ID_ENUM] =		bt_ctf_field_enumeration_create,
	[BT_CTF_FIELD_TYPE_ID_FLOAT] =		bt_ctf_field_floating_point_create,
	[BT_CTF_FIELD_TYPE_ID_STRUCT] =		bt_ctf_field_structure_create,
	[BT_CTF_FIELD_TYPE_ID_VARIANT] =	bt_ctf_field_variant_create,
	[BT_CTF_FIELD_TYPE_ID_ARRAY] =		bt_ctf_field_array_create,
	[BT_CTF_FIELD_TYPE_ID_SEQUENCE] =	bt_ctf_field_sequence_create,
	[BT_CTF_FIELD_TYPE_ID_STRING] =		bt_ctf_field_string_create,
};

typedef int (*bt_ctf_field_serialize_recursive_func)(
		struct bt_ctf_field_common *, struct bt_ctfser *,
		enum bt_ctf_byte_order);

static
void bt_ctf_field_integer_destroy(struct bt_ctf_field *field)
{
	BT_LOGD("Destroying CTF writer integer field object: addr=%p", field);
	bt_ctf_field_common_integer_finalize((void *) field);
	g_free(field);
}

static
void bt_ctf_field_floating_point_destroy(struct bt_ctf_field *field)
{
	BT_LOGD("Destroying CTF writer floating point field object: addr=%p",
		field);
	bt_ctf_field_common_floating_point_finalize((void *) field);
	g_free(field);
}

static
void bt_ctf_field_enumeration_destroy_recursive(struct bt_ctf_field *field)
{
	struct bt_ctf_field_enumeration *enumeration = BT_CTF_FROM_COMMON(field);

	BT_LOGD("Destroying CTF writer enumeration field object: addr=%p",
		field);
	BT_LOGD_STR("Putting container field.");
	bt_ctf_object_put_ref(enumeration->container);
	bt_ctf_field_common_finalize((void *) field);
	g_free(field);
}

static
void bt_ctf_field_structure_destroy_recursive(struct bt_ctf_field *field)
{
	BT_LOGD("Destroying CTF writer structure field object: addr=%p", field);
	bt_ctf_field_common_structure_finalize_recursive((void *) field);
	g_free(field);
}

static
void bt_ctf_field_variant_destroy_recursive(struct bt_ctf_field *field)
{
	struct bt_ctf_field_variant *variant = BT_CTF_FROM_COMMON(field);

	BT_LOGD("Destroying CTF writer variant field object: addr=%p", field);
	BT_LOGD_STR("Putting tag field.");
	bt_ctf_object_put_ref(variant->tag);
	bt_ctf_field_common_variant_finalize_recursive((void *) field);
	g_free(field);
}

static
void bt_ctf_field_array_destroy_recursive(struct bt_ctf_field *field)
{
	BT_LOGD("Destroying CTF writer array field object: addr=%p", field);
	bt_ctf_field_common_array_finalize_recursive((void *) field);
	g_free(field);
}

static
void bt_ctf_field_sequence_destroy_recursive(struct bt_ctf_field *field)
{
	BT_LOGD("Destroying CTF writer sequence field object: addr=%p", field);
	bt_ctf_field_common_sequence_finalize_recursive((void *) field);
	g_free(field);
}

static
void bt_ctf_field_string_destroy(struct bt_ctf_field *field)
{
	BT_LOGD("Destroying CTF writer string field object: addr=%p", field);
	bt_ctf_field_common_string_finalize((void *) field);
	g_free(field);
}

BT_HIDDEN
int bt_ctf_field_serialize_recursive(struct bt_ctf_field *field,
		struct bt_ctfser *ctfser,
		enum bt_ctf_byte_order native_byte_order)
{
	struct bt_ctf_field_common *field_common = (void *) field;
	bt_ctf_field_serialize_recursive_func serialize_func;

	BT_ASSERT_DBG(ctfser);
	BT_CTF_ASSERT_PRE_NON_NULL(field, "Field");
	BT_ASSERT_DBG(field_common->spec.writer.serialize_func);
	serialize_func = field_common->spec.writer.serialize_func;
	return serialize_func(field_common, ctfser,
		native_byte_order);
}

static
int bt_ctf_field_integer_serialize(struct bt_ctf_field_common *field,
		struct bt_ctfser *ctfser,
		enum bt_ctf_byte_order native_byte_order)
{
	int ret;
	struct bt_ctf_field_type_common_integer *int_type =
		BT_CTF_FROM_COMMON(field->type);
	struct bt_ctf_field_common_integer *int_field =
		BT_CTF_FROM_COMMON(field);
	enum bt_ctf_byte_order byte_order;

	BT_CTF_ASSERT_PRE_CTF_FIELD_COMMON_IS_SET(field, "Integer field");
	BT_LOGT("Serializing CTF writer integer field: addr=%p, native-bo=%s",
		field,
		bt_ctf_byte_order_string(native_byte_order));
	byte_order = int_type->user_byte_order;
	if (byte_order == BT_CTF_BYTE_ORDER_NATIVE) {
		byte_order = native_byte_order;
	}

	if (int_type->is_signed) {
		ret = bt_ctfser_write_signed_int(ctfser,
			int_field->payload.signd, int_type->common.alignment,
			int_type->size,
			byte_order == BT_CTF_BYTE_ORDER_LITTLE_ENDIAN ?
				LITTLE_ENDIAN : BIG_ENDIAN);
	} else {
		ret = bt_ctfser_write_unsigned_int(ctfser,
			int_field->payload.unsignd, int_type->common.alignment,
			int_type->size,
			byte_order == BT_CTF_BYTE_ORDER_LITTLE_ENDIAN ?
				LITTLE_ENDIAN : BIG_ENDIAN);
	}

	if (G_UNLIKELY(ret)) {
		BT_LOGE("Cannot serialize integer field: ret=%d", ret);
		goto end;
	}

end:
	return ret;
}

static
int bt_ctf_field_enumeration_serialize_recursive(
		struct bt_ctf_field_common *field, struct bt_ctfser *ctfser,
		enum bt_ctf_byte_order native_byte_order)
{
	struct bt_ctf_field_enumeration *enumeration = (void *) field;

	BT_LOGT("Serializing enumeration field: addr=%p, native-bo=%s",
		field, bt_ctf_byte_order_string(native_byte_order));
	BT_LOGT_STR("Serializing enumeration field's payload field.");
	return bt_ctf_field_serialize_recursive(
		(void *) enumeration->container, ctfser, native_byte_order);
}

static
int bt_ctf_field_floating_point_serialize(struct bt_ctf_field_common *field,
		struct bt_ctfser *ctfser,
		enum bt_ctf_byte_order native_byte_order)
{
	int ret = -1;
	struct bt_ctf_field_type_common_floating_point *flt_type =
		BT_CTF_FROM_COMMON(field->type);
	struct bt_ctf_field_common_floating_point *flt_field = BT_CTF_FROM_COMMON(field);
	enum bt_ctf_byte_order byte_order;

	BT_CTF_ASSERT_PRE_CTF_FIELD_COMMON_IS_SET(field, "Floating point number field");
	BT_LOGT("Serializing floating point number field: "
		"addr=%p, native-bo=%s", field,
		bt_ctf_byte_order_string(native_byte_order));

	byte_order = flt_type->user_byte_order;
	if (byte_order == BT_CTF_BYTE_ORDER_NATIVE) {
		byte_order = native_byte_order;
	}

	if (flt_type->mant_dig == FLT_MANT_DIG) {
		ret = bt_ctfser_write_float32(ctfser, flt_field->payload,
			flt_type->common.alignment,
			byte_order == BT_CTF_BYTE_ORDER_LITTLE_ENDIAN ?
				LITTLE_ENDIAN : BIG_ENDIAN);
	} else if (flt_type->mant_dig == DBL_MANT_DIG) {
		ret = bt_ctfser_write_float64(ctfser, flt_field->payload,
			flt_type->common.alignment,
			byte_order == BT_CTF_BYTE_ORDER_LITTLE_ENDIAN ?
				LITTLE_ENDIAN : BIG_ENDIAN);
	} else {
		bt_common_abort();
	}

	if (G_UNLIKELY(ret)) {
		BT_LOGE("Cannot serialize floating point number field: "
			"ret=%d", ret);
		goto end;
	}

end:
	return ret;
}

static
int bt_ctf_field_structure_serialize_recursive(struct bt_ctf_field_common *field,
		struct bt_ctfser *ctfser,
		enum bt_ctf_byte_order native_byte_order)
{
	int64_t i;
	int ret;
	struct bt_ctf_field_common_structure *structure = BT_CTF_FROM_COMMON(field);

	BT_LOGT("Serializing structure field: addr=%p, native-bo=%s",
		field, bt_ctf_byte_order_string(native_byte_order));
	ret = bt_ctfser_align_offset_in_current_packet(ctfser,
		field->type->alignment);
	if (G_UNLIKELY(ret)) {
		BT_LOGE("Cannot align offset before serializing structure field: "
			"ret=%d", ret);
		goto end;
	}

	for (i = 0; i < structure->fields->len; i++) {
		struct bt_ctf_field_common *member = g_ptr_array_index(
			structure->fields, i);
		const char *field_name = NULL;

		BT_LOGT("Serializing structure field's field: ser-offset=%" PRIu64 ", "
			"field-addr=%p, index=%" PRIu64,
			bt_ctfser_get_offset_in_current_packet_bits(ctfser),
			member, i);

		if (G_UNLIKELY(!member)) {
			ret = bt_ctf_field_type_common_structure_borrow_field_by_index(
				field->type, &field_name, NULL, i);
			BT_ASSERT_DBG(ret == 0);
			BT_LOGW("Cannot serialize structure field's field: field is not set: "
				"struct-field-addr=%p, "
				"field-name=\"%s\", index=%" PRId64,
				field, field_name, i);
			ret = -1;
			goto end;
		}

		ret = bt_ctf_field_serialize_recursive((void *) member, ctfser,
			native_byte_order);
		if (G_UNLIKELY(ret)) {
			ret = bt_ctf_field_type_common_structure_borrow_field_by_index(
				field->type, &field_name, NULL, i);
			BT_ASSERT_DBG(ret == 0);
			BT_LOGW("Cannot serialize structure field's field: "
				"struct-field-addr=%p, field-addr=%p, "
				"field-name=\"%s\", index=%" PRId64,
				field->type, member, field_name, i);
			break;
		}
	}

end:
	return ret;
}

static
int bt_ctf_field_variant_serialize_recursive(struct bt_ctf_field_common *field,
		struct bt_ctfser *ctfser,
		enum bt_ctf_byte_order native_byte_order)
{
	struct bt_ctf_field_common_variant *variant = BT_CTF_FROM_COMMON(field);

	BT_LOGT("Serializing variant field: addr=%p, native-bo=%s",
		field, bt_ctf_byte_order_string(native_byte_order));
	BT_LOGT_STR("Serializing variant field's payload field.");
	return bt_ctf_field_serialize_recursive(
		(void *) variant->current_field, ctfser, native_byte_order);
}

static
int bt_ctf_field_array_serialize_recursive(struct bt_ctf_field_common *field,
		struct bt_ctfser *ctfser,
		enum bt_ctf_byte_order native_byte_order)
{
	int64_t i;
	int ret = 0;
	struct bt_ctf_field_common_array *array = BT_CTF_FROM_COMMON(field);

	BT_LOGT("Serializing array field: addr=%p, native-bo=%s",
		field, bt_ctf_byte_order_string(native_byte_order));

	for (i = 0; i < array->elements->len; i++) {
		struct bt_ctf_field_common *elem_field =
			g_ptr_array_index(array->elements, i);

		BT_LOGT("Serializing array field's element field: "
			"ser-offset=%" PRIu64 ", field-addr=%p, index=%" PRId64,
			bt_ctfser_get_offset_in_current_packet_bits(ctfser),
			elem_field, i);
		ret = bt_ctf_field_serialize_recursive(
			(void *) elem_field, ctfser, native_byte_order);
		if (G_UNLIKELY(ret)) {
			BT_LOGW("Cannot serialize array field's element field: "
				"array-field-addr=%p, field-addr=%p, "
				"index=%" PRId64, field, elem_field, i);
			goto end;
		}
	}

end:
	return ret;
}

static
int bt_ctf_field_sequence_serialize_recursive(struct bt_ctf_field_common *field,
		struct bt_ctfser *ctfser,
		enum bt_ctf_byte_order native_byte_order)
{
	int64_t i;
	int ret = 0;
	struct bt_ctf_field_common_sequence *sequence = BT_CTF_FROM_COMMON(field);

	BT_LOGT("Serializing sequence field: addr=%p, native-bo=%s",
		field, bt_ctf_byte_order_string(native_byte_order));

	for (i = 0; i < sequence->elements->len; i++) {
		struct bt_ctf_field_common *elem_field =
			g_ptr_array_index(sequence->elements, i);

		BT_LOGT("Serializing sequence field's element field: "
			"ser-offset=%" PRIu64 ", field-addr=%p, index=%" PRId64,
			bt_ctfser_get_offset_in_current_packet_bits(ctfser),
			elem_field, i);
		ret = bt_ctf_field_serialize_recursive(
			(void *) elem_field, ctfser, native_byte_order);
		if (G_UNLIKELY(ret)) {
			BT_LOGW("Cannot serialize sequence field's element field: "
				"sequence-field-addr=%p, field-addr=%p, "
				"index=%" PRId64, field, elem_field, i);
			goto end;
		}
	}

end:
	return ret;
}

static
int bt_ctf_field_string_serialize(struct bt_ctf_field_common *field,
		struct bt_ctfser *ctfser,
		enum bt_ctf_byte_order native_byte_order)
{
	int ret;
	struct bt_ctf_field_common_string *string = BT_CTF_FROM_COMMON(field);

	BT_CTF_ASSERT_PRE_CTF_FIELD_COMMON_IS_SET(field, "String field");
	BT_LOGT("Serializing string field: addr=%p, native-bo=%s",
		field, bt_ctf_byte_order_string((int) native_byte_order));
	ret = bt_ctfser_write_string(ctfser, (const char *) string->buf->data);
	if (G_UNLIKELY(ret)) {
		BT_LOGE("Cannot serialize string field: ret=%d", ret);
		goto end;
	}

end:
	return ret;
}

struct bt_ctf_field *bt_ctf_field_create(struct bt_ctf_field_type *type)
{
	struct bt_ctf_field *field = NULL;
	enum bt_ctf_field_type_id type_id;

	BT_CTF_ASSERT_PRE_NON_NULL(type, "Field type");
	BT_ASSERT_DBG(field_type_common_has_known_id((void *) type));
	BT_CTF_ASSERT_PRE(bt_ctf_field_type_common_validate((void *) type) == 0,
		"Field type is invalid: ft-addr=%p", type);
	type_id = bt_ctf_field_type_get_type_id(type);
	field = field_create_funcs[type_id](type);
	if (!field) {
		goto end;
	}

	bt_ctf_field_type_common_freeze((void *) type);

end:
	return field;
}

struct bt_ctf_field_type *bt_ctf_field_get_type(struct bt_ctf_field *field)
{
	return bt_ctf_object_get_ref(bt_ctf_field_common_borrow_type((void *) field));
}

enum bt_ctf_field_type_id bt_ctf_field_get_type_id(struct bt_ctf_field *field)
{
	struct bt_ctf_field_common *field_common = (void *) field;

	BT_CTF_ASSERT_PRE_NON_NULL(field, "Field");
	return (int) field_common->type->id;
}

int bt_ctf_field_sequence_set_length(struct bt_ctf_field *field,
		struct bt_ctf_field *length_field)
{
	int ret;
	struct bt_ctf_field_common *common_length_field = (void *) length_field;
	uint64_t length;

	BT_CTF_ASSERT_PRE_NON_NULL(length_field, "Length field");
	BT_CTF_ASSERT_PRE_CTF_FIELD_COMMON_IS_SET((void *) length_field, "Length field");
	BT_CTF_ASSERT_PRE(common_length_field->type->id == BT_CTF_FIELD_TYPE_ID_INTEGER ||
			common_length_field->type->id == BT_CTF_FIELD_TYPE_ID_ENUM,
		"Length field must be an integer or enumeration field: field-addr=%p",
		length_field);

	if (common_length_field->type->id == BT_CTF_FIELD_TYPE_ID_ENUM) {
		struct bt_ctf_field_enumeration *enumeration = (void *)
			length_field;

		length_field = (void *) enumeration->container;
	}

	ret = bt_ctf_field_integer_unsigned_get_value(length_field, &length);
	BT_ASSERT_DBG(ret == 0);
	return bt_ctf_field_common_sequence_set_length((void *) field,
		length, (bt_ctf_field_common_create_func) bt_ctf_field_create);
}

struct bt_ctf_field *bt_ctf_field_structure_get_field_by_index(
		struct bt_ctf_field *field, uint64_t index)
{
	return bt_ctf_object_get_ref(bt_ctf_field_common_structure_borrow_field_by_index(
		(void *) field, index));
}

struct bt_ctf_field *bt_ctf_field_structure_get_field_by_name(
		struct bt_ctf_field *field, const char *name)
{
	return bt_ctf_object_get_ref(bt_ctf_field_common_structure_borrow_field_by_name(
		(void *) field, name));
}

struct bt_ctf_field *bt_ctf_field_array_get_field(
		struct bt_ctf_field *field, uint64_t index)
{
	return bt_ctf_object_get_ref(
		bt_ctf_field_common_array_borrow_field((void *) field, index));
}

struct bt_ctf_field *bt_ctf_field_sequence_get_field(
		struct bt_ctf_field *field, uint64_t index)
{
	return bt_ctf_object_get_ref(
		bt_ctf_field_common_sequence_borrow_field((void *) field, index));
}

struct bt_ctf_field *bt_ctf_field_variant_get_field(struct bt_ctf_field *field,
		struct bt_ctf_field *tag_field)
{
	struct bt_ctf_field_variant *variant_field = (void *) field;
	struct bt_ctf_field_enumeration *enum_field = (void *) tag_field;
	struct bt_ctf_field_type_common_variant *variant_ft;
	struct bt_ctf_field_type_common_enumeration *tag_ft;
	struct bt_ctf_field *current_field = NULL;
	bt_ctf_bool is_signed;
	uint64_t tag_uval;
	int ret;

	BT_CTF_ASSERT_PRE_NON_NULL(field, "Variant field");
	BT_CTF_ASSERT_PRE_NON_NULL(tag_field, "Tag field");
	BT_CTF_ASSERT_PRE_CTF_FIELD_COMMON_IS_SET((void *) tag_field, "Tag field");
	BT_CTF_ASSERT_PRE_CTF_FIELD_COMMON_HAS_TYPE_ID(
		(struct bt_ctf_field_common *) tag_field,
		BT_CTF_FIELD_TYPE_ID_ENUM, "Tag field");
	BT_CTF_ASSERT_PRE_CTF_FIELD_COMMON_HAS_TYPE_ID(
		(struct bt_ctf_field_common *) field,
		BT_CTF_FIELD_TYPE_ID_VARIANT, "Field");
	BT_CTF_ASSERT_PRE(
		bt_ctf_field_common_validate_recursive((void *) tag_field) == 0,
		"Tag field is invalid: field-addr=%p", tag_field);
	variant_ft = BT_CTF_FROM_COMMON(variant_field->common.common.type);
	BT_CTF_ASSERT_PRE(bt_ctf_field_type_common_compare(
		BT_CTF_TO_COMMON(variant_ft->tag_ft), enum_field->common.type) == 0,
		"Unexpected tag field's type: expected-ft-addr=%p, "
		"tag-ft-addr=%p", variant_ft->tag_ft,
		enum_field->common.type);
	tag_ft = BT_CTF_FROM_COMMON(enum_field->common.type);
	is_signed = tag_ft->container_ft->is_signed;

	if (is_signed) {
		int64_t tag_ival;

		ret = bt_ctf_field_integer_signed_get_value(
			(void *) enum_field->container, &tag_ival);
		tag_uval = (uint64_t) tag_ival;
	} else {
		ret = bt_ctf_field_integer_unsigned_get_value(
			(void *) enum_field->container, &tag_uval);
	}

	BT_ASSERT_DBG(ret == 0);
	ret = bt_ctf_field_common_variant_set_tag((void *) field, tag_uval,
		is_signed);
	if (ret) {
		goto end;
	}

	bt_ctf_object_put_ref(variant_field->tag);
	variant_field->tag = bt_ctf_object_get_ref(tag_field);
	current_field = bt_ctf_field_variant_get_current_field(field);
	BT_ASSERT_DBG(current_field);

end:
	return current_field;
}

struct bt_ctf_field *bt_ctf_field_variant_get_current_field(
		struct bt_ctf_field *variant_field)
{
	return bt_ctf_object_get_ref(bt_ctf_field_common_variant_borrow_current_field(
		(void *) variant_field));
}

BT_HIDDEN
struct bt_ctf_field *bt_ctf_field_enumeration_borrow_container(
		struct bt_ctf_field *field)
{
	struct bt_ctf_field_enumeration *enumeration = (void *) field;

	BT_CTF_ASSERT_PRE_NON_NULL(field, "Enumeration field");
	BT_CTF_ASSERT_PRE_CTF_FIELD_COMMON_HAS_TYPE_ID((struct bt_ctf_field_common *) field,
		BT_CTF_FIELD_TYPE_ID_ENUM, "Field");
	BT_ASSERT_DBG(enumeration->container);
	return (void *) enumeration->container;
}

struct bt_ctf_field *bt_ctf_field_enumeration_get_container(
		struct bt_ctf_field *field)
{
	return bt_ctf_object_get_ref(bt_ctf_field_enumeration_borrow_container(field));
}

int bt_ctf_field_integer_signed_get_value(struct bt_ctf_field *field,
		int64_t *value)
{
	struct bt_ctf_field_common_integer *integer = (void *) field;

	BT_CTF_ASSERT_PRE_NON_NULL(field, "Integer field");
	BT_CTF_ASSERT_PRE_NON_NULL(value, "Value");
	BT_CTF_ASSERT_PRE_CTF_FIELD_COMMON_IS_SET(BT_CTF_TO_COMMON(integer), "Integer field");
	BT_CTF_ASSERT_PRE_CTF_FIELD_COMMON_HAS_TYPE_ID(BT_CTF_TO_COMMON(integer),
		BT_CTF_FIELD_TYPE_ID_INTEGER, "Field");
	BT_CTF_ASSERT_PRE(bt_ctf_field_type_common_integer_is_signed(
		integer->common.type),
		"Field's type is unsigned: field-addr=%p", field);
	*value = integer->payload.signd;
	return 0;
}

int bt_ctf_field_integer_signed_set_value(struct bt_ctf_field *field,
		int64_t value)
{
	int ret = 0;
	struct bt_ctf_field_common_integer *integer = (void *) field;
	struct bt_ctf_field_type_common_integer *integer_type;

	BT_CTF_ASSERT_PRE_NON_NULL(field, "Integer field");
	BT_CTF_ASSERT_PRE_CTF_FIELD_COMMON_HOT(BT_CTF_TO_COMMON(integer), "Integer field");
	BT_CTF_ASSERT_PRE_CTF_FIELD_COMMON_HAS_TYPE_ID(BT_CTF_TO_COMMON(integer),
		BT_CTF_FIELD_TYPE_ID_INTEGER, "Field");
	integer_type = BT_CTF_FROM_COMMON(integer->common.type);
	BT_CTF_ASSERT_PRE(
		bt_ctf_field_type_common_integer_is_signed(integer->common.type),
		"Field's type is unsigned: field-addr=%p", field);
	BT_CTF_ASSERT_PRE(value_is_in_range_signed(integer_type->size, value),
		"Value is out of bounds: value=%" PRId64 ", field-addr=%p",
		value, field);
	integer->payload.signd = value;
	bt_ctf_field_common_set(BT_CTF_TO_COMMON(integer), true);
	return ret;
}

int bt_ctf_field_integer_unsigned_get_value(struct bt_ctf_field *field,
		uint64_t *value)
{
	struct bt_ctf_field_common_integer *integer = (void *) field;

	BT_CTF_ASSERT_PRE_NON_NULL(field, "Integer field");
	BT_CTF_ASSERT_PRE_NON_NULL(value, "Value");
	BT_CTF_ASSERT_PRE_CTF_FIELD_COMMON_IS_SET(BT_CTF_TO_COMMON(integer), "Integer field");
	BT_CTF_ASSERT_PRE_CTF_FIELD_COMMON_HAS_TYPE_ID(BT_CTF_TO_COMMON(integer),
		BT_CTF_FIELD_TYPE_ID_INTEGER, "Field");
	BT_CTF_ASSERT_PRE(
		!bt_ctf_field_type_common_integer_is_signed(integer->common.type),
		"Field's type is signed: field-addr=%p", field);
	*value = integer->payload.unsignd;
	return 0;
}

int bt_ctf_field_integer_unsigned_set_value(struct bt_ctf_field *field,
		uint64_t value)
{
	struct bt_ctf_field_common_integer *integer = (void *) field;
	struct bt_ctf_field_type_common_integer *integer_type;

	BT_CTF_ASSERT_PRE_NON_NULL(field, "Integer field");
	BT_CTF_ASSERT_PRE_CTF_FIELD_COMMON_HOT(BT_CTF_TO_COMMON(integer), "Integer field");
	BT_CTF_ASSERT_PRE_CTF_FIELD_COMMON_HAS_TYPE_ID(BT_CTF_TO_COMMON(integer),
		BT_CTF_FIELD_TYPE_ID_INTEGER, "Field");
	integer_type = BT_CTF_FROM_COMMON(integer->common.type);
	BT_CTF_ASSERT_PRE(
		!bt_ctf_field_type_common_integer_is_signed(integer->common.type),
		"Field's type is signed: field-addr=%p", field);
	BT_CTF_ASSERT_PRE(value_is_in_range_unsigned(integer_type->size, value),
		"Value is out of bounds: value=%" PRIu64 ", field-addr=%p",
		value, field);
	integer->payload.unsignd = value;
	bt_ctf_field_common_set(BT_CTF_TO_COMMON(integer), true);
	return 0;
}

int bt_ctf_field_floating_point_get_value(struct bt_ctf_field *field,
		double *value)
{
	return bt_ctf_field_common_floating_point_get_value((void *) field, value);
}

int bt_ctf_field_floating_point_set_value(struct bt_ctf_field *field,
		double value)
{
	return bt_ctf_field_common_floating_point_set_value((void *) field, value);
}

const char *bt_ctf_field_string_get_value(struct bt_ctf_field *field)
{
	return bt_ctf_field_common_string_get_value((void *) field);
}

int bt_ctf_field_string_set_value(struct bt_ctf_field *field, const char *value)
{
	return bt_ctf_field_common_string_set_value((void *) field, value);
}

int bt_ctf_field_string_append(struct bt_ctf_field *field, const char *value)
{
	return bt_ctf_field_common_string_append((void *) field, value);
}

int bt_ctf_field_string_append_len(struct bt_ctf_field *field,
		const char *value, unsigned int length)
{
	return bt_ctf_field_common_string_append_len((void *) field, value, length);
}

struct bt_ctf_field *bt_ctf_field_copy(struct bt_ctf_field *field)
{
	return (void *) bt_ctf_field_common_copy((void *) field);
}

static
struct bt_ctf_field *bt_ctf_field_integer_create(struct bt_ctf_field_type *type)
{
	struct bt_ctf_field_common_integer *integer =
		g_new0(struct bt_ctf_field_common_integer, 1);

	BT_LOGD("Creating CTF writer integer field object: ft-addr=%p", type);

	if (integer) {
		bt_ctf_field_common_initialize(BT_CTF_TO_COMMON(integer), (void *) type,
			true,
			(bt_ctf_object_release_func) bt_ctf_field_integer_destroy,
			&bt_ctf_field_integer_methods);
		integer->common.spec.writer.serialize_func =
			(bt_ctf_field_serialize_recursive_func) bt_ctf_field_integer_serialize;
		BT_LOGD("Created CTF writer integer field object: addr=%p, ft-addr=%p",
			integer, type);
	} else {
		BT_LOGE_STR("Failed to allocate one integer field.");
	}

	return (void *) integer;
}

static
struct bt_ctf_field *bt_ctf_field_enumeration_create(
		struct bt_ctf_field_type *type)
{
	struct bt_ctf_field_type_common_enumeration *enum_ft = (void *) type;
	struct bt_ctf_field_enumeration *enumeration = g_new0(
		struct bt_ctf_field_enumeration, 1);

	BT_LOGD("Creating CTF writer enumeration field object: ft-addr=%p", type);

	if (!enumeration) {
		BT_LOGE_STR("Failed to allocate one enumeration field.");
		goto end;
	}

	bt_ctf_field_common_initialize(BT_CTF_TO_COMMON(enumeration),
		(void *) type,
		true, (bt_ctf_object_release_func)
			bt_ctf_field_enumeration_destroy_recursive,
		&bt_ctf_field_enumeration_methods);
	enumeration->container = (void *) bt_ctf_field_create(
		BT_CTF_FROM_COMMON(enum_ft->container_ft));
	if (!enumeration->container) {
		BT_CTF_OBJECT_PUT_REF_AND_RESET(enumeration);
		goto end;
	}

	enumeration->common.spec.writer.serialize_func =
		(bt_ctf_field_serialize_recursive_func)
			bt_ctf_field_enumeration_serialize_recursive;
	BT_LOGD("Created CTF writer enumeration field object: addr=%p, ft-addr=%p",
		enumeration, type);

end:
	return (void *) enumeration;
}

static
struct bt_ctf_field *bt_ctf_field_floating_point_create(
		struct bt_ctf_field_type *type)
{
	struct bt_ctf_field_common_floating_point *floating_point;

	BT_LOGD("Creating CTF writer floating point number field object: ft-addr=%p", type);
	floating_point = g_new0(struct bt_ctf_field_common_floating_point, 1);

	if (floating_point) {
		bt_ctf_field_common_initialize(BT_CTF_TO_COMMON(floating_point),
			(void *) type,
			true, (bt_ctf_object_release_func)
				bt_ctf_field_floating_point_destroy,
			&bt_ctf_field_floating_point_methods);
		floating_point->common.spec.writer.serialize_func =
			(bt_ctf_field_serialize_recursive_func) bt_ctf_field_floating_point_serialize;
		BT_LOGD("Created CTF writer floating point number field object: addr=%p, ft-addr=%p",
			floating_point, type);
	} else {
		BT_LOGE_STR("Failed to allocate one floating point number field.");
	}

	return (void *) floating_point;
}

static
struct bt_ctf_field *bt_ctf_field_structure_create(
		struct bt_ctf_field_type *type)
{
	struct bt_ctf_field_common_structure *structure = g_new0(
		struct bt_ctf_field_common_structure, 1);
	int iret;

	BT_LOGD("Creating CTF writer structure field object: ft-addr=%p", type);

	if (!structure) {
		BT_LOGE_STR("Failed to allocate one structure field.");
		goto end;
	}

	iret = bt_ctf_field_common_structure_initialize(BT_CTF_TO_COMMON(structure),
		(void *) type,
		true, (bt_ctf_object_release_func)
			bt_ctf_field_structure_destroy_recursive,
		&bt_ctf_field_structure_methods,
		(bt_ctf_field_common_create_func) bt_ctf_field_create,
		(GDestroyNotify) bt_ctf_object_put_ref);
	structure->common.spec.writer.serialize_func =
		(bt_ctf_field_serialize_recursive_func) bt_ctf_field_structure_serialize_recursive;
	if (iret) {
		BT_CTF_OBJECT_PUT_REF_AND_RESET(structure);
		goto end;
	}

	BT_LOGD("Created CTF writer structure field object: addr=%p, ft-addr=%p",
		structure, type);

end:
	return (void *) structure;
}

static
struct bt_ctf_field *bt_ctf_field_variant_create(struct bt_ctf_field_type *type)
{
	struct bt_ctf_field_type_common_variant *var_ft = (void *) type;
	struct bt_ctf_field_variant *variant = g_new0(
		struct bt_ctf_field_variant, 1);

	BT_LOGD("Creating CTF writer variant field object: ft-addr=%p", type);

	if (!variant) {
		BT_LOGE_STR("Failed to allocate one variant field.");
		goto end;
	}

	bt_ctf_field_common_variant_initialize(BT_CTF_TO_COMMON(BT_CTF_TO_COMMON(variant)),
		(void *) type,
		true, (bt_ctf_object_release_func)
			bt_ctf_field_variant_destroy_recursive,
		&bt_ctf_field_variant_methods,
		(bt_ctf_field_common_create_func) bt_ctf_field_create,
		(GDestroyNotify) bt_ctf_object_put_ref);
	variant->tag = (void *) bt_ctf_field_create(
		BT_CTF_FROM_COMMON(var_ft->tag_ft));
	variant->common.common.spec.writer.serialize_func =
		(bt_ctf_field_serialize_recursive_func) bt_ctf_field_variant_serialize_recursive;
	BT_LOGD("Created CTF writer variant field object: addr=%p, ft-addr=%p",
		variant, type);

end:
	return (void *) variant;
}

static
struct bt_ctf_field *bt_ctf_field_array_create(struct bt_ctf_field_type *type)
{
	struct bt_ctf_field_common_array *array =
		g_new0(struct bt_ctf_field_common_array, 1);
	int ret;

	BT_LOGD("Creating CTF writer array field object: ft-addr=%p", type);
	BT_ASSERT_DBG(type);

	if (!array) {
		BT_LOGE_STR("Failed to allocate one array field.");
		goto end;
	}

	ret = bt_ctf_field_common_array_initialize(BT_CTF_TO_COMMON(array),
		(void *) type,
		true, (bt_ctf_object_release_func)
			bt_ctf_field_array_destroy_recursive,
		&bt_ctf_field_array_methods,
		(bt_ctf_field_common_create_func) bt_ctf_field_create,
		(GDestroyNotify) bt_ctf_object_put_ref);
	array->common.spec.writer.serialize_func =
		(bt_ctf_field_serialize_recursive_func) bt_ctf_field_array_serialize_recursive;
	if (ret) {
		BT_CTF_OBJECT_PUT_REF_AND_RESET(array);
		goto end;
	}

	BT_LOGD("Created CTF writer array field object: addr=%p, ft-addr=%p",
		array, type);

end:
	return (void *) array;
}

static
struct bt_ctf_field *bt_ctf_field_sequence_create(struct bt_ctf_field_type *type)
{
	struct bt_ctf_field_common_sequence *sequence = g_new0(
		struct bt_ctf_field_common_sequence, 1);

	BT_LOGD("Creating CTF writer sequence field object: ft-addr=%p", type);

	if (sequence) {
		bt_ctf_field_common_sequence_initialize(BT_CTF_TO_COMMON(sequence),
			(void *) type,
			true, (bt_ctf_object_release_func)
				bt_ctf_field_sequence_destroy_recursive,
			&bt_ctf_field_sequence_methods,
			(GDestroyNotify) bt_ctf_object_put_ref);
		sequence->common.spec.writer.serialize_func =
			(bt_ctf_field_serialize_recursive_func) bt_ctf_field_sequence_serialize_recursive;
		BT_LOGD("Created CTF writer sequence field object: addr=%p, ft-addr=%p",
			sequence, type);
	} else {
		BT_LOGE_STR("Failed to allocate one sequence field.");
	}

	return (void *) sequence;
}

static
struct bt_ctf_field *bt_ctf_field_string_create(struct bt_ctf_field_type *type)
{
	struct bt_ctf_field_common_string *string = g_new0(
		struct bt_ctf_field_common_string, 1);

	BT_LOGD("Creating CTF writer string field object: ft-addr=%p", type);

	if (string) {
		bt_ctf_field_common_string_initialize(BT_CTF_TO_COMMON(string),
			(void *) type,
			true, (bt_ctf_object_release_func)
				bt_ctf_field_string_destroy,
			&bt_ctf_field_string_methods);
		string->common.spec.writer.serialize_func =
			(bt_ctf_field_serialize_recursive_func) bt_ctf_field_string_serialize;
		BT_LOGD("Created CTF writer string field object: addr=%p, ft-addr=%p",
			string, type);
	} else {
		BT_LOGE_STR("Failed to allocate one string field.");
	}

	return (void *) string;
}

static
void bt_ctf_field_enumeration_set_is_frozen_recursive(
		struct bt_ctf_field_common *field, bool is_frozen)
{
	struct bt_ctf_field_enumeration *enumeration = (void *) field;

	if (enumeration->container) {
		bt_ctf_field_common_set_is_frozen_recursive(
			(void *) enumeration->container, is_frozen);
	}

	bt_ctf_field_common_generic_set_is_frozen((void *) field, is_frozen);
}

static
int bt_ctf_field_enumeration_validate_recursive(struct bt_ctf_field_common *field)
{
	int ret = -1;
	struct bt_ctf_field_enumeration *enumeration = (void *) field;

	if (enumeration->container) {
		ret = bt_ctf_field_common_validate_recursive(
			(void *) enumeration->container);
	}

	return ret;
}

static
bt_ctf_bool bt_ctf_field_enumeration_is_set_recursive(struct bt_ctf_field_common *field)
{
	bt_ctf_bool is_set = BT_CTF_FALSE;
	struct bt_ctf_field_enumeration *enumeration = (void *) field;

	if (enumeration->container) {
		is_set = bt_ctf_field_common_is_set_recursive(
			(void *) enumeration->container);
	}

	return is_set;
}

static
void bt_ctf_field_enumeration_reset_recursive(struct bt_ctf_field_common *field)
{
	struct bt_ctf_field_enumeration *enumeration = (void *) field;

	if (enumeration->container) {
		bt_ctf_field_common_reset_recursive(
			(void *) enumeration->container);
	}

	bt_ctf_field_common_generic_reset((void *) field);
}

static
void bt_ctf_field_variant_set_is_frozen_recursive(
		struct bt_ctf_field_common *field, bool is_frozen)
{
	struct bt_ctf_field_variant *variant = (void *) field;

	if (variant->tag) {
		bt_ctf_field_common_set_is_frozen_recursive(
			(void *) variant->tag, is_frozen);
	}

	bt_ctf_field_common_variant_set_is_frozen_recursive((void *) field,
		is_frozen);
}

static
int bt_ctf_field_variant_validate_recursive(struct bt_ctf_field_common *field)
{
	int ret;
	struct bt_ctf_field_variant *variant = (void *) field;

	if (variant->tag) {
		ret = bt_ctf_field_common_validate_recursive(
			(void *) variant->tag);
		if (ret) {
			goto end;
		}
	}

	ret = bt_ctf_field_common_variant_validate_recursive((void *) field);

end:
	return ret;
}

static
bt_ctf_bool bt_ctf_field_variant_is_set_recursive(struct bt_ctf_field_common *field)
{
	bt_ctf_bool is_set;
	struct bt_ctf_field_variant *variant = (void *) field;

	if (variant->tag) {
		is_set = bt_ctf_field_common_is_set_recursive(
			(void *) variant->tag);
		if (is_set) {
			goto end;
		}
	}

	is_set = bt_ctf_field_common_variant_is_set_recursive((void *) field);

end:
	return is_set;
}

static
void bt_ctf_field_variant_reset_recursive(struct bt_ctf_field_common *field)
{
	struct bt_ctf_field_variant *variant = (void *) field;

	if (variant->tag) {
		bt_ctf_field_common_reset_recursive(
			(void *) variant->tag);
	}

	bt_ctf_field_common_variant_reset_recursive((void *) field);
}

BT_CTF_ASSERT_PRE_FUNC
static inline bool field_to_set_has_expected_type(
		struct bt_ctf_field_common *struct_field,
		const char *name, struct bt_ctf_field_common *value)
{
	bool ret = true;
	struct bt_ctf_field_type_common *expected_field_type = NULL;

	expected_field_type =
		bt_ctf_field_type_common_structure_borrow_field_type_by_name(
			struct_field->type, name);

	if (bt_ctf_field_type_common_compare(expected_field_type, value->type)) {
		BT_CTF_ASSERT_PRE_MSG("Value field's type is different from the expected field type: "
			"value-ft-addr=%p, expected-ft-addr=%p", value->type,
			expected_field_type);
		ret = false;
		goto end;
	}

end:
	return ret;
}

BT_HIDDEN
int bt_ctf_field_structure_set_field_by_name(struct bt_ctf_field *field,
		const char *name, struct bt_ctf_field *value)
{
	int ret = 0;
	GQuark field_quark;
	struct bt_ctf_field_common *common_field = (void *) field;
	struct bt_ctf_field_common_structure *structure =
		BT_CTF_FROM_COMMON(common_field);
	struct bt_ctf_field_common *common_value = (void *) value;
	size_t index;
	GHashTable *field_name_to_index;
	struct bt_ctf_field_type_common_structure *structure_ft;

	BT_CTF_ASSERT_PRE_NON_NULL(field, "Parent field");
	BT_CTF_ASSERT_PRE_NON_NULL(name, "Field name");
	BT_CTF_ASSERT_PRE_NON_NULL(value, "Value field");
	BT_CTF_ASSERT_PRE_CTF_FIELD_COMMON_HAS_TYPE_ID(common_field,
		BT_CTF_FIELD_TYPE_ID_STRUCT, "Parent field");
	BT_CTF_ASSERT_PRE(field_to_set_has_expected_type(common_field,
		name, common_value),
		"Value field's type is different from the expected field type.");
	field_quark = g_quark_from_string(name);
	structure_ft = BT_CTF_FROM_COMMON(common_field->type);
	field_name_to_index = structure_ft->field_name_to_index;
	if (!g_hash_table_lookup_extended(field_name_to_index,
			GUINT_TO_POINTER(field_quark), NULL,
			(gpointer *) &index)) {
		BT_LOGT("Invalid parameter: no such field in structure field's type: "
			"struct-field-addr=%p, struct-ft-addr=%p, "
			"field-ft-addr=%p, name=\"%s\"",
			field, common_field->type, common_value->type, name);
		ret = -1;
		goto end;
	}
	bt_ctf_object_get_ref(value);
	BT_CTF_OBJECT_MOVE_REF(structure->fields->pdata[index], value);

end:
	return ret;
}