[babeltrace.git] / lib / graph / notification / packet.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-PACKET"
#include <babeltrace/lib-logging-internal.h>

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

BT_HIDDEN
struct bt_notification *bt_notification_packet_begin_new(struct bt_graph *graph)
{
	struct bt_notification_packet_begin *notification;

	notification = g_new0(struct bt_notification_packet_begin, 1);
	if (!notification) {
		BT_LOGE_STR("Failed to allocate one packet beginning notification.");
		goto error;
	}

	bt_notification_init(&notification->parent,
			BT_NOTIFICATION_TYPE_PACKET_BEGIN,
			(bt_object_release_func) bt_notification_packet_begin_recycle,
			graph);
	goto end;

error:
	BT_OBJECT_PUT_REF_AND_RESET(notification);

end:
	return (void *) notification;
}

struct bt_notification *bt_notification_packet_begin_create(
		struct bt_self_notification_iterator *self_notif_iter,
		struct bt_packet *packet)
{
	struct bt_self_component_port_input_notification_iterator *notif_iter =
		(void *) self_notif_iter;
	struct bt_notification_packet_begin *notification = NULL;
	struct bt_stream *stream;
	struct bt_stream_class *stream_class;

	BT_ASSERT_PRE_NON_NULL(notif_iter, "Notification iterator");
	BT_ASSERT_PRE_NON_NULL(packet, "Packet");
	stream = bt_packet_borrow_stream(packet);
	BT_ASSERT(stream);
	stream_class = bt_stream_borrow_class(stream);
	BT_ASSERT(stream_class);
	BT_LIB_LOGD("Creating packet beginning notification object: "
		"%![packet-]+a, %![stream-]+s, %![sc-]+S",
		packet, stream, stream_class);
	notification = (void *) bt_notification_create_from_pool(
		&notif_iter->graph->packet_begin_notif_pool, notif_iter->graph);
	if (!notification) {
		/* bt_notification_create_from_pool() logs errors */
		goto end;
	}

	BT_ASSERT(!notification->packet);
	notification->packet = packet;
	bt_object_get_no_null_check_no_parent_check(
		&notification->packet->base);
	bt_packet_set_is_frozen(packet, true);
	BT_LIB_LOGD("Created packet beginning notification object: "
		"%![notif-]+n, %![packet-]+a, %![stream-]+s, %![sc-]+S",
		notification, packet, stream, stream_class);
	goto end;

end:
	return (void *) notification;
}

BT_HIDDEN
void bt_notification_packet_begin_destroy(struct bt_notification *notif)
{
	struct bt_notification_packet_begin *packet_begin_notif = (void *) notif;

	BT_LIB_LOGD("Destroying packet beginning notification: %!+n", notif);
	BT_LIB_LOGD("Putting packet: %!+a", packet_begin_notif->packet);
	BT_OBJECT_PUT_REF_AND_RESET(packet_begin_notif->packet);
	g_free(notif);
}

BT_HIDDEN
void bt_notification_packet_begin_recycle(struct bt_notification *notif)
{
	struct bt_notification_packet_begin *packet_begin_notif = (void *) notif;
	struct bt_graph *graph;

	BT_ASSERT(packet_begin_notif);

	if (unlikely(!notif->graph)) {
		bt_notification_packet_begin_destroy(notif);
		return;
	}

	BT_LIB_LOGD("Recycling packet beginning notification: %!+n", notif);
	bt_notification_reset(notif);
	bt_object_put_no_null_check(&packet_begin_notif->packet->base);
	packet_begin_notif->packet = NULL;
	graph = notif->graph;
	notif->graph = NULL;
	bt_object_pool_recycle_object(&graph->packet_begin_notif_pool, notif);
}

struct bt_packet *bt_notification_packet_begin_borrow_packet(
		struct bt_notification *notification)
{
	struct bt_notification_packet_begin *packet_begin;

	BT_ASSERT_PRE_NON_NULL(notification, "Notification");
	BT_ASSERT_PRE_NOTIF_IS_TYPE(notification,
		BT_NOTIFICATION_TYPE_PACKET_BEGIN);
	packet_begin = (void *) notification;
	return packet_begin->packet;
}

const struct bt_packet *bt_notification_packet_begin_borrow_packet_const(
		const struct bt_notification *notification)
{
	return bt_notification_packet_begin_borrow_packet(
		(void *) notification);
}

