[babeltrace.git] / lib / trace-ir / trace-class.c

/*
 * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
 * Copyright 2014 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.
 */

#define BT_LOG_TAG "TRACE"
#include <babeltrace/lib-logging-internal.h>

#include <babeltrace/assert-pre-internal.h>
#include <babeltrace/trace-ir/trace-class.h>
#include <babeltrace/trace-ir/trace-class-const.h>
#include <babeltrace/trace-ir/trace-internal.h>
#include <babeltrace/trace-ir/clock-class-internal.h>
#include <babeltrace/trace-ir/stream-internal.h>
#include <babeltrace/trace-ir/stream-class-internal.h>
#include <babeltrace/trace-ir/event-internal.h>
#include <babeltrace/trace-ir/event-class.h>
#include <babeltrace/trace-ir/event-class-internal.h>
#include <babeltrace/ctf-writer/functor-internal.h>
#include <babeltrace/ctf-writer/clock-internal.h>
#include <babeltrace/trace-ir/field-wrapper-internal.h>
#include <babeltrace/trace-ir/field-class-internal.h>
#include <babeltrace/trace-ir/attributes-internal.h>
#include <babeltrace/trace-ir/utils-internal.h>
#include <babeltrace/trace-ir/resolve-field-path-internal.h>
#include <babeltrace/compiler-internal.h>
#include <babeltrace/value.h>
#include <babeltrace/value-const.h>
#include <babeltrace/value-internal.h>
#include <babeltrace/types.h>
#include <babeltrace/endian-internal.h>
#include <babeltrace/assert-internal.h>
#include <babeltrace/compat/glib-internal.h>
#include <inttypes.h>
#include <stdint.h>
#include <string.h>
#include <stdlib.h>

#define BT_ASSERT_PRE_TRACE_CLASS_HOT(_tc)				\
	BT_ASSERT_PRE_HOT((_tc), "Trace class", ": %!+T", (_tc))

static
void destroy_trace_class(struct bt_object *obj)
{
	struct bt_trace_class *tc = (void *) obj;

	BT_LIB_LOGD("Destroying trace class object: %!+T", tc);
	bt_object_pool_finalize(&tc->packet_header_field_pool);

	if (tc->environment) {
		BT_LOGD_STR("Destroying environment attributes.");
		bt_attributes_destroy(tc->environment);
		tc->environment = NULL;
	}

	if (tc->name.str) {
		g_string_free(tc->name.str, TRUE);
		tc->name.str = NULL;
		tc->name.value = NULL;
	}

	if (tc->stream_classes) {
		BT_LOGD_STR("Destroying stream classes.");
		g_ptr_array_free(tc->stream_classes, TRUE);
		tc->stream_classes = NULL;
	}

	BT_LOGD_STR("Putting packet header field class.");
	bt_object_put_ref(tc->packet_header_fc);
	tc->packet_header_fc = NULL;
	g_free(tc);
}

static
void free_packet_header_field(struct bt_field_wrapper *field_wrapper,
		struct bt_trace_class *tc)
{
	bt_field_wrapper_destroy(field_wrapper);
}

struct bt_trace_class *bt_trace_class_create(void)
{
	struct bt_trace_class *tc = NULL;
	int ret;

	BT_LOGD_STR("Creating default trace class object.");
	tc = g_new0(struct bt_trace_class, 1);
	if (!tc) {
		BT_LOGE_STR("Failed to allocate one trace class.");
		goto error;
	}

	bt_object_init_shared_with_parent(&tc->base, destroy_trace_class);

	tc->stream_classes = g_ptr_array_new_with_free_func(
		(GDestroyNotify) bt_object_try_spec_release);
	if (!tc->stream_classes) {
		BT_LOGE_STR("Failed to allocate one GPtrArray.");
		goto error;
	}

	tc->name.str = g_string_new(NULL);
	if (!tc->name.str) {
		BT_LOGE_STR("Failed to allocate one GString.");
		goto error;
	}

	tc->environment = bt_attributes_create();
	if (!tc->environment) {
		BT_LOGE_STR("Cannot create empty attributes object.");
		goto error;
	}

	tc->assigns_automatic_stream_class_id = true;
	ret = bt_object_pool_initialize(&tc->packet_header_field_pool,
		(bt_object_pool_new_object_func) bt_field_wrapper_new,
		(bt_object_pool_destroy_object_func) free_packet_header_field,
		tc);
	if (ret) {
		BT_LOGE("Failed to initialize packet header field pool: ret=%d",
			ret);
		goto error;
	}

