doc/api/libbabeltrace2/DoxygenLayout.xml: use `topics` tab

[babeltrace.git] / src / lib / trace-ir / stream.c

/*
 * SPDX-License-Identifier: MIT
 *
 * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
 * Copyright 2013, 2014 Jérémie Galarneau <jeremie.galarneau@efficios.com>
 */

#define BT_LOG_TAG "LIB/STREAM"
#include "lib/logging.h"

#include "lib/assert-cond.h"
#include <babeltrace2/trace-ir/stream.h>
#include <babeltrace2/trace-ir/stream-class.h>
#include <babeltrace2/trace-ir/trace.h>
#include "compat/compiler.h"
#include "common/assert.h"
#include <inttypes.h>
#include <stdbool.h>
#include <unistd.h>

#include "packet.h"
#include "stream-class.h"
#include "stream.h"
#include "trace.h"
#include "lib/value.h"
#include "lib/func-status.h"

#define BT_ASSERT_PRE_DEV_STREAM_HOT(_stream)				\
	BT_ASSERT_PRE_DEV_HOT("stream", (_stream), "Stream",		\
		": %!+s", (_stream))

static
void destroy_stream(struct bt_object *obj)
{
	struct bt_stream *stream = (void *) obj;

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

	g_free(stream->name);
	BT_LOGD_STR("Putting stream's class.");
	bt_object_put_ref(stream->class);
	bt_object_pool_finalize(&stream->packet_pool);
	g_free(stream);
}

static
void bt_stream_free_packet(struct bt_packet *packet,
		struct bt_stream *stream __attribute__((unused)))
{
	bt_packet_destroy(packet);
}

static inline
bool stream_id_is_unique(struct bt_trace *trace,
		struct bt_stream_class *stream_class, uint64_t id)
{
	uint64_t i;
	bool is_unique = true;

	for (i = 0; i < trace->streams->len; i++) {
		struct bt_stream *stream = trace->streams->pdata[i];

		if (stream->class != stream_class) {
			continue;
		}

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

end:
	return is_unique;
}

static
struct bt_stream *create_stream_with_id(struct bt_stream_class *stream_class,
		struct bt_trace *trace, uint64_t id, const char *api_func)
{
	int ret;
	struct bt_stream *stream;

	BT_ASSERT(stream_class);
	BT_ASSERT(trace);
	BT_ASSERT_PRE_FROM_FUNC(api_func,
		"trace-class-is-stream-class-trace-class",
		trace->class ==
			bt_stream_class_borrow_trace_class_inline(stream_class),
		"Trace's class is different from stream class's parent trace class: "
		"%![sc-]+S, %![trace-]+t", stream_class, trace);
	BT_ASSERT_PRE_FROM_FUNC(api_func, "stream-id-is-unique",
		stream_id_is_unique(trace, stream_class, id),
		"Duplicate stream ID: %![trace-]+t, id=%" PRIu64, trace, id);
	BT_LIB_LOGD("Creating stream object: %![trace-]+t, id=%" PRIu64,
		trace, id);
	stream = g_new0(struct bt_stream, 1);
	if (!stream) {
		BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate one stream.");
		goto error;
	}

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

	stream->id = id;
	ret = bt_object_pool_initialize(&stream->packet_pool,
		(bt_object_pool_new_object_func) bt_packet_new,
		(bt_object_pool_destroy_object_func) bt_stream_free_packet,
		stream);
	if (ret) {
		BT_LIB_LOGE_APPEND_CAUSE(
			"Failed to initialize packet pool: ret=%d", ret);
		goto error;
	}

	stream->class = stream_class;
	bt_object_get_ref_no_null_check(stream_class);

	/* bt_trace_add_stream() sets the parent trace, and freezes the trace */
	bt_trace_add_stream(trace, stream);

	bt_stream_class_freeze(stream_class);
	BT_LIB_LOGD("Created stream object: %!+s", stream);
	goto end;

error:
	BT_OBJECT_PUT_REF_AND_RESET(stream);

end:
	return stream;
}

BT_EXPORT
struct bt_stream *bt_stream_create(struct bt_stream_class *stream_class,
		struct bt_trace *trace)
{
	uint64_t id;

