lib: add pre condition asserts to check current thread has no error
[babeltrace.git] / src / lib / value.c
index 77fc75b4962a235884cafa701d210e9c1a9f99f4..15a97a828f9656501e01993c69f458867697cc2b 100644 (file)
@@ -136,6 +136,9 @@ void (* const destroy_funcs[])(struct bt_value *) = {
 static
 struct bt_value *bt_value_null_copy(const struct bt_value *null_obj)
 {
+       BT_ASSERT(null_obj == bt_value_null);
+
+       bt_object_get_ref_no_null_check(bt_value_null);
        return (void *) bt_value_null;
 }
 
@@ -194,7 +197,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);
@@ -294,11 +296,11 @@ struct bt_value *(* const copy_funcs[])(const struct bt_value *) = {
 };
 
 static
-bt_bool bt_value_null_compare(const struct bt_value *object_a,
+bt_bool bt_value_null_is_equal(const struct bt_value *object_a,
                const struct bt_value *object_b)
 {
        /*
-        * Always BT_TRUE since bt_value_compare() already checks if both
+        * Always BT_TRUE since bt_value_is_equal() already checks if both
         * object_a and object_b have the same type, and in the case of
         * null value objects, they're always the same if it is so.
         */
@@ -306,7 +308,7 @@ bt_bool bt_value_null_compare(const struct bt_value *object_a,
 }
 
 static
-bt_bool bt_value_bool_compare(const struct bt_value *object_a,
+bt_bool bt_value_bool_is_equal(const struct bt_value *object_a,
                const struct bt_value *object_b)
 {
        if (BT_VALUE_TO_BOOL(object_a)->value !=
@@ -322,7 +324,7 @@ bt_bool bt_value_bool_compare(const struct bt_value *object_a,
 }
 
 static
-bt_bool bt_value_integer_compare(const struct bt_value *object_a,
+bt_bool bt_value_integer_is_equal(const struct bt_value *object_a,
                const struct bt_value *object_b)
 {
        if (BT_VALUE_TO_INTEGER(object_a)->value.u !=
@@ -346,7 +348,7 @@ bt_bool bt_value_integer_compare(const struct bt_value *object_a,
 }
 
 static
-bt_bool bt_value_real_compare(const struct bt_value *object_a,
+bt_bool bt_value_real_is_equal(const struct bt_value *object_a,
                const struct bt_value *object_b)
 {
        if (BT_VALUE_TO_REAL(object_a)->value !=
@@ -362,7 +364,7 @@ bt_bool bt_value_real_compare(const struct bt_value *object_a,
 }
 
 static
-bt_bool bt_value_string_compare(const struct bt_value *object_a,
+bt_bool bt_value_string_is_equal(const struct bt_value *object_a,
                const struct bt_value *object_b)
 {
        if (strcmp(BT_VALUE_TO_STRING(object_a)->gstr->str,
@@ -378,7 +380,7 @@ bt_bool bt_value_string_compare(const struct bt_value *object_a,
 }
 
 static
-bt_bool bt_value_array_compare(const struct bt_value *object_a,
+bt_bool bt_value_array_is_equal(const struct bt_value *object_a,
                const struct bt_value *object_b)
 {
        int i;
@@ -407,7 +409,7 @@ bt_bool bt_value_array_compare(const struct bt_value *object_a,
                element_obj_b = bt_value_array_borrow_element_by_index_const(
                        object_b, i);
 
-               if (!bt_value_compare(element_obj_a, element_obj_b)) {
+               if (!bt_value_is_equal(element_obj_a, element_obj_b)) {
                        BT_LOGT("Array values's elements are different: "
                                "value-a-addr=%p, value-b-addr=%p, index=%d",
                                element_obj_a, element_obj_b, i);
@@ -421,7 +423,7 @@ end:
 }
 
 static
-bt_bool bt_value_map_compare(const struct bt_value *object_a,
+bt_bool bt_value_map_is_equal(const struct bt_value *object_a,
                const struct bt_value *object_b)
 {
        bt_bool ret = BT_TRUE;
@@ -450,7 +452,7 @@ bt_bool bt_value_map_compare(const struct bt_value *object_a,
                element_obj_b = bt_value_map_borrow_entry_value_const(object_b,
                        key_str);
 
-               if (!bt_value_compare(element_obj_a, element_obj_b)) {
+               if (!bt_value_is_equal(element_obj_a, element_obj_b)) {
                        BT_LOGT("Map values's elements are different: "
                                "value-a-addr=%p, value-b-addr=%p, key=\"%s\"",
                                element_obj_a, element_obj_b, key_str);
@@ -464,16 +466,16 @@ end:
 }
 
 static
-bt_bool (* const compare_funcs[])(const struct bt_value *,
+bt_bool (* const is_equal_funcs[])(const struct bt_value *,
                const struct bt_value *) = {
-       [BT_VALUE_TYPE_NULL] =                  bt_value_null_compare,
-       [BT_VALUE_TYPE_BOOL] =                  bt_value_bool_compare,
-       [BT_VALUE_TYPE_UNSIGNED_INTEGER] =      bt_value_integer_compare,
-       [BT_VALUE_TYPE_SIGNED_INTEGER] =        bt_value_integer_compare,
-       [BT_VALUE_TYPE_REAL] =                  bt_value_real_compare,
-       [BT_VALUE_TYPE_STRING] =                bt_value_string_compare,
-       [BT_VALUE_TYPE_ARRAY] =                 bt_value_array_compare,
-       [BT_VALUE_TYPE_MAP] =                   bt_value_map_compare,
+       [BT_VALUE_TYPE_NULL] =                  bt_value_null_is_equal,
+       [BT_VALUE_TYPE_BOOL] =                  bt_value_bool_is_equal,
+       [BT_VALUE_TYPE_UNSIGNED_INTEGER] =      bt_value_integer_is_equal,
+       [BT_VALUE_TYPE_SIGNED_INTEGER] =        bt_value_integer_is_equal,
+       [BT_VALUE_TYPE_REAL] =                  bt_value_real_is_equal,
+       [BT_VALUE_TYPE_STRING] =                bt_value_string_is_equal,
+       [BT_VALUE_TYPE_ARRAY] =                 bt_value_array_is_equal,
+       [BT_VALUE_TYPE_MAP] =                   bt_value_map_is_equal,
 };
 
 static
@@ -588,6 +590,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) {
@@ -606,6 +610,8 @@ end:
 
 struct bt_value *bt_value_bool_create(void)
 {
+       BT_ASSERT_PRE_NO_ERROR();
+
        return bt_value_bool_create_init(BT_FALSE);
 }
 
@@ -645,23 +651,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);
 }
 
@@ -669,6 +683,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) {
@@ -688,6 +704,8 @@ end:
 
 struct bt_value *bt_value_real_create(void)
 {
+       BT_ASSERT_PRE_NO_ERROR();
+
        return bt_value_real_create_init(0.);
 }
 
@@ -695,7 +713,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) {
@@ -723,6 +743,8 @@ end:
 
 struct bt_value *bt_value_string_create(void)
 {
+       BT_ASSERT_PRE_NO_ERROR();
+
        return bt_value_string_create_init("");
 }
 
@@ -730,6 +752,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) {
@@ -759,6 +783,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) {
@@ -870,6 +896,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");
@@ -913,6 +940,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);
@@ -931,6 +959,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);
@@ -945,6 +975,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);
@@ -959,6 +991,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);
@@ -972,6 +1006,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);
@@ -986,6 +1022,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);
@@ -1000,6 +1038,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);
@@ -1019,6 +1059,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);
@@ -1038,6 +1080,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);
@@ -1088,6 +1131,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");
@@ -1108,6 +1152,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);
@@ -1122,6 +1168,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);
@@ -1136,6 +1184,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);
@@ -1149,6 +1199,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);
@@ -1163,6 +1215,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);
@@ -1178,6 +1232,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);
@@ -1197,6 +1253,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);
@@ -1218,6 +1276,8 @@ enum bt_value_map_foreach_entry_status bt_value_map_foreach_entry(
        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);
@@ -1242,12 +1302,14 @@ 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;
+       struct bt_value *base_obj;
        int status;
 };
 
@@ -1270,15 +1332,15 @@ bt_bool extend_map_element(const char *key,
 
        BT_ASSERT(extension_obj_elem_copy);
 
-       /* Replace in extended object */
+       /* Replace in base map value. */
        extend_data->status = bt_value_map_insert_entry(
-               extend_data->extended_obj, key,
+               extend_data->base_obj, key,
                (void *) extension_obj_elem_copy);
        if (extend_data->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,
+                       "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;
        }
@@ -1295,66 +1357,36 @@ end:
 }
 
 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)
 {
        struct extend_map_element_data extend_data = {
-               .extended_obj = NULL,
+               .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");
-       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;
+       extend_data.base_obj = base_map_obj;
 
        if (bt_value_map_foreach_entry_const(extension_obj, extend_map_element,
                        &extend_data)) {
                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;
 }
 
@@ -1363,6 +1395,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);
@@ -1379,7 +1412,7 @@ enum bt_value_copy_status bt_value_copy(const struct bt_value *object,
        return status;
 }
 
-bt_bool bt_value_compare(const struct bt_value *object_a,
+bt_bool bt_value_is_equal(const struct bt_value *object_a,
        const struct bt_value *object_b)
 {
        bt_bool ret = BT_FALSE;
@@ -1397,7 +1430,7 @@ bt_bool bt_value_compare(const struct bt_value *object_a,
                goto end;
        }
 
-       ret = compare_funcs[object_a->type](object_a, object_b);
+       ret = is_equal_funcs[object_a->type](object_a, object_b);
 
 end:
        return ret;
This page took 0.031766 seconds and 4 git commands to generate.