	BT_LIB_LOGD("Created trace class object: %!+T", tc);
	goto end;

error:
	BT_OBJECT_PUT_REF_AND_RESET(tc);

end:
	return tc;
}

const char *bt_trace_class_get_name(const struct bt_trace_class *tc)
{
	BT_ASSERT_PRE_NON_NULL(tc, "Trace class");
	return tc->name.value;
}

enum bt_trace_class_status bt_trace_class_set_name(
		struct bt_trace_class *tc, const char *name)
{
	BT_ASSERT_PRE_NON_NULL(tc, "Trace class");
	BT_ASSERT_PRE_NON_NULL(name, "Name");
	BT_ASSERT_PRE_TRACE_CLASS_HOT(tc);
	g_string_assign(tc->name.str, name);
	tc->name.value = tc->name.str->str;
	BT_LIB_LOGV("Set trace class's name: %!+T", tc);
	return BT_TRACE_CLASS_STATUS_OK;
}

bt_uuid bt_trace_class_get_uuid(const struct bt_trace_class *tc)
{
	BT_ASSERT_PRE_NON_NULL(tc, "Trace class");
	return tc->uuid.value;
}

void bt_trace_class_set_uuid(struct bt_trace_class *tc, bt_uuid uuid)
{
	BT_ASSERT_PRE_NON_NULL(tc, "Trace class");
	BT_ASSERT_PRE_NON_NULL(uuid, "UUID");
	BT_ASSERT_PRE_TRACE_CLASS_HOT(tc);
	memcpy(tc->uuid.uuid, uuid, BABELTRACE_UUID_LEN);
	tc->uuid.value = tc->uuid.uuid;
	BT_LIB_LOGV("Set trace class's UUID: %!+T", tc);
}

BT_ASSERT_FUNC
static
bool trace_has_environment_entry(const struct bt_trace_class *tc, const char *name)
{
	BT_ASSERT(tc);

	return bt_attributes_borrow_field_value_by_name(
		tc->environment, name) != NULL;
}

static
enum bt_trace_class_status set_environment_entry(struct bt_trace_class *tc,
		const char *name, struct bt_value *value)
{
	int ret;

	BT_ASSERT(tc);
	BT_ASSERT(name);
	BT_ASSERT(value);
	BT_ASSERT_PRE(!tc->frozen ||
		!trace_has_environment_entry(tc, name),
		"Trace class is frozen: cannot replace environment entry: "
		"%![tc-]+T, entry-name=\"%s\"", tc, name);
	ret = bt_attributes_set_field_value(tc->environment, name,
		value);
	if (ret) {
		ret = BT_TRACE_CLASS_STATUS_NOMEM;
		BT_LIB_LOGE("Cannot set trace class's environment entry: "
			"%![tc-]+T, entry-name=\"%s\"", tc, name);
	} else {
		bt_value_freeze(value);
		BT_LIB_LOGV("Set trace class's environment entry: "
			"%![tc-]+T, entry-name=\"%s\"", tc, name);
	}

	return ret;
}

enum bt_trace_class_status bt_trace_class_set_environment_entry_string(
		struct bt_trace_class *tc, const char *name, const char *value)
{
	int ret;
	struct bt_value *value_obj;
	BT_ASSERT_PRE_NON_NULL(tc, "Trace class");
	BT_ASSERT_PRE_NON_NULL(name, "Name");
	BT_ASSERT_PRE_NON_NULL(value, "Value");
	value_obj = bt_value_string_create_init(value);
	if (!value_obj) {
		BT_LOGE_STR("Cannot create a string value object.");
		ret = -1;
		goto end;
	}

	/* set_environment_entry() logs errors */
	ret = set_environment_entry(tc, name, value_obj);

end:
	bt_object_put_ref(value_obj);
	return ret;
}

enum bt_trace_class_status bt_trace_class_set_environment_entry_integer(
		struct bt_trace_class *tc, const char *name, int64_t value)
{
	int ret;
	struct bt_value *value_obj;
	BT_ASSERT_PRE_NON_NULL(tc, "Trace class");
	BT_ASSERT_PRE_NON_NULL(name, "Name");
	value_obj = bt_value_integer_create_init(value);
	if (!value_obj) {
		BT_LOGE_STR("Cannot create an integer value object.");
		ret = BT_TRACE_CLASS_STATUS_NOMEM;
		goto end;
	}

