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

#ifndef BABELTRACE_CTF_IR_STREAM_CLASS_INTERNAL_H
#define BABELTRACE_CTF_IR_STREAM_CLASS_INTERNAL_H

/*
 * BabelTrace - CTF IR: Stream class 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/assert-internal.h>
#include <babeltrace/common-internal.h>
#include <babeltrace/ctf-ir/validation-internal.h>
#include <babeltrace/ctf-ir/field-types-internal.h>
#include <babeltrace/ctf-ir/utils-internal.h>
#include <babeltrace/ctf-ir/visitor.h>
#include <babeltrace/object-internal.h>
#include <babeltrace/babeltrace-internal.h>
#include <glib.h>
#include <inttypes.h>

struct bt_stream_class_common {
	struct bt_object base;
	GString *name;

	/* Array of pointers to event class addresses */
	GPtrArray *event_classes;

	/* event class id (int64_t) to event class address */
	GHashTable *event_classes_ht;
	int id_set;
	int64_t id;
	int64_t next_event_id;
	struct bt_field_type_common *packet_context_field_type;
	struct bt_field_type_common *event_header_field_type;
	struct bt_field_type_common *event_context_field_type;
	int frozen;
	int byte_order;

	/*
	 * This flag indicates if the stream class is valid. A valid
	 * stream class is _always_ frozen.
	 */
	int valid;

	/*
	 * Unique clock class mapped to any field type within this
	 * stream class, including all the stream class's event class
	 * field types. This is only set if the stream class is frozen.
	 *
	 * If the stream class is frozen and this is still NULL, it is
	 * still possible that it becomes non-NULL because
	 * bt_stream_class_add_event_class() can add an event class
	 * containing a field type mapped to some clock class. In this
	 * case, this is the mapped clock class, and at this point, both
	 * the new event class and the stream class are frozen, so the
	 * next added event classes are expected to contain field types
	 * which only map to this specific clock class.
	 *
	 * If this is a CTF writer stream class, then this is the
	 * backing clock class of the `clock` member above.
	 */
	struct bt_clock_class *clock_class;
};

struct bt_stream_class {
	struct bt_stream_class_common common;
};

struct bt_event_class_common;

BT_HIDDEN
int bt_stream_class_common_initialize(struct bt_stream_class_common *stream_class,
		const char *name, bt_object_release_func release_func);

BT_HIDDEN
void bt_stream_class_common_finalize(struct bt_stream_class_common *stream_class);

BT_HIDDEN
void bt_stream_class_common_freeze(struct bt_stream_class_common *stream_class);

BT_HIDDEN
void bt_stream_class_freeze(struct bt_stream_class *stream_class);

static inline
const char *bt_stream_class_common_get_name(
		struct bt_stream_class_common *stream_class)
{
	BT_ASSERT_PRE_NON_NULL(stream_class, "Stream class");
	return stream_class->name->len > 0 ? stream_class->name->str : NULL;
}

static inline
int64_t bt_stream_class_common_get_id(
		struct bt_stream_class_common *stream_class)
{
	int64_t ret;

	BT_ASSERT_PRE_NON_NULL(stream_class, "Stream class");

	if (!stream_class->id_set) {
		BT_LOGV("Stream class's ID is not set: addr=%p, name=\"%s\"",
			stream_class,
			bt_stream_class_common_get_name(stream_class));
		ret = (int64_t) -1;
		goto end;
	}

	ret = stream_class->id;

end:
	return ret;
}

BT_HIDDEN
void bt_stream_class_common_set_byte_order(
		struct bt_stream_class_common *stream_class, int byte_order);

BT_HIDDEN
int bt_stream_class_common_validate_single_clock_class(
		struct bt_stream_class_common *stream_class,
		struct bt_clock_class **expected_clock_class);

BT_HIDDEN
int bt_stream_class_common_add_event_class(
		struct bt_stream_class_common *stream_class,
		struct bt_event_class_common *event_class,
		bt_validation_flag_copy_field_type_func copy_field_type_func);

BT_HIDDEN
int bt_stream_class_common_visit(struct bt_stream_class_common *stream_class,
		bt_visitor visitor, void *data);

static inline
struct bt_trace_common *bt_stream_class_common_borrow_trace(
		struct bt_stream_class_common *stream_class)
{
	BT_ASSERT(stream_class);
	return (void *) bt_object_borrow_parent(stream_class);
}

