[babeltrace.git] / include / babeltrace / ctf-ir / event-types-internal.h

#ifndef BABELTRACE_CTF_IR_EVENT_TYPES_INTERNAL_H
#define BABELTRACE_CTF_IR_EVENT_TYPES_INTERNAL_H

/*
 * BabelTrace - CTF IR: Event types internal
 *
 * Copyright 2013, 2014 Jérémie Galarneau <jeremie.galarneau@efficios.com>
 *
 * Author: Jérémie Galarneau <jeremie.galarneau@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.
 */

#include <babeltrace/ctf-writer/event-types.h>
#include <babeltrace/ctf-writer/event-fields.h>
#include <babeltrace/ctf-writer/writer.h>
#include <babeltrace/ctf-ir/trace-internal.h>
#include <babeltrace/babeltrace-internal.h>
#include <babeltrace/object-internal.h>
#include <babeltrace/types.h>
#include <babeltrace/ctf/events.h>
#include <glib.h>

typedef void (*type_freeze_func)(struct bt_ctf_field_type *);
typedef int (*type_serialize_func)(struct bt_ctf_field_type *,
		struct metadata_context *);

enum bt_ctf_node {
	CTF_NODE_UNKNOWN = -1,
	CTF_NODE_ENV = 0,
	CTF_NODE_TRACE_PACKET_HEADER = 1,
	CTF_NODE_STREAM_PACKET_CONTEXT = 2,
	CTF_NODE_STREAM_EVENT_HEADER = 3,
	CTF_NODE_STREAM_EVENT_CONTEXT = 4,
	CTF_NODE_EVENT_CONTEXT = 5,
	CTF_NODE_EVENT_FIELDS = 6,
};

struct bt_ctf_field_path {
	enum bt_ctf_node root;

	/*
	 * Array of integers (int) indicating the index in either
	 * structures, variants, arrays, or sequences that make up
	 * the path to a field type. -1 means the "current element
	 * of an array or sequence type".
	 */
	GArray *path_indexes;
};

struct bt_ctf_field_type {
	struct bt_object base;
	struct bt_declaration *declaration;
	type_freeze_func freeze;
	type_serialize_func serialize;
	/*
	 * A type can't be modified once it is added to an event or after a
	 * a field has been instanciated from it.
	 */
	int frozen;

	/*
	 * This flag indicates if the field type is valid. A valid
	 * field type is _always_ frozen. All the nested field types of
	 * a valid field type are also valid (and thus frozen).
	 */
	int valid;
};

struct bt_ctf_field_type_integer {
	struct bt_ctf_field_type parent;
	struct declaration_integer declaration;
	struct bt_ctf_clock *mapped_clock;

	/*
	 * This is what the user sets and is never modified by internal
	 * code.
	 *
	 * This field must contain a `BT_CTF_BYTE_ORDER_*` value.
	 */
	enum bt_ctf_byte_order user_byte_order;
};

struct enumeration_mapping {
	union {
		uint64_t _unsigned;
		int64_t _signed;
	} range_start;

	union {
		uint64_t _unsigned;
		int64_t _signed;
	} range_end;
	GQuark string;
};

struct bt_ctf_field_type_enumeration {
	struct bt_ctf_field_type parent;
	struct bt_ctf_field_type *container;
	GPtrArray *entries; /* Array of ptrs to struct enumeration_mapping */
	struct declaration_enum declaration;
};

struct bt_ctf_field_type_floating_point {
	struct bt_ctf_field_type parent;
	struct declaration_float declaration;

	/*
	 * The `declaration` field above contains 3 pointers pointing
	 * to the fields below. This avoids unnecessary dynamic
	 * allocations.
	 */
	struct declaration_integer sign;
	struct declaration_integer mantissa;
	struct declaration_integer exp;

	/*
	 * This is what the user sets and is never modified by internal
	 * code.
	 *
	 * This field must contain a `BT_CTF_BYTE_ORDER_*` value.
	 */
	enum bt_ctf_byte_order user_byte_order;
};

struct structure_field {
	GQuark name;
	struct bt_ctf_field_type *type;
};

struct bt_ctf_field_type_structure {
	struct bt_ctf_field_type parent;
	GHashTable *field_name_to_index;
	GPtrArray *fields; /* Array of pointers to struct structure_field */
	struct declaration_struct declaration;
};

