lib: make trace IR API const-correct
[babeltrace.git] / lib / trace-ir / stream-class.c
index cc51cced718acaf6a8757e7b27251d8caafbcd71..3d8d9c37d6a7a6c81a9c9141e355566d8a3b4cb8 100644 (file)
@@ -1,8 +1,4 @@
 /*
- * stream-class.c
- *
- * Babeltrace trace IR - Stream Class
- *
  * Copyright 2013, 2014 Jérémie Galarneau <jeremie.galarneau@efficios.com>
  *
  * Author: Jérémie Galarneau <jeremie.galarneau@efficios.com>
@@ -35,6 +31,8 @@
 #include <babeltrace/trace-ir/field-classes-internal.h>
 #include <babeltrace/trace-ir/fields-internal.h>
 #include <babeltrace/trace-ir/stream-class-internal.h>
+#include <babeltrace/trace-ir/trace-const.h>
+#include <babeltrace/trace-ir/trace-internal.h>
 #include <babeltrace/trace-ir/utils-internal.h>
 #include <babeltrace/trace-ir/field-wrapper-internal.h>
 #include <babeltrace/trace-ir/resolve-field-path-internal.h>
@@ -58,23 +56,26 @@ void destroy_stream_class(struct bt_object *obj)
 
        BT_LIB_LOGD("Destroying stream class: %!+S", stream_class);
        BT_LOGD_STR("Putting default clock class.");
-       bt_object_put_ref(stream_class->default_clock_class);
+       BT_OBJECT_PUT_REF_AND_RESET(stream_class->default_clock_class);
 
        if (stream_class->event_classes) {
                BT_LOGD_STR("Destroying event classes.");
                g_ptr_array_free(stream_class->event_classes, TRUE);
+               stream_class->event_classes = NULL;
        }
 
        if (stream_class->name.str) {
                g_string_free(stream_class->name.str, TRUE);
+               stream_class->name.str = NULL;
+               stream_class->name.value = NULL;
        }
 
        BT_LOGD_STR("Putting event header field classe.");
-       bt_object_put_ref(stream_class->event_header_fc);
+       BT_OBJECT_PUT_REF_AND_RESET(stream_class->event_header_fc);
        BT_LOGD_STR("Putting packet context field classe.");
-       bt_object_put_ref(stream_class->packet_context_fc);
+       BT_OBJECT_PUT_REF_AND_RESET(stream_class->packet_context_fc);
        BT_LOGD_STR("Putting event common context field classe.");
-       bt_object_put_ref(stream_class->event_common_context_fc);
+       BT_OBJECT_PUT_REF_AND_RESET(stream_class->event_common_context_fc);
        bt_object_pool_finalize(&stream_class->event_header_field_pool);
        bt_object_pool_finalize(&stream_class->packet_context_field_pool);
        g_free(stream_class);
@@ -89,13 +90,13 @@ void free_field_wrapper(struct bt_field_wrapper *field_wrapper,
 
 BT_ASSERT_PRE_FUNC
 static
-bool stream_class_id_is_unique(struct bt_trace *trace, uint64_t id)
+bool stream_class_id_is_unique(const struct bt_trace *trace, uint64_t id)
 {
        uint64_t i;
        bool is_unique = true;
 
        for (i = 0; i < trace->stream_classes->len; i++) {
-               struct bt_stream_class *sc =
+               const struct bt_stream_class *sc =
                        trace->stream_classes->pdata[i];
 
                if (sc->id == id) {
@@ -200,19 +201,27 @@ struct bt_stream_class *bt_stream_class_create_with_id(
        return create_stream_class_with_id(trace, id);
 }
 
-struct bt_trace *bt_stream_class_borrow_trace(struct bt_stream_class *stream_class)
+struct bt_trace *bt_stream_class_borrow_trace(
+               struct bt_stream_class *stream_class)
 {
        BT_ASSERT_PRE_NON_NULL(stream_class, "Stream class");
        return bt_stream_class_borrow_trace_inline(stream_class);
 }
 
-const char *bt_stream_class_get_name(struct bt_stream_class *stream_class)
+const struct bt_trace *bt_stream_class_borrow_trace_const(
+               const struct bt_stream_class *stream_class)
+{
+       return bt_stream_class_borrow_trace((void *) stream_class);
+}
+
+const char *bt_stream_class_get_name(const struct bt_stream_class *stream_class)
 {
        BT_ASSERT_PRE_NON_NULL(stream_class, "Stream class");
        return stream_class->name.value;
 }
 
-int bt_stream_class_set_name(struct bt_stream_class *stream_class,
+int bt_stream_class_set_name(
+               struct bt_stream_class *stream_class,
                const char *name)
 {
        BT_ASSERT_PRE_NON_NULL(stream_class, "Stream class");
@@ -224,14 +233,14 @@ int bt_stream_class_set_name(struct bt_stream_class *stream_class,
        return 0;
 }
 
-uint64_t bt_stream_class_get_id(struct bt_stream_class *stream_class)
+uint64_t bt_stream_class_get_id(const struct bt_stream_class *stream_class)
 {
        BT_ASSERT_PRE_NON_NULL(stream_class, "Stream class");
        return stream_class->id;
 }
 
 uint64_t bt_stream_class_get_event_class_count(
-               struct bt_stream_class *stream_class)
+               const struct bt_stream_class *stream_class)
 {
        BT_ASSERT_PRE_NON_NULL(stream_class, "Stream class");
        return (uint64_t) stream_class->event_classes->len;
@@ -245,17 +254,25 @@ struct bt_event_class *bt_stream_class_borrow_event_class_by_index(
        return g_ptr_array_index(stream_class->event_classes, index);
 }
 
+const struct bt_event_class *
+bt_stream_class_borrow_event_class_by_index_const(
+               const struct bt_stream_class *stream_class, uint64_t index)
+{
+       return bt_stream_class_borrow_event_class_by_index(
+               (void *) stream_class, index);
+}
+
 struct bt_event_class *bt_stream_class_borrow_event_class_by_id(
-               struct bt_stream_class *trace, uint64_t id)
+               struct bt_stream_class *stream_class, uint64_t id)
 {
        struct bt_event_class *event_class = NULL;
        uint64_t i;
 
-       BT_ASSERT_PRE_NON_NULL(trace, "Trace");
+       BT_ASSERT_PRE_NON_NULL(stream_class, "Trace");
 
-       for (i = 0; i < trace->event_classes->len; i++) {
+       for (i = 0; i < stream_class->event_classes->len; i++) {
                struct bt_event_class *event_class_candidate =
-                       g_ptr_array_index(trace->event_classes, i);
+                       g_ptr_array_index(stream_class->event_classes, i);
 
                if (event_class_candidate->id == id) {
                        event_class = event_class_candidate;
@@ -267,8 +284,17 @@ end:
        return event_class;
 }
 
-struct bt_field_class *bt_stream_class_borrow_packet_context_field_class(
-               struct bt_stream_class *stream_class)
+const struct bt_event_class *
+bt_stream_class_borrow_event_class_by_id_const(
+               const struct bt_stream_class *stream_class, uint64_t id)
+{
+       return bt_stream_class_borrow_event_class_by_id(
+               (void *) stream_class, id);
+}
+
+const struct bt_field_class *
+bt_stream_class_borrow_packet_context_field_class_const(
+               const struct bt_stream_class *stream_class)
 {
        BT_ASSERT_PRE_NON_NULL(stream_class, "Stream class");
        return stream_class->packet_context_fc;
@@ -304,7 +330,8 @@ int bt_stream_class_set_packet_context_field_class(
 
        bt_field_class_make_part_of_trace(field_class);
        bt_object_put_ref(stream_class->packet_context_fc);
-       stream_class->packet_context_fc = bt_object_get_ref(field_class);
+       stream_class->packet_context_fc = field_class;
+       bt_object_get_no_null_check(stream_class->packet_context_fc);
        bt_field_class_freeze(field_class);
        BT_LIB_LOGV("Set stream class's packet context field classe: %!+S",
                stream_class);
@@ -313,8 +340,8 @@ end:
        return ret;
 }
 
-struct bt_field_class *bt_stream_class_borrow_event_header_field_class(
-               struct bt_stream_class *stream_class)
+const struct bt_field_class *bt_stream_class_borrow_event_header_field_class_const(
+               const struct bt_stream_class *stream_class)
 {
        BT_ASSERT_PRE_NON_NULL(stream_class, "Stream class");
        return stream_class->event_header_fc;
@@ -351,7 +378,8 @@ int bt_stream_class_set_event_header_field_class(
 
        bt_field_class_make_part_of_trace(field_class);
        bt_object_put_ref(stream_class->event_header_fc);
-       stream_class->event_header_fc = bt_object_get_ref(field_class);
+       stream_class->event_header_fc = field_class;
+       bt_object_get_no_null_check(stream_class->event_header_fc);
        bt_field_class_freeze(field_class);
        BT_LIB_LOGV("Set stream class's event header field classe: %!+S",
                stream_class);
@@ -360,8 +388,9 @@ end:
        return ret;
 }
 
-struct bt_field_class *bt_stream_class_borrow_event_common_context_field_class(
-               struct bt_stream_class *stream_class)
+const struct bt_field_class *
+bt_stream_class_borrow_event_common_context_field_class_const(
+               const struct bt_stream_class *stream_class)
 {
        BT_ASSERT_PRE_NON_NULL(stream_class, "Stream class");
        return stream_class->event_common_context_fc;
@@ -399,7 +428,8 @@ int bt_stream_class_set_event_common_context_field_class(
 
        bt_field_class_make_part_of_trace(field_class);
        bt_object_put_ref(stream_class->event_common_context_fc);
-       stream_class->event_common_context_fc = bt_object_get_ref(field_class);
+       stream_class->event_common_context_fc = field_class;
+       bt_object_get_no_null_check(stream_class->event_common_context_fc);
        bt_field_class_freeze(field_class);
        BT_LIB_LOGV("Set stream class's event common context field classe: %!+S",
                stream_class);
@@ -409,12 +439,12 @@ end:
 }
 
 BT_HIDDEN
-void _bt_stream_class_freeze(struct bt_stream_class *stream_class)
+void _bt_stream_class_freeze(const struct bt_stream_class *stream_class)
 {
        /* The field classes and default clock class are already frozen */
        BT_ASSERT(stream_class);
        BT_LIB_LOGD("Freezing stream class: %!+S", stream_class);