static inline
int bt_stream_class_common_set_name(struct bt_stream_class_common *stream_class,
		const char *name)
{
	int ret = 0;

	if (!stream_class) {
		BT_LOGW_STR("Invalid parameter: stream class is NULL.");
		ret = -1;
		goto end;
	}

	if (stream_class->frozen) {
		BT_LOGW("Invalid parameter: stream class is frozen: "
			"addr=%p, name=\"%s\", id=%" PRId64,
			stream_class,
			bt_stream_class_common_get_name(stream_class),
			bt_stream_class_common_get_id(stream_class));
		ret = -1;
		goto end;
	}

	if (!name) {
		g_string_assign(stream_class->name, "");
	} else {
		if (strlen(name) == 0) {
			BT_LOGW("Invalid parameter: name is empty.");
			ret = -1;
			goto end;
		}

		g_string_assign(stream_class->name, name);
	}

	BT_LOGV("Set stream class's name: "
		"addr=%p, name=\"%s\", id=%" PRId64,
		stream_class, bt_stream_class_common_get_name(stream_class),
		bt_stream_class_common_get_id(stream_class));
end:
	return ret;
}

static inline
void _bt_stream_class_common_set_id(
		struct bt_stream_class_common *stream_class, int64_t id)
{
	BT_ASSERT(stream_class);
	stream_class->id = id;
	stream_class->id_set = 1;
	BT_LOGV("Set stream class's ID (internal): "
		"addr=%p, name=\"%s\", id=%" PRId64,
		stream_class, bt_stream_class_common_get_name(stream_class),
		bt_stream_class_common_get_id(stream_class));
}

static inline
int bt_stream_class_common_set_id_no_check(
		struct bt_stream_class_common *stream_class, int64_t id)
{
	_bt_stream_class_common_set_id(stream_class, id);
	return 0;
}

static inline
int bt_stream_class_common_set_id(struct bt_stream_class_common *stream_class,
		uint64_t id_param)
{
	int ret = 0;
	int64_t id = (int64_t) id_param;

	if (!stream_class) {
		BT_LOGW_STR("Invalid parameter: stream class is NULL.");
		ret = -1;
		goto end;
	}

	if (stream_class->frozen) {
		BT_LOGW("Invalid parameter: stream class is frozen: "
			"addr=%p, name=\"%s\", id=%" PRId64,
			stream_class,
			bt_stream_class_common_get_name(stream_class),
			bt_stream_class_common_get_id(stream_class));
		ret = -1;
		goto end;
	}

	if (id < 0) {
		BT_LOGW("Invalid parameter: invalid stream class's ID: "
			"stream-class-addr=%p, stream-class-name=\"%s\", "
			"stream-class-id=%" PRId64 ", id=%" PRIu64,
			stream_class,
			bt_stream_class_common_get_name(stream_class),
			bt_stream_class_common_get_id(stream_class),
			id_param);
		ret = -1;
		goto end;
	}

	ret = bt_stream_class_common_set_id_no_check(stream_class, id);
	if (ret == 0) {
		BT_LOGV("Set stream class's ID: "
			"addr=%p, name=\"%s\", id=%" PRId64,
			stream_class,
			bt_stream_class_common_get_name(stream_class),
			bt_stream_class_common_get_id(stream_class));
	}
end:
	return ret;
}

static inline
int64_t bt_stream_class_common_get_event_class_count(
		struct bt_stream_class_common *stream_class)
{
	int64_t ret;

	if (!stream_class) {
		BT_LOGW_STR("Invalid parameter: stream class is NULL.");
		ret = (int64_t) -1;
		goto end;
	}

	ret = (int64_t) stream_class->event_classes->len;
end:
	return ret;
}

static inline
struct bt_event_class_common *bt_stream_class_common_borrow_event_class_by_index(
		struct bt_stream_class_common *stream_class, uint64_t index)
{
	BT_ASSERT_PRE_NON_NULL(stream_class, "Stream class");
	BT_ASSERT_PRE(index < stream_class->event_classes->len,
		"Index is out of bounds: index=%" PRIu64 ", "
		"count=%u",
		index, stream_class->event_classes->len);
	return g_ptr_array_index(stream_class->event_classes, index);
}

static inline
struct bt_event_class_common *bt_stream_class_common_borrow_event_class_by_id(
		struct bt_stream_class_common *stream_class, uint64_t id)
{
	int64_t id_key = (int64_t) id;

	BT_ASSERT_PRE_NON_NULL(stream_class, "Stream class");
	BT_ASSERT_PRE(id_key >= 0,
		"Invalid event class ID: %" PRIu64, id);
	return g_hash_table_lookup(stream_class->event_classes_ht,
			&id_key);
}