BT_HIDDEN
struct bt_notification *bt_notification_packet_end_new(struct bt_graph *graph)
{
	struct bt_notification_packet_end *notification;

	notification = g_new0(struct bt_notification_packet_end, 1);
	if (!notification) {
		BT_LOGE_STR("Failed to allocate one packet end notification.");
		goto error;
	}

	bt_notification_init(&notification->parent,
			BT_NOTIFICATION_TYPE_PACKET_END,
			(bt_object_release_func) bt_notification_packet_end_recycle,
			graph);
	goto end;

error:
	BT_OBJECT_PUT_REF_AND_RESET(notification);

end:
	return (void *) notification;
}

struct bt_notification *bt_notification_packet_end_create(
		struct bt_self_notification_iterator *self_notif_iter,
		struct bt_packet *packet)
{
	struct bt_self_component_port_input_notification_iterator *notif_iter =
		(void *) self_notif_iter;
	struct bt_notification_packet_end *notification = NULL;
	struct bt_stream *stream;
	struct bt_stream_class *stream_class;

	BT_ASSERT_PRE_NON_NULL(notif_iter, "Notification iterator");
	BT_ASSERT_PRE_NON_NULL(packet, "Packet");
	stream = bt_packet_borrow_stream(packet);
	BT_ASSERT(stream);
	stream_class = bt_stream_borrow_class(stream);
	BT_ASSERT(stream_class);
	BT_LIB_LOGD("Creating packet end notification object: "
		"%![packet-]+a, %![stream-]+s, %![sc-]+S",
		packet, stream, stream_class);
	notification = (void *) bt_notification_create_from_pool(
		&notif_iter->graph->packet_end_notif_pool, notif_iter->graph);
	if (!notification) {
		/* bt_notification_create_from_pool() logs errors */
		goto end;
	}

	BT_ASSERT(!notification->packet);
	notification->packet = packet;
	bt_object_get_no_null_check_no_parent_check(
		&notification->packet->base);
	bt_packet_set_is_frozen(packet, true);
	BT_LIB_LOGD("Created packet end notification object: "
		"%![notif-]+n, %![packet-]+a, %![stream-]+s, %![sc-]+S",
		notification, packet, stream, stream_class);
	goto end;

end:
	return (void *) notification;
}

BT_HIDDEN
void bt_notification_packet_end_destroy(struct bt_notification *notif)
{
	struct bt_notification_packet_end *packet_end_notif = (void *) notif;

	BT_LIB_LOGD("Destroying packet end notification: %!+n", notif);
	BT_LIB_LOGD("Putting packet: %!+a", packet_end_notif->packet);
	BT_OBJECT_PUT_REF_AND_RESET(packet_end_notif->packet);
	g_free(notif);
}

BT_HIDDEN
void bt_notification_packet_end_recycle(struct bt_notification *notif)
{
	struct bt_notification_packet_end *packet_end_notif = (void *) notif;
	struct bt_graph *graph;

	BT_ASSERT(packet_end_notif);

	if (!notif->graph) {
		bt_notification_packet_end_destroy(notif);
		return;
	}

	BT_LIB_LOGD("Recycling packet end notification: %!+n", notif);
	bt_notification_reset(notif);
	BT_OBJECT_PUT_REF_AND_RESET(packet_end_notif->packet);
	graph = notif->graph;
	notif->graph = NULL;
	bt_object_pool_recycle_object(&graph->packet_end_notif_pool, notif);
}

struct bt_packet *bt_notification_packet_end_borrow_packet(
		struct bt_notification *notification)
{
	struct bt_notification_packet_end *packet_end;

	BT_ASSERT_PRE_NON_NULL(notification, "Notification");
	BT_ASSERT_PRE_NOTIF_IS_TYPE(notification,
		BT_NOTIFICATION_TYPE_PACKET_END);
	packet_end = (void *) notification;
	return packet_end->packet;
}