	/* set_environment_entry() logs errors */
	ret = set_environment_entry(tc, name, value_obj);

end:
	bt_object_put_ref(value_obj);
	return ret;
}

uint64_t bt_trace_class_get_environment_entry_count(const struct bt_trace_class *tc)
{
	int64_t ret;

	BT_ASSERT_PRE_NON_NULL(tc, "Trace class");
	ret = bt_attributes_get_count(tc->environment);
	BT_ASSERT(ret >= 0);
	return (uint64_t) ret;
}

void bt_trace_class_borrow_environment_entry_by_index_const(
		const struct bt_trace_class *tc, uint64_t index,
		const char **name, const struct bt_value **value)
{
	BT_ASSERT_PRE_NON_NULL(tc, "Trace class");
	BT_ASSERT_PRE_NON_NULL(name, "Name");
	BT_ASSERT_PRE_NON_NULL(value, "Value");
	BT_ASSERT_PRE_VALID_INDEX(index,
		bt_attributes_get_count(tc->environment));
	*value = bt_attributes_borrow_field_value(tc->environment, index);
	BT_ASSERT(*value);
	*name = bt_attributes_get_field_name(tc->environment, index);
	BT_ASSERT(*name);
}

const struct bt_value *bt_trace_class_borrow_environment_entry_value_by_name_const(
		const struct bt_trace_class *tc, const char *name)
{
	BT_ASSERT_PRE_NON_NULL(tc, "Trace class");
	BT_ASSERT_PRE_NON_NULL(name, "Name");
	return bt_attributes_borrow_field_value_by_name(tc->environment,
		name);
}

uint64_t bt_trace_class_get_stream_class_count(const struct bt_trace_class *tc)
{
	BT_ASSERT_PRE_NON_NULL(tc, "Trace class");
	return (uint64_t) tc->stream_classes->len;
}

struct bt_stream_class *bt_trace_class_borrow_stream_class_by_index(
		struct bt_trace_class *tc, uint64_t index)
{
	BT_ASSERT_PRE_NON_NULL(tc, "Trace class");
	BT_ASSERT_PRE_VALID_INDEX(index, tc->stream_classes->len);
	return g_ptr_array_index(tc->stream_classes, index);
}

const struct bt_stream_class *
bt_trace_class_borrow_stream_class_by_index_const(
		const struct bt_trace_class *tc, uint64_t index)
{
	return bt_trace_class_borrow_stream_class_by_index(
		(void *) tc, index);
}

struct bt_stream_class *bt_trace_class_borrow_stream_class_by_id(
		struct bt_trace_class *tc, uint64_t id)
{
	struct bt_stream_class *stream_class = NULL;
	uint64_t i;

	BT_ASSERT_PRE_NON_NULL(tc, "Trace class");

	for (i = 0; i < tc->stream_classes->len; i++) {
		struct bt_stream_class *stream_class_candidate =
			g_ptr_array_index(tc->stream_classes, i);

		if (stream_class_candidate->id == id) {
			stream_class = stream_class_candidate;
			goto end;
		}
	}

end:
	return stream_class;
}

const struct bt_stream_class *
bt_trace_class_borrow_stream_class_by_id_const(
		const struct bt_trace_class *tc, uint64_t id)
{
	return bt_trace_class_borrow_stream_class_by_id((void *) tc, id);
}

const struct bt_field_class *bt_trace_class_borrow_packet_header_field_class_const(
		const struct bt_trace_class *tc)
{
	BT_ASSERT_PRE_NON_NULL(tc, "Trace class");
	return tc->packet_header_fc;
}

enum bt_trace_class_status bt_trace_class_set_packet_header_field_class(
		struct bt_trace_class *tc,
		struct bt_field_class *field_class)
{
	int ret;
	struct bt_resolve_field_path_context resolve_ctx = {
		.packet_header = field_class,
		.packet_context = NULL,
		.event_header = NULL,
		.event_common_context = NULL,
		.event_specific_context = NULL,
		.event_payload = NULL,
	};

