[babeltrace.git] / lib / graph / message / packet.c

/*
 * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
 * Copyright 2016 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 "MSG-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/message-packet-beginning-const.h>
#include <babeltrace/graph/message-packet-end-const.h>
#include <babeltrace/graph/message-packet-beginning.h>
#include <babeltrace/graph/message-packet-end.h>
#include <babeltrace/graph/message-packet-internal.h>
#include <babeltrace/assert-internal.h>
#include <babeltrace/assert-pre-internal.h>
#include <babeltrace/object-internal.h>
#include <inttypes.h>

static inline
struct bt_message *new_packet_message(struct bt_graph *graph,
		enum bt_message_type type, bt_object_release_func recycle_func)
{
	struct bt_message_packet *message;

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

	bt_message_init(&message->parent, type, recycle_func, graph);
	goto end;

error:
	BT_OBJECT_PUT_REF_AND_RESET(message);

end:
	return (void *) message;
}

BT_HIDDEN
struct bt_message *bt_message_packet_beginning_new(struct bt_graph *graph)
{
	return new_packet_message(graph, BT_MESSAGE_TYPE_PACKET_BEGINNING,
		(bt_object_release_func) bt_message_packet_beginning_recycle);
}

BT_HIDDEN
struct bt_message *bt_message_packet_end_new(struct bt_graph *graph)
{
	return new_packet_message(graph, BT_MESSAGE_TYPE_PACKET_END,
		(bt_object_release_func) bt_message_packet_end_recycle);
}

static inline
struct bt_message *bt_message_packet_create(
		struct bt_self_component_port_input_message_iterator *msg_iter,
		struct bt_packet *packet, struct bt_object_pool *pool)
{
	struct bt_message_packet *message = NULL;
	struct bt_stream *stream;
	struct bt_stream_class *stream_class;

	BT_ASSERT(msg_iter);
	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 message object: "
		"%![packet-]+a, %![stream-]+s, %![sc-]+S",
		packet, stream, stream_class);
	message = (void *) bt_message_create_from_pool(pool, msg_iter->graph);
	if (!message) {
		/* bt_message_create_from_pool() logs errors */
		goto end;
	}

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

end:
	return (void *) message;
}

struct bt_message *bt_message_packet_beginning_create(
		struct bt_self_message_iterator *self_msg_iter,
		struct bt_packet *packet)
{
	struct bt_self_component_port_input_message_iterator *msg_iter =
		(void *) self_msg_iter;

	BT_ASSERT_PRE_NON_NULL(msg_iter, "Message iterator");
	return bt_message_packet_create(msg_iter, packet,
		&msg_iter->graph->packet_begin_msg_pool);
}

struct bt_message *bt_message_packet_end_create(
		struct bt_self_message_iterator *self_msg_iter,
		struct bt_packet *packet)
{
	struct bt_self_component_port_input_message_iterator *msg_iter =
		(void *) self_msg_iter;

	BT_ASSERT_PRE_NON_NULL(msg_iter, "Message iterator");
	return bt_message_packet_create(msg_iter, packet,
		&msg_iter->graph->packet_end_msg_pool);
}

BT_HIDDEN
void bt_message_packet_destroy(struct bt_message *msg)
{
	struct bt_message_packet *packet_msg = (void *) msg;

	BT_LIB_LOGD("Destroying packet message: %!+n", msg);
	BT_LIB_LOGD("Putting packet: %!+a", packet_msg->packet);
	BT_OBJECT_PUT_REF_AND_RESET(packet_msg->packet);
	g_free(msg);
}

static inline
void recycle_packet_message(struct bt_message *msg, struct bt_object_pool *pool)
{
	struct bt_message_packet *packet_msg = (void *) msg;

	BT_LIB_LOGD("Recycling packet message: %!+n", msg);
	bt_message_reset(msg);
	bt_object_put_no_null_check(&packet_msg->packet->base);
	packet_msg->packet = NULL;
	msg->graph = NULL;
	bt_object_pool_recycle_object(pool, msg);
}

