lib: update and simplify the `bt_object` API

[babeltrace.git] / lib / values.c

/*
 * Values.c: value objects
 *
 * Babeltrace Library
 *
 * Copyright (c) 2015 EfficiOS Inc. and Linux Foundation
 * Copyright (c) 2015 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.
 *
 * 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.
 */

#define BT_LOG_TAG "VALUES"
#include <babeltrace/lib-logging-internal.h>

#include <stdlib.h>
#include <string.h>
#include <string.h>
#include <inttypes.h>
#include <babeltrace/compiler-internal.h>
#include <babeltrace/ref.h>
#include <babeltrace/values.h>
#include <babeltrace/compat/glib-internal.h>
#include <babeltrace/types.h>
#include <babeltrace/object-internal.h>
#include <babeltrace/values-internal.h>
#include <babeltrace/assert-internal.h>
#include <babeltrace/assert-pre-internal.h>

#define BT_VALUE_FROM_CONCRETE(_concrete) ((struct bt_value *) (_concrete))
#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_FLOAT(_base) ((struct bt_value_float *) (_base))
#define BT_VALUE_TO_STRING(_base) ((struct bt_value_string *) (_base))
#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(_value, _type)                      \
        BT_ASSERT_PRE((_value)->type == (_type),                        \
                "Value has the wrong type ID: expected-type=%s, "       \
                "%![value-]+v", bt_value_type_string(_type),            \
                (_value))

#define BT_ASSERT_PRE_VALUE_HOT(_value, _name)                          \
        BT_ASSERT_PRE_HOT((_value), (_name), ": +%!+v", (_value))

#define BT_ASSERT_PRE_VALUE_INDEX_IN_BOUNDS(_index, _count)             \
        BT_ASSERT_PRE((_index) < (_count),                              \
                "Index is out of bound: "                               \
                "index=%" PRIu64 ", count=%u", (_index), (_count));


struct bt_value {
        struct bt_object base;
        enum bt_value_type type;
        bt_bool frozen;
};

static
void bt_value_null_instance_release_func(struct bt_object *obj)
{
        BT_LOGW("Releasing the null value singleton: addr=%p", obj);
}

static
struct bt_value bt_value_null_instance = {
        .base = {
                .is_shared = true,
                .ref_count = 1,
                .release_func = bt_value_null_instance_release_func,
                .spec_release_func = NULL,
                .parent_is_owner_listener_func = NULL,
                .parent = NULL,
        },
        .type = BT_VALUE_TYPE_NULL,
        .frozen = BT_TRUE,
};

struct bt_value *bt_value_null = &bt_value_null_instance;

struct bt_value_bool {
        struct bt_value base;
        bt_bool value;
};

struct bt_value_integer {
        struct bt_value base;
        int64_t value;
};

struct bt_value_float {
        struct bt_value base;
        double value;
};

struct bt_value_string {
        struct bt_value base;
        GString *gstr;
};

struct bt_value_array {
        struct bt_value base;
        GPtrArray *garray;
};

struct bt_value_map {
        struct bt_value base;
        GHashTable *ght;
};

static
void bt_value_destroy(struct bt_object *obj);

static
void bt_value_string_destroy(struct bt_value *object)
{
        g_string_free(BT_VALUE_TO_STRING(object)->gstr, TRUE);
}

static
void bt_value_array_destroy(struct bt_value *object)
{
        /*
         * Pointer array's registered value destructor will take care
         * of putting each contained object.
         */
        g_ptr_array_free(BT_VALUE_TO_ARRAY(object)->garray, TRUE);
}

static
void bt_value_map_destroy(struct bt_value *object)
{
        /*
         * Hash table's registered value destructor will take care of
         * putting each contained object. Keys are GQuarks and cannot
         * be destroyed anyway.
         */
        g_hash_table_destroy(BT_VALUE_TO_MAP(object)->ght);
}

static
void (* const destroy_funcs[])(struct bt_value *) = {
        [BT_VALUE_TYPE_NULL] =          NULL,
        [BT_VALUE_TYPE_BOOL] =          NULL,
        [BT_VALUE_TYPE_INTEGER] =       NULL,
        [BT_VALUE_TYPE_FLOAT] =         NULL,
        [BT_VALUE_TYPE_STRING] =        bt_value_string_destroy,
        [BT_VALUE_TYPE_ARRAY] =         bt_value_array_destroy,
        [BT_VALUE_TYPE_MAP] =           bt_value_map_destroy,
};

static
struct bt_value *bt_value_null_copy(const struct bt_value *null_obj)
{
        return bt_value_null;
}

static
struct bt_value *bt_value_bool_copy(const struct bt_value *bool_obj)
{
        return bt_value_bool_create_init(BT_VALUE_TO_BOOL(bool_obj)->value);
}

static
struct bt_value *bt_value_integer_copy(const struct bt_value *integer_obj)
{
        return bt_value_integer_create_init(
                BT_VALUE_TO_INTEGER(integer_obj)->value);
}