static inline
struct bt_field_type_common *
bt_stream_class_common_borrow_packet_context_field_type(
		struct bt_stream_class_common *stream_class)
{
	BT_ASSERT_PRE_NON_NULL(stream_class, "Stream class");
	return stream_class->packet_context_field_type;
}

static inline
int bt_stream_class_common_set_packet_context_field_type(
		struct bt_stream_class_common *stream_class,
		struct bt_field_type_common *packet_context_type)
{
	int ret = 0;

	if (!stream_class) {
		BT_LOGW_STR("Invalid parameter: stream class is NULL.");
		ret = -1;
		goto end;
	}

	if (stream_class->frozen) {
		BT_LOGW("Invalid parameter: stream class is frozen: "
			"addr=%p, name=\"%s\", id=%" PRId64,
			stream_class, bt_stream_class_common_get_name(stream_class),
			bt_stream_class_common_get_id(stream_class));
		ret = -1;
		goto end;
	}

	if (packet_context_type &&
			bt_field_type_common_get_type_id(packet_context_type) !=
				BT_FIELD_TYPE_ID_STRUCT) {
		/* A packet context must be a structure. */
		BT_LOGW("Invalid parameter: stream class's packet context field type must be a structure: "
			"addr=%p, name=\"%s\", id=%" PRId64 ", "
			"packet-context-ft-addr=%p, packet-context-ft-id=%s",
			stream_class, bt_stream_class_common_get_name(stream_class),
			bt_stream_class_common_get_id(stream_class),
			packet_context_type,
			bt_common_field_type_id_string(
				bt_field_type_common_get_type_id(packet_context_type)));
		ret = -1;
		goto end;
	}

	bt_put(stream_class->packet_context_field_type);
	bt_get(packet_context_type);
	stream_class->packet_context_field_type = packet_context_type;
	BT_LOGV("Set stream class's packet context field type: "
		"addr=%p, name=\"%s\", id=%" PRId64 ", "
		"packet-context-ft-addr=%p",
		stream_class, bt_stream_class_common_get_name(stream_class),
		bt_stream_class_common_get_id(stream_class),
		packet_context_type);

end:
	return ret;
}

static inline
struct bt_field_type_common *
bt_stream_class_common_borrow_event_header_field_type(
		struct bt_stream_class_common *stream_class)
{
	struct bt_field_type_common *ret = NULL;

	BT_ASSERT_PRE_NON_NULL(stream_class, "Stream class");

	if (!stream_class->event_header_field_type) {
		BT_LOGV("Stream class has no event header field type: "
			"addr=%p, name=\"%s\", id=%" PRId64,
			stream_class,
			bt_stream_class_common_get_name(stream_class),
			bt_stream_class_common_get_id(stream_class));
		goto end;
	}

	ret = stream_class->event_header_field_type;

end:
	return ret;
}

static inline
int bt_stream_class_common_set_event_header_field_type(
		struct bt_stream_class_common *stream_class,
		struct bt_field_type_common *event_header_type)
{
	int ret = 0;

	if (!stream_class) {
		BT_LOGW_STR("Invalid parameter: stream class is NULL.");
		ret = -1;
		goto end;
	}

	if (stream_class->frozen) {
		BT_LOGW("Invalid parameter: stream class is frozen: "
			"addr=%p, name=\"%s\", id=%" PRId64,
			stream_class,
			bt_stream_class_common_get_name(stream_class),
			bt_stream_class_common_get_id(stream_class));
		ret = -1;
		goto end;
	}

	if (event_header_type &&
			bt_field_type_common_get_type_id(event_header_type) !=
				BT_FIELD_TYPE_ID_STRUCT) {
		/* An event header must be a structure. */
		BT_LOGW("Invalid parameter: stream class's event header field type must be a structure: "
			"addr=%p, name=\"%s\", id=%" PRId64 ", "
			"event-header-ft-addr=%p, event-header-ft-id=%s",
			stream_class, bt_stream_class_common_get_name(stream_class),
			bt_stream_class_common_get_id(stream_class),
			event_header_type,
			bt_common_field_type_id_string(
				bt_field_type_common_get_type_id(event_header_type)));
		ret = -1;
		goto end;
	}

	bt_put(stream_class->event_header_field_type);
	stream_class->event_header_field_type = bt_get(event_header_type);
	BT_LOGV("Set stream class's event header field type: "
		"addr=%p, name=\"%s\", id=%" PRId64 ", "
		"event-header-ft-addr=%p",
		stream_class, bt_stream_class_common_get_name(stream_class),
		bt_stream_class_common_get_id(stream_class),
		event_header_type);
end:
	return ret;
}