const struct bt_packet *bt_notification_packet_end_borrow_packet_const(
		const struct bt_notification *notification)
{
	return bt_notification_packet_end_borrow_packet(
		(void *) notification);
}
Commit	Line	Data
78586d8a	1	/*
78586d8a 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
93881221 PP	25	#define BT_LOG_TAG "NOTIF-PACKET"
	26	#include <babeltrace/lib-logging-internal.h>
	27
3d9990ac	28	#include <babeltrace/compiler-internal.h>
108b91d0 PP	29	#include <babeltrace/trace-ir/packet.h>
	30	#include <babeltrace/trace-ir/packet-internal.h>
	31	#include <babeltrace/trace-ir/stream-class.h>
	32	#include <babeltrace/trace-ir/stream.h>
	33	#include <babeltrace/trace-ir/stream-internal.h>
f7c3ac09	34	#include <babeltrace/graph/graph-internal.h>
7b53201c PP	35	#include <babeltrace/graph/notification-packet-const.h>
7b53201c PP	36	#include <babeltrace/graph/notification-packet.h>
b2e0c907	37	#include <babeltrace/graph/notification-packet-internal.h>
9e550e5f	38	#include <babeltrace/object.h>
8b45963b PP	39	#include <babeltrace/assert-internal.h>
8b45963b PP	40	#include <babeltrace/assert-pre-internal.h>
c5a24b0a	41	#include <babeltrace/object-internal.h>
93881221	42	#include <inttypes.h>
78586d8a	43
f7c3ac09 PP	44	BT_HIDDEN
f7c3ac09 PP	45	struct bt_notification bt_notification_packet_begin_new(struct bt_graph graph)
78586d8a	46	{
f7c3ac09	47	struct bt_notification_packet_begin *notification;
78586d8a	48
f7c3ac09 PP	49	notification = g_new0(struct bt_notification_packet_begin, 1);
	50	if (!notification) {
	51	BT_LOGE_STR("Failed to allocate one packet beginning notification.");
	52	goto error;
	53	}
78586d8a	54
f7c3ac09 PP	55	bt_notification_init(&notification->parent,
	56	BT_NOTIFICATION_TYPE_PACKET_BEGIN,
	57	(bt_object_release_func) bt_notification_packet_begin_recycle,
	58	graph);
	59	goto end;
78586d8a	60
f7c3ac09	61	error:
8138bfe1	62	BT_OBJECT_PUT_REF_AND_RESET(notification);
f7c3ac09 PP	63
	64	end:
	65	return (void *) notification;
78586d8a JG	66	}
78586d8a JG	67
7b53201c	68	struct bt_notification *bt_notification_packet_begin_create(
834e9996	69	struct bt_self_notification_iterator *self_notif_iter,
78cf9df6	70	struct bt_packet *packet)
78586d8a	71	{
834e9996 PP	72	struct bt_self_component_port_input_notification_iterator *notif_iter =
834e9996 PP	73	(void *) self_notif_iter;
e5815ba2	74	struct bt_notification_packet_begin *notification = NULL;
839d52a5 PP	75	struct bt_stream *stream;
839d52a5 PP	76	struct bt_stream_class *stream_class;
78586d8a	77
03e18d5d	78	BT_ASSERT_PRE_NON_NULL(notif_iter, "Notification iterator");
8b45963b	79	BT_ASSERT_PRE_NON_NULL(packet, "Packet");
839d52a5	80	stream = bt_packet_borrow_stream(packet);
8b45963b	81	BT_ASSERT(stream);
8deee039	82	stream_class = bt_stream_borrow_class(stream);
8b45963b	83	BT_ASSERT(stream_class);
834e9996 PP	84	BT_LIB_LOGD("Creating packet beginning notification object: "
	85	"%![packet-]+a, %![stream-]+s, %![sc-]+S",
	86	packet, stream, stream_class);
f7c3ac09	87	notification = (void *) bt_notification_create_from_pool(
834e9996	88	&notif_iter->graph->packet_begin_notif_pool, notif_iter->graph);
93881221	89	if (!notification) {
f7c3ac09	90	/* bt_notification_create_from_pool() logs errors */
c5a24b0a	91	goto end;
93881221 PP	92	}
93881221 PP	93
c5a24b0a PP	94	BT_ASSERT(!notification->packet);
	95	notification->packet = packet;
	96	bt_object_get_no_null_check_no_parent_check(
	97	&notification->packet->base);
e5815ba2	98	bt_packet_set_is_frozen(packet, true);
834e9996 PP	99	BT_LIB_LOGD("Created packet beginning notification object: "
	100	"%![notif-]+n, %![packet-]+a, %![stream-]+s, %![sc-]+S",
	101	notification, packet, stream, stream_class);
