[babeltrace.git] / types / variant.c

/*
 * variant.c
 *
 * BabelTrace - Variant Type Converter
 *
 * Copyright 2011 - Mathieu Desnoyers <mathieu.desnoyers@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.
 */

#include <babeltrace/compiler.h>
#include <babeltrace/format.h>
#include <errno.h>

static
struct declaration *_variant_declaration_new(struct type *type,
				struct declaration_scope *parent_scope);
static
void _variant_declaration_free(struct declaration *declaration);

void variant_copy(struct stream_pos *dest, const struct format *fdest, 
		  struct stream_pos *src, const struct format *fsrc,
		  struct declaration *declaration)
{
	struct declaration_variant *variant =
		container_of(declaration, struct declaration_variant, p);
	struct type_variant *variant_type = variant->type;
	struct field *field;
	struct type *field_type;

	fsrc->variant_begin(src, variant_type);
	fdest->variant_begin(dest, variant_type);

	field = variant_get_current_field(variant);
	field_type = field->declaration->type;
	field_type->copy(dest, fdest, src, fsrc, field->declaration);

	fsrc->variant_end(src, variant_type);
	fdest->variant_end(dest, variant_type);
}

static
void _variant_type_free(struct type *type)
{
	struct type_variant *variant_type =
		container_of(type, struct type_variant, p);
	unsigned long i;

	free_type_scope(variant_type->scope);
	g_hash_table_destroy(variant_type->fields_by_tag);

	for (i = 0; i < variant_type->fields->len; i++) {
		struct type_field *type_field =
			&g_array_index(variant_type->fields,
				       struct type_field, i);
		type_unref(type_field->type);
	}
	g_array_free(variant_type->fields, true);
	g_free(variant_type);
}

struct type_variant *variant_type_new(const char *name,
				      struct type_scope *parent_scope)
{
	struct type_variant *variant_type;
	struct type *type;

	variant_type = g_new(struct type_variant, 1);
	type = &variant_type->p;
	variant_type->fields_by_tag = g_hash_table_new(g_direct_hash,
						       g_direct_equal);
	variant_type->fields = g_array_sized_new(FALSE, TRUE,
						 sizeof(struct type_field),
						 DEFAULT_NR_STRUCT_FIELDS);
	variant_type->scope = new_type_scope(parent_scope);
	type->name = g_quark_from_string(name);
	type->alignment = 1;
	type->copy = variant_copy;
	type->type_free = _variant_type_free;
	type->declaration_new = _variant_declaration_new;
	type->declaration_free = _variant_declaration_free;
	type->ref = 1;
	return variant_type;
}

static
struct declaration *
	_variant_declaration_new(struct type *type,
				 struct declaration_scope *parent_scope)
{
	struct type_variant *variant_type =
		container_of(type, struct type_variant, p);
	struct declaration_variant *variant;
	unsigned long i;

	variant = g_new(struct declaration_variant, 1);
	type_ref(&variant_type->p);
	variant->p.type = type;
	variant->type = variant_type;
	variant->p.ref = 1;
	variant->scope = new_declaration_scope(parent_scope);
	variant->fields = g_array_sized_new(FALSE, TRUE,
					    sizeof(struct field),
					    DEFAULT_NR_STRUCT_FIELDS);
	g_array_set_size(variant->fields, variant_type->fields->len);
	for (i = 0; i < variant_type->fields->len; i++) {
		struct type_field *type_field =
			&g_array_index(variant_type->fields,
				       struct type_field, i);
		struct field *field = &g_array_index(variant->fields,
						     struct field, i);

		field->name = type_field->name;
		field->declaration =
			type_field->type->declaration_new(type_field->type,
							  variant->scope);
	}
	variant->current_field = NULL;
	return &variant->p;
}

static
void _variant_declaration_free(struct declaration *declaration)
{
	struct declaration_variant *variant =
		container_of(declaration, struct declaration_variant, p);
	unsigned long i;

	assert(variant->fields->len == variant->type->fields->len);
	for (i = 0; i < variant->fields->len; i++) {
		struct field *field = &g_array_index(variant->fields,
						     struct field, i);
		declaration_unref(field->declaration);
	}
	free_declaration_scope(variant->scope);
	type_unref(variant->p.type);
	g_free(variant);
}

void variant_type_add_field(struct type_variant *variant_type,
			    const char *tag_name,
			    struct type *tag_type)
{
	struct type_field *field;
	unsigned long index;