static inline
struct bt_field_type_common *
bt_stream_class_common_borrow_event_context_field_type(
		struct bt_stream_class_common *stream_class)
{
	struct bt_field_type_common *ret = NULL;

	BT_ASSERT_PRE_NON_NULL(stream_class, "Stream class");

	if (!stream_class->event_context_field_type) {
		goto end;
	}

	ret = stream_class->event_context_field_type;

end:
	return ret;
}

static inline
int bt_stream_class_common_set_event_context_field_type(
		struct bt_stream_class_common *stream_class,
		struct bt_field_type_common *event_context_type)
{
	int ret = 0;

	if (!stream_class) {
		BT_LOGW_STR("Invalid parameter: stream class is NULL.");
		ret = -1;
		goto end;
	}

	if (stream_class->frozen) {
		BT_LOGW("Invalid parameter: stream class is frozen: "
			"addr=%p, name=\"%s\", id=%" PRId64,
			stream_class, bt_stream_class_common_get_name(stream_class),
			bt_stream_class_common_get_id(stream_class));
		ret = -1;
		goto end;
	}

	if (event_context_type &&
			bt_field_type_common_get_type_id(event_context_type) !=
				BT_FIELD_TYPE_ID_STRUCT) {
		/* A packet context must be a structure. */
		BT_LOGW("Invalid parameter: stream class's event context field type must be a structure: "
			"addr=%p, name=\"%s\", id=%" PRId64 ", "
			"event-context-ft-addr=%p, event-context-ft-id=%s",
			stream_class, bt_stream_class_common_get_name(stream_class),
			bt_stream_class_common_get_id(stream_class),
			event_context_type,
			bt_common_field_type_id_string(
				bt_field_type_common_get_type_id(event_context_type)));
		ret = -1;
		goto end;
	}

	bt_put(stream_class->event_context_field_type);
	stream_class->event_context_field_type = bt_get(event_context_type);
	BT_LOGV("Set stream class's event context field type: "
		"addr=%p, name=\"%s\", id=%" PRId64 ", "
		"event-context-ft-addr=%p",
		stream_class, bt_stream_class_common_get_name(stream_class),
		bt_stream_class_common_get_id(stream_class),
		event_context_type);
end:
	return ret;
}

#endif /* BABELTRACE_CTF_IR_STREAM_CLASS_INTERNAL_H */
Commit	Line	Data
adc315b8 JG	1	#ifndef BABELTRACE_CTF_IR_STREAM_CLASS_INTERNAL_H
adc315b8 JG	2	#define BABELTRACE_CTF_IR_STREAM_CLASS_INTERNAL_H
273b65be JG	3
273b65be JG	4	/*
adc315b8	5	* BabelTrace - CTF IR: Stream class 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
3dca2276 PP	30	#include <babeltrace/assert-internal.h>
	31	#include <babeltrace/common-internal.h>
	32	#include <babeltrace/ctf-ir/validation-internal.h>
	33	#include <babeltrace/ctf-ir/field-types-internal.h>
	34	#include <babeltrace/ctf-ir/utils-internal.h>
	35	#include <babeltrace/ctf-ir/visitor.h>
83509119	36	#include <babeltrace/object-internal.h>
273b65be JG	37	#include <babeltrace/babeltrace-internal.h>
273b65be JG	38	#include <glib.h>
3dca2276	39	#include <inttypes.h>
273b65be	40
3dca2276	41	struct bt_stream_class_common {
83509119	42	struct bt_object base;
273b65be	43	GString *name;
3dca2276 PP	44
	45	/* Array of pointers to event class addresses */
	46	GPtrArray *event_classes;
	47
	48	/* event class id (int64_t) to event class address */
0b9ce69f	49	GHashTable *event_classes_ht;
adc315b8	50	int id_set;
9ac68eb1 PP	51	int64_t id;
9ac68eb1 PP	52	int64_t next_event_id;
3dca2276 PP	53	struct bt_field_type_common *packet_context_field_type;
	54	struct bt_field_type_common *event_header_field_type;
	55	struct bt_field_type_common *event_context_field_type;
273b65be	56	int frozen;
c35a1669	57	int byte_order;
09840de5 PP	58
	59	/*
	60	* This flag indicates if the stream class is valid. A valid
	61	* stream class is _always_ frozen.
	62	*/
	63	int valid;
