[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/field-wrapper-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_borrow_stream(struct bt_packet *packet)
{
	BT_ASSERT_PRE_NON_NULL(packet, "Packet");
	return packet->stream;
}

struct bt_field *bt_packet_borrow_header(struct bt_packet *packet)
{
	BT_ASSERT_PRE_NON_NULL(packet, "Packet");
	return packet->header ? (void *) packet->header->field : NULL;
}

struct bt_field *bt_packet_borrow_context(struct bt_packet *packet)
{
	BT_ASSERT_PRE_NON_NULL(packet, "Packet");
	return packet->context ? (void *) packet->context->field : NULL;
}

BT_HIDDEN
void _bt_packet_set_is_frozen(struct bt_packet *packet, bool is_frozen)
{
	if (!packet || packet->frozen) {
		return;
	}

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

	if (packet->header) {
		BT_LOGD_STR("Freezing packet's header field.");
		bt_field_set_is_frozen_recursive((void *) packet->header->field,
			is_frozen);
	}

	if (packet->context) {
		BT_LOGD_STR("Freezing packet's context field.");
		bt_field_set_is_frozen_recursive((void *) packet->context->field,
			is_frozen);
	}

	packet->frozen = is_frozen;
}

static inline
void bt_packet_reset(struct bt_packet *packet)
{
	BT_ASSERT(packet);
	bt_packet_set_is_frozen(packet, false);

	if (packet->header) {
		bt_field_set_is_frozen_recursive(
			(void *) packet->header->field, false);
		bt_field_reset_recursive((void *) packet->header->field);
	}

	if (packet->context) {
		bt_field_set_is_frozen_recursive(
			(void *) packet->context->field, false);
		bt_field_reset_recursive((void *) packet->context->field);
	}

	bt_clock_value_set_reset(&packet->begin_cv_set);
	bt_clock_value_set_reset(&packet->end_cv_set);
}

static
void bt_packet_header_field_recycle(struct bt_field_wrapper *header_field,
		struct bt_trace *trace)
{
	BT_ASSERT(header_field);
	BT_LIB_LOGD("Recycling packet header field: "
		"addr=%p, %![trace-]+t, %![field-]+f", header_field,
		trace, header_field->field);
	bt_object_pool_recycle_object(&trace->packet_header_field_pool,
		header_field);
}

static
void bt_packet_context_field_recycle(struct bt_field_wrapper *context_field,
		struct bt_stream_class *stream_class)
{
	BT_ASSERT(context_field);
	BT_LIB_LOGD("Recycling packet context field: "
		"addr=%p, %![sc-]+S, %![field-]+f", context_field,
		stream_class, context_field->field);
	bt_object_pool_recycle_object(&stream_class->packet_context_field_pool,
		context_field);
}

BT_HIDDEN
void bt_packet_recycle(struct bt_packet *packet)
{
	struct bt_stream *stream;

	BT_ASSERT(packet);
	BT_LIB_LOGD("Recycling packet: %!+a", packet);

	/*
	 * Those are the important ordered steps:
	 *
	 * 1. Reset the packet object (put any permanent reference it
	 *    has, unfreeze it and its fields in developer mode, etc.),
	 *    but do NOT put its stream's reference. This stream
	 *    contains the pool to which we're about to recycle this
	 *    packet object, so we must guarantee its existence thanks
	 *    to this existing reference.
	 *
	 * 2. Move the stream reference to our `stream`
	 *    variable so that we can set the packet's stream member
	 *    to NULL before recycling it. We CANNOT do this after
	 *    we put the stream reference because this bt_put()
	 *    could destroy the stream, also destroying its
	 *    packet pool, thus also destroying our packet object (this
	 *    would result in an invalid write access).
	 *
	 * 3. Recycle the packet object.
	 *
	 * 4. Put our stream reference.
	 */
	bt_packet_reset(packet);
	stream = packet->stream;
	BT_ASSERT(stream);
	packet->stream = NULL;
	bt_object_pool_recycle_object(&stream->packet_pool, packet);
	bt_object_put_no_null_check(&stream->common.base);
}

BT_HIDDEN
void bt_packet_destroy(struct bt_packet *packet)
{
	BT_LOGD("Destroying packet: addr=%p", packet);
	BT_LOGD_STR("Destroying packet's header field.");

	if (packet->header) {
		if (packet->stream) {
			BT_LOGD_STR("Recycling packet's header field.");
			bt_packet_header_field_recycle(packet->header,
				bt_stream_class_borrow_trace(
					bt_stream_borrow_class(packet->stream)));
		} else {
			bt_field_wrapper_destroy(packet->header);
		}
	}

	if (packet->context) {
		if (packet->stream) {
			BT_LOGD_STR("Recycling packet's context field.");
			bt_packet_context_field_recycle(packet->context,
				bt_stream_borrow_class(packet->stream));
		} else {
			bt_field_wrapper_destroy(packet->context);
		}
	}

	bt_clock_value_set_finalize(&packet->begin_cv_set);
	bt_clock_value_set_finalize(&packet->end_cv_set);
	BT_LOGD_STR("Putting packet's stream.");
	bt_put(packet->stream);
	g_free(packet);
}

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

	BT_ASSERT(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_borrow_class(stream);
	BT_ASSERT(stream_class);
	trace = bt_stream_class_borrow_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_shared(&packet->base,
		(bt_object_release_func) bt_packet_recycle);
	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_wrapper_create(
			&trace->packet_header_field_pool,
			(void *) trace->common.packet_header_field_type);
		if (!packet->header) {
			BT_LOGE("Cannot create packet header field wrapper.");
			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_wrapper_create(
			&stream_class->packet_context_field_pool,
			(void *) stream->common.stream_class->packet_context_field_type);
		if (!packet->context) {
			BT_LOGE("Cannot create packet context field wrapper.");
			BT_PUT(packet);
			goto end;
		}
	}

	if (bt_clock_value_set_initialize(&packet->begin_cv_set)) {
		BT_PUT(packet);
		goto end;
	}

	if (bt_clock_value_set_initialize(&packet->end_cv_set)) {
		BT_PUT(packet);
		goto end;
	}

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

end:
	return packet;
}

struct bt_packet *bt_packet_create(struct bt_stream *stream)
{
	struct bt_packet *packet = NULL;

	BT_ASSERT_PRE_NON_NULL(stream, "Stream");
	packet = bt_object_pool_create_object(&stream->packet_pool);
	if (unlikely(!packet)) {
		BT_LIB_LOGE("Cannot allocate one packet from stream's packet pool: "
			"%![stream-]+s", stream);
		goto end;
	}

	if (unlikely(!packet->stream)) {
		packet->stream = stream;
		bt_object_get_no_null_check_no_parent_check(
			&packet->stream->common.base);
	}

	goto end;

end:
	return packet;
}

int bt_packet_move_header(struct bt_packet *packet,
		struct bt_packet_header_field *header_field)
{
	struct bt_trace *trace;
	struct bt_field_wrapper *field_wrapper = (void *) header_field;

	BT_ASSERT_PRE_NON_NULL(packet, "Event");
	BT_ASSERT_PRE_NON_NULL(field_wrapper, "Header field");
	BT_ASSERT_PRE_HOT(packet, "Packet", ": %!+a", packet);
	trace = bt_stream_class_borrow_trace(
		bt_stream_borrow_class(packet->stream));
	BT_ASSERT_PRE(trace->common.packet_header_field_type,
		"Trace has no packet header field type: %!+t",
		trace);

	/* TODO: compare field types (precondition) */

	/* Recycle current header field: always exists */
	BT_ASSERT(packet->header);
	bt_packet_header_field_recycle(packet->header, trace);

	/* Move new field */
	packet->header = field_wrapper;
	return 0;
}

int bt_packet_move_context(struct bt_packet *packet,
		struct bt_packet_context_field *context_field)
{
	struct bt_stream_class *stream_class;
	struct bt_field_wrapper *field_wrapper = (void *) context_field;

	BT_ASSERT_PRE_NON_NULL(packet, "Event");
	BT_ASSERT_PRE_NON_NULL(field_wrapper, "Context field");
	BT_ASSERT_PRE_HOT(packet, "Packet", ": %!+a", packet);
	stream_class = bt_stream_borrow_class(packet->stream);
	BT_ASSERT_PRE(stream_class->common.packet_context_field_type,
		"Stream class has no packet context field type: %!+S",
		stream_class);

	/* TODO: compare field types (precondition) */

	/* Recycle current context field: always exists */
	BT_ASSERT(packet->context);
	bt_packet_context_field_recycle(packet->context, stream_class);

	/* Move new field */
	packet->context = field_wrapper;
	return 0;
}

int bt_packet_set_beginning_clock_value(struct bt_packet *packet,
		struct bt_clock_class *clock_class, uint64_t raw_value,
		bt_bool is_default)
{
	BT_ASSERT_PRE_NON_NULL(packet, "Packet");
	BT_ASSERT_PRE_NON_NULL(clock_class, "Clock class");
	BT_ASSERT_PRE_HOT(packet, "Packet", ": %!+a", packet);
	BT_ASSERT_PRE(is_default,
		"You can only set a default clock value as of this version.");
	return bt_clock_value_set_set_clock_value(&packet->begin_cv_set,
		clock_class, raw_value, is_default);
}

struct bt_clock_value *bt_packet_borrow_default_begin_clock_value(
		struct bt_packet *packet)
{
	struct bt_clock_value *clock_value = NULL;

	BT_ASSERT_PRE_NON_NULL(packet, "Packet");
	clock_value = packet->begin_cv_set.default_cv;
	if (!clock_value) {
		BT_LIB_LOGV("No default clock value: %![packet-]+a", packet);
	}

	return clock_value;
}

int bt_packet_set_end_clock_value(struct bt_packet *packet,
		struct bt_clock_class *clock_class, uint64_t raw_value,
		bt_bool is_default)
{
	BT_ASSERT_PRE_NON_NULL(packet, "Packet");
	BT_ASSERT_PRE_NON_NULL(clock_class, "Clock class");
	BT_ASSERT_PRE_HOT(packet, "Packet", ": %!+a", packet);
	BT_ASSERT_PRE(is_default,
		"You can only set a default clock value as of this version.");
	return bt_clock_value_set_set_clock_value(&packet->end_cv_set,
		clock_class, raw_value, is_default);
}

struct bt_clock_value *bt_packet_borrow_default_end_clock_value(
		struct bt_packet *packet)
{
	struct bt_clock_value *clock_value = NULL;

	BT_ASSERT_PRE_NON_NULL(packet, "Packet");
	clock_value = packet->end_cv_set.default_cv;
	if (!clock_value) {
		BT_LIB_LOGV("No default clock value: %![packet-]+a", packet);
	}

	return clock_value;
}
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>
312c056a	34	#include <babeltrace/ctf-ir/field-wrapper-internal.h>
f79cf0f0 PP	35	#include <babeltrace/ctf-ir/trace.h>
	36	#include <babeltrace/ctf-ir/stream-class-internal.h>
	37	#include <babeltrace/ctf-ir/stream-class.h>
	38	#include <babeltrace/ctf-ir/stream.h>
	39	#include <babeltrace/ctf-ir/stream-internal.h>
	40	#include <babeltrace/ctf-ir/trace-internal.h>
	41	#include <babeltrace/object-internal.h>
	42	#include <babeltrace/ref.h>
f6ccaed9	43	#include <babeltrace/assert-internal.h>
be514b0c	44	#include <inttypes.h>
f79cf0f0	45
094ff7c0	46	struct bt_stream bt_packet_borrow_stream(struct bt_packet packet)
f79cf0f0	47	{
f6ccaed9	48	BT_ASSERT_PRE_NON_NULL(packet, "Packet");
094ff7c0	49	return packet->stream;
f79cf0f0 PP	50	}
f79cf0f0 PP	51
312c056a	52	struct bt_field bt_packet_borrow_header(struct bt_packet packet)
f79cf0f0	53	{
f6ccaed9	54	BT_ASSERT_PRE_NON_NULL(packet, "Packet");
312c056a	55	return packet->header ? (void *) packet->header->field : NULL;
f79cf0f0 PP	56	}
f79cf0f0 PP	57
312c056a	58	struct bt_field bt_packet_borrow_context(struct bt_packet packet)
f79cf0f0	59	{
312c056a PP	60	BT_ASSERT_PRE_NON_NULL(packet, "Packet");
	61	return packet->context ? (void *) packet->context->field : NULL;
	62	}
c5c82c6e	63
312c056a	64	BT_HIDDEN
6c677fb5	65	void _bt_packet_set_is_frozen(struct bt_packet *packet, bool is_frozen)
312c056a PP	66	{
	67	if (!packet \|\| packet->frozen) {
	68	return;
c5c82c6e PP	69	}
c5c82c6e PP	70
312c056a PP	71	BT_LOGD("Freezing packet: addr=%p", packet);
	72
	73	if (packet->header) {
	74	BT_LOGD_STR("Freezing packet's header field.");
6c677fb5 PP	75	bt_field_set_is_frozen_recursive((void *) packet->header->field,
6c677fb5 PP	76	is_frozen);
f79cf0f0 PP	77	}
f79cf0f0 PP	78
312c056a PP	79	if (packet->context) {
312c056a PP	80	BT_LOGD_STR("Freezing packet's context field.");
6c677fb5 PP	81	bt_field_set_is_frozen_recursive((void *) packet->context->field,
6c677fb5 PP	82	is_frozen);
312c056a PP	83	}
312c056a PP	84
6c677fb5	85	packet->frozen = is_frozen;
f6ccaed9 PP	86	}
f6ccaed9 PP	87
312c056a PP	88	static inline
312c056a PP	89	void bt_packet_reset(struct bt_packet *packet)
f6ccaed9	90	{
312c056a	91	BT_ASSERT(packet);
6c677fb5	92	bt_packet_set_is_frozen(packet, false);
312c056a PP	93
	94	if (packet->header) {
	95	bt_field_set_is_frozen_recursive(
	96	(void *) packet->header->field, false);
	97	bt_field_reset_recursive((void *) packet->header->field);
	98	}
	99
	100	if (packet->context) {
	101	bt_field_set_is_frozen_recursive(
	102	(void *) packet->context->field, false);
	103	bt_field_reset_recursive((void *) packet->context->field);
	104	}
e22b45d0 PP	105
	106	bt_clock_value_set_reset(&packet->begin_cv_set);
	107	bt_clock_value_set_reset(&packet->end_cv_set);
f79cf0f0 PP	108	}
f79cf0f0 PP	109
312c056a PP	110	static
	111	void bt_packet_header_field_recycle(struct bt_field_wrapper *header_field,
	112	struct bt_trace *trace)
f79cf0f0	113	{
312c056a PP	114	BT_ASSERT(header_field);
	115	BT_LIB_LOGD("Recycling packet header field: "
	116	"addr=%p, %![trace-]+t, %![field-]+f", header_field,
	117	trace, header_field->field);
	118	bt_object_pool_recycle_object(&trace->packet_header_field_pool,
	119	header_field);
f79cf0f0 PP	120	}
f79cf0f0 PP	121
312c056a PP	122	static
	123	void bt_packet_context_field_recycle(struct bt_field_wrapper *context_field,
	124	struct bt_stream_class *stream_class)
f79cf0f0	125	{
312c056a PP	126	BT_ASSERT(context_field);
	127	BT_LIB_LOGD("Recycling packet context field: "
	128	"addr=%p, %![sc-]+S, %![field-]+f", context_field,
	129	stream_class, context_field->field);
	130	bt_object_pool_recycle_object(&stream_class->packet_context_field_pool,
	131	context_field);
f79cf0f0 PP	132	}
	133
	134	BT_HIDDEN
312c056a	135	void bt_packet_recycle(struct bt_packet *packet)
f79cf0f0	136	{
312c056a	137	struct bt_stream *stream;
f79cf0f0	138
312c056a PP	139	BT_ASSERT(packet);
	140	BT_LIB_LOGD("Recycling packet: %!+a", packet);
	141
	142	/*
	143	* Those are the important ordered steps:
	144	*
	145	* 1. Reset the packet object (put any permanent reference it
	146	* has, unfreeze it and its fields in developer mode, etc.),
	147	* but do NOT put its stream's reference. This stream
	148	* contains the pool to which we're about to recycle this
	149	* packet object, so we must guarantee its existence thanks
	150	* to this existing reference.
	151	*
	152	* 2. Move the stream reference to our `stream`
	153	* variable so that we can set the packet's stream member
	154	* to NULL before recycling it. We CANNOT do this after
	155	* we put the stream reference because this bt_put()
	156	* could destroy the stream, also destroying its
	157	* packet pool, thus also destroying our packet object (this
	158	* would result in an invalid write access).
	159	*
	160	* 3. Recycle the packet object.
	161	*
	162	* 4. Put our stream reference.
	163	*/
	164	bt_packet_reset(packet);
	165	stream = packet->stream;
	166	BT_ASSERT(stream);
	167	packet->stream = NULL;
	168	bt_object_pool_recycle_object(&stream->packet_pool, packet);
6c677fb5	169	bt_object_put_no_null_check(&stream->common.base);
f79cf0f0 PP	170	}
f79cf0f0 PP	171
312c056a PP	172	BT_HIDDEN
312c056a PP	173	void bt_packet_destroy(struct bt_packet *packet)
f79cf0f0	174	{
8ea705f0	175	BT_LOGD("Destroying packet: addr=%p", packet);
312c056a PP	176	BT_LOGD_STR("Destroying packet's header field.");
	177
	178	if (packet->header) {
	179	if (packet->stream) {
	180	BT_LOGD_STR("Recycling packet's header field.");
	181	bt_packet_header_field_recycle(packet->header,
	182	bt_stream_class_borrow_trace(
	183	bt_stream_borrow_class(packet->stream)));
	184	} else {
	185	bt_field_wrapper_destroy(packet->header);
	186	}
	187	}
	188
	189	if (packet->context) {
	190	if (packet->stream) {
	191	BT_LOGD_STR("Recycling packet's context field.");
	192	bt_packet_context_field_recycle(packet->context,
	193	bt_stream_borrow_class(packet->stream));
	194	} else {
	195	bt_field_wrapper_destroy(packet->context);
	196	}
	197	}
	198
e22b45d0 PP	199	bt_clock_value_set_finalize(&packet->begin_cv_set);
e22b45d0 PP	200	bt_clock_value_set_finalize(&packet->end_cv_set);
d409daba	201	BT_LOGD_STR("Putting packet's stream.");
f79cf0f0 PP	202	bt_put(packet->stream);
	203	g_free(packet);
	204	}
	205
312c056a PP	206	BT_HIDDEN
312c056a PP	207	struct bt_packet bt_packet_new(struct bt_stream stream)
f79cf0f0	208	{
50842bdc PP	209	struct bt_packet *packet = NULL;
	210	struct bt_stream_class *stream_class = NULL;
	211	struct bt_trace *trace = NULL;
f79cf0f0	212
312c056a	213	BT_ASSERT(stream);
be514b0c PP	214	BT_LOGD("Creating packet object: stream-addr=%p, "
	215	"stream-name=\"%s\", stream-class-addr=%p, "
	216	"stream-class-name=\"%s\", stream-class-id=%" PRId64,
50842bdc	217	stream, bt_stream_get_name(stream),
3dca2276 PP	218	stream->common.stream_class,
	219	bt_stream_class_common_get_name(stream->common.stream_class),
	220	bt_stream_class_common_get_id(stream->common.stream_class));
094ff7c0	221	stream_class = bt_stream_borrow_class(stream);
f6ccaed9	222	BT_ASSERT(stream_class);
094ff7c0	223	trace = bt_stream_class_borrow_trace(stream_class);
f6ccaed9	224	BT_ASSERT(trace);
50842bdc	225	packet = g_new0(struct bt_packet, 1);
f79cf0f0	226	if (!packet) {
8ea705f0	227	BT_LOGE_STR("Failed to allocate one packet object.");
f79cf0f0 PP	228	goto end;
	229	}
	230
3fea54f6 PP	231	bt_object_init_shared(&packet->base,
3fea54f6 PP	232	(bt_object_release_func) bt_packet_recycle);
f79cf0f0	233	packet->stream = bt_get(stream);
be514b0c	234
3dca2276	235	if (trace->common.packet_header_field_type) {
be514b0c	236	BT_LOGD("Creating initial packet header field: ft-addr=%p",
3dca2276	237	trace->common.packet_header_field_type);
312c056a PP	238	packet->header = bt_field_wrapper_create(
	239	&trace->packet_header_field_pool,
	240	(void *) trace->common.packet_header_field_type);
be514b0c	241	if (!packet->header) {
312c056a	242	BT_LOGE("Cannot create packet header field wrapper.");
be514b0c PP	243	BT_PUT(packet);
	244	goto end;
	245	}
f79cf0f0 PP	246	}
f79cf0f0 PP	247
3dca2276	248	if (stream->common.stream_class->packet_context_field_type) {
be514b0c	249	BT_LOGD("Creating initial packet context field: ft-addr=%p",
3dca2276	250	stream->common.stream_class->packet_context_field_type);
312c056a PP	251	packet->context = bt_field_wrapper_create(
	252	&stream_class->packet_context_field_pool,
	253	(void *) stream->common.stream_class->packet_context_field_type);
be514b0c	254	if (!packet->context) {
312c056a	255	BT_LOGE("Cannot create packet context field wrapper.");
be514b0c PP	256	BT_PUT(packet);
	257	goto end;
	258	}
f79cf0f0 PP	259	}
f79cf0f0 PP	260
e22b45d0 PP	261	if (bt_clock_value_set_initialize(&packet->begin_cv_set)) {
	262	BT_PUT(packet);
	263	goto end;
	264	}
	265
	266	if (bt_clock_value_set_initialize(&packet->end_cv_set)) {
	267	BT_PUT(packet);
	268	goto end;
	269	}
	270
8ea705f0 PP	271	BT_LOGD("Created packet object: addr=%p", packet);
8ea705f0 PP	272
f79cf0f0	273	end:
f79cf0f0 PP	274	return packet;
f79cf0f0 PP	275	}
312c056a PP	276
	277	struct bt_packet bt_packet_create(struct bt_stream stream)
	278	{
	279	struct bt_packet *packet = NULL;
	280
	281	BT_ASSERT_PRE_NON_NULL(stream, "Stream");
	282	packet = bt_object_pool_create_object(&stream->packet_pool);
6c677fb5	283	if (unlikely(!packet)) {
312c056a PP	284	BT_LIB_LOGE("Cannot allocate one packet from stream's packet pool: "
312c056a PP	285	"%![stream-]+s", stream);
6c677fb5	286	goto end;
312c056a PP	287	}
312c056a PP	288
6c677fb5 PP	289	if (unlikely(!packet->stream)) {
	290	packet->stream = stream;
	291	bt_object_get_no_null_check_no_parent_check(
	292	&packet->stream->common.base);
312c056a PP	293	}
	294
	295	goto end;
	296
312c056a PP	297	end:
	298	return packet;
	299	}
	300
	301	int bt_packet_move_header(struct bt_packet *packet,
	302	struct bt_packet_header_field *header_field)
	303	{
	304	struct bt_trace *trace;
	305	struct bt_field_wrapper field_wrapper = (void ) header_field;
	306
	307	BT_ASSERT_PRE_NON_NULL(packet, "Event");
	308	BT_ASSERT_PRE_NON_NULL(field_wrapper, "Header field");
e22b45d0	309	BT_ASSERT_PRE_HOT(packet, "Packet", ": %!+a", packet);
312c056a PP	310	trace = bt_stream_class_borrow_trace(
	311	bt_stream_borrow_class(packet->stream));
	312	BT_ASSERT_PRE(trace->common.packet_header_field_type,
	313	"Trace has no packet header field type: %!+t",
	314	trace);
	315
	316	/* TODO: compare field types (precondition) */
	317
	318	/* Recycle current header field: always exists */
	319	BT_ASSERT(packet->header);
	320	bt_packet_header_field_recycle(packet->header, trace);
	321
	322	/* Move new field */
	323	packet->header = field_wrapper;
	324	return 0;
	325	}
	326
	327	int bt_packet_move_context(struct bt_packet *packet,
	328	struct bt_packet_context_field *context_field)
	329	{
	330	struct bt_stream_class *stream_class;
	331	struct bt_field_wrapper field_wrapper = (void ) context_field;
	332
	333	BT_ASSERT_PRE_NON_NULL(packet, "Event");
	334	BT_ASSERT_PRE_NON_NULL(field_wrapper, "Context field");
e22b45d0	335	BT_ASSERT_PRE_HOT(packet, "Packet", ": %!+a", packet);
312c056a PP	336	stream_class = bt_stream_borrow_class(packet->stream);
	337	BT_ASSERT_PRE(stream_class->common.packet_context_field_type,
	338	"Stream class has no packet context field type: %!+S",
	339	stream_class);
	340
	341	/* TODO: compare field types (precondition) */
	342
	343	/* Recycle current context field: always exists */
	344	BT_ASSERT(packet->context);
	345	bt_packet_context_field_recycle(packet->context, stream_class);
	346
	347	/* Move new field */
	348	packet->context = field_wrapper;
	349	return 0;
	350	}
e22b45d0 PP	351
	352	int bt_packet_set_beginning_clock_value(struct bt_packet *packet,
	353	struct bt_clock_class *clock_class, uint64_t raw_value,
	354	bt_bool is_default)
	355	{
	356	BT_ASSERT_PRE_NON_NULL(packet, "Packet");
	357	BT_ASSERT_PRE_NON_NULL(clock_class, "Clock class");
	358	BT_ASSERT_PRE_HOT(packet, "Packet", ": %!+a", packet);
	359	BT_ASSERT_PRE(is_default,
	360	"You can only set a default clock value as of this version.");
	361	return bt_clock_value_set_set_clock_value(&packet->begin_cv_set,
	362	clock_class, raw_value, is_default);
	363	}
	364
	365	struct bt_clock_value *bt_packet_borrow_default_begin_clock_value(
	366	struct bt_packet *packet)
	367	{
	368	struct bt_clock_value *clock_value = NULL;
	369
	370	BT_ASSERT_PRE_NON_NULL(packet, "Packet");
	371	clock_value = packet->begin_cv_set.default_cv;
	372	if (!clock_value) {
	373	BT_LIB_LOGV("No default clock value: %![packet-]+a", packet);
	374	}
	375
	376	return clock_value;
	377	}
	378
	379	int bt_packet_set_end_clock_value(struct bt_packet *packet,
	380	struct bt_clock_class *clock_class, uint64_t raw_value,
	381	bt_bool is_default)
	382	{
	383	BT_ASSERT_PRE_NON_NULL(packet, "Packet");
	384	BT_ASSERT_PRE_NON_NULL(clock_class, "Clock class");
	385	BT_ASSERT_PRE_HOT(packet, "Packet", ": %!+a", packet);
	386	BT_ASSERT_PRE(is_default,
	387	"You can only set a default clock value as of this version.");
	388	return bt_clock_value_set_set_clock_value(&packet->end_cv_set,
	389	clock_class, raw_value, is_default);
	390	}
	391
	392	struct bt_clock_value *bt_packet_borrow_default_end_clock_value(
	393	struct bt_packet *packet)
	394	{
	395	struct bt_clock_value *clock_value = NULL;
	396
	397	BT_ASSERT_PRE_NON_NULL(packet, "Packet");
	398	clock_value = packet->end_cv_set.default_cv;
	399	if (!clock_value) {
	400	BT_LIB_LOGV("No default clock value: %![packet-]+a", packet);
	401	}
	402
	403	return clock_value;
	404	}