static
struct bt_value *bt_value_float_copy(const struct bt_value *float_obj)
{
        return bt_value_float_create_init(
                BT_VALUE_TO_FLOAT(float_obj)->value);
}

static
struct bt_value *bt_value_string_copy(const struct bt_value *string_obj)
{
        return bt_value_string_create_init(
                BT_VALUE_TO_STRING(string_obj)->gstr->str);
}

static
struct bt_value *bt_value_array_copy(const struct bt_value *array_obj)
{
        int i;
        int ret;
        struct bt_value *copy_obj;
        struct bt_value_array *typed_array_obj;

        BT_LOGD("Copying array value: addr=%p", array_obj);
        typed_array_obj = BT_VALUE_TO_ARRAY(array_obj);
        copy_obj = bt_value_array_create();
        if (!copy_obj) {
                BT_LOGE_STR("Cannot create empty array value.");
                goto end;
        }

        for (i = 0; i < typed_array_obj->garray->len; ++i) {
                struct bt_value *element_obj_copy;
                struct bt_value *element_obj = bt_value_array_borrow(
                        array_obj, i);

                BT_ASSERT(element_obj);
                BT_LOGD("Copying array value's element: element-addr=%p, "
                        "index=%d", element_obj, i);
                element_obj_copy = bt_value_copy(element_obj);
                if (!element_obj_copy) {
                        BT_LOGE("Cannot copy array value's element: "
                                "array-addr=%p, index=%d",
                                array_obj, i);
                        BT_PUT(copy_obj);
                        goto end;
                }

                ret = bt_value_array_append(copy_obj, element_obj_copy);
                BT_PUT(element_obj_copy);
                if (ret) {
                        BT_LOGE("Cannot append to array value: addr=%p",
                                array_obj);
                        BT_PUT(copy_obj);
                        goto end;
                }
        }

        BT_LOGD("Copied array value: original-addr=%p, copy-addr=%p",
                array_obj, copy_obj);

end:
        return copy_obj;
}

static
struct bt_value *bt_value_map_copy(const struct bt_value *map_obj)
{
        int ret;
        GHashTableIter iter;
        gpointer key, element_obj;
        struct bt_value *copy_obj;
        struct bt_value *element_obj_copy;
        struct bt_value_map *typed_map_obj;

        BT_LOGD("Copying map value: addr=%p", map_obj);
        typed_map_obj = BT_VALUE_TO_MAP(map_obj);
        copy_obj = bt_value_map_create();
        if (!copy_obj) {
                goto end;
        }

        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));

                BT_ASSERT(key_str);
                BT_LOGD("Copying map value's element: element-addr=%p, "
                        "key=\"%s\"", element_obj, key_str);
                element_obj_copy = bt_value_copy(element_obj);
                if (!element_obj_copy) {
                        BT_LOGE("Cannot copy map value's element: "
                                "map-addr=%p, key=\"%s\"",
                                map_obj, key_str);
                        BT_PUT(copy_obj);
                        goto end;
                }

                ret = bt_value_map_insert(copy_obj, key_str, element_obj_copy);
                BT_PUT(element_obj_copy);
                if (ret) {
                        BT_LOGE("Cannot insert into map value: addr=%p, key=\"%s\"",
                                map_obj, key_str);
                        BT_PUT(copy_obj);
                        goto end;
                }
        }

        BT_LOGD("Copied map value: addr=%p", map_obj);

end:
        return copy_obj;
}

static
struct bt_value *(* const copy_funcs[])(const struct bt_value *) = {
        [BT_VALUE_TYPE_NULL] =          bt_value_null_copy,
        [BT_VALUE_TYPE_BOOL] =          bt_value_bool_copy,
        [BT_VALUE_TYPE_INTEGER] =       bt_value_integer_copy,
        [BT_VALUE_TYPE_FLOAT] =         bt_value_float_copy,
        [BT_VALUE_TYPE_STRING] =        bt_value_string_copy,
        [BT_VALUE_TYPE_ARRAY] =         bt_value_array_copy,
        [BT_VALUE_TYPE_MAP] =           bt_value_map_copy,
};

static
bt_bool bt_value_null_compare(const struct bt_value *object_a,
                const struct bt_value *object_b)
{
        /*
         * Always BT_TRUE since bt_value_compare() 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.
         */
        return BT_TRUE;
}

static
bt_bool bt_value_bool_compare(const struct bt_value *object_a,
                const struct bt_value *object_b)
{
        if (BT_VALUE_TO_BOOL(object_a)->value !=
                        BT_VALUE_TO_BOOL(object_b)->value) {
                BT_LOGV("Boolean value objects are different: "
                        "bool-a-val=%d, bool-b-val=%d",
                        BT_VALUE_TO_BOOL(object_a)->value,
                        BT_VALUE_TO_BOOL(object_b)->value);
                return BT_FALSE;
        }

        return BT_TRUE;
}

