[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_beginning_destroy(struct bt_object *obj)
{
	struct bt_notification_stream_beginning *notification =
			(struct bt_notification_stream_beginning *) 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_beginning_create(
		struct bt_self_notification_iterator *self_notif_iter,
		struct bt_stream *stream)
{
	struct bt_notification_stream_beginning *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_beginning, 1);
	if (!notification) {
		BT_LOGE_STR("Failed to allocate one stream beginning notification.");
		goto error;
	}

	bt_notification_init(&notification->parent,
			BT_NOTIFICATION_TYPE_STREAM_BEGINNING,
			bt_notification_stream_beginning_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_beginning_borrow_stream(
		struct bt_notification *notification)
{
	struct bt_notification_stream_beginning *stream_begin;

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

const struct bt_stream *bt_notification_stream_beginning_borrow_stream_const(
		const struct bt_notification *notification)
{
	return bt_notification_stream_beginning_borrow_stream(
		(void *) notification);
}

void bt_notification_stream_beginning_set_default_clock_value(
		struct bt_notification *notif,
		uint64_t value_cycles)
{
	struct bt_notification_stream_beginning *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_BEGINNING);
	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_beginning_borrow_default_clock_value(
		struct bt_notification *notif)
{
	struct bt_notification_stream_beginning *stream_begin = (void *) notif;

	BT_ASSERT_PRE_NON_NULL(notif, "Notification");
	BT_ASSERT_PRE_NOTIF_IS_TYPE(notif, BT_NOTIFICATION_TYPE_STREAM_BEGINNING);
	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/notification-stream.h>
	34	#include <babeltrace/graph/notification-stream-const.h>
	35	#include <babeltrace/graph/notification-stream-internal.h>
	36	#include <babeltrace/assert-internal.h>
	37	#include <babeltrace/object.h>
	38	#include <inttypes.h>
	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
	46	BT_LIB_LOGD("Destroying stream end notification: %!+n",
	47	notification);
	48	BT_LIB_LOGD("Putting stream: %!+s", notification->stream);
	49	BT_OBJECT_PUT_REF_AND_RESET(notification->stream);
	50
	51	if (notification->default_cv) {
	52	bt_clock_value_recycle(notification->default_cv);
	53	notification->default_cv = NULL;
	54	}
	55
	56	g_free(notification);
	57	}
	58
	59	struct bt_notification *bt_notification_stream_end_create(
	60	struct bt_self_notification_iterator *self_notif_iter,
	61	struct bt_stream *stream)
	62	{
	63	struct bt_notification_stream_end *notification;
	64	struct bt_stream_class *stream_class;
	65
	66	BT_ASSERT_PRE_NON_NULL(self_notif_iter, "Notification iterator");
	67	BT_ASSERT_PRE_NON_NULL(stream, "Stream");
	68	stream_class = bt_stream_borrow_class(stream);
	69	BT_ASSERT(stream_class);
	70	BT_LIB_LOGD("Creating stream end notification object: "
	71	"%![stream-]+s, %![sc-]+S", stream, stream_class);
	72	notification = g_new0(struct bt_notification_stream_end, 1);
	73	if (!notification) {
	74	BT_LOGE_STR("Failed to allocate one stream end notification.");
	75	goto error;
	76	}
	77
	78	bt_notification_init(&notification->parent,
	79	BT_NOTIFICATION_TYPE_STREAM_END,
	80	bt_notification_stream_end_destroy, NULL);
	81	notification->stream = stream;
	82	bt_object_get_no_null_check(notification->stream);
	83	BT_LIB_LOGD("Created stream end notification object: "
	84	"%![notif-]+n, %![stream-]+s, %![sc-]+S", notification,
	85	stream, stream_class);
	86
	87	return (void *) &notification->parent;
	88	error:
	89	return NULL;
	90	}
	91
	92	struct bt_stream *bt_notification_stream_end_borrow_stream(
	93	struct bt_notification *notification)
	94	{
	95	struct bt_notification_stream_end *stream_end;
	96
	97	BT_ASSERT_PRE_NON_NULL(notification, "Notification");
	98	BT_ASSERT_PRE_NOTIF_IS_TYPE(notification,
	99	BT_NOTIFICATION_TYPE_STREAM_END);
	100	stream_end = (void *) notification;
	101	return stream_end->stream;
	102	}
	103
	104	const struct bt_stream *bt_notification_stream_end_borrow_stream_const(
	105	const struct bt_notification *notification)
	106	{
	107	return bt_notification_stream_end_borrow_stream(
	108	(void *) notification);
	109	}
	110
	111	void bt_notification_stream_end_set_default_clock_value(
	112	struct bt_notification *notif, uint64_t value_cycles)
	113	{
	114	struct bt_notification_stream_end se_notif = (void ) notif;
	115
	116	BT_ASSERT_PRE_NON_NULL(notif, "Notification");
	117	BT_ASSERT_PRE_HOT(notif, "Notification", ": %!+n", notif);
	118	BT_ASSERT_PRE_NOTIF_IS_TYPE(notif, BT_NOTIFICATION_TYPE_STREAM_END);
	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
	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);
	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);
	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;
	136
	137	BT_ASSERT_PRE_NON_NULL(notif, "Notification");
	138	BT_ASSERT_PRE_NOTIF_IS_TYPE(notif, BT_NOTIFICATION_TYPE_STREAM_END);
	139	return stream_end->default_cv;
	140	}
	141
	142	static
	143	void bt_notification_stream_beginning_destroy(struct bt_object *obj)
	144	{
	145	struct bt_notification_stream_beginning *notification =
	146	(struct bt_notification_stream_beginning *) obj;
	147
	148	BT_LIB_LOGD("Destroying stream beginning notification: %!+n",
	149	notification);
	150	BT_LIB_LOGD("Putting stream: %!+s", notification->stream);
	151	BT_OBJECT_PUT_REF_AND_RESET(notification->stream);
	152
	153	if (notification->default_cv) {
	154	bt_clock_value_recycle(notification->default_cv);
	155	notification->default_cv = NULL;
	156	}
	157
	158	g_free(notification);
	159	}
	160
	161	struct bt_notification *bt_notification_stream_beginning_create(
	162	struct bt_self_notification_iterator *self_notif_iter,
	163	struct bt_stream *stream)
	164	{
	165	struct bt_notification_stream_beginning *notification;
	166	struct bt_stream_class *stream_class;
	167
	168	BT_ASSERT_PRE_NON_NULL(self_notif_iter, "Notification iterator");
	169	BT_ASSERT_PRE_NON_NULL(stream, "Stream");
	170	stream_class = bt_stream_borrow_class(stream);
	171	BT_ASSERT(stream_class);
	172	BT_LIB_LOGD("Creating stream beginning notification object: "
	173	"%![stream-]+s, %![sc-]+S", stream, stream_class);
	174	notification = g_new0(struct bt_notification_stream_beginning, 1);
	175	if (!notification) {
	176	BT_LOGE_STR("Failed to allocate one stream beginning notification.");
	177	goto error;
	178	}
	179
	180	bt_notification_init(&notification->parent,
	181	BT_NOTIFICATION_TYPE_STREAM_BEGINNING,
	182	bt_notification_stream_beginning_destroy, NULL);
	183	notification->stream = stream;
	184	bt_object_get_no_null_check(notification->stream);
	185	BT_LIB_LOGD("Created stream beginning notification object: "
	186	"%![notif-]+n, %![stream-]+s, %![sc-]+S", notification,
	187	stream, stream_class);
	188	return (void *) &notification->parent;
	189	error:
	190	return NULL;
	191	}
	192
	193	struct bt_stream *bt_notification_stream_beginning_borrow_stream(
	194	struct bt_notification *notification)
	195	{
	196	struct bt_notification_stream_beginning *stream_begin;
	197
	198	BT_ASSERT_PRE_NON_NULL(notification, "Notification");
	199	BT_ASSERT_PRE_NOTIF_IS_TYPE(notification,
	200	BT_NOTIFICATION_TYPE_STREAM_BEGINNING);
	201	stream_begin = (void *) notification;
	202	return stream_begin->stream;
	203	}
	204
	205	const struct bt_stream *bt_notification_stream_beginning_borrow_stream_const(
	206	const struct bt_notification *notification)
	207	{
	208	return bt_notification_stream_beginning_borrow_stream(
	209	(void *) notification);
	210	}
	211
	212	void bt_notification_stream_beginning_set_default_clock_value(
	213	struct bt_notification *notif,
	214	uint64_t value_cycles)
	215	{
	216	struct bt_notification_stream_beginning sb_notif = (void ) notif;
	217
	218	BT_ASSERT_PRE_NON_NULL(notif, "Notification");
	219	BT_ASSERT_PRE_HOT(notif, "Notification", ": %!+n", notif);
	220	BT_ASSERT_PRE_NOTIF_IS_TYPE(notif, BT_NOTIFICATION_TYPE_STREAM_BEGINNING);
	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
	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);
	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);
	232	}
	233
	234	struct bt_clock_value *bt_notification_stream_beginning_borrow_default_clock_value(
	235	struct bt_notification *notif)
	236	{
	237	struct bt_notification_stream_beginning stream_begin = (void ) notif;
	238
	239	BT_ASSERT_PRE_NON_NULL(notif, "Notification");
	240	BT_ASSERT_PRE_NOTIF_IS_TYPE(notif, BT_NOTIFICATION_TYPE_STREAM_BEGINNING);
	241	return stream_begin->default_cv;
	242	}