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