BT_HIDDEN
void bt_message_packet_beginning_recycle(struct bt_message *msg)
{
	BT_ASSERT(msg);

	if (unlikely(!msg->graph)) {
		bt_message_packet_destroy(msg);
		return;
	}

	recycle_packet_message(msg, &msg->graph->packet_begin_msg_pool);
}

BT_HIDDEN
void bt_message_packet_end_recycle(struct bt_message *msg)
{
	BT_ASSERT(msg);

	if (unlikely(!msg->graph)) {
		bt_message_packet_destroy(msg);
		return;
	}

	recycle_packet_message(msg, &msg->graph->packet_end_msg_pool);
}

struct bt_packet *bt_message_packet_beginning_borrow_packet(
		struct bt_message *message)
{
	struct bt_message_packet *packet_msg = (void *) message;

	BT_ASSERT_PRE_NON_NULL(message, "Message");
	BT_ASSERT_PRE_MSG_IS_TYPE(message,
		BT_MESSAGE_TYPE_PACKET_BEGINNING);
	return packet_msg->packet;
}

const struct bt_packet *bt_message_packet_beginning_borrow_packet_const(
		const struct bt_message *message)
{
	return bt_message_packet_beginning_borrow_packet(
		(void *) message);
}

struct bt_packet *bt_message_packet_end_borrow_packet(
		struct bt_message *message)
{
	struct bt_message_packet *packet_msg = (void *) message;

	BT_ASSERT_PRE_NON_NULL(message, "Message");
	BT_ASSERT_PRE_MSG_IS_TYPE(message,
		BT_MESSAGE_TYPE_PACKET_END);
	return packet_msg->packet;
}

const struct bt_packet *bt_message_packet_end_borrow_packet_const(
		const struct bt_message *message)
{
	return bt_message_packet_end_borrow_packet(
		(void *) message);
}
Commit	Line	Data
d6e69534 PP	1	/*
	2	* Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
	3	* Copyright 2016 Jérémie Galarneau <jeremie.galarneau@efficios.com>
	4	*
	5	* Permission is hereby granted, free of charge, to any person obtaining a copy
	6	* of this software and associated documentation files (the "Software"), to deal
	7	* in the Software without restriction, including without limitation the rights
	8	* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
	9	* copies of the Software, and to permit persons to whom the Software is
	10	* furnished to do so, subject to the following conditions:
	11	*
	12	* The above copyright notice and this permission notice shall be included in
	13	* all copies or substantial portions of the Software.
	14	*
	15	* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
	16	* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
	17	* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
	18	* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
	19	* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
	20	* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
	21	* SOFTWARE.
	22	*/
	23
	24	#define BT_LOG_TAG "MSG-PACKET"
	25	#include <babeltrace/lib-logging-internal.h>
	26
	27	#include <babeltrace/compiler-internal.h>
	28	#include <babeltrace/trace-ir/packet.h>
	29	#include <babeltrace/trace-ir/packet-internal.h>
	30	#include <babeltrace/trace-ir/stream-class.h>
	31	#include <babeltrace/trace-ir/stream.h>
	32	#include <babeltrace/trace-ir/stream-internal.h>
	33	#include <babeltrace/graph/graph-internal.h>
5df26c89 PP	34	#include <babeltrace/graph/message-packet-beginning-const.h>
	35	#include <babeltrace/graph/message-packet-end-const.h>
	36	#include <babeltrace/graph/message-packet-beginning.h>
	37	#include <babeltrace/graph/message-packet-end.h>
d6e69534 PP	38	#include <babeltrace/graph/message-packet-internal.h>
	39	#include <babeltrace/assert-internal.h>
	40	#include <babeltrace/assert-pre-internal.h>
	41	#include <babeltrace/object-internal.h>
	42	#include <inttypes.h>
	43
5df26c89 PP	44	static inline
	45	struct bt_message new_packet_message(struct bt_graph graph,
	46	enum bt_message_type type, bt_object_release_func recycle_func)
d6e69534	47	{
5df26c89	48	struct bt_message_packet *message;
d6e69534	49
5df26c89	50	message = g_new0(struct bt_message_packet, 1);
d6e69534	51	if (!message) {
5df26c89	52	BT_LOGE_STR("Failed to allocate one packet message.");
d6e69534 PP	53	goto error;
	54	}
	55
5df26c89	56	bt_message_init(&message->parent, type, recycle_func, graph);
d6e69534 PP	57	goto end;
	58
	59	error:
	60	BT_OBJECT_PUT_REF_AND_RESET(message);
	61
	62	end:
	63	return (void *) message;
	64	}
	65