	BT_ASSERT_PRE_NON_NULL(tc, "Trace class");
	BT_ASSERT_PRE_NON_NULL(field_class, "Field class");
	BT_ASSERT_PRE_TRACE_CLASS_HOT(tc);
	BT_ASSERT_PRE(bt_field_class_get_type(field_class) ==
		BT_FIELD_CLASS_TYPE_STRUCTURE,
		"Packet header field class is not a structure field class: %!+F",
		field_class);
	ret = bt_resolve_field_paths(field_class, &resolve_ctx);
	if (ret) {
		/*
		 * This is the only reason for which
		 * bt_resolve_field_paths() can fail: anything else
		 * would be because a precondition is not satisfied.
		 */
		ret = BT_TRACE_CLASS_STATUS_NOMEM;
		goto end;
	}

	bt_field_class_make_part_of_trace_class(field_class);
	bt_object_put_ref(tc->packet_header_fc);
	tc->packet_header_fc = field_class;
	bt_object_get_no_null_check(tc->packet_header_fc);
	bt_field_class_freeze(field_class);
	BT_LIB_LOGV("Set trace class's packet header field class: %!+T", tc);

end:
	return ret;
}

BT_HIDDEN
void _bt_trace_class_freeze(const struct bt_trace_class *tc)
{
	/* The packet header field class is already frozen */
	BT_ASSERT(tc);
	BT_LIB_LOGD("Freezing trace class: %!+T", tc);
	((struct bt_trace_class *) tc)->frozen = true;
}

bt_bool bt_trace_class_assigns_automatic_stream_class_id(const struct bt_trace_class *tc)
{
	BT_ASSERT_PRE_NON_NULL(tc, "Trace class");
	return (bt_bool) tc->assigns_automatic_stream_class_id;
}

void bt_trace_class_set_assigns_automatic_stream_class_id(struct bt_trace_class *tc,
		bt_bool value)
{
	BT_ASSERT_PRE_NON_NULL(tc, "Trace class");
	BT_ASSERT_PRE_TRACE_CLASS_HOT(tc);
	tc->assigns_automatic_stream_class_id = (bool) value;
	BT_LIB_LOGV("Set trace class's automatic stream class ID "
		"assignment property: %!+T", tc);
}

void bt_trace_class_get_ref(const struct bt_trace_class *trace_class)
{
	bt_object_get_ref(trace_class);
}

void bt_trace_class_put_ref(const struct bt_trace_class *trace_class)
{
	bt_object_put_ref(trace_class);
}
Commit	Line	Data
862ca4ed	1	/*
e2f7325d	2	* Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
862ca4ed PP	3	* Copyright 2014 Jérémie Galarneau <jeremie.galarneau@efficios.com>
862ca4ed PP	4	*
862ca4ed PP	5	* Permission is hereby granted, free of charge, to any person obtaining a copy
	6	* of this software and associated documentation files (the "Software"), to deal
	7	* in the Software without restriction, including without limitation the rights
	8	* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
	9	* copies of the Software, and to permit persons to whom the Software is
	10	* furnished to do so, subject to the following conditions:
	11	*
	12	* The above copyright notice and this permission notice shall be included in
	13	* all copies or substantial portions of the Software.
	14	*
	15	* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
	16	* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
	17	* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
	18	* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
	19	* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
	20	* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
	21	* SOFTWARE.
	22	*/
	23
	24	#define BT_LOG_TAG "TRACE"
	25	#include <babeltrace/lib-logging-internal.h>
	26
	27	#include <babeltrace/assert-pre-internal.h>
	28	#include <babeltrace/trace-ir/trace-class.h>
	29	#include <babeltrace/trace-ir/trace-class-const.h>
	30	#include <babeltrace/trace-ir/trace-internal.h>
	31	#include <babeltrace/trace-ir/clock-class-internal.h>
	32	#include <babeltrace/trace-ir/stream-internal.h>
	33	#include <babeltrace/trace-ir/stream-class-internal.h>
	34	#include <babeltrace/trace-ir/event-internal.h>
	35	#include <babeltrace/trace-ir/event-class.h>
	36	#include <babeltrace/trace-ir/event-class-internal.h>
	37	#include <babeltrace/ctf-writer/functor-internal.h>
	38	#include <babeltrace/ctf-writer/clock-internal.h>
	39	#include <babeltrace/trace-ir/field-wrapper-internal.h>
