X-Git-Url: http://git.efficios.com/?a=blobdiff_plain;f=lib%2Fctf-ir%2Fpacket.c;h=227a7fd9c959776e19f0d5ede7f8a84a5f1e431e;hb=3fea54f69edd1780566230255da196cb6e82df62;hp=fd31398dbdb9018a838a7e3a14ff1353b14adb4b;hpb=d409daba48de62cd973f8cc4ba60739afb4d280f;p=babeltrace.git

diff --git a/lib/ctf-ir/packet.c b/lib/ctf-ir/packet.c
index fd31398d..227a7fd9 100644
--- a/lib/ctf-ir/packet.c
+++ b/lib/ctf-ir/packet.c
@@ -25,231 +25,313 @@
  */
 
 #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/lib-logging-internal.h>
 #include <babeltrace/object-internal.h>
 #include <babeltrace/ref.h>
+#include <babeltrace/assert-internal.h>
+#include <inttypes.h>
 
-struct bt_ctf_stream *bt_ctf_packet_get_stream(struct bt_ctf_packet *packet)
+struct bt_stream *bt_packet_borrow_stream(struct bt_packet *packet)
 {
-	return packet ? bt_get(packet->stream) : NULL;
+	BT_ASSERT_PRE_NON_NULL(packet, "Packet");
+	return packet->stream;
 }
 
-struct bt_ctf_field *bt_ctf_packet_get_header(
-		struct bt_ctf_packet *packet)
+struct bt_field *bt_packet_borrow_header(struct bt_packet *packet)
 {
-	return packet ? bt_get(packet->header) : NULL;
+	BT_ASSERT_PRE_NON_NULL(packet, "Packet");
+	return packet->header ? (void *) packet->header->field : NULL;
 }
 
-int bt_ctf_packet_set_header(struct bt_ctf_packet *packet,
-		struct bt_ctf_field *header)
+struct bt_field *bt_packet_borrow_context(struct bt_packet *packet)
 {
-	int ret = 0;
-	struct bt_ctf_trace *trace = NULL;
-	struct bt_ctf_stream_class *stream_class = NULL;
-	struct bt_ctf_field_type *header_field_type = NULL;
-	struct bt_ctf_field_type *expected_header_field_type = NULL;
+	BT_ASSERT_PRE_NON_NULL(packet, "Packet");
+	return packet->context ? (void *) packet->context->field : NULL;
+}
 
