lib: make bt_value_map_foreach_entry_{const_}func() return a status code
[babeltrace.git] / src / lib / value.c
index 91d109fc5d3dbf1d1ea6afc5f5cf0e2c47a58e98..2b23e80ff35a2bcfb0cd03a392ba7aedefe66d39 100644 (file)
@@ -33,6 +33,7 @@
 #include "common/common.h"
 #include "compat/glib.h"
 #include "lib/assert-pre.h"
+#include "lib/assert-post.h"
 #include "lib/value.h"
 #include "common/assert.h"
 #include "func-status.h"
@@ -197,7 +198,6 @@ struct bt_value *bt_value_array_copy(const struct bt_value *array_obj)
                        bt_value_array_borrow_element_by_index_const(
                                array_obj, i);
 
-               BT_ASSERT(element_obj);
                BT_LOGD("Copying array value's element: element-addr=%p, "
                        "index=%d", element_obj, i);
                ret = bt_value_copy(element_obj, &element_obj_copy);
@@ -591,6 +591,8 @@ struct bt_value *bt_value_bool_create_init(bt_bool val)
 {
        struct bt_value_bool *bool_obj;
 
+       BT_ASSERT_PRE_NO_ERROR();
+
        BT_LOGD("Creating boolean value object: val=%d", val);
        bool_obj = g_new0(struct bt_value_bool, 1);
        if (!bool_obj) {
@@ -609,6 +611,8 @@ end:
 
 struct bt_value *bt_value_bool_create(void)
 {
+       BT_ASSERT_PRE_NO_ERROR();
+
        return bt_value_bool_create_init(BT_FALSE);
 }
 
@@ -648,23 +652,31 @@ end:
 
 struct bt_value *bt_value_integer_unsigned_create_init(uint64_t val)
 {
+       BT_ASSERT_PRE_NO_ERROR();
+
        return bt_value_integer_create_init(BT_VALUE_TYPE_UNSIGNED_INTEGER,
                val);
 }
 
 struct bt_value *bt_value_integer_unsigned_create(void)
 {
+       BT_ASSERT_PRE_NO_ERROR();
+
        return bt_value_integer_unsigned_create_init(0);
 }
 
 struct bt_value *bt_value_integer_signed_create_init(int64_t val)
 {
+       BT_ASSERT_PRE_NO_ERROR();
+
        return bt_value_integer_create_init(BT_VALUE_TYPE_SIGNED_INTEGER,
                (uint64_t) val);
 }
 
 struct bt_value *bt_value_integer_signed_create(void)
 {
+       BT_ASSERT_PRE_NO_ERROR();
+
        return bt_value_integer_signed_create_init(0);
 }
 
@@ -672,6 +684,8 @@ struct bt_value *bt_value_real_create_init(double val)
 {
        struct bt_value_real *real_obj;
 
+       BT_ASSERT_PRE_NO_ERROR();
+
        BT_LOGD("Creating real number value object: val=%f", val);
        real_obj = g_new0(struct bt_value_real, 1);
        if (!real_obj) {
@@ -691,6 +705,8 @@ end:
 
 struct bt_value *bt_value_real_create(void)
 {
+       BT_ASSERT_PRE_NO_ERROR();
+
        return bt_value_real_create_init(0.);
 }
 
@@ -698,7 +714,9 @@ struct bt_value *bt_value_string_create_init(const char *val)
 {
        struct bt_value_string *string_obj = NULL;
 
+       BT_ASSERT_PRE_NO_ERROR();
        BT_ASSERT_PRE_NON_NULL(val, "Value");
+
        BT_LOGD("Creating string value object: val-len=%zu", strlen(val));
        string_obj = g_new0(struct bt_value_string, 1);
        if (!string_obj) {
@@ -726,6 +744,8 @@ end:
 
 struct bt_value *bt_value_string_create(void)
 {
+       BT_ASSERT_PRE_NO_ERROR();
+
        return bt_value_string_create_init("");
 }
 
@@ -733,6 +753,8 @@ struct bt_value *bt_value_array_create(void)
 {
        struct bt_value_array *array_obj;
 
+       BT_ASSERT_PRE_NO_ERROR();
+
        BT_LOGD_STR("Creating empty array value object.");
        array_obj = g_new0(struct bt_value_array, 1);
        if (!array_obj) {
@@ -762,6 +784,8 @@ struct bt_value *bt_value_map_create(void)
 {
        struct bt_value_map *map_obj;
 
+       BT_ASSERT_PRE_NO_ERROR();
+
        BT_LOGD_STR("Creating empty map value object.");
        map_obj = g_new0(struct bt_value_map, 1);
        if (!map_obj) {
@@ -873,6 +897,7 @@ const char *bt_value_string_get(const struct bt_value *string_obj)
 enum bt_value_string_set_status bt_value_string_set(
                struct bt_value *string_obj, const char *val)
 {
+       BT_ASSERT_PRE_NO_ERROR();
        BT_ASSERT_PRE_NON_NULL(string_obj, "Value object");
        BT_ASSERT_PRE_VALUE_IS_TYPE(string_obj, BT_VALUE_TYPE_STRING);
        BT_ASSERT_PRE_DEV_VALUE_HOT(string_obj, "Value object");
@@ -916,6 +941,7 @@ enum bt_value_array_append_element_status bt_value_array_append_element(
        struct bt_value_array *typed_array_obj =
                BT_VALUE_TO_ARRAY(array_obj);
 
+       BT_ASSERT_PRE_NO_ERROR();
        BT_ASSERT_PRE_NON_NULL(array_obj, "Array value object");
        BT_ASSERT_PRE_NON_NULL(element_obj, "Element value object");
        BT_ASSERT_PRE_VALUE_IS_TYPE(array_obj, BT_VALUE_TYPE_ARRAY);
@@ -934,6 +960,8 @@ bt_value_array_append_bool_element(struct bt_value *array_obj, bt_bool val)
        enum bt_value_array_append_element_status ret;
        struct bt_value *bool_obj = NULL;
 
+       BT_ASSERT_PRE_NO_ERROR();
+
        bool_obj = bt_value_bool_create_init(val);
        ret = bt_value_array_append_element(array_obj,
                (void *) bool_obj);
@@ -948,6 +976,8 @@ bt_value_array_append_unsigned_integer_element(struct bt_value *array_obj,
        enum bt_value_array_append_element_status ret;
        struct bt_value *integer_obj = NULL;
 
+       BT_ASSERT_PRE_NO_ERROR();
+
        integer_obj = bt_value_integer_unsigned_create_init(val);
        ret = bt_value_array_append_element(array_obj,
                (void *) integer_obj);
@@ -962,6 +992,8 @@ bt_value_array_append_signed_integer_element(struct bt_value *array_obj,
        enum bt_value_array_append_element_status ret;
        struct bt_value *integer_obj = NULL;
 
+       BT_ASSERT_PRE_NO_ERROR();
+
        integer_obj = bt_value_integer_signed_create_init(val);
        ret = bt_value_array_append_element(array_obj,
                (void *) integer_obj);
@@ -975,6 +1007,8 @@ bt_value_array_append_real_element(struct bt_value *array_obj, double val)
        enum bt_value_array_append_element_status ret;
        struct bt_value *real_obj = NULL;
 
+       BT_ASSERT_PRE_NO_ERROR();
+
        real_obj = bt_value_real_create_init(val);
        ret = bt_value_array_append_element(array_obj,
                (void *) real_obj);
@@ -989,6 +1023,8 @@ bt_value_array_append_string_element(struct bt_value *array_obj,
        enum bt_value_array_append_element_status ret;
        struct bt_value *string_obj = NULL;
 
+       BT_ASSERT_PRE_NO_ERROR();
+
        string_obj = bt_value_string_create_init(val);
        ret = bt_value_array_append_element(array_obj,
                (void *) string_obj);
@@ -1003,6 +1039,8 @@ bt_value_array_append_empty_array_element(struct bt_value *array_obj,
        enum bt_value_array_append_element_status ret;
        struct bt_value *empty_array_obj = NULL;
 
+       BT_ASSERT_PRE_NO_ERROR();
+
        empty_array_obj = bt_value_array_create();
        ret = bt_value_array_append_element(array_obj,
                (void *) empty_array_obj);
@@ -1022,6 +1060,8 @@ bt_value_array_append_empty_map_element(struct bt_value *array_obj,
        enum bt_value_array_append_element_status ret;
        struct bt_value *map_obj = NULL;
 
+       BT_ASSERT_PRE_NO_ERROR();
+
        map_obj = bt_value_map_create();
        ret = bt_value_array_append_element(array_obj,
                (void *) map_obj);
@@ -1041,6 +1081,7 @@ bt_value_array_set_element_by_index(struct bt_value *array_obj, uint64_t index,
        struct bt_value_array *typed_array_obj =
                BT_VALUE_TO_ARRAY(array_obj);
 
+       BT_ASSERT_PRE_NO_ERROR();
        BT_ASSERT_PRE_NON_NULL(array_obj, "Array value object");
        BT_ASSERT_PRE_NON_NULL(element_obj, "Element value object");
        BT_ASSERT_PRE_VALUE_IS_TYPE(array_obj, BT_VALUE_TYPE_ARRAY);
@@ -1091,6 +1132,7 @@ enum bt_value_map_insert_entry_status bt_value_map_insert_entry(
                struct bt_value *map_obj, const char *key,
                struct bt_value *element_obj)
 {
+       BT_ASSERT_PRE_NO_ERROR();
        BT_ASSERT_PRE_NON_NULL(map_obj, "Map value object");
        BT_ASSERT_PRE_NON_NULL(key, "Key");
        BT_ASSERT_PRE_NON_NULL(element_obj, "Element value object");
@@ -1111,6 +1153,8 @@ enum bt_value_map_insert_entry_status bt_value_map_insert_bool_entry(
        enum bt_value_map_insert_entry_status ret;
        struct bt_value *bool_obj = NULL;
 
+       BT_ASSERT_PRE_NO_ERROR();
+
        bool_obj = bt_value_bool_create_init(val);
        ret = bt_value_map_insert_entry(map_obj, key,
                (void *) bool_obj);
@@ -1125,6 +1169,8 @@ bt_value_map_insert_unsigned_integer_entry(struct bt_value *map_obj,
        enum bt_value_map_insert_entry_status ret;
        struct bt_value *integer_obj = NULL;
 
+       BT_ASSERT_PRE_NO_ERROR();
+
        integer_obj = bt_value_integer_unsigned_create_init(val);
        ret = bt_value_map_insert_entry(map_obj, key,
                (void *) integer_obj);
@@ -1139,6 +1185,8 @@ bt_value_map_insert_signed_integer_entry(struct bt_value *map_obj,
        enum bt_value_map_insert_entry_status ret;
        struct bt_value *integer_obj = NULL;
 
+       BT_ASSERT_PRE_NO_ERROR();
+
        integer_obj = bt_value_integer_signed_create_init(val);
        ret = bt_value_map_insert_entry(map_obj, key,
                (void *) integer_obj);
@@ -1152,6 +1200,8 @@ enum bt_value_map_insert_entry_status bt_value_map_insert_real_entry(
        enum bt_value_map_insert_entry_status ret;
        struct bt_value *real_obj = NULL;
 
+       BT_ASSERT_PRE_NO_ERROR();
+
        real_obj = bt_value_real_create_init(val);
        ret = bt_value_map_insert_entry(map_obj, key,
                (void *) real_obj);
@@ -1166,6 +1216,8 @@ enum bt_value_map_insert_entry_status bt_value_map_insert_string_entry(
        enum bt_value_map_insert_entry_status ret;
        struct bt_value *string_obj = NULL;
 
+       BT_ASSERT_PRE_NO_ERROR();
+
        string_obj = bt_value_string_create_init(val);
        ret = bt_value_map_insert_entry(map_obj, key,
                (void *) string_obj);
@@ -1181,6 +1233,8 @@ bt_value_map_insert_empty_array_entry(
        enum bt_value_map_insert_entry_status ret;
        struct bt_value *array_obj = NULL;
 
+       BT_ASSERT_PRE_NO_ERROR();
+
        array_obj = bt_value_array_create();
        ret = bt_value_map_insert_entry(map_obj, key,
                (void *) array_obj);
@@ -1200,6 +1254,8 @@ bt_value_map_insert_empty_map_entry(struct bt_value *map_obj, const char *key,
        enum bt_value_map_insert_entry_status ret;
        struct bt_value *empty_map_obj = NULL;
 
+       BT_ASSERT_PRE_NO_ERROR();
+
        empty_map_obj = bt_value_map_create();
        ret = bt_value_map_insert_entry(map_obj, key,
                (void *) empty_map_obj);
@@ -1216,11 +1272,13 @@ enum bt_value_map_foreach_entry_status bt_value_map_foreach_entry(
                struct bt_value *map_obj, bt_value_map_foreach_entry_func func,
                void *data)
 {
-       enum bt_value_map_foreach_entry_status ret = BT_FUNC_STATUS_OK;
+       int status = BT_FUNC_STATUS_OK;
        gpointer key, element_obj;
        GHashTableIter iter;
        struct bt_value_map *typed_map_obj = BT_VALUE_TO_MAP(map_obj);
 
+       BT_ASSERT_PRE_NO_ERROR();
+
        BT_ASSERT_PRE_DEV_NON_NULL(map_obj, "Value object");
        BT_ASSERT_PRE_DEV_NON_NULL(func, "Callback");
        BT_ASSERT_PRE_DEV_VALUE_IS_TYPE(map_obj, BT_VALUE_TYPE_MAP);
@@ -1229,43 +1287,68 @@ enum bt_value_map_foreach_entry_status bt_value_map_foreach_entry(
        while (g_hash_table_iter_next(&iter, &key, &element_obj)) {
                const char *key_str = g_quark_to_string(GPOINTER_TO_UINT(key));
 
-               if (!func(key_str, element_obj, data)) {
-                       BT_LOGT("User interrupted the loop: key=\"%s\", "
-                               "value-addr=%p, data=%p",
-                               key_str, element_obj, data);
-                       ret = BT_FUNC_STATUS_INTERRUPTED;
+               status = func(key_str, element_obj, data);
+               BT_ASSERT_POST_NO_ERROR_IF_NO_ERROR_STATUS(status);
+               if (status != BT_FUNC_STATUS_OK) {
+                       if (status < 0) {
+                               BT_LIB_LOGE_APPEND_CAUSE(
+                                       "User function failed while iterating "
+                                       "map value entries: "
+                                       "status=%s, key=\"%s\", "
+                                       "value-addr=%p, data=%p",
+                                       bt_common_func_status_string(status),
+                                       key_str, element_obj, data);
+
+                               if (status == BT_FUNC_STATUS_ERROR) {
+                                       /*
+                                        * User function error becomes a
+                                        * user error from this
+                                        * function's caller's
+                                        * perspective.
+                                        */
+                                       status = BT_FUNC_STATUS_USER_ERROR;
+                               }
+                       } else {
+                               BT_ASSERT(status == BT_FUNC_STATUS_INTERRUPTED);
+                               BT_LOGT("User interrupted the loop: status=%s, "
+                                       "key=\"%s\", value-addr=%p, data=%p",
+                                       bt_common_func_status_string(status),
+                                       key_str, element_obj, data);
+                       }
+
                        break;
                }
        }
 
-       return ret;
+       return status;
 }
 
 enum bt_value_map_foreach_entry_const_status bt_value_map_foreach_entry_const(
                const struct bt_value *map_obj,
                bt_value_map_foreach_entry_const_func func, void *data)
 {
+       BT_ASSERT_PRE_NO_ERROR();
+
        return (int) bt_value_map_foreach_entry((void *) map_obj,
                (bt_value_map_foreach_entry_func) func, data);
 }
 
 struct extend_map_element_data {
-       struct bt_value *extended_obj;
-       int status;
+       struct bt_value *base_obj;
 };
 
 static
-bt_bool extend_map_element(const char *key,
-               const struct bt_value *extension_obj_elem, void *data)
+bt_value_map_foreach_entry_const_func_status extend_map_element(
+               const char *key, const struct bt_value *extension_obj_elem,
+               void *data)
 {
-       bt_bool ret = BT_TRUE;
+       int status;
        struct extend_map_element_data *extend_data = data;
        struct bt_value *extension_obj_elem_copy = NULL;
 
        /* Copy object which is to replace the current one */
-       extend_data->status = bt_value_copy(extension_obj_elem,
-               &extension_obj_elem_copy);
-       if (extend_data->status) {
+       status = bt_value_copy(extension_obj_elem, &extension_obj_elem_copy);
+       if (status) {
                BT_LIB_LOGE_APPEND_CAUSE("Cannot copy map element: %!+v",
                        extension_obj_elem);
                goto error;
@@ -1273,92 +1356,62 @@ bt_bool extend_map_element(const char *key,
 
        BT_ASSERT(extension_obj_elem_copy);
 
-       /* Replace in extended object */
-       extend_data->status = bt_value_map_insert_entry(
-               extend_data->extended_obj, key,
+       /* Replace in base map value. */
+       status = bt_value_map_insert_entry(extend_data->base_obj, key,
                (void *) extension_obj_elem_copy);
-       if (extend_data->status) {
+       if (status) {
                BT_LIB_LOGE_APPEND_CAUSE(
-                       "Cannot replace value in extended value: key=\"%s\", "
-                       "%![extended-value-]+v, %![element-value-]+v",
-                       key, extend_data->extended_obj,
-                       extension_obj_elem_copy);
+                       "Cannot replace value in base map value: key=\"%s\", "
+                       "%![base-map-value-]+v, %![element-value-]+v",
+                       key, extend_data->base_obj, extension_obj_elem_copy);
                goto error;
        }
 
        goto end;
 
 error:
-       BT_ASSERT(extend_data->status != BT_FUNC_STATUS_OK);
-       ret = BT_FALSE;
+       BT_ASSERT(status < 0);
 
 end:
        BT_OBJECT_PUT_REF_AND_RESET(extension_obj_elem_copy);
-       return ret;
+       BT_ASSERT(status == BT_FUNC_STATUS_OK ||
+               status == BT_FUNC_STATUS_MEMORY_ERROR);
+       return status;
 }
 
 enum bt_value_map_extend_status bt_value_map_extend(
-               const struct bt_value *base_map_obj,
-               const struct bt_value *extension_obj,
-               struct bt_value **extended_map_obj)
+               struct bt_value *base_map_obj,
+               const struct bt_value *extension_obj)
 {
+       int status = BT_FUNC_STATUS_OK;
        struct extend_map_element_data extend_data = {
-               .extended_obj = NULL,
-               .status = BT_FUNC_STATUS_OK,
+               .base_obj = NULL,
        };
 
+       BT_ASSERT_PRE_NO_ERROR();
        BT_ASSERT_PRE_NON_NULL(base_map_obj, "Base value object");
+       BT_ASSERT_PRE_DEV_VALUE_HOT(base_map_obj, "Base value object");
        BT_ASSERT_PRE_NON_NULL(extension_obj, "Extension value object");
-       BT_ASSERT_PRE_NON_NULL(extended_map_obj,
-               "Extended value object (output)");
        BT_ASSERT_PRE_VALUE_IS_TYPE(base_map_obj, BT_VALUE_TYPE_MAP);
        BT_ASSERT_PRE_VALUE_IS_TYPE(extension_obj, BT_VALUE_TYPE_MAP);
        BT_LOGD("Extending map value: base-value-addr=%p, extension-value-addr=%p",
                base_map_obj, extension_obj);
-       *extended_map_obj = NULL;
-
-       /* Create copy of base map object to start with */
-       extend_data.status = bt_value_copy(base_map_obj, extended_map_obj);
-       if (extend_data.status) {
-               BT_LIB_LOGE_APPEND_CAUSE(
-                       "Cannot copy base value: %![base-value-]+v",
-                       base_map_obj);
-               goto error;
-       }
-
-       BT_ASSERT(extended_map_obj);
 
        /*
         * For each key in the extension map object, replace this key
-        * in the copied map object.
+        * in the base map object.
         */
-       extend_data.extended_obj = *extended_map_obj;
-
-       if (bt_value_map_foreach_entry_const(extension_obj, extend_map_element,
-                       &extend_data)) {
+       extend_data.base_obj = base_map_obj;
+       status = bt_value_map_foreach_entry_const(extension_obj,
+               extend_map_element, &extend_data);
+       if (status != BT_FUNC_STATUS_OK) {
+               BT_ASSERT(status == BT_FUNC_STATUS_MEMORY_ERROR);
                BT_LIB_LOGE_APPEND_CAUSE(
                        "Cannot iterate on the extension object's elements: "
                        "%![extension-value-]+v", extension_obj);
-               goto error;
-       }
-
-       if (extend_data.status) {
-               BT_LIB_LOGE_APPEND_CAUSE(
-                       "Failed to successfully iterate on the extension object's elements: "
-                       "%![extension-value-]+v", extension_obj);
-               goto error;
        }
 
-       BT_LOGD("Extended map value: extended-value-addr=%p",
-               *extended_map_obj);
-       goto end;
-
-error:
-       BT_OBJECT_PUT_REF_AND_RESET(*extended_map_obj);
-       *extended_map_obj = NULL;
-
-end:
-       return extend_data.status;
+       return status;
 }
 
 enum bt_value_copy_status bt_value_copy(const struct bt_value *object,
@@ -1366,6 +1419,7 @@ enum bt_value_copy_status bt_value_copy(const struct bt_value *object,
 {
        enum bt_value_copy_status status = BT_FUNC_STATUS_OK;
 
+       BT_ASSERT_PRE_NO_ERROR();
        BT_ASSERT_PRE_NON_NULL(object, "Value object");
        BT_ASSERT_PRE_NON_NULL(copy_obj, "Value object copy (output)");
        BT_LOGD("Copying value object: addr=%p", object);
This page took 0.029665 seconds and 4 git commands to generate.