	g_array_set_size(variant_type->fields, variant_type->fields->len + 1);
	index = variant_type->fields->len - 1;	/* last field (new) */
	field = &g_array_index(variant_type->fields, struct type_field, index);
	field->name = g_quark_from_string(tag_name);
	type_ref(tag_type);
	field->type = tag_type;
	/* Keep index in hash rather than pointer, because array can relocate */
	g_hash_table_insert(variant_type->fields_by_tag,
			    (gpointer) (unsigned long) field->name,
			    (gpointer) index);
	/*
	 * Alignment of variant is based on the alignment of its currently
	 * selected choice, so we leave variant alignment as-is (statically
	 * speaking).
	 */
}

struct type_field *
struct_type_get_field_from_tag(struct type_variant *variant_type, GQuark tag)
{
	unsigned long index;

	index = (unsigned long) g_hash_table_lookup(variant_type->fields_by_tag,
						    (gconstpointer) (unsigned long) tag);
	return &g_array_index(variant_type->fields, struct type_field, index);
}

/*
 * tag_instance is assumed to be an enumeration.
 */
int variant_declaration_set_tag(struct declaration_variant *variant,
				struct declaration *enum_tag)
{
	struct declaration_enum *_enum =
		container_of(variant->enum_tag, struct declaration_enum, p);
	struct type_enum *enum_type = _enum->type;
	int missing_field = 0;
	unsigned long i;

	/*
	 * Strictly speaking, each enumerator must map to a field of the
	 * variant. However, we are even stricter here by requiring that each
	 * variant choice map to an enumerator too. We then validate that the
	 * number of enumerators equals the number of variant choices.
	 */
	if (variant->type->fields->len != enum_get_nr_enumerators(enum_type))
		return -EPERM;

	for (i = 0; i < variant->type->fields->len; i++) {
		struct type_field *field_type =
			&g_array_index(variant->type->fields,
				       struct type_field, i);
		if (!enum_quark_to_range_set(enum_type, field_type->name)) {
			missing_field = 1;
			break;
		}
	}
	if (missing_field)
		return -EPERM;

	/*
	 * Check the enumeration: it must map each value to one and only one
	 * enumerator tag.
	 * TODO: we should also check that each range map to one and only one
	 * tag. For the moment, we will simply check this dynamically in
	 * variant_type_get_current_field().
	 */

	/* Set the enum tag field */
	variant->enum_tag = enum_tag;
	return 0;
}

/*
 * field returned only valid as long as the field structure is not appended to.
 */
struct field *variant_get_current_field(struct declaration_variant *variant)
{
	struct declaration_enum *_enum =
		container_of(variant->enum_tag, struct declaration_enum, p);
	struct type_variant *variant_type = variant->type;
	unsigned long index;
	GArray *tag_array;
	GQuark tag;

	tag_array = _enum->value;
	/*
	 * The 1 to 1 mapping from enumeration to value should have been already
	 * checked. (see TODO above)
	 */
	assert(tag_array->len == 1);
	tag = g_array_index(tag_array, GQuark, 0);
	index = (unsigned long) g_hash_table_lookup(variant_type->fields_by_tag,
						    (gconstpointer) (unsigned long) tag);
	variant->current_field = &g_array_index(variant->fields, struct field, index);
	return variant->current_field;
}
Commit	Line	Data
c054553d MD	1	/*
	2	* variant.c
	3	*
	4	* BabelTrace - Variant Type Converter
	5	*
	6	* Copyright 2011 - Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
	7	*
	8	* Permission is hereby granted, free of charge, to any person obtaining a copy
	9	* of this software and associated documentation files (the "Software"), to deal
	10	* in the Software without restriction, including without limitation the rights
	11	* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
	12	* copies of the Software, and to permit persons to whom the Software is
	13	* furnished to do so, subject to the following conditions:
	14	*
	15	* The above copyright notice and this permission notice shall be included in
	16	* all copies or substantial portions of the Software.
	17	*/
	18
	19	#include <babeltrace/compiler.h>
	20	#include <babeltrace/format.h>
6ee5115e	21	#include <errno.h>
c054553d MD	22
c054553d MD	23	static
e19c3d69 MD	24	struct declaration _variant_declaration_new(struct type type,
e19c3d69 MD	25	struct declaration_scope *parent_scope);
c054553d	26	static
e19c3d69	27	void _variant_declaration_free(struct declaration *declaration);
c054553d MD	28
	29	void variant_copy(struct stream_pos dest, const struct format fdest,
	30	struct stream_pos src, const struct format fsrc,
e19c3d69	31	struct declaration *declaration)
c054553d	32	{
e19c3d69 MD	33	struct declaration_variant *variant =
	34	container_of(declaration, struct declaration_variant, p);
	35	struct type_variant *variant_type = variant->type;
c054553d	36	struct field *field;
e19c3d69	37	struct type *field_type;
c054553d	38
e19c3d69 MD	39	fsrc->variant_begin(src, variant_type);
e19c3d69 MD	40	fdest->variant_begin(dest, variant_type);
c054553d	41
e19c3d69	42	field = variant_get_current_field(variant);
6ee5115e MD	43	field_type = field->declaration->type;
6ee5115e MD	44	field_type->copy(dest, fdest, src, fsrc, field->declaration);
c054553d	45
e19c3d69 MD	46	fsrc->variant_end(src, variant_type);
e19c3d69 MD	47	fdest->variant_end(dest, variant_type);
c054553d MD	48	}
	49
	50	static