5df26c89 PP	66	BT_HIDDEN
5df26c89 PP	67	struct bt_message bt_message_packet_beginning_new(struct bt_graph graph)
d6e69534	68	{
5df26c89 PP	69	return new_packet_message(graph, BT_MESSAGE_TYPE_PACKET_BEGINNING,
	70	(bt_object_release_func) bt_message_packet_beginning_recycle);
	71	}
	72
	73	BT_HIDDEN
	74	struct bt_message bt_message_packet_end_new(struct bt_graph graph)
	75	{
	76	return new_packet_message(graph, BT_MESSAGE_TYPE_PACKET_END,
	77	(bt_object_release_func) bt_message_packet_end_recycle);
	78	}
	79
	80	static inline
	81	struct bt_message *bt_message_packet_create(
	82	struct bt_self_component_port_input_message_iterator *msg_iter,
	83	struct bt_packet packet, struct bt_object_pool pool)
	84	{
	85	struct bt_message_packet *message = NULL;
d6e69534 PP	86	struct bt_stream *stream;
	87	struct bt_stream_class *stream_class;
	88
5df26c89	89	BT_ASSERT(msg_iter);
d6e69534 PP	90	BT_ASSERT_PRE_NON_NULL(packet, "Packet");
	91	stream = bt_packet_borrow_stream(packet);
	92	BT_ASSERT(stream);
	93	stream_class = bt_stream_borrow_class(stream);
	94	BT_ASSERT(stream_class);
5df26c89	95	BT_LIB_LOGD("Creating packet message object: "
d6e69534 PP	96	"%![packet-]+a, %![stream-]+s, %![sc-]+S",
d6e69534 PP	97	packet, stream, stream_class);
5df26c89	98	message = (void *) bt_message_create_from_pool(pool, msg_iter->graph);
d6e69534 PP	99	if (!message) {
	100	/* bt_message_create_from_pool() logs errors */
	101	goto end;
	102	}
	103
	104	BT_ASSERT(!message->packet);
	105	message->packet = packet;
	106	bt_object_get_no_null_check_no_parent_check(
	107	&message->packet->base);
	108	bt_packet_set_is_frozen(packet, true);
5df26c89	109	BT_LIB_LOGD("Created packet message object: "
d6e69534 PP	110	"%![msg-]+n, %![packet-]+a, %![stream-]+s, %![sc-]+S",
	111	message, packet, stream, stream_class);
	112	goto end;
	113
	114	end:
	115	return (void *) message;
	116	}
	117
5df26c89 PP	118	struct bt_message *bt_message_packet_beginning_create(
	119	struct bt_self_message_iterator *self_msg_iter,
	120	struct bt_packet *packet)
d6e69534	121	{
5df26c89 PP	122	struct bt_self_component_port_input_message_iterator *msg_iter =
5df26c89 PP	123	(void *) self_msg_iter;
d6e69534	124
5df26c89 PP	125	BT_ASSERT_PRE_NON_NULL(msg_iter, "Message iterator");
	126	return bt_message_packet_create(msg_iter, packet,
	127	&msg_iter->graph->packet_begin_msg_pool);
d6e69534 PP	128	}
d6e69534 PP	129
5df26c89 PP	130	struct bt_message *bt_message_packet_end_create(
	131	struct bt_self_message_iterator *self_msg_iter,
	132	struct bt_packet *packet)