static
bt_bool bt_value_integer_compare(const struct bt_value *object_a,
                const struct bt_value *object_b)
{
        if (BT_VALUE_TO_INTEGER(object_a)->value !=
                        BT_VALUE_TO_INTEGER(object_b)->value) {
                BT_LOGV("Integer value objects are different: "
                        "int-a-val=%" PRId64 ", int-b-val=%" PRId64,
                        BT_VALUE_TO_INTEGER(object_a)->value,
                        BT_VALUE_TO_INTEGER(object_b)->value);
                return BT_FALSE;
        }

        return BT_TRUE;
}

static
bt_bool bt_value_float_compare(const struct bt_value *object_a,
                const struct bt_value *object_b)
{
        if (BT_VALUE_TO_FLOAT(object_a)->value !=
                        BT_VALUE_TO_FLOAT(object_b)->value) {
                BT_LOGV("Floating point number value objects are different: "
                        "float-a-val=%f, float-b-val=%f",
                        BT_VALUE_TO_FLOAT(object_a)->value,
                        BT_VALUE_TO_FLOAT(object_b)->value);
                return BT_FALSE;
        }

        return BT_TRUE;
}

static
bt_bool bt_value_string_compare(const struct bt_value *object_a,
                const struct bt_value *object_b)
{
        if (strcmp(BT_VALUE_TO_STRING(object_a)->gstr->str,
                        BT_VALUE_TO_STRING(object_b)->gstr->str) != 0) {
                BT_LOGV("String value objects are different: "
                        "string-a-val=\"%s\", string-b-val=\"%s\"",
                        BT_VALUE_TO_STRING(object_a)->gstr->str,
                        BT_VALUE_TO_STRING(object_b)->gstr->str);
                return BT_FALSE;
        }

        return BT_TRUE;
}

static
bt_bool bt_value_array_compare(const struct bt_value *object_a,
                const struct bt_value *object_b)
{
        int i;
        bt_bool ret = BT_TRUE;
        const struct bt_value_array *array_obj_a =
                BT_VALUE_TO_ARRAY(object_a);

        if (bt_value_array_size(object_a) != bt_value_array_size(object_b)) {
                BT_LOGV("Array values are different: size mismatch "
                        "value-a-addr=%p, value-b-addr=%p, "
                        "value-a-size=%" PRId64 ", value-b-size=%" PRId64,
                        object_a, object_b,
                        bt_value_array_size(object_a),
                        bt_value_array_size(object_b));
                ret = BT_FALSE;
                goto end;
        }

        for (i = 0; i < array_obj_a->garray->len; ++i) {
                struct bt_value *element_obj_a;
                struct bt_value *element_obj_b;

                element_obj_a = bt_value_array_borrow(object_a, i);
                element_obj_b = bt_value_array_borrow(object_b, i);

                if (!bt_value_compare(element_obj_a, element_obj_b)) {
                        BT_LOGV("Array values's elements are different: "
                                "value-a-addr=%p, value-b-addr=%p, index=%d",
                                element_obj_a, element_obj_b, i);
                        ret = BT_FALSE;
                        goto end;
                }
        }

end:
        return ret;
}

static
bt_bool bt_value_map_compare(const struct bt_value *object_a,
                const struct bt_value *object_b)
{
        bt_bool ret = BT_TRUE;
        GHashTableIter iter;
        gpointer key, element_obj_a;
        const struct bt_value_map *map_obj_a = BT_VALUE_TO_MAP(object_a);

        if (bt_value_map_size(object_a) != bt_value_map_size(object_b)) {
                BT_LOGV("Map values are different: size mismatch "
                        "value-a-addr=%p, value-b-addr=%p, "
                        "value-a-size=%" PRId64 ", value-b-size=%" PRId64,
                        object_a, object_b,
                        bt_value_map_size(object_a),
                        bt_value_map_size(object_b));
                ret = BT_FALSE;
                goto end;
        }

        g_hash_table_iter_init(&iter, map_obj_a->ght);

        while (g_hash_table_iter_next(&iter, &key, &element_obj_a)) {
                struct bt_value *element_obj_b;
                const char *key_str = g_quark_to_string(GPOINTER_TO_UINT(key));

                element_obj_b = bt_value_map_borrow(object_b, key_str);

                if (!bt_value_compare(element_obj_a, element_obj_b)) {
                        BT_LOGV("Map values's elements are different: "
                                "value-a-addr=%p, value-b-addr=%p, key=\"%s\"",
                                element_obj_a, element_obj_b, key_str);
                        ret = BT_FALSE;
                        goto end;
                }
        }

end:
        return ret;
}

static
bt_bool (* const compare_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_INTEGER] =       bt_value_integer_compare,
        [BT_VALUE_TYPE_FLOAT] =         bt_value_float_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,
};

static
void bt_value_null_freeze(struct bt_value *object)
{
}

static
void bt_value_generic_freeze(struct bt_value *object)
{
        object->frozen = BT_TRUE;
}

static
void bt_value_array_freeze(struct bt_value *object)
{
        int i;
        struct bt_value_array *typed_array_obj =
                BT_VALUE_TO_ARRAY(object);

        for (i = 0; i < typed_array_obj->garray->len; ++i) {
                bt_value_freeze(g_ptr_array_index(typed_array_obj->garray, i));
        }

        bt_value_generic_freeze(object);
}

