[babeltrace.git] / plugins / libctfcopytrace / clock-fields.c

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

#define BT_LOG_TAG "PLUGIN-CTFCOPYTRACE-LIB-CLOCK-FIELDS"
#include "logging.h"

#include <babeltrace/babeltrace.h>
#include <babeltrace/assert-internal.h>
#include <stdio.h>

#include "clock-fields.h"

static
int find_update_struct_clock_fields(FILE *err, struct bt_field_type *type,
		const struct bt_clock_class *writer_clock_class);
static
int find_update_array_clock_fields(FILE *err, struct bt_field_type *type,
		const struct bt_clock_class *writer_clock_class);
static
int find_update_enum_clock_fields(FILE *err, struct bt_field_type *type,
		const struct bt_clock_class *writer_clock_class);
static
int find_update_sequence_clock_fields(FILE *err, struct bt_field_type *type,
		const struct bt_clock_class *writer_clock_class);
static
int find_update_variant_clock_fields(FILE *err, struct bt_field_type *type,
		const struct bt_clock_class *writer_clock_class);

static
int copy_find_clock_int_field(FILE *err,
		const struct bt_event *event, const struct bt_event *writer_event,
		const struct bt_field *field, struct bt_field_type *type,
		const struct bt_field *copy_field);
static
int copy_find_clock_struct_field(FILE *err,
		const struct bt_event *event, const struct bt_event *writer_event,
		const struct bt_field *field, struct bt_field_type *type,
		const struct bt_field *copy_field);
static
int copy_find_clock_array_field(FILE *err,
		const struct bt_event *event, const struct bt_event *writer_event,
		const struct bt_field *field, struct bt_field_type *type,
		const struct bt_field *copy_field);
static
int copy_find_clock_sequence_field(FILE *err,
		const struct bt_event *event, const struct bt_event *writer_event,
		const struct bt_field *field, struct bt_field_type *type,
		const struct bt_field *copy_field);
static
int copy_find_clock_variant_field(FILE *err, const struct bt_event *event,
		const struct bt_event *writer_event, const struct bt_field *field,
		struct bt_field_type *type, const struct bt_field *copy_field);
static
int copy_find_clock_enum_field(FILE *err, const struct bt_event *event,
		const struct bt_event *writer_event, const struct bt_field *field,
		struct bt_field_type *type, const struct bt_field *copy_field);

static
int update_header_clock_int_field_type(FILE *err, struct bt_field_type *type,
		const struct bt_clock_class *writer_clock_class)
{
	const struct bt_clock_class *clock = NULL;
	int ret;

	clock = bt_field_type_integer_get_mapped_clock_class(type);
	if (!clock) {
		return 0;
	}
	BT_OBJECT_PUT_REF_AND_RESET(clock);

	ret = bt_field_type_integer_set_size(type, 64);
	if (ret) {
		BT_LOGE_STR("Failed to set integer size to 64.");
		goto end;
	}

	ret = bt_field_type_integer_set_mapped_clock_class(type,
			writer_clock_class);
	if (ret) {
		BT_LOGE_STR("Failed to map integer to clock_class.");
		goto end;
	}

end:
	return ret;
}

static
int find_update_clock_fields(FILE *err, struct bt_field_type *type,
		const struct bt_clock_class *writer_clock_class)
{
	int ret;

	switch (bt_field_type_get_type_id(type)) {
	case BT_FIELD_TYPE_ID_INTEGER:
		return update_header_clock_int_field_type(err, type,
				writer_clock_class);
	case BT_FIELD_TYPE_ID_STRUCT:
		return find_update_struct_clock_fields(err, type,
				writer_clock_class);
	case BT_FIELD_TYPE_ID_ARRAY:
		return find_update_array_clock_fields(err, type,
				writer_clock_class);
	case BT_FIELD_TYPE_ID_SEQUENCE:
		return find_update_sequence_clock_fields(err, type,
				writer_clock_class);
	case BT_FIELD_TYPE_ID_VARIANT:
		return find_update_variant_clock_fields(err, type,
				writer_clock_class);
	case BT_FIELD_TYPE_ID_ENUM:
		return find_update_enum_clock_fields(err, type,
				writer_clock_class);
		break;
	default:
		break;
	}

	ret = 0;

	return ret;
}

