[babeltrace.git] / include / babeltrace / types.h

#ifndef _BABELTRACE_TYPES_H
#define _BABELTRACE_TYPES_H

/*
 * BabelTrace
 *
 * Type Header
 *
 * 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/align.h>
#include <babeltrace/list.h>
#include <stdbool.h>
#include <stdint.h>
#include <limits.h>
#include <string.h>
#include <glib.h>
#include <assert.h>

/* Preallocate this many fields for structures */
#define DEFAULT_NR_STRUCT_FIELDS 8

/*
 * Always update stream_pos with move_pos and init_pos.
 */
struct stream_pos {
	char *base;		/* Base address */
	size_t offset;		/* Offset from base, in bits */
	int dummy;		/* Dummy position, for length calculation */
};

static inline
void init_pos(struct stream_pos *pos, char *base)
{
	pos->base = base;	/* initial base, page-aligned */
	pos->offset = 0;
	pos->dummy = false;
}

/*
 * move_pos - move position of a relative bit offset
 *
 * TODO: allow larger files by updating base too.
 */
static inline
void move_pos(struct stream_pos *pos, size_t offset)
{
	pos->offset = pos->offset + offset;
}

/*
 * align_pos - align position on a bit offset (> 0)
 *
 * TODO: allow larger files by updating base too.
 */
static inline
void align_pos(struct stream_pos *pos, size_t offset)
{
	pos->offset += offset_align(pos->offset, offset);
}

static inline
void copy_pos(struct stream_pos *dest, struct stream_pos *src)
{
	memcpy(dest, src, sizeof(struct stream_pos));
}

static inline
char *get_pos_addr(struct stream_pos *pos)
{
	/* Only makes sense to get the address after aligning on CHAR_BIT */
	assert(!(pos->offset % CHAR_BIT));
	return pos->base + (pos->offset / CHAR_BIT);
}

struct format;
struct definition;

/* type scope */
struct declaration_scope {
	/* Hash table mapping type name GQuark to "struct declaration" */
	GHashTable *typedef_declarations;
	/* Hash table mapping struct name GQuark to "struct declaration_struct" */
	GHashTable *struct_declarations;
	/* Hash table mapping variant name GQuark to "struct declaration_variant" */
	GHashTable *variant_declarations;
	/* Hash table mapping enum name GQuark to "struct type_enum" */
	GHashTable *enum_declarations;
	struct declaration_scope *parent_scope;
};

/* definition scope */
struct definition_scope {
	/* Hash table mapping field name GQuark to "struct definition" */
	GHashTable *definitions;
	struct definition_scope *parent_scope;
	/*
	 * Complete "path" leading to this definition scope.
	 * Includes trace/stream/event '.' field name '.' field name '.' ....
	 * Array of GQuark elements (which are each separated by dots).
	 */
	GArray *scope_path;	/* array of GQuark */
};

enum ctf_type_id {
	CTF_TYPE_UNKNOWN = 0,
	CTF_TYPE_INTEGER,
	CTF_TYPE_FLOAT,
	CTF_TYPE_ENUM,
	CTF_TYPE_STRING,
	CTF_TYPE_STRUCT,
	CTF_TYPE_VARIANT,
	CTF_TYPE_ARRAY,
	CTF_TYPE_SEQUENCE,
	NR_CTF_TYPES,
};

struct declaration {
	enum ctf_type_id id;
	GQuark name;		/* type name */
	size_t alignment;	/* type alignment, in bits */
	int ref;		/* number of references to the type */
	/*
	 * declaration_free called with declaration ref is decremented to 0.
	 */
	void (*declaration_free)(struct declaration *declaration);
	struct definition *
		(*definition_new)(struct declaration *declaration,
				  struct definition_scope *parent_scope,
				  GQuark field_name, int index);
	/*
	 * definition_free called with definition ref is decremented to 0.
	 */
	void (*definition_free)(struct definition *definition);
	/*
	 * Definition copy function. Knows how to find the child
	 * definition from the parent definition.
	 */
	void (*copy)(struct stream_pos *dest, const struct format *fdest, 
		     struct stream_pos *src, const struct format *fsrc,
		     struct definition *definition);
};