static
void bt_value_map_freeze(struct bt_value *object)
{
        GHashTableIter iter;
        gpointer key, element_obj;
        const struct bt_value_map *map_obj = BT_VALUE_TO_MAP(object);

        g_hash_table_iter_init(&iter, map_obj->ght);

        while (g_hash_table_iter_next(&iter, &key, &element_obj)) {
                bt_value_freeze(element_obj);
        }

        bt_value_generic_freeze(object);
}

static
void (* const freeze_funcs[])(struct bt_value *) = {
        [BT_VALUE_TYPE_NULL] =          bt_value_null_freeze,
        [BT_VALUE_TYPE_BOOL] =          bt_value_generic_freeze,
        [BT_VALUE_TYPE_INTEGER] =       bt_value_generic_freeze,
        [BT_VALUE_TYPE_FLOAT] =         bt_value_generic_freeze,
        [BT_VALUE_TYPE_STRING] =        bt_value_generic_freeze,
        [BT_VALUE_TYPE_ARRAY] =         bt_value_array_freeze,
        [BT_VALUE_TYPE_MAP] =           bt_value_map_freeze,
};

static
void bt_value_destroy(struct bt_object *obj)
{
        struct bt_value *value;

        value = container_of(obj, struct bt_value, base);
        BT_ASSERT(value->type != BT_VALUE_TYPE_UNKNOWN);
        BT_LOGD("Destroying value: addr=%p", value);

        if (bt_value_is_null(value)) {
                BT_LOGD_STR("Not destroying the null value singleton.");
                return;
        }

        if (destroy_funcs[value->type]) {
                destroy_funcs[value->type](value);
        }

        g_free(value);
}

BT_HIDDEN
enum bt_value_status _bt_value_freeze(struct bt_value *object)
{
        enum bt_value_status ret = BT_VALUE_STATUS_OK;

        BT_ASSERT(object);

        if (object->frozen) {
                goto end;
        }

        BT_LOGD("Freezing value: addr=%p", object);
        freeze_funcs[object->type](object);

end:
        return ret;
}

enum bt_value_type bt_value_get_type(const struct bt_value *object)
{
        BT_ASSERT_PRE_NON_NULL(object, "Value object");
        return object->type;
}

static
struct bt_value bt_value_create_base(enum bt_value_type type)
{
        struct bt_value value;

        value.type = type;
        value.frozen = BT_FALSE;
        bt_object_init_shared(&value.base, bt_value_destroy);
        return value;
}

struct bt_value *bt_value_bool_create_init(bt_bool val)
{
        struct bt_value_bool *bool_obj;

        BT_LOGD("Creating boolean value object: val=%d", val);
        bool_obj = g_new0(struct bt_value_bool, 1);
        if (!bool_obj) {
                BT_LOGE_STR("Failed to allocate one boolean value object.");
                goto end;
        }

        bool_obj->base = bt_value_create_base(BT_VALUE_TYPE_BOOL);
        bool_obj->value = val;
        BT_LOGD("Created boolean value object: addr=%p", bool_obj);

end:
        return BT_VALUE_FROM_CONCRETE(bool_obj);
}

struct bt_value *bt_value_bool_create(void)
{
        return bt_value_bool_create_init(BT_FALSE);
}

struct bt_value *bt_value_integer_create_init(int64_t val)
{
        struct bt_value_integer *integer_obj;

        BT_LOGD("Creating integer value object: val=%" PRId64, val);
        integer_obj = g_new0(struct bt_value_integer, 1);
        if (!integer_obj) {
                BT_LOGE_STR("Failed to allocate one integer value object.");
                goto end;
        }

        integer_obj->base = bt_value_create_base(BT_VALUE_TYPE_INTEGER);
        integer_obj->value = val;
        BT_LOGD("Created integer value object: addr=%p",
                integer_obj);

end:
        return BT_VALUE_FROM_CONCRETE(integer_obj);
}

struct bt_value *bt_value_integer_create(void)
{
        return bt_value_integer_create_init(0);
}

struct bt_value *bt_value_float_create_init(double val)
{
        struct bt_value_float *float_obj;

        BT_LOGD("Creating floating point number value object: val=%f", val);
        float_obj = g_new0(struct bt_value_float, 1);
        if (!float_obj) {
                BT_LOGE_STR("Failed to allocate one floating point number value object.");
                goto end;
        }

        float_obj->base = bt_value_create_base(BT_VALUE_TYPE_FLOAT);
        float_obj->value = val;
        BT_LOGD("Created floating point number value object: addr=%p",
                float_obj);

end:
        return BT_VALUE_FROM_CONCRETE(float_obj);
}

struct bt_value *bt_value_float_create(void)
{
        return bt_value_float_create_init(0.);
}

struct bt_value *bt_value_string_create_init(const char *val)
{
        struct bt_value_string *string_obj = NULL;

