[babeltrace.git] / src / ctf-writer / stream-class.h

#ifndef BABELTRACE_CTF_WRITER_STREAM_CLASS_INTERNAL_H
#define BABELTRACE_CTF_WRITER_STREAM_CLASS_INTERNAL_H

/*
 * Copyright 2014 EfficiOS Inc.
 *
 * 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.
 *
 * The Common Trace Format (CTF) Specification is available at
 * http://www.efficios.com/ctf
 */

#include "common/assert.h"
#include "common/macros.h"
#include "common/common.h"
#include <babeltrace2/ctf-writer/field-types.h>
#include <babeltrace2/ctf-writer/visitor.h>
#include <inttypes.h>

#include "clock.h"
#include "field-types.h"
#include "object.h"
#include "stream-class.h"
#include "utils.h"
#include "validation.h"

struct bt_ctf_stream_class_common {
	struct bt_ctf_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_ctf_field_type_common *packet_context_field_type;
	struct bt_ctf_field_type_common *event_header_field_type;
	struct bt_ctf_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_ctf_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_ctf_clock_class *clock_class;
};

struct bt_ctf_event_class_common;

BT_HIDDEN
int bt_ctf_stream_class_common_initialize(struct bt_ctf_stream_class_common *stream_class,
		const char *name, bt_ctf_object_release_func release_func);

BT_HIDDEN
void bt_ctf_stream_class_common_finalize(struct bt_ctf_stream_class_common *stream_class);

BT_HIDDEN
void bt_ctf_stream_class_common_freeze(struct bt_ctf_stream_class_common *stream_class);

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

static inline
int64_t bt_ctf_stream_class_common_get_id(
		struct bt_ctf_stream_class_common *stream_class)
{
	int64_t ret;

	BT_CTF_ASSERT_PRE_NON_NULL(stream_class, "Stream class");

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

	ret = stream_class->id;

end:
	return ret;
}

BT_HIDDEN
void bt_ctf_stream_class_common_set_byte_order(
		struct bt_ctf_stream_class_common *stream_class, int byte_order);

BT_HIDDEN
int bt_ctf_stream_class_common_validate_single_clock_class(
		struct bt_ctf_stream_class_common *stream_class,
		struct bt_ctf_clock_class **expected_clock_class);

BT_HIDDEN
int bt_ctf_stream_class_common_add_event_class(
		struct bt_ctf_stream_class_common *stream_class,
		struct bt_ctf_event_class_common *event_class,
		bt_ctf_validation_flag_copy_field_type_func copy_field_type_func);

BT_HIDDEN
int bt_ctf_stream_class_common_visit(struct bt_ctf_stream_class_common *stream_class,
		bt_ctf_visitor visitor, void *data);

BT_HIDDEN
int bt_ctf_stream_class_visit(struct bt_ctf_stream_class *stream_class,
		bt_ctf_visitor visitor, void *data);

static inline
struct bt_ctf_trace_common *bt_ctf_stream_class_common_borrow_trace(
		struct bt_ctf_stream_class_common *stream_class)
{
	BT_ASSERT(stream_class);
	return (void *) bt_ctf_object_borrow_parent(&stream_class->base);
}

static inline
int bt_ctf_stream_class_common_set_name(struct bt_ctf_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_ctf_stream_class_common_get_name(stream_class),
			bt_ctf_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_LOGT("Set stream class's name: "
		"addr=%p, name=\"%s\", id=%" PRId64,
		stream_class, bt_ctf_stream_class_common_get_name(stream_class),
		bt_ctf_stream_class_common_get_id(stream_class));
end:
	return ret;
}

static inline
void _bt_ctf_stream_class_common_set_id(
		struct bt_ctf_stream_class_common *stream_class, int64_t id)
{
	BT_ASSERT(stream_class);
	stream_class->id = id;
	stream_class->id_set = 1;
	BT_LOGT("Set stream class's ID (internal): "
		"addr=%p, name=\"%s\", id=%" PRId64,
		stream_class, bt_ctf_stream_class_common_get_name(stream_class),
		bt_ctf_stream_class_common_get_id(stream_class));
}

static inline
int bt_ctf_stream_class_common_set_id_no_check(
		struct bt_ctf_stream_class_common *stream_class, int64_t id)
{
	_bt_ctf_stream_class_common_set_id(stream_class, id);
	return 0;
}

