[lttngtop.git] / lib / 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/ref-internal.h>
#include <babeltrace/ctf-writer/event-fields.h>
#include <babeltrace/ctf-writer/writer.h>
#include <babeltrace/ctf-writer/writer-internal.h>
#include <babeltrace/babeltrace-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 *);

struct bt_ctf_field_type {
	struct bt_ctf_ref ref_count;
	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;
};

struct bt_ctf_field_type_integer {
	struct bt_ctf_field_type parent;
	struct declaration_integer declaration;
};

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 pointers to struct enum_mapping */
	struct declaration_enum declaration;
};

struct bt_ctf_field_type_floating_point {
	struct bt_ctf_field_type parent;
	struct declaration_float declaration;
	struct declaration_integer sign;
	struct declaration_integer mantissa;
	struct declaration_integer exp;
};

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_enum declaration;
};

struct bt_ctf_field_type_variant {
	struct bt_ctf_field_type parent;
	GString *tag_name;
	struct bt_ctf_field_type_enumeration *tag;
	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 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);

#endif /* BABELTRACE_CTF_IR_EVENT_TYPES_INTERNAL_H */
Commit	Line	Data
4a325d7e JD	1	#ifndef BABELTRACE_CTF_IR_EVENT_TYPES_INTERNAL_H
	2	#define BABELTRACE_CTF_IR_EVENT_TYPES_INTERNAL_H
	3
	4	/*
	5	* BabelTrace - CTF IR: Event types internal
	6	*
	7	* Copyright 2013, 2014 Jérémie Galarneau <jeremie.galarneau@efficios.com>
	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>
	31	#include <babeltrace/ctf-writer/ref-internal.h>
	32	#include <babeltrace/ctf-writer/event-fields.h>
	33	#include <babeltrace/ctf-writer/writer.h>
	34	#include <babeltrace/ctf-writer/writer-internal.h>
	35	#include <babeltrace/babeltrace-internal.h>
	36	#include <babeltrace/types.h>
	37	#include <babeltrace/ctf/events.h>
	38	#include <glib.h>
	39
	40	typedef void(type_freeze_func)(struct bt_ctf_field_type );
	41	typedef int(type_serialize_func)(struct bt_ctf_field_type ,
	42	struct metadata_context *);
	43
	44	struct bt_ctf_field_type {
	45	struct bt_ctf_ref ref_count;
	46	struct bt_declaration *declaration;
	47	type_freeze_func freeze;
	48	type_serialize_func serialize;
	49	/*
	50	* A type can't be modified once it is added to an event or after a
	51	* a field has been instanciated from it.
	52	*/
	53	int frozen;
	54	};
	55
	56	struct bt_ctf_field_type_integer {
	57	struct bt_ctf_field_type parent;
	58	struct declaration_integer declaration;
	59	};
	60
	61	struct enumeration_mapping {
	62	union {
	63	uint64_t _unsigned;
	64	int64_t _signed;
65	} range_start;
66
67	union {
68	uint64_t _unsigned;
69	int64_t _signed;
70	} range_end;
71	GQuark string;
72	};
73
74	struct bt_ctf_field_type_enumeration {
75	struct bt_ctf_field_type parent;
76	struct bt_ctf_field_type *container;
77	GPtrArray entries; / Array of pointers to struct enum_mapping */
78	struct declaration_enum declaration;
79	};
80
81	struct bt_ctf_field_type_floating_point {
82	struct bt_ctf_field_type parent;
83	struct declaration_float declaration;
84	struct declaration_integer sign;
85	struct declaration_integer mantissa;
86	struct declaration_integer exp;
87	};
88
89	struct structure_field {
90	GQuark name;
91	struct bt_ctf_field_type *type;
92	};
93
94	struct bt_ctf_field_type_structure {
95	struct bt_ctf_field_type parent;
96	GHashTable *field_name_to_index;
97	GPtrArray fields; / Array of pointers to struct structure_field */
98	struct declaration_enum declaration;
99	};
100
101	struct bt_ctf_field_type_variant {
102	struct bt_ctf_field_type parent;
103	GString *tag_name;
104	struct bt_ctf_field_type_enumeration *tag;
105	GHashTable *field_name_to_index;
106	GPtrArray fields; / Array of pointers to struct structure_field */
107	struct declaration_variant declaration;
108	};
109
110	struct bt_ctf_field_type_array {
111	struct bt_ctf_field_type parent;
112	struct bt_ctf_field_type *element_type;
113	unsigned int length; /* Number of elements */
114	struct declaration_array declaration;
115	};
116
117	struct bt_ctf_field_type_sequence {
118	struct bt_ctf_field_type parent;
119	struct bt_ctf_field_type *element_type;
120	GString *length_field_name;
121	struct declaration_sequence declaration;
122	};
123
124	struct bt_ctf_field_type_string {
125	struct bt_ctf_field_type parent;
126	struct declaration_string declaration;
127	};
128
129	BT_HIDDEN
130	void bt_ctf_field_type_freeze(struct bt_ctf_field_type *type);
131
132	BT_HIDDEN
133	struct bt_ctf_field_type *bt_ctf_field_type_variant_get_field_type_signed(
134	struct bt_ctf_field_type_variant *variant, int64_t tag_value);
135
136	BT_HIDDEN
137	struct bt_ctf_field_type *bt_ctf_field_type_variant_get_field_type_unsigned(
138	struct bt_ctf_field_type_variant *variant, uint64_t tag_value);
139
140	BT_HIDDEN
141	int bt_ctf_field_type_serialize(struct bt_ctf_field_type *type,
142	struct metadata_context *context);
143
144	BT_HIDDEN
145	int bt_ctf_field_type_validate(struct bt_ctf_field_type *type);
146
147	BT_HIDDEN
148	const char *bt_ctf_field_type_enumeration_get_mapping_name_unsigned(
149	struct bt_ctf_field_type_enumeration *enumeration_type,
150	uint64_t value);
151
152	BT_HIDDEN
153	const char *bt_ctf_field_type_enumeration_get_mapping_name_signed(
154	struct bt_ctf_field_type_enumeration *enumeration_type,
155	int64_t value);
156
157	#endif /* BABELTRACE_CTF_IR_EVENT_TYPES_INTERNAL_H */