Move to kernel style SPDX license identifiers
[babeltrace.git] / src / lib / value.c
index 96c01ac453f9d79abcd0410cb82488a029f467e0..3d73636e3bac657980bbb50127d2735a54b33354 100644 (file)
@@ -1,23 +1,7 @@
 /*
- * Copyright (c) 2015-2018 Philippe Proulx <pproulx@efficios.com>
- *
- * Permission is hereby granted, free of charge, to any person obtaining a copy
- * of this software and associated documentation files (the "Software"), to deal
- * in the Software without restriction, including without limitation the rights
- * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- * copies of the Software, and to permit persons to whom the Software is
- * furnished to do so, subject to the following conditions:
- *
- * The above copyright notice and this permission notice shall be included in
- * all copies or substantial portions of the Software.
+ * SPDX-License-Identifier: MIT
  *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
- * SOFTWARE.
+ * Copyright (c) 2015-2018 Philippe Proulx <pproulx@efficios.com>
  */
 
 #define BT_LOG_TAG "LIB/VALUE"
@@ -33,6 +17,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"
@@ -590,6 +575,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) {
@@ -608,6 +595,8 @@ end:
 
 struct bt_value *bt_value_bool_create(void)
 {
+       BT_ASSERT_PRE_NO_ERROR();
+
        return bt_value_bool_create_init(BT_FALSE);
 }
 
@@ -647,23 +636,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);
 }
 
@@ -671,6 +668,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) {
@@ -690,6 +689,8 @@ end:
 
 struct bt_value *bt_value_real_create(void)
 {
+       BT_ASSERT_PRE_NO_ERROR();
+
        return bt_value_real_create_init(0.);
 }
 
@@ -697,7 +698,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) {
@@ -725,6 +728,8 @@ end:
 
 struct bt_value *bt_value_string_create(void)
 {
+       BT_ASSERT_PRE_NO_ERROR();
+
        return bt_value_string_create_init("");
 }
 
@@ -732,6 +737,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) {
@@ -761,6 +768,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) {
@@ -872,6 +881,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");
@@ -915,6 +925,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);
@@ -933,6 +944,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);
@@ -947,6 +960,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);
@@ -961,6 +976,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);
@@ -974,6 +991,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);
@@ -988,6 +1007,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);
@@ -1002,6 +1023,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);
@@ -1021,6 +1044,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);
@@ -1040,6 +1065,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);
@@ -1090,6 +1116,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");
@@ -1110,6 +1137,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);
@@ -1124,6 +1153,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);
@@ -1138,6 +1169,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);
@@ -1151,6 +1184,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);
@@ -1165,6 +1200,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);
@@ -1180,6 +1217,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);
@@ -1199,6 +1238,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);
@@ -1215,11 +1256,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);
@@ -1228,43 +1271,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 *base_obj;
-       int status;
 };
 
 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,38 +1341,38 @@ bt_bool extend_map_element(const char *key,
        BT_ASSERT(extension_obj_elem_copy);
 
        /* Replace in base map value. */
-       extend_data->status = bt_value_map_insert_entry(
-               extend_data->base_obj, key,
-               (void *) extension_obj_elem_copy);
-       if (extend_data->status) {
+       status = bt_value_map_insert_entry(extend_data->base_obj, key,
+               extension_obj_elem_copy);
+       if (status) {
                BT_LIB_LOGE_APPEND_CAUSE(
                        "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);
+                       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(
                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 = {
                .base_obj = NULL,
-               .status = BT_FUNC_STATUS_OK,
        };
 
+       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");
@@ -1318,15 +1386,16 @@ enum bt_value_map_extend_status bt_value_map_extend(
         * in the base map object.
         */
        extend_data.base_obj = base_map_obj;
-
-       if (bt_value_map_foreach_entry_const(extension_obj, extend_map_element,
-                       &extend_data)) {
+       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);
        }
 
-       return extend_data.status;
+       return status;
 }
 
 enum bt_value_copy_status bt_value_copy(const struct bt_value *object,
@@ -1334,6 +1403,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.029649 seconds and 4 git commands to generate.