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

#ifndef BABELTRACE_CTF_IR_FIELD_TYPES_INTERNAL_H
#define BABELTRACE_CTF_IR_FIELD_TYPES_INTERNAL_H

/*
 * BabelTrace - CTF IR: Event field 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 <stdint.h>
#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/ctf-ir/clock-class.h>
#include <babeltrace/babeltrace-internal.h>
#include <babeltrace/object-internal.h>
#include <babeltrace/types.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 *);

struct bt_ctf_field_type {
	struct bt_object base;
	enum bt_ctf_field_type_id id;
	unsigned int alignment;
	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 bt_ctf_clock_class *mapped_clock;
	enum bt_ctf_byte_order user_byte_order;
	bt_bool is_signed;
	unsigned int size;
	enum bt_ctf_integer_base base;
	enum bt_ctf_string_encoding encoding;
};

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 */
	/* Only set during validation. */
	bt_bool has_overlapping_ranges;
};

enum bt_ctf_field_type_enumeration_mapping_iterator_type {
	ITERATOR_BY_NAME,
	ITERATOR_BY_SIGNED_VALUE,
	ITERATOR_BY_UNSIGNED_VALUE,
};

struct bt_ctf_field_type_enumeration_mapping_iterator {
	struct bt_object base;
	struct bt_ctf_field_type_enumeration *enumeration_type;
	enum bt_ctf_field_type_enumeration_mapping_iterator_type type;
	int index;
	union {
		GQuark name_quark;
		int64_t signed_value;
		uint64_t unsigned_value;
	} u;
};

struct bt_ctf_field_type_floating_point {
	struct bt_ctf_field_type parent;
	enum bt_ctf_byte_order user_byte_order;
	unsigned int exp_dig;
	unsigned int mant_dig;
};

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 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_field_path;
	GHashTable *field_name_to_index;
	GPtrArray *fields; /* Array of pointers to struct structure_field */
};

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 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 bt_ctf_field_type_string {
	struct bt_ctf_field_type parent;
	enum bt_ctf_string_encoding encoding;
};

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
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
int bt_ctf_field_type_variant_set_tag_field_path(struct bt_ctf_field_type *type,
		struct bt_ctf_field_path *path);

BT_HIDDEN
int bt_ctf_field_type_variant_set_tag_field_type(struct bt_ctf_field_type *type,
		struct bt_ctf_field_type *tag_type);

/* 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
int64_t 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_FIELD_TYPES_INTERNAL_H */
Commit	Line	Data
2e33ac5a PP	1	#ifndef BABELTRACE_CTF_IR_FIELD_TYPES_INTERNAL_H
2e33ac5a PP	2	#define BABELTRACE_CTF_IR_FIELD_TYPES_INTERNAL_H
273b65be JG	3
273b65be JG	4	/*
2e33ac5a	5	* BabelTrace - CTF IR: Event field 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
544d0515	30	#include <stdint.h>
273b65be	31	#include <babeltrace/ctf-writer/event-types.h>
273b65be JG	32	#include <babeltrace/ctf-writer/event-fields.h>
273b65be JG	33	#include <babeltrace/ctf-writer/writer.h>
bc37ae52	34	#include <babeltrace/ctf-ir/trace-internal.h>
ac0c6bdd	35	#include <babeltrace/ctf-ir/clock-class.h>
273b65be	36	#include <babeltrace/babeltrace-internal.h>
83509119	37	#include <babeltrace/object-internal.h>
c55a9f58	38	#include <babeltrace/types.h>
273b65be JG	39	#include <glib.h>
273b65be JG	40
b75277fb JG	41	typedef void (type_freeze_func)(struct bt_ctf_field_type );
b75277fb JG	42	typedef int (type_serialize_func)(struct bt_ctf_field_type ,
273b65be JG	43	struct metadata_context *);
	44
	45	struct bt_ctf_field_type {
83509119	46	struct bt_object base;
1487a16a	47	enum bt_ctf_field_type_id id;
dc3fffef	48	unsigned int alignment;
273b65be JG	49	type_freeze_func freeze;
	50	type_serialize_func serialize;
	51	/*
	52	* A type can't be modified once it is added to an event or after a
	53	* a field has been instanciated from it.
	54	*/
	55	int frozen;
