[babeltrace.git] / src / lib / trace-ir / trace.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 "LIB/TRACE"
#include "lib/logging.h"

#include "lib/assert-pre.h"
#include "lib/assert-post.h"
#include <babeltrace2/trace-ir/trace.h>
#include <babeltrace2/trace-ir/trace-const.h>
#include <babeltrace2/trace-ir/event-class.h>
#include "ctf-writer/functor.h"
#include "ctf-writer/clock.h"
#include "compat/compiler.h"
#include <babeltrace2/value.h>
#include <babeltrace2/value-const.h>
#include "lib/value.h"
#include <babeltrace2/types.h>
#include "compat/endian.h"
#include "common/assert.h"
#include "compat/glib.h"
#include <inttypes.h>
#include <stdint.h>
#include <string.h>
#include <stdlib.h>

#include "attributes.h"
#include "clock-class.h"
#include "event-class.h"
#include "event.h"
#include "field-class.h"
#include "field-wrapper.h"
#include "resolve-field-path.h"
#include "stream-class.h"
#include "stream.h"
#include "trace-class.h"
#include "trace.h"
#include "utils.h"
#include "lib/value.h"
#include "lib/func-status.h"

struct bt_trace_destruction_listener_elem {
	bt_trace_destruction_listener_func func;
	void *data;
};

#define BT_ASSERT_PRE_DEV_TRACE_HOT(_trace) \
	BT_ASSERT_PRE_DEV_HOT((_trace), "Trace", ": %!+t", (_trace))

static
void destroy_trace(struct bt_object *obj)
{
	struct bt_trace *trace = (void *) obj;

	BT_LIB_LOGD("Destroying trace object: %!+t", trace);
	BT_OBJECT_PUT_REF_AND_RESET(trace->user_attributes);

	/*
	 * Call destruction listener functions so that everything else
	 * still exists in the trace.
	 */
	if (trace->destruction_listeners) {
		uint64_t i;
		BT_LIB_LOGD("Calling trace destruction listener(s): %!+t", trace);

		/*
		* The trace's reference count is 0 if we're here. Increment
		* it to avoid a double-destroy (possibly infinitely recursive).
		* This could happen for example if a destruction listener did
		* bt_object_get_ref() (or anything that causes
		* bt_object_get_ref() to be called) on the trace (ref.
		* count goes from 0 to 1), and then bt_object_put_ref(): the
		* reference count would go from 1 to 0 again and this function
		* would be called again.
		*/
		trace->base.ref_count++;

		/* Call all the trace destruction listeners */
		for (i = 0; i < trace->destruction_listeners->len; i++) {
			struct bt_trace_destruction_listener_elem elem =
				g_array_index(trace->destruction_listeners,
						struct bt_trace_destruction_listener_elem, i);

			if (elem.func) {
				elem.func(trace, elem.data);
			}

			/*
			 * The destruction listener should not have kept a
			 * reference to the trace.
			 */
			BT_ASSERT_POST(trace->base.ref_count == 1, "Destruction listener kept a reference to the trace being destroyed: %![trace-]+t", trace);
		}
		g_array_free(trace->destruction_listeners, TRUE);
		trace->destruction_listeners = NULL;
	}

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

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

	if (trace->streams) {
		BT_LOGD_STR("Destroying streams.");
		g_ptr_array_free(trace->streams, TRUE);
		trace->streams = NULL;
	}

	if (trace->stream_classes_stream_count) {
		g_hash_table_destroy(trace->stream_classes_stream_count);
		trace->stream_classes_stream_count = NULL;
	}

	BT_LOGD_STR("Putting trace's class.");
	bt_object_put_ref(trace->class);
	trace->class = NULL;
	g_free(trace);
}

struct bt_trace *bt_trace_create(struct bt_trace_class *tc)
{
	struct bt_trace *trace = NULL;

	BT_LIB_LOGD("Creating trace object: %![tc-]+T", tc);
	trace = g_new0(struct bt_trace, 1);
	if (!trace) {
		BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate one trace.");
		goto error;
	}

	bt_object_init_shared(&trace->base, destroy_trace);
	trace->user_attributes = bt_value_map_create();
	if (!trace->user_attributes) {
		BT_LIB_LOGE_APPEND_CAUSE(
			"Failed to create a map value object.");
		goto error;
	}

	trace->streams = g_ptr_array_new_with_free_func(
		(GDestroyNotify) bt_object_try_spec_release);
	if (!trace->streams) {
		BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate one GPtrArray.");
		goto error;
	}

	trace->stream_classes_stream_count = g_hash_table_new(g_direct_hash,
		g_direct_equal);
	if (!trace->stream_classes_stream_count) {
		BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate one GHashTable.");
		goto error;
	}

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

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

	trace->destruction_listeners = g_array_new(FALSE, TRUE,
		sizeof(struct bt_trace_destruction_listener_elem));
	if (!trace->destruction_listeners) {
		BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate one GArray.");
		goto error;
	}

	trace->class = tc;
	bt_object_get_ref_no_null_check(trace->class);
	BT_LIB_LOGD("Created trace object: %!+t", trace);
	goto end;

error:
	BT_OBJECT_PUT_REF_AND_RESET(trace);

end:
	return trace;
}

const char *bt_trace_get_name(const struct bt_trace *trace)
{
	BT_ASSERT_PRE_DEV_NON_NULL(trace, "Trace");
	return trace->name.value;
}