static
int find_update_variant_clock_fields(FILE *err, struct bt_field_type *type,
		const struct bt_clock_class *writer_clock_class)
{
	int count, i, ret;
	struct bt_field_type *entry_type = NULL;

	count = bt_field_type_variant_get_field_count(type);
	for (i = 0; i < count; i++) {
		const char *entry_name;

		ret = bt_field_type_variant_get_field_by_index(type,
				&entry_name, &entry_type, i);
		if (ret) {
			BT_LOGE_STR("Failed to get variant field.");
			goto error;
		}

		ret = find_update_clock_fields(err, entry_type,
				writer_clock_class);
		if (ret) {
			BT_LOGE_STR("Failed to find clock fields.");
			goto error;
		}
		BT_OBJECT_PUT_REF_AND_RESET(entry_type);
	}

	ret = 0;
	goto end;

error:
	ret = -1;
end:
	bt_object_put_ref(entry_type);
	return ret;
}

static
int find_update_struct_clock_fields(FILE *err, struct bt_field_type *type,
		const struct bt_clock_class *writer_clock_class)
{
	int count, i, ret;
	struct bt_field_type *entry_type = NULL;

	count = bt_field_type_structure_get_field_count(type);
	for (i = 0; i < count; i++) {
		const char *entry_name;

		ret = bt_field_type_structure_get_field_by_index(type,
				&entry_name, &entry_type, i);
		if (ret) {
			BT_LOGE_STR("Failed to get struct field.");
			goto error;
		}

		ret = find_update_clock_fields(err, entry_type,
				writer_clock_class);
		if (ret) {
			BT_LOGE_STR("Failed to find clock fields.");
			goto error;
		}
		BT_OBJECT_PUT_REF_AND_RESET(entry_type);
	}

	ret = 0;
	goto end;

error:
	bt_object_put_ref(entry_type);
end:
	return ret;
}

static
int find_update_sequence_clock_fields(FILE *err, struct bt_field_type *type,
		const struct bt_clock_class *writer_clock_class)
{
	int ret;
	struct bt_field_type *entry_type = NULL;

	entry_type = bt_field_type_sequence_get_element_type(type);
	BT_ASSERT(entry_type);

	ret = find_update_clock_fields(err, entry_type, writer_clock_class);
	BT_OBJECT_PUT_REF_AND_RESET(entry_type);
	if (ret) {
		BT_LOGE_STR("Failed to find clock fields.");
		goto error;
	}

	ret = 0;
	goto end;

error:
	ret = -1;
end:
	return ret;
}

static
int find_update_array_clock_fields(FILE *err, struct bt_field_type *type,
		const struct bt_clock_class *writer_clock_class)
{
	int ret = 0;
	struct bt_field_type *entry_type = NULL;

	entry_type = bt_field_type_array_get_element_type(type);
	BT_ASSERT(entry_type);

	ret = find_update_clock_fields(err, entry_type, writer_clock_class);
	BT_OBJECT_PUT_REF_AND_RESET(entry_type);
	if (ret) {
		BT_LOGE_STR("Failed to find clock fields.");
		ret = -1;
		goto end;
	}

end:
	return ret;
}

static
int find_update_enum_clock_fields(FILE *err, struct bt_field_type *type,
		const struct bt_clock_class *writer_clock_class)
{
	int ret;
	struct bt_field_type *entry_type = NULL;

	entry_type = bt_field_type_enumeration_get_container_type(type);
	BT_ASSERT(entry_type);

	ret = find_update_clock_fields(err, entry_type, writer_clock_class);
	BT_OBJECT_PUT_REF_AND_RESET(entry_type);
	if (ret) {
		BT_LOGE_STR("Failed to find clock fields.");
		goto error;
	}

	ret = 0;
	goto end;

error:
	ret = -1;
end:
	return ret;
}

