Split CTF IR and CTF writer APIs and implementations
[babeltrace.git] / lib / ctf-ir / packet.c
index d02d45bf76792c3ca0737119c9621e553b5f1b50..0004cffd1b85d6f6309079f910380b9418765575 100644 (file)
@@ -25,7 +25,9 @@
  */
 
 #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/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_get_stream(struct bt_packet *packet)
 {
-       return packet ? bt_get(packet->stream) : NULL;
+       BT_ASSERT_PRE_NON_NULL(packet, "Packet");
+       return bt_get(packet->stream);
 }
 
-struct bt_ctf_field *bt_ctf_packet_get_header(
-               struct bt_ctf_packet *packet)
+struct bt_field *bt_packet_get_header(
+               struct bt_packet *packet)
 {
-       return packet ? bt_get(packet->header) : NULL;
+       BT_ASSERT_PRE_NON_NULL(packet, "Packet");
+       return bt_get(packet->header);
 }
 
-int bt_ctf_packet_set_header(struct bt_ctf_packet *packet,
-               struct bt_ctf_field *header)
+BT_ASSERT_PRE_FUNC
+static inline bool validate_field_to_set(struct bt_field *field,
+               struct bt_field_type_common *expected_ft)
 {
-       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;
+       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;
+               }
 
-       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;
+       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;
        }
 
-       if (!header) {
-               goto skip_validation;
-       }
-
-       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;
-       }
+end:
+       return ret;
+}
 
-skip_validation:
+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);
-
-end:
-       BT_PUT(trace);
-       BT_PUT(stream_class);
-       BT_PUT(header_field_type);
-       BT_PUT(expected_header_field_type);
-
-       return ret;
+       return 0;
 }
 
-struct bt_ctf_field *bt_ctf_packet_get_context(
-               struct bt_ctf_packet *packet)
+struct bt_field *bt_packet_get_context(struct bt_packet *packet)
 {
-       return packet ? bt_get(packet->context) : NULL;
+       BT_ASSERT_PRE_NON_NULL(packet, "Packet");
+       return bt_get(packet->context);
 }
 
-int bt_ctf_packet_set_context(struct bt_ctf_packet *packet,
-               struct bt_ctf_field *context)
+int bt_packet_set_context(struct bt_packet *packet,
+               struct bt_field *context)
 {
-       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;
-
-       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 (!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;
-       }
-
-skip_validation:
+       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);
-
-end:
-       BT_PUT(stream_class);
-       BT_PUT(context_field_type);
-       BT_PUT(expected_context_field_type);
-       return ret;
+       return 0;
 }
 
 BT_HIDDEN
-void bt_ctf_packet_freeze(struct bt_ctf_packet *packet)
+void _bt_packet_freeze(struct bt_packet *packet)
 {
        if (!packet || packet->frozen) {
                return;
        }
 
        BT_LOGD("Freezing packet: addr=%p", packet);
-       bt_ctf_field_freeze(packet->header);
-       bt_ctf_field_freeze(packet->context);
+       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_ctf_packet_destroy(struct bt_object *obj)
+void bt_packet_destroy(struct bt_object *obj)
 {
-       struct bt_ctf_packet *packet;
+       struct bt_packet *packet = (void *) obj;
 
-       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("Putting packet's stream.");
        bt_put(packet->stream);
        g_free(packet);
 }
 
-struct bt_ctf_packet *bt_ctf_packet_create(
-               struct bt_ctf_stream *stream)
+struct bt_packet *bt_packet_create(
+               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_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_ctf_packet_destroy);
+       bt_object_init(packet, bt_packet_destroy);
        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_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;
+               }
        }
 
-       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_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);
This page took 0.026325 seconds and 4 git commands to generate.