enum bt_trace_set_name_status bt_trace_set_name(struct bt_trace *trace,
		const char *name)
{
	BT_ASSERT_PRE_NON_NULL(trace, "Trace");
	BT_ASSERT_PRE_NON_NULL(name, "Name");
	BT_ASSERT_PRE_DEV_TRACE_HOT(trace);
	g_string_assign(trace->name.str, name);
	trace->name.value = trace->name.str->str;
	BT_LIB_LOGD("Set trace's name: %!+t", trace);
	return BT_FUNC_STATUS_OK;
}

bt_uuid bt_trace_get_uuid(const struct bt_trace *trace)
{
	BT_ASSERT_PRE_DEV_NON_NULL(trace, "Trace");
	return trace->uuid.value;
}

void bt_trace_set_uuid(struct bt_trace *trace, bt_uuid uuid)
{
	BT_ASSERT_PRE_NON_NULL(trace, "Trace");
	BT_ASSERT_PRE_NON_NULL(uuid, "UUID");
	BT_ASSERT_PRE_DEV_TRACE_HOT(trace);
	bt_uuid_copy(trace->uuid.uuid, uuid);
	trace->uuid.value = trace->uuid.uuid;
	BT_LIB_LOGD("Set trace's UUID: %!+t", trace);
}

static
bool trace_has_environment_entry(const struct bt_trace *trace, const char *name)
{
	BT_ASSERT(trace);

	return bt_attributes_borrow_field_value_by_name(
		trace->environment, name);
}

static
enum bt_trace_set_environment_entry_status set_environment_entry(
		struct bt_trace *trace,
		const char *name, struct bt_value *value)
{
	int ret;

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

	return ret;
}

enum bt_trace_set_environment_entry_status
bt_trace_set_environment_entry_string(
		struct bt_trace *trace, const char *name, const char *value)
{
	int ret;
	struct bt_value *value_obj;
	BT_ASSERT_PRE_NON_NULL(trace, "Trace");
	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_LIB_LOGE_APPEND_CAUSE(
			"Cannot create a string value object.");
		ret = -1;
		goto end;
	}

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

end:
	bt_object_put_ref(value_obj);
	return ret;
}

enum bt_trace_set_environment_entry_status
bt_trace_set_environment_entry_integer(
		struct bt_trace *trace, const char *name, int64_t value)
{
	int ret;
	struct bt_value *value_obj;
	BT_ASSERT_PRE_NON_NULL(trace, "Trace");
	BT_ASSERT_PRE_NON_NULL(name, "Name");
	value_obj = bt_value_integer_signed_create_init(value);
	if (!value_obj) {
		BT_LIB_LOGE_APPEND_CAUSE(
			"Cannot create an integer value object.");
		ret = BT_FUNC_STATUS_MEMORY_ERROR;
		goto end;
	}

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

end:
	bt_object_put_ref(value_obj);
	return ret;
}

uint64_t bt_trace_get_environment_entry_count(const struct bt_trace *trace)
{
	BT_ASSERT_PRE_DEV_NON_NULL(trace, "Trace");
	return bt_attributes_get_count(trace->environment);
}

void bt_trace_borrow_environment_entry_by_index_const(
		const struct bt_trace *trace, uint64_t index,
		const char **name, const struct bt_value **value)
{
	BT_ASSERT_PRE_DEV_NON_NULL(trace, "Trace");
	BT_ASSERT_PRE_DEV_NON_NULL(name, "Name");
	BT_ASSERT_PRE_DEV_NON_NULL(value, "Value");
	BT_ASSERT_PRE_DEV_VALID_INDEX(index,
		bt_attributes_get_count(trace->environment));
	*value = bt_attributes_borrow_field_value(trace->environment, index);
	BT_ASSERT(*value);
	*name = bt_attributes_get_field_name(trace->environment, index);
	BT_ASSERT(*name);
}

const struct bt_value *bt_trace_borrow_environment_entry_value_by_name_const(
		const struct bt_trace *trace, const char *name)
{
	BT_ASSERT_PRE_DEV_NON_NULL(trace, "Trace");
	BT_ASSERT_PRE_DEV_NON_NULL(name, "Name");
	return bt_attributes_borrow_field_value_by_name(trace->environment,
		name);
}

uint64_t bt_trace_get_stream_count(const struct bt_trace *trace)
{
	BT_ASSERT_PRE_DEV_NON_NULL(trace, "Trace");
	return (uint64_t) trace->streams->len;
}

struct bt_stream *bt_trace_borrow_stream_by_index(
		struct bt_trace *trace, uint64_t index)
{
	BT_ASSERT_PRE_DEV_NON_NULL(trace, "Trace");
	BT_ASSERT_PRE_DEV_VALID_INDEX(index, trace->streams->len);
	return g_ptr_array_index(trace->streams, index);
}

const struct bt_stream *bt_trace_borrow_stream_by_index_const(
		const struct bt_trace *trace, uint64_t index)
{
	return bt_trace_borrow_stream_by_index((void *) trace, index);
}

struct bt_stream *bt_trace_borrow_stream_by_id(struct bt_trace *trace,
		uint64_t id)
{
	struct bt_stream *stream = NULL;
	uint64_t i;

	BT_ASSERT_PRE_DEV_NON_NULL(trace, "Trace");

	for (i = 0; i < trace->streams->len; i++) {
		struct bt_stream *stream_candidate =
			g_ptr_array_index(trace->streams, i);

		if (stream_candidate->id == id) {
			stream = stream_candidate;
			goto end;
		}
	}

end:
	return stream;
}