-       stream_class->frozen = true;
+       ((struct bt_stream_class *) stream_class)->frozen = true;
 }
 
 int bt_stream_class_set_default_clock_class(
@@ -425,7 +455,8 @@ int bt_stream_class_set_default_clock_class(
        BT_ASSERT_PRE_NON_NULL(clock_class, "Clock class");
        BT_ASSERT_PRE_STREAM_CLASS_HOT(stream_class);
        bt_object_put_ref(stream_class->default_clock_class);
-       stream_class->default_clock_class = bt_object_get_ref(clock_class);
+       stream_class->default_clock_class = clock_class;
+       bt_object_get_no_null_check(stream_class->default_clock_class);
        bt_clock_class_freeze(clock_class);
        BT_LIB_LOGV("Set stream class's default clock class: %!+S",
                stream_class);
@@ -439,51 +470,59 @@ struct bt_clock_class *bt_stream_class_borrow_default_clock_class(
        return stream_class->default_clock_class;
 }
 
+const struct bt_clock_class *bt_stream_class_borrow_default_clock_class_const(
+               const struct bt_stream_class *stream_class)
+{
+       BT_ASSERT_PRE_NON_NULL(stream_class, "Stream class");
+       return stream_class->default_clock_class;
+}
+
 bt_bool bt_stream_class_assigns_automatic_event_class_id(
-               struct bt_stream_class *stream_class)
+               const struct bt_stream_class *stream_class)
 {
        BT_ASSERT_PRE_NON_NULL(stream_class, "Stream class");
        return (bt_bool) stream_class->assigns_automatic_event_class_id;
 }
 
-int bt_stream_class_set_assigns_automatic_event_class_id(
-               struct bt_stream_class *stream_class, bt_bool value)
+void bt_stream_class_set_assigns_automatic_event_class_id(
+               struct bt_stream_class *stream_class,
+               bt_bool value)
 {
        BT_ASSERT_PRE_NON_NULL(stream_class, "Stream class");
        BT_ASSERT_PRE_STREAM_CLASS_HOT(stream_class);
        stream_class->assigns_automatic_event_class_id = (bool) value;
        BT_LIB_LOGV("Set stream class's automatic event class ID "
                "assignment property: %!+S", stream_class);
-       return 0;
 }
 
 bt_bool bt_stream_class_assigns_automatic_stream_id(
-               struct bt_stream_class *stream_class)
+               const struct bt_stream_class *stream_class)
 {
        BT_ASSERT_PRE_NON_NULL(stream_class, "Stream class");
        return (bt_bool) stream_class->assigns_automatic_stream_id;
 }
 