2a3ced3c PP	64
	65	/*
	66	* Unique clock class mapped to any field type within this
	67	* stream class, including all the stream class's event class
	68	* field types. This is only set if the stream class is frozen.
	69	*
	70	* If the stream class is frozen and this is still NULL, it is
	71	* still possible that it becomes non-NULL because
	72	* bt_stream_class_add_event_class() can add an event class
	73	* containing a field type mapped to some clock class. In this
	74	* case, this is the mapped clock class, and at this point, both
	75	* the new event class and the stream class are frozen, so the
	76	* next added event classes are expected to contain field types
	77	* which only map to this specific clock class.
	78	*
	79	* If this is a CTF writer stream class, then this is the
	80	* backing clock class of the `clock` member above.
	81	*/
	82	struct bt_clock_class *clock_class;
273b65be JG	83	};
273b65be JG	84
3dca2276 PP	85	struct bt_stream_class {
	86	struct bt_stream_class_common common;
	87	};
	88
	89	struct bt_event_class_common;
273b65be	90
adc315b8	91	BT_HIDDEN
3dca2276 PP	92	int bt_stream_class_common_initialize(struct bt_stream_class_common *stream_class,
3dca2276 PP	93	const char *name, bt_object_release_func release_func);
273b65be JG	94
273b65be JG	95	BT_HIDDEN
3dca2276	96	void bt_stream_class_common_finalize(struct bt_stream_class_common *stream_class);
273b65be	97
5ca83563	98	BT_HIDDEN
3dca2276	99	void bt_stream_class_common_freeze(struct bt_stream_class_common *stream_class);
5ca83563	100
29664b2a	101	BT_HIDDEN
3dca2276 PP	102	void bt_stream_class_freeze(struct bt_stream_class *stream_class);
	103
	104	static inline
	105	const char *bt_stream_class_common_get_name(
	106	struct bt_stream_class_common *stream_class)
	107	{
	108	BT_ASSERT_PRE_NON_NULL(stream_class, "Stream class");
	109	return stream_class->name->len > 0 ? stream_class->name->str : NULL;
	110	}
	111
	112	static inline
	113	int64_t bt_stream_class_common_get_id(
	114	struct bt_stream_class_common *stream_class)
	115	{
	116	int64_t ret;
	117
	118	BT_ASSERT_PRE_NON_NULL(stream_class, "Stream class");
	119
	120	if (!stream_class->id_set) {
	121	BT_LOGV("Stream class's ID is not set: addr=%p, name=\"%s\"",
	122	stream_class,
	123	bt_stream_class_common_get_name(stream_class));
	124	ret = (int64_t) -1;
	125	goto end;
	126	}
	127
	128	ret = stream_class->id;
	129
	130	end:
	131	return ret;
	132	}
29664b2a	133
e011d2c1	134	BT_HIDDEN
3dca2276 PP	135	void bt_stream_class_common_set_byte_order(
3dca2276 PP	136	struct bt_stream_class_common *stream_class, int byte_order);
e011d2c1	137
2a3ced3c	138	BT_HIDDEN
3dca2276 PP	139	int bt_stream_class_common_validate_single_clock_class(
3dca2276 PP	140	struct bt_stream_class_common *stream_class,
2a3ced3c PP	141	struct bt_clock_class **expected_clock_class);
2a3ced3c PP	142
3dca2276 PP	143	BT_HIDDEN
	144	int bt_stream_class_common_add_event_class(
	145	struct bt_stream_class_common *stream_class,
	146	struct bt_event_class_common *event_class,
	147	bt_validation_flag_copy_field_type_func copy_field_type_func);
	148
	149	BT_HIDDEN
	150	int bt_stream_class_common_visit(struct bt_stream_class_common *stream_class,
	151	bt_visitor visitor, void *data);
	152
	153	static inline
	154	struct bt_trace_common *bt_stream_class_common_borrow_trace(
	155	struct bt_stream_class_common *stream_class)
	156	{
	157	BT_ASSERT(stream_class);
	158	return (void *) bt_object_borrow_parent(stream_class);
	159	}
	160