const struct bt_stream *bt_trace_borrow_stream_by_id_const(
		const struct bt_trace *trace, uint64_t id)
{
	return bt_trace_borrow_stream_by_id((void *) trace, id);
}

enum bt_trace_add_listener_status bt_trace_add_destruction_listener(
		const struct bt_trace *c_trace,
		bt_trace_destruction_listener_func listener,
		void *data, bt_listener_id *listener_id)
{
	struct bt_trace *trace = (void *) c_trace;
	uint64_t i;
	struct bt_trace_destruction_listener_elem new_elem = {
		.func = listener,
		.data = data,
	};

	BT_ASSERT_PRE_NON_NULL(trace, "Trace");
	BT_ASSERT_PRE_NON_NULL(listener, "Listener");

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

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

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

	if (listener_id) {
		*listener_id = i;
	}

	BT_LIB_LOGD("Added destruction listener: " "%![trace-]+t, "
			"listener-id=%" PRIu64, trace, i);
	return BT_FUNC_STATUS_OK;
}

static
bool has_listener_id(const struct bt_trace *trace, uint64_t listener_id)
{
	BT_ASSERT(listener_id < trace->destruction_listeners->len);
	return (&g_array_index(trace->destruction_listeners,
			struct bt_trace_destruction_listener_elem,
			listener_id))->func;
}

enum bt_trace_remove_listener_status bt_trace_remove_destruction_listener(
		const struct bt_trace *c_trace, bt_listener_id listener_id)
{
	struct bt_trace *trace = (void *) c_trace;
	struct bt_trace_destruction_listener_elem *elem;

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

	elem->func = NULL;
	elem->data = NULL;
	BT_LIB_LOGD("Removed \"trace destruction listener: "
		"%![trace-]+t, listener-id=%" PRIu64,
		trace, listener_id);
	return BT_FUNC_STATUS_OK;
}

BT_HIDDEN
void _bt_trace_freeze(const struct bt_trace *trace)
{
	BT_ASSERT(trace);
	BT_LIB_LOGD("Freezing trace's class: %!+T", trace->class);
	bt_trace_class_freeze(trace->class);
	BT_LIB_LOGD("Freezing trace's user attributes: %!+v",
		trace->user_attributes);
	bt_value_freeze(trace->user_attributes);
	BT_LIB_LOGD("Freezing trace: %!+t", trace);
	((struct bt_trace *) trace)->frozen = true;
}

BT_HIDDEN
void bt_trace_add_stream(struct bt_trace *trace, struct bt_stream *stream)
{
	guint count = 0;

	bt_object_set_parent(&stream->base, &trace->base);
	g_ptr_array_add(trace->streams, stream);
	bt_trace_freeze(trace);

	if (bt_g_hash_table_contains(trace->stream_classes_stream_count,
			stream->class)) {
		count = GPOINTER_TO_UINT(g_hash_table_lookup(
			trace->stream_classes_stream_count, stream->class));
	}

	g_hash_table_insert(trace->stream_classes_stream_count,
		stream->class, GUINT_TO_POINTER(count + 1));
}

BT_HIDDEN
uint64_t bt_trace_get_automatic_stream_id(const struct bt_trace *trace,
		const struct bt_stream_class *stream_class)
{
	gpointer orig_key;
	gpointer value;
	uint64_t id = 0;

	BT_ASSERT(stream_class);
	BT_ASSERT(trace);
	if (g_hash_table_lookup_extended(trace->stream_classes_stream_count,
			stream_class, &orig_key, &value)) {
		id = (uint64_t) GPOINTER_TO_UINT(value);
	}

	return id;
}

struct bt_trace_class *bt_trace_borrow_class(struct bt_trace *trace)
{
	BT_ASSERT_PRE_DEV_NON_NULL(trace, "Trace");
	return trace->class;
}

const struct bt_trace_class *bt_trace_borrow_class_const(
		const struct bt_trace *trace)
{
	return bt_trace_borrow_class((void *) trace);
}

const struct bt_value *bt_trace_borrow_user_attributes_const(
		const struct bt_trace *trace)
{
	BT_ASSERT_PRE_DEV_NON_NULL(trace, "Trace");
	return trace->user_attributes;
}

struct bt_value *bt_trace_borrow_user_attributes(struct bt_trace *trace)
{
	return (void *) bt_trace_borrow_user_attributes_const((void *) trace);
}

void bt_trace_set_user_attributes(
		struct bt_trace *trace,
		const struct bt_value *user_attributes)
{
	BT_ASSERT_PRE_NON_NULL(trace, "Trace");
	BT_ASSERT_PRE_NON_NULL(user_attributes, "User attributes");
	BT_ASSERT_PRE(user_attributes->type == BT_VALUE_TYPE_MAP,
		"User attributes object is not a map value object.");
	BT_ASSERT_PRE_DEV_TRACE_HOT(trace);
	bt_object_put_ref_no_null_check(trace->user_attributes);
	trace->user_attributes = (void *) user_attributes;
	bt_object_get_ref_no_null_check(trace->user_attributes);
}

void bt_trace_get_ref(const struct bt_trace *trace)
{
	bt_object_get_ref(trace);
}