static inline
int bt_ctf_stream_class_common_set_id(struct bt_ctf_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_ctf_stream_class_common_get_name(stream_class),
			bt_ctf_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_ctf_stream_class_common_get_name(stream_class),
			bt_ctf_stream_class_common_get_id(stream_class),
			id_param);
		ret = -1;
		goto end;
	}

	ret = bt_ctf_stream_class_common_set_id_no_check(stream_class, id);
	if (ret == 0) {
		BT_LOGT("Set stream class's ID: "
			"addr=%p, name=\"%s\", id=%" PRId64,
			stream_class,
			bt_ctf_stream_class_common_get_name(stream_class),
			bt_ctf_stream_class_common_get_id(stream_class));
	}
end:
	return ret;
}

static inline
int64_t bt_ctf_stream_class_common_get_event_class_count(
		struct bt_ctf_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_ctf_event_class_common *bt_ctf_stream_class_common_borrow_event_class_by_index(
		struct bt_ctf_stream_class_common *stream_class, uint64_t index)
{
	BT_CTF_ASSERT_PRE_NON_NULL(stream_class, "Stream class");
	BT_CTF_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_ctf_event_class_common *bt_ctf_stream_class_common_borrow_event_class_by_id(
		struct bt_ctf_stream_class_common *stream_class, uint64_t id)
{
	int64_t id_key = (int64_t) id;

	BT_CTF_ASSERT_PRE_NON_NULL(stream_class, "Stream class");
	BT_CTF_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_ctf_field_type_common *
bt_ctf_stream_class_common_borrow_packet_context_field_type(
		struct bt_ctf_stream_class_common *stream_class)
{
	BT_CTF_ASSERT_PRE_NON_NULL(stream_class, "Stream class");
	return stream_class->packet_context_field_type;
}

static inline
int bt_ctf_stream_class_common_set_packet_context_field_type(
		struct bt_ctf_stream_class_common *stream_class,
		struct bt_ctf_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_ctf_stream_class_common_get_name(stream_class),
			bt_ctf_stream_class_common_get_id(stream_class));
		ret = -1;
		goto end;
	}

	if (packet_context_type &&
			bt_ctf_field_type_common_get_type_id(packet_context_type) !=
				BT_CTF_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_ctf_stream_class_common_get_name(stream_class),
			bt_ctf_stream_class_common_get_id(stream_class),
			packet_context_type,
			bt_ctf_field_type_id_string(
				bt_ctf_field_type_common_get_type_id(packet_context_type)));
		ret = -1;
		goto end;
	}

	bt_ctf_object_put_ref(stream_class->packet_context_field_type);
	stream_class->packet_context_field_type = packet_context_type;
	bt_ctf_object_get_ref(stream_class->packet_context_field_type);
	BT_LOGT("Set stream class's packet context field type: "
		"addr=%p, name=\"%s\", id=%" PRId64 ", "
		"packet-context-ft-addr=%p",
		stream_class, bt_ctf_stream_class_common_get_name(stream_class),
		bt_ctf_stream_class_common_get_id(stream_class),
		packet_context_type);

end:
	return ret;
}

static inline
struct bt_ctf_field_type_common *
bt_ctf_stream_class_common_borrow_event_header_field_type(
		struct bt_ctf_stream_class_common *stream_class)
{
	struct bt_ctf_field_type_common *ret = NULL;

	BT_CTF_ASSERT_PRE_NON_NULL(stream_class, "Stream class");

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

	ret = stream_class->event_header_field_type;

end:
	return ret;
}

static inline
int bt_ctf_stream_class_common_set_event_header_field_type(
		struct bt_ctf_stream_class_common *stream_class,
		struct bt_ctf_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_ctf_stream_class_common_get_name(stream_class),
			bt_ctf_stream_class_common_get_id(stream_class));
		ret = -1;
		goto end;
	}

	if (event_header_type &&
			bt_ctf_field_type_common_get_type_id(event_header_type) !=
				BT_CTF_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_ctf_stream_class_common_get_name(stream_class),
			bt_ctf_stream_class_common_get_id(stream_class),
			event_header_type,
			bt_ctf_field_type_id_string(
				bt_ctf_field_type_common_get_type_id(event_header_type)));
		ret = -1;
		goto end;
	}

	bt_ctf_object_put_ref(stream_class->event_header_field_type);
	stream_class->event_header_field_type = event_header_type;
	bt_ctf_object_get_ref(stream_class->event_header_field_type);
	BT_LOGT("Set stream class's event header field type: "
		"addr=%p, name=\"%s\", id=%" PRId64 ", "
		"event-header-ft-addr=%p",
		stream_class, bt_ctf_stream_class_common_get_name(stream_class),
		bt_ctf_stream_class_common_get_id(stream_class),
		event_header_type);