BT_HIDDEN
struct bt_field_type *override_header_type(FILE *err,
		struct bt_field_type *type,
		const struct bt_trace *writer_trace)
{
	struct bt_field_type *new_type = NULL;
	const struct bt_clock_class *writer_clock_class = NULL;
	int ret;

	/* FIXME multi-clock? */
	writer_clock_class = bt_trace_get_clock_class_by_index(writer_trace, 0);
	BT_ASSERT(writer_clock_class);

	new_type = bt_field_type_copy(type);
	if (!new_type) {
		BT_LOGE_STR("Failed to copy field type.");
		goto error;
	}

	if (bt_field_type_get_type_id(new_type) != BT_FIELD_TYPE_ID_STRUCT) {
		BT_LOGE("Expected header field type to be struct: type=%d",
				bt_field_type_get_type_id(new_type));
		goto error;
	}

	ret = find_update_struct_clock_fields(err, new_type, writer_clock_class);
	if (ret) {
		BT_LOGE_STR("Failed to find clock fields in struct.");
		goto error;
	}
	BT_OBJECT_PUT_REF_AND_RESET(writer_clock_class);

	goto end;

error:
	bt_object_put_ref(writer_clock_class);
	BT_OBJECT_PUT_REF_AND_RESET(new_type);
end:
	return new_type;
}

static
int copy_float_field(FILE *err, const struct bt_field *field,
		struct bt_field_type *type,
		const struct bt_field *copy_field)
{
	double value;
	int ret;

	ret = bt_field_floating_point_get_value(field, &value);
	if (ret) {
		BT_LOGE_STR("Failed to get value.");
		goto error;
	}

	ret = bt_field_floating_point_set_value(copy_field, value);
	if (ret) {
		ret = -1;
		BT_LOGE_STR("Failed to set floating point value.");
		goto end;
	}

	ret = 0;
	goto end;

error:
	ret = -1;
end:
	return ret;
}

static
int copy_string_field(FILE *err, const struct bt_field *field,
		struct bt_field_type *type,
		const struct bt_field *copy_field)
{
	const char *value;
	int ret;

	value = bt_field_string_get_value(field);
	if (!value) {
		BT_LOGE_STR("Failed to get value.");
		goto error;
	}

	ret = bt_field_string_set_value(copy_field, value);
	if (ret) {
		ret = -1;
		BT_LOGE_STR("Failed to set string value.");
		goto end;
	}

	ret = 0;
	goto end;

error:
	ret = -1;
end:
	return ret;
}

BT_HIDDEN
int copy_override_field(FILE *err, const struct bt_event *event,
		const struct bt_event *writer_event, const struct bt_field *field,
		const struct bt_field *copy_field)
{
	struct bt_field_type *type = NULL;
	int ret = 0;

	type = bt_field_get_type(field);
	BT_ASSERT(type);

	switch (bt_field_type_get_type_id(type)) {
	case BT_FIELD_TYPE_ID_INTEGER:
		ret = copy_find_clock_int_field(err, event, writer_event,
				field, type, copy_field);
		break;
	case BT_FIELD_TYPE_ID_STRUCT:
		ret = copy_find_clock_struct_field(err, event, writer_event,
				field, type, copy_field);
		break;
	case BT_FIELD_TYPE_ID_FLOAT:
		ret = copy_float_field(err, field, type, copy_field);
		break;
	case BT_FIELD_TYPE_ID_ENUM:
		ret = copy_find_clock_enum_field(err, event, writer_event,
				field, type, copy_field);
		break;
	case BT_FIELD_TYPE_ID_STRING:
		ret = copy_string_field(err, field, type, copy_field);
		break;
	case BT_FIELD_TYPE_ID_ARRAY:
		ret = copy_find_clock_array_field(err, event, writer_event,
				field, type, copy_field);
		break;
	case BT_FIELD_TYPE_ID_SEQUENCE:
		ret = copy_find_clock_sequence_field(err, event, writer_event,
				field, type, copy_field);
		break;
	case BT_FIELD_TYPE_ID_VARIANT:
		ret = copy_find_clock_variant_field(err, event, writer_event,
				field, type, copy_field);
		break;
	/* No default, we want to catch missing field types. */
	case BT_FIELD_TYPE_ID_UNKNOWN:
	case BT_FIELD_TYPE_ID_NR:
		break;
	}

	BT_OBJECT_PUT_REF_AND_RESET(type);

	return ret;
}