        if (!val) {
                BT_LOGW_STR("Invalid parameter: value is NULL.");
                goto end;
        }

        BT_LOGD("Creating string value object: val-len=%zu", strlen(val));
        string_obj = g_new0(struct bt_value_string, 1);
        if (!string_obj) {
                BT_LOGE_STR("Failed to allocate one string object.");
                goto end;
        }

        string_obj->base = bt_value_create_base(BT_VALUE_TYPE_STRING);
        string_obj->gstr = g_string_new(val);
        if (!string_obj->gstr) {
                BT_LOGE_STR("Failed to allocate a GString.");
                g_free(string_obj);
                string_obj = NULL;
                goto end;
        }

        BT_LOGD("Created string value object: addr=%p",
                string_obj);

end:
        return BT_VALUE_FROM_CONCRETE(string_obj);
}

struct bt_value *bt_value_string_create(void)
{
        return bt_value_string_create_init("");
}

struct bt_value *bt_value_array_create(void)
{
        struct bt_value_array *array_obj;

        BT_LOGD_STR("Creating empty array value object.");
        array_obj = g_new0(struct bt_value_array, 1);
        if (!array_obj) {
                BT_LOGE_STR("Failed to allocate one array object.");
                goto end;
        }

        array_obj->base = bt_value_create_base(BT_VALUE_TYPE_ARRAY);
        array_obj->garray = bt_g_ptr_array_new_full(0,
                (GDestroyNotify) bt_put);
        if (!array_obj->garray) {
                BT_LOGE_STR("Failed to allocate a GPtrArray.");
                g_free(array_obj);
                array_obj = NULL;
                goto end;
        }

        BT_LOGD("Created array value object: addr=%p",
                array_obj);

end:
        return BT_VALUE_FROM_CONCRETE(array_obj);
}

struct bt_value *bt_value_map_create(void)
{
        struct bt_value_map *map_obj;

        BT_LOGD_STR("Creating empty map value object.");
        map_obj = g_new0(struct bt_value_map, 1);
        if (!map_obj) {
                BT_LOGE_STR("Failed to allocate one map object.");
                goto end;
        }

        map_obj->base = bt_value_create_base(BT_VALUE_TYPE_MAP);
        map_obj->ght = g_hash_table_new_full(g_direct_hash, g_direct_equal,
                NULL, (GDestroyNotify) bt_put);
        if (!map_obj->ght) {
                BT_LOGE_STR("Failed to allocate a GHashTable.");
                g_free(map_obj);
                map_obj = NULL;
                goto end;
        }

        BT_LOGD("Created map value object: addr=%p",
                map_obj);

end:
        return BT_VALUE_FROM_CONCRETE(map_obj);
}

enum bt_value_status bt_value_bool_get(const struct bt_value *bool_obj,
                bt_bool *val)
{
        BT_ASSERT_PRE_NON_NULL(bool_obj, "Value object");
        BT_ASSERT_PRE_NON_NULL(val, "Raw value");
        BT_ASSERT_PRE_VALUE_IS_TYPE(bool_obj, BT_VALUE_TYPE_BOOL);
        *val = BT_VALUE_TO_BOOL(bool_obj)->value;
        return BT_VALUE_STATUS_OK;
}

enum bt_value_status 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_VALUE_HOT(bool_obj, "Value object");
        BT_VALUE_TO_BOOL(bool_obj)->value = val;
        BT_LOGV("Set boolean value's raw value: value-addr=%p, value=%d",
                bool_obj, val);
        return BT_VALUE_STATUS_OK;
}

enum bt_value_status bt_value_integer_get(const struct bt_value *integer_obj,
                int64_t *val)
{
        BT_ASSERT_PRE_NON_NULL(integer_obj, "Value object");
        BT_ASSERT_PRE_NON_NULL(val, "Raw value");
        BT_ASSERT_PRE_VALUE_IS_TYPE(integer_obj, BT_VALUE_TYPE_INTEGER);
        *val = BT_VALUE_TO_INTEGER(integer_obj)->value;
        return BT_VALUE_STATUS_OK;
}

enum bt_value_status bt_value_integer_set(struct bt_value *integer_obj,
                int64_t val)
{
        BT_ASSERT_PRE_NON_NULL(integer_obj, "Value object");
        BT_ASSERT_PRE_VALUE_IS_TYPE(integer_obj, BT_VALUE_TYPE_INTEGER);
        BT_ASSERT_PRE_VALUE_HOT(integer_obj, "Value object");
        BT_VALUE_TO_INTEGER(integer_obj)->value = val;
        BT_LOGV("Set integer value's raw value: value-addr=%p, value=%" PRId64,
                integer_obj, val);
        return BT_VALUE_STATUS_OK;
}

enum bt_value_status bt_value_float_get(const struct bt_value *float_obj,
                double *val)
{
        BT_ASSERT_PRE_NON_NULL(float_obj, "Value object");
        BT_ASSERT_PRE_NON_NULL(val, "Raw value");
        BT_ASSERT_PRE_VALUE_IS_TYPE(float_obj, BT_VALUE_TYPE_FLOAT);
        *val = BT_VALUE_TO_FLOAT(float_obj)->value;
        return BT_VALUE_STATUS_OK;
}