d6e69534	133	{
5df26c89 PP	134	struct bt_self_component_port_input_message_iterator *msg_iter =
5df26c89 PP	135	(void *) self_msg_iter;
d6e69534	136
5df26c89 PP	137	BT_ASSERT_PRE_NON_NULL(msg_iter, "Message iterator");
	138	return bt_message_packet_create(msg_iter, packet,
	139	&msg_iter->graph->packet_end_msg_pool);
d6e69534 PP	140	}
d6e69534 PP	141
5df26c89 PP	142	BT_HIDDEN
5df26c89 PP	143	void bt_message_packet_destroy(struct bt_message *msg)
d6e69534	144	{
5df26c89	145	struct bt_message_packet packet_msg = (void ) msg;
d6e69534	146
5df26c89 PP	147	BT_LIB_LOGD("Destroying packet message: %!+n", msg);
	148	BT_LIB_LOGD("Putting packet: %!+a", packet_msg->packet);
	149	BT_OBJECT_PUT_REF_AND_RESET(packet_msg->packet);
	150	g_free(msg);
d6e69534 PP	151	}
d6e69534 PP	152
5df26c89 PP	153	static inline
5df26c89 PP	154	void recycle_packet_message(struct bt_message msg, struct bt_object_pool pool)
d6e69534	155	{
5df26c89 PP	156	struct bt_message_packet packet_msg = (void ) msg;
	157
	158	BT_LIB_LOGD("Recycling packet message: %!+n", msg);
	159	bt_message_reset(msg);
	160	bt_object_put_no_null_check(&packet_msg->packet->base);
	161	packet_msg->packet = NULL;
	162	msg->graph = NULL;
	163	bt_object_pool_recycle_object(pool, msg);
d6e69534 PP	164	}
	165
	166	BT_HIDDEN
5df26c89	167	void bt_message_packet_beginning_recycle(struct bt_message *msg)
d6e69534	168	{
5df26c89	169	BT_ASSERT(msg);
d6e69534	170
5df26c89 PP	171	if (unlikely(!msg->graph)) {
	172	bt_message_packet_destroy(msg);
	173	return;
d6e69534 PP	174	}
d6e69534 PP	175
5df26c89	176	recycle_packet_message(msg, &msg->graph->packet_begin_msg_pool);
d6e69534 PP	177	}
d6e69534 PP	178
5df26c89 PP	179	BT_HIDDEN
5df26c89 PP	180	void bt_message_packet_end_recycle(struct bt_message *msg)
d6e69534	181	{
5df26c89	182	BT_ASSERT(msg);
d6e69534	183
5df26c89 PP	184	if (unlikely(!msg->graph)) {
	185	bt_message_packet_destroy(msg);
	186	return;
d6e69534 PP	187	}
d6e69534 PP	188
5df26c89	189	recycle_packet_message(msg, &msg->graph->packet_end_msg_pool);
d6e69534 PP	190	}
d6e69534 PP	191
5df26c89 PP	192	struct bt_packet *bt_message_packet_beginning_borrow_packet(
5df26c89 PP	193	struct bt_message *message)
d6e69534	194	{
5df26c89	195	struct bt_message_packet packet_msg = (void ) message;
d6e69534	196
5df26c89 PP	197	BT_ASSERT_PRE_NON_NULL(message, "Message");
	198	BT_ASSERT_PRE_MSG_IS_TYPE(message,
	199	BT_MESSAGE_TYPE_PACKET_BEGINNING);
	200	return packet_msg->packet;
d6e69534 PP	201	}
d6e69534 PP	202
5df26c89 PP	203	const struct bt_packet *bt_message_packet_beginning_borrow_packet_const(
5df26c89 PP	204	const struct bt_message *message)
d6e69534	205	{
5df26c89 PP	206	return bt_message_packet_beginning_borrow_packet(
5df26c89 PP	207	(void *) message);
d6e69534 PP	208	}
	209
	210	struct bt_packet *bt_message_packet_end_borrow_packet(
	211	struct bt_message *message)
	212	{
5df26c89	213	struct bt_message_packet packet_msg = (void ) message;
d6e69534 PP	214
	215	BT_ASSERT_PRE_NON_NULL(message, "Message");
	216	BT_ASSERT_PRE_MSG_IS_TYPE(message,
	217	BT_MESSAGE_TYPE_PACKET_END);
5df26c89	218	return packet_msg->packet;
d6e69534 PP	219	}
	220
	221	const struct bt_packet *bt_message_packet_end_borrow_packet_const(
	222	const struct bt_message *message)
	223	{
	224	return bt_message_packet_end_borrow_packet(
	225	(void *) message);
	226	}