lib: make trace IR API const-correct

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

diff --git a/lib/trace-ir/fields.c b/lib/trace-ir/fields.c
index 9872dd77603da350d8a42b23c89e05ed32949761..519d65e55ebf3960dab29fe1fed73f978a9451c2 100644 (file)
--- a/lib/trace-ir/fields.c
+++ b/lib/trace-ir/fields.c
@@ -1,8 +1,4 @@
 /*
- * fields.c
- *
- * Babeltrace trace IR - Event Fields
- *
  * Copyright 2013, 2014 Jérémie Galarneau <jeremie.galarneau@efficios.com>
  *
  * Author: Jérémie Galarneau <jeremie.galarneau@efficios.com>
@@ -31,10 +27,11 @@
 
 #include <babeltrace/assert-pre-internal.h>
 #include <babeltrace/trace-ir/fields.h>
+#include <babeltrace/trace-ir/fields-const.h>
 #include <babeltrace/trace-ir/fields-internal.h>
 #include <babeltrace/trace-ir/field-classes-internal.h>
 #include <babeltrace/object-internal.h>
-#include <babeltrace/ref.h>
+#include <babeltrace/object.h>
 #include <babeltrace/compiler-internal.h>
 #include <babeltrace/compat/fcntl-internal.h>
 #include <babeltrace/align-internal.h>
@@ -66,16 +63,16 @@ static
 void set_variant_field_is_frozen(struct bt_field *field, bool is_frozen);
 
 static
-bool single_field_is_set(struct bt_field *field);
+bool single_field_is_set(const struct bt_field *field);
 
 static
-bool array_field_is_set(struct bt_field *field);
+bool array_field_is_set(const struct bt_field *field);
 
 static
-bool structure_field_is_set(struct bt_field *field);
+bool structure_field_is_set(const struct bt_field *field);
 
 static
-bool variant_field_is_set(struct bt_field *field);
+bool variant_field_is_set(const struct bt_field *field);
 
 static
 struct bt_field_methods integer_field_methods = {
@@ -186,13 +183,20 @@ void (* const field_destroy_funcs[])(struct bt_field *) = {
        [BT_FIELD_CLASS_TYPE_VARIANT]           = destroy_variant_field,
 };
 
-struct bt_field_class *bt_field_borrow_class(struct bt_field *field)
+struct bt_field_class *bt_field_borrow_class(const struct bt_field *field)
+{
+       BT_ASSERT_PRE_NON_NULL(field, "Field");
+       return field->class;
+}
+
+const struct bt_field_class *bt_field_borrow_class_const(
+               const struct bt_field *field)
 {
        BT_ASSERT_PRE_NON_NULL(field, "Field");
        return field->class;
 }
 
-enum bt_field_class_type bt_field_get_class_type(struct bt_field *field)
+enum bt_field_class_type bt_field_get_class_type(const struct bt_field *field)
 {
        BT_ASSERT_PRE_NON_NULL(field, "Field");
        return field->class->type;
@@ -224,7 +228,8 @@ void init_field(struct bt_field *field, struct bt_field_class *fc,
        BT_ASSERT(fc);
        bt_object_init_unique(&field->base);
        field->methods = methods;
-       field->class = bt_get(fc);
+       field->class = fc;
+       bt_object_get_no_null_check(fc);
 }
 
 static
@@ -282,7 +287,7 @@ struct bt_field *create_string_field(struct bt_field_class *fc)
                sizeof(char), 1);
        if (!string_field->buf) {
                BT_LOGE_STR("Failed to allocate a GArray.");
-               BT_PUT(string_field);
+               BT_OBJECT_PUT_REF_AND_RESET(string_field);
                goto end;
        }
 
@@ -350,7 +355,7 @@ struct bt_field *create_structure_field(struct bt_field_class *fc)
                        &struct_field->fields)) {
                BT_LIB_LOGE("Cannot create structure member fields: "
                        "%![fc-]+F", fc);
-               BT_PUT(struct_field);
+               BT_OBJECT_PUT_REF_AND_RESET(struct_field);
                goto end;
        }
 
@@ -378,7 +383,7 @@ struct bt_field *create_variant_field(struct bt_field_class *fc)
                        &var_field->fields)) {
                BT_LIB_LOGE("Cannot create variant member fields: "
                        "%![fc-]+F", fc);
-               BT_PUT(var_field);
+               BT_OBJECT_PUT_REF_AND_RESET(var_field);
                goto end;
        }
 
@@ -442,7 +447,7 @@ struct bt_field *create_static_array_field(struct bt_field_class *fc)
        if (init_array_field_fields(array_field)) {
                BT_LIB_LOGE("Cannot create static array fields: "
                        "%![fc-]+F", fc);
-               BT_PUT(array_field);
+               BT_OBJECT_PUT_REF_AND_RESET(array_field);
                goto end;
        }
 
@@ -469,7 +474,7 @@ struct bt_field *create_dynamic_array_field(struct bt_field_class *fc)
        if (init_array_field_fields(array_field)) {
                BT_LIB_LOGE("Cannot create dynamic array fields: "
                        "%![fc-]+F", fc);
-               BT_PUT(array_field);
+               BT_OBJECT_PUT_REF_AND_RESET(array_field);
                goto end;
        }
 
@@ -479,9 +484,9 @@ end:
        return (void *) array_field;
 }
 
-int64_t bt_field_signed_integer_get_value(struct bt_field *field)
+int64_t bt_field_signed_integer_get_value(const struct bt_field *field)
 {
-       struct bt_field_integer *int_field = (void *) field;
+       const struct bt_field_integer *int_field = (const void *) field;
 
        BT_ASSERT_PRE_NON_NULL(field, "Field");
        BT_ASSERT_PRE_FIELD_IS_SET(field, "Field");
@@ -504,9 +509,9 @@ void bt_field_signed_integer_set_value(struct bt_field *field, int64_t value)
        bt_field_set_single(field, true);
 }
 
-uint64_t bt_field_unsigned_integer_get_value(struct bt_field *field)
+uint64_t bt_field_unsigned_integer_get_value(const struct bt_field *field)
 {
-       struct bt_field_integer *int_field = (void *) field;
+       const struct bt_field_integer *int_field = (const void *) field;
 
        BT_ASSERT_PRE_NON_NULL(field, "Field");
        BT_ASSERT_PRE_FIELD_IS_SET(field, "Field");
@@ -514,8 +519,7 @@ uint64_t bt_field_unsigned_integer_get_value(struct bt_field *field)
        return int_field->value.u;
 }
 
-void bt_field_unsigned_integer_set_value(struct bt_field *field,
-               uint64_t value)
+void bt_field_unsigned_integer_set_value(struct bt_field *field, uint64_t value)
 {
        struct bt_field_integer *int_field = (void *) field;
 
@@ -530,9 +534,9 @@ void bt_field_unsigned_integer_set_value(struct bt_field *field,
        bt_field_set_single(field, true);
 }
 
-double bt_field_real_get_value(struct bt_field *field)
+double bt_field_real_get_value(const struct bt_field *field)
 {
-       struct bt_field_real *real_field = (void *) field;
+       const struct bt_field_real *real_field = (const void *) field;
 
        BT_ASSERT_PRE_NON_NULL(field, "Field");
        BT_ASSERT_PRE_FIELD_IS_SET(field, "Field");
@@ -556,11 +560,12 @@ void bt_field_real_set_value(struct bt_field *field, double value)
        bt_field_set_single(field, true);
 }
 
-int bt_field_unsigned_enumeration_get_mapping_labels(struct bt_field *field,
+int bt_field_unsigned_enumeration_get_mapping_labels(
+               const struct bt_field *field,
                bt_field_class_enumeration_mapping_label_array *label_array,
                uint64_t *count)
 {
-       struct bt_field_integer *int_field = (void *) field;
+       const struct bt_field_integer *int_field = (const void *) field;
 
        BT_ASSERT_PRE_NON_NULL(field, "Field");
        BT_ASSERT_PRE_NON_NULL(label_array, "Label array (output)");
@@ -572,11 +577,12 @@ int bt_field_unsigned_enumeration_get_mapping_labels(struct bt_field *field,
                field->class, int_field->value.u, label_array, count);
 }
 
-int bt_field_signed_enumeration_get_mapping_labels(struct bt_field *field,
+int bt_field_signed_enumeration_get_mapping_labels(
+               const struct bt_field *field,
                bt_field_class_enumeration_mapping_label_array *label_array,
                uint64_t *count)
 {
-       struct bt_field_integer *int_field = (void *) field;
+       const struct bt_field_integer *int_field = (const void *) field;
 
        BT_ASSERT_PRE_NON_NULL(field, "Field");
        BT_ASSERT_PRE_NON_NULL(label_array, "Label array (output)");
@@ -588,9 +594,9 @@ int bt_field_signed_enumeration_get_mapping_labels(struct bt_field *field,
                field->class, int_field->value.i, label_array, count);
 }
 
-const char *bt_field_string_get_value(struct bt_field *field)
+const char *bt_field_string_get_value(const struct bt_field *field)
 {
-       struct bt_field_string *string_field = (void *) field;
+       const struct bt_field_string *string_field = (const void *) field;
 
        BT_ASSERT_PRE_NON_NULL(field, "Field");
        BT_ASSERT_PRE_FIELD_IS_SET(field, "Field");
@@ -599,9 +605,9 @@ const char *bt_field_string_get_value(struct bt_field *field)
        return (const char *) string_field->buf->data;
 }
 
-uint64_t bt_field_string_get_length(struct bt_field *field)
+uint64_t bt_field_string_get_length(const struct bt_field *field)
 {
-       struct bt_field_string *string_field = (void *) field;
+       const struct bt_field_string *string_field = (const void *) field;
 
        BT_ASSERT_PRE_NON_NULL(field, "Field");
        BT_ASSERT_PRE_FIELD_IS_SET(field, "Field");
@@ -624,8 +630,8 @@ int bt_field_string_set_value(struct bt_field *field, const char *value)
 
 int bt_field_string_append(struct bt_field *field, const char *value)
 {
-       return bt_field_string_append_with_length(field, value,
-               (uint64_t) strlen(value));
+       return bt_field_string_append_with_length(field,
+               value, (uint64_t) strlen(value));
 }
 
 int bt_field_string_append_with_length(struct bt_field *field,
@@ -673,17 +679,16 @@ int bt_field_string_clear(struct bt_field *field)
        return 0;
 }
 
-uint64_t bt_field_array_get_length(struct bt_field *field)
+uint64_t bt_field_array_get_length(const struct bt_field *field)
 {
-       struct bt_field_array *array_field = (void *) field;
+       const struct bt_field_array *array_field = (const void *) field;
 
        BT_ASSERT_PRE_NON_NULL(field, "Field");
        BT_ASSERT_PRE_FIELD_IS_ARRAY(field, "Field");
        return array_field->length;
 }
 
-int bt_field_dynamic_array_set_length(struct bt_field *field,
-               uint64_t length)
+int bt_field_dynamic_array_set_length(struct bt_field *field, uint64_t length)
 {
        int ret = 0;
        struct bt_field_array *array_field = (void *) field;
@@ -726,7 +731,8 @@ end:
        return ret;
 }
 
-struct bt_field *bt_field_array_borrow_element_field_by_index(
+static inline
+struct bt_field *borrow_array_field_element_field_by_index(
                struct bt_field *field, uint64_t index)
 {
        struct bt_field_array *array_field = (void *) field;
@@ -737,7 +743,21 @@ struct bt_field *bt_field_array_borrow_element_field_by_index(
        return array_field->fields->pdata[index];
 }
 
-struct bt_field *bt_field_structure_borrow_member_field_by_index(
+struct bt_field *bt_field_array_borrow_element_field_by_index(
+               struct bt_field *field, uint64_t index)
+{
+       return borrow_array_field_element_field_by_index(field, index);
+}
+
+const struct bt_field *
+bt_field_array_borrow_element_field_by_index_const(
+               const struct bt_field *field, uint64_t index)
+{
+       return borrow_array_field_element_field_by_index((void *) field, index);
+}
+
+static inline
+struct bt_field *borrow_structure_field_member_field_by_index(
                struct bt_field *field, uint64_t index)
 {
        struct bt_field_structure *struct_field = (void *) field;
@@ -749,7 +769,23 @@ struct bt_field *bt_field_structure_borrow_member_field_by_index(
        return struct_field->fields->pdata[index];
 }
 
-struct bt_field *bt_field_structure_borrow_member_field_by_name(
+struct bt_field *bt_field_structure_borrow_member_field_by_index(
+               struct bt_field *field, uint64_t index)
+{
+       return borrow_structure_field_member_field_by_index(field,
+               index);
+}
+
+const struct bt_field *
+bt_field_structure_borrow_member_field_by_index_const(
+               const struct bt_field *field, uint64_t index)
+{
+       return borrow_structure_field_member_field_by_index(
+               (void *) field, index);
+}
+
+static inline
+struct bt_field *borrow_structure_field_member_field_by_name(
                struct bt_field *field, const char *name)
 {
        struct bt_field *ret_field = NULL;
@@ -776,7 +812,21 @@ end:
        return ret_field;
 }
 
-struct bt_field *bt_field_variant_borrow_selected_option_field(
+struct bt_field *bt_field_structure_borrow_member_field_by_name(
+               struct bt_field *field, const char *name)
+{
+       return borrow_structure_field_member_field_by_name(field, name);
+}
+
+const struct bt_field *bt_field_structure_borrow_member_field_by_name_const(
+               const struct bt_field *field, const char *name)
+{
+       return borrow_structure_field_member_field_by_name(
+               (void *) field, name);
+}
+
+static inline
+struct bt_field *borrow_variant_field_selected_option_field(
                struct bt_field *field)
 {
        struct bt_field_variant *var_field = (void *) field;
@@ -789,8 +839,20 @@ struct bt_field *bt_field_variant_borrow_selected_option_field(
        return var_field->selected_field;
 }
 
-int bt_field_variant_select_option_field(struct bt_field *field,
-               uint64_t index)
+struct bt_field *bt_field_variant_borrow_selected_option_field(
+               struct bt_field *field)
+{
+       return borrow_variant_field_selected_option_field(field);
+}
+
+const struct bt_field *bt_field_variant_borrow_selected_option_field_const(
+               const struct bt_field *field)
+{
+       return borrow_variant_field_selected_option_field((void *) field);
+}
+
+int bt_field_variant_select_option_field(
+               struct bt_field *field, uint64_t index)
 {
        struct bt_field_variant *var_field = (void *) field;
 
@@ -805,9 +867,9 @@ int bt_field_variant_select_option_field(struct bt_field *field,
 }
 
 uint64_t bt_field_variant_get_selected_option_field_index(
-               struct bt_field *field)
+               const struct bt_field *field)
 {
-       struct bt_field_variant *var_field = (void *) field;
+       const struct bt_field_variant *var_field = (const void *) field;
 
        BT_ASSERT_PRE_NON_NULL(field, "Field");
        BT_ASSERT_PRE_FIELD_HAS_CLASS_TYPE(field,
@@ -822,7 +884,7 @@ void bt_field_finalize(struct bt_field *field)
 {
        BT_ASSERT(field);
        BT_LOGD_STR("Putting field's class.");
-       bt_put(field->class);
+       BT_OBJECT_PUT_REF_AND_RESET(field->class);
 }
 
 static
@@ -854,6 +916,7 @@ void destroy_structure_field(struct bt_field *field)
 
        if (struct_field->fields) {
                g_ptr_array_free(struct_field->fields, TRUE);
+               struct_field->fields = NULL;
        }
 
        g_free(field);
@@ -870,6 +933,7 @@ void destroy_variant_field(struct bt_field *field)
 
        if (var_field->fields) {
                g_ptr_array_free(var_field->fields, TRUE);
+               var_field->fields = NULL;
        }
 
        g_free(field);
@@ -886,6 +950,7 @@ void destroy_array_field(struct bt_field *field)
 
        if (array_field->fields) {
                g_ptr_array_free(array_field->fields, TRUE);
+               array_field->fields = NULL;
        }
 
        g_free(field);
@@ -902,6 +967,7 @@ void destroy_string_field(struct bt_field *field)
 
        if (string_field->buf) {
                g_array_free(string_field->buf, TRUE);
+               string_field->buf = NULL;
        }
 
        g_free(field);
@@ -1031,29 +1097,29 @@ void set_array_field_is_frozen(struct bt_field *field, bool is_frozen)
 }
 
 BT_HIDDEN
-void _bt_field_set_is_frozen(struct bt_field *field,
+void _bt_field_set_is_frozen(const struct bt_field *field,
                bool is_frozen)
 {
        BT_ASSERT(field);
        BT_LIB_LOGD("Setting field object's frozen state: %!+f, is-frozen=%d",
                field, is_frozen);
        BT_ASSERT(field->methods->set_is_frozen);
-       field->methods->set_is_frozen(field, is_frozen);
+       field->methods->set_is_frozen((void *) field, is_frozen);
 }
 
 static
-bool single_field_is_set(struct bt_field *field)
+bool single_field_is_set(const struct bt_field *field)
 {
        BT_ASSERT(field);
        return field->is_set;
 }
 
 static
-bool structure_field_is_set(struct bt_field *field)
+bool structure_field_is_set(const struct bt_field *field)
 {
        bool is_set = true;
        uint64_t i;
-       struct bt_field_structure *struct_field = (void *) field;
+       const struct bt_field_structure *struct_field = (const void *) field;
 
        BT_ASSERT(field);
 
@@ -1069,9 +1135,9 @@ end:
 }
 
 static
-bool variant_field_is_set(struct bt_field *field)
+bool variant_field_is_set(const struct bt_field *field)
 {
-       struct bt_field_variant *var_field = (void *) field;
+       const struct bt_field_variant *var_field = (const void *) field;
        bool is_set = false;
 
        BT_ASSERT(field);
@@ -1084,11 +1150,11 @@ bool variant_field_is_set(struct bt_field *field)
 }
 
 static
-bool array_field_is_set(struct bt_field *field)
+bool array_field_is_set(const struct bt_field *field)
 {
        bool is_set = true;
        uint64_t i;
-       struct bt_field_array *array_field = (void *) field;
+       const struct bt_field_array *array_field = (const void *) field;
 
        BT_ASSERT(field);