-	if (!packet) {
-		BT_LOGW_STR("Invalid parameter: packet is NULL.");
-		ret = -1;
-		goto end;
+BT_HIDDEN
+void _bt_packet_freeze(struct bt_packet *packet)
+{
+	if (!packet || packet->frozen) {
+		return;
 	}
 
-	if (packet->frozen) {
-		BT_LOGW("Invalid parameter: packet is frozen: addr=%p",
-			packet);
-		ret = -1;
-		goto end;
-	}
+	BT_LOGD("Freezing packet: addr=%p", packet);
 
-	if (!header) {
-		goto skip_validation;
+	if (packet->header) {
+		BT_LOGD_STR("Freezing packet's header field.");
+		bt_field_set_is_frozen_recursive((void *) packet->header->field, true);
 	}
 
-	stream_class = bt_ctf_stream_get_class(packet->stream);
-	assert(stream_class);
-	trace = bt_ctf_stream_class_get_trace(stream_class);
-	assert(trace);
-	header_field_type = bt_ctf_field_get_type(header);
-	assert(header_field_type);
-	expected_header_field_type = bt_ctf_trace_get_packet_header_type(trace);
-
-	if (bt_ctf_field_type_compare(header_field_type,
-			expected_header_field_type)) {
-		BT_LOGW("Invalid parameter: packet header's field type is different from the trace's packet header field type: "
-			"packet-addr=%p, packet-header-addr=%p",
-			packet, header);
-		ret = -1;
-		goto end;
+	if (packet->context) {
+		BT_LOGD_STR("Freezing packet's context field.");
+		bt_field_set_is_frozen_recursive((void *) packet->context->field, true);
 	}
 
-skip_validation:
-	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);
-
-end:
-	BT_PUT(trace);
-	BT_PUT(stream_class);
-	BT_PUT(header_field_type);
-	BT_PUT(expected_header_field_type);
-
-	return ret;
-}
-
-struct bt_ctf_field *bt_ctf_packet_get_context(
-		struct bt_ctf_packet *packet)
-{
-	return packet ? bt_get(packet->context) : NULL;
+	packet->frozen = 1;
 }
 
-int bt_ctf_packet_set_context(struct bt_ctf_packet *packet,
-		struct bt_ctf_field *context)
+static inline
+void bt_packet_reset(struct bt_packet *packet)
 {
-	int ret = 0;
-	struct bt_ctf_stream_class *stream_class = NULL;
-	struct bt_ctf_field_type *context_field_type = NULL;
-	struct bt_ctf_field_type *expected_context_field_type = NULL;
+	BT_ASSERT(packet);
+	packet->frozen = false;
 
-	if (!packet) {
-		BT_LOGW_STR("Invalid parameter: packet is NULL.");
-		ret = -1;
-		goto end;
-	}
-
-	if (packet->frozen) {
-		BT_LOGW("Invalid parameter: packet is frozen: addr=%p",
-			packet);
-		ret = -1;
-		goto end;
+	if (packet->header) {
+		bt_field_set_is_frozen_recursive(
+			(void *) packet->header->field, false);
+		bt_field_reset_recursive((void *) packet->header->field);
 	}
 
-	if (!context) {
-		goto skip_validation;
-	}
-
-	stream_class = bt_ctf_stream_get_class(packet->stream);
-	assert(stream_class);
-	context_field_type = bt_ctf_field_get_type(context);
-	assert(context_field_type);
-	expected_context_field_type =
-		bt_ctf_stream_class_get_packet_context_type(stream_class);
-
-	if (bt_ctf_field_type_compare(context_field_type,
-			expected_context_field_type)) {
-		BT_LOGW("Invalid parameter: packet context's field type is different from the stream class's packet context field type: "
-			"packet-addr=%p, packet-context-addr=%p",
-			packet, context);
-		ret = -1;
-		goto end;
+	if (packet->context) {
+		bt_field_set_is_frozen_recursive(
+			(void *) packet->context->field, false);
+		bt_field_reset_recursive((void *) packet->context->field);
 	}
+}
 
-skip_validation:
-	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);
+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);
+}
 
-end:
-	BT_PUT(stream_class);
-	BT_PUT(context_field_type);
-	BT_PUT(expected_context_field_type);
-	return ret;
+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_ctf_packet_freeze(struct bt_ctf_packet *packet)
+void bt_packet_recycle(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_ctf_field_freeze(packet->header);
-	BT_LOGD_STR("Freezing packet's context field.");
-	bt_ctf_field_freeze(packet->context);
-	packet->frozen = 1;
+	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_put(stream);
 }
 
-static
-void bt_ctf_packet_destroy(struct bt_object *obj)
+BT_HIDDEN
+void bt_packet_destroy(struct bt_packet *packet)
 {
-	struct bt_ctf_packet *packet;
-
-	packet = container_of(obj, struct bt_ctf_packet, base);
 	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("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_LOGD_STR("Putting packet's stream.");
 	bt_put(packet->stream);
 	g_free(packet);
 }
 
-struct bt_ctf_packet *bt_ctf_packet_create(
-		struct bt_ctf_stream *stream)
+BT_HIDDEN
+struct bt_packet *bt_packet_new(struct bt_stream *stream)
 {
-	struct bt_ctf_packet *packet = NULL;
-	struct bt_ctf_stream_class *stream_class = NULL;
-	struct bt_ctf_trace *trace = NULL;
-
-	BT_LOGD("Creating packet object: stream-addr=%p", stream);
-
-	if (!stream) {
-		BT_LOGW_STR("Invalid parameter: stream is NULL.");
-		goto end;
-	}
-
-	if (stream->pos.fd >= 0) {
-		BT_LOGW_STR("Invalid parameter: stream is a CTF writer stream.");
-		goto end;
-	}
-
-	stream_class = bt_ctf_stream_get_class(stream);
-	assert(stream_class);
-	trace = bt_ctf_stream_class_get_trace(stream_class);
-	assert(trace);
-	packet = g_new0(struct bt_ctf_packet, 1);
+	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(packet, bt_ctf_packet_destroy);
+	bt_object_init_shared(&packet->base,
+		(bt_object_release_func) bt_packet_recycle);
 	packet->stream = bt_get(stream);
-	packet->header = bt_ctf_field_create(trace->packet_header_type);
-	if (!packet->header && trace->packet_header_type) {
-		BT_LOGE_STR("Cannot create initial packet header field object.");
-		BT_PUT(packet);
-		goto end;
+
+	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;
+		}
 	}
 
-	packet->context = bt_ctf_field_create(
-		stream->stream_class->packet_context_type);
-	if (!packet->context && stream->stream_class->packet_context_type) {
-		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_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;
+		}
 	}
 
 	BT_LOGD("Created packet object: addr=%p", packet);
 
 end:
-	BT_PUT(trace);
-	BT_PUT(stream_class);
+	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 (!packet) {
+		BT_LIB_LOGE("Cannot allocate one packet from stream's packet pool: "
+			"%![stream-]+s", stream);
+		goto error;
+	}
+
+	if (!packet->stream) {
+		packet->stream = bt_get(stream);
+	}
+
+	goto end;
 
+error:
+	if (packet) {
+		bt_packet_recycle(packet);
+		packet = NULL;
+	}
+
+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;
+}