[babeltrace.git] / src / lib / graph / message / stream.c

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

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

#include "lib/assert-cond.h"
#include "compat/compiler.h"
#include <babeltrace2/trace-ir/clock-snapshot.h>
#include "lib/trace-ir/stream.h"
#include <babeltrace2/trace-ir/stream-class.h>
#include "lib/trace-ir/stream-class.h"
#include <babeltrace2/graph/message.h>
#include "common/assert.h"
#include <inttypes.h>

#include "stream.h"

#define BT_ASSERT_PRE_DEV_MSG_IS_STREAM_BEGINNING(_msg)			\
	BT_ASSERT_PRE_DEV_MSG_HAS_TYPE("message", (_msg),		\
		"stream-beginning", BT_MESSAGE_TYPE_STREAM_BEGINNING)

#define BT_ASSERT_PRE_DEV_MSG_IS_STREAM_END(_msg)			\
	BT_ASSERT_PRE_DEV_MSG_HAS_TYPE("message", (_msg),		\
		"stream-end", BT_MESSAGE_TYPE_STREAM_END)

static
void destroy_stream_message(struct bt_object *obj)
{
	struct bt_message_stream *message = (void *) obj;

	BT_LIB_LOGD("Destroying stream message: %!+n", message);

	if (message->default_cs) {
		BT_LIB_LOGD("Putting default clock snapshot: %!+k",
			message->default_cs);
		bt_clock_snapshot_destroy(message->default_cs);
		message->default_cs = NULL;
	}

	BT_LIB_LOGD("Putting stream: %!+s", message->stream);
	BT_OBJECT_PUT_REF_AND_RESET(message->stream);
	g_free(message);
}

static inline
struct bt_message *create_stream_message(
		struct bt_self_message_iterator *self_msg_iter,
		struct bt_stream *stream, enum bt_message_type type,
		const char *api_func)
{
	struct bt_message_stream *message;
	struct bt_stream_class *stream_class;

	BT_ASSERT_PRE_MSG_ITER_NON_NULL_FROM_FUNC(api_func, self_msg_iter);
	BT_ASSERT_PRE_STREAM_NON_NULL_FROM_FUNC(api_func, stream);
	stream_class = bt_stream_borrow_class(stream);
	BT_ASSERT(stream_class);
	BT_LIB_LOGD("Creating stream message object: "
		"type=%s, %![stream-]+s, %![sc-]+S",
		bt_common_message_type_string(type), stream, stream_class);
	message = g_new0(struct bt_message_stream, 1);
	if (!message) {
		BT_LIB_LOGE_APPEND_CAUSE(
			"Failed to allocate one stream message.");
		goto error;
	}

	bt_message_init(&message->parent, type,
		destroy_stream_message, NULL);
	message->stream = stream;
	bt_object_get_ref_no_null_check(message->stream);

	if (stream_class->default_clock_class) {
		message->default_cs = bt_clock_snapshot_create(
			stream_class->default_clock_class);
		if (!message->default_cs) {
			goto error;
		}
	}

	BT_LIB_LOGD("Created stream message object: "
		"%![msg-]+n, %![stream-]+s, %![sc-]+S", message,
		stream, stream_class);

	goto end;

error:
	if (message) {
		g_free(message);
		message = NULL;
	}

end:
	return &message->parent;
}

BT_EXPORT
struct bt_message *bt_message_stream_beginning_create(
		struct bt_self_message_iterator *self_msg_iter,
		const struct bt_stream *stream)
{
	BT_ASSERT_PRE_DEV_NO_ERROR();

	return create_stream_message(self_msg_iter, (void *) stream,
		BT_MESSAGE_TYPE_STREAM_BEGINNING, __func__);
}

BT_EXPORT
struct bt_message *bt_message_stream_end_create(
		struct bt_self_message_iterator *self_msg_iter,
		const struct bt_stream *stream)
{
	BT_ASSERT_PRE_DEV_NO_ERROR();

	return create_stream_message(self_msg_iter, (void *) stream,
		BT_MESSAGE_TYPE_STREAM_END, __func__);
}

static inline
struct bt_stream *borrow_stream_message_stream(struct bt_message *message)
{
	struct bt_message_stream *stream_msg;

	BT_ASSERT_DBG(message);
	stream_msg = (void *) message;
	return stream_msg->stream;
}