void bt_trace_put_ref(const struct bt_trace *trace)
{
	bt_object_put_ref(trace);
}
Commit	Line	Data
bc37ae52	1	/*
f2b0325d	2	* Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
bc37ae52 JG	3	* Copyright 2014 Jérémie Galarneau <jeremie.galarneau@efficios.com>
bc37ae52 JG	4	*
bc37ae52 JG	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
b03487ab	24	#define BT_LOG_TAG "LIB/TRACE"
1633ef46	25	#include "lib/logging.h"
e011d2c1	26
57952005	27	#include "lib/assert-pre.h"
727170fc	28	#include "lib/assert-post.h"
71c5da58	29	#include <babeltrace2/trace-ir/trace.h>
71c5da58	30	#include <babeltrace2/trace-ir/trace-const.h>
71c5da58	31	#include <babeltrace2/trace-ir/event-class.h>
57952005 MJ	32	#include "ctf-writer/functor.h"
	33	#include "ctf-writer/clock.h"
	34	#include "compat/compiler.h"
71c5da58 MJ	35	#include <babeltrace2/value.h>
71c5da58 MJ	36	#include <babeltrace2/value-const.h>
57952005	37	#include "lib/value.h"
71c5da58	38	#include <babeltrace2/types.h>
57952005 MJ	39	#include "compat/endian.h"
	40	#include "common/assert.h"
	41	#include "compat/glib.h"
dc3fffef	42	#include <inttypes.h>
544d0515	43	#include <stdint.h>
4a32fda0	44	#include <string.h>
0fbb9a9f	45	#include <stdlib.h>
bc37ae52	46
57952005 MJ	47	#include "attributes.h"
	48	#include "clock-class.h"
	49	#include "event-class.h"
	50	#include "event.h"
	51	#include "field-class.h"
	52	#include "field-wrapper.h"
	53	#include "resolve-field-path.h"
	54	#include "stream-class.h"
	55	#include "stream.h"
	56	#include "trace-class.h"
	57	#include "trace.h"
	58	#include "utils.h"
af90138b	59	#include "lib/value.h"
fb25b9e3	60	#include "lib/func-status.h"
57952005	61
1122415c FD	62	struct bt_trace_destruction_listener_elem {
1122415c FD	63	bt_trace_destruction_listener_func func;
3602afb0 PP	64	void *data;
	65	};
	66
fa6cfec3 PP	67	#define BT_ASSERT_PRE_DEV_TRACE_HOT(_trace) \
fa6cfec3 PP	68	BT_ASSERT_PRE_DEV_HOT((_trace), "Trace", ": %!+t", (_trace))
18acc6f8	69
bc37ae52	70	static
7b33a0e0	71	void destroy_trace(struct bt_object *obj)
8deee039 PP	72	{
8deee039 PP	73	struct bt_trace trace = (void ) obj;
bc37ae52	74
7b33a0e0	75	BT_LIB_LOGD("Destroying trace object: %!+t", trace);
af90138b	76	BT_OBJECT_PUT_REF_AND_RESET(trace->user_attributes);
bc37ae52	77
8deee039	78	/*
1122415c FD	79	* Call destruction listener functions so that everything else
1122415c FD	80	* still exists in the trace.
8deee039	81	*/
1122415c FD	82	if (trace->destruction_listeners) {
1122415c FD	83	uint64_t i;
a684a357	84	BT_LIB_LOGD("Calling trace destruction listener(s): %!+t", trace);
69868f44 SM	85
	86	/*
	87	* The trace's reference count is 0 if we're here. Increment
	88	* it to avoid a double-destroy (possibly infinitely recursive).
	89	* This could happen for example if a destruction listener did
	90	* bt_object_get_ref() (or anything that causes
	91	* bt_object_get_ref() to be called) on the trace (ref.
	92	* count goes from 0 to 1), and then bt_object_put_ref(): the
	93	* reference count would go from 1 to 0 again and this function
	94	* would be called again.
	95	*/
	96	trace->base.ref_count++;
	97
1122415c FD	98	/* Call all the trace destruction listeners */
	99	for (i = 0; i < trace->destruction_listeners->len; i++) {
	100	struct bt_trace_destruction_listener_elem elem =
	101	g_array_index(trace->destruction_listeners,
	102	struct bt_trace_destruction_listener_elem, i);
	103
	104	if (elem.func) {
	105	elem.func(trace, elem.data);
8deee039	106	}
69868f44 SM	107
	108	/*
	109	* The destruction listener should not have kept a
	110	* reference to the trace.
	111	*/
727170fc	112	BT_ASSERT_POST(trace->base.ref_count == 1, "Destruction listener kept a reference to the trace being destroyed: %![trace-]+t", trace);
8deee039	113	}
1122415c FD	114	g_array_free(trace->destruction_listeners, TRUE);
1122415c FD	115	trace->destruction_listeners = NULL;
bc37ae52 JG	116	}
bc37ae52 JG	117
7b33a0e0 PP	118	if (trace->name.str) {
7b33a0e0 PP	119	g_string_free(trace->name.str, TRUE);
1248f5ea PP	120	trace->name.str = NULL;
1248f5ea PP	121	trace->name.value = NULL;
95c09b3a PP	122	}
95c09b3a PP	123
cd03c43c PP	124	if (trace->environment) {
	125	BT_LOGD_STR("Destroying environment attributes.");
	126	bt_attributes_destroy(trace->environment);
	127	trace->environment = NULL;
	128	}
	129