static
int copy_find_clock_enum_field(FILE *err, const struct bt_event *event,
		const struct bt_event *writer_event, const struct bt_field *field,
		struct bt_field_type *type, const struct bt_field *copy_field)
{
	int ret;
	const struct bt_field *container = NULL, *copy_container = NULL;

	container = bt_field_enumeration_get_container(field);
	BT_ASSERT(container);

	copy_container = bt_field_enumeration_get_container(copy_field);
	BT_ASSERT(copy_container);

	ret = copy_override_field(err, event, writer_event, container,
			copy_container);
	if (ret) {
		ret = -1;
		BT_LOGE_STR("Failed to override enum field.");
		goto error;
	}

	ret = 0;
	goto end;

error:
	ret = -1;
end:
	bt_object_put_ref(copy_container);
	bt_object_put_ref(container);
	return ret;
}

static
int copy_find_clock_variant_field(FILE *err, const struct bt_event *event,
		const struct bt_event *writer_event, const struct bt_field *field,
		struct bt_field_type *type, const struct bt_field *copy_field)
{
	int ret;
	const struct bt_field *tag = NULL;
	const struct bt_field *variant_field = NULL, *copy_variant_field = NULL;

	tag = bt_field_variant_get_tag(field);
	BT_ASSERT(tag);

	variant_field = bt_field_variant_get_field(field, tag);
	if (!variant_field) {
		BT_LOGE_STR("Failed to get variant field.");
		goto error;
	}

	copy_variant_field = bt_field_variant_get_field(copy_field, tag);
	BT_ASSERT(copy_variant_field);

	ret = copy_override_field(err, event, writer_event, variant_field,
			copy_variant_field);
	if (ret) {
		BT_LOGE_STR("Failed to override variant field.");
		goto error;
	}

	ret = 0;
	goto end;

error:
	ret = -1;
end:
	bt_object_put_ref(copy_variant_field);
	bt_object_put_ref(variant_field);
	bt_object_put_ref(tag);
	return ret;
}

static
int copy_find_clock_sequence_field(FILE *err,
		const struct bt_event *event, const struct bt_event *writer_event,
		const struct bt_field *field, struct bt_field_type *type,
		const struct bt_field *copy_field)
{
	int ret;
	uint64_t i, count;
	const struct bt_field *length_field = NULL;
	const struct bt_field *entry_field = NULL, *entry_copy = NULL;

	length_field = bt_field_sequence_get_length(field);
	BT_ASSERT(length_field);

	ret = bt_field_unsigned_integer_get_value(length_field, &count);
	if (ret) {
		BT_LOGE("Failed to get value.");
		goto error;
	}

	ret = bt_field_sequence_set_length(copy_field, length_field);
	if (ret) {
		BT_LOGE_STR("Failed to set sequence length.");
		goto error;
	}
	BT_OBJECT_PUT_REF_AND_RESET(length_field);

	for (i = 0; i < count; i++) {
		entry_field = bt_field_sequence_get_field(field, i);
		if (!entry_field) {
			BT_LOGE_STR("Failed to get sequence field.");
			goto error;
		}

		entry_copy = bt_field_sequence_get_field(copy_field, i);
		BT_ASSERT(entry_copy);

		ret = copy_override_field(err, event, writer_event, entry_field,
				entry_copy);
		if (ret) {
			BT_LOGE_STR("Faield to override field in sequence.");
			goto error;
		}
		BT_OBJECT_PUT_REF_AND_RESET(entry_field);
		BT_OBJECT_PUT_REF_AND_RESET(entry_copy);
	}

	ret = 0;
	goto end;

error:
	bt_object_put_ref(length_field);
	bt_object_put_ref(entry_field);
	bt_object_put_ref(entry_copy);
	ret = -1;
end:
	return ret;
}

