[babeltrace.git] / lib / ctf-ir / packet.c

/*
 * packet.c
 *
 * Babeltrace CTF IR - Stream packet
 *
 * Copyright 2016 Philippe Proulx <pproulx@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 "PACKET"
#include <babeltrace/lib-logging-internal.h>

#include <babeltrace/assert-pre-internal.h>
#include <babeltrace/ctf-ir/fields-internal.h>
#include <babeltrace/ctf-ir/packet.h>
#include <babeltrace/ctf-ir/packet-internal.h>
#include <babeltrace/ctf-ir/trace.h>
#include <babeltrace/ctf-ir/stream-class-internal.h>
#include <babeltrace/ctf-ir/stream-class.h>
#include <babeltrace/ctf-ir/stream.h>
#include <babeltrace/ctf-ir/stream-internal.h>
#include <babeltrace/ctf-ir/trace-internal.h>
#include <babeltrace/object-internal.h>
#include <babeltrace/ref.h>
#include <babeltrace/assert-internal.h>
#include <inttypes.h>

struct bt_stream *bt_packet_get_stream(struct bt_packet *packet)
{
	BT_ASSERT_PRE_NON_NULL(packet, "Packet");
	return bt_get(packet->stream);
}

struct bt_field *bt_packet_get_header(
		struct bt_packet *packet)
{
	BT_ASSERT_PRE_NON_NULL(packet, "Packet");
	return bt_get(packet->header);
}

BT_ASSERT_PRE_FUNC
static inline bool validate_field_to_set(struct bt_field *field,
		struct bt_field_type_common *expected_ft)
{
	bool ret = true;

	if (!field) {
		if (expected_ft) {
			BT_ASSERT_PRE_MSG("Setting no field, but expected "
				"field type is not NULL: "
				"%![field-]+f, %![expected-ft-]+F",
				field, expected_ft);
			ret = false;
			goto end;
		}

		goto end;
	}

	if (bt_field_type_compare(bt_field_borrow_type(field),
			BT_FROM_COMMON(expected_ft)) != 0) {
		BT_ASSERT_PRE_MSG("Field type is different from expected "
			" field type: %![field-ft-]+F, %![expected-ft-]+F",
			bt_field_borrow_type(field), expected_ft);
		ret = false;
		goto end;
	}

end:
	return ret;
}

int bt_packet_set_header(struct bt_packet *packet,
		struct bt_field *header)
{
	BT_ASSERT_PRE_NON_NULL(packet, "Packet");
	BT_ASSERT_PRE_HOT(packet, "Packet", ": +%!+a", packet);
	BT_ASSERT_PRE(validate_field_to_set(header,
		bt_stream_class_borrow_trace(
			BT_FROM_COMMON(packet->stream->common.stream_class))->common.packet_header_field_type),
		"Invalid packet header field: "
		"%![packet-]+a, %![field-]+f", packet, header);
	bt_put(packet->header);
	packet->header = bt_get(header);
	BT_LOGV("Set packet's header field: packet-addr=%p, packet-header-addr=%p",
		packet, header);
	return 0;
}

struct bt_field *bt_packet_get_context(struct bt_packet *packet)
{
	BT_ASSERT_PRE_NON_NULL(packet, "Packet");
	return bt_get(packet->context);
}

int bt_packet_set_context(struct bt_packet *packet,
		struct bt_field *context)
{
	BT_ASSERT_PRE_NON_NULL(packet, "Packet");
	BT_ASSERT_PRE_HOT(packet, "Packet", ": +%!+a", packet);
	BT_ASSERT_PRE(validate_field_to_set(context,
		BT_FROM_COMMON(packet->stream->common.stream_class->packet_context_field_type)),
		"Invalid packet context field: "
		"%![packet-]+a, %![field-]+f", packet, context);
	bt_put(packet->context);
	packet->context = bt_get(context);
	BT_LOGV("Set packet's context field: packet-addr=%p, packet-context-addr=%p",
		packet, context);
	return 0;
}

BT_HIDDEN
void _bt_packet_freeze(struct bt_packet *packet)
{
	if (!packet || packet->frozen) {
		return;
	}

	BT_LOGD("Freezing packet: addr=%p", packet);
	BT_LOGD_STR("Freezing packet's header field.");
	bt_field_freeze_recursive(packet->header);
	BT_LOGD_STR("Freezing packet's context field.");
	bt_field_freeze_recursive(packet->context);
	packet->frozen = 1;
}

static
void bt_packet_destroy(struct bt_object *obj)
{
	struct bt_packet *packet = (void *) obj;

	BT_LOGD("Destroying packet: addr=%p", packet);
	BT_LOGD_STR("Putting packet's header field.");
	bt_put(packet->header);
	BT_LOGD_STR("Putting packet's context field.");
	bt_put(packet->context);
	BT_LOGD_STR("Putting packet's stream.");
	bt_put(packet->stream);
	g_free(packet);
}

struct bt_packet *bt_packet_create(
		struct bt_stream *stream)
{
	struct bt_packet *packet = NULL;
	struct bt_stream_class *stream_class = NULL;
	struct bt_trace *trace = NULL;

	BT_ASSERT_PRE_NON_NULL(stream, "Stream");
	BT_LOGD("Creating packet object: stream-addr=%p, "
		"stream-name=\"%s\", stream-class-addr=%p, "
		"stream-class-name=\"%s\", stream-class-id=%" PRId64,
		stream, bt_stream_get_name(stream),
		stream->common.stream_class,
		bt_stream_class_common_get_name(stream->common.stream_class),
		bt_stream_class_common_get_id(stream->common.stream_class));
	stream_class = bt_stream_get_class(stream);
	BT_ASSERT(stream_class);
	trace = bt_stream_class_get_trace(stream_class);
	BT_ASSERT(trace);
	packet = g_new0(struct bt_packet, 1);
	if (!packet) {
		BT_LOGE_STR("Failed to allocate one packet object.");
		goto end;
	}

	bt_object_init(packet, bt_packet_destroy);
	packet->stream = bt_get(stream);

	if (trace->common.packet_header_field_type) {
		BT_LOGD("Creating initial packet header field: ft-addr=%p",
			trace->common.packet_header_field_type);
		packet->header = bt_field_create(
			BT_FROM_COMMON(trace->common.packet_header_field_type));
		if (!packet->header) {
			BT_LOGE_STR("Cannot create initial packet header field object.");
			BT_PUT(packet);
			goto end;
		}
	}

	if (stream->common.stream_class->packet_context_field_type) {
		BT_LOGD("Creating initial packet context field: ft-addr=%p",
			stream->common.stream_class->packet_context_field_type);
		packet->context = bt_field_create(
			BT_FROM_COMMON(stream->common.stream_class->packet_context_field_type));
		if (!packet->context) {
			BT_LOGE_STR("Cannot create initial packet header field object.");
			BT_PUT(packet);
			goto end;
		}
	}

	BT_LOGD("Created packet object: addr=%p", packet);

end:
	BT_PUT(trace);
	BT_PUT(stream_class);

	return packet;
}
Commit	Line	Data
f79cf0f0 PP	1	/*
	2	* packet.c
	3	*
	4	* Babeltrace CTF IR - Stream packet
	5	*
	6	* Copyright 2016 Philippe Proulx <pproulx@efficios.com>
	7	*
	8	* Permission is hereby granted, free of charge, to any person obtaining a copy
	9	* of this software and associated documentation files (the "Software"), to deal
	10	* in the Software without restriction, including without limitation the rights
	11	* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
	12	* copies of the Software, and to permit persons to whom the Software is
	13	* furnished to do so, subject to the following conditions:
	14	*
	15	* The above copyright notice and this permission notice shall be included in
	16	* all copies or substantial portions of the Software.
	17	*
	18	* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
	19	* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
	20	* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
	21	* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
	22	* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
	23	* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
	24	* SOFTWARE.
	25	*/
	26