3dca2276 PP	161	static inline
	162	int bt_stream_class_common_set_name(struct bt_stream_class_common *stream_class,
	163	const char *name)
	164	{
	165	int ret = 0;
	166
	167	if (!stream_class) {
	168	BT_LOGW_STR("Invalid parameter: stream class is NULL.");
	169	ret = -1;
	170	goto end;
	171	}
	172
	173	if (stream_class->frozen) {
	174	BT_LOGW("Invalid parameter: stream class is frozen: "
	175	"addr=%p, name=\"%s\", id=%" PRId64,
	176	stream_class,
	177	bt_stream_class_common_get_name(stream_class),
	178	bt_stream_class_common_get_id(stream_class));
	179	ret = -1;
	180	goto end;
	181	}
	182
	183	if (!name) {
	184	g_string_assign(stream_class->name, "");
	185	} else {
	186	if (strlen(name) == 0) {
	187	BT_LOGW("Invalid parameter: name is empty.");
	188	ret = -1;
	189	goto end;
	190	}
	191
	192	g_string_assign(stream_class->name, name);
	193	}
	194
	195	BT_LOGV("Set stream class's name: "
	196	"addr=%p, name=\"%s\", id=%" PRId64,
	197	stream_class, bt_stream_class_common_get_name(stream_class),
	198	bt_stream_class_common_get_id(stream_class));
	199	end:
	200	return ret;
	201	}
	202
	203	static inline
	204	void _bt_stream_class_common_set_id(
	205	struct bt_stream_class_common *stream_class, int64_t id)
dc3fffef	206	{
f6ccaed9	207	BT_ASSERT(stream_class);
3dca2276 PP	208	stream_class->id = id;
	209	stream_class->id_set = 1;
	210	BT_LOGV("Set stream class's ID (internal): "
	211	"addr=%p, name=\"%s\", id=%" PRId64,
	212	stream_class, bt_stream_class_common_get_name(stream_class),
	213	bt_stream_class_common_get_id(stream_class));
	214	}
	215
	216	static inline
	217	int bt_stream_class_common_set_id_no_check(
	218	struct bt_stream_class_common *stream_class, int64_t id)
	219	{
	220	_bt_stream_class_common_set_id(stream_class, id);
	221	return 0;
	222	}
	223
	224	static inline
	225	int bt_stream_class_common_set_id(struct bt_stream_class_common *stream_class,
	226	uint64_t id_param)
	227	{
	228	int ret = 0;
	229	int64_t id = (int64_t) id_param;
	230
	231	if (!stream_class) {
	232	BT_LOGW_STR("Invalid parameter: stream class is NULL.");
	233	ret = -1;
	234	goto end;
	235	}
	236
	237	if (stream_class->frozen) {
	238	BT_LOGW("Invalid parameter: stream class is frozen: "
	239	"addr=%p, name=\"%s\", id=%" PRId64,
	240	stream_class,
	241	bt_stream_class_common_get_name(stream_class),
	242	bt_stream_class_common_get_id(stream_class));
	243	ret = -1;
	244	goto end;
	245	}
	246
	247	if (id < 0) {
	248	BT_LOGW("Invalid parameter: invalid stream class's ID: "
	249	"stream-class-addr=%p, stream-class-name=\"%s\", "
	250	"stream-class-id=%" PRId64 ", id=%" PRIu64,
	251	stream_class,
	252	bt_stream_class_common_get_name(stream_class),
	253	bt_stream_class_common_get_id(stream_class),
	254	id_param);
	255	ret = -1;
	256	goto end;
	257	}
	258
	259	ret = bt_stream_class_common_set_id_no_check(stream_class, id);
	260	if (ret == 0) {
	261	BT_LOGV("Set stream class's ID: "
	262	"addr=%p, name=\"%s\", id=%" PRId64,
	263	stream_class,
	264	bt_stream_class_common_get_name(stream_class),
	265	bt_stream_class_common_get_id(stream_class));
	266	}
	267	end:
	268	return ret;
	269	}
	270
	271	static inline
272	int64_t bt_stream_class_common_get_event_class_count(
273	struct bt_stream_class_common *stream_class)
274	{
275	int64_t ret;
276
277	if (!stream_class) {
278	BT_LOGW_STR("Invalid parameter: stream class is NULL.");
279	ret = (int64_t) -1;
280	goto end;
281	}
282
283	ret = (int64_t) stream_class->event_classes->len;
284	end:
285	return ret;
286	}
287
288	static inline
094ff7c0	289	struct bt_event_class_common *bt_stream_class_common_borrow_event_class_by_index(
3dca2276 PP	290	struct bt_stream_class_common *stream_class, uint64_t index)
	291	{
	292	BT_ASSERT_PRE_NON_NULL(stream_class, "Stream class");
	293	BT_ASSERT_PRE(index < stream_class->event_classes->len,
	294	"Index is out of bounds: index=%" PRIu64 ", "
	295	"count=%u",
	296	index, stream_class->event_classes->len);
094ff7c0	297	return g_ptr_array_index(stream_class->event_classes, index);
3dca2276 PP	298	}
	299
	300	static inline