struct bt_ctf_field_type_variant {
	struct bt_ctf_field_type parent;
	GString *tag_name;
	struct bt_ctf_field_type_enumeration *tag;
	struct bt_ctf_field_path *tag_path;
	GHashTable *field_name_to_index;
	GPtrArray *fields; /* Array of pointers to struct structure_field */
	struct declaration_variant declaration;
};

struct bt_ctf_field_type_array {
	struct bt_ctf_field_type parent;
	struct bt_ctf_field_type *element_type;
	unsigned int length; /* Number of elements */
	struct declaration_array declaration;
};

struct bt_ctf_field_type_sequence {
	struct bt_ctf_field_type parent;
	struct bt_ctf_field_type *element_type;
	GString *length_field_name;
	struct bt_ctf_field_path *length_field_path;
	struct declaration_sequence declaration;
};

struct bt_ctf_field_type_string {
	struct bt_ctf_field_type parent;
	struct declaration_string declaration;
};

BT_HIDDEN
void bt_ctf_field_type_freeze(struct bt_ctf_field_type *type);

BT_HIDDEN
struct bt_ctf_field_type *bt_ctf_field_type_variant_get_field_type_signed(
		struct bt_ctf_field_type_variant *variant, int64_t tag_value);

BT_HIDDEN
struct bt_ctf_field_type *bt_ctf_field_type_variant_get_field_type_unsigned(
		struct bt_ctf_field_type_variant *variant, uint64_t tag_value);

BT_HIDDEN
int bt_ctf_field_type_serialize(struct bt_ctf_field_type *type,
		struct metadata_context *context);

BT_HIDDEN
int bt_ctf_field_type_validate(struct bt_ctf_field_type *type);

BT_HIDDEN
const char *bt_ctf_field_type_enumeration_get_mapping_name_unsigned(
		struct bt_ctf_field_type_enumeration *enumeration_type,
		uint64_t value);

BT_HIDDEN
const char *bt_ctf_field_type_enumeration_get_mapping_name_signed(
		struct bt_ctf_field_type_enumeration *enumeration_type,
		int64_t value);

/* Override field type's byte order only if it is set to "native" */
BT_HIDDEN
void bt_ctf_field_type_set_native_byte_order(
		struct bt_ctf_field_type *type, int byte_order);

/* Deep copy a field type */
BT_HIDDEN
struct bt_ctf_field_type *bt_ctf_field_type_copy(
		struct bt_ctf_field_type *type);

BT_HIDDEN
struct bt_ctf_field_path *bt_ctf_field_path_create(void);

BT_HIDDEN
void bt_ctf_field_path_clear(struct bt_ctf_field_path *field_path);

BT_HIDDEN
struct bt_ctf_field_path *bt_ctf_field_path_copy(
		struct bt_ctf_field_path *path);

BT_HIDDEN
void bt_ctf_field_path_destroy(struct bt_ctf_field_path *path);

BT_HIDDEN
int bt_ctf_field_type_structure_get_field_name_index(
		struct bt_ctf_field_type *structure, const char *name);

/* Replace an existing field's type in a structure */
BT_HIDDEN
int bt_ctf_field_type_structure_set_field_index(
		struct bt_ctf_field_type *structure,
		struct bt_ctf_field_type *field, int index);

BT_HIDDEN
int bt_ctf_field_type_variant_get_field_name_index(
		struct bt_ctf_field_type *variant, const char *name);

BT_HIDDEN
int bt_ctf_field_type_sequence_set_length_field_path(
		struct bt_ctf_field_type *type,
		struct bt_ctf_field_path *path);

BT_HIDDEN
struct bt_ctf_field_path *bt_ctf_field_type_sequence_get_length_field_path(
		struct bt_ctf_field_type *type);

BT_HIDDEN
int bt_ctf_field_type_variant_set_tag_field_path(struct bt_ctf_field_type *type,
		struct bt_ctf_field_path *path);

BT_HIDDEN
struct bt_ctf_field_path *bt_ctf_field_type_variant_get_tag_field_path(
		struct bt_ctf_field_type *type);

BT_HIDDEN
int bt_ctf_field_type_variant_set_tag(struct bt_ctf_field_type *type,
		struct bt_ctf_field_type *tag);

/* Replace an existing field's type in a variant */
BT_HIDDEN
int bt_ctf_field_type_variant_set_field_index(
		struct bt_ctf_field_type *variant,
		struct bt_ctf_field_type *field, int index);

BT_HIDDEN
int bt_ctf_field_type_array_set_element_type(struct bt_ctf_field_type *array,
		struct bt_ctf_field_type *element_type);