7b33a0e0 PP	130	if (trace->streams) {
	131	BT_LOGD_STR("Destroying streams.");
	132	g_ptr_array_free(trace->streams, TRUE);
1248f5ea	133	trace->streams = NULL;
bc37ae52 JG	134	}
bc37ae52 JG	135
7b33a0e0 PP	136	if (trace->stream_classes_stream_count) {
7b33a0e0 PP	137	g_hash_table_destroy(trace->stream_classes_stream_count);
1248f5ea	138	trace->stream_classes_stream_count = NULL;
7b33a0e0	139	}
8deee039	140
10b7a2e4 PP	141	BT_LOGD_STR("Putting trace's class.");
	142	bt_object_put_ref(trace->class);
	143	trace->class = NULL;
7b33a0e0	144	g_free(trace);
8deee039 PP	145	}
8deee039 PP	146
10b7a2e4	147	struct bt_trace bt_trace_create(struct bt_trace_class tc)
8deee039 PP	148	{
8deee039 PP	149	struct bt_trace *trace = NULL;
8deee039	150
10b7a2e4	151	BT_LIB_LOGD("Creating trace object: %![tc-]+T", tc);
8deee039 PP	152	trace = g_new0(struct bt_trace, 1);
8deee039 PP	153	if (!trace) {
a8f90e5d	154	BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate one trace.");
8deee039 PP	155	goto error;
	156	}
	157
10b7a2e4	158	bt_object_init_shared(&trace->base, destroy_trace);
af90138b PP	159	trace->user_attributes = bt_value_map_create();
	160	if (!trace->user_attributes) {
	161	BT_LIB_LOGE_APPEND_CAUSE(
	162	"Failed to create a map value object.");
	163	goto error;
	164	}
	165
7b33a0e0 PP	166	trace->streams = g_ptr_array_new_with_free_func(
	167	(GDestroyNotify) bt_object_try_spec_release);
	168	if (!trace->streams) {
a8f90e5d	169	BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate one GPtrArray.");
8deee039 PP	170	goto error;
	171	}
	172
7b33a0e0 PP	173	trace->stream_classes_stream_count = g_hash_table_new(g_direct_hash,
	174	g_direct_equal);
	175	if (!trace->stream_classes_stream_count) {
a8f90e5d	176	BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate one GHashTable.");
7b33a0e0 PP	177	goto error;
	178	}
	179
	180	trace->name.str = g_string_new(NULL);
	181	if (!trace->name.str) {
a8f90e5d	182	BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate one GString.");
7b33a0e0 PP	183	goto error;
	184	}
	185
cd03c43c PP	186	trace->environment = bt_attributes_create();
	187	if (!trace->environment) {
	188	BT_LIB_LOGE_APPEND_CAUSE("Cannot create empty attributes object.");
	189	goto error;
	190	}
	191
1122415c FD	192	trace->destruction_listeners = g_array_new(FALSE, TRUE,
	193	sizeof(struct bt_trace_destruction_listener_elem));
	194	if (!trace->destruction_listeners) {
a8f90e5d	195	BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate one GArray.");
3602afb0 PP	196	goto error;
	197	}
	198
10b7a2e4	199	trace->class = tc;
864aa43f	200	bt_object_get_ref_no_null_check(trace->class);
7b33a0e0 PP	201	BT_LIB_LOGD("Created trace object: %!+t", trace);
7b33a0e0 PP	202	goto end;
bc37ae52	203
bc37ae52	204	error:
8138bfe1	205	BT_OBJECT_PUT_REF_AND_RESET(trace);
7b33a0e0 PP	206
7b33a0e0 PP	207	end:
10b7a2e4	208	return trace;
bc37ae52 JG	209	}
bc37ae52 JG	210
78cf9df6	211	const char bt_trace_get_name(const struct bt_trace trace)
e96045d4	212	{
fa6cfec3	213	BT_ASSERT_PRE_DEV_NON_NULL(trace, "Trace");
7b33a0e0	214	return trace->name.value;
e96045d4 JG	215	}
e96045d4 JG	216
fb25b9e3 PP	217	enum bt_trace_set_name_status bt_trace_set_name(struct bt_trace *trace,
fb25b9e3 PP	218	const char *name)
e96045d4	219	{
7b33a0e0 PP	220	BT_ASSERT_PRE_NON_NULL(trace, "Trace");
7b33a0e0 PP	221	BT_ASSERT_PRE_NON_NULL(name, "Name");
fa6cfec3	222	BT_ASSERT_PRE_DEV_TRACE_HOT(trace);
7b33a0e0 PP	223	g_string_assign(trace->name.str, name);
7b33a0e0 PP	224	trace->name.value = trace->name.str->str;
a684a357	225	BT_LIB_LOGD("Set trace's name: %!+t", trace);
fb25b9e3	226	return BT_FUNC_STATUS_OK;
e96045d4 JG	227	}
e96045d4 JG	228
cd03c43c PP	229	bt_uuid bt_trace_get_uuid(const struct bt_trace *trace)
cd03c43c PP	230	{
fa6cfec3	231	BT_ASSERT_PRE_DEV_NON_NULL(trace, "Trace");
cd03c43c PP	232	return trace->uuid.value;
	233	}
	234
	235	void bt_trace_set_uuid(struct bt_trace *trace, bt_uuid uuid)
	236	{
	237	BT_ASSERT_PRE_NON_NULL(trace, "Trace");
	238	BT_ASSERT_PRE_NON_NULL(uuid, "UUID");
fa6cfec3	239	BT_ASSERT_PRE_DEV_TRACE_HOT(trace);
d126826c	240	bt_uuid_copy(trace->uuid.uuid, uuid);
cd03c43c PP	241	trace->uuid.value = trace->uuid.uuid;
	242	BT_LIB_LOGD("Set trace's UUID: %!+t", trace);
	243	}
	244