c6bd8523	40	#include <babeltrace/trace-ir/field-class-internal.h>
862ca4ed PP	41	#include <babeltrace/trace-ir/attributes-internal.h>
	42	#include <babeltrace/trace-ir/utils-internal.h>
	43	#include <babeltrace/trace-ir/resolve-field-path-internal.h>
	44	#include <babeltrace/compiler-internal.h>
c6bd8523 PP	45	#include <babeltrace/value.h>
	46	#include <babeltrace/value-const.h>
	47	#include <babeltrace/value-internal.h>
862ca4ed PP	48	#include <babeltrace/types.h>
	49	#include <babeltrace/endian-internal.h>
	50	#include <babeltrace/assert-internal.h>
	51	#include <babeltrace/compat/glib-internal.h>
	52	#include <inttypes.h>
	53	#include <stdint.h>
	54	#include <string.h>
	55	#include <stdlib.h>
	56
	57	#define BT_ASSERT_PRE_TRACE_CLASS_HOT(_tc) \
	58	BT_ASSERT_PRE_HOT((_tc), "Trace class", ": %!+T", (_tc))
	59
	60	static
	61	void destroy_trace_class(struct bt_object *obj)
	62	{
	63	struct bt_trace_class tc = (void ) obj;
	64
	65	BT_LIB_LOGD("Destroying trace class object: %!+T", tc);
	66	bt_object_pool_finalize(&tc->packet_header_field_pool);
	67
	68	if (tc->environment) {
	69	BT_LOGD_STR("Destroying environment attributes.");
	70	bt_attributes_destroy(tc->environment);
	71	tc->environment = NULL;
	72	}
	73
	74	if (tc->name.str) {
	75	g_string_free(tc->name.str, TRUE);
	76	tc->name.str = NULL;
	77	tc->name.value = NULL;
	78	}
	79
	80	if (tc->stream_classes) {
	81	BT_LOGD_STR("Destroying stream classes.");
	82	g_ptr_array_free(tc->stream_classes, TRUE);
	83	tc->stream_classes = NULL;
	84	}
	85
e6276565	86	BT_LOGD_STR("Putting packet header field class.");
862ca4ed PP	87	bt_object_put_ref(tc->packet_header_fc);
	88	tc->packet_header_fc = NULL;
	89	g_free(tc);
	90	}
	91
	92	static
	93	void free_packet_header_field(struct bt_field_wrapper *field_wrapper,
	94	struct bt_trace_class *tc)
	95	{
	96	bt_field_wrapper_destroy(field_wrapper);
	97	}
	98
	99	struct bt_trace_class *bt_trace_class_create(void)
	100	{
	101	struct bt_trace_class *tc = NULL;
	102	int ret;
	103
	104	BT_LOGD_STR("Creating default trace class object.");
	105	tc = g_new0(struct bt_trace_class, 1);
	106	if (!tc) {
	107	BT_LOGE_STR("Failed to allocate one trace class.");
	108	goto error;
	109	}
	110
	111	bt_object_init_shared_with_parent(&tc->base, destroy_trace_class);
	112
	113	tc->stream_classes = g_ptr_array_new_with_free_func(
	114	(GDestroyNotify) bt_object_try_spec_release);
	115	if (!tc->stream_classes) {
	116	BT_LOGE_STR("Failed to allocate one GPtrArray.");
	117	goto error;
	118	}
	119
	120	tc->name.str = g_string_new(NULL);
	121	if (!tc->name.str) {
	122	BT_LOGE_STR("Failed to allocate one GString.");
	123	goto error;
	124	}
	125
	126	tc->environment = bt_attributes_create();
	127	if (!tc->environment) {
	128	BT_LOGE_STR("Cannot create empty attributes object.");
	129	goto error;
	130	}
	131
	132	tc->assigns_automatic_stream_class_id = true;
	133	ret = bt_object_pool_initialize(&tc->packet_header_field_pool,
	134	(bt_object_pool_new_object_func) bt_field_wrapper_new,
	135	(bt_object_pool_destroy_object_func) free_packet_header_field,
	136	tc);
	137	if (ret) {
	138	BT_LOGE("Failed to initialize packet header field pool: ret=%d",
	139	ret);
	140	goto error;
	141	}
	142
	143	BT_LIB_LOGD("Created trace class object: %!+T", tc);
	144	goto end;
	145
	146	error:
	147	BT_OBJECT_PUT_REF_AND_RESET(tc);
	148
	149	end:
	150	return tc;
151	}
152
153	const char bt_trace_class_get_name(const struct bt_trace_class tc)
154	{
155	BT_ASSERT_PRE_NON_NULL(tc, "Trace class");
156	return tc->name.value;
157	}
158
a1ed915c PP	159	enum bt_trace_class_status bt_trace_class_set_name(
a1ed915c PP	160	struct bt_trace_class tc, const char name)
862ca4ed PP	161	{
	162	BT_ASSERT_PRE_NON_NULL(tc, "Trace class");
	163	BT_ASSERT_PRE_NON_NULL(name, "Name");
	164	BT_ASSERT_PRE_TRACE_CLASS_HOT(tc);
	165	g_string_assign(tc->name.str, name);
	166	tc->name.value = tc->name.str->str;
	167	BT_LIB_LOGV("Set trace class's name: %!+T", tc);
a1ed915c	168	return BT_TRACE_CLASS_STATUS_OK;
862ca4ed PP	169	}
	170
	171	bt_uuid bt_trace_class_get_uuid(const struct bt_trace_class *tc)
	172	{
	173	BT_ASSERT_PRE_NON_NULL(tc, "Trace class");
	174	return tc->uuid.value;
	175	}
	176
	177	void bt_trace_class_set_uuid(struct bt_trace_class *tc, bt_uuid uuid)
	178	{
	179	BT_ASSERT_PRE_NON_NULL(tc, "Trace class");
	180	BT_ASSERT_PRE_NON_NULL(uuid, "UUID");
	181	BT_ASSERT_PRE_TRACE_CLASS_HOT(tc);
	182	memcpy(tc->uuid.uuid, uuid, BABELTRACE_UUID_LEN);
	183	tc->uuid.value = tc->uuid.uuid;
	184	BT_LIB_LOGV("Set trace class's UUID: %!+T", tc);
	185	}
	186
	187	BT_ASSERT_FUNC
	188	static
	189	bool trace_has_environment_entry(const struct bt_trace_class tc, const char name)
	190	{
	191	BT_ASSERT(tc);
	192
	193	return bt_attributes_borrow_field_value_by_name(
	194	tc->environment, name) != NULL;
	195	}
	196
	197	static
