[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/notification-stream.h>
#include <babeltrace/graph/notification-stream-const.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_notification *bt_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_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 = (void *) notification;
	return stream_end->stream;
}

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

void bt_notification_stream_end_set_default_clock_value(
		struct bt_notification *notif, uint64_t value_cycles)
{
	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_notification *bt_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_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 = (void *) notification;
	return stream_begin->stream;
}

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

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