cd03c43c PP	245	static
	246	bool trace_has_environment_entry(const struct bt_trace trace, const char name)
	247	{
	248	BT_ASSERT(trace);
	249
	250	return bt_attributes_borrow_field_value_by_name(
8e01f2d9	251	trace->environment, name);
cd03c43c PP	252	}
	253
	254	static
	255	enum bt_trace_set_environment_entry_status set_environment_entry(
	256	struct bt_trace *trace,
	257	const char name, struct bt_value value)
	258	{
	259	int ret;
	260
	261	BT_ASSERT(trace);
	262	BT_ASSERT(name);
	263	BT_ASSERT(value);
	264	BT_ASSERT_PRE(!trace->frozen \|\|
	265	!trace_has_environment_entry(trace, name),
	266	"Trace is frozen: cannot replace environment entry: "
	267	"%![trace-]+t, entry-name=\"%s\"", trace, name);
	268	ret = bt_attributes_set_field_value(trace->environment, name,
	269	value);
	270	if (ret) {
	271	ret = BT_FUNC_STATUS_MEMORY_ERROR;
	272	BT_LIB_LOGE_APPEND_CAUSE(
	273	"Cannot set trace's environment entry: "
	274	"%![trace-]+t, entry-name=\"%s\"", trace, name);
	275	} else {
	276	bt_value_freeze(value);
	277	BT_LIB_LOGD("Set trace's environment entry: "
	278	"%![trace-]+t, entry-name=\"%s\"", trace, name);
	279	}
	280
	281	return ret;
	282	}
	283
	284	enum bt_trace_set_environment_entry_status
	285	bt_trace_set_environment_entry_string(
	286	struct bt_trace trace, const char name, const char *value)
	287	{
	288	int ret;
	289	struct bt_value *value_obj;
	290	BT_ASSERT_PRE_NON_NULL(trace, "Trace");
	291	BT_ASSERT_PRE_NON_NULL(name, "Name");
	292	BT_ASSERT_PRE_NON_NULL(value, "Value");
	293	value_obj = bt_value_string_create_init(value);
	294	if (!value_obj) {
	295	BT_LIB_LOGE_APPEND_CAUSE(
	296	"Cannot create a string value object.");
	297	ret = -1;
	298	goto end;
	299	}
	300
	301	/* set_environment_entry() logs errors */
	302	ret = set_environment_entry(trace, name, value_obj);
	303
	304	end:
	305	bt_object_put_ref(value_obj);
	306	return ret;
	307	}
	308
	309	enum bt_trace_set_environment_entry_status
	310	bt_trace_set_environment_entry_integer(
	311	struct bt_trace trace, const char name, int64_t value)
	312	{
	313	int ret;
	314	struct bt_value *value_obj;
	315	BT_ASSERT_PRE_NON_NULL(trace, "Trace");
316	BT_ASSERT_PRE_NON_NULL(name, "Name");
60bbfc7c	317	value_obj = bt_value_integer_signed_create_init(value);
cd03c43c PP	318	if (!value_obj) {
	319	BT_LIB_LOGE_APPEND_CAUSE(
	320	"Cannot create an integer value object.");
	321	ret = BT_FUNC_STATUS_MEMORY_ERROR;
	322	goto end;
	323	}
	324
	325	/* set_environment_entry() logs errors */
	326	ret = set_environment_entry(trace, name, value_obj);
	327
	328	end:
	329	bt_object_put_ref(value_obj);
	330	return ret;
	331	}
	332
	333	uint64_t bt_trace_get_environment_entry_count(const struct bt_trace *trace)
	334	{
fa6cfec3	335	BT_ASSERT_PRE_DEV_NON_NULL(trace, "Trace");
6e30bfda	336	return bt_attributes_get_count(trace->environment);
cd03c43c PP	337	}
	338
	339	void bt_trace_borrow_environment_entry_by_index_const(
	340	const struct bt_trace *trace, uint64_t index,
	341	const char name, const struct bt_value value)
	342	{
fa6cfec3 PP	343	BT_ASSERT_PRE_DEV_NON_NULL(trace, "Trace");
	344	BT_ASSERT_PRE_DEV_NON_NULL(name, "Name");
	345	BT_ASSERT_PRE_DEV_NON_NULL(value, "Value");
	346	BT_ASSERT_PRE_DEV_VALID_INDEX(index,
cd03c43c PP	347	bt_attributes_get_count(trace->environment));
	348	*value = bt_attributes_borrow_field_value(trace->environment, index);
	349	BT_ASSERT(*value);
	350	*name = bt_attributes_get_field_name(trace->environment, index);
	351	BT_ASSERT(*name);
	352	}
	353
	354	const struct bt_value *bt_trace_borrow_environment_entry_value_by_name_const(
	355	const struct bt_trace trace, const char name)
	356	{
fa6cfec3 PP	357	BT_ASSERT_PRE_DEV_NON_NULL(trace, "Trace");
fa6cfec3 PP	358	BT_ASSERT_PRE_DEV_NON_NULL(name, "Name");
cd03c43c PP	359	return bt_attributes_borrow_field_value_by_name(trace->environment,
	360	name);
	361	}
	362