8ea705f0	27	#define BT_LOG_TAG "PACKET"
be514b0c	28	#include <babeltrace/lib-logging-internal.h>
8ea705f0	29
3dca2276	30	#include <babeltrace/assert-pre-internal.h>
f79cf0f0 PP	31	#include <babeltrace/ctf-ir/fields-internal.h>
	32	#include <babeltrace/ctf-ir/packet.h>
	33	#include <babeltrace/ctf-ir/packet-internal.h>
	34	#include <babeltrace/ctf-ir/trace.h>
	35	#include <babeltrace/ctf-ir/stream-class-internal.h>
	36	#include <babeltrace/ctf-ir/stream-class.h>
	37	#include <babeltrace/ctf-ir/stream.h>
	38	#include <babeltrace/ctf-ir/stream-internal.h>
	39	#include <babeltrace/ctf-ir/trace-internal.h>
	40	#include <babeltrace/object-internal.h>
	41	#include <babeltrace/ref.h>
f6ccaed9	42	#include <babeltrace/assert-internal.h>
be514b0c	43	#include <inttypes.h>
f79cf0f0	44
50842bdc	45	struct bt_stream bt_packet_get_stream(struct bt_packet packet)
f79cf0f0	46	{
f6ccaed9 PP	47	BT_ASSERT_PRE_NON_NULL(packet, "Packet");
f6ccaed9 PP	48	return bt_get(packet->stream);
f79cf0f0 PP	49	}
f79cf0f0 PP	50
50842bdc PP	51	struct bt_field *bt_packet_get_header(
50842bdc PP	52	struct bt_packet *packet)
f79cf0f0	53	{
f6ccaed9 PP	54	BT_ASSERT_PRE_NON_NULL(packet, "Packet");
f6ccaed9 PP	55	return bt_get(packet->header);
f79cf0f0 PP	56	}
f79cf0f0 PP	57
f6ccaed9 PP	58	BT_ASSERT_PRE_FUNC
f6ccaed9 PP	59	static inline bool validate_field_to_set(struct bt_field *field,
3dca2276	60	struct bt_field_type_common *expected_ft)
f79cf0f0	61	{
f6ccaed9 PP	62	bool ret = true;
	63
	64	if (!field) {
	65	if (expected_ft) {
	66	BT_ASSERT_PRE_MSG("Setting no field, but expected "
	67	"field type is not NULL: "
	68	"%![field-]+f, %![expected-ft-]+F",
	69	field, expected_ft);
	70	ret = false;
c5c82c6e PP	71	goto end;
	72	}
	73
f6ccaed9	74	goto end;
c5c82c6e PP	75	}
c5c82c6e PP	76
3dca2276 PP	77	if (bt_field_type_compare(bt_field_borrow_type(field),
3dca2276 PP	78	BT_FROM_COMMON(expected_ft)) != 0) {
f6ccaed9 PP	79	BT_ASSERT_PRE_MSG("Field type is different from expected "
f6ccaed9 PP	80	" field type: %![field-ft-]+F, %![expected-ft-]+F",
3dca2276	81	bt_field_borrow_type(field), expected_ft);
f6ccaed9	82	ret = false;
f79cf0f0 PP	83	goto end;
	84	}
	85
f6ccaed9 PP	86	end:
	87	return ret;
	88	}
	89
	90	int bt_packet_set_header(struct bt_packet *packet,
	91	struct bt_field *header)
	92	{
	93	BT_ASSERT_PRE_NON_NULL(packet, "Packet");
	94	BT_ASSERT_PRE_HOT(packet, "Packet", ": +%!+a", packet);
	95	BT_ASSERT_PRE(validate_field_to_set(header,
3dca2276 PP	96	bt_stream_class_borrow_trace(
3dca2276 PP	97	BT_FROM_COMMON(packet->stream->common.stream_class))->common.packet_header_field_type),
f6ccaed9 PP	98	"Invalid packet header field: "
f6ccaed9 PP	99	"%![packet-]+a, %![field-]+f", packet, header);
f79cf0f0 PP	100	bt_put(packet->header);
f79cf0f0 PP	101	packet->header = bt_get(header);
8ea705f0 PP	102	BT_LOGV("Set packet's header field: packet-addr=%p, packet-header-addr=%p",
8ea705f0 PP	103	packet, header);
f6ccaed9	104	return 0;
f79cf0f0 PP	105	}
f79cf0f0 PP	106
f6ccaed9	107	struct bt_field bt_packet_get_context(struct bt_packet packet)
f79cf0f0	108	{
f6ccaed9 PP	109	BT_ASSERT_PRE_NON_NULL(packet, "Packet");
f6ccaed9 PP	110	return bt_get(packet->context);
f79cf0f0 PP	111	}
f79cf0f0 PP	112
50842bdc PP	113	int bt_packet_set_context(struct bt_packet *packet,
50842bdc PP	114	struct bt_field *context)
f79cf0f0	115	{
f6ccaed9 PP	116	BT_ASSERT_PRE_NON_NULL(packet, "Packet");
	117	BT_ASSERT_PRE_HOT(packet, "Packet", ": +%!+a", packet);
	118	BT_ASSERT_PRE(validate_field_to_set(context,
3dca2276	119	BT_FROM_COMMON(packet->stream->common.stream_class->packet_context_field_type)),
f6ccaed9 PP	120	"Invalid packet context field: "
f6ccaed9 PP	121	"%![packet-]+a, %![field-]+f", packet, context);
f79cf0f0 PP	122	bt_put(packet->context);
f79cf0f0 PP	123	packet->context = bt_get(context);
8ea705f0 PP	124	BT_LOGV("Set packet's context field: packet-addr=%p, packet-context-addr=%p",
8ea705f0 PP	125	packet, context);
f6ccaed9	126	return 0;
f79cf0f0 PP	127	}
	128
	129	BT_HIDDEN
