4 * Babeltrace CTF IR - Event Fields
6 * Copyright 2013, 2014 Jérémie Galarneau <jeremie.galarneau@efficios.com>
8 * Author: Jérémie Galarneau <jeremie.galarneau@efficios.com>
10 * Permission is hereby granted, free of charge, to any person obtaining a copy
11 * of this software and associated documentation files (the "Software"), to deal
12 * in the Software without restriction, including without limitation the rights
13 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
14 * copies of the Software, and to permit persons to whom the Software is
15 * furnished to do so, subject to the following conditions:
17 * The above copyright notice and this permission notice shall be included in
18 * all copies or substantial portions of the Software.
20 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
21 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
22 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
23 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
24 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
25 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
29 #define BT_LOG_TAG "FIELDS"
30 #include <babeltrace/lib-logging-internal.h>
32 #include <babeltrace/assert-pre-internal.h>
33 #include <babeltrace/ctf-ir/fields-internal.h>
34 #include <babeltrace/ctf-ir/field-types-internal.h>
35 #include <babeltrace/object-internal.h>
36 #include <babeltrace/ref.h>
37 #include <babeltrace/compiler-internal.h>
38 #include <babeltrace/compat/fcntl-internal.h>
39 #include <babeltrace/align-internal.h>
40 #include <babeltrace/assert-internal.h>
43 #define BT_ASSERT_PRE_FIELD_IS_INT_OR_ENUM(_field, _name) \
44 BT_ASSERT_PRE((_field)->type->id == BT_FIELD_TYPE_ID_INTEGER || \
45 (_field)->type->id == BT_FIELD_TYPE_ID_ENUM, \
46 _name " is not an integer or an enumeration field: " \
49 static struct bt_field_common_methods bt_field_integer_methods
= {
50 .set_is_frozen
= bt_field_common_generic_set_is_frozen
,
51 .validate
= bt_field_common_generic_validate
,
53 .is_set
= bt_field_common_generic_is_set
,
54 .reset
= bt_field_common_generic_reset
,
57 static struct bt_field_common_methods bt_field_floating_point_methods
= {
58 .set_is_frozen
= bt_field_common_generic_set_is_frozen
,
59 .validate
= bt_field_common_generic_validate
,
61 .is_set
= bt_field_common_generic_is_set
,
62 .reset
= bt_field_common_generic_reset
,
65 static struct bt_field_common_methods bt_field_enumeration_methods
= {
66 .set_is_frozen
= bt_field_common_generic_set_is_frozen
,
67 .validate
= bt_field_common_generic_validate
,
69 .is_set
= bt_field_common_generic_is_set
,
70 .reset
= bt_field_common_generic_reset
,
73 static struct bt_field_common_methods bt_field_string_methods
= {
74 .set_is_frozen
= bt_field_common_generic_set_is_frozen
,
75 .validate
= bt_field_common_generic_validate
,
77 .is_set
= bt_field_common_generic_is_set
,
78 .reset
= bt_field_common_string_reset
,
81 static struct bt_field_common_methods bt_field_structure_methods
= {
82 .set_is_frozen
= bt_field_common_structure_set_is_frozen_recursive
,
83 .validate
= bt_field_common_structure_validate_recursive
,
85 .is_set
= bt_field_common_structure_is_set_recursive
,
86 .reset
= bt_field_common_structure_reset_recursive
,
89 static struct bt_field_common_methods bt_field_sequence_methods
= {
90 .set_is_frozen
= bt_field_common_sequence_set_is_frozen_recursive
,
91 .validate
= bt_field_common_sequence_validate_recursive
,
93 .is_set
= bt_field_common_sequence_is_set_recursive
,
94 .reset
= bt_field_common_sequence_reset_recursive
,
97 static struct bt_field_common_methods bt_field_array_methods
= {
98 .set_is_frozen
= bt_field_common_array_set_is_frozen_recursive
,
99 .validate
= bt_field_common_array_validate_recursive
,
101 .is_set
= bt_field_common_array_is_set_recursive
,
102 .reset
= bt_field_common_array_reset_recursive
,
105 static struct bt_field_common_methods bt_field_variant_methods
= {
106 .set_is_frozen
= bt_field_common_variant_set_is_frozen_recursive
,
107 .validate
= bt_field_common_variant_validate_recursive
,
109 .is_set
= bt_field_common_variant_is_set_recursive
,
110 .reset
= bt_field_common_variant_reset_recursive
,
114 struct bt_field
*bt_field_integer_create(struct bt_field_type
*);
117 struct bt_field
*bt_field_enumeration_create(struct bt_field_type
*);
120 struct bt_field
*bt_field_floating_point_create(struct bt_field_type
*);
123 struct bt_field
*bt_field_structure_create(struct bt_field_type
*);
126 struct bt_field
*bt_field_variant_create(struct bt_field_type
*);
129 struct bt_field
*bt_field_array_create(struct bt_field_type
*);
132 struct bt_field
*bt_field_sequence_create(struct bt_field_type
*);
135 struct bt_field
*bt_field_string_create(struct bt_field_type
*);
138 struct bt_field
*(* const field_create_funcs
[])(struct bt_field_type
*) = {
139 [BT_FIELD_TYPE_ID_INTEGER
] = bt_field_integer_create
,
140 [BT_FIELD_TYPE_ID_ENUM
] = bt_field_enumeration_create
,
141 [BT_FIELD_TYPE_ID_FLOAT
] = bt_field_floating_point_create
,
142 [BT_FIELD_TYPE_ID_STRUCT
] = bt_field_structure_create
,
143 [BT_FIELD_TYPE_ID_VARIANT
] = bt_field_variant_create
,
144 [BT_FIELD_TYPE_ID_ARRAY
] = bt_field_array_create
,
145 [BT_FIELD_TYPE_ID_SEQUENCE
] = bt_field_sequence_create
,
146 [BT_FIELD_TYPE_ID_STRING
] = bt_field_string_create
,
150 void bt_field_integer_destroy(struct bt_field
*field
);
153 void bt_field_enumeration_destroy(struct bt_field
*field
);
156 void bt_field_floating_point_destroy(struct bt_field
*field
);
159 void bt_field_structure_destroy_recursive(struct bt_field
*field
);
162 void bt_field_variant_destroy_recursive(struct bt_field
*field
);
165 void bt_field_array_destroy_recursive(struct bt_field
*field
);
168 void bt_field_sequence_destroy_recursive(struct bt_field
*field
);
171 void bt_field_string_destroy(struct bt_field
*field
);
174 void (* const field_destroy_funcs
[])(struct bt_field
*) = {
175 [BT_FIELD_TYPE_ID_INTEGER
] = bt_field_integer_destroy
,
176 [BT_FIELD_TYPE_ID_ENUM
] = bt_field_enumeration_destroy
,
177 [BT_FIELD_TYPE_ID_FLOAT
] = bt_field_floating_point_destroy
,
178 [BT_FIELD_TYPE_ID_STRUCT
] = bt_field_structure_destroy_recursive
,
179 [BT_FIELD_TYPE_ID_VARIANT
] = bt_field_variant_destroy_recursive
,
180 [BT_FIELD_TYPE_ID_ARRAY
] = bt_field_array_destroy_recursive
,
181 [BT_FIELD_TYPE_ID_SEQUENCE
] = bt_field_sequence_destroy_recursive
,
182 [BT_FIELD_TYPE_ID_STRING
] = bt_field_string_destroy
,
186 struct bt_field
*bt_field_create_recursive(struct bt_field_type
*type
)
188 struct bt_field
*field
= NULL
;
189 enum bt_field_type_id type_id
;
191 BT_ASSERT_PRE_NON_NULL(type
, "Field type");
192 BT_ASSERT(field_type_common_has_known_id((void *) type
));
193 BT_ASSERT_PRE(bt_field_type_common_validate((void *) type
) == 0,
194 "Field type is invalid: %!+F", type
);
195 type_id
= bt_field_type_get_type_id(type
);
196 field
= field_create_funcs
[type_id
](type
);
201 bt_object_set_is_shared((void *) field
, false);
202 bt_field_type_freeze(type
);
208 struct bt_field_type
*bt_field_borrow_type(struct bt_field
*field
)
210 return (void *) bt_field_common_borrow_type((void *) field
);
213 enum bt_field_type_id
bt_field_get_type_id(struct bt_field
*field
)
215 struct bt_field_common
*field_common
= (void *) field
;
217 BT_ASSERT_PRE_NON_NULL(field
, "Field");
218 return field_common
->type
->id
;
221 bt_bool
bt_field_is_integer(struct bt_field
*field
)
223 return bt_field_get_type_id(field
) == BT_FIELD_TYPE_ID_INTEGER
;
226 bt_bool
bt_field_is_floating_point(struct bt_field
*field
)
228 return bt_field_get_type_id(field
) == BT_FIELD_TYPE_ID_FLOAT
;
231 bt_bool
bt_field_is_enumeration(struct bt_field
*field
)
233 return bt_field_get_type_id(field
) == BT_FIELD_TYPE_ID_ENUM
;
236 bt_bool
bt_field_is_string(struct bt_field
*field
)
238 return bt_field_get_type_id(field
) == BT_FIELD_TYPE_ID_STRING
;
241 bt_bool
bt_field_is_structure(struct bt_field
*field
)
243 return bt_field_get_type_id(field
) == BT_FIELD_TYPE_ID_STRUCT
;
246 bt_bool
bt_field_is_array(struct bt_field
*field
)
248 return bt_field_get_type_id(field
) == BT_FIELD_TYPE_ID_ARRAY
;
251 bt_bool
bt_field_is_sequence(struct bt_field
*field
)
253 return bt_field_get_type_id(field
) == BT_FIELD_TYPE_ID_SEQUENCE
;
256 bt_bool
bt_field_is_variant(struct bt_field
*field
)
258 return bt_field_get_type_id(field
) == BT_FIELD_TYPE_ID_VARIANT
;
261 int64_t bt_field_sequence_get_length(struct bt_field
*field
)
263 return bt_field_common_sequence_get_length((void *) field
);
266 int bt_field_sequence_set_length(struct bt_field
*field
, uint64_t length
)
268 return bt_field_common_sequence_set_length((void *) field
,
269 length
, (bt_field_common_create_func
) bt_field_create_recursive
);
272 struct bt_field
*bt_field_structure_borrow_field_by_index(
273 struct bt_field
*field
, uint64_t index
)
275 return (void *) bt_field_common_structure_borrow_field_by_index(
276 (void *) field
, index
);
279 struct bt_field
*bt_field_structure_borrow_field_by_name(
280 struct bt_field
*field
, const char *name
)
282 return (void *) bt_field_common_structure_borrow_field_by_name(
283 (void *) field
, name
);
286 struct bt_field
*bt_field_array_borrow_field(
287 struct bt_field
*field
, uint64_t index
)
289 return (void *) bt_field_common_array_borrow_field((void *) field
,
293 struct bt_field
*bt_field_sequence_borrow_field(
294 struct bt_field
*field
, uint64_t index
)
296 return (void *) bt_field_common_sequence_borrow_field((void *) field
,
300 struct bt_field
*bt_field_variant_borrow_current_field(
301 struct bt_field
*variant_field
)
303 return (void *) bt_field_common_variant_borrow_current_field(
304 (void *) variant_field
);
307 int bt_field_variant_set_tag_signed(struct bt_field
*variant_field
,
310 return bt_field_variant_common_set_tag((void *) variant_field
,
311 (uint64_t) tag
, true);
314 int bt_field_variant_set_tag_unsigned(struct bt_field
*variant_field
,
317 return bt_field_variant_common_set_tag((void *) variant_field
,
318 (uint64_t) tag
, false);
321 int bt_field_variant_get_tag_signed(struct bt_field
*variant_field
,
324 return bt_field_common_variant_get_tag_signed((void *) variant_field
, tag
);
327 int bt_field_variant_get_tag_unsigned(struct bt_field
*variant_field
,
330 return bt_field_common_variant_get_tag_unsigned((void *) variant_field
, tag
);
333 struct bt_field_type_enumeration_mapping_iterator
*
334 bt_field_enumeration_get_mappings(struct bt_field
*field
)
336 struct bt_field_enumeration
*enum_field
= (void *) field
;
338 BT_ASSERT_PRE_NON_NULL(field
, "Enumeration field");
339 BT_ASSERT_PRE_FIELD_COMMON_HAS_TYPE_ID((struct bt_field_common
*) field
,
340 BT_FIELD_TYPE_ID_ENUM
, "Field");
341 BT_ASSERT_PRE_FIELD_COMMON_IS_SET((struct bt_field_common
*) field
,
342 "Enumeration field");
343 return bt_field_common_enumeration_get_mappings((void *) field
,
344 (bt_field_common_create_func
) bt_field_create_recursive
,
345 enum_field
->common
.payload
.unsignd
);
350 struct bt_field_type_common_integer
*get_int_enum_int_ft(
351 struct bt_field
*field
)
353 struct bt_field_common_integer
*int_field
= (void *) field
;
354 struct bt_field_type_common_integer
*int_ft
= NULL
;
356 if (int_field
->common
.type
->id
== BT_FIELD_TYPE_ID_INTEGER
) {
357 int_ft
= BT_FROM_COMMON(int_field
->common
.type
);
358 } else if (int_field
->common
.type
->id
== BT_FIELD_TYPE_ID_ENUM
) {
359 struct bt_field_type_common_enumeration
*enum_ft
=
360 BT_FROM_COMMON(int_field
->common
.type
);
361 int_ft
= enum_ft
->container_ft
;
368 int bt_field_integer_signed_get_value(struct bt_field
*field
, int64_t *value
)
370 struct bt_field_common_integer
*integer
= (void *) field
;
372 BT_ASSERT_PRE_NON_NULL(field
, "Integer/enumeration field");
373 BT_ASSERT_PRE_NON_NULL(value
, "Value");
374 BT_ASSERT_PRE_FIELD_COMMON_IS_SET(BT_TO_COMMON(integer
),
375 "Integer/enumeration field");
376 BT_ASSERT_PRE_FIELD_IS_INT_OR_ENUM(BT_TO_COMMON(integer
), "Field");
377 BT_ASSERT_PRE(bt_field_type_common_integer_is_signed(
378 BT_TO_COMMON(get_int_enum_int_ft(field
))),
379 "Field's type is unsigned: %!+f", field
);
380 *value
= integer
->payload
.signd
;
384 int bt_field_integer_signed_set_value(struct bt_field
*field
, int64_t value
)
387 struct bt_field_common_integer
*integer
= (void *) field
;
389 BT_ASSERT_PRE_NON_NULL(field
, "Integer field");
390 BT_ASSERT_PRE_FIELD_COMMON_HOT(BT_TO_COMMON(integer
), "Integer field");
391 BT_ASSERT_PRE_FIELD_IS_INT_OR_ENUM(BT_TO_COMMON(integer
), "Field");
392 BT_ASSERT_PRE(bt_field_type_common_integer_is_signed(
393 BT_FROM_COMMON(get_int_enum_int_ft(field
))),
394 "Field's type is unsigned: %!+f", field
);
395 BT_ASSERT_PRE(value_is_in_range_signed(
396 get_int_enum_int_ft(field
)->size
, value
),
397 "Value is out of bounds: value=%" PRId64
", %![field-]+f",
399 integer
->payload
.signd
= value
;
400 bt_field_set(field
, true);
404 int bt_field_integer_unsigned_get_value(struct bt_field
*field
, uint64_t *value
)
406 struct bt_field_common_integer
*integer
= (void *) field
;
408 BT_ASSERT_PRE_NON_NULL(field
, "Integer field");
409 BT_ASSERT_PRE_NON_NULL(value
, "Value");
410 BT_ASSERT_PRE_FIELD_COMMON_IS_SET(BT_TO_COMMON(integer
), "Integer field");
411 BT_ASSERT_PRE_FIELD_IS_INT_OR_ENUM(BT_TO_COMMON(integer
), "Field");
412 BT_ASSERT_PRE(!bt_field_type_common_integer_is_signed(
413 BT_FROM_COMMON(get_int_enum_int_ft(field
))),
414 "Field's type is signed: %!+f", field
);
415 *value
= integer
->payload
.unsignd
;
419 int bt_field_integer_unsigned_set_value(struct bt_field
*field
,
422 struct bt_field_common_integer
*integer
= (void *) field
;
424 BT_ASSERT_PRE_NON_NULL(field
, "Integer field");
425 BT_ASSERT_PRE_FIELD_COMMON_HOT(BT_TO_COMMON(integer
), "Integer field");
426 BT_ASSERT_PRE_FIELD_IS_INT_OR_ENUM(BT_TO_COMMON(integer
), "Field");
427 BT_ASSERT_PRE(!bt_field_type_common_integer_is_signed(
428 BT_FROM_COMMON(get_int_enum_int_ft(field
))),
429 "Field's type is signed: %!+f", field
);
430 BT_ASSERT_PRE(value_is_in_range_unsigned(
431 get_int_enum_int_ft(field
)->size
, value
),
432 "Value is out of bounds: value=%" PRIu64
", %![field-]+f",
434 integer
->payload
.unsignd
= value
;
435 bt_field_set(field
, true);
439 int bt_field_floating_point_get_value(struct bt_field
*field
,
442 return bt_field_common_floating_point_get_value((void *) field
, value
);
445 int bt_field_floating_point_set_value(struct bt_field
*field
,
448 return bt_field_common_floating_point_set_value((void *) field
, value
);
451 const char *bt_field_string_get_value(struct bt_field
*field
)
453 return bt_field_common_string_get_value((void *) field
);
456 int bt_field_string_set_value(struct bt_field
*field
, const char *value
)
458 return bt_field_common_string_set_value((void *) field
, value
);
461 int bt_field_string_append(struct bt_field
*field
, const char *value
)
463 return bt_field_common_string_append((void *) field
, value
);
466 int bt_field_string_append_len(struct bt_field
*field
,
467 const char *value
, unsigned int length
)
469 return bt_field_common_string_append_len((void *) field
, value
, length
);
472 int bt_field_string_clear(struct bt_field
*string_field
)
474 return bt_field_common_string_clear((void *) string_field
);
478 struct bt_field_common
*bt_field_common_copy(struct bt_field_common
*field
)
480 struct bt_field_common
*copy
= NULL
;
482 BT_ASSERT_PRE_NON_NULL(field
, "Field");
483 BT_ASSERT(field_type_common_has_known_id(field
->type
));
484 BT_ASSERT(field
->methods
->copy
);
485 copy
= field
->methods
->copy(field
);
487 BT_LOGW("Cannot create field: ft-addr=%p", field
->type
);
491 bt_field_common_set(copy
, field
->payload_set
);
498 void bt_field_integer_destroy(struct bt_field
*field
)
500 BT_LOGD("Destroying integer field object: addr=%p", field
);
501 bt_field_common_integer_finalize((void *) field
);
506 void bt_field_floating_point_destroy(struct bt_field
*field
)
508 BT_LOGD("Destroying floating point field object: addr=%p", field
);
509 bt_field_common_floating_point_finalize((void *) field
);
514 void bt_field_enumeration_destroy(struct bt_field
*field
)
516 BT_LOGD("Destroying enumeration field object: addr=%p", field
);
517 bt_field_common_finalize((void *) field
);
522 void bt_field_structure_destroy_recursive(struct bt_field
*field
)
524 BT_LOGD("Destroying structure field object: addr=%p", field
);
525 bt_field_common_structure_finalize_recursive((void *) field
);
530 void bt_field_variant_destroy_recursive(struct bt_field
*field
)
532 BT_LOGD("Destroying variant field object: addr=%p", field
);
533 bt_field_common_variant_finalize_recursive((void *) field
);
538 void bt_field_array_destroy_recursive(struct bt_field
*field
)
540 BT_LOGD("Destroying array field object: addr=%p", field
);
541 bt_field_common_array_finalize_recursive((void *) field
);
546 void bt_field_sequence_destroy_recursive(struct bt_field
*field
)
548 BT_LOGD("Destroying sequence field object: addr=%p", field
);
549 bt_field_common_sequence_finalize_recursive((void *) field
);
554 void bt_field_string_destroy(struct bt_field
*field
)
556 BT_LOGD("Destroying string field object: addr=%p", field
);
557 bt_field_common_string_finalize((void *) field
);
562 void bt_field_destroy_recursive(struct bt_field
*field
)
564 struct bt_field_common
*field_common
= (void *) field
;
570 BT_ASSERT(field_type_common_has_known_id((void *) field_common
->type
));
571 field_destroy_funcs
[field_common
->type
->id
](field
);
575 struct bt_field
*bt_field_integer_create(struct bt_field_type
*type
)
577 struct bt_field_common_integer
*integer
=
578 g_new0(struct bt_field_common_integer
, 1);
580 BT_LOGD("Creating integer field object: ft-addr=%p", type
);
583 bt_field_common_initialize(BT_TO_COMMON(integer
), (void *) type
,
584 NULL
, &bt_field_integer_methods
);
585 BT_LOGD("Created integer field object: addr=%p, ft-addr=%p",
588 BT_LOGE_STR("Failed to allocate one integer field.");
591 return (void *) integer
;
595 struct bt_field
*bt_field_enumeration_create(struct bt_field_type
*type
)
597 struct bt_field_enumeration
*enumeration
= g_new0(
598 struct bt_field_enumeration
, 1);
600 BT_LOGD("Creating enumeration field object: ft-addr=%p", type
);
603 bt_field_common_initialize(
604 BT_TO_COMMON(BT_TO_COMMON(enumeration
)),
605 (void *) type
, NULL
, &bt_field_enumeration_methods
);
606 BT_LOGD("Created enumeration field object: addr=%p, ft-addr=%p",
609 BT_LOGE_STR("Failed to allocate one enumeration field.");
612 return (void *) enumeration
;
616 struct bt_field
*bt_field_floating_point_create(struct bt_field_type
*type
)
618 struct bt_field_common_floating_point
*floating_point
;
620 BT_LOGD("Creating floating point number field object: ft-addr=%p", type
);
621 floating_point
= g_new0(struct bt_field_common_floating_point
, 1);
623 if (floating_point
) {
624 bt_field_common_initialize(BT_TO_COMMON(floating_point
),
625 (void *) type
, NULL
, &bt_field_floating_point_methods
);
626 BT_LOGD("Created floating point number field object: addr=%p, ft-addr=%p",
627 floating_point
, type
);
629 BT_LOGE_STR("Failed to allocate one floating point number field.");
632 return (void *) floating_point
;
636 int bt_field_common_structure_initialize(struct bt_field_common
*field
,
637 struct bt_field_type_common
*type
,
638 bt_object_release_func release_func
,
639 struct bt_field_common_methods
*methods
,
640 bt_field_common_create_func field_create_func
,
641 GDestroyNotify field_release_func
)
644 struct bt_field_type_common_structure
*structure_type
=
645 BT_FROM_COMMON(type
);
646 struct bt_field_common_structure
*structure
= BT_FROM_COMMON(field
);
649 BT_LOGD("Initializing common structure field object: ft-addr=%p", type
);
650 bt_field_common_initialize(field
, type
, release_func
, methods
);
651 structure
->fields
= g_ptr_array_new_with_free_func(field_release_func
);
652 g_ptr_array_set_size(structure
->fields
, structure_type
->fields
->len
);
654 /* Create all fields contained in the structure field. */
655 for (i
= 0; i
< structure_type
->fields
->len
; i
++) {
656 struct bt_field_common
*field
;
657 struct bt_field_type_common_structure_field
*struct_field
=
658 BT_FIELD_TYPE_COMMON_STRUCTURE_FIELD_AT_INDEX(
660 field
= field_create_func(struct_field
->type
);
662 BT_LOGE("Failed to create structure field's member: name=\"%s\", index=%zu",
663 g_quark_to_string(struct_field
->name
), i
);
668 g_ptr_array_index(structure
->fields
, i
) = field
;
671 BT_LOGD("Initialized common structure field object: addr=%p, ft-addr=%p",
679 struct bt_field
*bt_field_structure_create(struct bt_field_type
*type
)
681 struct bt_field_common_structure
*structure
= g_new0(
682 struct bt_field_common_structure
, 1);
685 BT_LOGD("Creating structure field object: ft-addr=%p", type
);
688 BT_LOGE_STR("Failed to allocate one structure field.");
692 iret
= bt_field_common_structure_initialize(BT_TO_COMMON(structure
),
693 (void *) type
, NULL
, &bt_field_structure_methods
,
694 (bt_field_common_create_func
) bt_field_create_recursive
,
695 (GDestroyNotify
) bt_field_destroy_recursive
);
701 BT_LOGD("Created structure field object: addr=%p, ft-addr=%p",
705 return (void *) structure
;
709 int bt_field_common_variant_initialize(struct bt_field_common
*field
,
710 struct bt_field_type_common
*type
,
711 bt_object_release_func release_func
,
712 struct bt_field_common_methods
*methods
,
713 bt_field_common_create_func field_create_func
,
714 GDestroyNotify field_release_func
)
717 struct bt_field_type_common_variant
*variant_type
=
718 BT_FROM_COMMON(type
);
719 struct bt_field_common_variant
*variant
= BT_FROM_COMMON(field
);
722 BT_LOGD("Initializing common variant field object: ft-addr=%p", type
);
723 bt_field_common_initialize(field
, type
, release_func
, methods
);
724 ret
= bt_field_type_common_variant_update_choices(type
);
726 BT_LOGE("Cannot update common variant field type choices: "
731 variant
->fields
= g_ptr_array_new_with_free_func(field_release_func
);
732 g_ptr_array_set_size(variant
->fields
, variant_type
->choices
->len
);
734 /* Create all fields contained in the variant field. */
735 for (i
= 0; i
< variant_type
->choices
->len
; i
++) {
736 struct bt_field_common
*field
;
737 struct bt_field_type_common_variant_choice
*var_choice
=
738 BT_FIELD_TYPE_COMMON_VARIANT_CHOICE_AT_INDEX(
741 field
= field_create_func(var_choice
->type
);
743 BT_LOGE("Failed to create variant field's member: name=\"%s\", index=%zu",
744 g_quark_to_string(var_choice
->name
), i
);
749 g_ptr_array_index(variant
->fields
, i
) = field
;
752 BT_LOGD("Initialized common variant field object: addr=%p, ft-addr=%p",
760 struct bt_field
*bt_field_variant_create(struct bt_field_type
*type
)
762 struct bt_field_common_variant
*variant
= g_new0(
763 struct bt_field_common_variant
, 1);
766 BT_LOGD("Creating variant field object: ft-addr=%p", type
);
769 BT_LOGE_STR("Failed to allocate one variant field.");
773 iret
= bt_field_common_variant_initialize(BT_TO_COMMON(variant
),
774 (void *) type
, NULL
, &bt_field_variant_methods
,
775 (bt_field_common_create_func
) bt_field_create_recursive
,
776 (GDestroyNotify
) bt_field_destroy_recursive
);
782 BT_LOGD("Created variant field object: addr=%p, ft-addr=%p",
786 return (void *) variant
;
790 int bt_field_common_array_initialize(struct bt_field_common
*field
,
791 struct bt_field_type_common
*type
,
792 bt_object_release_func release_func
,
793 struct bt_field_common_methods
*methods
,
794 bt_field_common_create_func field_create_func
,
795 GDestroyNotify field_destroy_func
)
797 struct bt_field_type_common_array
*array_type
= BT_FROM_COMMON(type
);
798 struct bt_field_common_array
*array
= BT_FROM_COMMON(field
);
799 unsigned int array_length
;
803 BT_LOGD("Initializing common array field object: ft-addr=%p", type
);
805 bt_field_common_initialize(field
, type
, release_func
, methods
);
806 array_length
= array_type
->length
;
807 array
->elements
= g_ptr_array_sized_new(array_length
);
808 if (!array
->elements
) {
813 g_ptr_array_set_free_func(array
->elements
, field_destroy_func
);
814 g_ptr_array_set_size(array
->elements
, array_length
);
816 for (i
= 0; i
< array_length
; i
++) {
817 array
->elements
->pdata
[i
] = field_create_func(
818 array_type
->element_ft
);
819 if (!array
->elements
->pdata
[i
]) {
825 BT_LOGD("Initialized common array field object: addr=%p, ft-addr=%p",
833 struct bt_field
*bt_field_array_create(struct bt_field_type
*type
)
835 struct bt_field_common_array
*array
=
836 g_new0(struct bt_field_common_array
, 1);
839 BT_LOGD("Creating array field object: ft-addr=%p", type
);
843 BT_LOGE_STR("Failed to allocate one array field.");
847 ret
= bt_field_common_array_initialize(BT_TO_COMMON(array
),
848 (void *) type
, NULL
, &bt_field_array_methods
,
849 (bt_field_common_create_func
) bt_field_create_recursive
,
850 (GDestroyNotify
) bt_field_destroy_recursive
);
856 BT_LOGD("Created array field object: addr=%p, ft-addr=%p",
860 return (void *) array
;
864 int bt_field_common_sequence_initialize(struct bt_field_common
*field
,
865 struct bt_field_type_common
*type
,
866 bt_object_release_func release_func
,
867 struct bt_field_common_methods
*methods
,
868 GDestroyNotify field_destroy_func
)
870 struct bt_field_common_sequence
*sequence
= BT_FROM_COMMON(field
);
873 BT_LOGD("Initializing common sequence field object: ft-addr=%p", type
);
875 bt_field_common_initialize(field
, type
, release_func
, methods
);
876 sequence
->elements
= g_ptr_array_new();
877 if (!sequence
->elements
) {
882 g_ptr_array_set_free_func(sequence
->elements
, field_destroy_func
);
883 BT_LOGD("Initialized common sequence field object: addr=%p, ft-addr=%p",
891 struct bt_field
*bt_field_sequence_create(struct bt_field_type
*type
)
893 struct bt_field_common_sequence
*sequence
=
894 g_new0(struct bt_field_common_sequence
, 1);
897 BT_LOGD("Creating sequence field object: ft-addr=%p", type
);
901 BT_LOGE_STR("Failed to allocate one sequence field.");
905 ret
= bt_field_common_sequence_initialize(BT_TO_COMMON(sequence
),
906 (void *) type
, NULL
, &bt_field_sequence_methods
,
907 (GDestroyNotify
) bt_field_destroy_recursive
);
913 BT_LOGD("Created sequence field object: addr=%p, ft-addr=%p",
917 return (void *) sequence
;
921 struct bt_field
*bt_field_string_create(struct bt_field_type
*type
)
923 struct bt_field_common_string
*string
= g_new0(
924 struct bt_field_common_string
, 1);
926 BT_LOGD("Creating string field object: ft-addr=%p", type
);
929 bt_field_common_initialize(BT_TO_COMMON(string
),
930 (void *) type
, NULL
, &bt_field_string_methods
);
931 BT_LOGD("Created string field object: addr=%p, ft-addr=%p",
934 BT_LOGE_STR("Failed to allocate one string field.");
937 return (void *) string
;
941 int bt_field_common_generic_validate(struct bt_field_common
*field
)
943 return (field
&& field
->payload_set
) ? 0 : -1;
947 int bt_field_common_structure_validate_recursive(struct bt_field_common
*field
)
951 struct bt_field_common_structure
*structure
= BT_FROM_COMMON(field
);
955 for (i
= 0; i
< structure
->fields
->len
; i
++) {
956 ret
= bt_field_common_validate_recursive(
957 (void *) structure
->fields
->pdata
[i
]);
963 this_ret
= bt_field_type_common_structure_borrow_field_by_index(
964 field
->type
, &name
, NULL
, i
);
965 BT_ASSERT(this_ret
== 0);
966 BT_ASSERT_PRE_MSG("Invalid structure field's field: "
967 "%![struct-field-]+_f, field-name=\"%s\", "
968 "index=%" PRId64
", %![field-]+_f",
969 field
, name
, i
, structure
->fields
->pdata
[i
]);
979 int bt_field_common_variant_validate_recursive(struct bt_field_common
*field
)
982 struct bt_field_common_variant
*variant
= BT_FROM_COMMON(field
);
986 if (!variant
->current_field
) {
991 ret
= bt_field_common_validate_recursive(variant
->current_field
);
998 int bt_field_common_array_validate_recursive(struct bt_field_common
*field
)
1002 struct bt_field_common_array
*array
= BT_FROM_COMMON(field
);
1006 for (i
= 0; i
< array
->elements
->len
; i
++) {
1007 ret
= bt_field_common_validate_recursive((void *) array
->elements
->pdata
[i
]);
1009 BT_ASSERT_PRE_MSG("Invalid array field's element field: "
1010 "%![array-field-]+_f, " PRId64
", "
1011 "%![elem-field-]+_f",
1012 field
, i
, array
->elements
->pdata
[i
]);
1022 int bt_field_common_sequence_validate_recursive(struct bt_field_common
*field
)
1026 struct bt_field_common_sequence
*sequence
= BT_FROM_COMMON(field
);
1030 for (i
= 0; i
< sequence
->elements
->len
; i
++) {
1031 ret
= bt_field_common_validate_recursive(
1032 (void *) sequence
->elements
->pdata
[i
]);
1034 BT_ASSERT_PRE_MSG("Invalid sequence field's element field: "
1035 "%![seq-field-]+_f, " PRId64
", "
1036 "%![elem-field-]+_f",
1037 field
, i
, sequence
->elements
->pdata
[i
]);
1046 void bt_field_common_generic_reset(struct bt_field_common
*field
)
1049 field
->payload_set
= false;
1053 void bt_field_common_structure_reset_recursive(struct bt_field_common
*field
)
1056 struct bt_field_common_structure
*structure
= BT_FROM_COMMON(field
);
1060 for (i
= 0; i
< structure
->fields
->len
; i
++) {
1061 struct bt_field_common
*member
= structure
->fields
->pdata
[i
];
1065 * Structure members are lazily initialized;
1066 * skip if this member has not been allocated
1072 bt_field_common_reset_recursive(member
);
1077 void bt_field_common_variant_reset_recursive(struct bt_field_common
*field
)
1079 struct bt_field_common_variant
*variant
= BT_FROM_COMMON(field
);
1082 variant
->current_field
= NULL
;
1086 void bt_field_common_array_reset_recursive(struct bt_field_common
*field
)
1089 struct bt_field_common_array
*array
= BT_FROM_COMMON(field
);
1093 for (i
= 0; i
< array
->elements
->len
; i
++) {
1094 struct bt_field_common
*member
= array
->elements
->pdata
[i
];
1098 * Array elements are lazily initialized; skip
1099 * if this member has not been allocated yet.
1104 bt_field_common_reset_recursive(member
);
1109 void bt_field_common_sequence_reset_recursive(struct bt_field_common
*field
)
1111 struct bt_field_common_sequence
*sequence
= BT_FROM_COMMON(field
);
1116 for (i
= 0; i
< sequence
->elements
->len
; i
++) {
1117 if (sequence
->elements
->pdata
[i
]) {
1118 bt_field_common_reset_recursive(
1119 sequence
->elements
->pdata
[i
]);
1123 sequence
->length
= 0;
1127 void bt_field_common_string_reset(struct bt_field_common
*field
)
1129 struct bt_field_common_string
*string
= BT_FROM_COMMON(field
);
1132 bt_field_common_generic_reset(field
);
1134 if (string
->payload
) {
1135 g_string_truncate(string
->payload
, 0);
1140 void bt_field_common_generic_set_is_frozen(struct bt_field_common
*field
,
1143 field
->frozen
= is_frozen
;
1147 void bt_field_common_structure_set_is_frozen_recursive(
1148 struct bt_field_common
*field
, bool is_frozen
)
1151 struct bt_field_common_structure
*structure_field
=
1152 BT_FROM_COMMON(field
);
1154 BT_LOGD("Freezing structure field object: addr=%p", field
);
1156 for (i
= 0; i
< structure_field
->fields
->len
; i
++) {
1157 struct bt_field_common
*struct_field
=
1158 g_ptr_array_index(structure_field
->fields
, i
);
1160 BT_LOGD("Freezing structure field's field: field-addr=%p, index=%" PRId64
,
1162 bt_field_common_set_is_frozen_recursive(struct_field
,
1166 bt_field_common_generic_set_is_frozen(field
, is_frozen
);
1170 void bt_field_common_variant_set_is_frozen_recursive(
1171 struct bt_field_common
*field
, bool is_frozen
)
1174 struct bt_field_common_variant
*variant_field
= BT_FROM_COMMON(field
);
1176 BT_LOGD("Freezing variant field object: addr=%p", field
);
1178 for (i
= 0; i
< variant_field
->fields
->len
; i
++) {
1179 struct bt_field_common
*var_field
=
1180 g_ptr_array_index(variant_field
->fields
, i
);
1182 BT_LOGD("Freezing variant field's field: field-addr=%p, index=%" PRId64
,
1184 bt_field_common_set_is_frozen_recursive(var_field
, is_frozen
);
1187 bt_field_common_generic_set_is_frozen(field
, is_frozen
);
1191 void bt_field_common_array_set_is_frozen_recursive(
1192 struct bt_field_common
*field
, bool is_frozen
)
1195 struct bt_field_common_array
*array_field
= BT_FROM_COMMON(field
);
1197 BT_LOGD("Freezing array field object: addr=%p", field
);
1199 for (i
= 0; i
< array_field
->elements
->len
; i
++) {
1200 struct bt_field_common
*elem_field
=
1201 g_ptr_array_index(array_field
->elements
, i
);
1203 BT_LOGD("Freezing array field object's element field: "
1204 "element-field-addr=%p, index=%" PRId64
,
1206 bt_field_common_set_is_frozen_recursive(elem_field
, is_frozen
);
1209 bt_field_common_generic_set_is_frozen(field
, is_frozen
);
1213 void bt_field_common_sequence_set_is_frozen_recursive(
1214 struct bt_field_common
*field
, bool is_frozen
)
1217 struct bt_field_common_sequence
*sequence_field
=
1218 BT_FROM_COMMON(field
);
1220 BT_LOGD("Freezing sequence field object: addr=%p", field
);
1222 for (i
= 0; i
< sequence_field
->length
; i
++) {
1223 struct bt_field_common
*elem_field
=
1224 g_ptr_array_index(sequence_field
->elements
, i
);
1226 BT_LOGD("Freezing sequence field object's element field: "
1227 "element-field-addr=%p, index=%" PRId64
,
1229 bt_field_common_set_is_frozen_recursive(elem_field
, is_frozen
);
1232 bt_field_common_generic_set_is_frozen(field
, is_frozen
);
1236 void _bt_field_common_set_is_frozen_recursive(struct bt_field_common
*field
,
1243 if (field
->frozen
) {
1247 BT_LOGD("Setting field object's frozen state: addr=%p, is-frozen=%d",
1249 BT_ASSERT(field_type_common_has_known_id(field
->type
));
1250 BT_ASSERT(field
->methods
->set_is_frozen
);
1251 field
->methods
->set_is_frozen(field
, is_frozen
);
1258 bt_bool
bt_field_common_generic_is_set(struct bt_field_common
*field
)
1260 return field
&& field
->payload_set
;
1264 bt_bool
bt_field_common_structure_is_set_recursive(
1265 struct bt_field_common
*field
)
1267 bt_bool is_set
= BT_FALSE
;
1269 struct bt_field_common_structure
*structure
= BT_FROM_COMMON(field
);
1273 for (i
= 0; i
< structure
->fields
->len
; i
++) {
1274 is_set
= bt_field_common_is_set_recursive(
1275 structure
->fields
->pdata
[i
]);
1286 bt_bool
bt_field_common_variant_is_set_recursive(struct bt_field_common
*field
)
1288 struct bt_field_common_variant
*variant
= BT_FROM_COMMON(field
);
1289 bt_bool is_set
= BT_FALSE
;
1293 if (variant
->current_field
) {
1294 is_set
= bt_field_common_is_set_recursive(
1295 variant
->current_field
);
1302 bt_bool
bt_field_common_array_is_set_recursive(struct bt_field_common
*field
)
1305 bt_bool is_set
= BT_FALSE
;
1306 struct bt_field_common_array
*array
= BT_FROM_COMMON(field
);
1310 for (i
= 0; i
< array
->elements
->len
; i
++) {
1311 is_set
= bt_field_common_is_set_recursive(array
->elements
->pdata
[i
]);
1322 bt_bool
bt_field_common_sequence_is_set_recursive(struct bt_field_common
*field
)
1325 bt_bool is_set
= BT_FALSE
;
1326 struct bt_field_common_sequence
*sequence
= BT_FROM_COMMON(field
);
1330 if (!sequence
->elements
) {
1334 for (i
= 0; i
< sequence
->elements
->len
; i
++) {
1335 is_set
= bt_field_common_is_set_recursive(
1336 sequence
->elements
->pdata
[i
]);