78cf9df6	363	uint64_t bt_trace_get_stream_count(const struct bt_trace *trace)
bc37ae52	364	{
fa6cfec3	365	BT_ASSERT_PRE_DEV_NON_NULL(trace, "Trace");
7b33a0e0 PP	366	return (uint64_t) trace->streams->len;
7b33a0e0 PP	367	}
95c09b3a	368
7b33a0e0 PP	369	struct bt_stream *bt_trace_borrow_stream_by_index(
	370	struct bt_trace *trace, uint64_t index)
	371	{
fa6cfec3 PP	372	BT_ASSERT_PRE_DEV_NON_NULL(trace, "Trace");
fa6cfec3 PP	373	BT_ASSERT_PRE_DEV_VALID_INDEX(index, trace->streams->len);
7b33a0e0 PP	374	return g_ptr_array_index(trace->streams, index);
7b33a0e0 PP	375	}
18acc6f8	376
78cf9df6 PP	377	const struct bt_stream *bt_trace_borrow_stream_by_index_const(
78cf9df6 PP	378	const struct bt_trace *trace, uint64_t index)
9e550e5f	379	{
78cf9df6	380	return bt_trace_borrow_stream_by_index((void *) trace, index);
9e550e5f PP	381	}
9e550e5f PP	382
78cf9df6 PP	383	struct bt_stream bt_trace_borrow_stream_by_id(struct bt_trace trace,
78cf9df6 PP	384	uint64_t id)
7b33a0e0 PP	385	{
	386	struct bt_stream *stream = NULL;
	387	uint64_t i;
bc37ae52	388
fa6cfec3	389	BT_ASSERT_PRE_DEV_NON_NULL(trace, "Trace");
bc37ae52	390
7b33a0e0 PP	391	for (i = 0; i < trace->streams->len; i++) {
	392	struct bt_stream *stream_candidate =
	393	g_ptr_array_index(trace->streams, i);
cfeb617e	394
7b33a0e0 PP	395	if (stream_candidate->id == id) {
	396	stream = stream_candidate;
	397	goto end;
	398	}
6474e016	399	}
95c09b3a	400
bc37ae52	401	end:
7b33a0e0	402	return stream;
bc37ae52 JG	403	}
bc37ae52 JG	404
78cf9df6 PP	405	const struct bt_stream *bt_trace_borrow_stream_by_id_const(
78cf9df6 PP	406	const struct bt_trace *trace, uint64_t id)
9e550e5f	407	{
78cf9df6	408	return bt_trace_borrow_stream_by_id((void *) trace, id);
9e550e5f PP	409	}
9e550e5f PP	410
fb25b9e3	411	enum bt_trace_add_listener_status bt_trace_add_destruction_listener(
78cf9df6	412	const struct bt_trace *c_trace,
1122415c	413	bt_trace_destruction_listener_func listener,
eba7ea21	414	void data, bt_listener_id listener_id)
3602afb0	415	{
78cf9df6	416	struct bt_trace trace = (void ) c_trace;
7b33a0e0	417	uint64_t i;
1122415c	418	struct bt_trace_destruction_listener_elem new_elem = {
3602afb0 PP	419	.func = listener,
	420	.data = data,
	421	};
	422
7b33a0e0 PP	423	BT_ASSERT_PRE_NON_NULL(trace, "Trace");
7b33a0e0 PP	424	BT_ASSERT_PRE_NON_NULL(listener, "Listener");
9962ad4b	425
3602afb0	426	/* Find the next available spot */
1122415c FD	427	for (i = 0; i < trace->destruction_listeners->len; i++) {
	428	struct bt_trace_destruction_listener_elem elem =
	429	g_array_index(trace->destruction_listeners,
	430	struct bt_trace_destruction_listener_elem, i);
3602afb0 PP	431
	432	if (!elem.func) {
	433	break;
	434	}
	435	}
	436
1122415c FD	437	if (i == trace->destruction_listeners->len) {
1122415c FD	438	g_array_append_val(trace->destruction_listeners, new_elem);
3602afb0	439	} else {
1122415c	440	g_array_insert_val(trace->destruction_listeners, i, new_elem);
3602afb0 PP	441	}
3602afb0 PP	442
7b33a0e0 PP	443	if (listener_id) {
	444	*listener_id = i;
	445	}
3602afb0	446
a684a357	447	BT_LIB_LOGD("Added destruction listener: " "%![trace-]+t, "
1122415c	448	"listener-id=%" PRIu64, trace, i);
fb25b9e3	449	return BT_FUNC_STATUS_OK;
7b33a0e0 PP	450	}
7b33a0e0 PP	451
7b33a0e0	452	static
78cf9df6	453	bool has_listener_id(const struct bt_trace *trace, uint64_t listener_id)
7b33a0e0	454	{
1122415c FD	455	BT_ASSERT(listener_id < trace->destruction_listeners->len);
	456	return (&g_array_index(trace->destruction_listeners,
	457	struct bt_trace_destruction_listener_elem,
8e01f2d9	458	listener_id))->func;
3602afb0 PP	459	}
3602afb0 PP	460
fb25b9e3	461	enum bt_trace_remove_listener_status bt_trace_remove_destruction_listener(
eba7ea21	462	const struct bt_trace *c_trace, bt_listener_id listener_id)
3602afb0	463	{
78cf9df6	464	struct bt_trace trace = (void ) c_trace;
1122415c	465	struct bt_trace_destruction_listener_elem *elem;
3602afb0	466
7b33a0e0	467	BT_ASSERT_PRE_NON_NULL(trace, "Trace");
7b33a0e0	468	BT_ASSERT_PRE(has_listener_id(trace, listener_id),
1122415c	469	"Trace has no such trace destruction listener ID: "
7b33a0e0	470	"%![trace-]+t, %" PRIu64, trace, listener_id);
1122415c FD	471	elem = &g_array_index(trace->destruction_listeners,
1122415c FD	472	struct bt_trace_destruction_listener_elem,
3602afb0	473	listener_id);
7b33a0e0	474	BT_ASSERT(elem->func);
3602afb0 PP	475
	476	elem->func = NULL;
	477	elem->data = NULL;
a684a357	478	BT_LIB_LOGD("Removed \"trace destruction listener: "
7b33a0e0 PP	479	"%![trace-]+t, listener-id=%" PRIu64,
7b33a0e0 PP	480	trace, listener_id);
fb25b9e3	481	return BT_FUNC_STATUS_OK;
7b33a0e0	482	}
3602afb0	483
7b33a0e0	484	BT_HIDDEN
78cf9df6	485	void _bt_trace_freeze(const struct bt_trace *trace)
7b33a0e0	486	{
7b33a0e0	487	BT_ASSERT(trace);
10b7a2e4 PP	488	BT_LIB_LOGD("Freezing trace's class: %!+T", trace->class);
10b7a2e4 PP	489	bt_trace_class_freeze(trace->class);
af90138b PP	490	BT_LIB_LOGD("Freezing trace's user attributes: %!+v",
	491	trace->user_attributes);
	492	bt_value_freeze(trace->user_attributes);
7b33a0e0	493	BT_LIB_LOGD("Freezing trace: %!+t", trace);
78cf9df6	494	((struct bt_trace *) trace)->frozen = true;
5acf2ae6	495	}
a6918753	496
7b33a0e0 PP	497	BT_HIDDEN
	498	void bt_trace_add_stream(struct bt_trace trace, struct bt_stream stream)
	499	{
	500	guint count = 0;
	501
	502	bt_object_set_parent(&stream->base, &trace->base);
	503	g_ptr_array_add(trace->streams, stream);
18acc6f8	504	bt_trace_freeze(trace);
a6918753	505
7b33a0e0 PP	506	if (bt_g_hash_table_contains(trace->stream_classes_stream_count,
	507	stream->class)) {
	508	count = GPOINTER_TO_UINT(g_hash_table_lookup(
	509	trace->stream_classes_stream_count, stream->class));
a6918753 PP	510	}
a6918753 PP	511
7b33a0e0 PP	512	g_hash_table_insert(trace->stream_classes_stream_count,
	513	stream->class, GUINT_TO_POINTER(count + 1));
	514	}
	515
	516	BT_HIDDEN
