[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>

struct bt_trace_class_destruction_listener_elem {
	bt_trace_class_destruction_listener_func func;
	void *data;
};

#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);
	/*
	 * Call destruction listener functions so that everything else
	 * still exists in the trace class.
	 */
	if (tc->destruction_listeners) {
		uint64_t i;
		BT_LIB_LOGV("Calling trace class destruction listener(s): %!+T", tc);
		/* Call all the trace class destruction listeners */
		for (i = 0; i < tc->destruction_listeners->len; i++) {
			struct bt_trace_class_destruction_listener_elem elem =
				g_array_index(tc->destruction_listeners,
						struct bt_trace_class_destruction_listener_elem, i);

			if (elem.func) {
				elem.func(tc, elem.data);
			}
		}
		g_array_free(tc->destruction_listeners, TRUE);
		tc->destruction_listeners = NULL;
	}

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

	g_free(tc);
}

struct bt_trace_class *bt_trace_class_create(bt_self_component *self_comp)
{
	struct bt_trace_class *tc = NULL;

	BT_ASSERT_PRE_NON_NULL(self_comp, "Self component");
	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->destruction_listeners = g_array_new(FALSE, TRUE,
		sizeof(struct bt_trace_class_destruction_listener_elem));
	if (!tc->destruction_listeners) {
		BT_LOGE_STR("Failed to allocate one GArray.");
		goto error;
	}

	tc->assigns_automatic_stream_class_id = true;
	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);
}

enum bt_trace_class_status bt_trace_class_add_destruction_listener(
		const struct bt_trace_class *_tc,
		bt_trace_class_destruction_listener_func listener,
		void *data, uint64_t *listener_id)
{
	struct bt_trace_class *tc = (void *) _tc;
	uint64_t i;
	struct bt_trace_class_destruction_listener_elem new_elem = {
		.func = listener,
		.data = data,
	};

	BT_ASSERT_PRE_NON_NULL(tc, "Trace class");
	BT_ASSERT_PRE_NON_NULL(listener, "Listener");

	/* Find the next available spot */
	for (i = 0; i < tc->destruction_listeners->len; i++) {
		struct bt_trace_class_destruction_listener_elem elem =
			g_array_index(tc->destruction_listeners,
				struct bt_trace_class_destruction_listener_elem, i);

		if (!elem.func) {
			break;
		}
	}

	if (i == tc->destruction_listeners->len) {
		g_array_append_val(tc->destruction_listeners, new_elem);
	} else {
		g_array_insert_val(tc->destruction_listeners, i, new_elem);
	}

	if (listener_id) {
		*listener_id = i;
	}

	BT_LIB_LOGV("Added trace class destruction listener: %![tc-]+T, "
			"listener-id=%" PRIu64, tc, i);
	return BT_TRACE_CLASS_STATUS_OK;
}

BT_ASSERT_PRE_FUNC
static
bool has_listener_id(const struct bt_trace_class *tc, uint64_t listener_id)
{
	BT_ASSERT(listener_id < tc->destruction_listeners->len);
	return (&g_array_index(tc->destruction_listeners,
			struct bt_trace_class_destruction_listener_elem,
			listener_id))->func != NULL;
}

enum bt_trace_class_status bt_trace_class_remove_destruction_listener(
		const struct bt_trace_class *_tc, uint64_t listener_id)
{
	struct bt_trace_class *tc = (void *) _tc;
	struct bt_trace_class_destruction_listener_elem *elem;

	BT_ASSERT_PRE_NON_NULL(tc, "Trace class");
	BT_ASSERT_PRE(has_listener_id(tc, listener_id),
		"Trace class has no such trace class destruction listener ID: "
		"%![tc-]+T, %" PRIu64, tc, listener_id);
	elem = &g_array_index(tc->destruction_listeners,
			struct bt_trace_class_destruction_listener_elem,
			listener_id);
	BT_ASSERT(elem->func);

	elem->func = NULL;
	elem->data = NULL;
	BT_LIB_LOGV("Removed trace class destruction listener: "
		"%![tc-]+T, listener-id=%" PRIu64,
		tc, listener_id);
	return BT_TRACE_CLASS_STATUS_OK;
}

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);
}