BT_HIDDEN
int bt_ctf_field_type_sequence_set_element_type(struct bt_ctf_field_type *array,
		struct bt_ctf_field_type *element_type);

BT_HIDDEN
int bt_ctf_field_type_get_field_count(struct bt_ctf_field_type *type);

BT_HIDDEN
struct bt_ctf_field_type *bt_ctf_field_type_get_field_at_index(
		struct bt_ctf_field_type *type, int index);

BT_HIDDEN
int bt_ctf_field_type_get_field_index(struct bt_ctf_field_type *type,
		const char *name);

#endif /* BABELTRACE_CTF_IR_EVENT_TYPES_INTERNAL_H */
Commit	Line	Data
adc315b8 JG	1	#ifndef BABELTRACE_CTF_IR_EVENT_TYPES_INTERNAL_H
adc315b8 JG	2	#define BABELTRACE_CTF_IR_EVENT_TYPES_INTERNAL_H
273b65be JG	3
273b65be JG	4	/*
adc315b8	5	* BabelTrace - CTF IR: Event types internal
273b65be	6	*
de9dd397	7	* Copyright 2013, 2014 Jérémie Galarneau <jeremie.galarneau@efficios.com>
273b65be JG	8	*
	9	* Author: Jérémie Galarneau <jeremie.galarneau@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	* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
	22	* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
	23	* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
	24	* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
	25	* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
	26	* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
	27	* SOFTWARE.
	28	*/
	29
	30	#include <babeltrace/ctf-writer/event-types.h>
273b65be JG	31	#include <babeltrace/ctf-writer/event-fields.h>
273b65be JG	32	#include <babeltrace/ctf-writer/writer.h>
bc37ae52	33	#include <babeltrace/ctf-ir/trace-internal.h>
273b65be	34	#include <babeltrace/babeltrace-internal.h>
83509119	35	#include <babeltrace/object-internal.h>
273b65be JG	36	#include <babeltrace/types.h>
	37	#include <babeltrace/ctf/events.h>
	38	#include <glib.h>
	39
b75277fb JG	40	typedef void (type_freeze_func)(struct bt_ctf_field_type );
b75277fb JG	41	typedef int (type_serialize_func)(struct bt_ctf_field_type ,
273b65be JG	42	struct metadata_context *);
273b65be JG	43
6b64f185 JG	44	enum bt_ctf_node {
	45	CTF_NODE_UNKNOWN = -1,
	46	CTF_NODE_ENV = 0,
	47	CTF_NODE_TRACE_PACKET_HEADER = 1,
	48	CTF_NODE_STREAM_PACKET_CONTEXT = 2,
	49	CTF_NODE_STREAM_EVENT_HEADER = 3,
	50	CTF_NODE_STREAM_EVENT_CONTEXT = 4,
	51	CTF_NODE_EVENT_CONTEXT = 5,
	52	CTF_NODE_EVENT_FIELDS = 6,
	53	};
	54
	55	struct bt_ctf_field_path {
	56	enum bt_ctf_node root;
09840de5	57
6b64f185 JG	58	/*
6b64f185 JG	59	* Array of integers (int) indicating the index in either
09840de5 PP	60	* structures, variants, arrays, or sequences that make up
	61	* the path to a field type. -1 means the "current element
	62	* of an array or sequence type".
6b64f185 JG	63	*/
	64	GArray *path_indexes;
	65	};
	66