f6ccaed9	130	void _bt_packet_freeze(struct bt_packet *packet)
f79cf0f0	131	{
8ea705f0	132	if (!packet \|\| packet->frozen) {
5c3b707d	133	return;
f79cf0f0 PP	134	}
f79cf0f0 PP	135
8ea705f0	136	BT_LOGD("Freezing packet: addr=%p", packet);
d409daba	137	BT_LOGD_STR("Freezing packet's header field.");
f6ccaed9	138	bt_field_freeze_recursive(packet->header);
d409daba	139	BT_LOGD_STR("Freezing packet's context field.");
f6ccaed9	140	bt_field_freeze_recursive(packet->context);
f79cf0f0	141	packet->frozen = 1;
f79cf0f0 PP	142	}
	143
	144	static
50842bdc	145	void bt_packet_destroy(struct bt_object *obj)
f79cf0f0	146	{
3dca2276	147	struct bt_packet packet = (void ) obj;
f79cf0f0	148
8ea705f0	149	BT_LOGD("Destroying packet: addr=%p", packet);
d409daba	150	BT_LOGD_STR("Putting packet's header field.");
f79cf0f0	151	bt_put(packet->header);
d409daba	152	BT_LOGD_STR("Putting packet's context field.");
f79cf0f0	153	bt_put(packet->context);
d409daba	154	BT_LOGD_STR("Putting packet's stream.");
f79cf0f0 PP	155	bt_put(packet->stream);
	156	g_free(packet);
	157	}
	158