BT_HIDDEN
void _bt_trace_class_freeze(const struct bt_trace_class *tc)
{
	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
ad5268b5 FD	57	struct bt_trace_class_destruction_listener_elem {
	58	bt_trace_class_destruction_listener_func func;
	59	void *data;
	60	};
	61
862ca4ed PP	62	#define BT_ASSERT_PRE_TRACE_CLASS_HOT(_tc) \
	63	BT_ASSERT_PRE_HOT((_tc), "Trace class", ": %!+T", (_tc))
	64
	65	static
	66	void destroy_trace_class(struct bt_object *obj)
	67	{
	68	struct bt_trace_class tc = (void ) obj;
	69
	70	BT_LIB_LOGD("Destroying trace class object: %!+T", tc);
ad5268b5 FD	71	/*
	72	* Call destruction listener functions so that everything else
	73	* still exists in the trace class.
	74	*/
	75	if (tc->destruction_listeners) {
	76	uint64_t i;
	77	BT_LIB_LOGV("Calling trace class destruction listener(s): %!+T", tc);
	78	/* Call all the trace class destruction listeners */
	79	for (i = 0; i < tc->destruction_listeners->len; i++) {
	80	struct bt_trace_class_destruction_listener_elem elem =
	81	g_array_index(tc->destruction_listeners,
	82	struct bt_trace_class_destruction_listener_elem, i);
	83
	84	if (elem.func) {
	85	elem.func(tc, elem.data);
	86	}
	87	}
	88	g_array_free(tc->destruction_listeners, TRUE);
	89	tc->destruction_listeners = NULL;
	90	}
862ca4ed PP	91
	92	if (tc->environment) {
	93	BT_LOGD_STR("Destroying environment attributes.");
	94	bt_attributes_destroy(tc->environment);
	95	tc->environment = NULL;
	96	}
	97
	98	if (tc->name.str) {
	99	g_string_free(tc->name.str, TRUE);
	100	tc->name.str = NULL;
	101	tc->name.value = NULL;
	102	}
	103
	104	if (tc->stream_classes) {
	105	BT_LOGD_STR("Destroying stream classes.");
	106	g_ptr_array_free(tc->stream_classes, TRUE);
	107	tc->stream_classes = NULL;
	108	}
	109
862ca4ed PP	110	g_free(tc);
	111	}
	112
41693723	113	struct bt_trace_class bt_trace_class_create(bt_self_component self_comp)
862ca4ed PP	114	{
862ca4ed PP	115	struct bt_trace_class *tc = NULL;
862ca4ed	116
41693723	117	BT_ASSERT_PRE_NON_NULL(self_comp, "Self component");
862ca4ed PP	118	BT_LOGD_STR("Creating default trace class object.");
	119	tc = g_new0(struct bt_trace_class, 1);
	120	if (!tc) {
	121	BT_LOGE_STR("Failed to allocate one trace class.");
	122	goto error;
	123	}
	124
	125	bt_object_init_shared_with_parent(&tc->base, destroy_trace_class);
	126
	127	tc->stream_classes = g_ptr_array_new_with_free_func(
	128	(GDestroyNotify) bt_object_try_spec_release);
	129	if (!tc->stream_classes) {
	130	BT_LOGE_STR("Failed to allocate one GPtrArray.");
	131	goto error;
	132	}
	133
	134	tc->name.str = g_string_new(NULL);
	135	if (!tc->name.str) {
	136	BT_LOGE_STR("Failed to allocate one GString.");
	137	goto error;
	138	}
	139
	140	tc->environment = bt_attributes_create();
	141	if (!tc->environment) {
	142	BT_LOGE_STR("Cannot create empty attributes object.");
	143	goto error;
	144	}
	145
ad5268b5 FD	146	tc->destruction_listeners = g_array_new(FALSE, TRUE,
	147	sizeof(struct bt_trace_class_destruction_listener_elem));
	148	if (!tc->destruction_listeners) {
	149	BT_LOGE_STR("Failed to allocate one GArray.");
	150	goto error;
	151	}
	152
862ca4ed	153	tc->assigns_automatic_stream_class_id = true;
862ca4ed PP	154	BT_LIB_LOGD("Created trace class object: %!+T", tc);
	155	goto end;
	156
	157	error:
	158	BT_OBJECT_PUT_REF_AND_RESET(tc);
	159
	160	end:
	161	return tc;
	162	}
	163
	164	const char bt_trace_class_get_name(const struct bt_trace_class tc)
	165	{
	166	BT_ASSERT_PRE_NON_NULL(tc, "Trace class");
	167	return tc->name.value;
	168	}
	169
a1ed915c PP	170	enum bt_trace_class_status bt_trace_class_set_name(
a1ed915c PP	171	struct bt_trace_class tc, const char name)
862ca4ed PP	172	{
	173	BT_ASSERT_PRE_NON_NULL(tc, "Trace class");
	174	BT_ASSERT_PRE_NON_NULL(name, "Name");
	175	BT_ASSERT_PRE_TRACE_CLASS_HOT(tc);
	176	g_string_assign(tc->name.str, name);
	177	tc->name.value = tc->name.str->str;
	178	BT_LIB_LOGV("Set trace class's name: %!+T", tc);
a1ed915c	179	return BT_TRACE_CLASS_STATUS_OK;
862ca4ed PP	180	}
	181
	182	bt_uuid bt_trace_class_get_uuid(const struct bt_trace_class *tc)
	183	{
	184	BT_ASSERT_PRE_NON_NULL(tc, "Trace class");
	185	return tc->uuid.value;
	186	}
	187
	188	void bt_trace_class_set_uuid(struct bt_trace_class *tc, bt_uuid uuid)
	189	{
	190	BT_ASSERT_PRE_NON_NULL(tc, "Trace class");
	191	BT_ASSERT_PRE_NON_NULL(uuid, "UUID");
	192	BT_ASSERT_PRE_TRACE_CLASS_HOT(tc);
	193	memcpy(tc->uuid.uuid, uuid, BABELTRACE_UUID_LEN);
	194	tc->uuid.value = tc->uuid.uuid;
	195	BT_LIB_LOGV("Set trace class's UUID: %!+T", tc);
	196	}
	197
ad5268b5 FD	198	enum bt_trace_class_status bt_trace_class_add_destruction_listener(
	199	const struct bt_trace_class *_tc,
	200	bt_trace_class_destruction_listener_func listener,
	201	void data, uint64_t listener_id)
	202	{
	203	struct bt_trace_class tc = (void ) _tc;
	204	uint64_t i;
	205	struct bt_trace_class_destruction_listener_elem new_elem = {
	206	.func = listener,
	207	.data = data,
	208	};
	209
	210	BT_ASSERT_PRE_NON_NULL(tc, "Trace class");
	211	BT_ASSERT_PRE_NON_NULL(listener, "Listener");
	212
	213	/* Find the next available spot */
	214	for (i = 0; i < tc->destruction_listeners->len; i++) {
	215	struct bt_trace_class_destruction_listener_elem elem =
	216	g_array_index(tc->destruction_listeners,
	217	struct bt_trace_class_destruction_listener_elem, i);
	218
	219	if (!elem.func) {
	220	break;
	221	}
	222	}
	223
	224	if (i == tc->destruction_listeners->len) {
	225	g_array_append_val(tc->destruction_listeners, new_elem);
	226	} else {
	227	g_array_insert_val(tc->destruction_listeners, i, new_elem);
	228	}
	229
	230	if (listener_id) {
	231	*listener_id = i;
	232	}
	233
	234	BT_LIB_LOGV("Added trace class destruction listener: %![tc-]+T, "
	235	"listener-id=%" PRIu64, tc, i);
	236	return BT_TRACE_CLASS_STATUS_OK;
	237	}
	238
	239	BT_ASSERT_PRE_FUNC
	240	static
	241	bool has_listener_id(const struct bt_trace_class *tc, uint64_t listener_id)
	242	{
	243	BT_ASSERT(listener_id < tc->destruction_listeners->len);
	244	return (&g_array_index(tc->destruction_listeners,
	245	struct bt_trace_class_destruction_listener_elem,
	246	listener_id))->func != NULL;
	247	}
	248
	249	enum bt_trace_class_status bt_trace_class_remove_destruction_listener(
	250	const struct bt_trace_class *_tc, uint64_t listener_id)
	251	{
	252	struct bt_trace_class tc = (void ) _tc;
	253	struct bt_trace_class_destruction_listener_elem *elem;
	254
	255	BT_ASSERT_PRE_NON_NULL(tc, "Trace class");
	256	BT_ASSERT_PRE(has_listener_id(tc, listener_id),
	257	"Trace class has no such trace class destruction listener ID: "
	258	"%![tc-]+T, %" PRIu64, tc, listener_id);
	259	elem = &g_array_index(tc->destruction_listeners,
	260	struct bt_trace_class_destruction_listener_elem,
	261	listener_id);
262	BT_ASSERT(elem->func);
263
264	elem->func = NULL;
265	elem->data = NULL;
266	BT_LIB_LOGV("Removed trace class destruction listener: "
267	"%![tc-]+T, listener-id=%" PRIu64,
268	tc, listener_id);
269	return BT_TRACE_CLASS_STATUS_OK;
270	}
271
862ca4ed PP	272	BT_ASSERT_FUNC
	273	static
	274	bool trace_has_environment_entry(const struct bt_trace_class tc, const char name)
	275	{
	276	BT_ASSERT(tc);
	277
	278	return bt_attributes_borrow_field_value_by_name(
	279	tc->environment, name) != NULL;
	280	}
	281
	282	static
a1ed915c PP	283	enum bt_trace_class_status set_environment_entry(struct bt_trace_class *tc,
a1ed915c PP	284	const char name, struct bt_value value)
862ca4ed PP	285	{
	286	int ret;
	287
	288	BT_ASSERT(tc);
	289	BT_ASSERT(name);
	290	BT_ASSERT(value);
	291	BT_ASSERT_PRE(!tc->frozen \|\|
	292	!trace_has_environment_entry(tc, name),
	293	"Trace class is frozen: cannot replace environment entry: "
	294	"%![tc-]+T, entry-name=\"%s\"", tc, name);
	295	ret = bt_attributes_set_field_value(tc->environment, name,
	296	value);
862ca4ed	297	if (ret) {
a1ed915c	298	ret = BT_TRACE_CLASS_STATUS_NOMEM;
862ca4ed PP	299	BT_LIB_LOGE("Cannot set trace class's environment entry: "
	300	"%![tc-]+T, entry-name=\"%s\"", tc, name);
	301	} else {
a1ed915c	302	bt_value_freeze(value);
862ca4ed PP	303	BT_LIB_LOGV("Set trace class's environment entry: "
	304	"%![tc-]+T, entry-name=\"%s\"", tc, name);
	305	}
	306
	307	return ret;
	308	}
	309
a1ed915c	310	enum bt_trace_class_status bt_trace_class_set_environment_entry_string(
862ca4ed PP	311	struct bt_trace_class tc, const char name, const char *value)
	312	{
	313	int ret;
	314	struct bt_value *value_obj;
	315	BT_ASSERT_PRE_NON_NULL(tc, "Trace class");
	316	BT_ASSERT_PRE_NON_NULL(name, "Name");
	317	BT_ASSERT_PRE_NON_NULL(value, "Value");
	318	value_obj = bt_value_string_create_init(value);
	319	if (!value_obj) {
	320	BT_LOGE_STR("Cannot create a string value object.");
	321	ret = -1;
	322	goto end;
	323	}
	324
	325	/* set_environment_entry() logs errors */
	326	ret = set_environment_entry(tc, name, value_obj);
	327
	328	end:
	329	bt_object_put_ref(value_obj);
	330	return ret;
	331	}
	332
a1ed915c PP	333	enum bt_trace_class_status bt_trace_class_set_environment_entry_integer(
a1ed915c PP	334	struct bt_trace_class tc, const char name, int64_t value)
862ca4ed PP	335	{
	336	int ret;
	337	struct bt_value *value_obj;
	338	BT_ASSERT_PRE_NON_NULL(tc, "Trace class");
	339	BT_ASSERT_PRE_NON_NULL(name, "Name");
	340	value_obj = bt_value_integer_create_init(value);
	341	if (!value_obj) {
	342	BT_LOGE_STR("Cannot create an integer value object.");
a1ed915c	343	ret = BT_TRACE_CLASS_STATUS_NOMEM;
862ca4ed PP	344	goto end;
	345	}
	346
	347	/* set_environment_entry() logs errors */
	348	ret = set_environment_entry(tc, name, value_obj);
	349
	350	end:
	351	bt_object_put_ref(value_obj);
	352	return ret;
	353	}
	354
	355	uint64_t bt_trace_class_get_environment_entry_count(const struct bt_trace_class *tc)
	356	{
	357	int64_t ret;
	358
	359	BT_ASSERT_PRE_NON_NULL(tc, "Trace class");
	360	ret = bt_attributes_get_count(tc->environment);
	361	BT_ASSERT(ret >= 0);
	362	return (uint64_t) ret;
	363	}
	364
	365	void bt_trace_class_borrow_environment_entry_by_index_const(
	366	const struct bt_trace_class *tc, uint64_t index,
	367	const char name, const struct bt_value value)
	368	{
	369	BT_ASSERT_PRE_NON_NULL(tc, "Trace class");
	370	BT_ASSERT_PRE_NON_NULL(name, "Name");
	371	BT_ASSERT_PRE_NON_NULL(value, "Value");
	372	BT_ASSERT_PRE_VALID_INDEX(index,
	373	bt_attributes_get_count(tc->environment));
	374	*value = bt_attributes_borrow_field_value(tc->environment, index);
	375	BT_ASSERT(*value);
	376	*name = bt_attributes_get_field_name(tc->environment, index);
	377	BT_ASSERT(*name);
	378	}
	379
	380	const struct bt_value *bt_trace_class_borrow_environment_entry_value_by_name_const(
	381	const struct bt_trace_class tc, const char name)
	382	{
	383	BT_ASSERT_PRE_NON_NULL(tc, "Trace class");
	384	BT_ASSERT_PRE_NON_NULL(name, "Name");
	385	return bt_attributes_borrow_field_value_by_name(tc->environment,
	386	name);
	387	}
	388
	389	uint64_t bt_trace_class_get_stream_class_count(const struct bt_trace_class *tc)
	390	{
	391	BT_ASSERT_PRE_NON_NULL(tc, "Trace class");
	392	return (uint64_t) tc->stream_classes->len;
	393	}
	394
	395	struct bt_stream_class *bt_trace_class_borrow_stream_class_by_index(
	396	struct bt_trace_class *tc, uint64_t index)
	397	{
	398	BT_ASSERT_PRE_NON_NULL(tc, "Trace class");
	399	BT_ASSERT_PRE_VALID_INDEX(index, tc->stream_classes->len);
	400	return g_ptr_array_index(tc->stream_classes, index);
	401	}
	402
	403	const struct bt_stream_class *
	404	bt_trace_class_borrow_stream_class_by_index_const(
	405	const struct bt_trace_class *tc, uint64_t index)
	406	{
	407	return bt_trace_class_borrow_stream_class_by_index(
408	(void *) tc, index);
409	}
410
411	struct bt_stream_class *bt_trace_class_borrow_stream_class_by_id(
412	struct bt_trace_class *tc, uint64_t id)
413	{
414	struct bt_stream_class *stream_class = NULL;
415	uint64_t i;
416
417	BT_ASSERT_PRE_NON_NULL(tc, "Trace class");
418
419	for (i = 0; i < tc->stream_classes->len; i++) {
420	struct bt_stream_class *stream_class_candidate =
421	g_ptr_array_index(tc->stream_classes, i);
422
423	if (stream_class_candidate->id == id) {
424	stream_class = stream_class_candidate;
425	goto end;
426	}
427	}
428
429	end:
430	return stream_class;
431	}
432
433	const struct bt_stream_class *
434	bt_trace_class_borrow_stream_class_by_id_const(
435	const struct bt_trace_class *tc, uint64_t id)
436	{
437	return bt_trace_class_borrow_stream_class_by_id((void *) tc, id);
438	}
439
862ca4ed PP	440	BT_HIDDEN
	441	void _bt_trace_class_freeze(const struct bt_trace_class *tc)
	442	{
862ca4ed PP	443	BT_ASSERT(tc);
	444	BT_LIB_LOGD("Freezing trace class: %!+T", tc);
	445	((struct bt_trace_class *) tc)->frozen = true;
	446	}
	447
	448	bt_bool bt_trace_class_assigns_automatic_stream_class_id(const struct bt_trace_class *tc)
	449	{
	450	BT_ASSERT_PRE_NON_NULL(tc, "Trace class");
	451	return (bt_bool) tc->assigns_automatic_stream_class_id;
	452	}
	453
	454	void bt_trace_class_set_assigns_automatic_stream_class_id(struct bt_trace_class *tc,
	455	bt_bool value)
	456	{
	457	BT_ASSERT_PRE_NON_NULL(tc, "Trace class");
	458	BT_ASSERT_PRE_TRACE_CLASS_HOT(tc);
	459	tc->assigns_automatic_stream_class_id = (bool) value;
	460	BT_LIB_LOGV("Set trace class's automatic stream class ID "
	461	"assignment property: %!+T", tc);
	462	}
c5b9b441 PP	463
	464	void bt_trace_class_get_ref(const struct bt_trace_class *trace_class)
	465	{
	466	bt_object_get_ref(trace_class);
	467	}
	468
	469	void bt_trace_class_put_ref(const struct bt_trace_class *trace_class)
	470	{
	471	bt_object_put_ref(trace_class);
	472	}