2 * Values.c: value objects
6 * Copyright (c) 2015 EfficiOS Inc. and Linux Foundation
7 * Copyright (c) 2015 Philippe Proulx <pproulx@efficios.com>
9 * Permission is hereby granted, free of charge, to any person obtaining a copy
10 * of this software and associated documentation files (the "Software"), to deal
11 * in the Software without restriction, including without limitation the rights
12 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
13 * copies of the Software, and to permit persons to whom the Software is
14 * furnished to do so, subject to the following conditions:
16 * The above copyright notice and this permission notice shall be included in
17 * all copies or substantial portions of the Software.
19 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
20 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
21 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
22 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
23 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
24 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
28 #define BT_LOG_TAG "VALUES"
29 #include <babeltrace/lib-logging-internal.h>
35 #include <babeltrace/compiler-internal.h>
36 #include <babeltrace/ref.h>
37 #include <babeltrace/values.h>
38 #include <babeltrace/compat/glib-internal.h>
39 #include <babeltrace/types.h>
40 #include <babeltrace/object-internal.h>
41 #include <babeltrace/values-internal.h>
42 #include <babeltrace/assert-internal.h>
43 #include <babeltrace/assert-pre-internal.h>
45 #define BT_VALUE_FROM_CONCRETE(_concrete) ((struct bt_value *) (_concrete))
46 #define BT_VALUE_TO_BOOL(_base) ((struct bt_value_bool *) (_base))
47 #define BT_VALUE_TO_INTEGER(_base) ((struct bt_value_integer *) (_base))
48 #define BT_VALUE_TO_REAL(_base) ((struct bt_value_real *) (_base))
49 #define BT_VALUE_TO_STRING(_base) ((struct bt_value_string *) (_base))
50 #define BT_VALUE_TO_ARRAY(_base) ((struct bt_value_array *) (_base))
51 #define BT_VALUE_TO_MAP(_base) ((struct bt_value_map *) (_base))
53 #define BT_ASSERT_PRE_VALUE_IS_TYPE(_value, _type) \
54 BT_ASSERT_PRE((_value)->type == (_type), \
55 "Value has the wrong type ID: expected-type=%s, " \
56 "%![value-]+v", bt_value_type_string(_type), \
59 #define BT_ASSERT_PRE_VALUE_HOT(_value, _name) \
60 BT_ASSERT_PRE_HOT((_value), (_name), ": %!+v", (_value))
62 #define BT_ASSERT_PRE_VALUE_INDEX_IN_BOUNDS(_index, _count) \
63 BT_ASSERT_PRE((_index) < (_count), \
64 "Index is out of bound: " \
65 "index=%" PRIu64 ", count=%u", (_index), (_count));
69 struct bt_object base
;
70 enum bt_value_type type
;
75 void bt_value_null_instance_release_func(struct bt_object
*obj
)
77 BT_LOGW("Releasing the null value singleton: addr=%p", obj
);
81 struct bt_value bt_value_null_instance
= {
85 .release_func
= bt_value_null_instance_release_func
,
86 .spec_release_func
= NULL
,
87 .parent_is_owner_listener_func
= NULL
,
90 .type
= BT_VALUE_TYPE_NULL
,
94 struct bt_value
*bt_value_null
= &bt_value_null_instance
;
96 struct bt_value_bool
{
101 struct bt_value_integer
{
102 struct bt_value base
;
106 struct bt_value_real
{
107 struct bt_value base
;
111 struct bt_value_string
{
112 struct bt_value base
;
116 struct bt_value_array
{
117 struct bt_value base
;
121 struct bt_value_map
{
122 struct bt_value base
;
127 void bt_value_destroy(struct bt_object
*obj
);
130 void bt_value_string_destroy(struct bt_value
*object
)
132 g_string_free(BT_VALUE_TO_STRING(object
)->gstr
, TRUE
);
136 void bt_value_array_destroy(struct bt_value
*object
)
139 * Pointer array's registered value destructor will take care
140 * of putting each contained object.
142 g_ptr_array_free(BT_VALUE_TO_ARRAY(object
)->garray
, TRUE
);
146 void bt_value_map_destroy(struct bt_value
*object
)
149 * Hash table's registered value destructor will take care of
150 * putting each contained object. Keys are GQuarks and cannot
151 * be destroyed anyway.
153 g_hash_table_destroy(BT_VALUE_TO_MAP(object
)->ght
);
157 void (* const destroy_funcs
[])(struct bt_value
*) = {
158 [BT_VALUE_TYPE_NULL
] = NULL
,
159 [BT_VALUE_TYPE_BOOL
] = NULL
,
160 [BT_VALUE_TYPE_INTEGER
] = NULL
,
161 [BT_VALUE_TYPE_REAL
] = NULL
,
162 [BT_VALUE_TYPE_STRING
] = bt_value_string_destroy
,
163 [BT_VALUE_TYPE_ARRAY
] = bt_value_array_destroy
,
164 [BT_VALUE_TYPE_MAP
] = bt_value_map_destroy
,
168 struct bt_value
*bt_value_null_copy(const struct bt_value
*null_obj
)
170 return bt_value_null
;
174 struct bt_value
*bt_value_bool_copy(const struct bt_value
*bool_obj
)
176 return bt_value_bool_create_init(BT_VALUE_TO_BOOL(bool_obj
)->value
);
180 struct bt_value
*bt_value_integer_copy(const struct bt_value
*integer_obj
)
182 return bt_value_integer_create_init(
183 BT_VALUE_TO_INTEGER(integer_obj
)->value
);
187 struct bt_value
*bt_value_real_copy(const struct bt_value
*real_obj
)
189 return bt_value_real_create_init(
190 BT_VALUE_TO_REAL(real_obj
)->value
);
194 struct bt_value
*bt_value_string_copy(const struct bt_value
*string_obj
)
196 return bt_value_string_create_init(
197 BT_VALUE_TO_STRING(string_obj
)->gstr
->str
);
201 struct bt_value
*bt_value_array_copy(const struct bt_value
*array_obj
)
205 struct bt_value
*copy_obj
;
206 struct bt_value_array
*typed_array_obj
;
208 BT_LOGD("Copying array value: addr=%p", array_obj
);
209 typed_array_obj
= BT_VALUE_TO_ARRAY(array_obj
);
210 copy_obj
= bt_value_array_create();
212 BT_LOGE_STR("Cannot create empty array value.");
216 for (i
= 0; i
< typed_array_obj
->garray
->len
; ++i
) {
217 struct bt_value
*element_obj_copy
;
218 struct bt_value
*element_obj
= bt_value_array_borrow(
221 BT_ASSERT(element_obj
);
222 BT_LOGD("Copying array value's element: element-addr=%p, "
223 "index=%d", element_obj
, i
);
224 element_obj_copy
= bt_value_copy(element_obj
);
225 if (!element_obj_copy
) {
226 BT_LOGE("Cannot copy array value's element: "
227 "array-addr=%p, index=%d",
233 ret
= bt_value_array_append(copy_obj
, element_obj_copy
);
234 BT_PUT(element_obj_copy
);
236 BT_LOGE("Cannot append to array value: addr=%p",
243 BT_LOGD("Copied array value: original-addr=%p, copy-addr=%p",
244 array_obj
, copy_obj
);
251 struct bt_value
*bt_value_map_copy(const struct bt_value
*map_obj
)
255 gpointer key
, element_obj
;
256 struct bt_value
*copy_obj
;
257 struct bt_value
*element_obj_copy
;
258 struct bt_value_map
*typed_map_obj
;
260 BT_LOGD("Copying map value: addr=%p", map_obj
);
261 typed_map_obj
= BT_VALUE_TO_MAP(map_obj
);
262 copy_obj
= bt_value_map_create();
267 g_hash_table_iter_init(&iter
, typed_map_obj
->ght
);
269 while (g_hash_table_iter_next(&iter
, &key
, &element_obj
)) {
270 const char *key_str
= g_quark_to_string(GPOINTER_TO_UINT(key
));
273 BT_LOGD("Copying map value's element: element-addr=%p, "
274 "key=\"%s\"", element_obj
, key_str
);
275 element_obj_copy
= bt_value_copy(element_obj
);
276 if (!element_obj_copy
) {
277 BT_LOGE("Cannot copy map value's element: "
278 "map-addr=%p, key=\"%s\"",
284 ret
= bt_value_map_insert(copy_obj
, key_str
, element_obj_copy
);
285 BT_PUT(element_obj_copy
);
287 BT_LOGE("Cannot insert into map value: addr=%p, key=\"%s\"",
294 BT_LOGD("Copied map value: addr=%p", map_obj
);
301 struct bt_value
*(* const copy_funcs
[])(const struct bt_value
*) = {
302 [BT_VALUE_TYPE_NULL
] = bt_value_null_copy
,
303 [BT_VALUE_TYPE_BOOL
] = bt_value_bool_copy
,
304 [BT_VALUE_TYPE_INTEGER
] = bt_value_integer_copy
,
305 [BT_VALUE_TYPE_REAL
] = bt_value_real_copy
,
306 [BT_VALUE_TYPE_STRING
] = bt_value_string_copy
,
307 [BT_VALUE_TYPE_ARRAY
] = bt_value_array_copy
,
308 [BT_VALUE_TYPE_MAP
] = bt_value_map_copy
,
312 bt_bool
bt_value_null_compare(const struct bt_value
*object_a
,
313 const struct bt_value
*object_b
)
316 * Always BT_TRUE since bt_value_compare() already checks if both
317 * object_a and object_b have the same type, and in the case of
318 * null value objects, they're always the same if it is so.
324 bt_bool
bt_value_bool_compare(const struct bt_value
*object_a
,
325 const struct bt_value
*object_b
)
327 if (BT_VALUE_TO_BOOL(object_a
)->value
!=
328 BT_VALUE_TO_BOOL(object_b
)->value
) {
329 BT_LOGV("Boolean value objects are different: "
330 "bool-a-val=%d, bool-b-val=%d",
331 BT_VALUE_TO_BOOL(object_a
)->value
,
332 BT_VALUE_TO_BOOL(object_b
)->value
);
340 bt_bool
bt_value_integer_compare(const struct bt_value
*object_a
,
341 const struct bt_value
*object_b
)
343 if (BT_VALUE_TO_INTEGER(object_a
)->value
!=
344 BT_VALUE_TO_INTEGER(object_b
)->value
) {
345 BT_LOGV("Integer value objects are different: "
346 "int-a-val=%" PRId64
", int-b-val=%" PRId64
,
347 BT_VALUE_TO_INTEGER(object_a
)->value
,
348 BT_VALUE_TO_INTEGER(object_b
)->value
);
356 bt_bool
bt_value_real_compare(const struct bt_value
*object_a
,
357 const struct bt_value
*object_b
)
359 if (BT_VALUE_TO_REAL(object_a
)->value
!=
360 BT_VALUE_TO_REAL(object_b
)->value
) {
361 BT_LOGV("Real number value objects are different: "
362 "real-a-val=%f, real-b-val=%f",
363 BT_VALUE_TO_REAL(object_a
)->value
,
364 BT_VALUE_TO_REAL(object_b
)->value
);
372 bt_bool
bt_value_string_compare(const struct bt_value
*object_a
,
373 const struct bt_value
*object_b
)
375 if (strcmp(BT_VALUE_TO_STRING(object_a
)->gstr
->str
,
376 BT_VALUE_TO_STRING(object_b
)->gstr
->str
) != 0) {
377 BT_LOGV("String value objects are different: "
378 "string-a-val=\"%s\", string-b-val=\"%s\"",
379 BT_VALUE_TO_STRING(object_a
)->gstr
->str
,
380 BT_VALUE_TO_STRING(object_b
)->gstr
->str
);
388 bt_bool
bt_value_array_compare(const struct bt_value
*object_a
,
389 const struct bt_value
*object_b
)
392 bt_bool ret
= BT_TRUE
;
393 const struct bt_value_array
*array_obj_a
=
394 BT_VALUE_TO_ARRAY(object_a
);
396 if (bt_value_array_size(object_a
) != bt_value_array_size(object_b
)) {
397 BT_LOGV("Array values are different: size mismatch "
398 "value-a-addr=%p, value-b-addr=%p, "
399 "value-a-size=%" PRId64
", value-b-size=%" PRId64
,
401 bt_value_array_size(object_a
),
402 bt_value_array_size(object_b
));
407 for (i
= 0; i
< array_obj_a
->garray
->len
; ++i
) {
408 struct bt_value
*element_obj_a
;
409 struct bt_value
*element_obj_b
;
411 element_obj_a
= bt_value_array_borrow(object_a
, i
);
412 element_obj_b
= bt_value_array_borrow(object_b
, i
);
414 if (!bt_value_compare(element_obj_a
, element_obj_b
)) {
415 BT_LOGV("Array values's elements are different: "
416 "value-a-addr=%p, value-b-addr=%p, index=%d",
417 element_obj_a
, element_obj_b
, i
);
428 bt_bool
bt_value_map_compare(const struct bt_value
*object_a
,
429 const struct bt_value
*object_b
)
431 bt_bool ret
= BT_TRUE
;
433 gpointer key
, element_obj_a
;
434 const struct bt_value_map
*map_obj_a
= BT_VALUE_TO_MAP(object_a
);
436 if (bt_value_map_size(object_a
) != bt_value_map_size(object_b
)) {
437 BT_LOGV("Map values are different: size mismatch "
438 "value-a-addr=%p, value-b-addr=%p, "
439 "value-a-size=%" PRId64
", value-b-size=%" PRId64
,
441 bt_value_map_size(object_a
),
442 bt_value_map_size(object_b
));
447 g_hash_table_iter_init(&iter
, map_obj_a
->ght
);
449 while (g_hash_table_iter_next(&iter
, &key
, &element_obj_a
)) {
450 struct bt_value
*element_obj_b
;
451 const char *key_str
= g_quark_to_string(GPOINTER_TO_UINT(key
));
453 element_obj_b
= bt_value_map_borrow(object_b
, key_str
);
455 if (!bt_value_compare(element_obj_a
, element_obj_b
)) {
456 BT_LOGV("Map values's elements are different: "
457 "value-a-addr=%p, value-b-addr=%p, key=\"%s\"",
458 element_obj_a
, element_obj_b
, key_str
);
469 bt_bool (* const compare_funcs
[])(const struct bt_value
*,
470 const struct bt_value
*) = {
471 [BT_VALUE_TYPE_NULL
] = bt_value_null_compare
,
472 [BT_VALUE_TYPE_BOOL
] = bt_value_bool_compare
,
473 [BT_VALUE_TYPE_INTEGER
] = bt_value_integer_compare
,
474 [BT_VALUE_TYPE_REAL
] = bt_value_real_compare
,
475 [BT_VALUE_TYPE_STRING
] = bt_value_string_compare
,
476 [BT_VALUE_TYPE_ARRAY
] = bt_value_array_compare
,
477 [BT_VALUE_TYPE_MAP
] = bt_value_map_compare
,
481 void bt_value_null_freeze(struct bt_value
*object
)
486 void bt_value_generic_freeze(struct bt_value
*object
)
488 object
->frozen
= BT_TRUE
;
492 void bt_value_array_freeze(struct bt_value
*object
)
495 struct bt_value_array
*typed_array_obj
=
496 BT_VALUE_TO_ARRAY(object
);
498 for (i
= 0; i
< typed_array_obj
->garray
->len
; ++i
) {
499 bt_value_freeze(g_ptr_array_index(typed_array_obj
->garray
, i
));
502 bt_value_generic_freeze(object
);
506 void bt_value_map_freeze(struct bt_value
*object
)
509 gpointer key
, element_obj
;
510 const struct bt_value_map
*map_obj
= BT_VALUE_TO_MAP(object
);
512 g_hash_table_iter_init(&iter
, map_obj
->ght
);
514 while (g_hash_table_iter_next(&iter
, &key
, &element_obj
)) {
515 bt_value_freeze(element_obj
);
518 bt_value_generic_freeze(object
);
522 void (* const freeze_funcs
[])(struct bt_value
*) = {
523 [BT_VALUE_TYPE_NULL
] = bt_value_null_freeze
,
524 [BT_VALUE_TYPE_BOOL
] = bt_value_generic_freeze
,
525 [BT_VALUE_TYPE_INTEGER
] = bt_value_generic_freeze
,
526 [BT_VALUE_TYPE_REAL
] = bt_value_generic_freeze
,
527 [BT_VALUE_TYPE_STRING
] = bt_value_generic_freeze
,
528 [BT_VALUE_TYPE_ARRAY
] = bt_value_array_freeze
,
529 [BT_VALUE_TYPE_MAP
] = bt_value_map_freeze
,
533 void bt_value_destroy(struct bt_object
*obj
)
535 struct bt_value
*value
;
537 value
= container_of(obj
, struct bt_value
, base
);
538 BT_LOGD("Destroying value: addr=%p", value
);
540 if (bt_value_is_null(value
)) {
541 BT_LOGD_STR("Not destroying the null value singleton.");
545 if (destroy_funcs
[value
->type
]) {
546 destroy_funcs
[value
->type
](value
);
553 enum bt_value_status
_bt_value_freeze(struct bt_value
*object
)
555 enum bt_value_status ret
= BT_VALUE_STATUS_OK
;
559 if (object
->frozen
) {
563 BT_LOGD("Freezing value: addr=%p", object
);
564 freeze_funcs
[object
->type
](object
);
570 enum bt_value_type
bt_value_get_type(const struct bt_value
*object
)
572 BT_ASSERT_PRE_NON_NULL(object
, "Value object");
577 struct bt_value
bt_value_create_base(enum bt_value_type type
)
579 struct bt_value value
;
582 value
.frozen
= BT_FALSE
;
583 bt_object_init_shared(&value
.base
, bt_value_destroy
);
587 struct bt_value
*bt_value_bool_create_init(bt_bool val
)
589 struct bt_value_bool
*bool_obj
;
591 BT_LOGD("Creating boolean value object: val=%d", val
);
592 bool_obj
= g_new0(struct bt_value_bool
, 1);
594 BT_LOGE_STR("Failed to allocate one boolean value object.");
598 bool_obj
->base
= bt_value_create_base(BT_VALUE_TYPE_BOOL
);
599 bool_obj
->value
= val
;
600 BT_LOGD("Created boolean value object: addr=%p", bool_obj
);
603 return BT_VALUE_FROM_CONCRETE(bool_obj
);
606 struct bt_value
*bt_value_bool_create(void)
608 return bt_value_bool_create_init(BT_FALSE
);
611 struct bt_value
*bt_value_integer_create_init(int64_t val
)
613 struct bt_value_integer
*integer_obj
;
615 BT_LOGD("Creating integer value object: val=%" PRId64
, val
);
616 integer_obj
= g_new0(struct bt_value_integer
, 1);
618 BT_LOGE_STR("Failed to allocate one integer value object.");
622 integer_obj
->base
= bt_value_create_base(BT_VALUE_TYPE_INTEGER
);
623 integer_obj
->value
= val
;
624 BT_LOGD("Created integer value object: addr=%p",
628 return BT_VALUE_FROM_CONCRETE(integer_obj
);
631 struct bt_value
*bt_value_integer_create(void)
633 return bt_value_integer_create_init(0);
636 struct bt_value
*bt_value_real_create_init(double val
)
638 struct bt_value_real
*real_obj
;
640 BT_LOGD("Creating real number value object: val=%f", val
);
641 real_obj
= g_new0(struct bt_value_real
, 1);
643 BT_LOGE_STR("Failed to allocate one real number value object.");
647 real_obj
->base
= bt_value_create_base(BT_VALUE_TYPE_REAL
);
648 real_obj
->value
= val
;
649 BT_LOGD("Created real number value object: addr=%p",
653 return BT_VALUE_FROM_CONCRETE(real_obj
);
656 struct bt_value
*bt_value_real_create(void)
658 return bt_value_real_create_init(0.);
661 struct bt_value
*bt_value_string_create_init(const char *val
)
663 struct bt_value_string
*string_obj
= NULL
;
666 BT_LOGW_STR("Invalid parameter: value is NULL.");
670 BT_LOGD("Creating string value object: val-len=%zu", strlen(val
));
671 string_obj
= g_new0(struct bt_value_string
, 1);
673 BT_LOGE_STR("Failed to allocate one string object.");
677 string_obj
->base
= bt_value_create_base(BT_VALUE_TYPE_STRING
);
678 string_obj
->gstr
= g_string_new(val
);
679 if (!string_obj
->gstr
) {
680 BT_LOGE_STR("Failed to allocate a GString.");
686 BT_LOGD("Created string value object: addr=%p",
690 return BT_VALUE_FROM_CONCRETE(string_obj
);
693 struct bt_value
*bt_value_string_create(void)
695 return bt_value_string_create_init("");
698 struct bt_value
*bt_value_array_create(void)
700 struct bt_value_array
*array_obj
;
702 BT_LOGD_STR("Creating empty array value object.");
703 array_obj
= g_new0(struct bt_value_array
, 1);
705 BT_LOGE_STR("Failed to allocate one array object.");
709 array_obj
->base
= bt_value_create_base(BT_VALUE_TYPE_ARRAY
);
710 array_obj
->garray
= bt_g_ptr_array_new_full(0,
711 (GDestroyNotify
) bt_put
);
712 if (!array_obj
->garray
) {
713 BT_LOGE_STR("Failed to allocate a GPtrArray.");
719 BT_LOGD("Created array value object: addr=%p",
723 return BT_VALUE_FROM_CONCRETE(array_obj
);
726 struct bt_value
*bt_value_map_create(void)
728 struct bt_value_map
*map_obj
;
730 BT_LOGD_STR("Creating empty map value object.");
731 map_obj
= g_new0(struct bt_value_map
, 1);
733 BT_LOGE_STR("Failed to allocate one map object.");
737 map_obj
->base
= bt_value_create_base(BT_VALUE_TYPE_MAP
);
738 map_obj
->ght
= g_hash_table_new_full(g_direct_hash
, g_direct_equal
,
739 NULL
, (GDestroyNotify
) bt_put
);
741 BT_LOGE_STR("Failed to allocate a GHashTable.");
747 BT_LOGD("Created map value object: addr=%p",
751 return BT_VALUE_FROM_CONCRETE(map_obj
);
754 enum bt_value_status
bt_value_bool_get(const struct bt_value
*bool_obj
,
757 BT_ASSERT_PRE_NON_NULL(bool_obj
, "Value object");
758 BT_ASSERT_PRE_NON_NULL(val
, "Raw value");
759 BT_ASSERT_PRE_VALUE_IS_TYPE(bool_obj
, BT_VALUE_TYPE_BOOL
);
760 *val
= BT_VALUE_TO_BOOL(bool_obj
)->value
;
761 return BT_VALUE_STATUS_OK
;
764 enum bt_value_status
bt_value_bool_set(struct bt_value
*bool_obj
, bt_bool val
)
766 BT_ASSERT_PRE_NON_NULL(bool_obj
, "Value object");
767 BT_ASSERT_PRE_VALUE_IS_TYPE(bool_obj
, BT_VALUE_TYPE_BOOL
);
768 BT_ASSERT_PRE_VALUE_HOT(bool_obj
, "Value object");
769 BT_VALUE_TO_BOOL(bool_obj
)->value
= val
;
770 BT_LOGV("Set boolean value's raw value: value-addr=%p, value=%d",
772 return BT_VALUE_STATUS_OK
;
775 enum bt_value_status
bt_value_integer_get(const struct bt_value
*integer_obj
,
778 BT_ASSERT_PRE_NON_NULL(integer_obj
, "Value object");
779 BT_ASSERT_PRE_NON_NULL(val
, "Raw value");
780 BT_ASSERT_PRE_VALUE_IS_TYPE(integer_obj
, BT_VALUE_TYPE_INTEGER
);
781 *val
= BT_VALUE_TO_INTEGER(integer_obj
)->value
;
782 return BT_VALUE_STATUS_OK
;
785 enum bt_value_status
bt_value_integer_set(struct bt_value
*integer_obj
,
788 BT_ASSERT_PRE_NON_NULL(integer_obj
, "Value object");
789 BT_ASSERT_PRE_VALUE_IS_TYPE(integer_obj
, BT_VALUE_TYPE_INTEGER
);
790 BT_ASSERT_PRE_VALUE_HOT(integer_obj
, "Value object");
791 BT_VALUE_TO_INTEGER(integer_obj
)->value
= val
;
792 BT_LOGV("Set integer value's raw value: value-addr=%p, value=%" PRId64
,
794 return BT_VALUE_STATUS_OK
;
797 enum bt_value_status
bt_value_real_get(const struct bt_value
*real_obj
,
800 BT_ASSERT_PRE_NON_NULL(real_obj
, "Value object");
801 BT_ASSERT_PRE_NON_NULL(val
, "Raw value");
802 BT_ASSERT_PRE_VALUE_IS_TYPE(real_obj
, BT_VALUE_TYPE_REAL
);
803 *val
= BT_VALUE_TO_REAL(real_obj
)->value
;
804 return BT_VALUE_STATUS_OK
;
807 enum bt_value_status
bt_value_real_set(struct bt_value
*real_obj
,
810 BT_ASSERT_PRE_NON_NULL(real_obj
, "Value object");
811 BT_ASSERT_PRE_VALUE_IS_TYPE(real_obj
, BT_VALUE_TYPE_REAL
);
812 BT_ASSERT_PRE_VALUE_HOT(real_obj
, "Value object");
813 BT_VALUE_TO_REAL(real_obj
)->value
= val
;
814 BT_LOGV("Set real number value's raw value: value-addr=%p, value=%f",
816 return BT_VALUE_STATUS_OK
;
819 enum bt_value_status
bt_value_string_get(const struct bt_value
*string_obj
,
822 BT_ASSERT_PRE_NON_NULL(string_obj
, "Value object");
823 BT_ASSERT_PRE_NON_NULL(val
, "Raw value");
824 BT_ASSERT_PRE_VALUE_IS_TYPE(string_obj
, BT_VALUE_TYPE_STRING
);
825 *val
= BT_VALUE_TO_STRING(string_obj
)->gstr
->str
;
826 return BT_VALUE_STATUS_OK
;
829 enum bt_value_status
bt_value_string_set(struct bt_value
*string_obj
,
832 BT_ASSERT_PRE_NON_NULL(string_obj
, "Value object");
833 BT_ASSERT_PRE_NON_NULL(val
, "Raw value");
834 BT_ASSERT_PRE_VALUE_IS_TYPE(string_obj
, BT_VALUE_TYPE_STRING
);
835 BT_ASSERT_PRE_VALUE_HOT(string_obj
, "Value object");
836 g_string_assign(BT_VALUE_TO_STRING(string_obj
)->gstr
, val
);
837 BT_LOGV("Set string value's raw value: value-addr=%p, raw-value-addr=%p",
839 return BT_VALUE_STATUS_OK
;
842 int64_t bt_value_array_size(const struct bt_value
*array_obj
)
844 BT_ASSERT_PRE_NON_NULL(array_obj
, "Value object");
845 BT_ASSERT_PRE_VALUE_IS_TYPE(array_obj
, BT_VALUE_TYPE_ARRAY
);
846 return (int64_t) BT_VALUE_TO_ARRAY(array_obj
)->garray
->len
;
849 bt_bool
bt_value_array_is_empty(const struct bt_value
*array_obj
)
851 return bt_value_array_size(array_obj
) == 0;
854 struct bt_value
*bt_value_array_borrow(const struct bt_value
*array_obj
,
857 struct bt_value_array
*typed_array_obj
=
858 BT_VALUE_TO_ARRAY(array_obj
);
860 BT_ASSERT_PRE_NON_NULL(array_obj
, "Value object");
861 BT_ASSERT_PRE_VALUE_IS_TYPE(array_obj
, BT_VALUE_TYPE_ARRAY
);
862 BT_ASSERT_PRE_VALUE_INDEX_IN_BOUNDS(index
,
863 typed_array_obj
->garray
->len
);
864 return g_ptr_array_index(typed_array_obj
->garray
, index
);
867 enum bt_value_status
bt_value_array_append(struct bt_value
*array_obj
,
868 struct bt_value
*element_obj
)
870 struct bt_value_array
*typed_array_obj
=
871 BT_VALUE_TO_ARRAY(array_obj
);
873 BT_ASSERT_PRE_NON_NULL(array_obj
, "Array value object");
874 BT_ASSERT_PRE_NON_NULL(element_obj
, "Element value object");
875 BT_ASSERT_PRE_VALUE_IS_TYPE(array_obj
, BT_VALUE_TYPE_ARRAY
);
876 BT_ASSERT_PRE_VALUE_HOT(array_obj
, "Array value object");
877 g_ptr_array_add(typed_array_obj
->garray
, element_obj
);
879 BT_LOGV("Appended element to array value: array-value-addr=%p, "
880 "element-value-addr=%p, new-size=%u",
881 array_obj
, element_obj
, typed_array_obj
->garray
->len
);
882 return BT_VALUE_STATUS_OK
;
885 enum bt_value_status
bt_value_array_append_bool(struct bt_value
*array_obj
,
888 enum bt_value_status ret
;
889 struct bt_value
*bool_obj
= NULL
;
891 bool_obj
= bt_value_bool_create_init(val
);
892 ret
= bt_value_array_append(array_obj
, bool_obj
);
897 enum bt_value_status
bt_value_array_append_integer(
898 struct bt_value
*array_obj
, int64_t val
)
900 enum bt_value_status ret
;
901 struct bt_value
*integer_obj
= NULL
;
903 integer_obj
= bt_value_integer_create_init(val
);
904 ret
= bt_value_array_append(array_obj
, integer_obj
);
909 enum bt_value_status
bt_value_array_append_real(struct bt_value
*array_obj
,
912 enum bt_value_status ret
;
913 struct bt_value
*real_obj
= NULL
;
915 real_obj
= bt_value_real_create_init(val
);
916 ret
= bt_value_array_append(array_obj
, real_obj
);
921 enum bt_value_status
bt_value_array_append_string(struct bt_value
*array_obj
,
924 enum bt_value_status ret
;
925 struct bt_value
*string_obj
= NULL
;
927 string_obj
= bt_value_string_create_init(val
);
928 ret
= bt_value_array_append(array_obj
, string_obj
);
933 enum bt_value_status
bt_value_array_append_empty_array(
934 struct bt_value
*array_obj
)
936 enum bt_value_status ret
;
937 struct bt_value
*empty_array_obj
= NULL
;
939 empty_array_obj
= bt_value_array_create();
940 ret
= bt_value_array_append(array_obj
, empty_array_obj
);
941 bt_put(empty_array_obj
);
945 enum bt_value_status
bt_value_array_append_empty_map(struct bt_value
*array_obj
)
947 enum bt_value_status ret
;
948 struct bt_value
*map_obj
= NULL
;
950 map_obj
= bt_value_map_create();
951 ret
= bt_value_array_append(array_obj
, map_obj
);
956 enum bt_value_status
bt_value_array_set(struct bt_value
*array_obj
,
957 uint64_t index
, struct bt_value
*element_obj
)
959 struct bt_value_array
*typed_array_obj
=
960 BT_VALUE_TO_ARRAY(array_obj
);
962 BT_ASSERT_PRE_NON_NULL(array_obj
, "Array value object");
963 BT_ASSERT_PRE_NON_NULL(element_obj
, "Element value object");
964 BT_ASSERT_PRE_VALUE_IS_TYPE(array_obj
, BT_VALUE_TYPE_ARRAY
);
965 BT_ASSERT_PRE_VALUE_HOT(array_obj
, "Array value object");
966 BT_ASSERT_PRE_VALUE_INDEX_IN_BOUNDS(index
,
967 typed_array_obj
->garray
->len
);
968 bt_put(g_ptr_array_index(typed_array_obj
->garray
, index
));
969 g_ptr_array_index(typed_array_obj
->garray
, index
) = element_obj
;
971 BT_LOGV("Set array value's element: array-value-addr=%p, "
972 "index=%" PRIu64
", element-value-addr=%p",
973 array_obj
, index
, element_obj
);
974 return BT_VALUE_STATUS_OK
;
977 int64_t bt_value_map_size(const struct bt_value
*map_obj
)
979 BT_ASSERT_PRE_NON_NULL(map_obj
, "Value object");
980 BT_ASSERT_PRE_VALUE_IS_TYPE(map_obj
, BT_VALUE_TYPE_MAP
);
981 return (int64_t) g_hash_table_size(BT_VALUE_TO_MAP(map_obj
)->ght
);
984 bt_bool
bt_value_map_is_empty(const struct bt_value
*map_obj
)
986 return bt_value_map_size(map_obj
) == 0;
989 struct bt_value
*bt_value_map_borrow(const struct bt_value
*map_obj
,
992 BT_ASSERT_PRE_NON_NULL(map_obj
, "Value object");
993 BT_ASSERT_PRE_NON_NULL(key
, "Key");
994 BT_ASSERT_PRE_VALUE_IS_TYPE(map_obj
, BT_VALUE_TYPE_MAP
);
995 return g_hash_table_lookup(BT_VALUE_TO_MAP(map_obj
)->ght
,
996 GUINT_TO_POINTER(g_quark_from_string(key
)));
999 bt_bool
bt_value_map_has_key(const struct bt_value
*map_obj
, const char *key
)
1001 BT_ASSERT_PRE_NON_NULL(map_obj
, "Value object");
1002 BT_ASSERT_PRE_NON_NULL(key
, "Key");
1003 BT_ASSERT_PRE_VALUE_IS_TYPE(map_obj
, BT_VALUE_TYPE_MAP
);
1004 return bt_g_hash_table_contains(BT_VALUE_TO_MAP(map_obj
)->ght
,
1005 GUINT_TO_POINTER(g_quark_from_string(key
)));
1008 enum bt_value_status
bt_value_map_insert(struct bt_value
*map_obj
,
1009 const char *key
, struct bt_value
*element_obj
)
1011 BT_ASSERT_PRE_NON_NULL(map_obj
, "Map value object");
1012 BT_ASSERT_PRE_NON_NULL(key
, "Key");
1013 BT_ASSERT_PRE_NON_NULL(element_obj
, "Element value object");
1014 BT_ASSERT_PRE_VALUE_IS_TYPE(map_obj
, BT_VALUE_TYPE_MAP
);
1015 BT_ASSERT_PRE_VALUE_HOT(map_obj
, "Map value object");
1016 g_hash_table_insert(BT_VALUE_TO_MAP(map_obj
)->ght
,
1017 GUINT_TO_POINTER(g_quark_from_string(key
)), element_obj
);
1018 bt_get(element_obj
);
1019 BT_LOGV("Inserted value into map value: map-value-addr=%p, "
1020 "key=\"%s\", element-value-addr=%p",
1021 map_obj
, key
, element_obj
);
1022 return BT_VALUE_STATUS_OK
;
1025 enum bt_value_status
bt_value_map_insert_bool(struct bt_value
*map_obj
,
1026 const char *key
, bt_bool val
)
1028 enum bt_value_status ret
;
1029 struct bt_value
*bool_obj
= NULL
;
1031 bool_obj
= bt_value_bool_create_init(val
);
1032 ret
= bt_value_map_insert(map_obj
, key
, bool_obj
);
1037 enum bt_value_status
bt_value_map_insert_integer(struct bt_value
*map_obj
,
1038 const char *key
, int64_t val
)
1040 enum bt_value_status ret
;
1041 struct bt_value
*integer_obj
= NULL
;
1043 integer_obj
= bt_value_integer_create_init(val
);
1044 ret
= bt_value_map_insert(map_obj
, key
, integer_obj
);
1045 bt_put(integer_obj
);
1049 enum bt_value_status
bt_value_map_insert_real(struct bt_value
*map_obj
,
1050 const char *key
, double val
)
1052 enum bt_value_status ret
;
1053 struct bt_value
*real_obj
= NULL
;
1055 real_obj
= bt_value_real_create_init(val
);
1056 ret
= bt_value_map_insert(map_obj
, key
, real_obj
);
1061 enum bt_value_status
bt_value_map_insert_string(struct bt_value
*map_obj
,
1062 const char *key
, const char *val
)
1064 enum bt_value_status ret
;
1065 struct bt_value
*string_obj
= NULL
;
1067 string_obj
= bt_value_string_create_init(val
);
1068 ret
= bt_value_map_insert(map_obj
, key
, string_obj
);
1073 enum bt_value_status
bt_value_map_insert_empty_array(struct bt_value
*map_obj
,
1076 enum bt_value_status ret
;
1077 struct bt_value
*array_obj
= NULL
;
1079 array_obj
= bt_value_array_create();
1080 ret
= bt_value_map_insert(map_obj
, key
, array_obj
);
1085 enum bt_value_status
bt_value_map_insert_empty_map(struct bt_value
*map_obj
,
1088 enum bt_value_status ret
;
1089 struct bt_value
*empty_map_obj
= NULL
;
1091 empty_map_obj
= bt_value_map_create();
1092 ret
= bt_value_map_insert(map_obj
, key
, empty_map_obj
);
1093 bt_put(empty_map_obj
);
1097 enum bt_value_status
bt_value_map_foreach(const struct bt_value
*map_obj
,
1098 bt_value_map_foreach_cb cb
, void *data
)
1100 enum bt_value_status ret
= BT_VALUE_STATUS_OK
;
1101 gpointer key
, element_obj
;
1102 GHashTableIter iter
;
1103 struct bt_value_map
*typed_map_obj
= BT_VALUE_TO_MAP(map_obj
);
1105 BT_ASSERT_PRE_NON_NULL(map_obj
, "Value object");
1106 BT_ASSERT_PRE_NON_NULL(cb
, "Callback");
1107 BT_ASSERT_PRE_VALUE_IS_TYPE(map_obj
, BT_VALUE_TYPE_MAP
);
1108 g_hash_table_iter_init(&iter
, typed_map_obj
->ght
);
1110 while (g_hash_table_iter_next(&iter
, &key
, &element_obj
)) {
1111 const char *key_str
= g_quark_to_string(GPOINTER_TO_UINT(key
));
1113 if (!cb(key_str
, element_obj
, data
)) {
1114 BT_LOGV("User canceled the loop: key=\"%s\", "
1115 "value-addr=%p, data=%p",
1116 key_str
, element_obj
, data
);
1117 ret
= BT_VALUE_STATUS_CANCELED
;
1125 struct extend_map_element_data
{
1126 struct bt_value
*extended_obj
;
1131 bt_bool
extend_map_element(const char *key
,
1132 struct bt_value
*extension_obj_elem
, void *data
)
1134 bt_bool ret
= BT_TRUE
;
1136 struct extend_map_element_data
*extend_data
= data
;
1138 /* Copy object which is to replace the current one */
1139 struct bt_value
*extension_obj_elem_copy
=
1140 bt_value_copy(extension_obj_elem
);
1142 /* Replace in extended object */
1143 if (bt_value_map_insert(extend_data
->extended_obj
, key
,
1144 extension_obj_elem_copy
)) {
1145 BT_LOGE("Cannot replace value in extended value: key=\"%s\", "
1146 "extended-value-addr=%p, element-value-addr=%p",
1147 key
, extend_data
->extended_obj
,
1148 extension_obj_elem_copy
);
1156 extend_data
->got_error
= BT_TRUE
;
1159 BT_PUT(extension_obj_elem_copy
);
1163 struct bt_value
*bt_value_map_extend(struct bt_value
*base_map_obj
,
1164 struct bt_value
*extension_obj
)
1166 struct bt_value
*extended_obj
= NULL
;
1167 struct extend_map_element_data extend_data
= { 0 };
1169 BT_ASSERT_PRE_NON_NULL(base_map_obj
, "Base value object");
1170 BT_ASSERT_PRE_NON_NULL(extension_obj
, "Extension value object");
1171 BT_ASSERT_PRE_VALUE_IS_TYPE(base_map_obj
, BT_VALUE_TYPE_MAP
);
1172 BT_ASSERT_PRE_VALUE_IS_TYPE(extension_obj
, BT_VALUE_TYPE_MAP
);
1173 BT_LOGD("Extending map value: base-value-addr=%p, extension-value-addr=%p",
1174 base_map_obj
, extension_obj
);
1176 /* Create copy of base map object to start with */
1177 extended_obj
= bt_value_copy(base_map_obj
);
1178 if (!extended_obj
) {
1179 BT_LOGE("Cannot copy base value: base-value-addr=%p",
1185 * For each key in the extension map object, replace this key
1186 * in the copied map object.
1188 extend_data
.extended_obj
= extended_obj
;
1190 if (bt_value_map_foreach(extension_obj
, extend_map_element
,
1192 BT_LOGE("Cannot iterate on the extension object's elements: "
1193 "extension-value-addr=%p", extension_obj
);
1197 if (extend_data
.got_error
) {
1198 BT_LOGE("Failed to successfully iterate on the extension object's elements: "
1199 "extension-value-addr=%p", extension_obj
);
1203 BT_LOGD("Extended map value: extended-value-addr=%p",
1208 BT_PUT(extended_obj
);
1211 return extended_obj
;
1214 struct bt_value
*bt_value_copy(const struct bt_value
*object
)
1216 struct bt_value
*copy_obj
= NULL
;
1218 BT_ASSERT_PRE_NON_NULL(object
, "Value object");
1219 BT_LOGD("Copying value object: addr=%p", object
);
1220 copy_obj
= copy_funcs
[object
->type
](object
);
1222 BT_LOGD("Copied value object: copy-value-addr=%p",
1225 BT_LOGE_STR("Failed to copy value object.");
1231 bt_bool
bt_value_compare(const struct bt_value
*object_a
,
1232 const struct bt_value
*object_b
)
1234 bt_bool ret
= BT_FALSE
;
1236 BT_ASSERT_PRE_NON_NULL(object_a
, "Value object A");
1237 BT_ASSERT_PRE_NON_NULL(object_b
, "Value object B");
1239 if (object_a
->type
!= object_b
->type
) {
1240 BT_LOGV("Values are different: type mismatch: "
1241 "value-a-addr=%p, value-b-addr=%p, "
1242 "value-a-type=%s, value-b-type=%s",
1244 bt_value_type_string(object_a
->type
),
1245 bt_value_type_string(object_b
->type
));
1249 ret
= compare_funcs
[object_a
->type
](object_a
, object_b
);