094ff7c0	301	struct bt_event_class_common *bt_stream_class_common_borrow_event_class_by_id(
3dca2276 PP	302	struct bt_stream_class_common *stream_class, uint64_t id)
	303	{
	304	int64_t id_key = (int64_t) id;
	305
	306	BT_ASSERT_PRE_NON_NULL(stream_class, "Stream class");
	307	BT_ASSERT_PRE(id_key >= 0,
	308	"Invalid event class ID: %" PRIu64, id);
094ff7c0 PP	309	return g_hash_table_lookup(stream_class->event_classes_ht,
094ff7c0 PP	310	&id_key);
3dca2276 PP	311	}
	312
	313	static inline
094ff7c0 PP	314	struct bt_field_type_common *
094ff7c0 PP	315	bt_stream_class_common_borrow_packet_context_field_type(
3dca2276 PP	316	struct bt_stream_class_common *stream_class)
	317	{
	318	BT_ASSERT_PRE_NON_NULL(stream_class, "Stream class");
094ff7c0	319	return stream_class->packet_context_field_type;
3dca2276 PP	320	}
	321
	322	static inline
	323	int bt_stream_class_common_set_packet_context_field_type(
	324	struct bt_stream_class_common *stream_class,
	325	struct bt_field_type_common *packet_context_type)
	326	{
	327	int ret = 0;
	328
	329	if (!stream_class) {
	330	BT_LOGW_STR("Invalid parameter: stream class is NULL.");
	331	ret = -1;
	332	goto end;
	333	}
	334
	335	if (stream_class->frozen) {
	336	BT_LOGW("Invalid parameter: stream class is frozen: "
	337	"addr=%p, name=\"%s\", id=%" PRId64,
	338	stream_class, bt_stream_class_common_get_name(stream_class),
	339	bt_stream_class_common_get_id(stream_class));
	340	ret = -1;
	341	goto end;
	342	}
	343
	344	if (packet_context_type &&
	345	bt_field_type_common_get_type_id(packet_context_type) !=
	346	BT_FIELD_TYPE_ID_STRUCT) {
	347	/* A packet context must be a structure. */
	348	BT_LOGW("Invalid parameter: stream class's packet context field type must be a structure: "
	349	"addr=%p, name=\"%s\", id=%" PRId64 ", "
	350	"packet-context-ft-addr=%p, packet-context-ft-id=%s",
	351	stream_class, bt_stream_class_common_get_name(stream_class),
	352	bt_stream_class_common_get_id(stream_class),
	353	packet_context_type,
	354	bt_common_field_type_id_string(
	355	bt_field_type_common_get_type_id(packet_context_type)));
	356	ret = -1;
	357	goto end;
	358	}
	359
	360	bt_put(stream_class->packet_context_field_type);
	361	bt_get(packet_context_type);
	362	stream_class->packet_context_field_type = packet_context_type;
	363	BT_LOGV("Set stream class's packet context field type: "
	364	"addr=%p, name=\"%s\", id=%" PRId64 ", "
	365	"packet-context-ft-addr=%p",
	366	stream_class, bt_stream_class_common_get_name(stream_class),
	367	bt_stream_class_common_get_id(stream_class),
	368	packet_context_type);
	369
	370	end:
	371	return ret;
	372	}
	373
	374	static inline