50842bdc PP	159	struct bt_packet *bt_packet_create(
50842bdc PP	160	struct bt_stream *stream)
f79cf0f0	161	{
50842bdc PP	162	struct bt_packet *packet = NULL;
	163	struct bt_stream_class *stream_class = NULL;
	164	struct bt_trace *trace = NULL;
f79cf0f0	165
f6ccaed9	166	BT_ASSERT_PRE_NON_NULL(stream, "Stream");
be514b0c PP	167	BT_LOGD("Creating packet object: stream-addr=%p, "
	168	"stream-name=\"%s\", stream-class-addr=%p, "
	169	"stream-class-name=\"%s\", stream-class-id=%" PRId64,
50842bdc	170	stream, bt_stream_get_name(stream),
3dca2276 PP	171	stream->common.stream_class,
	172	bt_stream_class_common_get_name(stream->common.stream_class),
	173	bt_stream_class_common_get_id(stream->common.stream_class));
50842bdc	174	stream_class = bt_stream_get_class(stream);
f6ccaed9	175	BT_ASSERT(stream_class);
50842bdc	176	trace = bt_stream_class_get_trace(stream_class);
f6ccaed9	177	BT_ASSERT(trace);
50842bdc	178	packet = g_new0(struct bt_packet, 1);
f79cf0f0	179	if (!packet) {
8ea705f0	180	BT_LOGE_STR("Failed to allocate one packet object.");
f79cf0f0 PP	181	goto end;
	182	}
	183
50842bdc	184	bt_object_init(packet, bt_packet_destroy);
f79cf0f0	185	packet->stream = bt_get(stream);
be514b0c	186
3dca2276	187	if (trace->common.packet_header_field_type) {
be514b0c	188	BT_LOGD("Creating initial packet header field: ft-addr=%p",
3dca2276 PP	189	trace->common.packet_header_field_type);
	190	packet->header = bt_field_create(
	191	BT_FROM_COMMON(trace->common.packet_header_field_type));
be514b0c PP	192	if (!packet->header) {
	193	BT_LOGE_STR("Cannot create initial packet header field object.");
	194	BT_PUT(packet);
	195	goto end;
	196	}
f79cf0f0 PP	197	}
f79cf0f0 PP	198
3dca2276	199	if (stream->common.stream_class->packet_context_field_type) {
be514b0c	200	BT_LOGD("Creating initial packet context field: ft-addr=%p",
3dca2276	201	stream->common.stream_class->packet_context_field_type);
50842bdc	202	packet->context = bt_field_create(
3dca2276	203	BT_FROM_COMMON(stream->common.stream_class->packet_context_field_type));
be514b0c PP	204	if (!packet->context) {
	205	BT_LOGE_STR("Cannot create initial packet header field object.");
	206	BT_PUT(packet);
	207	goto end;
	208	}
f79cf0f0 PP	209	}
f79cf0f0 PP	210
8ea705f0 PP	211	BT_LOGD("Created packet object: addr=%p", packet);
8ea705f0 PP	212
f79cf0f0 PP	213	end:
	214	BT_PUT(trace);
	215	BT_PUT(stream_class);
	216
	217	return packet;
	218	}