e19c3d69	51	void _variant_type_free(struct type *type)
c054553d	52	{
e19c3d69 MD	53	struct type_variant *variant_type =
e19c3d69 MD	54	container_of(type, struct type_variant, p);
c054553d MD	55	unsigned long i;
c054553d MD	56
64893f33	57	free_type_scope(variant_type->scope);
e19c3d69	58	g_hash_table_destroy(variant_type->fields_by_tag);
c054553d	59
e19c3d69	60	for (i = 0; i < variant_type->fields->len; i++) {
6ee5115e	61	struct type_field *type_field =
e19c3d69 MD	62	&g_array_index(variant_type->fields,
e19c3d69 MD	63	struct type_field, i);
6ee5115e	64	type_unref(type_field->type);
c054553d	65	}
e19c3d69 MD	66	g_array_free(variant_type->fields, true);
e19c3d69 MD	67	g_free(variant_type);
c054553d MD	68	}
c054553d MD	69
64893f33 MD	70	struct type_variant variant_type_new(const char name,
64893f33 MD	71	struct type_scope *parent_scope)
c054553d	72	{
e19c3d69 MD	73	struct type_variant *variant_type;
e19c3d69 MD	74	struct type *type;
c054553d	75
e19c3d69 MD	76	variant_type = g_new(struct type_variant, 1);
	77	type = &variant_type->p;
	78	variant_type->fields_by_tag = g_hash_table_new(g_direct_hash,
	79	g_direct_equal);
	80	variant_type->fields = g_array_sized_new(FALSE, TRUE,
	81	sizeof(struct type_field),
	82	DEFAULT_NR_STRUCT_FIELDS);
64893f33	83	variant_type->scope = new_type_scope(parent_scope);
e19c3d69 MD	84	type->name = g_quark_from_string(name);
	85	type->alignment = 1;
	86	type->copy = variant_copy;
	87	type->type_free = _variant_type_free;
	88	type->declaration_new = _variant_declaration_new;
	89	type->declaration_free = _variant_declaration_free;
	90	type->ref = 1;
e19c3d69	91	return variant_type;
c054553d MD	92	}
	93
	94	static
e19c3d69 MD	95	struct declaration *
	96	_variant_declaration_new(struct type *type,
	97	struct declaration_scope *parent_scope)
c054553d	98	{
e19c3d69 MD	99	struct type_variant *variant_type =
	100	container_of(type, struct type_variant, p);
	101	struct declaration_variant *variant;
ac88af75	102	unsigned long i;
c054553d	103
e19c3d69 MD	104	variant = g_new(struct declaration_variant, 1);
e19c3d69 MD	105	type_ref(&variant_type->p);
6ee5115e MD	106	variant->p.type = type;
6ee5115e MD	107	variant->type = variant_type;
c054553d MD	108	variant->p.ref = 1;
	109	variant->scope = new_declaration_scope(parent_scope);
	110	variant->fields = g_array_sized_new(FALSE, TRUE,
	111	sizeof(struct field),
	112	DEFAULT_NR_STRUCT_FIELDS);
ac88af75 MD	113	g_array_set_size(variant->fields, variant_type->fields->len);
	114	for (i = 0; i < variant_type->fields->len; i++) {
	115	struct type_field *type_field =
	116	&g_array_index(variant_type->fields,
	117	struct type_field, i);
	118	struct field *field = &g_array_index(variant->fields,
	119	struct field, i);
	120
	121	field->name = type_field->name;
	122	field->declaration =
	123	type_field->type->declaration_new(type_field->type,
	124	variant->scope);
	125	}
c054553d MD	126	variant->current_field = NULL;
	127	return &variant->p;
	128	}
	129
	130	static
6ee5115e	131	void _variant_declaration_free(struct declaration *declaration)
c054553d	132	{
e19c3d69 MD	133	struct declaration_variant *variant =
e19c3d69 MD	134	container_of(declaration, struct declaration_variant, p);
c054553d MD	135	unsigned long i;
c054553d MD	136
ac88af75	137	assert(variant->fields->len == variant->type->fields->len);
c054553d MD	138	for (i = 0; i < variant->fields->len; i++) {
	139	struct field *field = &g_array_index(variant->fields,
	140	struct field, i);
e19c3d69	141	declaration_unref(field->declaration);
c054553d MD	142	}
c054553d MD	143	free_declaration_scope(variant->scope);
e19c3d69	144	type_unref(variant->p.type);
c054553d MD	145	g_free(variant);
	146	}
	147