struct definition {
	struct declaration *declaration;
	int index;		/* Position of the definition in its container */
	int ref;		/* number of references to the definition */
};

/*
 * Because we address in bits, bitfields end up being exactly the same as
 * integers, except that their read/write functions must be able to deal with
 * read/write non aligned on CHAR_BIT.
 */
struct declaration_integer {
	struct declaration p;
	size_t len;		/* length, in bits. */
	int byte_order;		/* byte order */
	int signedness;
};

struct definition_integer {
	struct definition p;
	struct declaration_integer *declaration;
	/* Last values read */
	union {
		uint64_t _unsigned;
		int64_t _signed;
	} value;
};

struct declaration_float {
	struct declaration p;
	struct declaration_integer *sign;
	struct declaration_integer *mantissa;
	struct declaration_integer *exp;
	int byte_order;
	/* TODO: we might want to express more info about NaN, +inf and -inf */
};

struct definition_float {
	struct definition p;
	struct declaration_float *declaration;
	/* Last values read */
	long double value;
};

/*
 * enum_val_equal assumes that signed and unsigned memory layout overlap.
 */
struct enum_range {
	union {
		int64_t _signed;
		uint64_t _unsigned;
	} start;	/* lowest range value */
	union {
		int64_t _signed;
		uint64_t _unsigned;
	} end;		/* highest range value */
};

struct enum_range_to_quark {
	struct cds_list_head node;
	struct enum_range range;
	GQuark quark;
};

/*
 * We optimize the common case (range of size 1: single value) by creating a
 * hash table mapping values to quark sets. We then lookup the ranges to
 * complete the quark set.
 *
 * TODO: The proper structure to hold the range to quark set mapping would be an
 * interval tree, with O(n) size, O(n*log(n)) build time and O(log(n)) query
 * time. Using a simple O(n) list search for now for implementation speed and
 * given that we can expect to have a _relatively_ small number of enumeration
 * ranges. This might become untrue if we are fed with symbol tables often
 * required to lookup function names from instruction pointer value.
 */
struct enum_table {
	GHashTable *value_to_quark_set;		/* (value, GQuark GArray) */
	struct cds_list_head range_to_quark;	/* (range, GQuark) */
	GHashTable *quark_to_range_set;		/* (GQuark, range GArray) */
};

struct declaration_enum {
	struct declaration p;
	struct declaration_integer *integer_declaration;
	struct enum_table table;
};

struct definition_enum {
	struct definition p;
	struct definition_integer *integer;
	struct declaration_enum *declaration;
	/* Last GQuark values read. Keeping a reference on the GQuark array. */
	GArray *value;
};

struct declaration_string {
	struct declaration p;
};

struct definition_string {
	struct definition p;
	struct declaration_string *declaration;
	char *value;	/* freed at definition_string teardown */
};

struct declaration_field {
	GQuark name;
	struct declaration *declaration;
};

struct field {
	GQuark name;
	struct definition *definition;
};

struct declaration_struct {
	struct declaration p;
	GHashTable *fields_by_name;	/* Tuples (field name, field index) */
	struct declaration_scope *scope;
	GArray *fields;			/* Array of declaration_field */
};

struct definition_struct {
	struct definition p;
	struct declaration_struct *declaration;
	struct definition_scope *scope;
	GArray *fields;			/* Array of struct field */
};

struct declaration_variant {
	struct declaration p;
	GHashTable *fields_by_tag;	/* Tuples (field tag, field index) */
	struct declaration_scope *scope;
	GArray *fields;			/* Array of declaration_field */
	GQuark tag_name;		/* TODO */
	/* Tag name must be nonzero and must exist when defining the variant */
};

struct definition_variant {
	struct definition p;
	struct declaration_variant *declaration;
	struct definition_scope *scope;
	struct definition *enum_tag;
	GArray *fields;			/* Array of struct field */
	struct field *current_field;	/* Last field read */
};

struct declaration_array {
	struct declaration p;
	size_t len;
	struct declaration *elem;
	struct declaration_scope *scope;
};