enum bt_value_status bt_value_float_set(struct bt_value *float_obj,
                double val)
{
        BT_ASSERT_PRE_NON_NULL(float_obj, "Value object");
        BT_ASSERT_PRE_VALUE_IS_TYPE(float_obj, BT_VALUE_TYPE_FLOAT);
        BT_ASSERT_PRE_VALUE_HOT(float_obj, "Value object");
        BT_VALUE_TO_FLOAT(float_obj)->value = val;
        BT_LOGV("Set floating point number value's raw value: value-addr=%p, value=%f",
                float_obj, val);
        return BT_VALUE_STATUS_OK;
}

enum bt_value_status bt_value_string_get(const struct bt_value *string_obj,
                const char **val)
{
        BT_ASSERT_PRE_NON_NULL(string_obj, "Value object");
        BT_ASSERT_PRE_NON_NULL(val, "Raw value");
        BT_ASSERT_PRE_VALUE_IS_TYPE(string_obj, BT_VALUE_TYPE_STRING);
        *val = BT_VALUE_TO_STRING(string_obj)->gstr->str;
        return BT_VALUE_STATUS_OK;
}

enum bt_value_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_NON_NULL(val, "Raw value");
        BT_ASSERT_PRE_VALUE_IS_TYPE(string_obj, BT_VALUE_TYPE_STRING);
        BT_ASSERT_PRE_VALUE_HOT(string_obj, "Value object");
        g_string_assign(BT_VALUE_TO_STRING(string_obj)->gstr, val);
        BT_LOGV("Set string value's raw value: value-addr=%p, raw-value-addr=%p",
                string_obj, val);
        return BT_VALUE_STATUS_OK;
}

int64_t bt_value_array_size(const struct bt_value *array_obj)
{
        BT_ASSERT_PRE_NON_NULL(array_obj, "Value object");
        BT_ASSERT_PRE_VALUE_IS_TYPE(array_obj, BT_VALUE_TYPE_ARRAY);
        return (int64_t) BT_VALUE_TO_ARRAY(array_obj)->garray->len;
}

bt_bool bt_value_array_is_empty(const struct bt_value *array_obj)
{
        return bt_value_array_size(array_obj) == 0;
}

struct bt_value *bt_value_array_borrow(const 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, "Value object");
        BT_ASSERT_PRE_VALUE_IS_TYPE(array_obj, BT_VALUE_TYPE_ARRAY);
        BT_ASSERT_PRE_VALUE_INDEX_IN_BOUNDS(index,
                typed_array_obj->garray->len);
        return g_ptr_array_index(typed_array_obj->garray, index);
}

enum bt_value_status bt_value_array_append(struct bt_value *array_obj,
                struct bt_value *element_obj)
{
        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_VALUE_HOT(array_obj, "Array value object");
        g_ptr_array_add(typed_array_obj->garray, element_obj);
        bt_get(element_obj);
        BT_LOGV("Appended element to array value: array-value-addr=%p, "
                "element-value-addr=%p, new-size=%u",
                array_obj, element_obj, typed_array_obj->garray->len);
        return BT_VALUE_STATUS_OK;
}

enum bt_value_status bt_value_array_append_bool(struct bt_value *array_obj,
                bt_bool val)
{
        enum bt_value_status ret;
        struct bt_value *bool_obj = NULL;

        bool_obj = bt_value_bool_create_init(val);
        ret = bt_value_array_append(array_obj, bool_obj);
        bt_put(bool_obj);
        return ret;
}

enum bt_value_status bt_value_array_append_integer(
                struct bt_value *array_obj, int64_t val)
{
        enum bt_value_status ret;
        struct bt_value *integer_obj = NULL;

        integer_obj = bt_value_integer_create_init(val);
        ret = bt_value_array_append(array_obj, integer_obj);
        bt_put(integer_obj);
        return ret;
}

enum bt_value_status bt_value_array_append_float(struct bt_value *array_obj,
                double val)
{
        enum bt_value_status ret;
        struct bt_value *float_obj = NULL;

        float_obj = bt_value_float_create_init(val);
        ret = bt_value_array_append(array_obj, float_obj);
        bt_put(float_obj);
        return ret;
}

enum bt_value_status bt_value_array_append_string(struct bt_value *array_obj,
                const char *val)
{
        enum bt_value_status ret;
        struct bt_value *string_obj = NULL;

        string_obj = bt_value_string_create_init(val);
        ret = bt_value_array_append(array_obj, string_obj);
        bt_put(string_obj);
        return ret;
}

enum bt_value_status bt_value_array_append_empty_array(
                struct bt_value *array_obj)
{
        enum bt_value_status ret;
        struct bt_value *empty_array_obj = NULL;

        empty_array_obj = bt_value_array_create();
        ret = bt_value_array_append(array_obj, empty_array_obj);
        bt_put(empty_array_obj);
        return ret;
}