81e36fac PP	56
	57	/*
	58	* This flag indicates if the field type is valid. A valid
	59	* field type is _always_ frozen. All the nested field types of
	60	* a valid field type are also valid (and thus frozen).
	61	*/
	62	int valid;
273b65be JG	63	};
	64
	65	struct bt_ctf_field_type_integer {
	66	struct bt_ctf_field_type parent;
ac0c6bdd	67	struct bt_ctf_clock_class *mapped_clock;
445c3471	68	enum bt_ctf_byte_order user_byte_order;
c55a9f58	69	bt_bool is_signed;
dc3fffef PP	70	unsigned int size;
	71	enum bt_ctf_integer_base base;
	72	enum bt_ctf_string_encoding encoding;
273b65be JG	73	};
	74
	75	struct enumeration_mapping {
b92ddaaa JG	76	union {
	77	uint64_t _unsigned;
	78	int64_t _signed;
	79	} range_start;
	80
	81	union {
	82	uint64_t _unsigned;
	83	int64_t _signed;
	84	} range_end;
273b65be JG	85	GQuark string;
	86	};
	87
	88	struct bt_ctf_field_type_enumeration {
	89	struct bt_ctf_field_type parent;
	90	struct bt_ctf_field_type *container;
db8ef253	91	GPtrArray entries; / Array of ptrs to struct enumeration_mapping */
d49e1284	92	/* Only set during validation. */
c55a9f58	93	bt_bool has_overlapping_ranges;
96e8f959 MD	94	};
96e8f959 MD	95
d49e1284	96	enum bt_ctf_field_type_enumeration_mapping_iterator_type {
96e8f959 MD	97	ITERATOR_BY_NAME,
	98	ITERATOR_BY_SIGNED_VALUE,
	99	ITERATOR_BY_UNSIGNED_VALUE,
	100	};
	101
	102	struct bt_ctf_field_type_enumeration_mapping_iterator {
	103	struct bt_object base;
	104	struct bt_ctf_field_type_enumeration *enumeration_type;
d49e1284	105	enum bt_ctf_field_type_enumeration_mapping_iterator_type type;
96e8f959 MD	106	int index;
	107	union {
	108	GQuark name_quark;
	109	int64_t signed_value;
	110	uint64_t unsigned_value;
	111	} u;
273b65be JG	112	};
	113
	114	struct bt_ctf_field_type_floating_point {
	115	struct bt_ctf_field_type parent;
445c3471	116	enum bt_ctf_byte_order user_byte_order;
dc3fffef PP	117	unsigned int exp_dig;
dc3fffef PP	118	unsigned int mant_dig;
273b65be JG	119	};
	120
	121	struct structure_field {
	122	GQuark name;
	123	struct bt_ctf_field_type *type;
	124	};
	125
	126	struct bt_ctf_field_type_structure {
	127	struct bt_ctf_field_type parent;
	128	GHashTable *field_name_to_index;
	129	GPtrArray fields; / Array of pointers to struct structure_field */
273b65be JG	130	};
	131
	132	struct bt_ctf_field_type_variant {
	133	struct bt_ctf_field_type parent;
	134	GString *tag_name;
	135	struct bt_ctf_field_type_enumeration *tag;
b011f6b0	136	struct bt_ctf_field_path *tag_field_path;
273b65be JG	137	GHashTable *field_name_to_index;
273b65be JG	138	GPtrArray fields; / Array of pointers to struct structure_field */
273b65be JG	139	};
	140
	141	struct bt_ctf_field_type_array {
	142	struct bt_ctf_field_type parent;
	143	struct bt_ctf_field_type *element_type;
	144	unsigned int length; /* Number of elements */
273b65be JG	145	};
	146
	147	struct bt_ctf_field_type_sequence {
	148	struct bt_ctf_field_type parent;
	149	struct bt_ctf_field_type *element_type;
	150	GString *length_field_name;
aa4e271c	151	struct bt_ctf_field_path *length_field_path;
273b65be JG	152	};
	153
	154	struct bt_ctf_field_type_string {
	155	struct bt_ctf_field_type parent;
dc3fffef	156	enum bt_ctf_string_encoding encoding;
273b65be JG	157	};
	158
	159	BT_HIDDEN
	160	void bt_ctf_field_type_freeze(struct bt_ctf_field_type *type);
	161
	162	BT_HIDDEN