struct definition_array {
	struct definition p;
	struct declaration_array *declaration;
	struct definition_scope *scope;
	struct field current_element;		/* struct field */
};

struct declaration_sequence {
	struct declaration p;
	struct declaration_integer *len_declaration;
	struct declaration *elem;
	struct declaration_scope *scope;
};

struct definition_sequence {
	struct definition p;
	struct declaration_sequence *declaration;
	struct definition_scope *scope;
	struct definition_integer *len;
	struct field current_element;		/* struct field */
};

int register_declaration(GQuark declaration_name,
			 struct declaration *declaration,
			 struct declaration_scope *scope);
struct declaration *lookup_declaration(GQuark declaration_name,
				       struct declaration_scope *scope);

/*
 * Type scopes also contain a separate registry for struct, variant and
 * enum types. Those register types rather than type definitions, so
 * that a named variant can be declared without specifying its target
 * "choice" tag field immediately.
 */
int register_struct_declaration(GQuark struct_name,
				struct declaration_struct *struct_declaration,
				struct declaration_scope *scope);
struct declaration_struct *
	lookup_struct_declaration(GQuark struct_name,
				  struct declaration_scope *scope);
int register_variant_declaration(GQuark variant_name,
			  struct declaration_variant *variant_declaration,
		          struct declaration_scope *scope);
struct declaration_variant *lookup_variant_declaration(GQuark variant_name,
					 struct declaration_scope *scope);
int register_enum_declaration(GQuark enum_name,
			      struct declaration_enum *enum_declaration,
			      struct declaration_scope *scope);
struct declaration_enum *
	lookup_enum_declaration(GQuark enum_name,
			        struct declaration_scope *scope);

struct declaration_scope *
	new_declaration_scope(struct declaration_scope *parent_scope);
void free_declaration_scope(struct declaration_scope *scope);

/*
 * field_definition is for field definitions. They are registered into
 * definition scopes.
 */
struct definition *
	lookup_definition(GArray *cur_path,	/* array of GQuark */
			  GArray *lookup_path,	/* array of GQuark */
			  struct definition_scope *scope);
int register_field_definition(GQuark field_name,
			      struct definition *definition,
			      struct definition_scope *scope);
struct definition_scope *
	new_definition_scope(struct definition_scope *parent_scope,
			     GQuark field_name);
void free_definition_scope(struct definition_scope *scope);

void declaration_ref(struct declaration *declaration);
void declaration_unref(struct declaration *declaration);

void definition_ref(struct definition *definition);
void definition_unref(struct definition *definition);

/* Nameless declarations can be created by passing a NULL name */

struct declaration_integer *integer_declaration_new(const char *name,
				      size_t len, int byte_order,
				      int signedness, size_t alignment);

/*
 * mantissa_len is the length of the number of bytes represented by the mantissa
 * (e.g. result of DBL_MANT_DIG). It includes the leading 1.
 */
struct declaration_float *float_declaration_new(const char *name,
				  size_t mantissa_len,
				  size_t exp_len, int byte_order,
				  size_t alignment);

/*
 * A GQuark can be translated to/from strings with g_quark_from_string() and
 * g_quark_to_string().
 */

/*
 * Returns a GArray of GQuark or NULL.
 * Caller must release the GArray with g_array_unref().
 */
GArray *enum_uint_to_quark_set(const struct declaration_enum *enum_declaration,
			       uint64_t v);

/*
 * Returns a GArray of GQuark or NULL.
 * Caller must release the GArray with g_array_unref().
 */
GArray *enum_int_to_quark_set(const struct declaration_enum *enum_declaration,
			      uint64_t v);

/*
 * Returns a GArray of struct enum_range or NULL.
 * Callers do _not_ own the returned GArray (and therefore _don't_ need to
 * release it).
 */
GArray *enum_quark_to_range_set(const struct declaration_enum *enum_declaration,
				GQuark q);
void enum_signed_insert(struct declaration_enum *enum_declaration,
                        int64_t start, int64_t end, GQuark q);