enum bt_value_status bt_value_array_append_empty_map(struct bt_value *array_obj)
{
        enum bt_value_status ret;
        struct bt_value *map_obj = NULL;

        map_obj = bt_value_map_create();
        ret = bt_value_array_append(array_obj, map_obj);
        bt_put(map_obj);
        return ret;
}

enum bt_value_status bt_value_array_set(struct bt_value *array_obj,
                uint64_t index, struct bt_value *element_obj)
{
        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_VALUE_HOT(array_obj, "Array value object");
        BT_ASSERT_PRE_VALUE_INDEX_IN_BOUNDS(index,
                typed_array_obj->garray->len);
        bt_put(g_ptr_array_index(typed_array_obj->garray, index));
        g_ptr_array_index(typed_array_obj->garray, index) = element_obj;
        bt_get(element_obj);
        BT_LOGV("Set array value's element: array-value-addr=%p, "
                "index=%" PRIu64 ", element-value-addr=%p",
                array_obj, index, element_obj);
        return BT_VALUE_STATUS_OK;
}

int64_t bt_value_map_size(const struct bt_value *map_obj)
{
        BT_ASSERT_PRE_NON_NULL(map_obj, "Value object");
        BT_ASSERT_PRE_VALUE_IS_TYPE(map_obj, BT_VALUE_TYPE_MAP);
        return (int64_t) g_hash_table_size(BT_VALUE_TO_MAP(map_obj)->ght);
}

bt_bool bt_value_map_is_empty(const struct bt_value *map_obj)
{
        return bt_value_map_size(map_obj) == 0;
}

struct bt_value *bt_value_map_borrow(const struct bt_value *map_obj,
                const char *key)
{
        BT_ASSERT_PRE_NON_NULL(map_obj, "Value object");
        BT_ASSERT_PRE_NON_NULL(key, "Key");
        BT_ASSERT_PRE_VALUE_IS_TYPE(map_obj, BT_VALUE_TYPE_MAP);
        return g_hash_table_lookup(BT_VALUE_TO_MAP(map_obj)->ght,
                GUINT_TO_POINTER(g_quark_from_string(key)));
}

bt_bool bt_value_map_has_key(const struct bt_value *map_obj, const char *key)
{
        BT_ASSERT_PRE_NON_NULL(map_obj, "Value object");
        BT_ASSERT_PRE_NON_NULL(key, "Key");
        BT_ASSERT_PRE_VALUE_IS_TYPE(map_obj, BT_VALUE_TYPE_MAP);
        return bt_g_hash_table_contains(BT_VALUE_TO_MAP(map_obj)->ght,
                GUINT_TO_POINTER(g_quark_from_string(key)));
}

enum bt_value_status bt_value_map_insert(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_VALUE_HOT(map_obj, "Map value object");
        g_hash_table_insert(BT_VALUE_TO_MAP(map_obj)->ght,
                GUINT_TO_POINTER(g_quark_from_string(key)), element_obj);
        bt_get(element_obj);
        BT_LOGV("Inserted value into map value: map-value-addr=%p, "
                "key=\"%s\", element-value-addr=%p",
                map_obj, key, element_obj);
        return BT_VALUE_STATUS_OK;
}

enum bt_value_status bt_value_map_insert_bool(struct bt_value *map_obj,
                const char *key, bt_bool val)
{
        enum bt_value_status ret;
        struct bt_value *bool_obj = NULL;

        bool_obj = bt_value_bool_create_init(val);
        ret = bt_value_map_insert(map_obj, key, bool_obj);
        bt_put(bool_obj);
        return ret;
}

enum bt_value_status bt_value_map_insert_integer(struct bt_value *map_obj,
                const char *key, int64_t val)
{
        enum bt_value_status ret;
        struct bt_value *integer_obj = NULL;

        integer_obj = bt_value_integer_create_init(val);
        ret = bt_value_map_insert(map_obj, key, integer_obj);
        bt_put(integer_obj);
        return ret;
}

enum bt_value_status bt_value_map_insert_float(struct bt_value *map_obj,
                const char *key, double val)
{
        enum bt_value_status ret;
        struct bt_value *float_obj = NULL;

        float_obj = bt_value_float_create_init(val);
        ret = bt_value_map_insert(map_obj, key, float_obj);
        bt_put(float_obj);
        return ret;
}

enum bt_value_status bt_value_map_insert_string(struct bt_value *map_obj,
                const char *key, const char *val)
{
        enum bt_value_status ret;
        struct bt_value *string_obj = NULL;

        string_obj = bt_value_string_create_init(val);
        ret = bt_value_map_insert(map_obj, key, string_obj);
        bt_put(string_obj);
        return ret;
}

enum bt_value_status bt_value_map_insert_empty_array(struct bt_value *map_obj,
                const char *key)
{
        enum bt_value_status ret;
        struct bt_value *array_obj = NULL;

        array_obj = bt_value_array_create();
        ret = bt_value_map_insert(map_obj, key, array_obj);
        bt_put(array_obj);
        return ret;
}