static
int copy_find_clock_array_field(FILE *err,
		const struct bt_event *event, const struct bt_event *writer_event,
		const struct bt_field *field, struct bt_field_type *type,
		const struct bt_field *copy_field)
{
	int ret, count, i;
	const struct bt_field *entry_field = NULL, *entry_copy = NULL;

	count = bt_field_type_array_get_length(type);
	for (i = 0; i < count; i++) {
		entry_field = bt_field_array_get_field(field, i);
		if (!entry_field) {
			ret = -1;
			BT_LOGE_STR("Failed to get array field.");
			goto error;
		}

		entry_copy = bt_field_array_get_field(copy_field, i);
		BT_ASSERT(entry_copy);

		ret = copy_override_field(err, event, writer_event, entry_field,
				entry_copy);
		if (ret) {
			ret = -1;
			BT_LOGE_STR("Failed to override field in array.");
			goto error;
		}
		BT_OBJECT_PUT_REF_AND_RESET(entry_field);
		BT_OBJECT_PUT_REF_AND_RESET(entry_copy);
	}

	ret = 0;
	goto end;

error:
	bt_object_put_ref(entry_field);
	bt_object_put_ref(entry_copy);

end:
	return ret;
}

static
int copy_find_clock_struct_field(FILE *err,
		const struct bt_event *event, const struct bt_event *writer_event,
		const struct bt_field *field, struct bt_field_type *type,
		const struct bt_field *copy_field)
{
	int count, i, ret;
	struct bt_field_type *entry_type = NULL;
	const struct bt_field *entry_field = NULL, *entry_copy = NULL;

	count = bt_field_type_structure_get_field_count(type);
	for (i = 0; i < count; i++) {
		const char *entry_name;

		entry_field = bt_field_structure_get_field_by_index(field, i);
		if (!entry_field) {
			BT_LOGE_STR("Failed to get struct field.");
			goto error;
		}

		ret = bt_field_type_structure_get_field_by_index(type, &entry_name,
				&entry_type, i);
		if (ret) {
			BT_LOGE_STR("Failed to get struct field.");
			goto error;
		}

		entry_copy = bt_field_structure_get_field_by_index(copy_field, i);
		BT_ASSERT(entry_copy);

		ret = copy_override_field(err, event, writer_event, entry_field,
				entry_copy);
		if (ret) {
			BT_LOGE_STR("Failed to override field in struct.");
			goto error;
		}
		BT_OBJECT_PUT_REF_AND_RESET(entry_copy);
		BT_OBJECT_PUT_REF_AND_RESET(entry_field);
		BT_OBJECT_PUT_REF_AND_RESET(entry_type);
	}

	ret = 0;
	goto end;

error:
	bt_object_put_ref(entry_type);
	bt_object_put_ref(entry_field);
	bt_object_put_ref(entry_copy);
	ret = -1;
end:
	return ret;
}

static
int set_int_value(FILE *err, const struct bt_field *field,
		const struct bt_field *copy_field,
		struct bt_field_type *type)
{
	uint64_t uvalue;
	int64_t value;
	int ret;

