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_FLOAT(_base) ((struct bt_value_float *) (_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 struct bt_value bt_value_null_instance
= {
84 .type
= BT_VALUE_TYPE_NULL
,
88 struct bt_value
*bt_value_null
= &bt_value_null_instance
;
90 struct bt_value_bool
{
95 struct bt_value_integer
{
100 struct bt_value_float
{
101 struct bt_value base
;
105 struct bt_value_string
{
106 struct bt_value base
;
110 struct bt_value_array
{
111 struct bt_value base
;
115 struct bt_value_map
{
116 struct bt_value base
;
121 void bt_value_destroy(struct bt_object
*obj
);
124 void bt_value_string_destroy(struct bt_value
*object
)
126 g_string_free(BT_VALUE_TO_STRING(object
)->gstr
, TRUE
);
130 void bt_value_array_destroy(struct bt_value
*object
)
133 * Pointer array's registered value destructor will take care
134 * of putting each contained object.
136 g_ptr_array_free(BT_VALUE_TO_ARRAY(object
)->garray
, TRUE
);
140 void bt_value_map_destroy(struct bt_value
*object
)
143 * Hash table's registered value destructor will take care of
144 * putting each contained object. Keys are GQuarks and cannot
145 * be destroyed anyway.
147 g_hash_table_destroy(BT_VALUE_TO_MAP(object
)->ght
);
151 void (* const destroy_funcs
[])(struct bt_value
*) = {
152 [BT_VALUE_TYPE_NULL
] = NULL
,
153 [BT_VALUE_TYPE_BOOL
] = NULL
,
154 [BT_VALUE_TYPE_INTEGER
] = NULL
,
155 [BT_VALUE_TYPE_FLOAT
] = NULL
,
156 [BT_VALUE_TYPE_STRING
] = bt_value_string_destroy
,
157 [BT_VALUE_TYPE_ARRAY
] = bt_value_array_destroy
,
158 [BT_VALUE_TYPE_MAP
] = bt_value_map_destroy
,
162 struct bt_value
*bt_value_null_copy(const struct bt_value
*null_obj
)
164 return bt_value_null
;
168 struct bt_value
*bt_value_bool_copy(const struct bt_value
*bool_obj
)
170 return bt_value_bool_create_init(BT_VALUE_TO_BOOL(bool_obj
)->value
);
174 struct bt_value
*bt_value_integer_copy(const struct bt_value
*integer_obj
)
176 return bt_value_integer_create_init(
177 BT_VALUE_TO_INTEGER(integer_obj
)->value
);
181 struct bt_value
*bt_value_float_copy(const struct bt_value
*float_obj
)
183 return bt_value_float_create_init(
184 BT_VALUE_TO_FLOAT(float_obj
)->value
);
188 struct bt_value
*bt_value_string_copy(const struct bt_value
*string_obj
)
190 return bt_value_string_create_init(
191 BT_VALUE_TO_STRING(string_obj
)->gstr
->str
);
195 struct bt_value
*bt_value_array_copy(const struct bt_value
*array_obj
)
199 struct bt_value
*copy_obj
;
200 struct bt_value_array
*typed_array_obj
;
202 BT_LOGD("Copying array value: addr=%p", array_obj
);
203 typed_array_obj
= BT_VALUE_TO_ARRAY(array_obj
);
204 copy_obj
= bt_value_array_create();
206 BT_LOGE_STR("Cannot create empty array value.");
210 for (i
= 0; i
< typed_array_obj
->garray
->len
; ++i
) {
211 struct bt_value
*element_obj_copy
;
212 struct bt_value
*element_obj
= bt_value_array_borrow(
215 BT_ASSERT(element_obj
);
216 BT_LOGD("Copying array value's element: element-addr=%p, "
217 "index=%d", element_obj
, i
);
218 element_obj_copy
= bt_value_copy(element_obj
);
219 if (!element_obj_copy
) {
220 BT_LOGE("Cannot copy array value's element: "
221 "array-addr=%p, index=%d",
227 ret
= bt_value_array_append(copy_obj
, element_obj_copy
);
228 BT_PUT(element_obj_copy
);
230 BT_LOGE("Cannot append to array value: addr=%p",
237 BT_LOGD("Copied array value: original-addr=%p, copy-addr=%p",
238 array_obj
, copy_obj
);
245 struct bt_value
*bt_value_map_copy(const struct bt_value
*map_obj
)
249 gpointer key
, element_obj
;
250 struct bt_value
*copy_obj
;
251 struct bt_value
*element_obj_copy
;
252 struct bt_value_map
*typed_map_obj
;
254 BT_LOGD("Copying map value: addr=%p", map_obj
);
255 typed_map_obj
= BT_VALUE_TO_MAP(map_obj
);
256 copy_obj
= bt_value_map_create();
261 g_hash_table_iter_init(&iter
, typed_map_obj
->ght
);
263 while (g_hash_table_iter_next(&iter
, &key
, &element_obj
)) {
264 const char *key_str
= g_quark_to_string(GPOINTER_TO_UINT(key
));
267 BT_LOGD("Copying map value's element: element-addr=%p, "
268 "key=\"%s\"", element_obj
, key_str
);
269 element_obj_copy
= bt_value_copy(element_obj
);
270 if (!element_obj_copy
) {
271 BT_LOGE("Cannot copy map value's element: "
272 "map-addr=%p, key=\"%s\"",
278 ret
= bt_value_map_insert(copy_obj
, key_str
, element_obj_copy
);
279 BT_PUT(element_obj_copy
);
281 BT_LOGE("Cannot insert into map value: addr=%p, key=\"%s\"",
288 BT_LOGD("Copied map value: addr=%p", map_obj
);
295 struct bt_value
*(* const copy_funcs
[])(const struct bt_value
*) = {
296 [BT_VALUE_TYPE_NULL
] = bt_value_null_copy
,
297 [BT_VALUE_TYPE_BOOL
] = bt_value_bool_copy
,
298 [BT_VALUE_TYPE_INTEGER
] = bt_value_integer_copy
,
299 [BT_VALUE_TYPE_FLOAT
] = bt_value_float_copy
,
300 [BT_VALUE_TYPE_STRING
] = bt_value_string_copy
,
301 [BT_VALUE_TYPE_ARRAY
] = bt_value_array_copy
,
302 [BT_VALUE_TYPE_MAP
] = bt_value_map_copy
,
306 bt_bool
bt_value_null_compare(const struct bt_value
*object_a
,
307 const struct bt_value
*object_b
)
310 * Always BT_TRUE since bt_value_compare() already checks if both
311 * object_a and object_b have the same type, and in the case of
312 * null value objects, they're always the same if it is so.
318 bt_bool
bt_value_bool_compare(const struct bt_value
*object_a
,
319 const struct bt_value
*object_b
)
321 if (BT_VALUE_TO_BOOL(object_a
)->value
!=
322 BT_VALUE_TO_BOOL(object_b
)->value
) {
323 BT_LOGV("Boolean value objects are different: "
324 "bool-a-val=%d, bool-b-val=%d",
325 BT_VALUE_TO_BOOL(object_a
)->value
,
326 BT_VALUE_TO_BOOL(object_b
)->value
);
334 bt_bool
bt_value_integer_compare(const struct bt_value
*object_a
,
335 const struct bt_value
*object_b
)
337 if (BT_VALUE_TO_INTEGER(object_a
)->value
!=
338 BT_VALUE_TO_INTEGER(object_b
)->value
) {
339 BT_LOGV("Integer value objects are different: "
340 "int-a-val=%" PRId64
", int-b-val=%" PRId64
,
341 BT_VALUE_TO_INTEGER(object_a
)->value
,
342 BT_VALUE_TO_INTEGER(object_b
)->value
);
350 bt_bool
bt_value_float_compare(const struct bt_value
*object_a
,
351 const struct bt_value
*object_b
)
353 if (BT_VALUE_TO_FLOAT(object_a
)->value
!=
354 BT_VALUE_TO_FLOAT(object_b
)->value
) {
355 BT_LOGV("Floating point number value objects are different: "
356 "float-a-val=%f, float-b-val=%f",
357 BT_VALUE_TO_FLOAT(object_a
)->value
,
358 BT_VALUE_TO_FLOAT(object_b
)->value
);
366 bt_bool
bt_value_string_compare(const struct bt_value
*object_a
,
367 const struct bt_value
*object_b
)
369 if (strcmp(BT_VALUE_TO_STRING(object_a
)->gstr
->str
,
370 BT_VALUE_TO_STRING(object_b
)->gstr
->str
) != 0) {
371 BT_LOGV("String value objects are different: "
372 "string-a-val=\"%s\", string-b-val=\"%s\"",
373 BT_VALUE_TO_STRING(object_a
)->gstr
->str
,
374 BT_VALUE_TO_STRING(object_b
)->gstr
->str
);
382 bt_bool
bt_value_array_compare(const struct bt_value
*object_a
,
383 const struct bt_value
*object_b
)
386 bt_bool ret
= BT_TRUE
;
387 const struct bt_value_array
*array_obj_a
=
388 BT_VALUE_TO_ARRAY(object_a
);
390 if (bt_value_array_size(object_a
) != bt_value_array_size(object_b
)) {
391 BT_LOGV("Array values are different: size mismatch "
392 "value-a-addr=%p, value-b-addr=%p, "
393 "value-a-size=%" PRId64
", value-b-size=%" PRId64
,
395 bt_value_array_size(object_a
),
396 bt_value_array_size(object_b
));
401 for (i
= 0; i
< array_obj_a
->garray
->len
; ++i
) {
402 struct bt_value
*element_obj_a
;
403 struct bt_value
*element_obj_b
;
405 element_obj_a
= bt_value_array_borrow(object_a
, i
);
406 element_obj_b
= bt_value_array_borrow(object_b
, i
);
408 if (!bt_value_compare(element_obj_a
, element_obj_b
)) {
409 BT_LOGV("Array values's elements are different: "
410 "value-a-addr=%p, value-b-addr=%p, index=%d",
411 element_obj_a
, element_obj_b
, i
);
422 bt_bool
bt_value_map_compare(const struct bt_value
*object_a
,
423 const struct bt_value
*object_b
)
425 bt_bool ret
= BT_TRUE
;
427 gpointer key
, element_obj_a
;
428 const struct bt_value_map
*map_obj_a
= BT_VALUE_TO_MAP(object_a
);
430 if (bt_value_map_size(object_a
) != bt_value_map_size(object_b
)) {
431 BT_LOGV("Map values are different: size mismatch "
432 "value-a-addr=%p, value-b-addr=%p, "
433 "value-a-size=%" PRId64
", value-b-size=%" PRId64
,
435 bt_value_map_size(object_a
),
436 bt_value_map_size(object_b
));
441 g_hash_table_iter_init(&iter
, map_obj_a
->ght
);
443 while (g_hash_table_iter_next(&iter
, &key
, &element_obj_a
)) {
444 struct bt_value
*element_obj_b
;
445 const char *key_str
= g_quark_to_string(GPOINTER_TO_UINT(key
));
447 element_obj_b
= bt_value_map_borrow(object_b
, key_str
);
449 if (!bt_value_compare(element_obj_a
, element_obj_b
)) {
450 BT_LOGV("Map values's elements are different: "
451 "value-a-addr=%p, value-b-addr=%p, key=\"%s\"",
452 element_obj_a
, element_obj_b
, key_str
);
463 bt_bool (* const compare_funcs
[])(const struct bt_value
*,
464 const struct bt_value
*) = {
465 [BT_VALUE_TYPE_NULL
] = bt_value_null_compare
,
466 [BT_VALUE_TYPE_BOOL
] = bt_value_bool_compare
,
467 [BT_VALUE_TYPE_INTEGER
] = bt_value_integer_compare
,
468 [BT_VALUE_TYPE_FLOAT
] = bt_value_float_compare
,
469 [BT_VALUE_TYPE_STRING
] = bt_value_string_compare
,
470 [BT_VALUE_TYPE_ARRAY
] = bt_value_array_compare
,
471 [BT_VALUE_TYPE_MAP
] = bt_value_map_compare
,
475 void bt_value_null_freeze(struct bt_value
*object
)
480 void bt_value_generic_freeze(struct bt_value
*object
)
482 object
->frozen
= BT_TRUE
;
486 void bt_value_array_freeze(struct bt_value
*object
)
489 struct bt_value_array
*typed_array_obj
=
490 BT_VALUE_TO_ARRAY(object
);
492 for (i
= 0; i
< typed_array_obj
->garray
->len
; ++i
) {
493 bt_value_freeze(g_ptr_array_index(typed_array_obj
->garray
, i
));
496 bt_value_generic_freeze(object
);
500 void bt_value_map_freeze(struct bt_value
*object
)
503 gpointer key
, element_obj
;
504 const struct bt_value_map
*map_obj
= BT_VALUE_TO_MAP(object
);
506 g_hash_table_iter_init(&iter
, map_obj
->ght
);
508 while (g_hash_table_iter_next(&iter
, &key
, &element_obj
)) {
509 bt_value_freeze(element_obj
);
512 bt_value_generic_freeze(object
);
516 void (* const freeze_funcs
[])(struct bt_value
*) = {
517 [BT_VALUE_TYPE_NULL
] = bt_value_null_freeze
,
518 [BT_VALUE_TYPE_BOOL
] = bt_value_generic_freeze
,
519 [BT_VALUE_TYPE_INTEGER
] = bt_value_generic_freeze
,
520 [BT_VALUE_TYPE_FLOAT
] = bt_value_generic_freeze
,
521 [BT_VALUE_TYPE_STRING
] = bt_value_generic_freeze
,
522 [BT_VALUE_TYPE_ARRAY
] = bt_value_array_freeze
,
523 [BT_VALUE_TYPE_MAP
] = bt_value_map_freeze
,
527 void bt_value_destroy(struct bt_object
*obj
)
529 struct bt_value
*value
;
531 value
= container_of(obj
, struct bt_value
, base
);
532 BT_ASSERT(value
->type
!= BT_VALUE_TYPE_UNKNOWN
);
533 BT_LOGD("Destroying value: addr=%p", value
);
535 if (bt_value_is_null(value
)) {
536 BT_LOGD_STR("Not destroying the null value singleton.");
540 if (destroy_funcs
[value
->type
]) {
541 destroy_funcs
[value
->type
](value
);
548 enum bt_value_status
_bt_value_freeze(struct bt_value
*object
)
550 enum bt_value_status ret
= BT_VALUE_STATUS_OK
;
554 if (object
->frozen
) {
558 BT_LOGD("Freezing value: addr=%p", object
);
559 freeze_funcs
[object
->type
](object
);
565 enum bt_value_type
bt_value_get_type(const struct bt_value
*object
)
567 BT_ASSERT_PRE_NON_NULL(object
, "Value object");
572 struct bt_value
bt_value_create_base(enum bt_value_type type
)
574 struct bt_value base
;
577 base
.frozen
= BT_FALSE
;
578 bt_object_init(&base
, bt_value_destroy
);
582 struct bt_value
*bt_value_bool_create_init(bt_bool val
)
584 struct bt_value_bool
*bool_obj
;
586 BT_LOGD("Creating boolean value object: val=%d", val
);
587 bool_obj
= g_new0(struct bt_value_bool
, 1);
589 BT_LOGE_STR("Failed to allocate one boolean value object.");
593 bool_obj
->base
= bt_value_create_base(BT_VALUE_TYPE_BOOL
);
594 bool_obj
->value
= val
;
595 BT_LOGD("Created boolean value object: addr=%p", bool_obj
);
598 return BT_VALUE_FROM_CONCRETE(bool_obj
);
601 struct bt_value
*bt_value_bool_create(void)
603 return bt_value_bool_create_init(BT_FALSE
);
606 struct bt_value
*bt_value_integer_create_init(int64_t val
)
608 struct bt_value_integer
*integer_obj
;
610 BT_LOGD("Creating integer value object: val=%" PRId64
, val
);
611 integer_obj
= g_new0(struct bt_value_integer
, 1);
613 BT_LOGE_STR("Failed to allocate one integer value object.");
617 integer_obj
->base
= bt_value_create_base(BT_VALUE_TYPE_INTEGER
);
618 integer_obj
->value
= val
;
619 BT_LOGD("Created integer value object: addr=%p",
623 return BT_VALUE_FROM_CONCRETE(integer_obj
);
626 struct bt_value
*bt_value_integer_create(void)
628 return bt_value_integer_create_init(0);
631 struct bt_value
*bt_value_float_create_init(double val
)
633 struct bt_value_float
*float_obj
;
635 BT_LOGD("Creating floating point number value object: val=%f", val
);
636 float_obj
= g_new0(struct bt_value_float
, 1);
638 BT_LOGE_STR("Failed to allocate one floating point number value object.");
642 float_obj
->base
= bt_value_create_base(BT_VALUE_TYPE_FLOAT
);
643 float_obj
->value
= val
;
644 BT_LOGD("Created floating point number value object: addr=%p",
648 return BT_VALUE_FROM_CONCRETE(float_obj
);
651 struct bt_value
*bt_value_float_create(void)
653 return bt_value_float_create_init(0.);
656 struct bt_value
*bt_value_string_create_init(const char *val
)
658 struct bt_value_string
*string_obj
= NULL
;
661 BT_LOGW_STR("Invalid parameter: value is NULL.");
665 BT_LOGD("Creating string value object: val-len=%zu", strlen(val
));
666 string_obj
= g_new0(struct bt_value_string
, 1);
668 BT_LOGE_STR("Failed to allocate one string object.");
672 string_obj
->base
= bt_value_create_base(BT_VALUE_TYPE_STRING
);
673 string_obj
->gstr
= g_string_new(val
);
674 if (!string_obj
->gstr
) {
675 BT_LOGE_STR("Failed to allocate a GString.");
681 BT_LOGD("Created string value object: addr=%p",
685 return BT_VALUE_FROM_CONCRETE(string_obj
);
688 struct bt_value
*bt_value_string_create(void)
690 return bt_value_string_create_init("");
693 struct bt_value
*bt_value_array_create(void)
695 struct bt_value_array
*array_obj
;
697 BT_LOGD_STR("Creating empty array value object.");
698 array_obj
= g_new0(struct bt_value_array
, 1);
700 BT_LOGE_STR("Failed to allocate one array object.");
704 array_obj
->base
= bt_value_create_base(BT_VALUE_TYPE_ARRAY
);
705 array_obj
->garray
= bt_g_ptr_array_new_full(0,
706 (GDestroyNotify
) bt_put
);
707 if (!array_obj
->garray
) {
708 BT_LOGE_STR("Failed to allocate a GPtrArray.");
714 BT_LOGD("Created array value object: addr=%p",
718 return BT_VALUE_FROM_CONCRETE(array_obj
);
721 struct bt_value
*bt_value_map_create(void)
723 struct bt_value_map
*map_obj
;
725 BT_LOGD_STR("Creating empty map value object.");
726 map_obj
= g_new0(struct bt_value_map
, 1);
728 BT_LOGE_STR("Failed to allocate one map object.");
732 map_obj
->base
= bt_value_create_base(BT_VALUE_TYPE_MAP
);
733 map_obj
->ght
= g_hash_table_new_full(g_direct_hash
, g_direct_equal
,
734 NULL
, (GDestroyNotify
) bt_put
);
736 BT_LOGE_STR("Failed to allocate a GHashTable.");
742 BT_LOGD("Created map value object: addr=%p",
746 return BT_VALUE_FROM_CONCRETE(map_obj
);
749 enum bt_value_status
bt_value_bool_get(const struct bt_value
*bool_obj
,
752 BT_ASSERT_PRE_NON_NULL(bool_obj
, "Value object");
753 BT_ASSERT_PRE_NON_NULL(val
, "Raw value");
754 BT_ASSERT_PRE_VALUE_IS_TYPE(bool_obj
, BT_VALUE_TYPE_BOOL
);
755 *val
= BT_VALUE_TO_BOOL(bool_obj
)->value
;
756 return BT_VALUE_STATUS_OK
;
759 enum bt_value_status
bt_value_bool_set(struct bt_value
*bool_obj
, bt_bool val
)
761 BT_ASSERT_PRE_NON_NULL(bool_obj
, "Value object");
762 BT_ASSERT_PRE_VALUE_IS_TYPE(bool_obj
, BT_VALUE_TYPE_BOOL
);
763 BT_ASSERT_PRE_VALUE_HOT(bool_obj
, "Value object");
764 BT_VALUE_TO_BOOL(bool_obj
)->value
= val
;
765 BT_LOGV("Set boolean value's raw value: value-addr=%p, value=%d",
767 return BT_VALUE_STATUS_OK
;
770 enum bt_value_status
bt_value_integer_get(const struct bt_value
*integer_obj
,
773 BT_ASSERT_PRE_NON_NULL(integer_obj
, "Value object");
774 BT_ASSERT_PRE_NON_NULL(val
, "Raw value");
775 BT_ASSERT_PRE_VALUE_IS_TYPE(integer_obj
, BT_VALUE_TYPE_INTEGER
);
776 *val
= BT_VALUE_TO_INTEGER(integer_obj
)->value
;
777 return BT_VALUE_STATUS_OK
;
780 enum bt_value_status
bt_value_integer_set(struct bt_value
*integer_obj
,
783 BT_ASSERT_PRE_NON_NULL(integer_obj
, "Value object");
784 BT_ASSERT_PRE_VALUE_IS_TYPE(integer_obj
, BT_VALUE_TYPE_INTEGER
);
785 BT_ASSERT_PRE_VALUE_HOT(integer_obj
, "Value object");
786 BT_VALUE_TO_INTEGER(integer_obj
)->value
= val
;
787 BT_LOGV("Set integer value's raw value: value-addr=%p, value=%" PRId64
,
789 return BT_VALUE_STATUS_OK
;
792 enum bt_value_status
bt_value_float_get(const struct bt_value
*float_obj
,
795 BT_ASSERT_PRE_NON_NULL(float_obj
, "Value object");
796 BT_ASSERT_PRE_NON_NULL(val
, "Raw value");
797 BT_ASSERT_PRE_VALUE_IS_TYPE(float_obj
, BT_VALUE_TYPE_FLOAT
);
798 *val
= BT_VALUE_TO_FLOAT(float_obj
)->value
;
799 return BT_VALUE_STATUS_OK
;
802 enum bt_value_status
bt_value_float_set(struct bt_value
*float_obj
,
805 BT_ASSERT_PRE_NON_NULL(float_obj
, "Value object");
806 BT_ASSERT_PRE_VALUE_IS_TYPE(float_obj
, BT_VALUE_TYPE_FLOAT
);
807 BT_ASSERT_PRE_VALUE_HOT(float_obj
, "Value object");
808 BT_VALUE_TO_FLOAT(float_obj
)->value
= val
;
809 BT_LOGV("Set floating point number value's raw value: value-addr=%p, value=%f",
811 return BT_VALUE_STATUS_OK
;
814 enum bt_value_status
bt_value_string_get(const struct bt_value
*string_obj
,
817 BT_ASSERT_PRE_NON_NULL(string_obj
, "Value object");
818 BT_ASSERT_PRE_NON_NULL(val
, "Raw value");
819 BT_ASSERT_PRE_VALUE_IS_TYPE(string_obj
, BT_VALUE_TYPE_STRING
);
820 *val
= BT_VALUE_TO_STRING(string_obj
)->gstr
->str
;
821 return BT_VALUE_STATUS_OK
;
824 enum bt_value_status
bt_value_string_set(struct bt_value
*string_obj
,
827 BT_ASSERT_PRE_NON_NULL(string_obj
, "Value object");
828 BT_ASSERT_PRE_NON_NULL(val
, "Raw value");
829 BT_ASSERT_PRE_VALUE_IS_TYPE(string_obj
, BT_VALUE_TYPE_STRING
);
830 BT_ASSERT_PRE_VALUE_HOT(string_obj
, "Value object");
831 g_string_assign(BT_VALUE_TO_STRING(string_obj
)->gstr
, val
);
832 BT_LOGV("Set string value's raw value: value-addr=%p, raw-value-addr=%p",
834 return BT_VALUE_STATUS_OK
;
837 int64_t bt_value_array_size(const struct bt_value
*array_obj
)
839 BT_ASSERT_PRE_NON_NULL(array_obj
, "Value object");
840 BT_ASSERT_PRE_VALUE_IS_TYPE(array_obj
, BT_VALUE_TYPE_ARRAY
);
841 return (int64_t) BT_VALUE_TO_ARRAY(array_obj
)->garray
->len
;
844 bt_bool
bt_value_array_is_empty(const struct bt_value
*array_obj
)
846 return bt_value_array_size(array_obj
) == 0;
849 struct bt_value
*bt_value_array_borrow(const struct bt_value
*array_obj
,
852 struct bt_value_array
*typed_array_obj
=
853 BT_VALUE_TO_ARRAY(array_obj
);
855 BT_ASSERT_PRE_NON_NULL(array_obj
, "Value object");
856 BT_ASSERT_PRE_VALUE_IS_TYPE(array_obj
, BT_VALUE_TYPE_ARRAY
);
857 BT_ASSERT_PRE_VALUE_INDEX_IN_BOUNDS(index
,
858 typed_array_obj
->garray
->len
);
859 return g_ptr_array_index(typed_array_obj
->garray
, index
);
862 enum bt_value_status
bt_value_array_append(struct bt_value
*array_obj
,
863 struct bt_value
*element_obj
)
865 struct bt_value_array
*typed_array_obj
=
866 BT_VALUE_TO_ARRAY(array_obj
);
868 BT_ASSERT_PRE_NON_NULL(array_obj
, "Array value object");
869 BT_ASSERT_PRE_NON_NULL(element_obj
, "Element value object");
870 BT_ASSERT_PRE_VALUE_IS_TYPE(array_obj
, BT_VALUE_TYPE_ARRAY
);
871 BT_ASSERT_PRE_VALUE_HOT(array_obj
, "Array value object");
872 g_ptr_array_add(typed_array_obj
->garray
, element_obj
);
874 BT_LOGV("Appended element to array value: array-value-addr=%p, "
875 "element-value-addr=%p, new-size=%u",
876 array_obj
, element_obj
, typed_array_obj
->garray
->len
);
877 return BT_VALUE_STATUS_OK
;
880 enum bt_value_status
bt_value_array_append_bool(struct bt_value
*array_obj
,
883 enum bt_value_status ret
;
884 struct bt_value
*bool_obj
= NULL
;
886 bool_obj
= bt_value_bool_create_init(val
);
887 ret
= bt_value_array_append(array_obj
, bool_obj
);
892 enum bt_value_status
bt_value_array_append_integer(
893 struct bt_value
*array_obj
, int64_t val
)
895 enum bt_value_status ret
;
896 struct bt_value
*integer_obj
= NULL
;
898 integer_obj
= bt_value_integer_create_init(val
);
899 ret
= bt_value_array_append(array_obj
, integer_obj
);
904 enum bt_value_status
bt_value_array_append_float(struct bt_value
*array_obj
,
907 enum bt_value_status ret
;
908 struct bt_value
*float_obj
= NULL
;
910 float_obj
= bt_value_float_create_init(val
);
911 ret
= bt_value_array_append(array_obj
, float_obj
);
916 enum bt_value_status
bt_value_array_append_string(struct bt_value
*array_obj
,
919 enum bt_value_status ret
;
920 struct bt_value
*string_obj
= NULL
;
922 string_obj
= bt_value_string_create_init(val
);
923 ret
= bt_value_array_append(array_obj
, string_obj
);
928 enum bt_value_status
bt_value_array_append_empty_array(
929 struct bt_value
*array_obj
)
931 enum bt_value_status ret
;
932 struct bt_value
*empty_array_obj
= NULL
;
934 empty_array_obj
= bt_value_array_create();
935 ret
= bt_value_array_append(array_obj
, empty_array_obj
);
936 bt_put(empty_array_obj
);
940 enum bt_value_status
bt_value_array_append_empty_map(struct bt_value
*array_obj
)
942 enum bt_value_status ret
;
943 struct bt_value
*map_obj
= NULL
;
945 map_obj
= bt_value_map_create();
946 ret
= bt_value_array_append(array_obj
, map_obj
);
951 enum bt_value_status
bt_value_array_set(struct bt_value
*array_obj
,
952 uint64_t index
, struct bt_value
*element_obj
)
954 struct bt_value_array
*typed_array_obj
=
955 BT_VALUE_TO_ARRAY(array_obj
);
957 BT_ASSERT_PRE_NON_NULL(array_obj
, "Array value object");
958 BT_ASSERT_PRE_NON_NULL(element_obj
, "Element value object");
959 BT_ASSERT_PRE_VALUE_IS_TYPE(array_obj
, BT_VALUE_TYPE_ARRAY
);
960 BT_ASSERT_PRE_VALUE_HOT(array_obj
, "Array value object");
961 BT_ASSERT_PRE_VALUE_INDEX_IN_BOUNDS(index
,
962 typed_array_obj
->garray
->len
);
963 bt_put(g_ptr_array_index(typed_array_obj
->garray
, index
));
964 g_ptr_array_index(typed_array_obj
->garray
, index
) = element_obj
;
966 BT_LOGV("Set array value's element: array-value-addr=%p, "
967 "index=%" PRIu64
", element-value-addr=%p",
968 array_obj
, index
, element_obj
);
969 return BT_VALUE_STATUS_OK
;
972 int64_t bt_value_map_size(const struct bt_value
*map_obj
)
974 BT_ASSERT_PRE_NON_NULL(map_obj
, "Value object");
975 BT_ASSERT_PRE_VALUE_IS_TYPE(map_obj
, BT_VALUE_TYPE_MAP
);
976 return (int64_t) g_hash_table_size(BT_VALUE_TO_MAP(map_obj
)->ght
);
979 bt_bool
bt_value_map_is_empty(const struct bt_value
*map_obj
)
981 return bt_value_map_size(map_obj
) == 0;
984 struct bt_value
*bt_value_map_borrow(const struct bt_value
*map_obj
,
987 BT_ASSERT_PRE_NON_NULL(map_obj
, "Value object");
988 BT_ASSERT_PRE_NON_NULL(key
, "Key");
989 BT_ASSERT_PRE_VALUE_IS_TYPE(map_obj
, BT_VALUE_TYPE_MAP
);
990 return g_hash_table_lookup(BT_VALUE_TO_MAP(map_obj
)->ght
,
991 GUINT_TO_POINTER(g_quark_from_string(key
)));
994 bt_bool
bt_value_map_has_key(const struct bt_value
*map_obj
, const char *key
)
996 BT_ASSERT_PRE_NON_NULL(map_obj
, "Value object");
997 BT_ASSERT_PRE_NON_NULL(key
, "Key");
998 BT_ASSERT_PRE_VALUE_IS_TYPE(map_obj
, BT_VALUE_TYPE_MAP
);
999 return bt_g_hash_table_contains(BT_VALUE_TO_MAP(map_obj
)->ght
,
1000 GUINT_TO_POINTER(g_quark_from_string(key
)));
1003 enum bt_value_status
bt_value_map_insert(struct bt_value
*map_obj
,
1004 const char *key
, struct bt_value
*element_obj
)
1006 BT_ASSERT_PRE_NON_NULL(map_obj
, "Map value object");
1007 BT_ASSERT_PRE_NON_NULL(key
, "Key");
1008 BT_ASSERT_PRE_NON_NULL(element_obj
, "Element value object");
1009 BT_ASSERT_PRE_VALUE_IS_TYPE(map_obj
, BT_VALUE_TYPE_MAP
);
1010 BT_ASSERT_PRE_VALUE_HOT(map_obj
, "Map value object");
1011 g_hash_table_insert(BT_VALUE_TO_MAP(map_obj
)->ght
,
1012 GUINT_TO_POINTER(g_quark_from_string(key
)), element_obj
);
1013 bt_get(element_obj
);
1014 BT_LOGV("Inserted value into map value: map-value-addr=%p, "
1015 "key=\"%s\", element-value-addr=%p",
1016 map_obj
, key
, element_obj
);
1017 return BT_VALUE_STATUS_OK
;
1020 enum bt_value_status
bt_value_map_insert_bool(struct bt_value
*map_obj
,
1021 const char *key
, bt_bool val
)
1023 enum bt_value_status ret
;
1024 struct bt_value
*bool_obj
= NULL
;
1026 bool_obj
= bt_value_bool_create_init(val
);
1027 ret
= bt_value_map_insert(map_obj
, key
, bool_obj
);
1032 enum bt_value_status
bt_value_map_insert_integer(struct bt_value
*map_obj
,
1033 const char *key
, int64_t val
)
1035 enum bt_value_status ret
;
1036 struct bt_value
*integer_obj
= NULL
;
1038 integer_obj
= bt_value_integer_create_init(val
);
1039 ret
= bt_value_map_insert(map_obj
, key
, integer_obj
);
1040 bt_put(integer_obj
);
1044 enum bt_value_status
bt_value_map_insert_float(struct bt_value
*map_obj
,
1045 const char *key
, double val
)
1047 enum bt_value_status ret
;
1048 struct bt_value
*float_obj
= NULL
;
1050 float_obj
= bt_value_float_create_init(val
);
1051 ret
= bt_value_map_insert(map_obj
, key
, float_obj
);
1056 enum bt_value_status
bt_value_map_insert_string(struct bt_value
*map_obj
,
1057 const char *key
, const char *val
)
1059 enum bt_value_status ret
;
1060 struct bt_value
*string_obj
= NULL
;
1062 string_obj
= bt_value_string_create_init(val
);
1063 ret
= bt_value_map_insert(map_obj
, key
, string_obj
);
1068 enum bt_value_status
bt_value_map_insert_empty_array(struct bt_value
*map_obj
,
1071 enum bt_value_status ret
;
1072 struct bt_value
*array_obj
= NULL
;
1074 array_obj
= bt_value_array_create();
1075 ret
= bt_value_map_insert(map_obj
, key
, array_obj
);
1080 enum bt_value_status
bt_value_map_insert_empty_map(struct bt_value
*map_obj
,
1083 enum bt_value_status ret
;
1084 struct bt_value
*empty_map_obj
= NULL
;
1086 empty_map_obj
= bt_value_map_create();
1087 ret
= bt_value_map_insert(map_obj
, key
, empty_map_obj
);
1088 bt_put(empty_map_obj
);
1092 enum bt_value_status
bt_value_map_foreach(const struct bt_value
*map_obj
,
1093 bt_value_map_foreach_cb cb
, void *data
)
1095 enum bt_value_status ret
= BT_VALUE_STATUS_OK
;
1096 gpointer key
, element_obj
;
1097 GHashTableIter iter
;
1098 struct bt_value_map
*typed_map_obj
= BT_VALUE_TO_MAP(map_obj
);
1100 BT_ASSERT_PRE_NON_NULL(map_obj
, "Value object");
1101 BT_ASSERT_PRE_NON_NULL(cb
, "Callback");
1102 BT_ASSERT_PRE_VALUE_IS_TYPE(map_obj
, BT_VALUE_TYPE_MAP
);
1103 g_hash_table_iter_init(&iter
, typed_map_obj
->ght
);
1105 while (g_hash_table_iter_next(&iter
, &key
, &element_obj
)) {
1106 const char *key_str
= g_quark_to_string(GPOINTER_TO_UINT(key
));
1108 if (!cb(key_str
, element_obj
, data
)) {
1109 BT_LOGV("User canceled the loop: key=\"%s\", "
1110 "value-addr=%p, data=%p",
1111 key_str
, element_obj
, data
);
1112 ret
= BT_VALUE_STATUS_CANCELED
;
1120 struct extend_map_element_data
{
1121 struct bt_value
*extended_obj
;
1126 bt_bool
extend_map_element(const char *key
,
1127 struct bt_value
*extension_obj_elem
, void *data
)
1129 bt_bool ret
= BT_TRUE
;
1131 struct extend_map_element_data
*extend_data
= data
;
1133 /* Copy object which is to replace the current one */
1134 struct bt_value
*extension_obj_elem_copy
=
1135 bt_value_copy(extension_obj_elem
);
1137 /* Replace in extended object */
1138 if (bt_value_map_insert(extend_data
->extended_obj
, key
,
1139 extension_obj_elem_copy
)) {
1140 BT_LOGE("Cannot replace value in extended value: key=\"%s\", "
1141 "extended-value-addr=%p, element-value-addr=%p",
1142 key
, extend_data
->extended_obj
,
1143 extension_obj_elem_copy
);
1151 extend_data
->got_error
= BT_TRUE
;
1154 BT_PUT(extension_obj_elem_copy
);
1158 struct bt_value
*bt_value_map_extend(struct bt_value
*base_map_obj
,
1159 struct bt_value
*extension_obj
)
1161 struct bt_value
*extended_obj
= NULL
;
1162 struct extend_map_element_data extend_data
= { 0 };
1164 BT_ASSERT_PRE_NON_NULL(base_map_obj
, "Base value object");
1165 BT_ASSERT_PRE_NON_NULL(extension_obj
, "Extension value object");
1166 BT_ASSERT_PRE_VALUE_IS_TYPE(base_map_obj
, BT_VALUE_TYPE_MAP
);
1167 BT_ASSERT_PRE_VALUE_IS_TYPE(extension_obj
, BT_VALUE_TYPE_MAP
);
1168 BT_LOGD("Extending map value: base-value-addr=%p, extension-value-addr=%p",
1169 base_map_obj
, extension_obj
);
1171 /* Create copy of base map object to start with */
1172 extended_obj
= bt_value_copy(base_map_obj
);
1173 if (!extended_obj
) {
1174 BT_LOGE("Cannot copy base value: base-value-addr=%p",
1180 * For each key in the extension map object, replace this key
1181 * in the copied map object.
1183 extend_data
.extended_obj
= extended_obj
;
1185 if (bt_value_map_foreach(extension_obj
, extend_map_element
,
1187 BT_LOGE("Cannot iterate on the extension object's elements: "
1188 "extension-value-addr=%p", extension_obj
);
1192 if (extend_data
.got_error
) {
1193 BT_LOGE("Failed to successfully iterate on the extension object's elements: "
1194 "extension-value-addr=%p", extension_obj
);
1198 BT_LOGD("Extended map value: extended-value-addr=%p",
1203 BT_PUT(extended_obj
);
1206 return extended_obj
;
1209 struct bt_value
*bt_value_copy(const struct bt_value
*object
)
1211 struct bt_value
*copy_obj
= NULL
;
1213 BT_ASSERT_PRE_NON_NULL(object
, "Value object");
1214 BT_LOGD("Copying value object: addr=%p", object
);
1215 copy_obj
= copy_funcs
[object
->type
](object
);
1217 BT_LOGD("Copied value object: copy-value-addr=%p",
1220 BT_LOGE_STR("Failed to copy value object.");
1226 bt_bool
bt_value_compare(const struct bt_value
*object_a
,
1227 const struct bt_value
*object_b
)
1229 bt_bool ret
= BT_FALSE
;
1231 BT_ASSERT_PRE_NON_NULL(object_a
, "Value object A");
1232 BT_ASSERT_PRE_NON_NULL(object_b
, "Value object B");
1234 if (object_a
->type
!= object_b
->type
) {
1235 BT_LOGV("Values are different: type mismatch: "
1236 "value-a-addr=%p, value-b-addr=%p, "
1237 "value-a-type=%s, value-b-type=%s",
1239 bt_value_type_string(object_a
->type
),
1240 bt_value_type_string(object_b
->type
));
1244 ret
= compare_funcs
[object_a
->type
](object_a
, object_b
);