Make API CTF-agnostic
[babeltrace.git] / include / babeltrace / ctf-ir / field-types-internal.h
index 70a15b0c21fd55a066e36e4936b7e2ea9dd72d75..fcefa0637c9ce019f9a88efe6c31756c410c13a2 100644 (file)
 #include <stdint.h>
 #include <glib.h>
 
-#define BT_ASSERT_PRE_FT_COMMON_HAS_ID(_ft, _type_id, _name)           \
-       BT_ASSERT_PRE(((struct bt_field_type_common *) (_ft))->id == (_type_id), \
-               _name " has the wrong type ID: expected-type-id=%s, "   \
-               "%![ft-]+_F", bt_common_field_type_id_string(_type_id), (_ft))
+#define BT_ASSERT_PRE_FT_IS_INT(_ft, _name)                            \
+       BT_ASSERT_PRE(                                                  \
+               ((struct bt_field_type *) (_ft))->id == BT_FIELD_TYPE_ID_UNSIGNED_INTEGER || \
+               ((struct bt_field_type *) (_ft))->id == BT_FIELD_TYPE_ID_SIGNED_INTEGER || \
+               ((struct bt_field_type *) (_ft))->id == BT_FIELD_TYPE_ID_UNSIGNED_ENUMERATION || \
+               ((struct bt_field_type *) (_ft))->id == BT_FIELD_TYPE_ID_SIGNED_ENUMERATION, \
+               _name " is not an integer field type: %![ft-]+F", (_ft))
+
+#define BT_ASSERT_PRE_FT_IS_UNSIGNED_INT(_ft, _name)                   \
+       BT_ASSERT_PRE(                                                  \
+               ((struct bt_field_type *) (_ft))->id == BT_FIELD_TYPE_ID_UNSIGNED_INTEGER || \
+               ((struct bt_field_type *) (_ft))->id == BT_FIELD_TYPE_ID_UNSIGNED_ENUMERATION, \
+               _name " is not an unsigned integer field type: %![ft-]+F", (_ft))
+
+#define BT_ASSERT_PRE_FT_IS_ENUM(_ft, _name)                           \
+       BT_ASSERT_PRE(                                                  \
+               ((struct bt_field_type *) (_ft))->id == BT_FIELD_TYPE_ID_UNSIGNED_ENUMERATION || \
+               ((struct bt_field_type *) (_ft))->id == BT_FIELD_TYPE_ID_SIGNED_ENUMERATION, \
+               _name " is not an enumeration field type: %![ft-]+F", (_ft))
+
+#define BT_ASSERT_PRE_FT_IS_ARRAY(_ft, _name)                          \
+       BT_ASSERT_PRE(                                                  \
+               ((struct bt_field_type *) (_ft))->id == BT_FIELD_TYPE_ID_STATIC_ARRAY || \
+               ((struct bt_field_type *) (_ft))->id == BT_FIELD_TYPE_ID_DYNAMIC_ARRAY, \
+               _name " is not an array field type: %![ft-]+F", (_ft))
+
+#define BT_ASSERT_PRE_FT_HAS_ID(_ft, _id, _name)                       \
+       BT_ASSERT_PRE(((struct bt_field_type *) (_ft))->id == (_id),    \
+               _name " has the wrong ID: expected-id=%s, "             \
+               "%![ft-]+F", bt_common_field_type_id_string(_id), (_ft))
 
 #define BT_ASSERT_PRE_FT_HOT(_ft, _name)                               \
-       BT_ASSERT_PRE_HOT((_ft), (_name), ": +%!+_F", (_ft))
+       BT_ASSERT_PRE_HOT((struct bt_field_type *) (_ft),               \
+               (_name), ": %!+F", (_ft))
 
-struct bt_field_common;
-struct bt_field_type_common;
-struct bt_field_type;
+#define BT_FIELD_TYPE_NAMED_FT_AT_INDEX(_ft, _index)           \
+       (&g_array_index(((struct bt_field_type_named_field_types_container *) (_ft))->named_fts, \
+               struct bt_named_field_type, (_index)))
 
