[babeltrace.git] / lib / graph / notification / stream.c

/*
 * Copyright 2016 Jérémie Galarneau <jeremie.galarneau@efficios.com>
 *
 * Author: 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 "NOTIF-STREAM"
#include <babeltrace/lib-logging-internal.h>

#include <babeltrace/assert-pre-internal.h>
#include <babeltrace/compiler-internal.h>
#include <babeltrace/trace-ir/stream-internal.h>
#include <babeltrace/trace-ir/stream-class.h>
#include <babeltrace/trace-ir/stream-class-internal.h>
#include <babeltrace/graph/private-notification-stream.h>
#include <babeltrace/graph/notification-stream-internal.h>
#include <babeltrace/assert-internal.h>
#include <babeltrace/object.h>
#include <inttypes.h>

static
void bt_notification_stream_end_destroy(struct bt_object *obj)
{
	struct bt_notification_stream_end *notification =
			(struct bt_notification_stream_end *) obj;

	BT_LIB_LOGD("Destroying stream end notification: %!+n",
		notification);
	BT_LIB_LOGD("Putting stream: %!+s", notification->stream);
	BT_OBJECT_PUT_REF_AND_RESET(notification->stream);

	if (notification->default_cv) {
		bt_clock_value_recycle(notification->default_cv);
		notification->default_cv = NULL;
	}

	g_free(notification);
}

struct bt_private_notification *bt_private_notification_stream_end_create(
		struct bt_self_notification_iterator *self_notif_iter,
		struct bt_stream *stream)
{
	struct bt_notification_stream_end *notification;
	struct bt_stream_class *stream_class;

	BT_ASSERT_PRE_NON_NULL(self_notif_iter, "Notification iterator");
	BT_ASSERT_PRE_NON_NULL(stream, "Stream");
	stream_class = bt_stream_borrow_class(stream);
	BT_ASSERT(stream_class);
	BT_LIB_LOGD("Creating stream end notification object: "
		"%![stream-]+s, %![sc-]+S", stream, stream_class);
	notification = g_new0(struct bt_notification_stream_end, 1);
	if (!notification) {
		BT_LOGE_STR("Failed to allocate one stream end notification.");
		goto error;
	}

	bt_notification_init(&notification->parent,
			BT_NOTIFICATION_TYPE_STREAM_END,
			bt_notification_stream_end_destroy, NULL);
	notification->stream = stream;
	bt_object_get_no_null_check(notification->stream);
	BT_LIB_LOGD("Created stream end notification object: "
		"%![notif-]+n, %![stream-]+s, %![sc-]+S", notification,
		stream, stream_class);

	return (void *) &notification->parent;
error:
	return NULL;
}

struct bt_stream *bt_private_notification_stream_end_borrow_stream(
		struct bt_private_notification *notification)
{
	struct bt_notification_stream_end *stream_end;

	BT_ASSERT_PRE_NON_NULL(notification, "Notification");
	BT_ASSERT_PRE_NOTIF_IS_TYPE(notification,
		BT_NOTIFICATION_TYPE_STREAM_END);
	stream_end = (void *) notification;
	return stream_end->stream;
}

const struct bt_stream *bt_notification_stream_end_borrow_stream(
		struct bt_notification *notification)
{
	return bt_private_notification_stream_end_borrow_stream(
		(void *) notification);
}

void bt_private_notification_stream_end_set_default_clock_value(
		struct bt_private_notification *priv_notif,
		uint64_t value_cycles)
{
	struct bt_notification *notif = (void *) priv_notif;
	struct bt_notification_stream_end *se_notif = (void *) notif;

	BT_ASSERT_PRE_NON_NULL(notif, "Notification");
	BT_ASSERT_PRE_HOT(notif, "Notification", ": %!+n", notif);
	BT_ASSERT_PRE_NOTIF_IS_TYPE(notif, BT_NOTIFICATION_TYPE_STREAM_END);
	BT_ASSERT_PRE(se_notif->stream->class->default_clock_class,
		"Notification's stream class has no default clock class: "
		"%![notif-]+n, %![sc-]+S", notif, se_notif->stream->class);

	/* TODO: have the object already created */
	se_notif->default_cv = bt_clock_value_create(
		se_notif->stream->class->default_clock_class);
	BT_ASSERT(se_notif->default_cv);
	bt_clock_value_set_value_inline(se_notif->default_cv, value_cycles);
	BT_LIB_LOGV("Set notification's default clock value: %![notif-]+n, "
		"value=%" PRIu64, value_cycles);
}