78cf9df6 PP	517	uint64_t bt_trace_get_automatic_stream_id(const struct bt_trace *trace,
78cf9df6 PP	518	const struct bt_stream_class *stream_class)
7b33a0e0 PP	519	{
	520	gpointer orig_key;
	521	gpointer value;
	522	uint64_t id = 0;
	523
	524	BT_ASSERT(stream_class);
	525	BT_ASSERT(trace);
	526	if (g_hash_table_lookup_extended(trace->stream_classes_stream_count,
	527	stream_class, &orig_key, &value)) {
	528	id = (uint64_t) GPOINTER_TO_UINT(value);
	529	}
	530
	531	return id;
a6918753	532	}
10b7a2e4 PP	533
	534	struct bt_trace_class bt_trace_borrow_class(struct bt_trace trace)
	535	{
fa6cfec3	536	BT_ASSERT_PRE_DEV_NON_NULL(trace, "Trace");
10b7a2e4 PP	537	return trace->class;
	538	}
	539
	540	const struct bt_trace_class *bt_trace_borrow_class_const(
	541	const struct bt_trace *trace)
	542	{
	543	return bt_trace_borrow_class((void *) trace);
	544	}
8c6884d9	545
af90138b PP	546	const struct bt_value *bt_trace_borrow_user_attributes_const(
	547	const struct bt_trace *trace)
	548	{
	549	BT_ASSERT_PRE_DEV_NON_NULL(trace, "Trace");
	550	return trace->user_attributes;
	551	}
	552
	553	struct bt_value bt_trace_borrow_user_attributes(struct bt_trace trace)
	554	{
	555	return (void ) bt_trace_borrow_user_attributes_const((void ) trace);
	556	}
	557
	558	void bt_trace_set_user_attributes(
	559	struct bt_trace *trace,
	560	const struct bt_value *user_attributes)
	561	{
	562	BT_ASSERT_PRE_NON_NULL(trace, "Trace");
	563	BT_ASSERT_PRE_NON_NULL(user_attributes, "User attributes");
	564	BT_ASSERT_PRE(user_attributes->type == BT_VALUE_TYPE_MAP,
	565	"User attributes object is not a map value object.");
	566	BT_ASSERT_PRE_DEV_TRACE_HOT(trace);
864aa43f	567	bt_object_put_ref_no_null_check(trace->user_attributes);
af90138b	568	trace->user_attributes = (void *) user_attributes;
864aa43f	569	bt_object_get_ref_no_null_check(trace->user_attributes);
af90138b PP	570	}
af90138b PP	571
8c6884d9 PP	572	void bt_trace_get_ref(const struct bt_trace *trace)
	573	{
	574	bt_object_get_ref(trace);
	575	}
	576
	577	void bt_trace_put_ref(const struct bt_trace *trace)
	578	{
	579	bt_object_put_ref(trace);
	580	}