end:
	return ret;
}

static inline
struct bt_ctf_field_type_common *
bt_ctf_stream_class_common_borrow_event_context_field_type(
		struct bt_ctf_stream_class_common *stream_class)
{
	struct bt_ctf_field_type_common *ret = NULL;

	BT_CTF_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_ctf_stream_class_common_set_event_context_field_type(
		struct bt_ctf_stream_class_common *stream_class,
		struct bt_ctf_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_ctf_stream_class_common_get_name(stream_class),
			bt_ctf_stream_class_common_get_id(stream_class));
		ret = -1;
		goto end;
	}

	if (event_context_type &&
			bt_ctf_field_type_common_get_type_id(event_context_type) !=
				BT_CTF_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_ctf_stream_class_common_get_name(stream_class),
			bt_ctf_stream_class_common_get_id(stream_class),
			event_context_type,
			bt_ctf_field_type_id_string(
				bt_ctf_field_type_common_get_type_id(event_context_type)));
		ret = -1;
		goto end;
	}

	bt_ctf_object_put_ref(stream_class->event_context_field_type);
	stream_class->event_context_field_type = event_context_type;
	bt_ctf_object_get_ref(stream_class->event_context_field_type);
	BT_LOGT("Set stream class's event context field type: "
		"addr=%p, name=\"%s\", id=%" PRId64 ", "
		"event-context-ft-addr=%p",
		stream_class, bt_ctf_stream_class_common_get_name(stream_class),
		bt_ctf_stream_class_common_get_id(stream_class),
		event_context_type);
end:
	return ret;
}

struct bt_ctf_stream_class {
	struct bt_ctf_stream_class_common common;
	struct bt_ctf_clock *clock;
	int64_t next_stream_id;
};

struct metadata_context;

BT_HIDDEN
int bt_ctf_stream_class_serialize(struct bt_ctf_stream_class *stream_class,
		struct metadata_context *context);

BT_HIDDEN
int bt_ctf_stream_class_map_clock_class(
		struct bt_ctf_stream_class *stream_class,
		struct bt_ctf_field_type *packet_context_type,
		struct bt_ctf_field_type *event_header_type);

#endif /* BABELTRACE_CTF_WRITER_STREAM_CLASS_INTERNAL_H */
Commit	Line	Data
3dca2276 PP	1	#ifndef BABELTRACE_CTF_WRITER_STREAM_CLASS_INTERNAL_H
	2	#define BABELTRACE_CTF_WRITER_STREAM_CLASS_INTERNAL_H
	3
	4	/*
3dca2276 PP	5	* Copyright 2014 EfficiOS Inc.
	6	*
	7	* Author: Jérémie Galarneau <jeremie.galarneau@efficios.com>
	8	*
	9	* Permission is hereby granted, free of charge, to any person obtaining a copy
	10	* of this software and associated documentation files (the "Software"), to deal
	11	* in the Software without restriction, including without limitation the rights
	12	* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
	13	* copies of the Software, and to permit persons to whom the Software is
	14	* furnished to do so, subject to the following conditions:
	15	*
	16	* The above copyright notice and this permission notice shall be included in
	17	* all copies or substantial portions of the Software.
	18	*
	19	* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
	20	* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
	21	* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
	22	* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
	23	* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
	24	* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
	25	* SOFTWARE.
	26	*
	27	* The Common Trace Format (CTF) Specification is available at
	28	* http://www.efficios.com/ctf
	29	*/
	30
578e048b	31	#include "common/assert.h"
91d81473	32	#include "common/macros.h"
578e048b	33	#include "common/common.h"
3fadfbc0	34	#include <babeltrace2/ctf-writer/field-types.h>
3fadfbc0	35	#include <babeltrace2/ctf-writer/visitor.h>
16ca5ff0 PP	36	#include <inttypes.h>
16ca5ff0 PP	37
578e048b MJ	38	#include "clock.h"
	39	#include "field-types.h"
	40	#include "object.h"
	41	#include "stream-class.h"
	42	#include "utils.h"
	43	#include "validation.h"
	44