f7c3ac09 PP	102	goto end;
f7c3ac09 PP	103
f7c3ac09 PP	104	end:
	105	return (void *) notification;
	106	}
	107
	108	BT_HIDDEN
	109	void bt_notification_packet_begin_destroy(struct bt_notification *notif)
	110	{
	111	struct bt_notification_packet_begin packet_begin_notif = (void ) notif;
	112
834e9996 PP	113	BT_LIB_LOGD("Destroying packet beginning notification: %!+n", notif);
834e9996 PP	114	BT_LIB_LOGD("Putting packet: %!+a", packet_begin_notif->packet);
8138bfe1	115	BT_OBJECT_PUT_REF_AND_RESET(packet_begin_notif->packet);
f7c3ac09 PP	116	g_free(notif);
	117	}
	118
	119	BT_HIDDEN
	120	void bt_notification_packet_begin_recycle(struct bt_notification *notif)
	121	{
	122	struct bt_notification_packet_begin packet_begin_notif = (void ) notif;
	123	struct bt_graph *graph;
	124
	125	BT_ASSERT(packet_begin_notif);
	126
c5a24b0a	127	if (unlikely(!notif->graph)) {
f7c3ac09 PP	128	bt_notification_packet_begin_destroy(notif);
	129	return;
	130	}
	131
834e9996	132	BT_LIB_LOGD("Recycling packet beginning notification: %!+n", notif);
f7c3ac09	133	bt_notification_reset(notif);
c5a24b0a PP	134	bt_object_put_no_null_check(&packet_begin_notif->packet->base);
c5a24b0a PP	135	packet_begin_notif->packet = NULL;
f7c3ac09 PP	136	graph = notif->graph;
	137	notif->graph = NULL;
	138	bt_object_pool_recycle_object(&graph->packet_begin_notif_pool, notif);
78586d8a JG	139	}
78586d8a JG	140
7b53201c PP	141	struct bt_packet *bt_notification_packet_begin_borrow_packet(
7b53201c PP	142	struct bt_notification *notification)
78586d8a	143	{
ea0e619e	144	struct bt_notification_packet_begin *packet_begin;
78586d8a	145
8b45963b PP	146	BT_ASSERT_PRE_NON_NULL(notification, "Notification");
	147	BT_ASSERT_PRE_NOTIF_IS_TYPE(notification,
	148	BT_NOTIFICATION_TYPE_PACKET_BEGIN);
78cf9df6	149	packet_begin = (void *) notification;
5fe68922	150	return packet_begin->packet;
78586d8a JG	151	}
78586d8a JG	152
7b53201c PP	153	const struct bt_packet *bt_notification_packet_begin_borrow_packet_const(
7b53201c PP	154	const struct bt_notification *notification)
9e550e5f	155	{
7b53201c	156	return bt_notification_packet_begin_borrow_packet(
9e550e5f PP	157	(void *) notification);
	158	}
	159
f7c3ac09 PP	160	BT_HIDDEN
	161	struct bt_notification bt_notification_packet_end_new(struct bt_graph graph)
	162	{
	163	struct bt_notification_packet_end *notification;
	164
	165	notification = g_new0(struct bt_notification_packet_end, 1);
	166	if (!notification) {
	167	BT_LOGE_STR("Failed to allocate one packet end notification.");
	168	goto error;
	169	}
	170
	171	bt_notification_init(&notification->parent,
	172	BT_NOTIFICATION_TYPE_PACKET_END,
	173	(bt_object_release_func) bt_notification_packet_end_recycle,
	174	graph);
	175	goto end;
	176
	177	error:
8138bfe1	178	BT_OBJECT_PUT_REF_AND_RESET(notification);
f7c3ac09 PP	179
	180	end:
	181	return (void *) notification;
	182	}
	183
