* SOFTWARE.
*/
-#include <babeltrace/ctf-writer/event-types.h>
-#include <babeltrace/ctf-writer/event-fields.h>
-#include <babeltrace/ctf-writer/writer.h>
-#include <babeltrace/ctf-ir/trace-internal.h>
+#include <babeltrace/assert-pre-internal.h>
+#include <babeltrace/ctf-ir/clock-class.h>
+#include <babeltrace/ctf-ir/field-types.h>
#include <babeltrace/babeltrace-internal.h>
#include <babeltrace/object-internal.h>
#include <babeltrace/types.h>
-#include <babeltrace/ctf/events.h>
+#include <stdint.h>
#include <glib.h>
-typedef void (*type_freeze_func)(struct bt_ctf_field_type *);
-typedef int (*type_serialize_func)(struct bt_ctf_field_type *,
- struct metadata_context *);
+#define BT_ASSERT_PRE_FT_HAS_ID(_ft, _type_id, _name) \
+ BT_ASSERT_PRE(((struct bt_field_type *) (_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_HOT(_ft, _name) \
+ BT_ASSERT_PRE_HOT((_ft), (_name), ": %!+F", (_ft))
+
+#define BT_FIELD_TYPE_STRUCTURE_FIELD_AT_INDEX(_ft, _index) \
+ (&g_array_index(((struct bt_field_type_structure *) (_ft))->fields, \
+ struct bt_field_type_structure_field, (_index)))
+
+#define BT_FIELD_TYPE_VARIANT_CHOICE_AT_INDEX(_ft, _index) \
+ (&g_array_index(((struct bt_field_type_variant *) (_ft))->choices, \
+ struct bt_field_type_variant_choice, (_index)))
+
+struct bt_field;
+struct bt_field_type;
+
+typedef void (*bt_field_type_method_freeze)(
+ struct bt_field_type *);
+typedef int (*bt_field_type_method_validate)(
+ struct bt_field_type *);
+typedef void (*bt_field_type_method_set_byte_order)(
+ struct bt_field_type *, enum bt_byte_order);
+typedef struct bt_field_type *(*bt_field_type_method_copy)(
+ struct bt_field_type *);
+typedef int (*bt_field_type_method_compare)(
+ struct bt_field_type *,
+ struct bt_field_type *);
+
+struct bt_field_type_methods {
+ bt_field_type_method_freeze freeze;
+ bt_field_type_method_validate validate;
+ bt_field_type_method_set_byte_order set_byte_order;
+ bt_field_type_method_copy copy;
+ bt_field_type_method_compare compare;
+};
-struct bt_ctf_field_type {
+struct bt_field_type {
struct bt_object base;
- struct bt_declaration *declaration;
- type_freeze_func freeze;
- type_serialize_func serialize;
+ enum bt_field_type_id id;
+ unsigned int alignment;
+
+ /* Virtual table */
+ struct bt_field_type_methods *methods;
+
/*
* A type can't be modified once it is added to an event or after a
* a field has been instanciated from it.
int valid;
};
-struct bt_ctf_field_type_integer {
- struct bt_ctf_field_type parent;
- struct declaration_integer declaration;
- struct bt_ctf_clock *mapped_clock;
+struct bt_field_type_integer {
+ struct bt_field_type common;
- /*
- * This is what the user sets and is never modified by internal
- * code.
- *
- * This field must contain a `BT_CTF_BYTE_ORDER_*` value.
- */
- enum bt_ctf_byte_order user_byte_order;
+ /* Owned by this */
+ 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;
};
struct enumeration_mapping {
uint64_t _unsigned;
int64_t _signed;
} range_start;
-
union {
uint64_t _unsigned;
int64_t _signed;
GQuark string;
};
-struct bt_ctf_field_type_enumeration {
- struct bt_ctf_field_type parent;
- struct bt_ctf_field_type *container;
- GPtrArray *entries; /* Array of ptrs to struct enumeration_mapping */
- struct declaration_enum declaration;
+struct bt_field_type_enumeration {
+ struct bt_field_type common;
+
+ /* Owned by this */
+ struct bt_field_type_integer *container_ft;
+
+ /* Array of `struct enumeration_mapping *`, owned by this */
+ GPtrArray *entries;
+
+ /* Only set during validation */
+ bt_bool has_overlapping_ranges;
};
-struct bt_ctf_field_type_floating_point {
- struct bt_ctf_field_type parent;
- struct declaration_float declaration;
+enum bt_field_type_enumeration_mapping_iterator_type {
+ ITERATOR_BY_NAME,
+ ITERATOR_BY_SIGNED_VALUE,
+ ITERATOR_BY_UNSIGNED_VALUE,
+};
- /*
- * The `declaration` field above contains 3 pointers pointing
- * to the fields below. This avoids unnecessary dynamic
- * allocations.
- */
- struct declaration_integer sign;
- struct declaration_integer mantissa;
- struct declaration_integer exp;
+struct bt_field_type_enumeration_mapping_iterator {
+ struct bt_object base;
- /*
- * This is what the user sets and is never modified by internal
- * code.
- *
- * This field must contain a `BT_CTF_BYTE_ORDER_*` value.
- */
- enum bt_ctf_byte_order user_byte_order;
+ /* Owned by this */
+ struct bt_field_type_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;
};
-struct structure_field {
- GQuark name;
- struct bt_ctf_field_type *type;
+struct bt_field_type_floating_point {
+ struct bt_field_type common;
+ enum bt_byte_order user_byte_order;
+ unsigned int exp_dig;
+ unsigned int mant_dig;
};
-struct bt_ctf_field_type_structure {
- struct bt_ctf_field_type parent;
- GHashTable *field_name_to_index;
- GPtrArray *fields; /* Array of pointers to struct structure_field */
- struct declaration_struct declaration;
+struct bt_field_type_structure_field {
+ GQuark name;
+
+ /* Owned by this */
+ struct bt_field_type *type;
};
-struct bt_ctf_field_type_variant {
- struct bt_ctf_field_type parent;
- GString *tag_name;
- struct bt_ctf_field_type_enumeration *tag;
- struct bt_ctf_field_path *tag_field_path;
+struct bt_field_type_structure {
+ struct bt_field_type common;
GHashTable *field_name_to_index;
- GPtrArray *fields; /* Array of pointers to struct structure_field */
- struct declaration_variant declaration;
+
+ /*
+ * Array of `struct bt_field_type_structure_field`,
+ * owned by this
+ */
+ GArray *fields;
};
-struct bt_ctf_field_type_array {
- struct bt_ctf_field_type parent;
- struct bt_ctf_field_type *element_type;
- unsigned int length; /* Number of elements */
- struct declaration_array declaration;
+struct bt_field_type_variant_choice_range {
+ union {
+ int64_t i;
+ uint64_t u;
+ } lower;
+ union {
+ int64_t i;
+ uint64_t u;
+ } upper;
};
-struct bt_ctf_field_type_sequence {
- struct bt_ctf_field_type parent;
- struct bt_ctf_field_type *element_type;
- GString *length_field_name;
- struct bt_ctf_field_path *length_field_path;
- struct declaration_sequence declaration;
+struct bt_field_type_variant_choice {
+ GQuark name;
+
+ /* Owned by this */
+ struct bt_field_type *type;
+
+ /* Array of `struct bt_field_type_variant_choice_range` */
+ GArray *ranges;
};
-struct bt_ctf_field_type_string {
- struct bt_ctf_field_type parent;
- struct declaration_string declaration;
+struct bt_field_type_variant {
+ struct bt_field_type common;
+ GString *tag_name;
+ bool choices_up_to_date;
+
+ /* Owned by this */
+ struct bt_field_type_enumeration *tag_ft;
+
+ /* Owned by this */
+ struct bt_field_path *tag_field_path;
+
+ GHashTable *choice_name_to_index;
+
+ /*
+ * Array of `struct bt_field_type_variant_choice`,
+ * owned by this */
+ GArray *choices;
};
-BT_HIDDEN
-void bt_ctf_field_type_freeze(struct bt_ctf_field_type *type);
+struct bt_field_type_array {
+ struct bt_field_type common;
-BT_HIDDEN
-struct bt_ctf_field_type *bt_ctf_field_type_variant_get_field_type_signed(
- struct bt_ctf_field_type_variant *variant, int64_t tag_value);
+ /* Owned by this */
+ struct bt_field_type *element_ft;
-BT_HIDDEN
-struct bt_ctf_field_type *bt_ctf_field_type_variant_get_field_type_unsigned(
- struct bt_ctf_field_type_variant *variant, uint64_t tag_value);
+ unsigned int length;
+};
-BT_HIDDEN
-int bt_ctf_field_type_serialize(struct bt_ctf_field_type *type,
- struct metadata_context *context);
+struct bt_field_type_sequence {
+ struct bt_field_type common;
-BT_HIDDEN
-int bt_ctf_field_type_validate(struct bt_ctf_field_type *type);
+ /* Owned by this */
+ struct bt_field_type *element_ft;
-BT_HIDDEN
-const char *bt_ctf_field_type_enumeration_get_mapping_name_unsigned(
- struct bt_ctf_field_type_enumeration *enumeration_type,
- uint64_t value);
+ GString *length_field_name;
-BT_HIDDEN
-const char *bt_ctf_field_type_enumeration_get_mapping_name_signed(
- struct bt_ctf_field_type_enumeration *enumeration_type,
- int64_t value);
+ /* Owned by this */
+ struct bt_field_path *length_field_path;
+};
-/* Override field type's byte order only if it is set to "native" */
-BT_HIDDEN
-void bt_ctf_field_type_set_native_byte_order(
- struct bt_ctf_field_type *type, int byte_order);
+struct bt_field_type_string {
+ struct bt_field_type common;
+ enum bt_string_encoding encoding;
+};
-BT_HIDDEN
-int bt_ctf_field_type_structure_get_field_name_index(
- struct bt_ctf_field_type *structure, const char *name);
+typedef struct bt_field *(* bt_field_create_func)(
+ struct bt_field_type *);
+
+BT_ASSERT_FUNC
+static inline bool bt_field_type_has_known_id(
+ struct bt_field_type *ft)
+{
+ return (int) ft->id > BT_FIELD_TYPE_ID_UNKNOWN ||
+ (int) ft->id < BT_FIELD_TYPE_ID_NR;
+}
-/* Replace an existing field's type in a structure */
BT_HIDDEN
-int bt_ctf_field_type_structure_set_field_index(
- struct bt_ctf_field_type *structure,
- struct bt_ctf_field_type *field, int index);
+int bt_field_type_variant_update_choices(
+ struct bt_field_type *ft);
BT_HIDDEN
-int bt_ctf_field_type_variant_get_field_name_index(
- struct bt_ctf_field_type *variant, const char *name);
+void bt_field_type_freeze(struct bt_field_type *ft);
BT_HIDDEN
-int bt_ctf_field_type_sequence_set_length_field_path(
- struct bt_ctf_field_type *type,
- struct bt_ctf_field_path *path);
+int bt_field_type_validate(struct bt_field_type *ft);
BT_HIDDEN
-int bt_ctf_field_type_variant_set_tag_field_path(struct bt_ctf_field_type *type,
- struct bt_ctf_field_path *path);
+int bt_field_type_sequence_set_length_field_path(
+ struct bt_field_type *ft, struct bt_field_path *path);
BT_HIDDEN
-int bt_ctf_field_type_variant_set_tag_field_type(struct bt_ctf_field_type *type,
- struct bt_ctf_field_type *tag_type);
+int bt_field_type_variant_set_tag_field_path(
+ struct bt_field_type *ft,
+ struct bt_field_path *path);
-/* Replace an existing field's type in a variant */
BT_HIDDEN
-int bt_ctf_field_type_variant_set_field_index(
- struct bt_ctf_field_type *variant,
- struct bt_ctf_field_type *field, int index);
+int bt_field_type_variant_set_tag_field_type(
+ struct bt_field_type *ft,
+ struct bt_field_type *tag_ft);
BT_HIDDEN
-int bt_ctf_field_type_array_set_element_type(struct bt_ctf_field_type *array,
- struct bt_ctf_field_type *element_type);
+int64_t bt_field_type_get_field_count(struct bt_field_type *ft);
BT_HIDDEN
-int bt_ctf_field_type_sequence_set_element_type(struct bt_ctf_field_type *array,
- struct bt_ctf_field_type *element_type);
+struct bt_field_type *bt_field_type_borrow_field_at_index(
+ struct bt_field_type *ft, int index);
BT_HIDDEN
-int bt_ctf_field_type_get_field_count(struct bt_ctf_field_type *type);
+int bt_field_type_get_field_index(struct bt_field_type *ft,
+ const char *name);
BT_HIDDEN
-struct bt_ctf_field_type *bt_ctf_field_type_get_field_at_index(
- struct bt_ctf_field_type *type, int index);
+int bt_field_type_validate_single_clock_class(
+ struct bt_field_type *ft,
+ struct bt_clock_class **expected_clock_class);
BT_HIDDEN
-int bt_ctf_field_type_get_field_index(struct bt_ctf_field_type *type,
- const char *name);
+int64_t bt_field_type_variant_find_choice_index(
+ struct bt_field_type *ft, uint64_t uval,
+ bool is_signed);
#endif /* BABELTRACE_CTF_IR_FIELD_TYPES_INTERNAL_H */