lib: trace IR, values: reset pointers to `NULL` on destruction
[babeltrace.git] / lib / trace-ir / packet.c
index d6677212ca6672994a857f6997e15cd75dbe98a0..983887c42ebe1166cd5a8612cf48d7f2e8ad1799 100644 (file)
@@ -1,8 +1,4 @@
 /*
- * packet.c
- *
- * Babeltrace trace IR - Stream packet
- *
  * Copyright 2016 Philippe Proulx <pproulx@efficios.com>
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy
@@ -29,6 +25,7 @@
 
 #include <babeltrace/assert-pre-internal.h>
 #include <babeltrace/trace-ir/fields-internal.h>
+#include <babeltrace/trace-ir/private-packet.h>
 #include <babeltrace/trace-ir/packet.h>
 #include <babeltrace/trace-ir/packet-internal.h>
 #include <babeltrace/trace-ir/field-wrapper-internal.h>
@@ -40,7 +37,7 @@
 #include <babeltrace/trace-ir/clock-value-internal.h>
 #include <babeltrace/trace-ir/trace-internal.h>
 #include <babeltrace/object-internal.h>
-#include <babeltrace/ref.h>
+#include <babeltrace/object.h>
 #include <babeltrace/assert-internal.h>
 #include <inttypes.h>
 
@@ -53,18 +50,36 @@ struct bt_stream *bt_packet_borrow_stream(struct bt_packet *packet)
        return packet->stream;
 }
 
+struct bt_private_stream *bt_private_packet_borrow_stream(
+               struct bt_private_packet *packet)
+{
+       return (void *) bt_packet_borrow_stream((void *) packet);
+}
+
 struct bt_field *bt_packet_borrow_header_field(struct bt_packet *packet)
 {
        BT_ASSERT_PRE_NON_NULL(packet, "Packet");
        return packet->header_field ? packet->header_field->field : NULL;
 }
 
+struct bt_private_field *bt_private_packet_borrow_header_field(
+               struct bt_private_packet *packet)
+{
+       return (void *) bt_packet_borrow_header_field((void *) packet);
+}
+
 struct bt_field *bt_packet_borrow_context_field(struct bt_packet *packet)
 {
        BT_ASSERT_PRE_NON_NULL(packet, "Packet");
        return packet->context_field ? packet->context_field->field : NULL;
 }
 
+struct bt_private_field *bt_private_packet_borrow_context_field(
+               struct bt_private_packet *packet)
+{
+       return (void *) bt_packet_borrow_context_field((void *) packet);
+}
+
 BT_HIDDEN
 void _bt_packet_set_is_frozen(struct bt_packet *packet, bool is_frozen)
 {
@@ -172,7 +187,7 @@ void bt_packet_recycle(struct bt_packet *packet)
         * 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()
+        *    we put the stream reference because this bt_object_put_ref()
         *    could destroy the stream, also destroying its
         *    packet pool, thus also destroying our packet object (this
         *    would result in an invalid write access).
@@ -203,6 +218,8 @@ void bt_packet_destroy(struct bt_packet *packet)
                } else {
                        bt_field_wrapper_destroy(packet->header_field);
                }
+
+               packet->header_field = NULL;
        }
 
        if (packet->context_field) {
@@ -213,20 +230,24 @@ void bt_packet_destroy(struct bt_packet *packet)
                } else {
                        bt_field_wrapper_destroy(packet->context_field);
                }
+
+               packet->context_field = NULL;
        }
 
        if (packet->default_beginning_cv) {
                BT_LOGD_STR("Recycling beginning clock value.");
                bt_clock_value_recycle(packet->default_beginning_cv);
+               packet->default_beginning_cv = NULL;
        }
 
        if (packet->default_end_cv) {
                BT_LOGD_STR("Recycling end clock value.");
                bt_clock_value_recycle(packet->default_end_cv);
+               packet->default_end_cv = NULL;
        }
 
        BT_LOGD_STR("Putting packet's stream.");
-       bt_put(packet->stream);
+       BT_OBJECT_PUT_REF_AND_RESET(packet->stream);
        g_free(packet);
 }
 
@@ -246,26 +267,26 @@ struct bt_packet *bt_packet_new(struct bt_stream *stream)
 
        bt_object_init_shared(&packet->base,
                (bt_object_release_func) bt_packet_recycle);
-       packet->stream = bt_get(stream);
+       packet->stream = bt_object_get_ref(stream);
        trace = bt_stream_class_borrow_trace_inline(stream->class);
        BT_ASSERT(trace);
 
-       if (trace->packet_header_ft) {
+       if (trace->packet_header_fc) {
                BT_LOGD_STR("Creating initial packet header field.");
                packet->header_field = bt_field_wrapper_create(
                        &trace->packet_header_field_pool,
-                       trace->packet_header_ft);
+                       trace->packet_header_fc);
                if (!packet->header_field) {
                        BT_LOGE_STR("Cannot create packet header field wrapper.");
                        goto error;
                }
        }
 
-       if (stream->class->packet_context_ft) {
+       if (stream->class->packet_context_fc) {
                BT_LOGD_STR("Creating initial packet context field.");
                packet->context_field = bt_field_wrapper_create(
                        &stream->class->packet_context_field_pool,
-                       stream->class->packet_context_ft);
+                       stream->class->packet_context_fc);
                if (!packet->context_field) {
                        BT_LOGE_STR("Cannot create packet context field wrapper.");
                        goto error;
@@ -297,14 +318,16 @@ struct bt_packet *bt_packet_new(struct bt_stream *stream)
        goto end;
 
 error:
-       BT_PUT(packet);
+       BT_OBJECT_PUT_REF_AND_RESET(packet);
 
 end:
        return packet;
 }
 
-struct bt_packet *bt_packet_create(struct bt_stream *stream)
+struct bt_private_packet *bt_private_packet_create(
+               struct bt_private_stream *priv_stream)
 {
+       struct bt_stream *stream = (void *) priv_stream;
        struct bt_packet *packet = NULL;
 
        BT_ASSERT_PRE_NON_NULL(stream, "Stream");
@@ -322,12 +345,14 @@ struct bt_packet *bt_packet_create(struct bt_stream *stream)
        }
 
 end:
-       return packet;
+       return (void *) packet;
 }
 
-int bt_packet_move_header_field(struct bt_packet *packet,
-               struct bt_packet_header_field *header_field)
+int bt_private_packet_move_header_field(
+               struct bt_private_packet *priv_packet,
+               struct bt_private_packet_header_field *header_field)
 {
+       struct bt_packet *packet = (void *) priv_packet;
        struct bt_trace *trace;
        struct bt_field_wrapper *field_wrapper = (void *) header_field;
 
@@ -335,14 +360,14 @@ int bt_packet_move_header_field(struct bt_packet *packet,
        BT_ASSERT_PRE_NON_NULL(field_wrapper, "Header field");
        BT_ASSERT_PRE_PACKET_HOT(packet);
        trace = bt_stream_class_borrow_trace_inline(packet->stream->class);
-       BT_ASSERT_PRE(trace->packet_header_ft,
-               "Trace has no packet header field type: %!+t",
+       BT_ASSERT_PRE(trace->packet_header_fc,
+               "Trace has no packet header field classe: %!+t",
                trace);
-       BT_ASSERT_PRE(field_wrapper->field->type ==
-               trace->packet_header_ft,
-               "Unexpected packet header field's type: "
-               "%![ft-]+F, %![expected-ft-]+F", field_wrapper->field->type,
-               trace->packet_header_ft);
+       BT_ASSERT_PRE(field_wrapper->field->class ==
+               trace->packet_header_fc,
+               "Unexpected packet header field's class: "
+               "%![fc-]+F, %![expected-fc-]+F", field_wrapper->field->class,
+               trace->packet_header_fc);
 
        /* Recycle current header field: always exists */
        BT_ASSERT(packet->header_field);
