[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_private_stream *priv_stream)
{
	struct bt_stream *stream = (void *) priv_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_notification_stream_end_borrow_stream(
		struct bt_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 = container_of(notification,
			struct bt_notification_stream_end, parent);
	return stream_end->stream;
}

struct bt_private_stream *bt_private_notification_stream_end_borrow_stream(
		struct bt_private_notification *notification)
{
	return (void *) bt_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_private_stream *priv_stream)
{
	struct bt_stream *stream = (void *) priv_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_notification_stream_begin_borrow_stream(
		struct bt_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 = container_of(notification,
			struct bt_notification_stream_begin, parent);
	return stream_begin->stream;
}

struct bt_private_stream *bt_private_notification_stream_begin_borrow_stream(
		struct bt_private_notification *notification)
{
	return (void *) bt_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
043e2020	1	/*
043e2020 JG	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
d229f56b PP	25	#define BT_LOG_TAG "NOTIF-STREAM"
	26	#include <babeltrace/lib-logging-internal.h>
	27
8fc063a2	28	#include <babeltrace/assert-pre-internal.h>
3d9990ac	29	#include <babeltrace/compiler-internal.h>
108b91d0 PP	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>
9e550e5f	33	#include <babeltrace/graph/private-notification-stream.h>
b2e0c907	34	#include <babeltrace/graph/notification-stream-internal.h>
8b45963b	35	#include <babeltrace/assert-internal.h>
9e550e5f	36	#include <babeltrace/object.h>
d229f56b	37	#include <inttypes.h>
043e2020 JG	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
834e9996	45	BT_LIB_LOGD("Destroying stream end notification: %!+n",
d229f56b	46	notification);
834e9996	47	BT_LIB_LOGD("Putting stream: %!+s", notification->stream);
8138bfe1	48	BT_OBJECT_PUT_REF_AND_RESET(notification->stream);
7b33a0e0 PP	49
	50	if (notification->default_cv) {
	51	bt_clock_value_recycle(notification->default_cv);
834e9996	52	notification->default_cv = NULL;
7b33a0e0 PP	53	}
7b33a0e0 PP	54
043e2020 JG	55	g_free(notification);
	56	}
	57
9e550e5f	58	struct bt_private_notification *bt_private_notification_stream_end_create(
834e9996	59	struct bt_self_notification_iterator *self_notif_iter,
9e550e5f	60	struct bt_private_stream *priv_stream)
043e2020	61	{
9e550e5f	62	struct bt_stream stream = (void ) priv_stream;
043e2020	63	struct bt_notification_stream_end *notification;
839d52a5	64	struct bt_stream_class *stream_class;
043e2020	65
834e9996	66	BT_ASSERT_PRE_NON_NULL(self_notif_iter, "Notification iterator");
8b45963b	67	BT_ASSERT_PRE_NON_NULL(stream, "Stream");
8deee039	68	stream_class = bt_stream_borrow_class(stream);
8b45963b	69	BT_ASSERT(stream_class);
834e9996 PP	70	BT_LIB_LOGD("Creating stream end notification object: "
834e9996 PP	71	"%![stream-]+s, %![sc-]+S", stream, stream_class);
043e2020	72	notification = g_new0(struct bt_notification_stream_end, 1);
d229f56b PP	73	if (!notification) {
	74	BT_LOGE_STR("Failed to allocate one stream end notification.");
	75	goto error;
	76	}
	77
043e2020 JG	78	bt_notification_init(&notification->parent,
043e2020 JG	79	BT_NOTIFICATION_TYPE_STREAM_END,
f7c3ac09	80	bt_notification_stream_end_destroy, NULL);
4b70020d PP	81	notification->stream = stream;
4b70020d PP	82	bt_object_get_no_null_check(notification->stream);
834e9996 PP	83	BT_LIB_LOGD("Created stream end notification object: "
	84	"%![notif-]+n, %![stream-]+s, %![sc-]+S", notification,
	85	stream, stream_class);
9e550e5f PP	86
9e550e5f PP	87	return (void *) &notification->parent;
043e2020 JG	88	error:
	89	return NULL;
	90	}
	91
5fe68922	92	struct bt_stream *bt_notification_stream_end_borrow_stream(
043e2020 JG	93	struct bt_notification *notification)
	94	{
	95	struct bt_notification_stream_end *stream_end;
	96
8b45963b PP	97	BT_ASSERT_PRE_NON_NULL(notification, "Notification");
	98	BT_ASSERT_PRE_NOTIF_IS_TYPE(notification,
	99	BT_NOTIFICATION_TYPE_STREAM_END);
043e2020 JG	100	stream_end = container_of(notification,
043e2020 JG	101	struct bt_notification_stream_end, parent);
5fe68922	102	return stream_end->stream;
043e2020	103	}
3230ee6b	104
9e550e5f PP	105	struct bt_private_stream *bt_private_notification_stream_end_borrow_stream(
	106	struct bt_private_notification *notification)
	107	{
	108	return (void *) bt_notification_stream_end_borrow_stream(
	109	(void *) notification);
	110	}
	111
c8bbf821	112	void bt_private_notification_stream_end_set_default_clock_value(
9e550e5f PP	113	struct bt_private_notification *priv_notif,
9e550e5f PP	114	uint64_t value_cycles)
8fc063a2	115	{
9e550e5f	116	struct bt_notification notif = (void ) priv_notif;
7b33a0e0	117	struct bt_notification_stream_end se_notif = (void ) notif;
8fc063a2 PP	118
8fc063a2 PP	119	BT_ASSERT_PRE_NON_NULL(notif, "Notification");
8fc063a2 PP	120	BT_ASSERT_PRE_HOT(notif, "Notification", ": %!+n", notif);
8fc063a2 PP	121	BT_ASSERT_PRE_NOTIF_IS_TYPE(notif, BT_NOTIFICATION_TYPE_STREAM_END);
7b33a0e0 PP	122	BT_ASSERT_PRE(se_notif->stream->class->default_clock_class,
	123	"Notification's stream class has no default clock class: "
	124	"%![notif-]+n, %![sc-]+S", notif, se_notif->stream->class);
	125
c8bbf821 PP	126	/* TODO: have the object already created */
	127	se_notif->default_cv = bt_clock_value_create(
	128	se_notif->stream->class->default_clock_class);
	129	BT_ASSERT(se_notif->default_cv);
7b33a0e0 PP	130	bt_clock_value_set_value_inline(se_notif->default_cv, value_cycles);
	131	BT_LIB_LOGV("Set notification's default clock value: %![notif-]+n, "
	132	"value=%" PRIu64, value_cycles);
8fc063a2 PP	133	}
	134
	135	struct bt_clock_value *bt_notification_stream_end_borrow_default_clock_value(
	136	struct bt_notification *notif)
	137	{
	138	struct bt_notification_stream_end stream_end = (void ) notif;
8fc063a2 PP	139
	140	BT_ASSERT_PRE_NON_NULL(notif, "Notification");
	141	BT_ASSERT_PRE_NOTIF_IS_TYPE(notif, BT_NOTIFICATION_TYPE_STREAM_END);
7b33a0e0	142	return stream_end->default_cv;
8fc063a2 PP	143	}
8fc063a2 PP	144
3230ee6b PP	145	static
	146	void bt_notification_stream_begin_destroy(struct bt_object *obj)
	147	{
	148	struct bt_notification_stream_begin *notification =
	149	(struct bt_notification_stream_begin *) obj;
	150
834e9996	151	BT_LIB_LOGD("Destroying stream beginning notification: %!+n",
d229f56b	152	notification);
834e9996	153	BT_LIB_LOGD("Putting stream: %!+s", notification->stream);
8138bfe1	154	BT_OBJECT_PUT_REF_AND_RESET(notification->stream);
7b33a0e0 PP	155
	156	if (notification->default_cv) {
	157	bt_clock_value_recycle(notification->default_cv);
834e9996	158	notification->default_cv = NULL;
7b33a0e0 PP	159	}
7b33a0e0 PP	160
3230ee6b PP	161	g_free(notification);
	162	}
	163
9e550e5f	164	struct bt_private_notification *bt_private_notification_stream_begin_create(
834e9996	165	struct bt_self_notification_iterator *self_notif_iter,
9e550e5f	166	struct bt_private_stream *priv_stream)
3230ee6b	167	{
9e550e5f	168	struct bt_stream stream = (void ) priv_stream;
3230ee6b	169	struct bt_notification_stream_begin *notification;
839d52a5	170	struct bt_stream_class *stream_class;
3230ee6b	171
834e9996	172	BT_ASSERT_PRE_NON_NULL(self_notif_iter, "Notification iterator");
8b45963b	173	BT_ASSERT_PRE_NON_NULL(stream, "Stream");
8deee039	174	stream_class = bt_stream_borrow_class(stream);
8b45963b	175	BT_ASSERT(stream_class);
834e9996 PP	176	BT_LIB_LOGD("Creating stream beginning notification object: "
834e9996 PP	177	"%![stream-]+s, %![sc-]+S", stream, stream_class);
3230ee6b	178	notification = g_new0(struct bt_notification_stream_begin, 1);
d229f56b PP	179	if (!notification) {
	180	BT_LOGE_STR("Failed to allocate one stream beginning notification.");
	181	goto error;
	182	}
	183
3230ee6b PP	184	bt_notification_init(&notification->parent,
3230ee6b PP	185	BT_NOTIFICATION_TYPE_STREAM_BEGIN,
f7c3ac09	186	bt_notification_stream_begin_destroy, NULL);
4b70020d PP	187	notification->stream = stream;
4b70020d PP	188	bt_object_get_no_null_check(notification->stream);
834e9996 PP	189	BT_LIB_LOGD("Created stream beginning notification object: "
	190	"%![notif-]+n, %![stream-]+s, %![sc-]+S", notification,
	191	stream, stream_class);
9e550e5f	192	return (void *) &notification->parent;
3230ee6b PP	193	error:
	194	return NULL;
	195	}
	196
5fe68922	197	struct bt_stream *bt_notification_stream_begin_borrow_stream(
3230ee6b PP	198	struct bt_notification *notification)
	199	{
	200	struct bt_notification_stream_begin *stream_begin;
	201
8b45963b PP	202	BT_ASSERT_PRE_NON_NULL(notification, "Notification");
	203	BT_ASSERT_PRE_NOTIF_IS_TYPE(notification,
	204	BT_NOTIFICATION_TYPE_STREAM_BEGIN);
3230ee6b PP	205	stream_begin = container_of(notification,
3230ee6b PP	206	struct bt_notification_stream_begin, parent);
5fe68922	207	return stream_begin->stream;
3230ee6b	208	}
8fc063a2	209
9e550e5f PP	210	struct bt_private_stream *bt_private_notification_stream_begin_borrow_stream(
	211	struct bt_private_notification *notification)
	212	{
	213	return (void *) bt_notification_stream_begin_borrow_stream(
	214	(void *) notification);
	215	}
	216
c8bbf821	217	void bt_private_notification_stream_begin_set_default_clock_value(
9e550e5f PP	218	struct bt_private_notification *priv_notif,
9e550e5f PP	219	uint64_t value_cycles)
8fc063a2	220	{
9e550e5f	221	struct bt_notification notif = (void ) priv_notif;
7b33a0e0	222	struct bt_notification_stream_begin sb_notif = (void ) notif;
8fc063a2 PP	223
8fc063a2 PP	224	BT_ASSERT_PRE_NON_NULL(notif, "Notification");
8fc063a2 PP	225	BT_ASSERT_PRE_HOT(notif, "Notification", ": %!+n", notif);
8fc063a2 PP	226	BT_ASSERT_PRE_NOTIF_IS_TYPE(notif, BT_NOTIFICATION_TYPE_STREAM_BEGIN);
7b33a0e0 PP	227	BT_ASSERT_PRE(sb_notif->stream->class->default_clock_class,
	228	"Notification's stream class has no default clock class: "
	229	"%![notif-]+n, %![sc-]+S", notif, sb_notif->stream->class);
	230
c8bbf821 PP	231	/* TODO: have the object already created */
	232	sb_notif->default_cv = bt_clock_value_create(
	233	sb_notif->stream->class->default_clock_class);
	234	BT_ASSERT(sb_notif->default_cv);
7b33a0e0 PP	235	bt_clock_value_set_value_inline(sb_notif->default_cv, value_cycles);
	236	BT_LIB_LOGV("Set notification's default clock value: %![notif-]+n, "
	237	"value=%" PRIu64, value_cycles);
8fc063a2 PP	238	}
	239
	240	struct bt_clock_value *bt_notification_stream_begin_borrow_default_clock_value(
	241	struct bt_notification *notif)
	242	{
	243	struct bt_notification_stream_begin stream_begin = (void ) notif;
8fc063a2 PP	244
	245	BT_ASSERT_PRE_NON_NULL(notif, "Notification");
	246	BT_ASSERT_PRE_NOTIF_IS_TYPE(notif, BT_NOTIFICATION_TYPE_STREAM_BEGIN);
7b33a0e0	247	return stream_begin->default_cv;
8fc063a2	248	}