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

#ifndef BABELTRACE_CTF_IR_FIELDS_INTERNAL_H
#define BABELTRACE_CTF_IR_FIELDS_INTERNAL_H

/*
 * Babeltrace - CTF IR: Event Fields 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-ir/field-types.h>
#include <babeltrace/ctf-writer/event-fields.h>
#include <babeltrace/object-internal.h>
#include <babeltrace/babeltrace-internal.h>
#include <stdint.h>
#include <glib.h>

struct bt_ctf_stream_pos;

struct bt_ctf_field {
	struct bt_object base;
	struct bt_ctf_field_type *type;
	int payload_set;
	int frozen;
};

struct bt_ctf_field_integer {
	struct bt_ctf_field parent;
	union {
		int64_t signd;
		uint64_t unsignd;
	} payload;
};

struct bt_ctf_field_enumeration {
	struct bt_ctf_field parent;
	struct bt_ctf_field *payload;
};

struct bt_ctf_field_floating_point {
	struct bt_ctf_field parent;
	double payload;
};

struct bt_ctf_field_structure {
	struct bt_ctf_field parent;
	GHashTable *field_name_to_index;
	GPtrArray *fields; /* Array of pointers to struct bt_ctf_field */
};

struct bt_ctf_field_variant {
	struct bt_ctf_field parent;
	struct bt_ctf_field *tag;
	struct bt_ctf_field *payload;
};

struct bt_ctf_field_array {
	struct bt_ctf_field parent;
	GPtrArray *elements; /* Array of pointers to struct bt_ctf_field */
};

struct bt_ctf_field_sequence {
	struct bt_ctf_field parent;
	struct bt_ctf_field *length;
	GPtrArray *elements; /* Array of pointers to struct bt_ctf_field */
};

struct bt_ctf_field_string {
	struct bt_ctf_field parent;
	GString *payload;
};

/*
 * Set a field's value with an already allocated field instance.
 */
BT_HIDDEN
int bt_ctf_field_structure_set_field(struct bt_ctf_field *structure,
		const char *name, struct bt_ctf_field *value);

/* Validate that the field's payload is set (returns 0 if set). */
BT_HIDDEN
int bt_ctf_field_validate(struct bt_ctf_field *field);

/* Mark field payload as unset. */
BT_HIDDEN
int bt_ctf_field_reset(struct bt_ctf_field *field);

BT_HIDDEN
int bt_ctf_field_serialize(struct bt_ctf_field *field,
		struct bt_ctf_stream_pos *pos,
		enum bt_ctf_byte_order native_byte_order);

BT_HIDDEN
void bt_ctf_field_freeze(struct bt_ctf_field *field);

BT_HIDDEN
bool bt_ctf_field_is_set(struct bt_ctf_field *field);

#endif /* BABELTRACE_CTF_IR_FIELDS_INTERNAL_H */
Commit	Line	Data
2e33ac5a PP	1	#ifndef BABELTRACE_CTF_IR_FIELDS_INTERNAL_H
2e33ac5a PP	2	#define BABELTRACE_CTF_IR_FIELDS_INTERNAL_H
273b65be JG	3
273b65be JG	4	/*
2e33ac5a	5	* Babeltrace - CTF IR: Event Fields 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
dc3fffef	30	#include <babeltrace/ctf-ir/field-types.h>
273b65be	31	#include <babeltrace/ctf-writer/event-fields.h>
83509119	32	#include <babeltrace/object-internal.h>
273b65be	33	#include <babeltrace/babeltrace-internal.h>
dc3fffef	34	#include <stdint.h>
273b65be JG	35	#include <glib.h>
273b65be JG	36
dc3fffef PP	37	struct bt_ctf_stream_pos;
dc3fffef PP	38
273b65be	39	struct bt_ctf_field {
83509119	40	struct bt_object base;
273b65be JG	41	struct bt_ctf_field_type *type;
273b65be JG	42	int payload_set;
918be005	43	int frozen;
273b65be JG	44	};
	45
	46	struct bt_ctf_field_integer {
	47	struct bt_ctf_field parent;
dc3fffef PP	48	union {
	49	int64_t signd;
	50	uint64_t unsignd;
	51	} payload;
273b65be JG	52	};
	53
	54	struct bt_ctf_field_enumeration {
	55	struct bt_ctf_field parent;
	56	struct bt_ctf_field *payload;
	57	};
	58
	59	struct bt_ctf_field_floating_point {
	60	struct bt_ctf_field parent;
dc3fffef	61	double payload;
273b65be JG	62	};
	63
	64	struct bt_ctf_field_structure {
	65	struct bt_ctf_field parent;
	66	GHashTable *field_name_to_index;
	67	GPtrArray fields; / Array of pointers to struct bt_ctf_field */
	68	};
	69
	70	struct bt_ctf_field_variant {
	71	struct bt_ctf_field parent;
	72	struct bt_ctf_field *tag;
	73	struct bt_ctf_field *payload;
	74	};
	75
	76	struct bt_ctf_field_array {
	77	struct bt_ctf_field parent;
	78	GPtrArray elements; / Array of pointers to struct bt_ctf_field */
	79	};
	80
	81	struct bt_ctf_field_sequence {
	82	struct bt_ctf_field parent;
	83	struct bt_ctf_field *length;
	84	GPtrArray elements; / Array of pointers to struct bt_ctf_field */
	85	};
	86
	87	struct bt_ctf_field_string {
	88	struct bt_ctf_field parent;
	89	GString *payload;
	90	};
	91
	92	/*
	93	* Set a field's value with an already allocated field instance.
	94	*/
	95	BT_HIDDEN
	96	int bt_ctf_field_structure_set_field(struct bt_ctf_field *structure,
	97	const char name, struct bt_ctf_field value);
	98
662e778c	99	/* Validate that the field's payload is set (returns 0 if set). */
273b65be JG	100	BT_HIDDEN
	101	int bt_ctf_field_validate(struct bt_ctf_field *field);
	102
12c8a1a3 JG	103	/* Mark field payload as unset. */
	104	BT_HIDDEN
	105	int bt_ctf_field_reset(struct bt_ctf_field *field);
	106
273b65be JG	107	BT_HIDDEN
273b65be JG	108	int bt_ctf_field_serialize(struct bt_ctf_field *field,
dc3fffef PP	109	struct bt_ctf_stream_pos *pos,
dc3fffef PP	110	enum bt_ctf_byte_order native_byte_order);
273b65be	111
918be005 PP	112	BT_HIDDEN
	113	void bt_ctf_field_freeze(struct bt_ctf_field *field);
	114
76f869ab JG	115	BT_HIDDEN
	116	bool bt_ctf_field_is_set(struct bt_ctf_field *field);
	117
2e33ac5a	118	#endif /* BABELTRACE_CTF_IR_FIELDS_INTERNAL_H */