void enum_unsigned_insert(struct declaration_enum *enum_declaration,
			  uint64_t start, uint64_t end, GQuark q);
size_t enum_get_nr_enumerators(struct declaration_enum *enum_declaration);

struct declaration_enum *
	enum_declaration_new(const char *name,
			     struct declaration_integer *integer_declaration);

struct declaration_struct *
	struct_declaration_new(const char *name,
			       struct declaration_scope *parent_scope);
void struct_declaration_add_field(struct declaration_struct *struct_declaration,
				  const char *field_name,
				  struct declaration *field_declaration);
/*
 * Returns the index of a field within a structure.
 */
unsigned long struct_declaration_lookup_field_index(struct declaration_struct *struct_declaration,
						    GQuark field_name);
/*
 * 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);
struct field *
struct_get_field_from_index(struct definition_struct *struct_definition,
			    unsigned long index);

/*
 * The tag enumeration is validated to ensure that it contains only mappings
 * from numeric values to a single tag. Overlapping tag value ranges are
 * therefore forbidden.
 */
struct declaration_variant *variant_declaration_new(const char *name,
		struct declaration_scope *parent_scope);
void variant_declaration_add_field(struct declaration_variant *variant_declaration,
		const char *tag_name,
		struct declaration *tag_declaration);
struct declaration_field *
	variant_declaration_get_field_from_tag(struct declaration_variant *variant_declaration,
		GQuark tag);
/*
 * Returns 0 on success, -EPERM on error.
 */
int variant_definition_set_tag(struct definition_variant *variant,
			       struct definition *enum_tag);
/*
 * Returns the field selected by the current tag value.
 * field returned only valid as long as the variant structure is not appended
 * to.
 */
struct field *variant_get_current_field(struct definition_variant *variant);

/*
 * elem_declaration passed as parameter now belongs to the array. No
 * need to free it explicitly. "len" is the number of elements in the
 * array.
 */
struct declaration_array *
	array_declaration_new(const char *name,
		size_t len, struct declaration *elem_declaration,
		struct declaration_scope *parent_scope);

/*
 * int_declaration and elem_declaration passed as parameter now belong
 * to the sequence. No need to free them explicitly.
 */
struct declaration_sequence *
	sequence_declaration_new(const char *name,
		struct declaration_integer *len_declaration, 
		struct declaration *elem_declaration,
		struct declaration_scope *parent_scope);