BT_EXPORT
struct bt_stream *bt_message_stream_beginning_borrow_stream(
		struct bt_message *message)
{
	BT_ASSERT_PRE_DEV_MSG_NON_NULL(message);
	BT_ASSERT_PRE_DEV_MSG_IS_STREAM_BEGINNING(message);
	return borrow_stream_message_stream(message);
}

BT_EXPORT
struct bt_stream *bt_message_stream_end_borrow_stream(
		struct bt_message *message)
{
	BT_ASSERT_PRE_DEV_MSG_NON_NULL(message);
	BT_ASSERT_PRE_DEV_MSG_IS_STREAM_END(message);
	return borrow_stream_message_stream(message);
}

BT_EXPORT
const struct bt_stream *bt_message_stream_beginning_borrow_stream_const(
		const struct bt_message *message)
{
	return bt_message_stream_beginning_borrow_stream(
		(void *) message);
}

BT_EXPORT
const struct bt_stream *bt_message_stream_end_borrow_stream_const(
		const struct bt_message *message)
{
	return bt_message_stream_end_borrow_stream(
		(void *) message);
}

static
void set_stream_default_clock_snapshot(
		struct bt_message *msg, uint64_t raw_value,
		const char *api_func)
{
	struct bt_message_stream *stream_msg = (void *) msg;
	struct bt_stream_class *sc;

	BT_ASSERT(msg);
	BT_ASSERT_PRE_DEV_HOT_FROM_FUNC(api_func, "message", msg,
		"Message", ": %!+n", msg);
	sc = stream_msg->stream->class;
	BT_ASSERT(sc);
	BT_ASSERT_PRE_MSG_SC_DEF_CLK_CLS_FROM_FUNC(api_func, msg, sc);
	BT_ASSERT(stream_msg->default_cs);
	bt_clock_snapshot_set_raw_value(stream_msg->default_cs, raw_value);
	stream_msg->default_cs_state = BT_MESSAGE_STREAM_CLOCK_SNAPSHOT_STATE_KNOWN;
	BT_LIB_LOGD("Set stream message's default clock snapshot: "
		"%![msg-]+n, value=%" PRIu64, msg, raw_value);
}

BT_EXPORT
void bt_message_stream_beginning_set_default_clock_snapshot(
		struct bt_message *message, uint64_t raw_value)
{
	BT_ASSERT_PRE_MSG_NON_NULL(message);
	BT_ASSERT_PRE_DEV_MSG_IS_STREAM_BEGINNING(message);
	set_stream_default_clock_snapshot(message, raw_value, __func__);
}

BT_EXPORT
void bt_message_stream_end_set_default_clock_snapshot(
		struct bt_message *message, uint64_t raw_value)
{
	BT_ASSERT_PRE_MSG_NON_NULL(message);
	BT_ASSERT_PRE_DEV_MSG_IS_STREAM_END(message);
	return set_stream_default_clock_snapshot(message, raw_value, __func__);
}

static enum bt_message_stream_clock_snapshot_state
borrow_stream_message_default_clock_snapshot_const(
		const bt_message *msg, const bt_clock_snapshot **snapshot,
		const char *api_func)
{
	struct bt_message_stream *stream_msg = (void *) msg;
	struct bt_stream_class *sc;

	BT_ASSERT_DBG(msg);
	sc = stream_msg->stream->class;
	BT_ASSERT_DBG(sc);
	BT_ASSERT_PRE_DEV_MSG_SC_DEF_CLK_CLS_FROM_FUNC(api_func, msg, sc);
	BT_ASSERT_DBG(stream_msg->default_cs);

	*snapshot = stream_msg->default_cs;

	return stream_msg->default_cs_state;
}

BT_EXPORT
enum bt_message_stream_clock_snapshot_state
bt_message_stream_beginning_borrow_default_clock_snapshot_const(
		const bt_message *message, const bt_clock_snapshot **snapshot)
{
	BT_ASSERT_PRE_DEV_MSG_NON_NULL(message);
	BT_ASSERT_PRE_DEV_MSG_IS_STREAM_BEGINNING(message);
	return borrow_stream_message_default_clock_snapshot_const(
		message, snapshot, __func__);
}

BT_EXPORT
enum bt_message_stream_clock_snapshot_state
bt_message_stream_end_borrow_default_clock_snapshot_const(
		const bt_message *message, const bt_clock_snapshot **snapshot)
{
	BT_ASSERT_PRE_DEV_MSG_NON_NULL(message);
	BT_ASSERT_PRE_DEV_MSG_IS_STREAM_END(message);
	return borrow_stream_message_default_clock_snapshot_const(
		message, snapshot, __func__);
}