273b65be	67	struct bt_ctf_field_type {
83509119	68	struct bt_object base;
273b65be JG	69	struct bt_declaration *declaration;
	70	type_freeze_func freeze;
	71	type_serialize_func serialize;
	72	/*
	73	* A type can't be modified once it is added to an event or after a
	74	* a field has been instanciated from it.
	75	*/
	76	int frozen;
81e36fac PP	77
	78	/*
	79	* This flag indicates if the field type is valid. A valid
	80	* field type is _always_ frozen. All the nested field types of
	81	* a valid field type are also valid (and thus frozen).
	82	*/
	83	int valid;
273b65be JG	84	};
	85
	86	struct bt_ctf_field_type_integer {
	87	struct bt_ctf_field_type parent;
	88	struct declaration_integer declaration;
6cfb906f	89	struct bt_ctf_clock *mapped_clock;
445c3471 PP	90
	91	/*
	92	* This is what the user sets and is never modified by internal
	93	* code.
	94	*
	95	* This field must contain a `BT_CTF_BYTE_ORDER_*` value.
	96	*/
	97	enum bt_ctf_byte_order user_byte_order;
273b65be JG	98	};
	99
	100	struct enumeration_mapping {
b92ddaaa JG	101	union {
	102	uint64_t _unsigned;
	103	int64_t _signed;
	104	} range_start;
	105
	106	union {
	107	uint64_t _unsigned;
	108	int64_t _signed;
	109	} range_end;
273b65be JG	110	GQuark string;
	111	};
	112
	113	struct bt_ctf_field_type_enumeration {
	114	struct bt_ctf_field_type parent;
	115	struct bt_ctf_field_type *container;
db8ef253	116	GPtrArray entries; / Array of ptrs to struct enumeration_mapping */
273b65be JG	117	struct declaration_enum declaration;
	118	};
	119
	120	struct bt_ctf_field_type_floating_point {
	121	struct bt_ctf_field_type parent;
	122	struct declaration_float declaration;
d480b699 PP	123
	124	/*
	125	* The `declaration` field above contains 3 pointers pointing
	126	* to the fields below. This avoids unnecessary dynamic
	127	* allocations.
	128	*/
273b65be JG	129	struct declaration_integer sign;
	130	struct declaration_integer mantissa;
	131	struct declaration_integer exp;
445c3471 PP	132
	133	/*
	134	* This is what the user sets and is never modified by internal
	135	* code.
	136	*
	137	* This field must contain a `BT_CTF_BYTE_ORDER_*` value.
	138	*/
	139	enum bt_ctf_byte_order user_byte_order;
273b65be JG	140	};
	141
	142	struct structure_field {
	143	GQuark name;
	144	struct bt_ctf_field_type *type;
	145	};
	146
	147	struct bt_ctf_field_type_structure {
	148	struct bt_ctf_field_type parent;
	149	GHashTable *field_name_to_index;
	150	GPtrArray fields; / Array of pointers to struct structure_field */
24724933	151	struct declaration_struct declaration;
273b65be JG	152	};
	153
	154	struct bt_ctf_field_type_variant {
	155	struct bt_ctf_field_type parent;
	156	GString *tag_name;
	157	struct bt_ctf_field_type_enumeration *tag;
4a1e8671	158	struct bt_ctf_field_path *tag_path;
273b65be JG	159	GHashTable *field_name_to_index;
	160	GPtrArray fields; / Array of pointers to struct structure_field */
	161	struct declaration_variant declaration;
	162	};
	163
	164	struct bt_ctf_field_type_array {
	165	struct bt_ctf_field_type parent;
	166	struct bt_ctf_field_type *element_type;
	167	unsigned int length; /* Number of elements */
	168	struct declaration_array declaration;
	169	};
	170
	171	struct bt_ctf_field_type_sequence {
	172	struct bt_ctf_field_type parent;
	173	struct bt_ctf_field_type *element_type;
	174	GString *length_field_name;
aa4e271c	175	struct bt_ctf_field_path *length_field_path;
273b65be JG	176	struct declaration_sequence declaration;
	177	};
	178
	179	struct bt_ctf_field_type_string {
	180	struct bt_ctf_field_type parent;
	181	struct declaration_string declaration;
	182	};
	183
	184	BT_HIDDEN
	185	void bt_ctf_field_type_freeze(struct bt_ctf_field_type *type);
	186
	187	BT_HIDDEN
b92ddaaa JG	188	struct bt_ctf_field_type *bt_ctf_field_type_variant_get_field_type_signed(
b92ddaaa JG	189	struct bt_ctf_field_type_variant *variant, int64_t tag_value);
273b65be JG	190
273b65be JG	191	BT_HIDDEN
b92ddaaa JG	192	struct bt_ctf_field_type *bt_ctf_field_type_variant_get_field_type_unsigned(
b92ddaaa JG	193	struct bt_ctf_field_type_variant *variant, uint64_t tag_value);
273b65be JG	194
	195	BT_HIDDEN
	196	int bt_ctf_field_type_serialize(struct bt_ctf_field_type *type,
	197	struct metadata_context *context);
	198
9ce21c30 JG	199	BT_HIDDEN
	200	int bt_ctf_field_type_validate(struct bt_ctf_field_type *type);
	201
