X-Git-Url: http://git.efficios.com/?a=blobdiff_plain;f=src%2Flib%2Fvalue.c;h=e570b005b4168448712f9bd34797ad56b800cf6c;hb=867eb7632255f6a84234542198bd7edaac1bce12;hp=77fc75b4962a235884cafa701d210e9c1a9f99f4;hpb=847ab606a7c62eccf63c86e4030a667e57d5b3e8;p=babeltrace.git diff --git a/src/lib/value.c b/src/lib/value.c index 77fc75b4..e570b005 100644 --- a/src/lib/value.c +++ b/src/lib/value.c @@ -1,23 +1,7 @@ /* - * Copyright (c) 2015-2018 Philippe Proulx - * - * 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 */ #define BT_LOG_TAG "LIB/VALUE" @@ -32,11 +16,19 @@ #include "compat/compiler.h" #include "common/common.h" #include "compat/glib.h" -#include "lib/assert-pre.h" +#include "lib/assert-cond.h" #include "lib/value.h" #include "common/assert.h" #include "func-status.h" +#define BT_ASSERT_PRE_DEV_VALUE_HOT_FROM_FUNC(_func, _value) \ + BT_ASSERT_PRE_DEV_HOT_FROM_FUNC(_func, "value-object", \ + ((struct bt_value *) (_value)), "Value object", \ + ": %!+v", (_value)) + +#define BT_ASSERT_PRE_DEV_VALUE_HOT(_value) \ + BT_ASSERT_PRE_DEV_VALUE_HOT_FROM_FUNC(__func__, (_value)) + #define BT_VALUE_TO_BOOL(_base) ((struct bt_value_bool *) (_base)) #define BT_VALUE_TO_INTEGER(_base) ((struct bt_value_integer *) (_base)) #define BT_VALUE_TO_REAL(_base) ((struct bt_value_real *) (_base)) @@ -44,28 +36,6 @@ #define BT_VALUE_TO_ARRAY(_base) ((struct bt_value_array *) (_base)) #define BT_VALUE_TO_MAP(_base) ((struct bt_value_map *) (_base)) -#define _BT_ASSERT_PRE_VALUE_IS_TYPE_COND(_value, _type) \ - (((struct bt_value *) (_value))->type == (_type)) - -#define _BT_ASSERT_PRE_VALUE_IS_TYPE_FMT \ - "Value has the wrong type ID: expected-type=%s, %![value-]+v" - -#define BT_ASSERT_PRE_VALUE_IS_TYPE(_value, _type) \ - BT_ASSERT_PRE( \ - _BT_ASSERT_PRE_VALUE_IS_TYPE_COND((_value), (_type)), \ - _BT_ASSERT_PRE_VALUE_IS_TYPE_FMT, \ - bt_common_value_type_string(_type), (_value)) - -#define BT_ASSERT_PRE_DEV_VALUE_IS_TYPE(_value, _type) \ - BT_ASSERT_PRE_DEV( \ - _BT_ASSERT_PRE_VALUE_IS_TYPE_COND((_value), (_type)), \ - _BT_ASSERT_PRE_VALUE_IS_TYPE_FMT, \ - bt_common_value_type_string(_type), (_value)) - -#define BT_ASSERT_PRE_DEV_VALUE_HOT(_value, _name) \ - BT_ASSERT_PRE_DEV_HOT(((struct bt_value *) (_value)), (_name), \ - ": %!+v", (_value)) - static void bt_value_null_instance_release_func(struct bt_object *obj) { @@ -136,6 +106,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 +167,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 +266,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 +278,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 +294,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 +318,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 +334,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 +350,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 +379,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 +393,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 +422,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 +436,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 @@ -569,7 +541,7 @@ end: enum bt_value_type bt_value_get_type(const struct bt_value *object) { - BT_ASSERT_PRE_DEV_NON_NULL(object, "Value object"); + BT_ASSERT_PRE_DEV_VALUE_NON_NULL(object); return object->type; } @@ -588,6 +560,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 +580,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 +621,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 +653,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 +674,8 @@ end: struct bt_value *bt_value_real_create(void) { + BT_ASSERT_PRE_NO_ERROR(); + return bt_value_real_create_init(0.); } @@ -695,7 +683,9 @@ struct bt_value *bt_value_string_create_init(const char *val) { struct bt_value_string *string_obj = NULL; - BT_ASSERT_PRE_NON_NULL(val, "Value"); + BT_ASSERT_PRE_NO_ERROR(); + BT_ASSERT_PRE_NON_NULL("raw-value", val, "Raw 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 +713,8 @@ end: struct bt_value *bt_value_string_create(void) { + BT_ASSERT_PRE_NO_ERROR(); + return bt_value_string_create_init(""); } @@ -730,6 +722,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 +753,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) { @@ -785,16 +781,15 @@ end: bt_bool bt_value_bool_get(const struct bt_value *bool_obj) { - BT_ASSERT_PRE_DEV_NON_NULL(bool_obj, "Value object"); - BT_ASSERT_PRE_DEV_VALUE_IS_TYPE(bool_obj, BT_VALUE_TYPE_BOOL); + BT_ASSERT_PRE_DEV_VALUE_NON_NULL(bool_obj); + BT_ASSERT_PRE_DEV_VALUE_IS_BOOL(bool_obj); return BT_VALUE_TO_BOOL(bool_obj)->value; } void bt_value_bool_set(struct bt_value *bool_obj, bt_bool val) { - BT_ASSERT_PRE_NON_NULL(bool_obj, "Value object"); - BT_ASSERT_PRE_VALUE_IS_TYPE(bool_obj, BT_VALUE_TYPE_BOOL); - BT_ASSERT_PRE_DEV_VALUE_HOT(bool_obj, "Value object"); + BT_ASSERT_PRE_VALUE_NON_NULL(bool_obj); + BT_ASSERT_PRE_VALUE_IS_BOOL(bool_obj); BT_VALUE_TO_BOOL(bool_obj)->value = val; BT_LOGT("Set boolean value's raw value: value-addr=%p, value=%d", bool_obj, val); @@ -802,34 +797,34 @@ void bt_value_bool_set(struct bt_value *bool_obj, bt_bool val) uint64_t bt_value_integer_unsigned_get(const struct bt_value *integer_obj) { - BT_ASSERT_PRE_DEV_NON_NULL(integer_obj, "Value object"); - BT_ASSERT_PRE_DEV_VALUE_IS_TYPE(integer_obj, - BT_VALUE_TYPE_UNSIGNED_INTEGER); + BT_ASSERT_PRE_DEV_VALUE_NON_NULL(integer_obj); + BT_ASSERT_PRE_DEV_VALUE_IS_UNSIGNED_INT(integer_obj); return BT_VALUE_TO_INTEGER(integer_obj)->value.u; } int64_t bt_value_integer_signed_get(const struct bt_value *integer_obj) { - BT_ASSERT_PRE_DEV_NON_NULL(integer_obj, "Value object"); - BT_ASSERT_PRE_DEV_VALUE_IS_TYPE(integer_obj, - BT_VALUE_TYPE_SIGNED_INTEGER); + BT_ASSERT_PRE_DEV_VALUE_NON_NULL(integer_obj); + BT_ASSERT_PRE_DEV_VALUE_IS_SIGNED_INT(integer_obj); return BT_VALUE_TO_INTEGER(integer_obj)->value.i; } static inline -void bt_value_integer_set(struct bt_value *integer_obj, - enum bt_value_type expected_type, uint64_t uval) +void set_integer_value(struct bt_value *integer_obj, + enum bt_value_type expected_type, uint64_t uval, + const char *api_func) { - BT_ASSERT_PRE_NON_NULL(integer_obj, "Value object"); - BT_ASSERT_PRE_VALUE_IS_TYPE(integer_obj, expected_type); - BT_ASSERT_PRE_DEV_VALUE_HOT(integer_obj, "Value object"); + BT_ASSERT_PRE_DEV_VALUE_HOT_FROM_FUNC(api_func, integer_obj); BT_VALUE_TO_INTEGER(integer_obj)->value.u = uval; } void bt_value_integer_unsigned_set(struct bt_value *integer_obj, uint64_t val) { - bt_value_integer_set(integer_obj, BT_VALUE_TYPE_UNSIGNED_INTEGER, val); + BT_ASSERT_PRE_VALUE_NON_NULL(integer_obj); + BT_ASSERT_PRE_VALUE_IS_UNSIGNED_INT(integer_obj); + set_integer_value(integer_obj, BT_VALUE_TYPE_UNSIGNED_INTEGER, val, + __func__); BT_LOGT("Set unsigned integer value's raw value: " "value-addr=%p, value=%" PRIu64, integer_obj, val); } @@ -837,24 +832,26 @@ void bt_value_integer_unsigned_set(struct bt_value *integer_obj, void bt_value_integer_signed_set(struct bt_value *integer_obj, int64_t val) { - bt_value_integer_set(integer_obj, BT_VALUE_TYPE_SIGNED_INTEGER, - (uint64_t) val); + BT_ASSERT_PRE_VALUE_NON_NULL(integer_obj); + BT_ASSERT_PRE_VALUE_IS_SIGNED_INT(integer_obj); + set_integer_value(integer_obj, BT_VALUE_TYPE_SIGNED_INTEGER, + (uint64_t) val, __func__); BT_LOGT("Set signed integer value's raw value: " "value-addr=%p, value=%" PRId64, integer_obj, val); } double bt_value_real_get(const struct bt_value *real_obj) { - BT_ASSERT_PRE_DEV_NON_NULL(real_obj, "Value object"); - BT_ASSERT_PRE_DEV_VALUE_IS_TYPE(real_obj, BT_VALUE_TYPE_REAL); + BT_ASSERT_PRE_DEV_VALUE_NON_NULL(real_obj); + BT_ASSERT_PRE_DEV_VALUE_IS_REAL(real_obj); return BT_VALUE_TO_REAL(real_obj)->value; } void bt_value_real_set(struct bt_value *real_obj, double val) { - BT_ASSERT_PRE_NON_NULL(real_obj, "Value object"); - BT_ASSERT_PRE_VALUE_IS_TYPE(real_obj, BT_VALUE_TYPE_REAL); - BT_ASSERT_PRE_DEV_VALUE_HOT(real_obj, "Value object"); + BT_ASSERT_PRE_VALUE_NON_NULL(real_obj); + BT_ASSERT_PRE_VALUE_IS_REAL(real_obj); + BT_ASSERT_PRE_DEV_VALUE_HOT(real_obj); BT_VALUE_TO_REAL(real_obj)->value = val; BT_LOGT("Set real number value's raw value: value-addr=%p, value=%f", real_obj, val); @@ -862,17 +859,18 @@ void bt_value_real_set(struct bt_value *real_obj, double val) const char *bt_value_string_get(const struct bt_value *string_obj) { - BT_ASSERT_PRE_DEV_NON_NULL(string_obj, "Value object"); - BT_ASSERT_PRE_DEV_VALUE_IS_TYPE(string_obj, BT_VALUE_TYPE_STRING); + BT_ASSERT_PRE_DEV_VALUE_NON_NULL(string_obj); + BT_ASSERT_PRE_DEV_VALUE_IS_STRING(string_obj); return BT_VALUE_TO_STRING(string_obj)->gstr->str; } enum bt_value_string_set_status bt_value_string_set( struct bt_value *string_obj, const char *val) { - 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"); + BT_ASSERT_PRE_NO_ERROR(); + BT_ASSERT_PRE_VALUE_NON_NULL(string_obj); + BT_ASSERT_PRE_VALUE_IS_STRING(string_obj); + BT_ASSERT_PRE_DEV_VALUE_HOT(string_obj); g_string_assign(BT_VALUE_TO_STRING(string_obj)->gstr, val); BT_LOGT("Set string value's raw value: value-addr=%p, raw-value-addr=%p", string_obj, val); @@ -881,8 +879,8 @@ enum bt_value_string_set_status bt_value_string_set( uint64_t bt_value_array_get_length(const struct bt_value *array_obj) { - BT_ASSERT_PRE_DEV_NON_NULL(array_obj, "Value object"); - BT_ASSERT_PRE_DEV_VALUE_IS_TYPE(array_obj, BT_VALUE_TYPE_ARRAY); + BT_ASSERT_PRE_DEV_VALUE_NON_NULL(array_obj); + BT_ASSERT_PRE_DEV_VALUE_IS_ARRAY(array_obj); return (uint64_t) BT_VALUE_TO_ARRAY(array_obj)->garray->len; } @@ -892,8 +890,8 @@ struct bt_value *bt_value_array_borrow_element_by_index( struct bt_value_array *typed_array_obj = BT_VALUE_TO_ARRAY(array_obj); - BT_ASSERT_PRE_DEV_NON_NULL(array_obj, "Value object"); - BT_ASSERT_PRE_DEV_VALUE_IS_TYPE(array_obj, BT_VALUE_TYPE_ARRAY); + BT_ASSERT_PRE_DEV_VALUE_NON_NULL(array_obj); + BT_ASSERT_PRE_DEV_VALUE_IS_ARRAY(array_obj); BT_ASSERT_PRE_DEV_VALID_INDEX(index, typed_array_obj->garray->len); return g_ptr_array_index(typed_array_obj->garray, index); } @@ -906,17 +904,22 @@ const struct bt_value *bt_value_array_borrow_element_by_index_const( (void *) array_obj, index); } -enum bt_value_array_append_element_status bt_value_array_append_element( +static +enum bt_value_array_append_element_status append_array_element( struct bt_value *array_obj, - struct bt_value *element_obj) + struct bt_value *element_obj, const char *api_func) { struct bt_value_array *typed_array_obj = BT_VALUE_TO_ARRAY(array_obj); - 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); - BT_ASSERT_PRE_DEV_VALUE_HOT(array_obj, "Array value object"); + BT_ASSERT_PRE_NO_ERROR_FROM_FUNC(api_func); + BT_ASSERT_PRE_NON_NULL_FROM_FUNC(api_func, "array-value-object", + array_obj, "Array value object"); + BT_ASSERT_PRE_NON_NULL_FROM_FUNC(api_func, "element-value-object", + element_obj, "Element value object"); + BT_ASSERT_PRE_VALUE_HAS_TYPE_FROM_FUNC(api_func, "value-object", + array_obj, "array", BT_VALUE_TYPE_ARRAY); + BT_ASSERT_PRE_DEV_VALUE_HOT_FROM_FUNC(api_func, array_obj); g_ptr_array_add(typed_array_obj->garray, element_obj); bt_object_get_ref(element_obj); BT_LOGT("Appended element to array value: array-value-addr=%p, " @@ -925,15 +928,24 @@ enum bt_value_array_append_element_status bt_value_array_append_element( return BT_FUNC_STATUS_OK; } +enum bt_value_array_append_element_status bt_value_array_append_element( + struct bt_value *array_obj, + struct bt_value *element_obj) +{ + return append_array_element(array_obj, element_obj, __func__); +} + enum bt_value_array_append_element_status 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); + ret = append_array_element(array_obj, + (void *) bool_obj, __func__); bt_object_put_ref(bool_obj); return ret; } @@ -945,9 +957,11 @@ 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); + ret = append_array_element(array_obj, + (void *) integer_obj, __func__); bt_object_put_ref(integer_obj); return ret; } @@ -959,9 +973,11 @@ 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); + ret = append_array_element(array_obj, + (void *) integer_obj, __func__); bt_object_put_ref(integer_obj); return ret; } @@ -972,9 +988,11 @@ 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); + ret = append_array_element(array_obj, + (void *) real_obj, __func__); bt_object_put_ref(real_obj); return ret; } @@ -986,9 +1004,11 @@ 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); + ret = append_array_element(array_obj, + (void *) string_obj, __func__); bt_object_put_ref(string_obj); return ret; } @@ -1000,9 +1020,11 @@ 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); + ret = append_array_element(array_obj, + (void *) empty_array_obj, __func__); if (element_obj) { *element_obj = empty_array_obj; @@ -1019,9 +1041,11 @@ 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); + ret = append_array_element(array_obj, + (void *) map_obj, __func__); if (element_obj) { *element_obj = map_obj; @@ -1038,10 +1062,13 @@ 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_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); - BT_ASSERT_PRE_DEV_VALUE_HOT(array_obj, "Array value object"); + BT_ASSERT_PRE_NO_ERROR(); + BT_ASSERT_PRE_NON_NULL("array-value-object", array_obj, + "Array value object"); + BT_ASSERT_PRE_NON_NULL("element-value-object", element_obj, + "Element value object"); + BT_ASSERT_PRE_VALUE_IS_ARRAY(array_obj); + BT_ASSERT_PRE_DEV_VALUE_HOT(array_obj); BT_ASSERT_PRE_VALID_INDEX(index, typed_array_obj->garray->len); bt_object_put_ref(g_ptr_array_index(typed_array_obj->garray, index)); g_ptr_array_index(typed_array_obj->garray, index) = element_obj; @@ -1054,17 +1081,17 @@ bt_value_array_set_element_by_index(struct bt_value *array_obj, uint64_t index, uint64_t bt_value_map_get_size(const struct bt_value *map_obj) { - BT_ASSERT_PRE_DEV_NON_NULL(map_obj, "Value object"); - BT_ASSERT_PRE_DEV_VALUE_IS_TYPE(map_obj, BT_VALUE_TYPE_MAP); + BT_ASSERT_PRE_DEV_VALUE_NON_NULL(map_obj); + BT_ASSERT_PRE_DEV_VALUE_IS_MAP(map_obj); return (uint64_t) g_hash_table_size(BT_VALUE_TO_MAP(map_obj)->ght); } struct bt_value *bt_value_map_borrow_entry_value(struct bt_value *map_obj, const char *key) { - BT_ASSERT_PRE_DEV_NON_NULL(map_obj, "Value object"); - BT_ASSERT_PRE_DEV_NON_NULL(key, "Key"); - BT_ASSERT_PRE_DEV_VALUE_IS_TYPE(map_obj, BT_VALUE_TYPE_MAP); + BT_ASSERT_PRE_DEV_VALUE_NON_NULL(map_obj); + BT_ASSERT_PRE_DEV_KEY_NON_NULL(key); + BT_ASSERT_PRE_DEV_VALUE_IS_MAP(map_obj); return g_hash_table_lookup(BT_VALUE_TO_MAP(map_obj)->ght, GUINT_TO_POINTER(g_quark_from_string(key))); } @@ -1077,22 +1104,27 @@ const struct bt_value *bt_value_map_borrow_entry_value_const( bt_bool bt_value_map_has_entry(const struct bt_value *map_obj, const char *key) { - BT_ASSERT_PRE_DEV_NON_NULL(map_obj, "Value object"); - BT_ASSERT_PRE_DEV_NON_NULL(key, "Key"); - BT_ASSERT_PRE_DEV_VALUE_IS_TYPE(map_obj, BT_VALUE_TYPE_MAP); + BT_ASSERT_PRE_DEV_VALUE_NON_NULL(map_obj); + BT_ASSERT_PRE_DEV_KEY_NON_NULL(key); + BT_ASSERT_PRE_DEV_VALUE_IS_MAP(map_obj); return bt_g_hash_table_contains(BT_VALUE_TO_MAP(map_obj)->ght, GUINT_TO_POINTER(g_quark_from_string(key))); } -enum bt_value_map_insert_entry_status bt_value_map_insert_entry( +static +enum bt_value_map_insert_entry_status insert_map_value_entry( struct bt_value *map_obj, const char *key, - struct bt_value *element_obj) -{ - 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"); - BT_ASSERT_PRE_VALUE_IS_TYPE(map_obj, BT_VALUE_TYPE_MAP); - BT_ASSERT_PRE_DEV_VALUE_HOT(map_obj, "Map value object"); + struct bt_value *element_obj, const char *api_func) +{ + BT_ASSERT_PRE_NO_ERROR_FROM_FUNC(api_func); + BT_ASSERT_PRE_NON_NULL_FROM_FUNC(api_func, "map-value-object", + map_obj, "Map value object"); + BT_ASSERT_PRE_KEY_NON_NULL_FROM_FUNC(api_func, key); + BT_ASSERT_PRE_NON_NULL_FROM_FUNC(api_func, + "element-value-object", element_obj, "Element value object"); + BT_ASSERT_PRE_VALUE_HAS_TYPE_FROM_FUNC(api_func, "value-object", + map_obj, "map", BT_VALUE_TYPE_MAP); + BT_ASSERT_PRE_DEV_VALUE_HOT_FROM_FUNC(api_func, map_obj); g_hash_table_insert(BT_VALUE_TO_MAP(map_obj)->ght, GUINT_TO_POINTER(g_quark_from_string(key)), element_obj); bt_object_get_ref(element_obj); @@ -1102,15 +1134,24 @@ enum bt_value_map_insert_entry_status bt_value_map_insert_entry( return BT_FUNC_STATUS_OK; } +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) +{ + return insert_map_value_entry(map_obj, key, element_obj, __func__); +} + enum bt_value_map_insert_entry_status bt_value_map_insert_bool_entry( struct bt_value *map_obj, const char *key, bt_bool val) { 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); + ret = insert_map_value_entry(map_obj, key, + (void *) bool_obj, __func__); bt_object_put_ref(bool_obj); return ret; } @@ -1122,9 +1163,11 @@ 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); + ret = insert_map_value_entry(map_obj, key, + (void *) integer_obj, __func__); bt_object_put_ref(integer_obj); return ret; } @@ -1136,9 +1179,11 @@ 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); + ret = insert_map_value_entry(map_obj, key, + (void *) integer_obj, __func__); bt_object_put_ref(integer_obj); return ret; } @@ -1149,9 +1194,11 @@ 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); + ret = insert_map_value_entry(map_obj, key, + (void *) real_obj, __func__); bt_object_put_ref(real_obj); return ret; } @@ -1163,9 +1210,11 @@ 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); + ret = insert_map_value_entry(map_obj, key, + (void *) string_obj, __func__); bt_object_put_ref(string_obj); return ret; } @@ -1178,9 +1227,11 @@ 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); + ret = insert_map_value_entry(map_obj, key, + (void *) array_obj, __func__); if (entry_obj) { *entry_obj = array_obj; @@ -1197,9 +1248,11 @@ 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); + ret = insert_map_value_entry(map_obj, key, + (void *) empty_map_obj, __func__); if (entry_obj) { *entry_obj = empty_map_obj; @@ -1209,60 +1262,98 @@ bt_value_map_insert_empty_map_entry(struct bt_value *map_obj, const char *key, return ret; } -enum bt_value_map_foreach_entry_status bt_value_map_foreach_entry( +static +enum bt_value_map_foreach_entry_status foreach_map_entry( struct bt_value *map_obj, bt_value_map_foreach_entry_func func, - void *data) + void *data, const char *api_func, + const char *user_func_name) { - 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_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); + BT_ASSERT_PRE_NO_ERROR_FROM_FUNC(api_func); + BT_ASSERT_PRE_DEV_VALUE_NON_NULL_FROM_FUNC(api_func, map_obj); + BT_ASSERT_PRE_DEV_NON_NULL_FROM_FUNC(api_func, "user-function", + func, "User function"); + BT_ASSERT_PRE_VALUE_HAS_TYPE_FROM_FUNC(api_func, "value-object", + map_obj, "map", BT_VALUE_TYPE_MAP); g_hash_table_iter_init(&iter, typed_map_obj->ght); 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(user_func_name, + 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_status bt_value_map_foreach_entry( + struct bt_value *map_obj, bt_value_map_foreach_entry_func func, + void *data) +{ + return foreach_map_entry(map_obj, func, data, __func__, + "bt_value_map_foreach_entry_func"); } 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) { - return (int) bt_value_map_foreach_entry((void *) map_obj, - (bt_value_map_foreach_entry_func) func, data); + return (int) foreach_map_entry((void *) map_obj, + (bt_value_map_foreach_entry_func) func, data, __func__, + "bt_value_map_foreach_entry_const_func"); } 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; @@ -1270,92 +1361,66 @@ 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, - (void *) extension_obj_elem_copy); - if (extend_data->status) { + /* Replace in base map value. */ + 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 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_NON_NULL(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_ASSERT_PRE_NO_ERROR(); + BT_ASSERT_PRE_NON_NULL("base-value-object", base_map_obj, + "Base value object"); + BT_ASSERT_PRE_DEV_VALUE_HOT(base_map_obj); + BT_ASSERT_PRE_NON_NULL("extension-value-object", extension_obj, + "Extension value object"); + BT_ASSERT_PRE_VALUE_HAS_TYPE("base-value-object", base_map_obj, + "map", BT_VALUE_TYPE_MAP); + BT_ASSERT_PRE_VALUE_HAS_TYPE("extension-value-object", extension_obj, + "map", 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, @@ -1363,8 +1428,10 @@ 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_NON_NULL(object, "Value object"); - BT_ASSERT_PRE_NON_NULL(copy_obj, "Value object copy (output)"); + BT_ASSERT_PRE_NO_ERROR(); + BT_ASSERT_PRE_VALUE_NON_NULL(object); + BT_ASSERT_PRE_NON_NULL("value-object-copy-output", copy_obj, + "Value object copy (output)"); BT_LOGD("Copying value object: addr=%p", object); *copy_obj = copy_funcs[object->type](object); if (*copy_obj) { @@ -1379,13 +1446,15 @@ 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; - BT_ASSERT_PRE_DEV_NON_NULL(object_a, "Value object A"); - BT_ASSERT_PRE_DEV_NON_NULL(object_b, "Value object B"); + BT_ASSERT_PRE_DEV_NON_NULL("value-object-a", object_a, + "Value object A"); + BT_ASSERT_PRE_DEV_NON_NULL("value-object-b", object_b, + "Value object B"); if (object_a->type != object_b->type) { BT_LOGT("Values are different: type mismatch: " @@ -1397,7 +1466,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;