-typedef void (*bt_field_type_common_method_freeze)(
-               struct bt_field_type_common *);
-typedef int (*bt_field_type_common_method_validate)(
-               struct bt_field_type_common *);
-typedef void (*bt_field_type_common_method_set_byte_order)(
-               struct bt_field_type_common *, enum bt_byte_order);
-typedef struct bt_field_type_common *(*bt_field_type_common_method_copy)(
-               struct bt_field_type_common *);
-typedef int (*bt_field_type_common_method_compare)(
-               struct bt_field_type_common *,
-               struct bt_field_type_common *);
-
-struct bt_field_type_common_methods {
-       bt_field_type_common_method_freeze freeze;
-       bt_field_type_common_method_validate validate;
-       bt_field_type_common_method_set_byte_order set_byte_order;
-       bt_field_type_common_method_copy copy;
-       bt_field_type_common_method_compare compare;
-};
+#define BT_FIELD_TYPE_ENUM_MAPPING_AT_INDEX(_ft, _index)               \
+       (&g_array_index(((struct bt_field_type_enumeration *) (_ft))->mappings, \
+               struct bt_field_type_enumeration_mapping, (_index)))
+
+#define BT_FIELD_TYPE_ENUM_MAPPING_RANGE_AT_INDEX(_mapping, _index)    \
+       (&g_array_index((_mapping)->ranges,                             \
+               struct bt_field_type_enumeration_mapping_range, (_index)))
+
+struct bt_field;
+struct bt_field_type;
 
-struct bt_field_type_common {
+struct bt_field_type {
        struct bt_object base;
        enum bt_field_type_id id;
-       unsigned int alignment;
-
-       /* Virtual table */
-       struct bt_field_type_common_methods *methods;
+       bool frozen;
 
        /*
-        * A type can't be modified once it is added to an event or after a
-        * a field has been instanciated from it.
+        * Only used in developer mode, this flag indicates whether or
+        * not this field type is part of a trace.
         */
-       int frozen;
+       bool part_of_trace;
+};
 
-       /*
-        * This flag indicates if the field type is valid. A valid
-        * field type is _always_ frozen. All the nested field types of
-        * a valid field type are also valid (and thus frozen).
-        */
-       int valid;
+struct bt_field_type_integer {
+       struct bt_field_type common;
 
        /*
-        * Specialized data for either CTF IR or CTF writer APIs.
-        * Having this here ensures that:
-        *
-        * * The type-specific common data is always found at the same
-        *   offset when the common API has a `struct
-        *   bt_field_type_common *` so that you can cast it to `struct
-        *   bt_field_type_common_integer *` for example and access the
-        *   common integer field type fields.
+        * Value range of fields built from this integer field type:
+        * this is an equivalent integer size in bits. More formally,
+        * `range` is `n` in:
         *
-        * * The specific CTF IR and CTF writer APIs can access their
-        *   specific field type fields in this union at an offset known
-        *   at build time. This avoids a pointer to specific data so
-        *   that all the fields, common or specific, of a CTF IR
-        *   integer field type or of a CTF writer integer field type,
-        *   for example, are contained within the same contiguous block
-        *   of memory.
+        * Unsigned range: [0, 2^n - 1]
+        * Signed range: [-2^(n - 1), 2^(n - 1) - 1]
         */
-       union {
-               struct {
-               } ir;
-               struct {
-                       void *serialize_func;
-               } writer;
-       } spec;
-};
+       uint64_t range;
 
-struct bt_field_type_common_integer {
-       struct bt_field_type_common common;
-       struct bt_clock_class *mapped_clock_class;
-       enum bt_byte_order user_byte_order;
-       bt_bool is_signed;
-       unsigned int size;
-       enum bt_integer_base base;
-       enum bt_string_encoding encoding;
+       enum bt_field_type_integer_preferred_display_base base;
 };
 
-struct enumeration_mapping {
+struct bt_field_type_enumeration_mapping_range {
        union {
-               uint64_t _unsigned;
-               int64_t _signed;
-       } range_start;
+               uint64_t u;
+               int64_t i;
+       } lower;
 
        union {
-               uint64_t _unsigned;
-               int64_t _signed;
-       } range_end;
-       GQuark string;
+               uint64_t u;
+               int64_t i;
+       } upper;
 };
 
