lib: make trace IR API const-correct

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

diff --git a/lib/trace-ir/packet.c b/lib/trace-ir/packet.c
index a6a122355de832cdfec7cbfe780079dc0dc81783..d71c62ed98e30e323532619fd82446520873cd17 100644 (file)
--- a/lib/trace-ir/packet.c
+++ b/lib/trace-ir/packet.c
@@ -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/packet-const.h>
 #include <babeltrace/trace-ir/packet.h>
 #include <babeltrace/trace-ir/packet-internal.h>
 #include <babeltrace/trace-ir/field-wrapper-internal.h>
@@ -53,20 +50,38 @@ struct bt_stream *bt_packet_borrow_stream(struct bt_packet *packet)
        return packet->stream;
 }
 
+const struct bt_stream *bt_packet_borrow_stream_const(
+               const struct bt_packet *packet)
+{
+       return 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;
 }
 
+const struct bt_field *bt_packet_borrow_header_field_const(
+               const struct bt_packet *packet)
+{
+       return 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;
 }
 
+const struct bt_field *bt_packet_borrow_context_field_const(
+               const struct bt_packet *packet)
+{
+       return bt_packet_borrow_context_field((void *) packet);
+}
+
 BT_HIDDEN
-void _bt_packet_set_is_frozen(struct bt_packet *packet, bool is_frozen)
+void _bt_packet_set_is_frozen(const struct bt_packet *packet, bool is_frozen)
 {
        if (!packet) {
                return;
@@ -87,7 +102,7 @@ void _bt_packet_set_is_frozen(struct bt_packet *packet, bool is_frozen)
                        is_frozen);
        }
 
-       packet->frozen = is_frozen;
+       ((struct bt_packet *) packet)->frozen = is_frozen;
 }
 
 static inline
@@ -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_object_put_ref(packet->stream);
+       BT_OBJECT_PUT_REF_AND_RESET(packet->stream);
        g_free(packet);
 }
 
@@ -246,7 +267,8 @@ 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_object_get_ref(stream);
+       packet->stream = stream;
+       bt_object_get_no_null_check(stream);
        trace = bt_stream_class_borrow_trace_inline(stream->class);
        BT_ASSERT(trace);
 
@@ -322,7 +344,7 @@ 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,
@@ -381,7 +403,7 @@ 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_packet_set_default_beginning_clock_value(struct bt_packet *packet,
                uint64_t value_cycles)
 {
        struct bt_stream_class *sc;
@@ -398,14 +420,15 @@ 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(
-               struct bt_packet *packet, struct bt_clock_value **clock_value)
+               const struct bt_packet *packet,
+               const struct bt_clock_value **clock_value)
 {
        BT_ASSERT_PRE_NON_NULL(packet, "Packet");
        BT_ASSERT_PRE_NON_NULL(clock_value, "Clock value (output)");
@@ -413,7 +436,7 @@ 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_packet_set_default_end_clock_value(struct bt_packet *packet,
                uint64_t value_cycles)
 {
        struct bt_stream_class *sc;
@@ -432,12 +455,12 @@ 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(
-               struct bt_packet *packet, struct bt_clock_value **clock_value)
+               const struct bt_packet *packet,
+               const struct bt_clock_value **clock_value)
 {
        BT_ASSERT_PRE_NON_NULL(packet, "Packet");
        BT_ASSERT_PRE_NON_NULL(clock_value, "Clock value (output)");
@@ -446,7 +469,7 @@ enum bt_clock_value_status bt_packet_borrow_default_end_clock_value(
 }
 
 enum bt_property_availability bt_packet_get_discarded_event_counter_snapshot(
-               struct bt_packet *packet, uint64_t *value)
+               const struct bt_packet *packet, uint64_t *value)
 {
        BT_ASSERT_PRE_NON_NULL(packet, "Packet");
        BT_ASSERT_PRE_NON_NULL(value, "Value (output)");
@@ -454,7 +477,7 @@ 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,
+void bt_packet_set_discarded_event_counter_snapshot(struct bt_packet *packet,
                uint64_t value)
 {
        BT_ASSERT_PRE_NON_NULL(packet, "Packet");
@@ -463,11 +486,10 @@ int bt_packet_set_discarded_event_counter_snapshot(struct bt_packet *packet,
                "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(
-               struct bt_packet *packet, uint64_t *value)
+               const struct bt_packet *packet, uint64_t *value)
 {
        BT_ASSERT_PRE_NON_NULL(packet, "Packet");
        BT_ASSERT_PRE_NON_NULL(value, "Value (output)");
@@ -475,7 +497,7 @@ 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,
+void bt_packet_set_packet_counter_snapshot(struct bt_packet *packet,
                uint64_t value)
 {
        BT_ASSERT_PRE_NON_NULL(packet, "Packet");
@@ -484,5 +506,4 @@ int bt_packet_set_packet_counter_snapshot(struct bt_packet *packet,
                "Packet's stream's packet counter is not enabled: "
                "%![packet-]+a", packet);
        bt_property_uint_set(&packet->packet_counter_snapshot, value);
-       return 0;
 }