#endif /* _BABELTRACE_declarationS_H */
Commit	Line	Data
	1	#ifndef _BABELTRACE_TYPES_H
	2	#define _BABELTRACE_TYPES_H
	3
	4	/*
	5	* BabelTrace
	6	*
	7	* Type Header
	8	*
	9	* Copyright 2010, 2011 - Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
	10	*
	11	* Permission is hereby granted, free of charge, to any person obtaining a copy
	12	* of this software and associated documentation files (the "Software"), to deal
	13	* in the Software without restriction, including without limitation the rights
	14	* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
	15	* copies of the Software, and to permit persons to whom the Software is
	16	* furnished to do so, subject to the following conditions:
	17	*
	18	* The above copyright notice and this permission notice shall be included in
	19	* all copies or substantial portions of the Software.
	20	*/
	21
	22	#include <babeltrace/align.h>
	23	#include <babeltrace/list.h>
	24	#include <stdbool.h>
	25	#include <stdint.h>
	26	#include <limits.h>
	27	#include <string.h>
	28	#include <glib.h>
	29	#include <assert.h>
	30
	31	/* Preallocate this many fields for structures */
	32	#define DEFAULT_NR_STRUCT_FIELDS 8
	33
	34	/*
	35	* Always update stream_pos with move_pos and init_pos.
	36	*/
	37	struct stream_pos {
	38	char base; / Base address */
	39	size_t offset; /* Offset from base, in bits */
	40	int dummy; /* Dummy position, for length calculation */
	41	};
	42
	43	static inline
	44	void init_pos(struct stream_pos pos, char base)
	45	{
	46	pos->base = base; /* initial base, page-aligned */
	47	pos->offset = 0;
	48	pos->dummy = false;
	49	}
	50
	51	/*
	52	* move_pos - move position of a relative bit offset
	53	*
	54	* TODO: allow larger files by updating base too.
	55	*/
	56	static inline
	57	void move_pos(struct stream_pos *pos, size_t offset)
	58	{
	59	pos->offset = pos->offset + offset;
	60	}
	61
	62	/*
	63	* align_pos - align position on a bit offset (> 0)
	64	*
	65	* TODO: allow larger files by updating base too.
	66	*/
	67	static inline
	68	void align_pos(struct stream_pos *pos, size_t offset)
	69	{
	70	pos->offset += offset_align(pos->offset, offset);
	71	}
	72
	73	static inline
	74	void copy_pos(struct stream_pos dest, struct stream_pos src)
	75	{
	76	memcpy(dest, src, sizeof(struct stream_pos));
	77	}
	78
	79	static inline
	80	char get_pos_addr(struct stream_pos pos)
	81	{
	82	/* Only makes sense to get the address after aligning on CHAR_BIT */
	83	assert(!(pos->offset % CHAR_BIT));
	84	return pos->base + (pos->offset / CHAR_BIT);
	85	}
	86
	87	struct format;
	88	struct definition;
	89
	90	/* type scope */
	91	struct declaration_scope {
	92	/* Hash table mapping type name GQuark to "struct declaration" */
	93	GHashTable *typedef_declarations;
	94	/* Hash table mapping struct name GQuark to "struct declaration_struct" */
	95	GHashTable *struct_declarations;
	96	/* Hash table mapping variant name GQuark to "struct declaration_variant" */
	97	GHashTable *variant_declarations;
	98	/* Hash table mapping enum name GQuark to "struct type_enum" */
	99	GHashTable *enum_declarations;
	100	struct declaration_scope *parent_scope;
	101	};
	102
	103	/* definition scope */
	104	struct definition_scope {
	105	/* Hash table mapping field name GQuark to "struct definition" */
	106	GHashTable *definitions;
	107	struct definition_scope *parent_scope;
	108	/*
	109	* Complete "path" leading to this definition scope.
	110	* Includes trace/stream/event '.' field name '.' field name '.' ....
	111	* Array of GQuark elements (which are each separated by dots).
	112	*/
	113	GArray scope_path; / array of GQuark */
	114	};
	115
	116	enum ctf_type_id {
	117	CTF_TYPE_UNKNOWN = 0,
	118	CTF_TYPE_INTEGER,
	119	CTF_TYPE_FLOAT,
	120	CTF_TYPE_ENUM,
	121	CTF_TYPE_STRING,
	122	CTF_TYPE_STRUCT,
	123	CTF_TYPE_VARIANT,
	124	CTF_TYPE_ARRAY,
	125	CTF_TYPE_SEQUENCE,
	126	NR_CTF_TYPES,
	127	};
	128
	129	struct declaration {
	130	enum ctf_type_id id;
	131	GQuark name; /* type name */
	132	size_t alignment; /* type alignment, in bits */
	133	int ref; /* number of references to the type */
	134	/*
	135	* declaration_free called with declaration ref is decremented to 0.
	136	*/
	137	void (declaration_free)(struct declaration declaration);
	138	struct definition *
	139	(definition_new)(struct declaration declaration,
	140	struct definition_scope *parent_scope,
	141	GQuark field_name, int index);
	142	/*
	143	* definition_free called with definition ref is decremented to 0.
	144	*/
	145	void (definition_free)(struct definition definition);
	146	/*
	147	* Definition copy function. Knows how to find the child
	148	* definition from the parent definition.
	149	*/
	150	void (copy)(struct stream_pos dest, const struct format *fdest,
	151	struct stream_pos src, const struct format fsrc,
	152	struct definition *definition);
	153	};
	154
	155	struct definition {
	156	struct declaration *declaration;
	157	int index; /* Position of the definition in its container */
	158	int ref; /* number of references to the definition */
	159	};
	160
	161	/*
	162	* Because we address in bits, bitfields end up being exactly the same as
	163	* integers, except that their read/write functions must be able to deal with
	164	* read/write non aligned on CHAR_BIT.
	165	*/
	166	struct declaration_integer {
	167	struct declaration p;
	168	size_t len; /* length, in bits. */
	169	int byte_order; /* byte order */
	170	int signedness;
	171	};
	172
	173	struct definition_integer {
	174	struct definition p;
	175	struct declaration_integer *declaration;
	176	/* Last values read */
	177	union {
	178	uint64_t _unsigned;
	179	int64_t _signed;
	180	} value;
	181	};
	182
	183	struct declaration_float {
	184	struct declaration p;
	185	struct declaration_integer *sign;
	186	struct declaration_integer *mantissa;
	187	struct declaration_integer *exp;
	188	int byte_order;
	189	/* TODO: we might want to express more info about NaN, +inf and -inf */
	190	};
	191
	192	struct definition_float {
	193	struct definition p;
	194	struct declaration_float *declaration;
	195	/* Last values read */
	196	long double value;
	197	};
	198
	199	/*
	200	* enum_val_equal assumes that signed and unsigned memory layout overlap.
	201	*/
	202	struct enum_range {
	203	union {
	204	int64_t _signed;
	205	uint64_t _unsigned;
	206	} start; /* lowest range value */
	207	union {
	208	int64_t _signed;
	209	uint64_t _unsigned;
	210	} end; /* highest range value */
	211	};
	212
	213	struct enum_range_to_quark {
	214	struct cds_list_head node;
	215	struct enum_range range;
	216	GQuark quark;
	217	};
	218
	219	/*
	220	* We optimize the common case (range of size 1: single value) by creating a
	221	* hash table mapping values to quark sets. We then lookup the ranges to
	222	* complete the quark set.
	223	*
	224	* TODO: The proper structure to hold the range to quark set mapping would be an
	225	* interval tree, with O(n) size, O(n*log(n)) build time and O(log(n)) query
	226	* time. Using a simple O(n) list search for now for implementation speed and
	227	* given that we can expect to have a _relatively_ small number of enumeration
	228	* ranges. This might become untrue if we are fed with symbol tables often
	229	* required to lookup function names from instruction pointer value.
	230	*/
	231	struct enum_table {
	232	GHashTable value_to_quark_set; / (value, GQuark GArray) */
	233	struct cds_list_head range_to_quark; /* (range, GQuark) */
	234	GHashTable quark_to_range_set; / (GQuark, range GArray) */
	235	};
	236
	237	struct declaration_enum {
	238	struct declaration p;
	239	struct declaration_integer *integer_declaration;
	240	struct enum_table table;
	241	};
	242
	243	struct definition_enum {
	244	struct definition p;
	245	struct definition_integer *integer;
	246	struct declaration_enum *declaration;
	247	/* Last GQuark values read. Keeping a reference on the GQuark array. */
	248	GArray *value;
	249	};
	250
	251	struct declaration_string {
	252	struct declaration p;
	253	};
	254
	255	struct definition_string {
	256	struct definition p;
	257	struct declaration_string *declaration;
	258	char value; / freed at definition_string teardown */
	259	};
	260
	261	struct declaration_field {
	262	GQuark name;
	263	struct declaration *declaration;
	264	};
	265
	266	struct field {
	267	GQuark name;
	268	struct definition *definition;
	269	};
	270
	271	struct declaration_struct {
	272	struct declaration p;
	273	GHashTable fields_by_name; / Tuples (field name, field index) */
	274	struct declaration_scope *scope;
	275	GArray fields; / Array of declaration_field */
	276	};
	277
	278	struct definition_struct {
	279	struct definition p;
	280	struct declaration_struct *declaration;
	281	struct definition_scope *scope;
	282	GArray fields; / Array of struct field */
	283	};
	284
	285	struct declaration_variant {
	286	struct declaration p;
	287	GHashTable fields_by_tag; / Tuples (field tag, field index) */
	288	struct declaration_scope *scope;
	289	GArray fields; / Array of declaration_field */
	290	GQuark tag_name; /* TODO */
	291	/* Tag name must be nonzero and must exist when defining the variant */
	292	};
	293
	294	struct definition_variant {
	295	struct definition p;
	296	struct declaration_variant *declaration;
	297	struct definition_scope *scope;
	298	struct definition *enum_tag;
	299	GArray fields; / Array of struct field */
	300	struct field current_field; / Last field read */
	301	};
	302
	303	struct declaration_array {
	304	struct declaration p;
	305	size_t len;
	306	struct declaration *elem;
	307	struct declaration_scope *scope;
	308	};
	309
	310	struct definition_array {
	311	struct definition p;
	312	struct declaration_array *declaration;
	313	struct definition_scope *scope;
	314	struct field current_element; /* struct field */
	315	};
	316
	317	struct declaration_sequence {
	318	struct declaration p;
	319	struct declaration_integer *len_declaration;
	320	struct declaration *elem;
	321	struct declaration_scope *scope;
	322	};
	323
	324	struct definition_sequence {
	325	struct definition p;
	326	struct declaration_sequence *declaration;
	327	struct definition_scope *scope;
	328	struct definition_integer *len;
	329	struct field current_element; /* struct field */
	330	};
	331
	332	int register_declaration(GQuark declaration_name,
	333	struct declaration *declaration,
	334	struct declaration_scope *scope);
	335	struct declaration *lookup_declaration(GQuark declaration_name,
	336	struct declaration_scope *scope);
	337
	338	/*
	339	* Type scopes also contain a separate registry for struct, variant and
	340	* enum types. Those register types rather than type definitions, so
	341	* that a named variant can be declared without specifying its target
	342	* "choice" tag field immediately.
	343	*/
	344	int register_struct_declaration(GQuark struct_name,
	345	struct declaration_struct *struct_declaration,
	346	struct declaration_scope *scope);
	347	struct declaration_struct *
	348	lookup_struct_declaration(GQuark struct_name,
	349	struct declaration_scope *scope);
	350	int register_variant_declaration(GQuark variant_name,
	351	struct declaration_variant *variant_declaration,
	352	struct declaration_scope *scope);
	353	struct declaration_variant *lookup_variant_declaration(GQuark variant_name,
	354	struct declaration_scope *scope);
	355	int register_enum_declaration(GQuark enum_name,
	356	struct declaration_enum *enum_declaration,
	357	struct declaration_scope *scope);
	358	struct declaration_enum *
	359	lookup_enum_declaration(GQuark enum_name,
	360	struct declaration_scope *scope);
	361
	362	struct declaration_scope *
	363	new_declaration_scope(struct declaration_scope *parent_scope);
	364	void free_declaration_scope(struct declaration_scope *scope);
	365
	366	/*
	367	* field_definition is for field definitions. They are registered into
	368	* definition scopes.
	369	*/
	370	struct definition *
	371	lookup_definition(GArray cur_path, / array of GQuark */
	372	GArray lookup_path, / array of GQuark */
	373	struct definition_scope *scope);
	374	int register_field_definition(GQuark field_name,
	375	struct definition *definition,
	376	struct definition_scope *scope);
	377	struct definition_scope *
	378	new_definition_scope(struct definition_scope *parent_scope,
	379	GQuark field_name);
	380	void free_definition_scope(struct definition_scope *scope);
	381
	382	void declaration_ref(struct declaration *declaration);
	383	void declaration_unref(struct declaration *declaration);
	384
	385	void definition_ref(struct definition *definition);
	386	void definition_unref(struct definition *definition);
	387
	388	/* Nameless declarations can be created by passing a NULL name */
	389
	390	struct declaration_integer integer_declaration_new(const char name,
	391	size_t len, int byte_order,
	392	int signedness, size_t alignment);
	393
	394	/*
	395	* mantissa_len is the length of the number of bytes represented by the mantissa
	396	* (e.g. result of DBL_MANT_DIG). It includes the leading 1.
	397	*/
	398	struct declaration_float float_declaration_new(const char name,
	399	size_t mantissa_len,
	400	size_t exp_len, int byte_order,
	401	size_t alignment);
	402
	403	/*
	404	* A GQuark can be translated to/from strings with g_quark_from_string() and
	405	* g_quark_to_string().
	406	*/
	407
	408	/*
	409	* Returns a GArray of GQuark or NULL.
	410	* Caller must release the GArray with g_array_unref().
	411	*/
	412	GArray enum_uint_to_quark_set(const struct declaration_enum enum_declaration,
	413	uint64_t v);
	414
	415	/*
	416	* Returns a GArray of GQuark or NULL.
	417	* Caller must release the GArray with g_array_unref().
	418	*/
	419	GArray enum_int_to_quark_set(const struct declaration_enum enum_declaration,
	420	uint64_t v);
	421
	422	/*
	423	* Returns a GArray of struct enum_range or NULL.
	424	* Callers do _not_ own the returned GArray (and therefore _don't_ need to
	425	* release it).
	426	*/
	427	GArray enum_quark_to_range_set(const struct declaration_enum enum_declaration,
	428	GQuark q);
	429	void enum_signed_insert(struct declaration_enum *enum_declaration,
	430	int64_t start, int64_t end, GQuark q);
	431	void enum_unsigned_insert(struct declaration_enum *enum_declaration,
	432	uint64_t start, uint64_t end, GQuark q);
	433	size_t enum_get_nr_enumerators(struct declaration_enum *enum_declaration);
	434
	435	struct declaration_enum *
	436	enum_declaration_new(const char *name,
	437	struct declaration_integer *integer_declaration);
	438
	439	struct declaration_struct *
	440	struct_declaration_new(const char *name,
	441	struct declaration_scope *parent_scope);
	442	void struct_declaration_add_field(struct declaration_struct *struct_declaration,
	443	const char *field_name,
	444	struct declaration *field_declaration);
	445	/*
	446	* Returns the index of a field within a structure.
	447	*/
	448	unsigned long struct_declaration_lookup_field_index(struct declaration_struct *struct_declaration,
	449	GQuark field_name);
	450	/*
	451	* field returned only valid as long as the field structure is not appended to.
	452	*/
	453	struct declaration_field *
	454	struct_declaration_get_field_from_index(struct declaration_struct *struct_declaration,
	455	unsigned long index);
	456	struct field *
	457	struct_get_field_from_index(struct definition_struct *struct_definition,
	458	unsigned long index);
	459
	460	/*
	461	* The tag enumeration is validated to ensure that it contains only mappings
	462	* from numeric values to a single tag. Overlapping tag value ranges are
	463	* therefore forbidden.
	464	*/
	465	struct declaration_variant variant_declaration_new(const char name,
	466	struct declaration_scope *parent_scope);
	467	void variant_declaration_add_field(struct declaration_variant *variant_declaration,
	468	const char *tag_name,
	469	struct declaration *tag_declaration);
	470	struct declaration_field *
	471	variant_declaration_get_field_from_tag(struct declaration_variant *variant_declaration,
	472	GQuark tag);
	473	/*
	474	* Returns 0 on success, -EPERM on error.
	475	*/
	476	int variant_definition_set_tag(struct definition_variant *variant,
	477	struct definition *enum_tag);
	478	/*
	479	* Returns the field selected by the current tag value.
	480	* field returned only valid as long as the variant structure is not appended
	481	* to.
	482	*/
	483	struct field variant_get_current_field(struct definition_variant variant);
	484
	485	/*
	486	* elem_declaration passed as parameter now belongs to the array. No
	487	* need to free it explicitly. "len" is the number of elements in the
	488	* array.
	489	*/
	490	struct declaration_array *
	491	array_declaration_new(const char *name,
	492	size_t len, struct declaration *elem_declaration,
	493	struct declaration_scope *parent_scope);
	494
	495	/*
	496	* int_declaration and elem_declaration passed as parameter now belong
	497	* to the sequence. No need to free them explicitly.
	498	*/
	499	struct declaration_sequence *
	500	sequence_declaration_new(const char *name,
	501	struct declaration_integer *len_declaration,
	502	struct declaration *elem_declaration,
	503	struct declaration_scope *parent_scope);
	504
	505	#endif /* _BABELTRACE_declarationS_H */