-struct bt_field_type_common_enumeration {
-       struct bt_field_type_common common;
-       struct bt_field_type_common_integer *container_ft;
-       GPtrArray *entries; /* Array of ptrs to struct enumeration_mapping */
-       /* Only set during validation. */
-       bt_bool has_overlapping_ranges;
-};
-
-enum bt_field_type_enumeration_mapping_iterator_type {
-       ITERATOR_BY_NAME,
-       ITERATOR_BY_SIGNED_VALUE,
-       ITERATOR_BY_UNSIGNED_VALUE,
-};
+struct bt_field_type_enumeration_mapping {
+       GString *label;
 
-struct bt_field_type_enumeration_mapping_iterator {
-       struct bt_object base;
-       struct bt_field_type_common_enumeration *enumeration_ft;
-       enum bt_field_type_enumeration_mapping_iterator_type type;
-       int index;
-       union {
-               GQuark name_quark;
-               int64_t signed_value;
-               uint64_t unsigned_value;
-       } u;
+       /* Array of `struct bt_field_type_enumeration_mapping_range` */
+       GArray *ranges;
 };
 
-struct bt_field_type_common_floating_point {
-       struct bt_field_type_common common;
-       enum bt_byte_order user_byte_order;
-       unsigned int exp_dig;
-       unsigned int mant_dig;
-};
+struct bt_field_type_enumeration {
+       struct bt_field_type_integer common;
 
-struct structure_field_common {
-       struct bt_field_type_common common;
-       GQuark name;
-       struct bt_field_type_common *type;
-};
+       /* Array of `struct bt_field_type_enumeration_mapping *` */
+       GArray *mappings;
 
-struct bt_field_type_common_structure {
-       struct bt_field_type_common common;
-       GHashTable *field_name_to_index;
-       GPtrArray *fields; /* Array of pointers to struct structure_field_common */
+       /*
+        * This is an array of `const char *` which acts as a temporary
+        * (potentially growing) buffer for
+        * bt_field_type_unsigned_enumeration_get_mapping_labels_by_value()
+        * and
+        * bt_field_type_signed_enumeration_get_mapping_labels_by_value().
+        *
+        * The actual strings are owned by the mappings above.
+        */
+       GPtrArray *label_buf;
 };
 
-struct bt_field_type_common_variant {
-       struct bt_field_type_common common;
-       GString *tag_name;
-       struct bt_field_type_common_enumeration *tag_ft;
-       struct bt_field_path *tag_field_path;
-       GHashTable *field_name_to_index;
-       GPtrArray *fields; /* Array of pointers to struct structure_field_common */
+struct bt_field_type_real {
+       struct bt_field_type common;
+       bool is_single_precision;
 };
 
-struct bt_field_type_common_array {
-       struct bt_field_type_common common;
-       struct bt_field_type_common *element_ft;
-       unsigned int length; /* Number of elements */
+struct bt_field_type_string {
+       struct bt_field_type common;
 };
 
-struct bt_field_type_common_sequence {
-       struct bt_field_type_common common;
-       struct bt_field_type_common *element_ft;
-       GString *length_field_name;
-       struct bt_field_path *length_field_path;
-};
+/* A named field type is a (name, field type) pair */
+struct bt_named_field_type {
+       GString *name;
 
-struct bt_field_type_common_string {
-       struct bt_field_type_common common;
-       enum bt_string_encoding encoding;
+       /* Owned by this */
+       struct bt_field_type *ft;
 };
 
-#ifdef BT_DEV_MODE
-# define bt_field_type_freeze          _bt_field_type_freeze
-# define bt_field_type_common_freeze   _bt_field_type_common_freeze
-#else
-# define bt_field_type_freeze(_ft)
-# define bt_field_type_common_freeze(_ft)
-#endif
-
-typedef struct bt_field_common *(* bt_field_common_create_func)(
-               struct bt_field_type_common *);
-
-BT_HIDDEN
-void bt_field_type_common_initialize(struct bt_field_type_common *ft,
-               bool init_bo, bt_object_release_func release_func,
-               struct bt_field_type_common_methods *methods);
-
-BT_HIDDEN
-void bt_field_type_common_integer_initialize(
-               struct bt_field_type_common *ft,
-               unsigned int size, bt_object_release_func release_func,
-               struct bt_field_type_common_methods *methods);
-
-BT_HIDDEN
-void bt_field_type_common_floating_point_initialize(
-               struct bt_field_type_common *ft,
-               bt_object_release_func release_func,
-               struct bt_field_type_common_methods *methods);
-
-BT_HIDDEN
-void bt_field_type_common_enumeration_initialize(
-               struct bt_field_type_common *ft,
-               struct bt_field_type_common *container_ft,
-               bt_object_release_func release_func,
-               struct bt_field_type_common_methods *methods);
-
-BT_HIDDEN
-void bt_field_type_common_string_initialize(
-               struct bt_field_type_common *ft,
-               bt_object_release_func release_func,
-               struct bt_field_type_common_methods *methods);
-
-BT_HIDDEN
-void bt_field_type_common_structure_initialize(
-               struct bt_field_type_common *ft,
-               bt_object_release_func release_func,
-               struct bt_field_type_common_methods *methods);
-
-BT_HIDDEN
-void bt_field_type_common_array_initialize(
-               struct bt_field_type_common *ft,
-               struct bt_field_type_common *element_ft,
-               unsigned int length, bt_object_release_func release_func,
-               struct bt_field_type_common_methods *methods);
-
-BT_HIDDEN
-void bt_field_type_common_sequence_initialize(
-               struct bt_field_type_common *ft,
-               struct bt_field_type_common *element_ft,
-               const char *length_field_name,
-               bt_object_release_func release_func,
-               struct bt_field_type_common_methods *methods);
-
-BT_HIDDEN
-void bt_field_type_common_variant_initialize(
-               struct bt_field_type_common *ft,
-               struct bt_field_type_common *tag_ft,
-               const char *tag_name,
-               bt_object_release_func release_func,
-               struct bt_field_type_common_methods *methods);
-
-BT_HIDDEN
-void bt_field_type_common_integer_destroy(struct bt_object *obj);
-
-BT_HIDDEN
-void bt_field_type_common_floating_point_destroy(struct bt_object *obj);
-
-BT_HIDDEN
-void bt_field_type_common_enumeration_destroy_recursive(struct bt_object *obj);
-
-BT_HIDDEN
-void bt_field_type_common_string_destroy(struct bt_object *obj);
-
-BT_HIDDEN
-void bt_field_type_common_structure_destroy_recursive(struct bt_object *obj);
-
-BT_HIDDEN
-void bt_field_type_common_array_destroy_recursive(struct bt_object *obj);
-
-BT_HIDDEN
-void bt_field_type_common_sequence_destroy_recursive(struct bt_object *obj);
-
-BT_HIDDEN
-void bt_field_type_common_variant_destroy_recursive(struct bt_object *obj);
-
-BT_HIDDEN
-int bt_field_type_common_integer_validate(struct bt_field_type_common *ft);
-
-BT_HIDDEN
-int bt_field_type_common_enumeration_validate_recursive(
-               struct bt_field_type_common *ft);
-
-BT_HIDDEN
-int bt_field_type_common_sequence_validate_recursive(
-               struct bt_field_type_common *ft);
-
-BT_HIDDEN
-int bt_field_type_common_array_validate_recursive(
-               struct bt_field_type_common *ft);
-
-BT_HIDDEN
-int bt_field_type_common_structure_validate_recursive(
-               struct bt_field_type_common *ft);
-
-BT_HIDDEN
-int bt_field_type_common_variant_validate_recursive(
-               struct bt_field_type_common *type);
-
-BT_HIDDEN
-int bt_field_type_common_validate(struct bt_field_type_common *ft);
-
-BT_HIDDEN
-int bt_field_type_common_integer_get_size(struct bt_field_type_common *ft);
-
-BT_HIDDEN
-bt_bool bt_field_type_common_integer_is_signed(struct bt_field_type_common *ft);
-
-BT_HIDDEN
-int bt_field_type_common_integer_set_is_signed(struct bt_field_type_common *ft,
-               bt_bool is_signed);
-
-BT_HIDDEN
-int bt_field_type_common_integer_set_size(struct bt_field_type_common *ft,
-               unsigned int size);
-
-BT_HIDDEN
-enum bt_integer_base bt_field_type_common_integer_get_base(
-               struct bt_field_type_common *ft);
-
-BT_HIDDEN
-int bt_field_type_common_integer_set_base(struct bt_field_type_common *ft,
-               enum bt_integer_base base);
-
-BT_HIDDEN
-enum bt_string_encoding bt_field_type_common_integer_get_encoding(
-               struct bt_field_type_common *ft);
-
-BT_HIDDEN
-int bt_field_type_common_integer_set_encoding(struct bt_field_type_common *ft,
-               enum bt_string_encoding encoding);
-
-BT_HIDDEN
-struct bt_clock_class *bt_field_type_common_integer_get_mapped_clock_class(
-               struct bt_field_type_common *ft);
-
-BT_HIDDEN
-int bt_field_type_common_integer_set_mapped_clock_class_no_check_frozen(
-               struct bt_field_type_common *ft,
-               struct bt_clock_class *clock_class);
-
-BT_HIDDEN
-int bt_field_type_common_integer_set_mapped_clock_class(
-               struct bt_field_type_common *ft,
-               struct bt_clock_class *clock_class);
-
-BT_HIDDEN
-struct bt_field_type_enumeration_mapping_iterator *
-bt_field_type_common_enumeration_find_mappings_by_name(
-               struct bt_field_type_common *ft, const char *name);
-
-BT_HIDDEN
-struct bt_field_type_enumeration_mapping_iterator *
-bt_field_type_common_enumeration_signed_find_mappings_by_value(
-               struct bt_field_type_common *ft, int64_t value);
-
-BT_HIDDEN
-struct bt_field_type_enumeration_mapping_iterator *
-bt_field_type_common_enumeration_unsigned_find_mappings_by_value(
-               struct bt_field_type_common *ft, uint64_t value);
-
-BT_HIDDEN
-int bt_field_type_common_enumeration_signed_get_mapping_by_index(
-               struct bt_field_type_common *ft, uint64_t index,
-               const char **mapping_name, int64_t *range_begin,
-               int64_t *range_end);
-
-BT_HIDDEN
-int bt_field_type_common_enumeration_unsigned_get_mapping_by_index(
-               struct bt_field_type_common *ft, uint64_t index,
-               const char **mapping_name, uint64_t *range_begin,
-               uint64_t *range_end);
-
-BT_HIDDEN
-struct bt_field_type_common *bt_field_type_common_enumeration_get_container_field_type(
-               struct bt_field_type_common *ft);
-
-BT_HIDDEN
-int bt_field_type_common_enumeration_signed_add_mapping(
-               struct bt_field_type_common *ft, const char *string,
-               int64_t range_start, int64_t range_end);
-
-BT_HIDDEN
-int bt_field_type_common_enumeration_unsigned_add_mapping(
-               struct bt_field_type_common *ft, const char *string,
-               uint64_t range_start, uint64_t range_end);
-
-BT_HIDDEN
-int64_t bt_field_type_common_enumeration_get_mapping_count(
-               struct bt_field_type_common *ft);
-
-BT_HIDDEN
-int bt_field_type_common_floating_point_get_exponent_digits(
-               struct bt_field_type_common *ft);
-
-BT_HIDDEN
-int bt_field_type_common_floating_point_set_exponent_digits(
-               struct bt_field_type_common *ft,
-               unsigned int exponent_digits);
-
-BT_HIDDEN
-int bt_field_type_common_floating_point_get_mantissa_digits(
-               struct bt_field_type_common *type);
-
-BT_HIDDEN
-int bt_field_type_common_floating_point_set_mantissa_digits(
-               struct bt_field_type_common *ft, unsigned int mantissa_digits);
-
-BT_HIDDEN
-int bt_field_type_common_structure_replace_field(
-               struct bt_field_type_common *ft,
-               const char *field_name,
-               struct bt_field_type_common *field_type);
-
-BT_HIDDEN
-int bt_field_type_common_structure_add_field(struct bt_field_type_common *ft,
-               struct bt_field_type_common *field_type,
-               const char *field_name);
-
-BT_HIDDEN
-int64_t bt_field_type_common_structure_get_field_count(
-               struct bt_field_type_common *ft);
-
-BT_HIDDEN
-int bt_field_type_common_structure_get_field_by_index(
-               struct bt_field_type_common *ft,
-               const char **field_name,
-               struct bt_field_type_common **field_type, uint64_t index);
-
-BT_HIDDEN
-struct bt_field_type_common *bt_field_type_common_structure_get_field_type_by_name(
-               struct bt_field_type_common *ft, const char *name);
-
-BT_HIDDEN
-struct bt_field_type_common *bt_field_type_common_variant_get_tag_field_type(
-               struct bt_field_type_common *ft);
-
-BT_HIDDEN
-const char *bt_field_type_common_variant_get_tag_name(
-               struct bt_field_type_common *ft);
-
-BT_HIDDEN
-int bt_field_type_common_variant_set_tag_name(
-               struct bt_field_type_common *ft, const char *name);
-
-BT_HIDDEN
-int bt_field_type_common_variant_add_field(struct bt_field_type_common *ft,
-               struct bt_field_type_common *field_type,
-               const char *field_name);
-
-BT_HIDDEN
-struct bt_field_type_common *bt_field_type_common_variant_get_field_type_by_name(
-               struct bt_field_type_common *ft,
-               const char *field_name);
-
-BT_HIDDEN
-struct bt_field_type_common *bt_field_type_common_variant_get_field_type_from_tag(
-               struct bt_field_type_common *ft,
-               struct bt_field_common *tag_field,
-               bt_field_common_create_func field_create_func);
-
-BT_HIDDEN
-int64_t bt_field_type_common_variant_get_field_count(
-               struct bt_field_type_common *ft);
-
-BT_HIDDEN
-int bt_field_type_common_variant_get_field_by_index(
-               struct bt_field_type_common *ft,
-               const char **field_name,
-               struct bt_field_type_common **field_type, uint64_t index);
-
-BT_HIDDEN
-struct bt_field_type_common *bt_field_type_common_array_get_element_field_type(
-               struct bt_field_type_common *ft);
-
-BT_HIDDEN
-int bt_field_type_common_array_set_element_field_type(
-               struct bt_field_type_common *ft,
-               struct bt_field_type_common *element_ft);
-
-BT_HIDDEN
-int64_t bt_field_type_common_array_get_length(struct bt_field_type_common *ft);
-
-BT_HIDDEN
-struct bt_field_type_common *bt_field_type_common_sequence_get_element_field_type(
-               struct bt_field_type_common *ft);
-
-BT_HIDDEN
-int bt_field_type_common_sequence_set_element_field_type(
-               struct bt_field_type_common *ft,
-               struct bt_field_type_common *element_ft);
-
-BT_HIDDEN
-const char *bt_field_type_common_sequence_get_length_field_name(
-               struct bt_field_type_common *ft);
-
-BT_HIDDEN
-enum bt_string_encoding bt_field_type_common_string_get_encoding(
-               struct bt_field_type_common *ft);
-
-BT_HIDDEN
-int bt_field_type_common_string_set_encoding(struct bt_field_type_common *ft,
-               enum bt_string_encoding encoding);
-
-BT_HIDDEN
-int bt_field_type_common_get_alignment(struct bt_field_type_common *type);
-
-BT_HIDDEN
-int bt_field_type_common_set_alignment(struct bt_field_type_common *ft,
-               unsigned int alignment);
-
-BT_HIDDEN
-enum bt_byte_order bt_field_type_common_get_byte_order(
-               struct bt_field_type_common *ft);
-
-BT_HIDDEN
-int bt_field_type_common_set_byte_order(struct bt_field_type_common *ft,
-               enum bt_byte_order byte_order);
-
-BT_HIDDEN
-enum bt_field_type_id bt_field_type_common_get_type_id(
-               struct bt_field_type_common *ft);
-
-BT_HIDDEN
-void _bt_field_type_common_freeze(struct bt_field_type_common *ft);
-
-BT_HIDDEN
-void _bt_field_type_freeze(struct bt_field_type *ft);
-
-BT_HIDDEN
-struct bt_field_type_common *bt_field_type_common_variant_get_field_type_signed(
-               struct bt_field_type_common_variant *var_ft,
-               int64_t tag_value);
-
-BT_HIDDEN
-struct bt_field_type_common *bt_field_type_common_variant_get_field_type_unsigned(
-               struct bt_field_type_common_variant *var_ft,
-               uint64_t tag_value);
-
-BT_HIDDEN
-struct bt_field_type_common *bt_field_type_common_copy(
-               struct bt_field_type_common *ft);
-
-BT_HIDDEN
-int bt_field_type_common_structure_get_field_name_index(
-               struct bt_field_type_common *ft, const char *name);
-
-BT_HIDDEN
-int bt_field_type_common_variant_get_field_name_index(
-               struct bt_field_type_common *ft, const char *name);
-
-BT_HIDDEN
-int bt_field_type_common_sequence_set_length_field_path(
-               struct bt_field_type_common *ft, struct bt_field_path *path);
-
-BT_HIDDEN
-int bt_field_type_common_variant_set_tag_field_path(
-               struct bt_field_type_common *ft,
-               struct bt_field_path *path);
-
-BT_HIDDEN
-int bt_field_type_common_variant_set_tag_field_type(
-               struct bt_field_type_common *ft,
-               struct bt_field_type_common *tag_ft);
-
-BT_HIDDEN
-void bt_field_type_common_generic_freeze(struct bt_field_type_common *ft);
-
-BT_HIDDEN
-void bt_field_type_common_enumeration_freeze_recursive(
-               struct bt_field_type_common *ft);
-
-BT_HIDDEN
-void bt_field_type_common_structure_freeze_recursive(
-               struct bt_field_type_common *ft);
-
-BT_HIDDEN
-void bt_field_type_common_variant_freeze_recursive(
-               struct bt_field_type_common *ft);
-
-BT_HIDDEN
-void bt_field_type_common_array_freeze_recursive(
-               struct bt_field_type_common *ft);
-
-BT_HIDDEN
-void bt_field_type_common_sequence_freeze_recursive(
-               struct bt_field_type_common *type);
-
-BT_HIDDEN
-void bt_field_type_common_integer_set_byte_order(
-               struct bt_field_type_common *ft, enum bt_byte_order byte_order);
-
-BT_HIDDEN
-void bt_field_type_common_enumeration_set_byte_order_recursive(
-               struct bt_field_type_common *ft, enum bt_byte_order byte_order);
-
-BT_HIDDEN
-void bt_field_type_common_floating_point_set_byte_order(
-               struct bt_field_type_common *ft, enum bt_byte_order byte_order);
-
-BT_HIDDEN
-void bt_field_type_common_structure_set_byte_order_recursive(
-               struct bt_field_type_common *ft,
-               enum bt_byte_order byte_order);
-
-BT_HIDDEN
-void bt_field_type_common_variant_set_byte_order_recursive(
-               struct bt_field_type_common *ft,
-               enum bt_byte_order byte_order);
+/*
+ * This is the base field type for a container of named field types.
+ * Structure and variant field types inherit this.
+ */
+struct bt_field_type_named_field_types_container {
+       struct bt_field_type common;
 
-BT_HIDDEN
-void bt_field_type_common_array_set_byte_order_recursive(
-               struct bt_field_type_common *ft,
-               enum bt_byte_order byte_order);
+       /*
+        * Key: `const char *`, not owned by this (owned by named field
+        * type objects contained in `named_fts` below).
+        */
+       GHashTable *name_to_index;
 
-BT_HIDDEN
-void bt_field_type_common_sequence_set_byte_order_recursive(
-               struct bt_field_type_common *ft,
-               enum bt_byte_order byte_order);
+       /* Array of `struct bt_named_field_type` */
+       GArray *named_fts;
+};
 
-BT_HIDDEN
-int bt_field_type_common_integer_compare(struct bt_field_type_common *ft_a,
-               struct bt_field_type_common *ft_b);
+struct bt_field_type_structure {
+       struct bt_field_type_named_field_types_container common;
+};
 
-BT_HIDDEN
-int bt_field_type_common_floating_point_compare(
-               struct bt_field_type_common *ft_a,
-               struct bt_field_type_common *ft_b);
+struct bt_field_type_array {
+       struct bt_field_type common;
 
-BT_HIDDEN
-int bt_field_type_common_enumeration_compare_recursive(
-               struct bt_field_type_common *ft_a,
-               struct bt_field_type_common *ft_b);
+       /* Owned by this */
+       struct bt_field_type *element_ft;
+};
 
-BT_HIDDEN
-int bt_field_type_common_string_compare(struct bt_field_type_common *ft_a,
-               struct bt_field_type_common *ft_b);
+struct bt_field_type_static_array {
+       struct bt_field_type_array common;
+       uint64_t length;
+};
 
-BT_HIDDEN
-int bt_field_type_common_structure_compare_recursive(
-               struct bt_field_type_common *ft_a,
-               struct bt_field_type_common *ft_b);
+struct bt_field_type_dynamic_array {
+       struct bt_field_type_array common;
 
-BT_HIDDEN
-int bt_field_type_common_variant_compare_recursive(
-               struct bt_field_type_common *ft_a,
-               struct bt_field_type_common *ft_b);
+       /* Weak: never dereferenced, only use to find it elsewhere */
+       struct bt_field_type *length_ft;
 
-BT_HIDDEN
-int bt_field_type_common_array_compare_recursive(
-               struct bt_field_type_common *ft_a,
-               struct bt_field_type_common *ft_b);
+       /* Owned by this */
+       struct bt_field_path *length_field_path;
+};
 
-BT_HIDDEN
-int bt_field_type_common_sequence_compare_recursive(
-               struct bt_field_type_common *ft_a,
-               struct bt_field_type_common *ft_b);
+struct bt_field_type_variant {
+       struct bt_field_type_named_field_types_container common;
 
-BT_HIDDEN
-int bt_field_type_common_compare(struct bt_field_type_common *ft_a,
-               struct bt_field_type_common *ft_b);
+       /* Weak: never dereferenced, only use to find it elsewhere */
+       struct bt_field_type *selector_ft;
 
-BT_HIDDEN
-int64_t bt_field_type_common_get_field_count(struct bt_field_type_common *ft);
+       /* Owned by this */
+       struct bt_field_path *selector_field_path;
+};
 
-BT_HIDDEN
-struct bt_field_type_common *bt_field_type_common_get_field_at_index(
-               struct bt_field_type_common *ft, int index);
+static inline
+bool bt_field_type_has_known_id(struct bt_field_type *ft)
+{
+       return ft->id >= BT_FIELD_TYPE_ID_UNSIGNED_INTEGER &&
+               ft->id <= BT_FIELD_TYPE_ID_VARIANT;
+}
 
 BT_HIDDEN
-int bt_field_type_common_get_field_index(struct bt_field_type_common *ft,
-               const char *name);
+void _bt_field_type_freeze(struct bt_field_type *field_type);
 
-BT_HIDDEN
-struct bt_field_path *bt_field_type_common_variant_get_tag_field_path(
-               struct bt_field_type_common *ft);
+#ifdef BT_DEV_MODE
+# define bt_field_type_freeze          _bt_field_type_freeze
+#else
+# define bt_field_type_freeze(_ft)
+#endif
 
+/*
+ * This function recursively marks `field_type` and its children as
+ * being part of a trace. This is used to validate that all field types
+ * are used at a single location within trace objects even if they are
+ * shared objects for other purposes.
+ */
 BT_HIDDEN
-struct bt_field_path *bt_field_type_common_sequence_get_length_field_path(
-               struct bt_field_type_common *ft);
+void _bt_field_type_make_part_of_trace(struct bt_field_type *field_type);
 
-BT_HIDDEN
-int bt_field_type_common_validate_single_clock_class(
-               struct bt_field_type_common *ft,
-               struct bt_clock_class **expected_clock_class);
+#ifdef BT_DEV_MODE
+# define bt_field_type_make_part_of_trace      _bt_field_type_make_part_of_trace
+#else
+# define bt_field_type_make_part_of_trace(_ft) ((void) _ft)
+#endif
 
 #endif /* BABELTRACE_CTF_IR_FIELD_TYPES_INTERNAL_H */
This page took 0.032408 seconds and 4 git commands to generate.