16ca5ff0	45	struct bt_ctf_stream_class_common {
e1e02a22	46	struct bt_ctf_object base;
16ca5ff0 PP	47	GString *name;
	48
	49	/* Array of pointers to event class addresses */
	50	GPtrArray *event_classes;
	51
	52	/* event class id (int64_t) to event class address */
	53	GHashTable *event_classes_ht;
	54	int id_set;
	55	int64_t id;
	56	int64_t next_event_id;
	57	struct bt_ctf_field_type_common *packet_context_field_type;
	58	struct bt_ctf_field_type_common *event_header_field_type;
	59	struct bt_ctf_field_type_common *event_context_field_type;
	60	int frozen;
	61	int byte_order;
	62
	63	/*
	64	* This flag indicates if the stream class is valid. A valid
	65	* stream class is _always_ frozen.
	66	*/
	67	int valid;
	68
	69	/*
	70	* Unique clock class mapped to any field type within this
	71	* stream class, including all the stream class's event class
	72	* field types. This is only set if the stream class is frozen.
	73	*
	74	* If the stream class is frozen and this is still NULL, it is
	75	* still possible that it becomes non-NULL because
	76	* bt_ctf_stream_class_add_event_class() can add an event class
	77	* containing a field type mapped to some clock class. In this
	78	* case, this is the mapped clock class, and at this point, both
	79	* the new event class and the stream class are frozen, so the
	80	* next added event classes are expected to contain field types
	81	* which only map to this specific clock class.
	82	*
	83	* If this is a CTF writer stream class, then this is the
	84	* backing clock class of the `clock` member above.
	85	*/
	86	struct bt_ctf_clock_class *clock_class;
	87	};
	88
	89	struct bt_ctf_event_class_common;
	90
	91	BT_HIDDEN
	92	int bt_ctf_stream_class_common_initialize(struct bt_ctf_stream_class_common *stream_class,
e1e02a22	93	const char *name, bt_ctf_object_release_func release_func);
16ca5ff0 PP	94
	95	BT_HIDDEN
	96	void bt_ctf_stream_class_common_finalize(struct bt_ctf_stream_class_common *stream_class);
	97
	98	BT_HIDDEN
	99	void bt_ctf_stream_class_common_freeze(struct bt_ctf_stream_class_common *stream_class);
	100
	101	static inline
	102	const char *bt_ctf_stream_class_common_get_name(
	103	struct bt_ctf_stream_class_common *stream_class)
	104	{
67d2ce02	105	BT_CTF_ASSERT_PRE_NON_NULL(stream_class, "Stream class");
16ca5ff0 PP	106	return stream_class->name->len > 0 ? stream_class->name->str : NULL;
	107	}
	108
	109	static inline
	110	int64_t bt_ctf_stream_class_common_get_id(
	111	struct bt_ctf_stream_class_common *stream_class)
	112	{
	113	int64_t ret;
	114
67d2ce02	115	BT_CTF_ASSERT_PRE_NON_NULL(stream_class, "Stream class");
16ca5ff0 PP	116
16ca5ff0 PP	117	if (!stream_class->id_set) {
ef267d12	118	BT_LOGT("Stream class's ID is not set: addr=%p, name=\"%s\"",
16ca5ff0 PP	119	stream_class,
	120	bt_ctf_stream_class_common_get_name(stream_class));
	121	ret = (int64_t) -1;
	122	goto end;
	123	}
	124
	125	ret = stream_class->id;
	126
	127	end:
	128	return ret;
	129	}
	130
	131	BT_HIDDEN
	132	void bt_ctf_stream_class_common_set_byte_order(
	133	struct bt_ctf_stream_class_common *stream_class, int byte_order);
	134
	135	BT_HIDDEN
	136	int bt_ctf_stream_class_common_validate_single_clock_class(
	137	struct bt_ctf_stream_class_common *stream_class,
	138	struct bt_ctf_clock_class **expected_clock_class);
	139
	140	BT_HIDDEN
	141	int bt_ctf_stream_class_common_add_event_class(
	142	struct bt_ctf_stream_class_common *stream_class,
	143	struct bt_ctf_event_class_common *event_class,
	144	bt_ctf_validation_flag_copy_field_type_func copy_field_type_func);
	145
	146	BT_HIDDEN
	147	int bt_ctf_stream_class_common_visit(struct bt_ctf_stream_class_common *stream_class,
	148	bt_ctf_visitor visitor, void *data);
	149
	150	BT_HIDDEN
	151	int bt_ctf_stream_class_visit(struct bt_ctf_stream_class *stream_class,
	152	bt_ctf_visitor visitor, void *data);
	153
	154	static inline
	155	struct bt_ctf_trace_common *bt_ctf_stream_class_common_borrow_trace(
	156	struct bt_ctf_stream_class_common *stream_class)
	157	{
	158	BT_ASSERT(stream_class);
e1e02a22	159	return (void *) bt_ctf_object_borrow_parent(&stream_class->base);
16ca5ff0 PP	160	}
	161
	162	static inline
	163	int bt_ctf_stream_class_common_set_name(struct bt_ctf_stream_class_common *stream_class,
	164	const char *name)
	165	{
	166	int ret = 0;
	167
	168	if (!stream_class) {
	169	BT_LOGW_STR("Invalid parameter: stream class is NULL.");
	170	ret = -1;
	171	goto end;
	172	}
	173
	174	if (stream_class->frozen) {
	175	BT_LOGW("Invalid parameter: stream class is frozen: "
	176	"addr=%p, name=\"%s\", id=%" PRId64,
	177	stream_class,
	178	bt_ctf_stream_class_common_get_name(stream_class),
	179	bt_ctf_stream_class_common_get_id(stream_class));
	180	ret = -1;
	181	goto end;
	182	}
	183
	184	if (!name) {
	185	g_string_assign(stream_class->name, "");
	186	} else {
	187	if (strlen(name) == 0) {
	188	BT_LOGW("Invalid parameter: name is empty.");
	189	ret = -1;
	190	goto end;
	191	}
	192
	193	g_string_assign(stream_class->name, name);
	194	}
	195
ef267d12	196	BT_LOGT("Set stream class's name: "
16ca5ff0 PP	197	"addr=%p, name=\"%s\", id=%" PRId64,
	198	stream_class, bt_ctf_stream_class_common_get_name(stream_class),
	199	bt_ctf_stream_class_common_get_id(stream_class));
	200	end:
	201	return ret;
	202	}
	203
	204	static inline
	205	void _bt_ctf_stream_class_common_set_id(
	206	struct bt_ctf_stream_class_common *stream_class, int64_t id)
	207	{
	208	BT_ASSERT(stream_class);
	209	stream_class->id = id;
	210	stream_class->id_set = 1;
ef267d12	211	BT_LOGT("Set stream class's ID (internal): "
16ca5ff0 PP	212	"addr=%p, name=\"%s\", id=%" PRId64,
	213	stream_class, bt_ctf_stream_class_common_get_name(stream_class),
	214	bt_ctf_stream_class_common_get_id(stream_class));
	215	}
	216
	217	static inline
	218	int bt_ctf_stream_class_common_set_id_no_check(
	219	struct bt_ctf_stream_class_common *stream_class, int64_t id)
	220	{
	221	_bt_ctf_stream_class_common_set_id(stream_class, id);
	222	return 0;
	223	}
	224
	225	static inline
	226	int bt_ctf_stream_class_common_set_id(struct bt_ctf_stream_class_common *stream_class,
	227	uint64_t id_param)
	228	{
	229	int ret = 0;
	230	int64_t id = (int64_t) id_param;
	231
	232	if (!stream_class) {
	233	BT_LOGW_STR("Invalid parameter: stream class is NULL.");
	234	ret = -1;
	235	goto end;
	236	}
	237
	238	if (stream_class->frozen) {
	239	BT_LOGW("Invalid parameter: stream class is frozen: "
	240	"addr=%p, name=\"%s\", id=%" PRId64,
	241	stream_class,
	242	bt_ctf_stream_class_common_get_name(stream_class),
	243	bt_ctf_stream_class_common_get_id(stream_class));
	244	ret = -1;
	245	goto end;
	246	}
	247
	248	if (id < 0) {
	249	BT_LOGW("Invalid parameter: invalid stream class's ID: "
	250	"stream-class-addr=%p, stream-class-name=\"%s\", "
	251	"stream-class-id=%" PRId64 ", id=%" PRIu64,
	252	stream_class,
	253	bt_ctf_stream_class_common_get_name(stream_class),
	254	bt_ctf_stream_class_common_get_id(stream_class),
	255	id_param);
	256	ret = -1;
	257	goto end;
	258	}
	259
	260	ret = bt_ctf_stream_class_common_set_id_no_check(stream_class, id);
	261	if (ret == 0) {
ef267d12	262	BT_LOGT("Set stream class's ID: "
16ca5ff0 PP	263	"addr=%p, name=\"%s\", id=%" PRId64,
	264	stream_class,
	265	bt_ctf_stream_class_common_get_name(stream_class),
	266	bt_ctf_stream_class_common_get_id(stream_class));
	267	}
	268	end:
	269	return ret;
	270	}
	271
	272	static inline
	273	int64_t bt_ctf_stream_class_common_get_event_class_count(
	274	struct bt_ctf_stream_class_common *stream_class)
	275	{
	276	int64_t ret;
	277
	278	if (!stream_class) {
	279	BT_LOGW_STR("Invalid parameter: stream class is NULL.");
	280	ret = (int64_t) -1;
	281	goto end;
	282	}
	283
	284	ret = (int64_t) stream_class->event_classes->len;
	285	end:
	286	return ret;
	287	}
	288
	289	static inline
	290	struct bt_ctf_event_class_common *bt_ctf_stream_class_common_borrow_event_class_by_index(
	291	struct bt_ctf_stream_class_common *stream_class, uint64_t index)
	292	{
67d2ce02 MJ	293	BT_CTF_ASSERT_PRE_NON_NULL(stream_class, "Stream class");
67d2ce02 MJ	294	BT_CTF_ASSERT_PRE(index < stream_class->event_classes->len,
16ca5ff0 PP	295	"Index is out of bounds: index=%" PRIu64 ", "
	296	"count=%u",
	297	index, stream_class->event_classes->len);
	298	return g_ptr_array_index(stream_class->event_classes, index);
	299	}
	300
	301	static inline
	302	struct bt_ctf_event_class_common *bt_ctf_stream_class_common_borrow_event_class_by_id(
	303	struct bt_ctf_stream_class_common *stream_class, uint64_t id)
	304	{
	305	int64_t id_key = (int64_t) id;
	306
67d2ce02 MJ	307	BT_CTF_ASSERT_PRE_NON_NULL(stream_class, "Stream class");
67d2ce02 MJ	308	BT_CTF_ASSERT_PRE(id_key >= 0,
16ca5ff0 PP	309	"Invalid event class ID: %" PRIu64, id);
	310	return g_hash_table_lookup(stream_class->event_classes_ht,
	311	&id_key);
	312	}
	313
	314	static inline
	315	struct bt_ctf_field_type_common *
	316	bt_ctf_stream_class_common_borrow_packet_context_field_type(
	317	struct bt_ctf_stream_class_common *stream_class)
	318	{
67d2ce02	319	BT_CTF_ASSERT_PRE_NON_NULL(stream_class, "Stream class");
16ca5ff0 PP	320	return stream_class->packet_context_field_type;
	321	}
	322
	323	static inline
	324	int bt_ctf_stream_class_common_set_packet_context_field_type(
	325	struct bt_ctf_stream_class_common *stream_class,
	326	struct bt_ctf_field_type_common *packet_context_type)
	327	{
	328	int ret = 0;
	329
	330	if (!stream_class) {
	331	BT_LOGW_STR("Invalid parameter: stream class is NULL.");
	332	ret = -1;
	333	goto end;
	334	}
	335
	336	if (stream_class->frozen) {
	337	BT_LOGW("Invalid parameter: stream class is frozen: "
	338	"addr=%p, name=\"%s\", id=%" PRId64,
	339	stream_class, bt_ctf_stream_class_common_get_name(stream_class),
	340	bt_ctf_stream_class_common_get_id(stream_class));
	341	ret = -1;
	342	goto end;
	343	}
	344
	345	if (packet_context_type &&
	346	bt_ctf_field_type_common_get_type_id(packet_context_type) !=
	347	BT_CTF_FIELD_TYPE_ID_STRUCT) {
	348	/* A packet context must be a structure. */
	349	BT_LOGW("Invalid parameter: stream class's packet context field type must be a structure: "
	350	"addr=%p, name=\"%s\", id=%" PRId64 ", "
	351	"packet-context-ft-addr=%p, packet-context-ft-id=%s",
	352	stream_class, bt_ctf_stream_class_common_get_name(stream_class),
	353	bt_ctf_stream_class_common_get_id(stream_class),
	354	packet_context_type,
	355	bt_ctf_field_type_id_string(
	356	bt_ctf_field_type_common_get_type_id(packet_context_type)));
	357	ret = -1;
	358	goto end;
	359	}
	360
e1e02a22	361	bt_ctf_object_put_ref(stream_class->packet_context_field_type);
16ca5ff0	362	stream_class->packet_context_field_type = packet_context_type;
e1e02a22	363	bt_ctf_object_get_ref(stream_class->packet_context_field_type);
ef267d12	364	BT_LOGT("Set stream class's packet context field type: "
16ca5ff0 PP	365	"addr=%p, name=\"%s\", id=%" PRId64 ", "
	366	"packet-context-ft-addr=%p",
	367	stream_class, bt_ctf_stream_class_common_get_name(stream_class),
	368	bt_ctf_stream_class_common_get_id(stream_class),
	369	packet_context_type);
	370
	371	end:
	372	return ret;
	373	}
	374
	375	static inline
	376	struct bt_ctf_field_type_common *
	377	bt_ctf_stream_class_common_borrow_event_header_field_type(
	378	struct bt_ctf_stream_class_common *stream_class)
	379	{
	380	struct bt_ctf_field_type_common *ret = NULL;
	381
67d2ce02	382	BT_CTF_ASSERT_PRE_NON_NULL(stream_class, "Stream class");
16ca5ff0 PP	383
16ca5ff0 PP	384	if (!stream_class->event_header_field_type) {
ef267d12	385	BT_LOGT("Stream class has no event header field type: "
16ca5ff0 PP	386	"addr=%p, name=\"%s\", id=%" PRId64,
	387	stream_class,
	388	bt_ctf_stream_class_common_get_name(stream_class),
	389	bt_ctf_stream_class_common_get_id(stream_class));
	390	goto end;
	391	}
	392
	393	ret = stream_class->event_header_field_type;
	394
	395	end:
	396	return ret;
	397	}
	398
	399	static inline
	400	int bt_ctf_stream_class_common_set_event_header_field_type(
	401	struct bt_ctf_stream_class_common *stream_class,
	402	struct bt_ctf_field_type_common *event_header_type)
	403	{
	404	int ret = 0;
	405
	406	if (!stream_class) {
	407	BT_LOGW_STR("Invalid parameter: stream class is NULL.");
	408	ret = -1;
	409	goto end;
	410	}
	411
	412	if (stream_class->frozen) {
	413	BT_LOGW("Invalid parameter: stream class is frozen: "
	414	"addr=%p, name=\"%s\", id=%" PRId64,
	415	stream_class,
	416	bt_ctf_stream_class_common_get_name(stream_class),
	417	bt_ctf_stream_class_common_get_id(stream_class));
	418	ret = -1;
	419	goto end;
	420	}
	421
	422	if (event_header_type &&
	423	bt_ctf_field_type_common_get_type_id(event_header_type) !=
	424	BT_CTF_FIELD_TYPE_ID_STRUCT) {
	425	/* An event header must be a structure. */
	426	BT_LOGW("Invalid parameter: stream class's event header field type must be a structure: "
	427	"addr=%p, name=\"%s\", id=%" PRId64 ", "
	428	"event-header-ft-addr=%p, event-header-ft-id=%s",
	429	stream_class, bt_ctf_stream_class_common_get_name(stream_class),
	430	bt_ctf_stream_class_common_get_id(stream_class),
	431	event_header_type,
	432	bt_ctf_field_type_id_string(
	433	bt_ctf_field_type_common_get_type_id(event_header_type)));
	434	ret = -1;
	435	goto end;
	436	}
	437
e1e02a22 PP	438	bt_ctf_object_put_ref(stream_class->event_header_field_type);
	439	stream_class->event_header_field_type = event_header_type;
	440	bt_ctf_object_get_ref(stream_class->event_header_field_type);
ef267d12	441	BT_LOGT("Set stream class's event header field type: "
16ca5ff0 PP	442	"addr=%p, name=\"%s\", id=%" PRId64 ", "
	443	"event-header-ft-addr=%p",
	444	stream_class, bt_ctf_stream_class_common_get_name(stream_class),
	445	bt_ctf_stream_class_common_get_id(stream_class),
	446	event_header_type);
	447	end:
	448	return ret;
	449	}
	450
	451	static inline
	452	struct bt_ctf_field_type_common *
	453	bt_ctf_stream_class_common_borrow_event_context_field_type(
	454	struct bt_ctf_stream_class_common *stream_class)
	455	{
	456	struct bt_ctf_field_type_common *ret = NULL;
	457
67d2ce02	458	BT_CTF_ASSERT_PRE_NON_NULL(stream_class, "Stream class");
16ca5ff0 PP	459
	460	if (!stream_class->event_context_field_type) {
	461	goto end;
	462	}
	463
	464	ret = stream_class->event_context_field_type;
	465
	466	end:
	467	return ret;
	468	}
	469
	470	static inline
	471	int bt_ctf_stream_class_common_set_event_context_field_type(
	472	struct bt_ctf_stream_class_common *stream_class,
	473	struct bt_ctf_field_type_common *event_context_type)
	474	{
	475	int ret = 0;
	476
	477	if (!stream_class) {
	478	BT_LOGW_STR("Invalid parameter: stream class is NULL.");
	479	ret = -1;
	480	goto end;
	481	}
	482
	483	if (stream_class->frozen) {
	484	BT_LOGW("Invalid parameter: stream class is frozen: "
	485	"addr=%p, name=\"%s\", id=%" PRId64,
	486	stream_class, bt_ctf_stream_class_common_get_name(stream_class),
	487	bt_ctf_stream_class_common_get_id(stream_class));
	488	ret = -1;
	489	goto end;
	490	}
	491
	492	if (event_context_type &&
	493	bt_ctf_field_type_common_get_type_id(event_context_type) !=
	494	BT_CTF_FIELD_TYPE_ID_STRUCT) {
	495	/* A packet context must be a structure. */
	496	BT_LOGW("Invalid parameter: stream class's event context field type must be a structure: "
	497	"addr=%p, name=\"%s\", id=%" PRId64 ", "
	498	"event-context-ft-addr=%p, event-context-ft-id=%s",
	499	stream_class, bt_ctf_stream_class_common_get_name(stream_class),
	500	bt_ctf_stream_class_common_get_id(stream_class),
	501	event_context_type,
	502	bt_ctf_field_type_id_string(
	503	bt_ctf_field_type_common_get_type_id(event_context_type)));
	504	ret = -1;
	505	goto end;
	506	}
	507
e1e02a22 PP	508	bt_ctf_object_put_ref(stream_class->event_context_field_type);
	509	stream_class->event_context_field_type = event_context_type;
	510	bt_ctf_object_get_ref(stream_class->event_context_field_type);
ef267d12	511	BT_LOGT("Set stream class's event context field type: "
16ca5ff0 PP	512	"addr=%p, name=\"%s\", id=%" PRId64 ", "
	513	"event-context-ft-addr=%p",
	514	stream_class, bt_ctf_stream_class_common_get_name(stream_class),
	515	bt_ctf_stream_class_common_get_id(stream_class),
	516	event_context_type);
	517	end:
	518	return ret;
	519	}
3dca2276 PP	520
3dca2276 PP	521	struct bt_ctf_stream_class {
16ca5ff0	522	struct bt_ctf_stream_class_common common;
3dca2276 PP	523	struct bt_ctf_clock *clock;
	524	int64_t next_stream_id;
	525	};
	526
	527	struct metadata_context;
	528
	529	BT_HIDDEN
	530	int bt_ctf_stream_class_serialize(struct bt_ctf_stream_class *stream_class,
	531	struct metadata_context *context);
	532
	533	BT_HIDDEN
	534	int bt_ctf_stream_class_map_clock_class(
	535	struct bt_ctf_stream_class *stream_class,
	536	struct bt_ctf_field_type *packet_context_type,
	537	struct bt_ctf_field_type *event_header_type);
	538
	539	#endif /* BABELTRACE_CTF_WRITER_STREAM_CLASS_INTERNAL_H */