[babeltrace.git] / types / struct.c

/*
 * struct.c
 *
 * BabelTrace - Structure Type Converter
 *
 * Copyright 2010, 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>

#ifndef max
#define max(a, b)	((a) < (b) ? (b) : (a))
#endif

static
struct definition *_struct_definition_new(struct declaration *declaration,
				struct definition_scope *parent_scope,
				GQuark field_name, int index);
static
void _struct_definition_free(struct definition *definition);

void struct_copy(struct stream_pos *dest, const struct format *fdest, 
		 struct stream_pos *src, const struct format *fsrc,
		 struct definition *definition)
{
	struct definition_struct *_struct =
		container_of(definition, struct definition_struct, p);
	struct declaration_struct *struct_declaration = _struct->declaration;
	unsigned long i;

	fsrc->struct_begin(src, struct_declaration);
	fdest->struct_begin(dest, struct_declaration);

	for (i = 0; i < _struct->fields->len; i++) {
		struct field *field = &g_array_index(_struct->fields,
						     struct field, i);
		struct declaration *field_declaration = field->definition->declaration;

		field_declaration->copy(dest, fdest, src, fsrc, field->definition);

	}
	fsrc->struct_end(src, struct_declaration);
	fdest->struct_end(dest, struct_declaration);
}

static
void _struct_declaration_free(struct declaration *declaration)
{
	struct declaration_struct *struct_declaration =
		container_of(declaration, struct declaration_struct, p);
	unsigned long i;

	free_declaration_scope(struct_declaration->scope);
	g_hash_table_destroy(struct_declaration->fields_by_name);

	for (i = 0; i < struct_declaration->fields->len; i++) {
		struct declaration_field *declaration_field =
			&g_array_index(struct_declaration->fields,
				       struct declaration_field, i);
		declaration_unref(declaration_field->declaration);
	}
	g_array_free(struct_declaration->fields, true);
	g_free(struct_declaration);
}

struct declaration_struct *
	struct_declaration_new(struct declaration_scope *parent_scope)
{
	struct declaration_struct *struct_declaration;
	struct declaration *declaration;

	struct_declaration = g_new(struct declaration_struct, 1);
	declaration = &struct_declaration->p;
	struct_declaration->fields_by_name = g_hash_table_new(g_direct_hash,
						       g_direct_equal);
	struct_declaration->fields = g_array_sized_new(FALSE, TRUE,
						sizeof(struct declaration_field),
						DEFAULT_NR_STRUCT_FIELDS);
	struct_declaration->scope = new_declaration_scope(parent_scope);
	declaration->id = CTF_TYPE_STRUCT;
	declaration->alignment = 1;
	declaration->copy = struct_copy;
	declaration->declaration_free = _struct_declaration_free;
	declaration->definition_new = _struct_definition_new;
	declaration->definition_free = _struct_definition_free;
	declaration->ref = 1;
	return struct_declaration;
}

static
struct definition *
	_struct_definition_new(struct declaration *declaration,
			       struct definition_scope *parent_scope,
			       GQuark field_name, int index)
{
	struct declaration_struct *struct_declaration =
		container_of(declaration, struct declaration_struct, p);
	struct definition_struct *_struct;
	unsigned long i;
	int ret;

	_struct = g_new(struct definition_struct, 1);
	declaration_ref(&struct_declaration->p);
	_struct->p.declaration = declaration;
	_struct->declaration = struct_declaration;
	_struct->p.ref = 1;
	_struct->p.index = index;
	_struct->scope = new_definition_scope(parent_scope, field_name);
	_struct->fields = g_array_sized_new(FALSE, TRUE,
					    sizeof(struct field),
					    DEFAULT_NR_STRUCT_FIELDS);
	g_array_set_size(_struct->fields, struct_declaration->fields->len);
	for (i = 0; i < struct_declaration->fields->len; i++) {
		struct declaration_field *declaration_field =
			&g_array_index(struct_declaration->fields,
				       struct declaration_field, i);
		struct field *field = &g_array_index(_struct->fields,
						     struct field, i);

		field->name = declaration_field->name;
		field->definition =
			declaration_field->declaration->definition_new(declaration_field->declaration,
							  _struct->scope,
							  field->name, i);
		ret = register_field_definition(field->name,
						field->definition,
						_struct->scope);
		assert(!ret);
	}
	return &_struct->p;
}

static
void _struct_definition_free(struct definition *definition)
{
	struct definition_struct *_struct =
		container_of(definition, struct definition_struct, p);
	unsigned long i;

	assert(_struct->fields->len == _struct->declaration->fields->len);
	for (i = 0; i < _struct->fields->len; i++) {
		struct field *field = &g_array_index(_struct->fields,
						     struct field, i);
		definition_unref(field->definition);
	}
	free_definition_scope(_struct->scope);
	declaration_unref(_struct->p.declaration);
	g_free(_struct);
}

void struct_declaration_add_field(struct declaration_struct *struct_declaration,
			   const char *field_name,
			   struct declaration *field_declaration)
{
	struct declaration_field *field;
	unsigned long index;

	g_array_set_size(struct_declaration->fields, struct_declaration->fields->len + 1);
	index = struct_declaration->fields->len - 1;	/* last field (new) */
	field = &g_array_index(struct_declaration->fields, struct declaration_field, index);
	field->name = g_quark_from_string(field_name);
	declaration_ref(field_declaration);
	field->declaration = field_declaration;
	/* Keep index in hash rather than pointer, because array can relocate */
	g_hash_table_insert(struct_declaration->fields_by_name,
			    (gpointer) (unsigned long) field->name,
			    (gpointer) index);
	/*
	 * Alignment of structure is the max alignment of declarations contained
	 * therein.
	 */
	struct_declaration->p.alignment = max(struct_declaration->p.alignment,
				       field_declaration->alignment);
}

