1 #ifndef BABELTRACE_CTF_IR_FIELD_TYPES_INTERNAL_H
2 #define BABELTRACE_CTF_IR_FIELD_TYPES_INTERNAL_H
5 * BabelTrace - CTF IR: Event field types internal
7 * Copyright 2013, 2014 Jérémie Galarneau <jeremie.galarneau@efficios.com>
9 * Author: Jérémie Galarneau <jeremie.galarneau@efficios.com>
11 * Permission is hereby granted, free of charge, to any person obtaining a copy
12 * of this software and associated documentation files (the "Software"), to deal
13 * in the Software without restriction, including without limitation the rights
14 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
15 * copies of the Software, and to permit persons to whom the Software is
16 * furnished to do so, subject to the following conditions:
18 * The above copyright notice and this permission notice shall be included in
19 * all copies or substantial portions of the Software.
21 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
22 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
23 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
24 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
25 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
26 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
30 #include <babeltrace/assert-pre-internal.h>
31 #include <babeltrace/ctf-ir/clock-class.h>
32 #include <babeltrace/ctf-ir/field-types.h>
33 #include <babeltrace/babeltrace-internal.h>
34 #include <babeltrace/object-internal.h>
35 #include <babeltrace/types.h>
39 #define BT_ASSERT_PRE_FT_COMMON_HAS_ID(_ft, _type_id, _name) \
40 BT_ASSERT_PRE(((struct bt_field_type_common *) (_ft))->id == (_type_id), \
41 _name " has the wrong type ID: expected-type-id=%s, " \
42 "%![ft-]+_F", bt_common_field_type_id_string(_type_id), (_ft))
44 #define BT_ASSERT_PRE_FT_HOT(_ft, _name) \
45 BT_ASSERT_PRE_HOT((_ft), (_name), ": %!+_F", (_ft))
47 #define BT_FIELD_TYPE_COMMON_STRUCTURE_FIELD_AT_INDEX(_ft, _index) \
48 (&g_array_index(((struct bt_field_type_common_structure *) (_ft))->fields, \
49 struct bt_field_type_common_structure_field, (_index)))
51 #define BT_FIELD_TYPE_COMMON_VARIANT_CHOICE_AT_INDEX(_ft, _index) \
52 (&g_array_index(((struct bt_field_type_common_variant *) (_ft))->choices, \
53 struct bt_field_type_common_variant_choice, (_index)))
55 struct bt_field_common
;
56 struct bt_field_type_common
;
59 typedef void (*bt_field_type_common_method_freeze
)(
60 struct bt_field_type_common
*);
61 typedef int (*bt_field_type_common_method_validate
)(
62 struct bt_field_type_common
*);
63 typedef void (*bt_field_type_common_method_set_byte_order
)(
64 struct bt_field_type_common
*, enum bt_byte_order
);
65 typedef struct bt_field_type_common
*(*bt_field_type_common_method_copy
)(
66 struct bt_field_type_common
*);
67 typedef int (*bt_field_type_common_method_compare
)(
68 struct bt_field_type_common
*,
69 struct bt_field_type_common
*);
71 struct bt_field_type_common_methods
{
72 bt_field_type_common_method_freeze freeze
;
73 bt_field_type_common_method_validate validate
;
74 bt_field_type_common_method_set_byte_order set_byte_order
;
75 bt_field_type_common_method_copy copy
;
76 bt_field_type_common_method_compare compare
;
79 struct bt_field_type_common
{
80 struct bt_object base
;
81 enum bt_field_type_id id
;
82 unsigned int alignment
;
85 struct bt_field_type_common_methods
*methods
;
88 * A type can't be modified once it is added to an event or after a
89 * a field has been instanciated from it.
94 * This flag indicates if the field type is valid. A valid
95 * field type is _always_ frozen. All the nested field types of
96 * a valid field type are also valid (and thus frozen).
101 * Specialized data for either CTF IR or CTF writer APIs.
102 * Having this here ensures that:
104 * * The type-specific common data is always found at the same
105 * offset when the common API has a `struct
106 * bt_field_type_common *` so that you can cast it to `struct
107 * bt_field_type_common_integer *` for example and access the
108 * common integer field type fields.
110 * * The specific CTF IR and CTF writer APIs can access their
111 * specific field type fields in this union at an offset known
112 * at build time. This avoids a pointer to specific data so
113 * that all the fields, common or specific, of a CTF IR
114 * integer field type or of a CTF writer integer field type,
115 * for example, are contained within the same contiguous block
122 void *serialize_func
;
127 struct bt_field_type_common_integer
{
128 struct bt_field_type_common common
;
131 struct bt_clock_class
*mapped_clock_class
;
133 enum bt_byte_order user_byte_order
;
136 enum bt_integer_base base
;
137 enum bt_string_encoding encoding
;
140 struct enumeration_mapping
{
152 struct bt_field_type_common_enumeration
{
153 struct bt_field_type_common common
;
156 struct bt_field_type_common_integer
*container_ft
;
158 /* Array of `struct enumeration_mapping *`, owned by this */
161 /* Only set during validation */
162 bt_bool has_overlapping_ranges
;
165 enum bt_field_type_enumeration_mapping_iterator_type
{
167 ITERATOR_BY_SIGNED_VALUE
,
168 ITERATOR_BY_UNSIGNED_VALUE
,
171 struct bt_field_type_enumeration_mapping_iterator
{
172 struct bt_object base
;
175 struct bt_field_type_common_enumeration
*enumeration_ft
;
177 enum bt_field_type_enumeration_mapping_iterator_type type
;
181 int64_t signed_value
;
182 uint64_t unsigned_value
;
186 struct bt_field_type_common_floating_point
{
187 struct bt_field_type_common common
;
188 enum bt_byte_order user_byte_order
;
189 unsigned int exp_dig
;
190 unsigned int mant_dig
;
193 struct bt_field_type_common_structure_field
{
197 struct bt_field_type_common
*type
;
200 struct bt_field_type_common_structure
{
201 struct bt_field_type_common common
;
202 GHashTable
*field_name_to_index
;
205 * Array of `struct bt_field_type_common_structure_field`,
211 struct bt_field_type_common_variant_choice_range
{
222 struct bt_field_type_common_variant_choice
{
226 struct bt_field_type_common
*type
;
228 /* Array of `struct bt_field_type_common_variant_choice_range` */
232 struct bt_field_type_common_variant
{
233 struct bt_field_type_common common
;
235 bool choices_up_to_date
;
238 struct bt_field_type_common_enumeration
*tag_ft
;
241 struct bt_field_path
*tag_field_path
;
243 GHashTable
*choice_name_to_index
;
246 * Array of `struct bt_field_type_common_variant_choice`,
251 struct bt_field_type_common_array
{
252 struct bt_field_type_common common
;
255 struct bt_field_type_common
*element_ft
;
260 struct bt_field_type_common_sequence
{
261 struct bt_field_type_common common
;
264 struct bt_field_type_common
*element_ft
;
266 GString
*length_field_name
;
269 struct bt_field_path
*length_field_path
;
272 struct bt_field_type_common_string
{
273 struct bt_field_type_common common
;
274 enum bt_string_encoding encoding
;
277 typedef struct bt_field_common
*(* bt_field_common_create_func
)(
278 struct bt_field_type_common
*);
281 void bt_field_type_common_initialize(struct bt_field_type_common
*ft
,
282 bool init_bo
, bt_object_release_func release_func
,
283 struct bt_field_type_common_methods
*methods
);
286 void bt_field_type_common_integer_initialize(
287 struct bt_field_type_common
*ft
,
288 unsigned int size
, bt_object_release_func release_func
,
289 struct bt_field_type_common_methods
*methods
);
292 void bt_field_type_common_floating_point_initialize(
293 struct bt_field_type_common
*ft
,
294 bt_object_release_func release_func
,
295 struct bt_field_type_common_methods
*methods
);
298 void bt_field_type_common_enumeration_initialize(
299 struct bt_field_type_common
*ft
,
300 struct bt_field_type_common
*container_ft
,
301 bt_object_release_func release_func
,
302 struct bt_field_type_common_methods
*methods
);
305 void bt_field_type_common_string_initialize(
306 struct bt_field_type_common
*ft
,
307 bt_object_release_func release_func
,
308 struct bt_field_type_common_methods
*methods
);
311 void bt_field_type_common_structure_initialize(
312 struct bt_field_type_common
*ft
,
313 bt_object_release_func release_func
,
314 struct bt_field_type_common_methods
*methods
);
317 void bt_field_type_common_array_initialize(
318 struct bt_field_type_common
*ft
,
319 struct bt_field_type_common
*element_ft
,
320 unsigned int length
, bt_object_release_func release_func
,
321 struct bt_field_type_common_methods
*methods
);
324 void bt_field_type_common_sequence_initialize(
325 struct bt_field_type_common
*ft
,
326 struct bt_field_type_common
*element_ft
,
327 const char *length_field_name
,
328 bt_object_release_func release_func
,
329 struct bt_field_type_common_methods
*methods
);
332 void bt_field_type_common_variant_initialize(
333 struct bt_field_type_common
*ft
,
334 struct bt_field_type_common
*tag_ft
,
335 const char *tag_name
,
336 bt_object_release_func release_func
,
337 struct bt_field_type_common_methods
*methods
);
340 void bt_field_type_common_integer_destroy(struct bt_object
*obj
);
343 void bt_field_type_common_floating_point_destroy(struct bt_object
*obj
);
346 void bt_field_type_common_enumeration_destroy_recursive(struct bt_object
*obj
);
349 void bt_field_type_common_string_destroy(struct bt_object
*obj
);
352 void bt_field_type_common_structure_destroy_recursive(struct bt_object
*obj
);
355 void bt_field_type_common_array_destroy_recursive(struct bt_object
*obj
);
358 void bt_field_type_common_sequence_destroy_recursive(struct bt_object
*obj
);
361 void bt_field_type_common_variant_destroy_recursive(struct bt_object
*obj
);
364 int bt_field_type_common_integer_validate(struct bt_field_type_common
*ft
);
367 int bt_field_type_common_enumeration_validate_recursive(
368 struct bt_field_type_common
*ft
);
371 int bt_field_type_common_sequence_validate_recursive(
372 struct bt_field_type_common
*ft
);
375 int bt_field_type_common_array_validate_recursive(
376 struct bt_field_type_common
*ft
);
379 int bt_field_type_common_structure_validate_recursive(
380 struct bt_field_type_common
*ft
);
383 int bt_field_type_common_variant_validate_recursive(
384 struct bt_field_type_common
*type
);
387 int bt_field_type_common_validate(struct bt_field_type_common
*ft
);
390 int bt_field_type_common_integer_get_size(struct bt_field_type_common
*ft
);
393 bt_bool
bt_field_type_common_integer_is_signed(struct bt_field_type_common
*ft
);
396 int bt_field_type_common_integer_set_is_signed(struct bt_field_type_common
*ft
,
400 int bt_field_type_common_integer_set_size(struct bt_field_type_common
*ft
,
404 enum bt_integer_base
bt_field_type_common_integer_get_base(
405 struct bt_field_type_common
*ft
);
408 int bt_field_type_common_integer_set_base(struct bt_field_type_common
*ft
,
409 enum bt_integer_base base
);
412 enum bt_string_encoding
bt_field_type_common_integer_get_encoding(
413 struct bt_field_type_common
*ft
);
416 int bt_field_type_common_integer_set_encoding(struct bt_field_type_common
*ft
,
417 enum bt_string_encoding encoding
);
420 struct bt_clock_class
*bt_field_type_common_integer_borrow_mapped_clock_class(
421 struct bt_field_type_common
*ft
);
424 int bt_field_type_common_integer_set_mapped_clock_class_no_check_frozen(
425 struct bt_field_type_common
*ft
,
426 struct bt_clock_class
*clock_class
);
429 int bt_field_type_common_integer_set_mapped_clock_class(
430 struct bt_field_type_common
*ft
,
431 struct bt_clock_class
*clock_class
);
434 struct bt_field_type_enumeration_mapping_iterator
*
435 bt_field_type_common_enumeration_find_mappings_by_name(
436 struct bt_field_type_common
*ft
, const char *name
);
439 struct bt_field_type_enumeration_mapping_iterator
*
440 bt_field_type_common_enumeration_signed_find_mappings_by_value(
441 struct bt_field_type_common
*ft
, int64_t value
);
444 struct bt_field_type_enumeration_mapping_iterator
*
445 bt_field_type_common_enumeration_unsigned_find_mappings_by_value(
446 struct bt_field_type_common
*ft
, uint64_t value
);
449 int bt_field_type_common_enumeration_signed_get_mapping_by_index(
450 struct bt_field_type_common
*ft
, uint64_t index
,
451 const char **mapping_name
, int64_t *range_begin
,
455 int bt_field_type_common_enumeration_unsigned_get_mapping_by_index(
456 struct bt_field_type_common
*ft
, uint64_t index
,
457 const char **mapping_name
, uint64_t *range_begin
,
458 uint64_t *range_end
);
461 struct bt_field_type_common
*
462 bt_field_type_common_enumeration_borrow_container_field_type(
463 struct bt_field_type_common
*ft
);
466 int bt_field_type_common_enumeration_signed_add_mapping(
467 struct bt_field_type_common
*ft
, const char *string
,
468 int64_t range_start
, int64_t range_end
);
471 int bt_field_type_common_enumeration_unsigned_add_mapping(
472 struct bt_field_type_common
*ft
, const char *string
,
473 uint64_t range_start
, uint64_t range_end
);
476 int64_t bt_field_type_common_enumeration_get_mapping_count(
477 struct bt_field_type_common
*ft
);
480 int bt_field_type_common_floating_point_get_exponent_digits(
481 struct bt_field_type_common
*ft
);
484 int bt_field_type_common_floating_point_set_exponent_digits(
485 struct bt_field_type_common
*ft
,
486 unsigned int exponent_digits
);
489 int bt_field_type_common_floating_point_get_mantissa_digits(
490 struct bt_field_type_common
*type
);
493 int bt_field_type_common_floating_point_set_mantissa_digits(
494 struct bt_field_type_common
*ft
, unsigned int mantissa_digits
);
497 int bt_field_type_common_structure_replace_field(
498 struct bt_field_type_common
*ft
,
499 const char *field_name
,
500 struct bt_field_type_common
*field_type
);
503 int bt_field_type_common_structure_add_field(struct bt_field_type_common
*ft
,
504 struct bt_field_type_common
*field_type
,
505 const char *field_name
);
508 int64_t bt_field_type_common_structure_get_field_count(
509 struct bt_field_type_common
*ft
);
512 int bt_field_type_common_structure_borrow_field_by_index(
513 struct bt_field_type_common
*ft
,
514 const char **field_name
,
515 struct bt_field_type_common
**field_type
, uint64_t index
);
518 struct bt_field_type_common
*
519 bt_field_type_common_structure_borrow_field_type_by_name(
520 struct bt_field_type_common
*ft
, const char *name
);
523 struct bt_field_type_common
*
524 bt_field_type_common_variant_borrow_tag_field_type(
525 struct bt_field_type_common
*ft
);
528 const char *bt_field_type_common_variant_get_tag_name(
529 struct bt_field_type_common
*ft
);
532 int bt_field_type_common_variant_set_tag_name(
533 struct bt_field_type_common
*ft
, const char *name
);
536 int bt_field_type_common_variant_add_field(struct bt_field_type_common
*ft
,
537 struct bt_field_type_common
*field_type
,
538 const char *field_name
);
541 int bt_field_type_common_variant_update_choices(
542 struct bt_field_type_common
*ft
);
545 struct bt_field_type_common
*
546 bt_field_type_common_variant_borrow_field_type_by_name(
547 struct bt_field_type_common
*ft
,
548 const char *field_name
);
551 int64_t bt_field_type_common_variant_get_field_count(
552 struct bt_field_type_common
*ft
);
555 int bt_field_type_common_variant_borrow_field_by_index(
556 struct bt_field_type_common
*ft
,
557 const char **field_name
,
558 struct bt_field_type_common
**field_type
, uint64_t index
);
561 struct bt_field_type_common
*
562 bt_field_type_common_array_borrow_element_field_type(
563 struct bt_field_type_common
*ft
);
566 int bt_field_type_common_array_set_element_field_type(
567 struct bt_field_type_common
*ft
,
568 struct bt_field_type_common
*element_ft
);
571 int64_t bt_field_type_common_array_get_length(struct bt_field_type_common
*ft
);
574 struct bt_field_type_common
*
575 bt_field_type_common_sequence_borrow_element_field_type(
576 struct bt_field_type_common
*ft
);
579 int bt_field_type_common_sequence_set_element_field_type(
580 struct bt_field_type_common
*ft
,
581 struct bt_field_type_common
*element_ft
);
584 const char *bt_field_type_common_sequence_get_length_field_name(
585 struct bt_field_type_common
*ft
);
588 enum bt_string_encoding
bt_field_type_common_string_get_encoding(
589 struct bt_field_type_common
*ft
);
592 int bt_field_type_common_string_set_encoding(struct bt_field_type_common
*ft
,
593 enum bt_string_encoding encoding
);
596 int bt_field_type_common_get_alignment(struct bt_field_type_common
*type
);
599 int bt_field_type_common_set_alignment(struct bt_field_type_common
*ft
,
600 unsigned int alignment
);
603 enum bt_byte_order
bt_field_type_common_get_byte_order(
604 struct bt_field_type_common
*ft
);
607 int bt_field_type_common_set_byte_order(struct bt_field_type_common
*ft
,
608 enum bt_byte_order byte_order
);
611 enum bt_field_type_id
bt_field_type_common_get_type_id(
612 struct bt_field_type_common
*ft
);
615 void bt_field_type_common_freeze(struct bt_field_type_common
*ft
);
618 void bt_field_type_freeze(struct bt_field_type
*ft
);
621 struct bt_field_type_common
*
622 bt_field_type_common_variant_borrow_field_type_signed(
623 struct bt_field_type_common_variant
*var_ft
,
627 struct bt_field_type_common
*
628 bt_field_type_common_variant_borrow_field_type_unsigned(
629 struct bt_field_type_common_variant
*var_ft
,
633 struct bt_field_type_common
*bt_field_type_common_copy(
634 struct bt_field_type_common
*ft
);
637 int bt_field_type_common_structure_get_field_name_index(
638 struct bt_field_type_common
*ft
, const char *name
);
641 int bt_field_type_common_variant_get_field_name_index(
642 struct bt_field_type_common
*ft
, const char *name
);
645 int bt_field_type_common_sequence_set_length_field_path(
646 struct bt_field_type_common
*ft
, struct bt_field_path
*path
);
649 int bt_field_type_common_variant_set_tag_field_path(
650 struct bt_field_type_common
*ft
,
651 struct bt_field_path
*path
);
654 int bt_field_type_common_variant_set_tag_field_type(
655 struct bt_field_type_common
*ft
,
656 struct bt_field_type_common
*tag_ft
);
659 void bt_field_type_common_generic_freeze(struct bt_field_type_common
*ft
);
662 void bt_field_type_common_enumeration_freeze_recursive(
663 struct bt_field_type_common
*ft
);
666 void bt_field_type_common_structure_freeze_recursive(
667 struct bt_field_type_common
*ft
);
670 void bt_field_type_common_variant_freeze_recursive(
671 struct bt_field_type_common
*ft
);
674 void bt_field_type_common_array_freeze_recursive(
675 struct bt_field_type_common
*ft
);
678 void bt_field_type_common_sequence_freeze_recursive(
679 struct bt_field_type_common
*type
);
682 void bt_field_type_common_integer_set_byte_order(
683 struct bt_field_type_common
*ft
, enum bt_byte_order byte_order
);
686 void bt_field_type_common_enumeration_set_byte_order_recursive(
687 struct bt_field_type_common
*ft
, enum bt_byte_order byte_order
);
690 void bt_field_type_common_floating_point_set_byte_order(
691 struct bt_field_type_common
*ft
, enum bt_byte_order byte_order
);
694 void bt_field_type_common_structure_set_byte_order_recursive(
695 struct bt_field_type_common
*ft
,
696 enum bt_byte_order byte_order
);
699 void bt_field_type_common_variant_set_byte_order_recursive(
700 struct bt_field_type_common
*ft
,
701 enum bt_byte_order byte_order
);
704 void bt_field_type_common_array_set_byte_order_recursive(
705 struct bt_field_type_common
*ft
,
706 enum bt_byte_order byte_order
);
709 void bt_field_type_common_sequence_set_byte_order_recursive(
710 struct bt_field_type_common
*ft
,
711 enum bt_byte_order byte_order
);
714 int bt_field_type_common_integer_compare(struct bt_field_type_common
*ft_a
,
715 struct bt_field_type_common
*ft_b
);
718 int bt_field_type_common_floating_point_compare(
719 struct bt_field_type_common
*ft_a
,
720 struct bt_field_type_common
*ft_b
);
723 int bt_field_type_common_enumeration_compare_recursive(
724 struct bt_field_type_common
*ft_a
,
725 struct bt_field_type_common
*ft_b
);
728 int bt_field_type_common_string_compare(struct bt_field_type_common
*ft_a
,
729 struct bt_field_type_common
*ft_b
);
732 int bt_field_type_common_structure_compare_recursive(
733 struct bt_field_type_common
*ft_a
,
734 struct bt_field_type_common
*ft_b
);
737 int bt_field_type_common_variant_compare_recursive(
738 struct bt_field_type_common
*ft_a
,
739 struct bt_field_type_common
*ft_b
);
742 int bt_field_type_common_array_compare_recursive(
743 struct bt_field_type_common
*ft_a
,
744 struct bt_field_type_common
*ft_b
);
747 int bt_field_type_common_sequence_compare_recursive(
748 struct bt_field_type_common
*ft_a
,
749 struct bt_field_type_common
*ft_b
);
752 int bt_field_type_common_compare(struct bt_field_type_common
*ft_a
,
753 struct bt_field_type_common
*ft_b
);
756 int64_t bt_field_type_common_get_field_count(struct bt_field_type_common
*ft
);
759 struct bt_field_type_common
*bt_field_type_common_borrow_field_at_index(
760 struct bt_field_type_common
*ft
, int index
);
763 int bt_field_type_common_get_field_index(struct bt_field_type_common
*ft
,
767 struct bt_field_path
*bt_field_type_common_variant_borrow_tag_field_path(
768 struct bt_field_type_common
*ft
);
771 struct bt_field_path
*bt_field_type_common_sequence_borrow_length_field_path(
772 struct bt_field_type_common
*ft
);
775 int bt_field_type_common_validate_single_clock_class(
776 struct bt_field_type_common
*ft
,
777 struct bt_clock_class
**expected_clock_class
);
780 int64_t bt_field_type_common_variant_find_choice_index(
781 struct bt_field_type_common
*ft
, uint64_t uval
,
784 #endif /* BABELTRACE_CTF_IR_FIELD_TYPES_INTERNAL_H */