	BT_ASSERT_PRE_NO_ERROR();
	BT_ASSERT_PRE_SC_NON_NULL(stream_class);
	BT_ASSERT_PRE_TRACE_NON_NULL(trace);
	BT_ASSERT_PRE("stream-class-automatically-assigns-stream-ids",
		stream_class->assigns_automatic_stream_id,
		"Stream class does not automatically assigns stream IDs: "
		"%![sc-]+S", stream_class);
	id = bt_trace_get_automatic_stream_id(trace, stream_class);
	return create_stream_with_id(stream_class, trace, id, __func__);
}

BT_EXPORT
struct bt_stream *bt_stream_create_with_id(struct bt_stream_class *stream_class,
		struct bt_trace *trace, uint64_t id)
{
	BT_ASSERT_PRE_NO_ERROR();
	BT_ASSERT_PRE_SC_NON_NULL(stream_class);
	BT_ASSERT_PRE_TRACE_NON_NULL(trace);
	BT_ASSERT_PRE("stream-class-does-not-automatically-assigns-stream-ids",
		!stream_class->assigns_automatic_stream_id,
		"Stream class automatically assigns stream IDs: "
		"%![sc-]+S", stream_class);
	return create_stream_with_id(stream_class, trace, id, __func__);
}

BT_EXPORT
struct bt_stream_class *bt_stream_borrow_class(struct bt_stream *stream)
{
	BT_ASSERT_PRE_DEV_STREAM_NON_NULL(stream);
	return stream->class;
}

BT_EXPORT
const struct bt_stream_class *bt_stream_borrow_class_const(
		const struct bt_stream *stream)
{
	return bt_stream_borrow_class((void *) stream);
}

BT_EXPORT
struct bt_trace *bt_stream_borrow_trace(struct bt_stream *stream)
{
	BT_ASSERT_PRE_DEV_STREAM_NON_NULL(stream);
	return bt_stream_borrow_trace_inline(stream);
}

BT_EXPORT
const struct bt_trace *bt_stream_borrow_trace_const(
		const struct bt_stream *stream)
{
	return bt_stream_borrow_trace((void *) stream);
}

BT_EXPORT
const char *bt_stream_get_name(const struct bt_stream *stream)
{
	BT_ASSERT_PRE_DEV_STREAM_NON_NULL(stream);
	return stream->name;
}

BT_EXPORT
enum bt_stream_set_name_status bt_stream_set_name(struct bt_stream *stream,
		const char *name)
{
	BT_ASSERT_PRE_NO_ERROR();
	BT_ASSERT_PRE_STREAM_NON_NULL(stream);
	BT_ASSERT_PRE_NAME_NON_NULL(name);
	BT_ASSERT_PRE_DEV_STREAM_HOT(stream);
	g_free(stream->name);
	stream->name = g_strdup(name);
	BT_LIB_LOGD("Set stream's name: %!+s", stream);
	return BT_FUNC_STATUS_OK;
}

BT_EXPORT
uint64_t bt_stream_get_id(const struct bt_stream *stream)
{
	BT_ASSERT_PRE_DEV_SC_NON_NULL(stream);
	return stream->id;
}

void _bt_stream_freeze(const struct bt_stream *stream)
{
	BT_ASSERT(stream);
	BT_LIB_LOGD("Freezing stream's user attributes: %!+v",
		stream->user_attributes);
	bt_value_freeze(stream->user_attributes);
	BT_LIB_LOGD("Freezing stream: %!+s", stream);
	((struct bt_stream *) stream)->frozen = true;
}

BT_EXPORT
const struct bt_value *bt_stream_borrow_user_attributes_const(
		const struct bt_stream *stream)
{
	BT_ASSERT_PRE_DEV_STREAM_NON_NULL(stream);
	return stream->user_attributes;
}

BT_EXPORT
struct bt_value *bt_stream_borrow_user_attributes(struct bt_stream *stream)
{
	return (void *) bt_stream_borrow_user_attributes_const((void *) stream);
}

BT_EXPORT
void bt_stream_set_user_attributes(struct bt_stream *stream,
		const struct bt_value *user_attributes)
{
	BT_ASSERT_PRE_STREAM_NON_NULL(stream);
	BT_ASSERT_PRE_USER_ATTRS_NON_NULL(user_attributes);
	BT_ASSERT_PRE_USER_ATTRS_IS_MAP(user_attributes);
	BT_ASSERT_PRE_DEV_STREAM_HOT(stream);
	bt_object_put_ref_no_null_check(stream->user_attributes);
	stream->user_attributes = (void *) user_attributes;
	bt_object_get_ref_no_null_check(stream->user_attributes);
}

BT_EXPORT
void bt_stream_get_ref(const struct bt_stream *stream)
{
	bt_object_get_ref(stream);
}

BT_EXPORT
void bt_stream_put_ref(const struct bt_stream *stream)
{
	bt_object_put_ref(stream);
}