@@ -353,9 +378,11 @@ int bt_packet_move_header_field(struct bt_packet *packet,
        return 0;
 }
 
-int bt_packet_move_context_field(struct bt_packet *packet,
-               struct bt_packet_context_field *context_field)
+int bt_private_packet_move_context_field(
+               struct bt_private_packet *priv_packet,
+               struct bt_private_packet_context_field *context_field)
 {
+       struct bt_packet *packet = (void *) priv_packet;
        struct bt_stream_class *stream_class;
        struct bt_field_wrapper *field_wrapper = (void *) context_field;
 
@@ -363,14 +390,14 @@ int bt_packet_move_context_field(struct bt_packet *packet,
        BT_ASSERT_PRE_NON_NULL(field_wrapper, "Context field");
        BT_ASSERT_PRE_HOT(packet, "Packet", ": %!+a", packet);
        stream_class = packet->stream->class;
-       BT_ASSERT_PRE(stream_class->packet_context_ft,
-               "Stream class has no packet context field type: %!+S",
+       BT_ASSERT_PRE(stream_class->packet_context_fc,
+               "Stream class has no packet context field classe: %!+S",
                stream_class);
-       BT_ASSERT_PRE(field_wrapper->field->type ==
-               stream_class->packet_context_ft,
-               "Unexpected packet header field's type: "
-               "%![ft-]+F, %![expected-ft-]+F", field_wrapper->field->type,
-               stream_class->packet_context_ft);
+       BT_ASSERT_PRE(field_wrapper->field->class ==
+               stream_class->packet_context_fc,
+               "Unexpected packet header field's class: "
+               "%![fc-]+F, %![expected-fc-]+F", field_wrapper->field->class,
+               stream_class->packet_context_fc);
 
        /* Recycle current context field: always exists */
        BT_ASSERT(packet->context_field);
@@ -381,9 +408,11 @@ int bt_packet_move_context_field(struct bt_packet *packet,
        return 0;
 }
 
-int bt_packet_set_default_beginning_clock_value(struct bt_packet *packet,
+void bt_private_packet_set_default_beginning_clock_value(
+               struct bt_private_packet *priv_packet,
                uint64_t value_cycles)
 {
+       struct bt_packet *packet = (void *) priv_packet;
        struct bt_stream_class *sc;
 
        BT_ASSERT_PRE_NON_NULL(packet, "Packet");
@@ -398,10 +427,10 @@ int bt_packet_set_default_beginning_clock_value(struct bt_packet *packet,
                "no default beginning clock value: %![packet-]+a, %![sc-]+S",
                packet, sc);
        BT_ASSERT(packet->default_beginning_cv);
-       bt_clock_value_set_value_inline(packet->default_beginning_cv, value_cycles);
+       bt_clock_value_set_value_inline(packet->default_beginning_cv,
+               value_cycles);
        BT_LIB_LOGV("Set packet's default beginning clock value: "
-               "%![packet-]+a, value=%" PRIu64, value_cycles);
-       return 0;
+               "%![packet-]+a, value=%" PRIu64, packet, value_cycles);
 }
 
 enum bt_clock_value_status bt_packet_borrow_default_beginning_clock_value(
@@ -413,9 +442,11 @@ enum bt_clock_value_status bt_packet_borrow_default_beginning_clock_value(
        return BT_CLOCK_VALUE_STATUS_KNOWN;
 }
 
-int bt_packet_set_default_end_clock_value(struct bt_packet *packet,
+void bt_private_packet_set_default_end_clock_value(
+               struct bt_private_packet *priv_packet,
                uint64_t value_cycles)
 {
+       struct bt_packet *packet = (void *) priv_packet;
        struct bt_stream_class *sc;
 
        BT_ASSERT_PRE_NON_NULL(packet, "Packet");
@@ -432,8 +463,7 @@ int bt_packet_set_default_end_clock_value(struct bt_packet *packet,
        BT_ASSERT(packet->default_end_cv);
        bt_clock_value_set_value_inline(packet->default_end_cv, value_cycles);
        BT_LIB_LOGV("Set packet's default end clock value: "
-               "%![packet-]+a, value=%" PRIu64, value_cycles);
-       return 0;
+               "%![packet-]+a, value=%" PRIu64, packet, value_cycles);
 }
 
 enum bt_clock_value_status bt_packet_borrow_default_end_clock_value(
@@ -454,16 +484,17 @@ enum bt_property_availability bt_packet_get_discarded_event_counter_snapshot(
        return packet->discarded_event_counter_snapshot.base.avail;
 }
 
-int bt_packet_set_discarded_event_counter_snapshot(struct bt_packet *packet,
-               uint64_t value)
+void bt_private_packet_set_discarded_event_counter_snapshot(
+               struct bt_private_packet *priv_packet, uint64_t value)
 {
+       struct bt_packet *packet = (void *) priv_packet;
+
        BT_ASSERT_PRE_NON_NULL(packet, "Packet");
        BT_ASSERT_PRE_PACKET_HOT(packet);
        BT_ASSERT_PRE(packet->stream->class->packets_have_discarded_event_counter_snapshot,
                "Packet's stream's discarded event counter is not enabled: "
                "%![packet-]+a", packet);
        bt_property_uint_set(&packet->discarded_event_counter_snapshot, value);
-       return 0;
 }
 
 enum bt_property_availability bt_packet_get_packet_counter_snapshot(
@@ -475,14 +506,15 @@ enum bt_property_availability bt_packet_get_packet_counter_snapshot(
        return packet->packet_counter_snapshot.base.avail;
 }
 
-int bt_packet_set_packet_counter_snapshot(struct bt_packet *packet,
-               uint64_t value)
+void bt_private_packet_set_packet_counter_snapshot(
+               struct bt_private_packet *priv_packet, uint64_t value)
 {
+       struct bt_packet *packet = (void *) priv_packet;
+
        BT_ASSERT_PRE_NON_NULL(packet, "Packet");
        BT_ASSERT_PRE_PACKET_HOT(packet);
        BT_ASSERT_PRE(packet->stream->class->packets_have_packet_counter_snapshot,
                "Packet's stream's packet counter is not enabled: "
                "%![packet-]+a", packet);
        bt_property_uint_set(&packet->packet_counter_snapshot, value);
-       return 0;
 }
This page took 0.027671 seconds and 4 git commands to generate.