094ff7c0 PP	375	struct bt_field_type_common *
094ff7c0 PP	376	bt_stream_class_common_borrow_event_header_field_type(
3dca2276 PP	377	struct bt_stream_class_common *stream_class)
	378	{
	379	struct bt_field_type_common *ret = NULL;
	380
	381	BT_ASSERT_PRE_NON_NULL(stream_class, "Stream class");
	382
	383	if (!stream_class->event_header_field_type) {
	384	BT_LOGV("Stream class has no event header field type: "
	385	"addr=%p, name=\"%s\", id=%" PRId64,
	386	stream_class,
	387	bt_stream_class_common_get_name(stream_class),
	388	bt_stream_class_common_get_id(stream_class));
	389	goto end;
	390	}
	391
094ff7c0	392	ret = stream_class->event_header_field_type;
3dca2276 PP	393
	394	end:
	395	return ret;
	396	}
	397
	398	static inline
	399	int bt_stream_class_common_set_event_header_field_type(
	400	struct bt_stream_class_common *stream_class,
	401	struct bt_field_type_common *event_header_type)
	402	{
	403	int ret = 0;
	404
	405	if (!stream_class) {
	406	BT_LOGW_STR("Invalid parameter: stream class is NULL.");
	407	ret = -1;
	408	goto end;
	409	}
	410
	411	if (stream_class->frozen) {
	412	BT_LOGW("Invalid parameter: stream class is frozen: "
	413	"addr=%p, name=\"%s\", id=%" PRId64,
	414	stream_class,
	415	bt_stream_class_common_get_name(stream_class),
	416	bt_stream_class_common_get_id(stream_class));
	417	ret = -1;
	418	goto end;
	419	}
	420
	421	if (event_header_type &&
	422	bt_field_type_common_get_type_id(event_header_type) !=
	423	BT_FIELD_TYPE_ID_STRUCT) {
	424	/* An event header must be a structure. */
	425	BT_LOGW("Invalid parameter: stream class's event header field type must be a structure: "
	426	"addr=%p, name=\"%s\", id=%" PRId64 ", "
	427	"event-header-ft-addr=%p, event-header-ft-id=%s",
	428	stream_class, bt_stream_class_common_get_name(stream_class),
	429	bt_stream_class_common_get_id(stream_class),
	430	event_header_type,
	431	bt_common_field_type_id_string(
	432	bt_field_type_common_get_type_id(event_header_type)));
	433	ret = -1;
	434	goto end;
	435	}
	436
	437	bt_put(stream_class->event_header_field_type);
	438	stream_class->event_header_field_type = bt_get(event_header_type);
	439	BT_LOGV("Set stream class's event header field type: "
	440	"addr=%p, name=\"%s\", id=%" PRId64 ", "
	441	"event-header-ft-addr=%p",
	442	stream_class, bt_stream_class_common_get_name(stream_class),
	443	bt_stream_class_common_get_id(stream_class),
	444	event_header_type);
	445	end:
	446	return ret;
	447	}
	448
	449	static inline
094ff7c0 PP	450	struct bt_field_type_common *
094ff7c0 PP	451	bt_stream_class_common_borrow_event_context_field_type(
3dca2276 PP	452	struct bt_stream_class_common *stream_class)
	453	{
	454	struct bt_field_type_common *ret = NULL;
	455
	456	BT_ASSERT_PRE_NON_NULL(stream_class, "Stream class");
	457
	458	if (!stream_class->event_context_field_type) {
	459	goto end;
	460	}
	461
094ff7c0	462	ret = stream_class->event_context_field_type;
3dca2276 PP	463
	464	end:
	465	return ret;
	466	}
	467
	468	static inline
	469	int bt_stream_class_common_set_event_context_field_type(
	470	struct bt_stream_class_common *stream_class,
	471	struct bt_field_type_common *event_context_type)
	472	{
	473	int ret = 0;
	474
	475	if (!stream_class) {
	476	BT_LOGW_STR("Invalid parameter: stream class is NULL.");
	477	ret = -1;
	478	goto end;
	479	}
	480
	481	if (stream_class->frozen) {
	482	BT_LOGW("Invalid parameter: stream class is frozen: "
	483	"addr=%p, name=\"%s\", id=%" PRId64,
	484	stream_class, bt_stream_class_common_get_name(stream_class),
	485	bt_stream_class_common_get_id(stream_class));
	486	ret = -1;
	487	goto end;
	488	}
	489
	490	if (event_context_type &&
	491	bt_field_type_common_get_type_id(event_context_type) !=
	492	BT_FIELD_TYPE_ID_STRUCT) {
	493	/* A packet context must be a structure. */
	494	BT_LOGW("Invalid parameter: stream class's event context field type must be a structure: "
	495	"addr=%p, name=\"%s\", id=%" PRId64 ", "
	496	"event-context-ft-addr=%p, event-context-ft-id=%s",
	497	stream_class, bt_stream_class_common_get_name(stream_class),
	498	bt_stream_class_common_get_id(stream_class),
	499	event_context_type,
	500	bt_common_field_type_id_string(
	501	bt_field_type_common_get_type_id(event_context_type)));
	502	ret = -1;
	503	goto end;
	504	}
	505
	506	bt_put(stream_class->event_context_field_type);
	507	stream_class->event_context_field_type = bt_get(event_context_type);
	508	BT_LOGV("Set stream class's event context field type: "
	509	"addr=%p, name=\"%s\", id=%" PRId64 ", "
	510	"event-context-ft-addr=%p",
	511	stream_class, bt_stream_class_common_get_name(stream_class),
	512	bt_stream_class_common_get_id(stream_class),
	513	event_context_type);
	514	end:
	515	return ret;
dc3fffef PP	516	}
dc3fffef PP	517
adc315b8	518	#endif /* BABELTRACE_CTF_IR_STREAM_CLASS_INTERNAL_H */