e5958c30 JG	202	BT_HIDDEN
	203	const char *bt_ctf_field_type_enumeration_get_mapping_name_unsigned(
	204	struct bt_ctf_field_type_enumeration *enumeration_type,
	205	uint64_t value);
	206
	207	BT_HIDDEN
	208	const char *bt_ctf_field_type_enumeration_get_mapping_name_signed(
	209	struct bt_ctf_field_type_enumeration *enumeration_type,
	210	int64_t value);
	211
c35a1669 JG	212	/* Override field type's byte order only if it is set to "native" */
	213	BT_HIDDEN
	214	void bt_ctf_field_type_set_native_byte_order(
	215	struct bt_ctf_field_type *type, int byte_order);
24724933 JG	216
	217	/* Deep copy a field type */
	218	BT_HIDDEN
	219	struct bt_ctf_field_type *bt_ctf_field_type_copy(
	220	struct bt_ctf_field_type *type);
	221
6b64f185 JG	222	BT_HIDDEN
	223	struct bt_ctf_field_path *bt_ctf_field_path_create(void);
	224
7073124e PP	225	BT_HIDDEN
	226	void bt_ctf_field_path_clear(struct bt_ctf_field_path *field_path);
	227
6b64f185 JG	228	BT_HIDDEN
	229	struct bt_ctf_field_path *bt_ctf_field_path_copy(
	230	struct bt_ctf_field_path *path);
	231
	232	BT_HIDDEN
	233	void bt_ctf_field_path_destroy(struct bt_ctf_field_path *path);
39a5e0db JG	234
	235	BT_HIDDEN
	236	int bt_ctf_field_type_structure_get_field_name_index(
	237	struct bt_ctf_field_type structure, const char name);
736133f1	238
5cec03e4 JG	239	/* Replace an existing field's type in a structure */
	240	BT_HIDDEN
	241	int bt_ctf_field_type_structure_set_field_index(
	242	struct bt_ctf_field_type *structure,
	243	struct bt_ctf_field_type *field, int index);
	244
736133f1 JG	245	BT_HIDDEN
	246	int bt_ctf_field_type_variant_get_field_name_index(
	247	struct bt_ctf_field_type variant, const char name);
aa4e271c JG	248
	249	BT_HIDDEN
	250	int bt_ctf_field_type_sequence_set_length_field_path(
	251	struct bt_ctf_field_type *type,
	252	struct bt_ctf_field_path *path);
4a1e8671	253
32fe3f28 PP	254	BT_HIDDEN
	255	struct bt_ctf_field_path *bt_ctf_field_type_sequence_get_length_field_path(
	256	struct bt_ctf_field_type *type);
	257
4a1e8671 JG	258	BT_HIDDEN
	259	int bt_ctf_field_type_variant_set_tag_field_path(struct bt_ctf_field_type *type,
	260	struct bt_ctf_field_path *path);
3f39933a	261
32fe3f28 PP	262	BT_HIDDEN
	263	struct bt_ctf_field_path *bt_ctf_field_type_variant_get_tag_field_path(
	264	struct bt_ctf_field_type *type);
	265
3f39933a JG	266	BT_HIDDEN
	267	int bt_ctf_field_type_variant_set_tag(struct bt_ctf_field_type *type,
	268	struct bt_ctf_field_type *tag);
	269
5cec03e4 JG	270	/* Replace an existing field's type in a variant */
	271	BT_HIDDEN
	272	int bt_ctf_field_type_variant_set_field_index(
	273	struct bt_ctf_field_type *variant,
	274	struct bt_ctf_field_type *field, int index);
	275
626e93aa PP	276	BT_HIDDEN
	277	int bt_ctf_field_type_array_set_element_type(struct bt_ctf_field_type *array,
	278	struct bt_ctf_field_type *element_type);
	279
	280	BT_HIDDEN
	281	int bt_ctf_field_type_sequence_set_element_type(struct bt_ctf_field_type *array,
	282	struct bt_ctf_field_type *element_type);
	283
09840de5 PP	284	BT_HIDDEN
	285	int bt_ctf_field_type_get_field_count(struct bt_ctf_field_type *type);
	286
	287	BT_HIDDEN
	288	struct bt_ctf_field_type *bt_ctf_field_type_get_field_at_index(
	289	struct bt_ctf_field_type *type, int index);
	290
	291	BT_HIDDEN
	292	int bt_ctf_field_type_get_field_index(struct bt_ctf_field_type *type,
	293	const char *name);
	294
adc315b8	295	#endif /* BABELTRACE_CTF_IR_EVENT_TYPES_INTERNAL_H */