a1ed915c PP	198	enum bt_trace_class_status set_environment_entry(struct bt_trace_class *tc,
a1ed915c PP	199	const char name, struct bt_value value)
862ca4ed PP	200	{
	201	int ret;
	202
	203	BT_ASSERT(tc);
	204	BT_ASSERT(name);
	205	BT_ASSERT(value);
	206	BT_ASSERT_PRE(!tc->frozen \|\|
	207	!trace_has_environment_entry(tc, name),
	208	"Trace class is frozen: cannot replace environment entry: "
	209	"%![tc-]+T, entry-name=\"%s\"", tc, name);
	210	ret = bt_attributes_set_field_value(tc->environment, name,
	211	value);
862ca4ed	212	if (ret) {
a1ed915c	213	ret = BT_TRACE_CLASS_STATUS_NOMEM;
862ca4ed PP	214	BT_LIB_LOGE("Cannot set trace class's environment entry: "
	215	"%![tc-]+T, entry-name=\"%s\"", tc, name);
	216	} else {
a1ed915c	217	bt_value_freeze(value);
862ca4ed PP	218	BT_LIB_LOGV("Set trace class's environment entry: "
	219	"%![tc-]+T, entry-name=\"%s\"", tc, name);
	220	}
	221
	222	return ret;
	223	}
	224
a1ed915c	225	enum bt_trace_class_status bt_trace_class_set_environment_entry_string(
862ca4ed PP	226	struct bt_trace_class tc, const char name, const char *value)
	227	{
	228	int ret;
	229	struct bt_value *value_obj;
	230	BT_ASSERT_PRE_NON_NULL(tc, "Trace class");
	231	BT_ASSERT_PRE_NON_NULL(name, "Name");
	232	BT_ASSERT_PRE_NON_NULL(value, "Value");
	233	value_obj = bt_value_string_create_init(value);
	234	if (!value_obj) {
	235	BT_LOGE_STR("Cannot create a string value object.");
	236	ret = -1;
	237	goto end;
	238	}
	239
	240	/* set_environment_entry() logs errors */
	241	ret = set_environment_entry(tc, name, value_obj);
	242
	243	end:
	244	bt_object_put_ref(value_obj);
	245	return ret;
	246	}
	247
