[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-const.h>
#include <babeltrace/graph/message-packet.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>

BT_HIDDEN
struct bt_message *bt_message_packet_beginning_new(struct bt_graph *graph)
{
	struct bt_message_packet_beginning *message;

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

	bt_message_init(&message->parent,
			BT_MESSAGE_TYPE_PACKET_BEGINNING,
			(bt_object_release_func) bt_message_packet_beginning_recycle,
			graph);
	goto end;

error:
	BT_OBJECT_PUT_REF_AND_RESET(message);

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;
	struct bt_message_packet_beginning *message = NULL;
	struct bt_stream *stream;
	struct bt_stream_class *stream_class;

	BT_ASSERT_PRE_NON_NULL(msg_iter, "Message 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 message object: "
		"%![packet-]+a, %![stream-]+s, %![sc-]+S",
		packet, stream, stream_class);
	message = (void *) bt_message_create_from_pool(
		&msg_iter->graph->packet_begin_msg_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 beginning message object: "
		"%![msg-]+n, %![packet-]+a, %![stream-]+s, %![sc-]+S",
		message, packet, stream, stream_class);
	goto end;

end:
	return (void *) message;
}

BT_HIDDEN
void bt_message_packet_beginning_destroy(struct bt_message *msg)
{
	struct bt_message_packet_beginning *packet_begin_msg = (void *) msg;

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

BT_HIDDEN
void bt_message_packet_beginning_recycle(struct bt_message *msg)
{
	struct bt_message_packet_beginning *packet_begin_msg = (void *) msg;
	struct bt_graph *graph;

	BT_ASSERT(packet_begin_msg);

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

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

struct bt_packet *bt_message_packet_beginning_borrow_packet(
		struct bt_message *message)
{
	struct bt_message_packet_beginning *packet_begin;

	BT_ASSERT_PRE_NON_NULL(message, "Message");
	BT_ASSERT_PRE_MSG_IS_TYPE(message,
		BT_MESSAGE_TYPE_PACKET_BEGINNING);
	packet_begin = (void *) message;
	return packet_begin->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);
}

BT_HIDDEN
struct bt_message *bt_message_packet_end_new(struct bt_graph *graph)
{
	struct bt_message_packet_end *message;

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

	bt_message_init(&message->parent,
			BT_MESSAGE_TYPE_PACKET_END,
			(bt_object_release_func) bt_message_packet_end_recycle,
			graph);
	goto end;

error:
	BT_OBJECT_PUT_REF_AND_RESET(message);

end:
	return (void *) message;
}

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;
	struct bt_message_packet_end *message = NULL;
	struct bt_stream *stream;
	struct bt_stream_class *stream_class;

	BT_ASSERT_PRE_NON_NULL(msg_iter, "Message 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 message object: "
		"%![packet-]+a, %![stream-]+s, %![sc-]+S",
		packet, stream, stream_class);
	message = (void *) bt_message_create_from_pool(
		&msg_iter->graph->packet_end_msg_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 end message object: "
		"%![msg-]+n, %![packet-]+a, %![stream-]+s, %![sc-]+S",
		message, packet, stream, stream_class);
	goto end;

end:
	return (void *) message;
}

BT_HIDDEN
void bt_message_packet_end_destroy(struct bt_message *msg)
{
	struct bt_message_packet_end *packet_end_msg = (void *) msg;

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

BT_HIDDEN
void bt_message_packet_end_recycle(struct bt_message *msg)
{
	struct bt_message_packet_end *packet_end_msg = (void *) msg;
	struct bt_graph *graph;

	BT_ASSERT(packet_end_msg);

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

	BT_LIB_LOGD("Recycling packet end message: %!+n", msg);
	bt_message_reset(msg);
	BT_OBJECT_PUT_REF_AND_RESET(packet_end_msg->packet);
	graph = msg->graph;
	msg->graph = NULL;
	bt_object_pool_recycle_object(&graph->packet_end_msg_pool, msg);
}

struct bt_packet *bt_message_packet_end_borrow_packet(
		struct bt_message *message)
{
	struct bt_message_packet_end *packet_end;

	BT_ASSERT_PRE_NON_NULL(message, "Message");
	BT_ASSERT_PRE_MSG_IS_TYPE(message,
		BT_MESSAGE_TYPE_PACKET_END);
	packet_end = (void *) message;
	return packet_end->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>
	34	#include <babeltrace/graph/message-packet-const.h>
	35	#include <babeltrace/graph/message-packet.h>
	36	#include <babeltrace/graph/message-packet-internal.h>
	37	#include <babeltrace/assert-internal.h>
	38	#include <babeltrace/assert-pre-internal.h>
	39	#include <babeltrace/object-internal.h>
	40	#include <inttypes.h>
	41
	42	BT_HIDDEN
	43	struct bt_message bt_message_packet_beginning_new(struct bt_graph graph)
	44	{
	45	struct bt_message_packet_beginning *message;
	46
	47	message = g_new0(struct bt_message_packet_beginning, 1);
	48	if (!message) {
	49	BT_LOGE_STR("Failed to allocate one packet beginning message.");
	50	goto error;
	51	}
	52
	53	bt_message_init(&message->parent,
	54	BT_MESSAGE_TYPE_PACKET_BEGINNING,
	55	(bt_object_release_func) bt_message_packet_beginning_recycle,
	56	graph);
	57	goto end;
	58
	59	error:
	60	BT_OBJECT_PUT_REF_AND_RESET(message);
	61
	62	end:
	63	return (void *) message;
	64	}
65
66	struct bt_message *bt_message_packet_beginning_create(
67	struct bt_self_message_iterator *self_msg_iter,
68	struct bt_packet *packet)
69	{
70	struct bt_self_component_port_input_message_iterator *msg_iter =
71	(void *) self_msg_iter;
72	struct bt_message_packet_beginning *message = NULL;
73	struct bt_stream *stream;
74	struct bt_stream_class *stream_class;
75
76	BT_ASSERT_PRE_NON_NULL(msg_iter, "Message iterator");
77	BT_ASSERT_PRE_NON_NULL(packet, "Packet");
78	stream = bt_packet_borrow_stream(packet);
79	BT_ASSERT(stream);
80	stream_class = bt_stream_borrow_class(stream);
81	BT_ASSERT(stream_class);
82	BT_LIB_LOGD("Creating packet beginning message object: "
83	"%![packet-]+a, %![stream-]+s, %![sc-]+S",
84	packet, stream, stream_class);
85	message = (void *) bt_message_create_from_pool(
86	&msg_iter->graph->packet_begin_msg_pool, msg_iter->graph);
87	if (!message) {
88	/* bt_message_create_from_pool() logs errors */
89	goto end;
90	}
91
92	BT_ASSERT(!message->packet);
93	message->packet = packet;
94	bt_object_get_no_null_check_no_parent_check(
95	&message->packet->base);
96	bt_packet_set_is_frozen(packet, true);
97	BT_LIB_LOGD("Created packet beginning message object: "
98	"%![msg-]+n, %![packet-]+a, %![stream-]+s, %![sc-]+S",
99	message, packet, stream, stream_class);
100	goto end;
101
102	end:
103	return (void *) message;
104	}
105
106	BT_HIDDEN
107	void bt_message_packet_beginning_destroy(struct bt_message *msg)
108	{
109	struct bt_message_packet_beginning packet_begin_msg = (void ) msg;
110
111	BT_LIB_LOGD("Destroying packet beginning message: %!+n", msg);
112	BT_LIB_LOGD("Putting packet: %!+a", packet_begin_msg->packet);
113	BT_OBJECT_PUT_REF_AND_RESET(packet_begin_msg->packet);
114	g_free(msg);
115	}
116
117	BT_HIDDEN
118	void bt_message_packet_beginning_recycle(struct bt_message *msg)
119	{
120	struct bt_message_packet_beginning packet_begin_msg = (void ) msg;
121	struct bt_graph *graph;
122
123	BT_ASSERT(packet_begin_msg);
124
125	if (unlikely(!msg->graph)) {
126	bt_message_packet_beginning_destroy(msg);
127	return;
128	}
129
130	BT_LIB_LOGD("Recycling packet beginning message: %!+n", msg);
131	bt_message_reset(msg);
132	bt_object_put_no_null_check(&packet_begin_msg->packet->base);
133	packet_begin_msg->packet = NULL;
134	graph = msg->graph;
135	msg->graph = NULL;
136	bt_object_pool_recycle_object(&graph->packet_begin_msg_pool, msg);
137	}
138
139	struct bt_packet *bt_message_packet_beginning_borrow_packet(
140	struct bt_message *message)
141	{
142	struct bt_message_packet_beginning *packet_begin;
143
144	BT_ASSERT_PRE_NON_NULL(message, "Message");
145	BT_ASSERT_PRE_MSG_IS_TYPE(message,
146	BT_MESSAGE_TYPE_PACKET_BEGINNING);
147	packet_begin = (void *) message;
148	return packet_begin->packet;
149	}
150
151	const struct bt_packet *bt_message_packet_beginning_borrow_packet_const(
152	const struct bt_message *message)
153	{
154	return bt_message_packet_beginning_borrow_packet(
155	(void *) message);
156	}
157
158	BT_HIDDEN
159	struct bt_message bt_message_packet_end_new(struct bt_graph graph)
160	{
161	struct bt_message_packet_end *message;
162
163	message = g_new0(struct bt_message_packet_end, 1);
164	if (!message) {
165	BT_LOGE_STR("Failed to allocate one packet end message.");
166	goto error;
167	}
168
169	bt_message_init(&message->parent,
170	BT_MESSAGE_TYPE_PACKET_END,
171	(bt_object_release_func) bt_message_packet_end_recycle,
172	graph);
173	goto end;
174
175	error:
176	BT_OBJECT_PUT_REF_AND_RESET(message);
177
178	end:
179	return (void *) message;
180	}
181
182	struct bt_message *bt_message_packet_end_create(
183	struct bt_self_message_iterator *self_msg_iter,
184	struct bt_packet *packet)
185	{
186	struct bt_self_component_port_input_message_iterator *msg_iter =
187	(void *) self_msg_iter;
188	struct bt_message_packet_end *message = NULL;
189	struct bt_stream *stream;
190	struct bt_stream_class *stream_class;
191
192	BT_ASSERT_PRE_NON_NULL(msg_iter, "Message iterator");
193	BT_ASSERT_PRE_NON_NULL(packet, "Packet");
194	stream = bt_packet_borrow_stream(packet);
195	BT_ASSERT(stream);
196	stream_class = bt_stream_borrow_class(stream);
197	BT_ASSERT(stream_class);
198	BT_LIB_LOGD("Creating packet end message object: "
199	"%![packet-]+a, %![stream-]+s, %![sc-]+S",
200	packet, stream, stream_class);
201	message = (void *) bt_message_create_from_pool(
202	&msg_iter->graph->packet_end_msg_pool, msg_iter->graph);
203	if (!message) {
204	/* bt_message_create_from_pool() logs errors */
205	goto end;
206	}
207
208	BT_ASSERT(!message->packet);
209	message->packet = packet;
210	bt_object_get_no_null_check_no_parent_check(
211	&message->packet->base);
212	bt_packet_set_is_frozen(packet, true);
213	BT_LIB_LOGD("Created packet end message object: "
214	"%![msg-]+n, %![packet-]+a, %![stream-]+s, %![sc-]+S",
215	message, packet, stream, stream_class);
216	goto end;
217
218	end:
219	return (void *) message;
220	}
221
222	BT_HIDDEN
223	void bt_message_packet_end_destroy(struct bt_message *msg)
224	{
225	struct bt_message_packet_end packet_end_msg = (void ) msg;
226
227	BT_LIB_LOGD("Destroying packet end message: %!+n", msg);
228	BT_LIB_LOGD("Putting packet: %!+a", packet_end_msg->packet);
229	BT_OBJECT_PUT_REF_AND_RESET(packet_end_msg->packet);
230	g_free(msg);
231	}
232
233	BT_HIDDEN
234	void bt_message_packet_end_recycle(struct bt_message *msg)
235	{
236	struct bt_message_packet_end packet_end_msg = (void ) msg;
237	struct bt_graph *graph;
238
239	BT_ASSERT(packet_end_msg);
240
241	if (!msg->graph) {
242	bt_message_packet_end_destroy(msg);
243	return;
244	}
245
246	BT_LIB_LOGD("Recycling packet end message: %!+n", msg);
247	bt_message_reset(msg);
248	BT_OBJECT_PUT_REF_AND_RESET(packet_end_msg->packet);
249	graph = msg->graph;
250	msg->graph = NULL;
251	bt_object_pool_recycle_object(&graph->packet_end_msg_pool, msg);
252	}
253
254	struct bt_packet *bt_message_packet_end_borrow_packet(
255	struct bt_message *message)
256	{
257	struct bt_message_packet_end *packet_end;
258
259	BT_ASSERT_PRE_NON_NULL(message, "Message");
260	BT_ASSERT_PRE_MSG_IS_TYPE(message,
261	BT_MESSAGE_TYPE_PACKET_END);
262	packet_end = (void *) message;
263	return packet_end->packet;
264	}
265
266	const struct bt_packet *bt_message_packet_end_borrow_packet_const(
267	const struct bt_message *message)
268	{
269	return bt_message_packet_end_borrow_packet(
270	(void *) message);
271	}