enum bt_value_status bt_value_map_insert_empty_map(struct bt_value *map_obj,
                const char *key)
{
        enum bt_value_status ret;
        struct bt_value *empty_map_obj = NULL;

        empty_map_obj = bt_value_map_create();
        ret = bt_value_map_insert(map_obj, key, empty_map_obj);
        bt_put(empty_map_obj);
        return ret;
}

enum bt_value_status bt_value_map_foreach(const struct bt_value *map_obj,
                bt_value_map_foreach_cb cb, void *data)
{
        enum bt_value_status ret = BT_VALUE_STATUS_OK;
        gpointer key, element_obj;
        GHashTableIter iter;
        struct bt_value_map *typed_map_obj = BT_VALUE_TO_MAP(map_obj);

        BT_ASSERT_PRE_NON_NULL(map_obj, "Value object");
        BT_ASSERT_PRE_NON_NULL(cb, "Callback");
        BT_ASSERT_PRE_VALUE_IS_TYPE(map_obj, 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 (!cb(key_str, element_obj, data)) {
                        BT_LOGV("User canceled the loop: key=\"%s\", "
                                "value-addr=%p, data=%p",
                                key_str, element_obj, data);
                        ret = BT_VALUE_STATUS_CANCELED;
                        break;
                }
        }

        return ret;
}

struct extend_map_element_data {
        struct bt_value *extended_obj;
        bt_bool got_error;
};

static
bt_bool extend_map_element(const char *key,
                struct bt_value *extension_obj_elem, void *data)
{
        bt_bool ret = BT_TRUE;

        struct extend_map_element_data *extend_data = data;

        /* Copy object which is to replace the current one */
        struct bt_value *extension_obj_elem_copy =
                bt_value_copy(extension_obj_elem);

        /* Replace in extended object */
        if (bt_value_map_insert(extend_data->extended_obj, key,
                        extension_obj_elem_copy)) {
                BT_LOGE("Cannot replace value in extended value: key=\"%s\", "
                        "extended-value-addr=%p, element-value-addr=%p",
                        key, extend_data->extended_obj,
                        extension_obj_elem_copy);
                goto error;
        }

        goto end;

error:
        ret = BT_FALSE;
        extend_data->got_error = BT_TRUE;

end:
        BT_PUT(extension_obj_elem_copy);
        return ret;
}

struct bt_value *bt_value_map_extend(struct bt_value *base_map_obj,
                struct bt_value *extension_obj)
{
        struct bt_value *extended_obj = NULL;
        struct extend_map_element_data extend_data = { 0 };

        BT_ASSERT_PRE_NON_NULL(base_map_obj, "Base value object");
        BT_ASSERT_PRE_NON_NULL(extension_obj, "Extension value object");
        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);

        /* Create copy of base map object to start with */
        extended_obj = bt_value_copy(base_map_obj);
        if (!extended_obj) {
                BT_LOGE("Cannot copy base value: base-value-addr=%p",
                        base_map_obj);
                goto error;
        }

        /*
         * For each key in the extension map object, replace this key
         * in the copied map object.
         */
        extend_data.extended_obj = extended_obj;

        if (bt_value_map_foreach(extension_obj, extend_map_element,
                        &extend_data)) {
                BT_LOGE("Cannot iterate on the extension object's elements: "
                        "extension-value-addr=%p", extension_obj);
                goto error;
        }

        if (extend_data.got_error) {
                BT_LOGE("Failed to successfully iterate on the extension object's elements: "
                        "extension-value-addr=%p", extension_obj);
                goto error;
        }

        BT_LOGD("Extended map value: extended-value-addr=%p",
                extended_obj);
        goto end;

error:
        BT_PUT(extended_obj);

end:
        return extended_obj;
}

struct bt_value *bt_value_copy(const struct bt_value *object)
{
        struct bt_value *copy_obj = NULL;

        BT_ASSERT_PRE_NON_NULL(object, "Value object");
        BT_LOGD("Copying value object: addr=%p", object);
        copy_obj = copy_funcs[object->type](object);
        if (copy_obj) {
                BT_LOGD("Copied value object: copy-value-addr=%p",
                        copy_obj);
        } else {
                BT_LOGE_STR("Failed to copy value object.");
        }

        return copy_obj;
}

bt_bool bt_value_compare(const struct bt_value *object_a,
        const struct bt_value *object_b)
{
        bt_bool ret = BT_FALSE;

        BT_ASSERT_PRE_NON_NULL(object_a, "Value object A");
        BT_ASSERT_PRE_NON_NULL(object_b, "Value object B");

        if (object_a->type != object_b->type) {
                BT_LOGV("Values are different: type mismatch: "
                        "value-a-addr=%p, value-b-addr=%p, "
                        "value-a-type=%s, value-b-type=%s",
                        object_a, object_b,
                        bt_value_type_string(object_a->type),
                        bt_value_type_string(object_b->type));
                goto end;
        }

        ret = compare_funcs[object_a->type](object_a, object_b);

end:
        return ret;
}