	if (bt_field_type_integer_is_signed(type)) {
		ret = bt_field_signed_integer_get_value(field, &value);
		if (ret) {
			BT_LOGE("Failed to get value.");
			goto error;
		}

		ret = bt_field_signed_integer_set_value(copy_field, value);
		if (ret) {
			ret = -1;
			BT_LOGE_STR("Failed to set signed integer value.");
			goto end;
		}
	} else {
		ret = bt_field_unsigned_integer_get_value(field,
				&uvalue);
		if (ret) {
			BT_LOGE("Failed to get value.");
			goto error;
		}

		ret = bt_field_unsigned_integer_set_value(copy_field, uvalue);
		if (ret) {
			ret = -1;
			BT_LOGE_STR("Failed to set unsigned integer value.");
			goto end;
		}
	}
	ret = 0;
	goto end;

error:
	ret = -1;
end:
	return ret;
}

const struct bt_clock_class *stream_class_get_clock_class(FILE *err,
		const struct bt_stream_class *stream_class)
{
	const struct bt_trace *trace = NULL;
	const struct bt_clock_class *clock_class = NULL;

	trace = bt_stream_class_get_trace(stream_class);
	BT_ASSERT(trace);

	/* FIXME multi-clock? */
	clock_class = bt_trace_get_clock_class_by_index(trace, 0);

	bt_object_put_ref(trace);

	return clock_class;
}

const struct bt_clock_class *event_get_clock_class(FILE *err, const struct bt_event *event)
{
	const struct bt_event_class *event_class = NULL;
	const struct bt_stream_class *stream_class = NULL;
	const struct bt_clock_class *clock_class = NULL;

	event_class = bt_event_get_class(event);
	BT_ASSERT(event_class);

	stream_class = bt_event_class_get_stream_class(event_class);
	BT_OBJECT_PUT_REF_AND_RESET(event_class);
	BT_ASSERT(stream_class);

	clock_class = stream_class_get_clock_class(err, stream_class);
	bt_object_put_ref(stream_class);

	return clock_class;
}

static
int copy_find_clock_int_field(FILE *err,
		const struct bt_event *event, const struct bt_event *writer_event,
		const struct bt_field *field, struct bt_field_type *type,
		const struct bt_field *copy_field)
{
	const struct bt_clock_class *clock_class = NULL, *writer_clock_class = NULL;
	struct bt_clock_value *clock_value = NULL, *writer_clock_value = NULL;
	uint64_t value;
	int ret;

	clock_class = bt_field_type_integer_get_mapped_clock_class(type);
	if (!clock_class) {
		return set_int_value(err, field, copy_field, type);
	}

	clock_value = bt_event_get_clock_value(event, clock_class);
	BT_OBJECT_PUT_REF_AND_RESET(clock_class);
	BT_ASSERT(clock_value);

	ret = bt_clock_value_get_value(clock_value, &value);
	BT_OBJECT_PUT_REF_AND_RESET(clock_value);
	if (ret) {
		BT_LOGE("Failed to get clock value.");
		goto error;
	}

	ret = bt_field_unsigned_integer_set_value(copy_field, value);
	if (ret) {
		BT_LOGE_STR("Failed to set unsigned integer value.");
		goto error;
	}

	writer_clock_class = event_get_clock_class(err, writer_event);
	BT_ASSERT(writer_clock_class);

	writer_clock_value = bt_clock_value_create(writer_clock_class, value);
	BT_OBJECT_PUT_REF_AND_RESET(writer_clock_class);
	if (!writer_clock_value) {
		BT_LOGE_STR("Failed to create clock value.");
		goto error;
	}

	ret = bt_event_set_clock_value(writer_event, writer_clock_value);
	BT_OBJECT_PUT_REF_AND_RESET(writer_clock_value);
	if (ret) {
		BT_LOGE_STR("Failed to set clock value.");
		goto error;
	}

	ret = 0;
	goto end;

error:
	ret = -1;
end:
	return ret;
}