struct bt_clock_value *bt_notification_stream_end_borrow_default_clock_value(
		struct bt_notification *notif)
{
	struct bt_notification_stream_end *stream_end = (void *) notif;

	BT_ASSERT_PRE_NON_NULL(notif, "Notification");
	BT_ASSERT_PRE_NOTIF_IS_TYPE(notif, BT_NOTIFICATION_TYPE_STREAM_END);
	return stream_end->default_cv;
}

static
void bt_notification_stream_begin_destroy(struct bt_object *obj)
{
	struct bt_notification_stream_begin *notification =
			(struct bt_notification_stream_begin *) obj;

	BT_LIB_LOGD("Destroying stream beginning notification: %!+n",
		notification);
	BT_LIB_LOGD("Putting stream: %!+s", notification->stream);
	BT_OBJECT_PUT_REF_AND_RESET(notification->stream);

	if (notification->default_cv) {
		bt_clock_value_recycle(notification->default_cv);
		notification->default_cv = NULL;
	}

	g_free(notification);
}

struct bt_private_notification *bt_private_notification_stream_begin_create(
		struct bt_self_notification_iterator *self_notif_iter,
		struct bt_stream *stream)
{
	struct bt_notification_stream_begin *notification;
	struct bt_stream_class *stream_class;

	BT_ASSERT_PRE_NON_NULL(self_notif_iter, "Notification iterator");
	BT_ASSERT_PRE_NON_NULL(stream, "Stream");
	stream_class = bt_stream_borrow_class(stream);
	BT_ASSERT(stream_class);
	BT_LIB_LOGD("Creating stream beginning notification object: "
		"%![stream-]+s, %![sc-]+S", stream, stream_class);
	notification = g_new0(struct bt_notification_stream_begin, 1);
	if (!notification) {
		BT_LOGE_STR("Failed to allocate one stream beginning notification.");
		goto error;
	}

	bt_notification_init(&notification->parent,
			BT_NOTIFICATION_TYPE_STREAM_BEGIN,
			bt_notification_stream_begin_destroy, NULL);
	notification->stream = stream;
	bt_object_get_no_null_check(notification->stream);
	BT_LIB_LOGD("Created stream beginning notification object: "
		"%![notif-]+n, %![stream-]+s, %![sc-]+S", notification,
		stream, stream_class);
	return (void *) &notification->parent;
error:
	return NULL;
}

struct bt_stream *bt_private_notification_stream_begin_borrow_stream(
		struct bt_private_notification *notification)
{
	struct bt_notification_stream_begin *stream_begin;

	BT_ASSERT_PRE_NON_NULL(notification, "Notification");
	BT_ASSERT_PRE_NOTIF_IS_TYPE(notification,
		BT_NOTIFICATION_TYPE_STREAM_BEGIN);
	stream_begin = (void *) notification;
	return stream_begin->stream;
}

const struct bt_stream *bt_notification_stream_begin_borrow_stream(
		struct bt_notification *notification)
{
	return bt_private_notification_stream_begin_borrow_stream(
		(void *) notification);
}

void bt_private_notification_stream_begin_set_default_clock_value(
		struct bt_private_notification *priv_notif,
		uint64_t value_cycles)
{
	struct bt_notification *notif = (void *) priv_notif;
	struct bt_notification_stream_begin *sb_notif = (void *) notif;

	BT_ASSERT_PRE_NON_NULL(notif, "Notification");
	BT_ASSERT_PRE_HOT(notif, "Notification", ": %!+n", notif);
	BT_ASSERT_PRE_NOTIF_IS_TYPE(notif, BT_NOTIFICATION_TYPE_STREAM_BEGIN);
	BT_ASSERT_PRE(sb_notif->stream->class->default_clock_class,
		"Notification's stream class has no default clock class: "
		"%![notif-]+n, %![sc-]+S", notif, sb_notif->stream->class);

	/* TODO: have the object already created */
	sb_notif->default_cv = bt_clock_value_create(
		sb_notif->stream->class->default_clock_class);
	BT_ASSERT(sb_notif->default_cv);
	bt_clock_value_set_value_inline(sb_notif->default_cv, value_cycles);
	BT_LIB_LOGV("Set notification's default clock value: %![notif-]+n, "
		"value=%" PRIu64, value_cycles);
}