e19c3d69 MD	148	void variant_type_add_field(struct type_variant *variant_type,
	149	const char *tag_name,
	150	struct type *tag_type)
c054553d	151	{
e19c3d69	152	struct type_field *field;
c054553d MD	153	unsigned long index;
c054553d MD	154
e19c3d69 MD	155	g_array_set_size(variant_type->fields, variant_type->fields->len + 1);
	156	index = variant_type->fields->len - 1; /* last field (new) */
	157	field = &g_array_index(variant_type->fields, struct type_field, index);
c054553d	158	field->name = g_quark_from_string(tag_name);
e19c3d69 MD	159	type_ref(tag_type);
e19c3d69 MD	160	field->type = tag_type;
c054553d	161	/* Keep index in hash rather than pointer, because array can relocate */
6ee5115e	162	g_hash_table_insert(variant_type->fields_by_tag,
c054553d MD	163	(gpointer) (unsigned long) field->name,
	164	(gpointer) index);
	165	/*
	166	* Alignment of variant is based on the alignment of its currently
	167	* selected choice, so we leave variant alignment as-is (statically
	168	* speaking).
	169	*/
	170	}
	171
e19c3d69 MD	172	struct type_field *
e19c3d69 MD	173	struct_type_get_field_from_tag(struct type_variant *variant_type, GQuark tag)
c054553d MD	174	{
	175	unsigned long index;
	176
e19c3d69	177	index = (unsigned long) g_hash_table_lookup(variant_type->fields_by_tag,
c054553d	178	(gconstpointer) (unsigned long) tag);
e19c3d69	179	return &g_array_index(variant_type->fields, struct type_field, index);
c054553d MD	180	}
	181
	182	/*
	183	* tag_instance is assumed to be an enumeration.
	184	*/
e19c3d69 MD	185	int variant_declaration_set_tag(struct declaration_variant *variant,
e19c3d69 MD	186	struct declaration *enum_tag)
c054553d	187	{
e19c3d69 MD	188	struct declaration_enum *_enum =
	189	container_of(variant->enum_tag, struct declaration_enum, p);
	190	struct type_enum *enum_type = _enum->type;
c054553d MD	191	int missing_field = 0;
	192	unsigned long i;
	193
	194	/*
	195	* Strictly speaking, each enumerator must map to a field of the
	196	* variant. However, we are even stricter here by requiring that each
	197	* variant choice map to an enumerator too. We then validate that the
	198	* number of enumerators equals the number of variant choices.
	199	*/
e19c3d69	200	if (variant->type->fields->len != enum_get_nr_enumerators(enum_type))
c054553d MD	201	return -EPERM;
c054553d MD	202
e19c3d69 MD	203	for (i = 0; i < variant->type->fields->len; i++) {
	204	struct type_field *field_type =
	205	&g_array_index(variant->type->fields,
	206	struct type_field, i);
	207	if (!enum_quark_to_range_set(enum_type, field_type->name)) {
c054553d MD	208	missing_field = 1;
	209	break;
	210	}
	211	}
	212	if (missing_field)
	213	return -EPERM;
	214
	215	/*
	216	* Check the enumeration: it must map each value to one and only one
	217	* enumerator tag.
	218	* TODO: we should also check that each range map to one and only one
	219	* tag. For the moment, we will simply check this dynamically in
	220	* variant_type_get_current_field().
	221	*/
	222
	223	/* Set the enum tag field */
e19c3d69	224	variant->enum_tag = enum_tag;
c054553d MD	225	return 0;
	226	}
	227
	228	/*
	229	* field returned only valid as long as the field structure is not appended to.
	230	*/
e19c3d69	231	struct field variant_get_current_field(struct declaration_variant variant)
c054553d	232	{
e19c3d69 MD	233	struct declaration_enum *_enum =
e19c3d69 MD	234	container_of(variant->enum_tag, struct declaration_enum, p);
6ee5115e	235	struct type_variant *variant_type = variant->type;
c054553d MD	236	unsigned long index;
	237	GArray *tag_array;
	238	GQuark tag;
	239
	240	tag_array = _enum->value;
	241	/*
	242	* The 1 to 1 mapping from enumeration to value should have been already
	243	* checked. (see TODO above)
	244	*/
	245	assert(tag_array->len == 1);
	246	tag = g_array_index(tag_array, GQuark, 0);
e19c3d69	247	index = (unsigned long) g_hash_table_lookup(variant_type->fields_by_tag,
c054553d	248	(gconstpointer) (unsigned long) tag);
e19c3d69	249	variant->current_field = &g_array_index(variant->fields, struct field, index);
96354dac	250	return variant->current_field;
c054553d	251	}