static inline
const struct bt_clock_class *
borrow_stream_message_stream_class_default_clock_class(
		const struct bt_message *msg)
{
	struct bt_message_stream *stream_msg = (void *) msg;

	BT_ASSERT_DBG(msg);
	return stream_msg->stream->class->default_clock_class;
}

BT_EXPORT
const struct bt_clock_class *
bt_message_stream_beginning_borrow_stream_class_default_clock_class_const(
		const struct bt_message *msg)
{
	BT_ASSERT_PRE_DEV_MSG_NON_NULL(msg);
	BT_ASSERT_PRE_DEV_MSG_IS_STREAM_BEGINNING(msg);
	return borrow_stream_message_stream_class_default_clock_class(msg);
}

BT_EXPORT
const struct bt_clock_class *
bt_message_stream_end_borrow_stream_class_default_clock_class_const(
		const struct bt_message *msg)
{
	BT_ASSERT_PRE_DEV_MSG_NON_NULL(msg);
	BT_ASSERT_PRE_DEV_MSG_IS_STREAM_END(msg);
	return borrow_stream_message_stream_class_default_clock_class(msg);
}
Commit	Line	Data
	1	/*
	2	* SPDX-License-Identifier: MIT
	3	*
	4	* Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
	5	* Copyright 2016 Jérémie Galarneau <jeremie.galarneau@efficios.com>
	6	*/
	7
	8	#define BT_LOG_TAG "LIB/MSG-STREAM"
	9	#include "lib/logging.h"
	10
	11	#include "lib/assert-cond.h"
	12	#include "compat/compiler.h"
	13	#include <babeltrace2/trace-ir/clock-snapshot.h>
	14	#include "lib/trace-ir/stream.h"
	15	#include <babeltrace2/trace-ir/stream-class.h>
	16	#include "lib/trace-ir/stream-class.h"
	17	#include <babeltrace2/graph/message.h>
	18	#include "common/assert.h"
	19	#include <inttypes.h>
	20
	21	#include "stream.h"
	22
	23	#define BT_ASSERT_PRE_DEV_MSG_IS_STREAM_BEGINNING(_msg) \
	24	BT_ASSERT_PRE_DEV_MSG_HAS_TYPE("message", (_msg), \
	25	"stream-beginning", BT_MESSAGE_TYPE_STREAM_BEGINNING)
	26
	27	#define BT_ASSERT_PRE_DEV_MSG_IS_STREAM_END(_msg) \
	28	BT_ASSERT_PRE_DEV_MSG_HAS_TYPE("message", (_msg), \
	29	"stream-end", BT_MESSAGE_TYPE_STREAM_END)
	30
	31	static
	32	void destroy_stream_message(struct bt_object *obj)
	33	{
	34	struct bt_message_stream message = (void ) obj;
	35
	36	BT_LIB_LOGD("Destroying stream message: %!+n", message);
	37
	38	if (message->default_cs) {
	39	BT_LIB_LOGD("Putting default clock snapshot: %!+k",
	40	message->default_cs);
	41	bt_clock_snapshot_destroy(message->default_cs);
	42	message->default_cs = NULL;
	43	}
	44
	45	BT_LIB_LOGD("Putting stream: %!+s", message->stream);
	46	BT_OBJECT_PUT_REF_AND_RESET(message->stream);
	47	g_free(message);
	48	}
	49
	50	static inline
	51	struct bt_message *create_stream_message(
	52	struct bt_self_message_iterator *self_msg_iter,
	53	struct bt_stream *stream, enum bt_message_type type,
	54	const char *api_func)
	55	{
	56	struct bt_message_stream *message;
	57	struct bt_stream_class *stream_class;
	58
	59	BT_ASSERT_PRE_MSG_ITER_NON_NULL_FROM_FUNC(api_func, self_msg_iter);
	60	BT_ASSERT_PRE_STREAM_NON_NULL_FROM_FUNC(api_func, stream);
	61	stream_class = bt_stream_borrow_class(stream);
	62	BT_ASSERT(stream_class);
	63	BT_LIB_LOGD("Creating stream message object: "
	64	"type=%s, %![stream-]+s, %![sc-]+S",
	65	bt_common_message_type_string(type), stream, stream_class);
	66	message = g_new0(struct bt_message_stream, 1);
	67	if (!message) {
	68	BT_LIB_LOGE_APPEND_CAUSE(
	69	"Failed to allocate one stream message.");
	70	goto error;
	71	}
	72
	73	bt_message_init(&message->parent, type,
	74	destroy_stream_message, NULL);
	75	message->stream = stream;
	76	bt_object_get_ref_no_null_check(message->stream);
	77
	78	if (stream_class->default_clock_class) {
	79	message->default_cs = bt_clock_snapshot_create(
	80	stream_class->default_clock_class);
	81	if (!message->default_cs) {
	82	goto error;
	83	}
	84	}
	85
	86	BT_LIB_LOGD("Created stream message object: "
	87	"%![msg-]+n, %![stream-]+s, %![sc-]+S", message,
	88	stream, stream_class);
	89
	90	goto end;
	91
	92	error:
	93	if (message) {
	94	g_free(message);
	95	message = NULL;
	96	}
	97
	98	end:
	99	return &message->parent;
	100	}
	101
	102	BT_EXPORT
	103	struct bt_message *bt_message_stream_beginning_create(
	104	struct bt_self_message_iterator *self_msg_iter,
	105	const struct bt_stream *stream)
	106	{
	107	BT_ASSERT_PRE_DEV_NO_ERROR();
	108
	109	return create_stream_message(self_msg_iter, (void *) stream,
	110	BT_MESSAGE_TYPE_STREAM_BEGINNING, __func__);
	111	}
	112
	113	BT_EXPORT
	114	struct bt_message *bt_message_stream_end_create(
	115	struct bt_self_message_iterator *self_msg_iter,
	116	const struct bt_stream *stream)
	117	{
	118	BT_ASSERT_PRE_DEV_NO_ERROR();
	119
	120	return create_stream_message(self_msg_iter, (void *) stream,
	121	BT_MESSAGE_TYPE_STREAM_END, __func__);
	122	}
	123
	124	static inline
	125	struct bt_stream borrow_stream_message_stream(struct bt_message message)
	126	{
	127	struct bt_message_stream *stream_msg;
	128
	129	BT_ASSERT_DBG(message);
	130	stream_msg = (void *) message;
	131	return stream_msg->stream;
	132	}
	133
	134	BT_EXPORT
	135	struct bt_stream *bt_message_stream_beginning_borrow_stream(
	136	struct bt_message *message)
	137	{
	138	BT_ASSERT_PRE_DEV_MSG_NON_NULL(message);
	139	BT_ASSERT_PRE_DEV_MSG_IS_STREAM_BEGINNING(message);
	140	return borrow_stream_message_stream(message);
	141	}
	142
	143	BT_EXPORT
	144	struct bt_stream *bt_message_stream_end_borrow_stream(
	145	struct bt_message *message)
	146	{
	147	BT_ASSERT_PRE_DEV_MSG_NON_NULL(message);
	148	BT_ASSERT_PRE_DEV_MSG_IS_STREAM_END(message);
	149	return borrow_stream_message_stream(message);
	150	}
	151
	152	BT_EXPORT
	153	const struct bt_stream *bt_message_stream_beginning_borrow_stream_const(
	154	const struct bt_message *message)
	155	{
	156	return bt_message_stream_beginning_borrow_stream(
	157	(void *) message);
	158	}
	159
	160	BT_EXPORT
	161	const struct bt_stream *bt_message_stream_end_borrow_stream_const(
	162	const struct bt_message *message)
	163	{
	164	return bt_message_stream_end_borrow_stream(
	165	(void *) message);
	166	}
	167
	168	static
	169	void set_stream_default_clock_snapshot(
	170	struct bt_message *msg, uint64_t raw_value,
	171	const char *api_func)
	172	{
	173	struct bt_message_stream stream_msg = (void ) msg;
	174	struct bt_stream_class *sc;
	175
	176	BT_ASSERT(msg);
	177	BT_ASSERT_PRE_DEV_HOT_FROM_FUNC(api_func, "message", msg,
	178	"Message", ": %!+n", msg);
	179	sc = stream_msg->stream->class;
	180	BT_ASSERT(sc);
	181	BT_ASSERT_PRE_MSG_SC_DEF_CLK_CLS_FROM_FUNC(api_func, msg, sc);
	182	BT_ASSERT(stream_msg->default_cs);
	183	bt_clock_snapshot_set_raw_value(stream_msg->default_cs, raw_value);
	184	stream_msg->default_cs_state = BT_MESSAGE_STREAM_CLOCK_SNAPSHOT_STATE_KNOWN;
	185	BT_LIB_LOGD("Set stream message's default clock snapshot: "
	186	"%![msg-]+n, value=%" PRIu64, msg, raw_value);
	187	}
	188
	189	BT_EXPORT
	190	void bt_message_stream_beginning_set_default_clock_snapshot(
	191	struct bt_message *message, uint64_t raw_value)
	192	{
	193	BT_ASSERT_PRE_MSG_NON_NULL(message);
	194	BT_ASSERT_PRE_DEV_MSG_IS_STREAM_BEGINNING(message);
	195	set_stream_default_clock_snapshot(message, raw_value, __func__);
	196	}
	197
	198	BT_EXPORT
	199	void bt_message_stream_end_set_default_clock_snapshot(
	200	struct bt_message *message, uint64_t raw_value)
	201	{
	202	BT_ASSERT_PRE_MSG_NON_NULL(message);
	203	BT_ASSERT_PRE_DEV_MSG_IS_STREAM_END(message);
	204	return set_stream_default_clock_snapshot(message, raw_value, __func__);
	205	}
	206
	207	static enum bt_message_stream_clock_snapshot_state
	208	borrow_stream_message_default_clock_snapshot_const(
	209	const bt_message msg, const bt_clock_snapshot *snapshot,
	210	const char *api_func)
	211	{
	212	struct bt_message_stream stream_msg = (void ) msg;
	213	struct bt_stream_class *sc;
	214
	215	BT_ASSERT_DBG(msg);
	216	sc = stream_msg->stream->class;
	217	BT_ASSERT_DBG(sc);
	218	BT_ASSERT_PRE_DEV_MSG_SC_DEF_CLK_CLS_FROM_FUNC(api_func, msg, sc);
	219	BT_ASSERT_DBG(stream_msg->default_cs);
	220
	221	*snapshot = stream_msg->default_cs;
	222
	223	return stream_msg->default_cs_state;
	224	}
	225
	226	BT_EXPORT
	227	enum bt_message_stream_clock_snapshot_state
	228	bt_message_stream_beginning_borrow_default_clock_snapshot_const(
	229	const bt_message message, const bt_clock_snapshot *snapshot)
	230	{
	231	BT_ASSERT_PRE_DEV_MSG_NON_NULL(message);
	232	BT_ASSERT_PRE_DEV_MSG_IS_STREAM_BEGINNING(message);
	233	return borrow_stream_message_default_clock_snapshot_const(
	234	message, snapshot, __func__);
	235	}
	236
	237	BT_EXPORT
	238	enum bt_message_stream_clock_snapshot_state
	239	bt_message_stream_end_borrow_default_clock_snapshot_const(
	240	const bt_message message, const bt_clock_snapshot *snapshot)
	241	{
	242	BT_ASSERT_PRE_DEV_MSG_NON_NULL(message);
	243	BT_ASSERT_PRE_DEV_MSG_IS_STREAM_END(message);
	244	return borrow_stream_message_default_clock_snapshot_const(
	245	message, snapshot, __func__);
	246	}
	247
	248	static inline
	249	const struct bt_clock_class *
	250	borrow_stream_message_stream_class_default_clock_class(
	251	const struct bt_message *msg)
	252	{
	253	struct bt_message_stream stream_msg = (void ) msg;
	254
	255	BT_ASSERT_DBG(msg);
	256	return stream_msg->stream->class->default_clock_class;
	257	}
	258
	259	BT_EXPORT
	260	const struct bt_clock_class *
	261	bt_message_stream_beginning_borrow_stream_class_default_clock_class_const(
	262	const struct bt_message *msg)
	263	{
	264	BT_ASSERT_PRE_DEV_MSG_NON_NULL(msg);
	265	BT_ASSERT_PRE_DEV_MSG_IS_STREAM_BEGINNING(msg);
	266	return borrow_stream_message_stream_class_default_clock_class(msg);
	267	}
	268
	269	BT_EXPORT
	270	const struct bt_clock_class *
	271	bt_message_stream_end_borrow_stream_class_default_clock_class_const(
	272	const struct bt_message *msg)
	273	{
	274	BT_ASSERT_PRE_DEV_MSG_NON_NULL(msg);
	275	BT_ASSERT_PRE_DEV_MSG_IS_STREAM_END(msg);
	276	return borrow_stream_message_stream_class_default_clock_class(msg);
	277	}