struct bt_clock_value *bt_notification_stream_begin_borrow_default_clock_value(
		struct bt_notification *notif)
{
	struct bt_notification_stream_begin *stream_begin = (void *) notif;

	BT_ASSERT_PRE_NON_NULL(notif, "Notification");
	BT_ASSERT_PRE_NOTIF_IS_TYPE(notif, BT_NOTIFICATION_TYPE_STREAM_BEGIN);
	return stream_begin->default_cv;
}
Commit	Line	Data
	1	/*
	2	* Copyright 2016 Jérémie Galarneau <jeremie.galarneau@efficios.com>
	3	*
	4	* Author: Jérémie Galarneau <jeremie.galarneau@efficios.com>
	5	*
	6	* Permission is hereby granted, free of charge, to any person obtaining a copy
	7	* of this software and associated documentation files (the "Software"), to deal
	8	* in the Software without restriction, including without limitation the rights
	9	* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
	10	* copies of the Software, and to permit persons to whom the Software is
	11	* furnished to do so, subject to the following conditions:
	12	*
	13	* The above copyright notice and this permission notice shall be included in
	14	* all copies or substantial portions of the Software.
	15	*
	16	* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
	17	* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
	18	* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
	19	* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
	20	* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
	21	* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
	22	* SOFTWARE.
	23	*/
	24
	25	#define BT_LOG_TAG "NOTIF-STREAM"
	26	#include <babeltrace/lib-logging-internal.h>
	27
	28	#include <babeltrace/assert-pre-internal.h>
	29	#include <babeltrace/compiler-internal.h>
	30	#include <babeltrace/trace-ir/stream-internal.h>
	31	#include <babeltrace/trace-ir/stream-class.h>
	32	#include <babeltrace/trace-ir/stream-class-internal.h>
	33	#include <babeltrace/graph/private-notification-stream.h>
	34	#include <babeltrace/graph/notification-stream-internal.h>
	35	#include <babeltrace/assert-internal.h>
	36	#include <babeltrace/object.h>
	37	#include <inttypes.h>
	38
	39	static
	40	void bt_notification_stream_end_destroy(struct bt_object *obj)
	41	{
	42	struct bt_notification_stream_end *notification =
	43	(struct bt_notification_stream_end *) obj;
	44
	45	BT_LIB_LOGD("Destroying stream end notification: %!+n",
	46	notification);
	47	BT_LIB_LOGD("Putting stream: %!+s", notification->stream);
	48	BT_OBJECT_PUT_REF_AND_RESET(notification->stream);
	49
	50	if (notification->default_cv) {
	51	bt_clock_value_recycle(notification->default_cv);
	52	notification->default_cv = NULL;
	53	}
	54
	55	g_free(notification);
	56	}
	57
	58	struct bt_private_notification *bt_private_notification_stream_end_create(
	59	struct bt_self_notification_iterator *self_notif_iter,
	60	struct bt_stream *stream)
	61	{
	62	struct bt_notification_stream_end *notification;
	63	struct bt_stream_class *stream_class;
	64
	65	BT_ASSERT_PRE_NON_NULL(self_notif_iter, "Notification iterator");
	66	BT_ASSERT_PRE_NON_NULL(stream, "Stream");
	67	stream_class = bt_stream_borrow_class(stream);
	68	BT_ASSERT(stream_class);
	69	BT_LIB_LOGD("Creating stream end notification object: "
	70	"%![stream-]+s, %![sc-]+S", stream, stream_class);
	71	notification = g_new0(struct bt_notification_stream_end, 1);
	72	if (!notification) {
	73	BT_LOGE_STR("Failed to allocate one stream end notification.");
	74	goto error;
	75	}
	76
	77	bt_notification_init(&notification->parent,
	78	BT_NOTIFICATION_TYPE_STREAM_END,
	79	bt_notification_stream_end_destroy, NULL);
	80	notification->stream = stream;
	81	bt_object_get_no_null_check(notification->stream);
	82	BT_LIB_LOGD("Created stream end notification object: "
	83	"%![notif-]+n, %![stream-]+s, %![sc-]+S", notification,
	84	stream, stream_class);
	85
	86	return (void *) &notification->parent;
	87	error:
	88	return NULL;
	89	}
	90
	91	struct bt_stream *bt_private_notification_stream_end_borrow_stream(
	92	struct bt_private_notification *notification)
	93	{
	94	struct bt_notification_stream_end *stream_end;
	95
	96	BT_ASSERT_PRE_NON_NULL(notification, "Notification");
	97	BT_ASSERT_PRE_NOTIF_IS_TYPE(notification,
	98	BT_NOTIFICATION_TYPE_STREAM_END);
	99	stream_end = (void *) notification;
	100	return stream_end->stream;
	101	}
	102
	103	const struct bt_stream *bt_notification_stream_end_borrow_stream(
	104	struct bt_notification *notification)
	105	{
	106	return bt_private_notification_stream_end_borrow_stream(
	107	(void *) notification);
	108	}
	109
	110	void bt_private_notification_stream_end_set_default_clock_value(
	111	struct bt_private_notification *priv_notif,
	112	uint64_t value_cycles)
	113	{
	114	struct bt_notification notif = (void ) priv_notif;
	115	struct bt_notification_stream_end se_notif = (void ) notif;
	116
	117	BT_ASSERT_PRE_NON_NULL(notif, "Notification");
	118	BT_ASSERT_PRE_HOT(notif, "Notification", ": %!+n", notif);
	119	BT_ASSERT_PRE_NOTIF_IS_TYPE(notif, BT_NOTIFICATION_TYPE_STREAM_END);
	120	BT_ASSERT_PRE(se_notif->stream->class->default_clock_class,
	121	"Notification's stream class has no default clock class: "
	122	"%![notif-]+n, %![sc-]+S", notif, se_notif->stream->class);
	123
	124	/* TODO: have the object already created */
	125	se_notif->default_cv = bt_clock_value_create(
	126	se_notif->stream->class->default_clock_class);
	127	BT_ASSERT(se_notif->default_cv);
	128	bt_clock_value_set_value_inline(se_notif->default_cv, value_cycles);
	129	BT_LIB_LOGV("Set notification's default clock value: %![notif-]+n, "
	130	"value=%" PRIu64, value_cycles);
	131	}
	132
	133	struct bt_clock_value *bt_notification_stream_end_borrow_default_clock_value(
	134	struct bt_notification *notif)
	135	{
	136	struct bt_notification_stream_end stream_end = (void ) notif;
	137
	138	BT_ASSERT_PRE_NON_NULL(notif, "Notification");
	139	BT_ASSERT_PRE_NOTIF_IS_TYPE(notif, BT_NOTIFICATION_TYPE_STREAM_END);
	140	return stream_end->default_cv;
	141	}
	142
	143	static
	144	void bt_notification_stream_begin_destroy(struct bt_object *obj)
	145	{
	146	struct bt_notification_stream_begin *notification =
	147	(struct bt_notification_stream_begin *) obj;
	148
	149	BT_LIB_LOGD("Destroying stream beginning notification: %!+n",
	150	notification);
	151	BT_LIB_LOGD("Putting stream: %!+s", notification->stream);
	152	BT_OBJECT_PUT_REF_AND_RESET(notification->stream);
	153
	154	if (notification->default_cv) {
	155	bt_clock_value_recycle(notification->default_cv);
	156	notification->default_cv = NULL;
	157	}
	158
	159	g_free(notification);
	160	}
	161
	162	struct bt_private_notification *bt_private_notification_stream_begin_create(
	163	struct bt_self_notification_iterator *self_notif_iter,
	164	struct bt_stream *stream)
	165	{
	166	struct bt_notification_stream_begin *notification;
	167	struct bt_stream_class *stream_class;
	168
	169	BT_ASSERT_PRE_NON_NULL(self_notif_iter, "Notification iterator");
	170	BT_ASSERT_PRE_NON_NULL(stream, "Stream");
	171	stream_class = bt_stream_borrow_class(stream);
	172	BT_ASSERT(stream_class);
	173	BT_LIB_LOGD("Creating stream beginning notification object: "
	174	"%![stream-]+s, %![sc-]+S", stream, stream_class);
	175	notification = g_new0(struct bt_notification_stream_begin, 1);
	176	if (!notification) {
	177	BT_LOGE_STR("Failed to allocate one stream beginning notification.");
	178	goto error;
	179	}
	180
	181	bt_notification_init(&notification->parent,
	182	BT_NOTIFICATION_TYPE_STREAM_BEGIN,
	183	bt_notification_stream_begin_destroy, NULL);
	184	notification->stream = stream;
	185	bt_object_get_no_null_check(notification->stream);
	186	BT_LIB_LOGD("Created stream beginning notification object: "
	187	"%![notif-]+n, %![stream-]+s, %![sc-]+S", notification,
	188	stream, stream_class);
	189	return (void *) &notification->parent;
	190	error:
	191	return NULL;
	192	}
	193
	194	struct bt_stream *bt_private_notification_stream_begin_borrow_stream(
	195	struct bt_private_notification *notification)
	196	{
	197	struct bt_notification_stream_begin *stream_begin;
	198
	199	BT_ASSERT_PRE_NON_NULL(notification, "Notification");
	200	BT_ASSERT_PRE_NOTIF_IS_TYPE(notification,
	201	BT_NOTIFICATION_TYPE_STREAM_BEGIN);
	202	stream_begin = (void *) notification;
	203	return stream_begin->stream;
	204	}
	205
	206	const struct bt_stream *bt_notification_stream_begin_borrow_stream(
	207	struct bt_notification *notification)
	208	{
	209	return bt_private_notification_stream_begin_borrow_stream(
	210	(void *) notification);
	211	}
	212
	213	void bt_private_notification_stream_begin_set_default_clock_value(
	214	struct bt_private_notification *priv_notif,
	215	uint64_t value_cycles)
	216	{
	217	struct bt_notification notif = (void ) priv_notif;
	218	struct bt_notification_stream_begin sb_notif = (void ) notif;
	219
	220	BT_ASSERT_PRE_NON_NULL(notif, "Notification");
	221	BT_ASSERT_PRE_HOT(notif, "Notification", ": %!+n", notif);
	222	BT_ASSERT_PRE_NOTIF_IS_TYPE(notif, BT_NOTIFICATION_TYPE_STREAM_BEGIN);
	223	BT_ASSERT_PRE(sb_notif->stream->class->default_clock_class,
	224	"Notification's stream class has no default clock class: "
	225	"%![notif-]+n, %![sc-]+S", notif, sb_notif->stream->class);
	226
	227	/* TODO: have the object already created */
	228	sb_notif->default_cv = bt_clock_value_create(
	229	sb_notif->stream->class->default_clock_class);
	230	BT_ASSERT(sb_notif->default_cv);
	231	bt_clock_value_set_value_inline(sb_notif->default_cv, value_cycles);
	232	BT_LIB_LOGV("Set notification's default clock value: %![notif-]+n, "
	233	"value=%" PRIu64, value_cycles);
	234	}
	235
	236	struct bt_clock_value *bt_notification_stream_begin_borrow_default_clock_value(
	237	struct bt_notification *notif)
	238	{
	239	struct bt_notification_stream_begin stream_begin = (void ) notif;
	240
	241	BT_ASSERT_PRE_NON_NULL(notif, "Notification");
	242	BT_ASSERT_PRE_NOTIF_IS_TYPE(notif, BT_NOTIFICATION_TYPE_STREAM_BEGIN);
	243	return stream_begin->default_cv;
	244	}