unsigned long
	struct_declaration_lookup_field_index(struct declaration_struct *struct_declaration,
				       GQuark field_name)
{
	unsigned long index;

	index = (unsigned long) g_hash_table_lookup(struct_declaration->fields_by_name,
						    (gconstpointer) (unsigned long) field_name);
	return index;
}

/*
 * field returned only valid as long as the field structure is not appended to.
 */
struct declaration_field *
	struct_declaration_get_field_from_index(struct declaration_struct *struct_declaration,
					 unsigned long index)
{
	return &g_array_index(struct_declaration->fields, struct declaration_field, index);
}

/*
 * field returned only valid as long as the field structure is not appended to.
 */
struct field *
struct_definition_get_field_from_index(struct definition_struct *_struct,
					unsigned long index)
{
	return &g_array_index(_struct->fields, struct field, index);
}
Commit	Line	Data
	1	/*
	2	* struct.c
	3	*
	4	* BabelTrace - Structure Type Converter
	5	*
	6	* Copyright 2010, 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>
	21
	22	#ifndef max
	23	#define max(a, b) ((a) < (b) ? (b) : (a))
	24	#endif
	25
	26	static
	27	struct definition _struct_definition_new(struct declaration declaration,
	28	struct definition_scope *parent_scope,
	29	GQuark field_name, int index);
	30	static
	31	void _struct_definition_free(struct definition *definition);
	32
	33	void struct_copy(struct stream_pos dest, const struct format fdest,
	34	struct stream_pos src, const struct format fsrc,
	35	struct definition *definition)
	36	{
	37	struct definition_struct *_struct =
	38	container_of(definition, struct definition_struct, p);
	39	struct declaration_struct *struct_declaration = _struct->declaration;
	40	unsigned long i;
	41
	42	fsrc->struct_begin(src, struct_declaration);
	43	fdest->struct_begin(dest, struct_declaration);
	44
	45	for (i = 0; i < _struct->fields->len; i++) {
	46	struct field *field = &g_array_index(_struct->fields,
	47	struct field, i);
	48	struct declaration *field_declaration = field->definition->declaration;
	49
	50	field_declaration->copy(dest, fdest, src, fsrc, field->definition);
	51
	52	}
	53	fsrc->struct_end(src, struct_declaration);
	54	fdest->struct_end(dest, struct_declaration);
	55	}
	56
	57	static
	58	void _struct_declaration_free(struct declaration *declaration)
	59	{
	60	struct declaration_struct *struct_declaration =
	61	container_of(declaration, struct declaration_struct, p);
	62	unsigned long i;
	63
	64	free_declaration_scope(struct_declaration->scope);
	65	g_hash_table_destroy(struct_declaration->fields_by_name);
	66
	67	for (i = 0; i < struct_declaration->fields->len; i++) {
	68	struct declaration_field *declaration_field =
	69	&g_array_index(struct_declaration->fields,
	70	struct declaration_field, i);
	71	declaration_unref(declaration_field->declaration);
	72	}
	73	g_array_free(struct_declaration->fields, true);
	74	g_free(struct_declaration);
	75	}
	76
	77	struct declaration_struct *
	78	struct_declaration_new(struct declaration_scope *parent_scope)
	79	{
	80	struct declaration_struct *struct_declaration;
	81	struct declaration *declaration;
	82
	83	struct_declaration = g_new(struct declaration_struct, 1);
	84	declaration = &struct_declaration->p;
	85	struct_declaration->fields_by_name = g_hash_table_new(g_direct_hash,
	86	g_direct_equal);
	87	struct_declaration->fields = g_array_sized_new(FALSE, TRUE,
	88	sizeof(struct declaration_field),
	89	DEFAULT_NR_STRUCT_FIELDS);
	90	struct_declaration->scope = new_declaration_scope(parent_scope);
	91	declaration->id = CTF_TYPE_STRUCT;
	92	declaration->alignment = 1;
	93	declaration->copy = struct_copy;
	94	declaration->declaration_free = _struct_declaration_free;
	95	declaration->definition_new = _struct_definition_new;
	96	declaration->definition_free = _struct_definition_free;
	97	declaration->ref = 1;
	98	return struct_declaration;
	99	}
	100
	101	static
	102	struct definition *
	103	_struct_definition_new(struct declaration *declaration,
	104	struct definition_scope *parent_scope,
	105	GQuark field_name, int index)
	106	{
	107	struct declaration_struct *struct_declaration =
	108	container_of(declaration, struct declaration_struct, p);
	109	struct definition_struct *_struct;
	110	unsigned long i;
	111	int ret;
	112
	113	_struct = g_new(struct definition_struct, 1);
	114	declaration_ref(&struct_declaration->p);
	115	_struct->p.declaration = declaration;
	116	_struct->declaration = struct_declaration;
	117	_struct->p.ref = 1;
	118	_struct->p.index = index;
	119	_struct->scope = new_definition_scope(parent_scope, field_name);
	120	_struct->fields = g_array_sized_new(FALSE, TRUE,
	121	sizeof(struct field),
	122	DEFAULT_NR_STRUCT_FIELDS);
	123	g_array_set_size(_struct->fields, struct_declaration->fields->len);
	124	for (i = 0; i < struct_declaration->fields->len; i++) {
	125	struct declaration_field *declaration_field =
	126	&g_array_index(struct_declaration->fields,
	127	struct declaration_field, i);
	128	struct field *field = &g_array_index(_struct->fields,
	129	struct field, i);
	130
	131	field->name = declaration_field->name;
	132	field->definition =
	133	declaration_field->declaration->definition_new(declaration_field->declaration,
	134	_struct->scope,
	135	field->name, i);
	136	ret = register_field_definition(field->name,
	137	field->definition,
	138	_struct->scope);
	139	assert(!ret);
	140	}
	141	return &_struct->p;
	142	}
	143
	144	static
	145	void _struct_definition_free(struct definition *definition)
	146	{
	147	struct definition_struct *_struct =
	148	container_of(definition, struct definition_struct, p);
	149	unsigned long i;
	150
	151	assert(_struct->fields->len == _struct->declaration->fields->len);
	152	for (i = 0; i < _struct->fields->len; i++) {
	153	struct field *field = &g_array_index(_struct->fields,
	154	struct field, i);
	155	definition_unref(field->definition);
	156	}
	157	free_definition_scope(_struct->scope);
	158	declaration_unref(_struct->p.declaration);
	159	g_free(_struct);
	160	}
	161
	162	void struct_declaration_add_field(struct declaration_struct *struct_declaration,
	163	const char *field_name,
	164	struct declaration *field_declaration)
	165	{
	166	struct declaration_field *field;
	167	unsigned long index;
	168
	169	g_array_set_size(struct_declaration->fields, struct_declaration->fields->len + 1);
	170	index = struct_declaration->fields->len - 1; /* last field (new) */
	171	field = &g_array_index(struct_declaration->fields, struct declaration_field, index);
	172	field->name = g_quark_from_string(field_name);
	173	declaration_ref(field_declaration);
	174	field->declaration = field_declaration;
	175	/* Keep index in hash rather than pointer, because array can relocate */
	176	g_hash_table_insert(struct_declaration->fields_by_name,
	177	(gpointer) (unsigned long) field->name,
	178	(gpointer) index);
	179	/*
	180	* Alignment of structure is the max alignment of declarations contained
	181	* therein.
	182	*/
	183	struct_declaration->p.alignment = max(struct_declaration->p.alignment,
	184	field_declaration->alignment);
	185	}
	186
	187	unsigned long
	188	struct_declaration_lookup_field_index(struct declaration_struct *struct_declaration,
	189	GQuark field_name)
	190	{
	191	unsigned long index;
	192
	193	index = (unsigned long) g_hash_table_lookup(struct_declaration->fields_by_name,
	194	(gconstpointer) (unsigned long) field_name);
	195	return index;
	196	}
	197
	198	/*
	199	* field returned only valid as long as the field structure is not appended to.
	200	*/
	201	struct declaration_field *
	202	struct_declaration_get_field_from_index(struct declaration_struct *struct_declaration,
	203	unsigned long index)
	204	{
	205	return &g_array_index(struct_declaration->fields, struct declaration_field, index);
	206	}
	207
	208	/*
	209	* field returned only valid as long as the field structure is not appended to.
	210	*/
	211	struct field *
	212	struct_definition_get_field_from_index(struct definition_struct *_struct,
	213	unsigned long index)
	214	{
	215	return &g_array_index(_struct->fields, struct field, index);
	216	}