7b53201c	184	struct bt_notification *bt_notification_packet_end_create(
834e9996	185	struct bt_self_notification_iterator *self_notif_iter,
78cf9df6	186	struct bt_packet *packet)
78586d8a	187	{
834e9996 PP	188	struct bt_self_component_port_input_notification_iterator *notif_iter =
834e9996 PP	189	(void *) self_notif_iter;
e5815ba2	190	struct bt_notification_packet_end *notification = NULL;
839d52a5 PP	191	struct bt_stream *stream;
839d52a5 PP	192	struct bt_stream_class *stream_class;
78586d8a	193
03e18d5d	194	BT_ASSERT_PRE_NON_NULL(notif_iter, "Notification iterator");
8b45963b	195	BT_ASSERT_PRE_NON_NULL(packet, "Packet");
839d52a5	196	stream = bt_packet_borrow_stream(packet);
8b45963b	197	BT_ASSERT(stream);
8deee039	198	stream_class = bt_stream_borrow_class(stream);
8b45963b	199	BT_ASSERT(stream_class);
834e9996 PP	200	BT_LIB_LOGD("Creating packet end notification object: "
	201	"%![packet-]+a, %![stream-]+s, %![sc-]+S",
	202	packet, stream, stream_class);
f7c3ac09	203	notification = (void *) bt_notification_create_from_pool(
834e9996	204	&notif_iter->graph->packet_end_notif_pool, notif_iter->graph);
93881221	205	if (!notification) {
f7c3ac09	206	/* bt_notification_create_from_pool() logs errors */
c5a24b0a	207	goto end;
93881221 PP	208	}
93881221 PP	209
c5a24b0a PP	210	BT_ASSERT(!notification->packet);
	211	notification->packet = packet;
	212	bt_object_get_no_null_check_no_parent_check(
	213	&notification->packet->base);
e5815ba2	214	bt_packet_set_is_frozen(packet, true);
834e9996 PP	215	BT_LIB_LOGD("Created packet end notification object: "
	216	"%![notif-]+n, %![packet-]+a, %![stream-]+s, %![sc-]+S",
	217	notification, packet, stream, stream_class);
f7c3ac09 PP	218	goto end;
f7c3ac09 PP	219
f7c3ac09 PP	220	end:
	221	return (void *) notification;
	222	}
	223
	224	BT_HIDDEN
	225	void bt_notification_packet_end_destroy(struct bt_notification *notif)
	226	{
	227	struct bt_notification_packet_end packet_end_notif = (void ) notif;
	228
834e9996 PP	229	BT_LIB_LOGD("Destroying packet end notification: %!+n", notif);
834e9996 PP	230	BT_LIB_LOGD("Putting packet: %!+a", packet_end_notif->packet);
8138bfe1	231	BT_OBJECT_PUT_REF_AND_RESET(packet_end_notif->packet);
f7c3ac09 PP	232	g_free(notif);
	233	}
	234
	235	BT_HIDDEN
	236	void bt_notification_packet_end_recycle(struct bt_notification *notif)
	237	{
	238	struct bt_notification_packet_end packet_end_notif = (void ) notif;
	239	struct bt_graph *graph;
	240
	241	BT_ASSERT(packet_end_notif);
	242
	243	if (!notif->graph) {
	244	bt_notification_packet_end_destroy(notif);
	245	return;
	246	}
	247
834e9996	248	BT_LIB_LOGD("Recycling packet end notification: %!+n", notif);
f7c3ac09	249	bt_notification_reset(notif);
8138bfe1	250	BT_OBJECT_PUT_REF_AND_RESET(packet_end_notif->packet);
f7c3ac09 PP	251	graph = notif->graph;
	252	notif->graph = NULL;
	253	bt_object_pool_recycle_object(&graph->packet_end_notif_pool, notif);
78586d8a JG	254	}
78586d8a JG	255
7b53201c PP	256	struct bt_packet *bt_notification_packet_end_borrow_packet(
7b53201c PP	257	struct bt_notification *notification)
78586d8a JG	258	{
	259	struct bt_notification_packet_end *packet_end;
	260
8b45963b PP	261	BT_ASSERT_PRE_NON_NULL(notification, "Notification");
	262	BT_ASSERT_PRE_NOTIF_IS_TYPE(notification,
	263	BT_NOTIFICATION_TYPE_PACKET_END);
78cf9df6	264	packet_end = (void *) notification;
5fe68922	265	return packet_end->packet;
78586d8a	266	}
9e550e5f	267
7b53201c PP	268	const struct bt_packet *bt_notification_packet_end_borrow_packet_const(
7b53201c PP	269	const struct bt_notification *notification)
9e550e5f	270	{
7b53201c	271	return bt_notification_packet_end_borrow_packet(
9e550e5f PP	272	(void *) notification);
9e550e5f PP	273	}