-int bt_stream_class_set_assigns_automatic_stream_id(
-               struct bt_stream_class *stream_class, bt_bool value)
+void bt_stream_class_set_assigns_automatic_stream_id(
+               struct bt_stream_class *stream_class,
+               bt_bool value)
 {
        BT_ASSERT_PRE_NON_NULL(stream_class, "Stream class");
        BT_ASSERT_PRE_STREAM_CLASS_HOT(stream_class);
        stream_class->assigns_automatic_stream_id = (bool) value;
        BT_LIB_LOGV("Set stream class's automatic stream ID "
                "assignment property: %!+S", stream_class);
-       return 0;
 }
 
 bt_bool bt_stream_class_packets_have_discarded_event_counter_snapshot(
-               struct bt_stream_class *stream_class)
+               const struct bt_stream_class *stream_class)
 {
        BT_ASSERT_PRE_NON_NULL(stream_class, "Stream class");
        return (bt_bool) stream_class->packets_have_discarded_event_counter_snapshot;
 }
 
-int bt_stream_class_set_packets_have_discarded_event_counter_snapshot(
-               struct bt_stream_class *stream_class, bt_bool value)
+void bt_stream_class_set_packets_have_discarded_event_counter_snapshot(
+               struct bt_stream_class *stream_class,
+               bt_bool value)
 {
        BT_ASSERT_PRE_NON_NULL(stream_class, "Stream class");
        BT_ASSERT_PRE_STREAM_CLASS_HOT(stream_class);
@@ -492,18 +531,18 @@ int bt_stream_class_set_packets_have_discarded_event_counter_snapshot(
        BT_LIB_LOGV("Set stream class's "
                "\"packets have discarded event counter snapshot\" property: "
                "%!+S", stream_class);
-       return 0;
 }
 
 bt_bool bt_stream_class_packets_have_packet_counter_snapshot(
-               struct bt_stream_class *stream_class)
+               const struct bt_stream_class *stream_class)
 {
        BT_ASSERT_PRE_NON_NULL(stream_class, "Stream class");
        return (bt_bool) stream_class->packets_have_packet_counter_snapshot;
 }
 