b92ddaaa JG	163	struct bt_ctf_field_type *bt_ctf_field_type_variant_get_field_type_signed(
b92ddaaa JG	164	struct bt_ctf_field_type_variant *variant, int64_t tag_value);
273b65be JG	165
273b65be JG	166	BT_HIDDEN
b92ddaaa JG	167	struct bt_ctf_field_type *bt_ctf_field_type_variant_get_field_type_unsigned(
b92ddaaa JG	168	struct bt_ctf_field_type_variant *variant, uint64_t tag_value);
273b65be JG	169
	170	BT_HIDDEN
	171	int bt_ctf_field_type_serialize(struct bt_ctf_field_type *type,
	172	struct metadata_context *context);
	173
9ce21c30 JG	174	BT_HIDDEN
	175	int bt_ctf_field_type_validate(struct bt_ctf_field_type *type);
	176
39a5e0db JG	177	BT_HIDDEN
	178	int bt_ctf_field_type_structure_get_field_name_index(
	179	struct bt_ctf_field_type structure, const char name);
736133f1	180
5cec03e4 JG	181	/* Replace an existing field's type in a structure */
	182	BT_HIDDEN
	183	int bt_ctf_field_type_structure_set_field_index(
	184	struct bt_ctf_field_type *structure,
	185	struct bt_ctf_field_type *field, int index);
	186
736133f1 JG	187	BT_HIDDEN
	188	int bt_ctf_field_type_variant_get_field_name_index(
	189	struct bt_ctf_field_type variant, const char name);
aa4e271c JG	190
	191	BT_HIDDEN
	192	int bt_ctf_field_type_sequence_set_length_field_path(
	193	struct bt_ctf_field_type *type,
	194	struct bt_ctf_field_path *path);
4a1e8671 JG	195
	196	BT_HIDDEN
	197	int bt_ctf_field_type_variant_set_tag_field_path(struct bt_ctf_field_type *type,
	198	struct bt_ctf_field_path *path);
3f39933a JG	199
3f39933a JG	200	BT_HIDDEN
4b5fcb78 PP	201	int bt_ctf_field_type_variant_set_tag_field_type(struct bt_ctf_field_type *type,
4b5fcb78 PP	202	struct bt_ctf_field_type *tag_type);
3f39933a	203
5cec03e4 JG	204	/* Replace an existing field's type in a variant */
	205	BT_HIDDEN
	206	int bt_ctf_field_type_variant_set_field_index(
	207	struct bt_ctf_field_type *variant,
	208	struct bt_ctf_field_type *field, int index);
	209
626e93aa PP	210	BT_HIDDEN
	211	int bt_ctf_field_type_array_set_element_type(struct bt_ctf_field_type *array,
	212	struct bt_ctf_field_type *element_type);
	213
	214	BT_HIDDEN
	215	int bt_ctf_field_type_sequence_set_element_type(struct bt_ctf_field_type *array,
	216	struct bt_ctf_field_type *element_type);
	217
09840de5	218	BT_HIDDEN
544d0515	219	int64_t bt_ctf_field_type_get_field_count(struct bt_ctf_field_type *type);
09840de5 PP	220
	221	BT_HIDDEN
	222	struct bt_ctf_field_type *bt_ctf_field_type_get_field_at_index(
	223	struct bt_ctf_field_type *type, int index);
	224
	225	BT_HIDDEN
	226	int bt_ctf_field_type_get_field_index(struct bt_ctf_field_type *type,
	227	const char *name);
	228
2e33ac5a	229	#endif /* BABELTRACE_CTF_IR_FIELD_TYPES_INTERNAL_H */