a1ed915c PP	248	enum bt_trace_class_status bt_trace_class_set_environment_entry_integer(
a1ed915c PP	249	struct bt_trace_class tc, const char name, int64_t value)
862ca4ed PP	250	{
	251	int ret;
	252	struct bt_value *value_obj;
	253	BT_ASSERT_PRE_NON_NULL(tc, "Trace class");
	254	BT_ASSERT_PRE_NON_NULL(name, "Name");
	255	value_obj = bt_value_integer_create_init(value);
	256	if (!value_obj) {
	257	BT_LOGE_STR("Cannot create an integer value object.");
a1ed915c	258	ret = BT_TRACE_CLASS_STATUS_NOMEM;
862ca4ed PP	259	goto end;
	260	}
	261
	262	/* set_environment_entry() logs errors */
	263	ret = set_environment_entry(tc, name, value_obj);
	264
	265	end:
	266	bt_object_put_ref(value_obj);
	267	return ret;
	268	}
	269
	270	uint64_t bt_trace_class_get_environment_entry_count(const struct bt_trace_class *tc)
	271	{
	272	int64_t ret;
	273
	274	BT_ASSERT_PRE_NON_NULL(tc, "Trace class");
	275	ret = bt_attributes_get_count(tc->environment);
	276	BT_ASSERT(ret >= 0);
	277	return (uint64_t) ret;
	278	}
	279
	280	void bt_trace_class_borrow_environment_entry_by_index_const(
	281	const struct bt_trace_class *tc, uint64_t index,
	282	const char name, const struct bt_value value)
	283	{
	284	BT_ASSERT_PRE_NON_NULL(tc, "Trace class");
	285	BT_ASSERT_PRE_NON_NULL(name, "Name");
	286	BT_ASSERT_PRE_NON_NULL(value, "Value");
	287	BT_ASSERT_PRE_VALID_INDEX(index,
	288	bt_attributes_get_count(tc->environment));
	289	*value = bt_attributes_borrow_field_value(tc->environment, index);
	290	BT_ASSERT(*value);
	291	*name = bt_attributes_get_field_name(tc->environment, index);
	292	BT_ASSERT(*name);
	293	}
	294
	295	const struct bt_value *bt_trace_class_borrow_environment_entry_value_by_name_const(
	296	const struct bt_trace_class tc, const char name)
	297	{
	298	BT_ASSERT_PRE_NON_NULL(tc, "Trace class");
	299	BT_ASSERT_PRE_NON_NULL(name, "Name");
	300	return bt_attributes_borrow_field_value_by_name(tc->environment,
	301	name);
	302	}
	303
	304	uint64_t bt_trace_class_get_stream_class_count(const struct bt_trace_class *tc)
	305	{
	306	BT_ASSERT_PRE_NON_NULL(tc, "Trace class");
	307	return (uint64_t) tc->stream_classes->len;
	308	}
	309
	310	struct bt_stream_class *bt_trace_class_borrow_stream_class_by_index(
	311	struct bt_trace_class *tc, uint64_t index)
	312	{
	313	BT_ASSERT_PRE_NON_NULL(tc, "Trace class");
	314	BT_ASSERT_PRE_VALID_INDEX(index, tc->stream_classes->len);
	315	return g_ptr_array_index(tc->stream_classes, index);
	316	}
	317
	318	const struct bt_stream_class *
	319	bt_trace_class_borrow_stream_class_by_index_const(
	320	const struct bt_trace_class *tc, uint64_t index)
	321	{
	322	return bt_trace_class_borrow_stream_class_by_index(
323	(void *) tc, index);
324	}
325
326	struct bt_stream_class *bt_trace_class_borrow_stream_class_by_id(
327	struct bt_trace_class *tc, uint64_t id)
328	{
329	struct bt_stream_class *stream_class = NULL;
330	uint64_t i;
331
332	BT_ASSERT_PRE_NON_NULL(tc, "Trace class");
333
334	for (i = 0; i < tc->stream_classes->len; i++) {
335	struct bt_stream_class *stream_class_candidate =
336	g_ptr_array_index(tc->stream_classes, i);
337
338	if (stream_class_candidate->id == id) {
339	stream_class = stream_class_candidate;
340	goto end;
341	}
342	}
343
344	end:
345	return stream_class;
346	}
347
348	const struct bt_stream_class *
349	bt_trace_class_borrow_stream_class_by_id_const(
350	const struct bt_trace_class *tc, uint64_t id)
351	{
352	return bt_trace_class_borrow_stream_class_by_id((void *) tc, id);
353	}
354
355	const struct bt_field_class *bt_trace_class_borrow_packet_header_field_class_const(
356	const struct bt_trace_class *tc)
357	{
358	BT_ASSERT_PRE_NON_NULL(tc, "Trace class");
359	return tc->packet_header_fc;
360	}
361
a1ed915c	362	enum bt_trace_class_status bt_trace_class_set_packet_header_field_class(
862ca4ed PP	363	struct bt_trace_class *tc,
	364	struct bt_field_class *field_class)
	365	{
	366	int ret;
	367	struct bt_resolve_field_path_context resolve_ctx = {
	368	.packet_header = field_class,
	369	.packet_context = NULL,
	370	.event_header = NULL,
	371	.event_common_context = NULL,
	372	.event_specific_context = NULL,
	373	.event_payload = NULL,
	374	};
	375
	376	BT_ASSERT_PRE_NON_NULL(tc, "Trace class");
	377	BT_ASSERT_PRE_NON_NULL(field_class, "Field class");
	378	BT_ASSERT_PRE_TRACE_CLASS_HOT(tc);
	379	BT_ASSERT_PRE(bt_field_class_get_type(field_class) ==
	380	BT_FIELD_CLASS_TYPE_STRUCTURE,
e6276565	381	"Packet header field class is not a structure field class: %!+F",
862ca4ed PP	382	field_class);
	383	ret = bt_resolve_field_paths(field_class, &resolve_ctx);
	384	if (ret) {
a1ed915c PP	385	/*
	386	* This is the only reason for which
	387	* bt_resolve_field_paths() can fail: anything else
	388	* would be because a precondition is not satisfied.
	389	*/
	390	ret = BT_TRACE_CLASS_STATUS_NOMEM;
862ca4ed PP	391	goto end;
	392	}
	393
	394	bt_field_class_make_part_of_trace_class(field_class);
	395	bt_object_put_ref(tc->packet_header_fc);
	396	tc->packet_header_fc = field_class;
	397	bt_object_get_no_null_check(tc->packet_header_fc);
	398	bt_field_class_freeze(field_class);
e6276565	399	BT_LIB_LOGV("Set trace class's packet header field class: %!+T", tc);
862ca4ed PP	400
	401	end:
	402	return ret;
	403	}
	404
	405	BT_HIDDEN
	406	void _bt_trace_class_freeze(const struct bt_trace_class *tc)
	407	{
e6276565	408	/* The packet header field class is already frozen */
862ca4ed PP	409	BT_ASSERT(tc);
	410	BT_LIB_LOGD("Freezing trace class: %!+T", tc);
	411	((struct bt_trace_class *) tc)->frozen = true;
	412	}
	413
	414	bt_bool bt_trace_class_assigns_automatic_stream_class_id(const struct bt_trace_class *tc)
	415	{
	416	BT_ASSERT_PRE_NON_NULL(tc, "Trace class");
	417	return (bt_bool) tc->assigns_automatic_stream_class_id;
	418	}
	419
	420	void bt_trace_class_set_assigns_automatic_stream_class_id(struct bt_trace_class *tc,
	421	bt_bool value)
	422	{
	423	BT_ASSERT_PRE_NON_NULL(tc, "Trace class");
	424	BT_ASSERT_PRE_TRACE_CLASS_HOT(tc);
	425	tc->assigns_automatic_stream_class_id = (bool) value;
	426	BT_LIB_LOGV("Set trace class's automatic stream class ID "
	427	"assignment property: %!+T", tc);
	428	}
c5b9b441 PP	429
	430	void bt_trace_class_get_ref(const struct bt_trace_class *trace_class)
	431	{
	432	bt_object_get_ref(trace_class);
	433	}
	434
	435	void bt_trace_class_put_ref(const struct bt_trace_class *trace_class)
	436	{
	437	bt_object_put_ref(trace_class);
	438	}