-int bt_stream_class_set_packets_have_packet_counter_snapshot(
-               struct bt_stream_class *stream_class, bt_bool value)
+void bt_stream_class_set_packets_have_packet_counter_snapshot(
+               struct bt_stream_class *stream_class,
+               bt_bool value)
 {
        BT_ASSERT_PRE_NON_NULL(stream_class, "Stream class");
        BT_ASSERT_PRE_STREAM_CLASS_HOT(stream_class);
@@ -512,18 +551,18 @@ int bt_stream_class_set_packets_have_packet_counter_snapshot(
        BT_LIB_LOGV("Set stream class's "
                "\"packets have packet counter snapshot\" property: "
                "%!+S", stream_class);
-       return 0;
 }
 
 bt_bool bt_stream_class_packets_have_default_beginning_clock_value(
-               struct bt_stream_class *stream_class)
+               const struct bt_stream_class *stream_class)
 {
        BT_ASSERT_PRE_NON_NULL(stream_class, "Stream class");
        return (bt_bool) stream_class->packets_have_default_beginning_cv;
 }
 
-int bt_stream_class_set_packets_have_default_beginning_clock_value(
-               struct bt_stream_class *stream_class, bt_bool value)
+void bt_stream_class_set_packets_have_default_beginning_clock_value(
+               struct bt_stream_class *stream_class,
+               bt_bool value)
 {
        BT_ASSERT_PRE_NON_NULL(stream_class, "Stream class");
        BT_ASSERT_PRE_STREAM_CLASS_HOT(stream_class);
@@ -534,18 +573,18 @@ int bt_stream_class_set_packets_have_default_beginning_clock_value(
        BT_LIB_LOGV("Set stream class's "
                "\"packets have default beginning clock value\" property: "
                "%!+S", stream_class);
-       return 0;
 }
 
 bt_bool bt_stream_class_packets_have_default_end_clock_value(
-               struct bt_stream_class *stream_class)
+               const struct bt_stream_class *stream_class)
 {
        BT_ASSERT_PRE_NON_NULL(stream_class, "Stream class");
        return (bt_bool) stream_class->packets_have_default_end_cv;
 }
 
-int bt_stream_class_set_packets_have_default_end_clock_value(
-               struct bt_stream_class *stream_class, bt_bool value)
+void bt_stream_class_set_packets_have_default_end_clock_value(
+               struct bt_stream_class *stream_class,
+               bt_bool value)
 {
        BT_ASSERT_PRE_NON_NULL(stream_class, "Stream class");
        BT_ASSERT_PRE_STREAM_CLASS_HOT(stream_class);
@@ -556,11 +595,10 @@ int bt_stream_class_set_packets_have_default_end_clock_value(
        BT_LIB_LOGV("Set stream class's "
                "\"packets have default end clock value\" property: "
                "%!+S", stream_class);
-       return 0;
 }
 
 bt_bool bt_stream_class_default_clock_is_always_known(
-               struct bt_stream_class *stream_class)
+               const struct bt_stream_class *stream_class)
 {
        /* BT_CLOCK_VALUE_STATUS_UNKNOWN is not supported as of 2.0 */
        return BT_TRUE;
This page took 0.030042 seconds and 4 git commands to generate.