* SOFTWARE.
*/
-#include <stdint.h>
-#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 <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;
- enum bt_ctf_field_type_id id;
+ enum bt_field_type_id id;
unsigned int alignment;
- type_freeze_func freeze;
- type_serialize_func serialize;
+
+ /* 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 bt_ctf_clock_class *mapped_clock;
- enum bt_ctf_byte_order user_byte_order;
+struct bt_field_type_integer {
+ struct bt_field_type common;
+
+ /* 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_ctf_integer_base base;
- enum bt_ctf_string_encoding encoding;
+ 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 */
- /* Only set during validation. */
+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;
};
-enum bt_ctf_field_type_enumeration_mapping_iterator_type {
+enum bt_field_type_enumeration_mapping_iterator_type {
ITERATOR_BY_NAME,
ITERATOR_BY_SIGNED_VALUE,
ITERATOR_BY_UNSIGNED_VALUE,
};
-struct bt_ctf_field_type_enumeration_mapping_iterator {
+struct bt_field_type_enumeration_mapping_iterator {
struct bt_object base;
- struct bt_ctf_field_type_enumeration *enumeration_type;
- enum bt_ctf_field_type_enumeration_mapping_iterator_type type;
+
+ /* 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;
} u;
};
-struct bt_ctf_field_type_floating_point {
- struct bt_ctf_field_type parent;
- enum bt_ctf_byte_order user_byte_order;
+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 structure_field {
+struct bt_field_type_structure_field {
GQuark name;
- struct bt_ctf_field_type *type;
+
+ /* Owned by this */
+ struct bt_field_type *type;
};
-struct bt_ctf_field_type_structure {
- struct bt_ctf_field_type parent;
+struct bt_field_type_structure {
+ struct bt_field_type common;
GHashTable *field_name_to_index;
- GPtrArray *fields; /* Array of pointers to struct structure_field */
+
+ /*
+ * Array of `struct bt_field_type_structure_field`,
+ * owned by this
+ */
+ GArray *fields;
};
-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;
- GHashTable *field_name_to_index;
- GPtrArray *fields; /* Array of pointers to struct structure_field */
+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_array {
- struct bt_ctf_field_type parent;
- struct bt_ctf_field_type *element_type;
- unsigned int length; /* Number of elements */
+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_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 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;
};
-struct bt_ctf_field_type_string {
- struct bt_ctf_field_type parent;
- enum bt_ctf_string_encoding encoding;
+struct bt_field_type_array {
+ struct bt_field_type common;
+
+ /* Owned by this */
+ struct bt_field_type *element_ft;
+
+ unsigned int length;
};
-BT_HIDDEN
-void bt_ctf_field_type_freeze(struct bt_ctf_field_type *type);
+struct bt_field_type_sequence {
+ 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);
+ GString *length_field_name;
-BT_HIDDEN
-int bt_ctf_field_type_serialize(struct bt_ctf_field_type *type,
- struct metadata_context *context);
+ /* Owned by this */
+ struct bt_field_path *length_field_path;
+};
-BT_HIDDEN
-int bt_ctf_field_type_validate(struct bt_ctf_field_type *type);
+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 *);
-/* 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);
+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;
+}
BT_HIDDEN
-int bt_ctf_field_type_variant_get_field_name_index(
- struct bt_ctf_field_type *variant, const char *name);
+int bt_field_type_variant_update_choices(
+ 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);
+void bt_field_type_freeze(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_validate(struct bt_field_type *ft);
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_sequence_set_length_field_path(
+ struct bt_field_type *ft, struct bt_field_path *path);
BT_HIDDEN
-int bt_ctf_field_type_array_set_element_type(struct bt_ctf_field_type *array,
- struct bt_ctf_field_type *element_type);
+int bt_field_type_variant_set_tag_field_path(
+ struct bt_field_type *ft,
+ struct bt_field_path *path);
BT_HIDDEN
-int bt_ctf_field_type_sequence_set_element_type(struct bt_ctf_field_type *array,
- struct bt_ctf_field_type *element_type);
+int bt_field_type_variant_set_tag_field_type(
+ struct bt_field_type *ft,
+ struct bt_field_type *tag_ft);
BT_HIDDEN
-int64_t bt_ctf_field_type_get_field_count(struct bt_ctf_field_type *type);
+int64_t bt_field_type_get_field_count(struct bt_field_type *ft);
BT_HIDDEN
-struct bt_ctf_field_type *bt_ctf_field_type_get_field_at_index(
- struct bt_ctf_field_type *type, int index);
+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_index(struct bt_ctf_field_type *type,
+int bt_field_type_get_field_index(struct bt_field_type *ft,
const char *name);
-static inline
-const char *bt_ctf_field_type_id_string(enum bt_ctf_field_type_id type_id)
-{
- switch (type_id) {
- case BT_CTF_FIELD_TYPE_ID_UNKNOWN:
- return "BT_CTF_FIELD_TYPE_ID_UNKNOWN";
- case BT_CTF_FIELD_TYPE_ID_INTEGER:
- return "BT_CTF_FIELD_TYPE_ID_INTEGER";
- case BT_CTF_FIELD_TYPE_ID_FLOAT:
- return "BT_CTF_FIELD_TYPE_ID_FLOAT";
- case BT_CTF_FIELD_TYPE_ID_ENUM:
- return "BT_CTF_FIELD_TYPE_ID_ENUM";
- case BT_CTF_FIELD_TYPE_ID_STRING:
- return "BT_CTF_FIELD_TYPE_ID_STRING";
- case BT_CTF_FIELD_TYPE_ID_STRUCT:
- return "BT_CTF_FIELD_TYPE_ID_STRUCT";
- case BT_CTF_FIELD_TYPE_ID_ARRAY:
- return "BT_CTF_FIELD_TYPE_ID_ARRAY";
- case BT_CTF_FIELD_TYPE_ID_SEQUENCE:
- return "BT_CTF_FIELD_TYPE_ID_SEQUENCE";
- case BT_CTF_FIELD_TYPE_ID_VARIANT:
- return "BT_CTF_FIELD_TYPE_ID_VARIANT";
- default:
- return "(unknown)";
- }
-};
-
-static inline
-const char *bt_ctf_byte_order_string(enum bt_ctf_byte_order bo)
-{
- switch (bo) {
- case BT_CTF_BYTE_ORDER_UNKNOWN:
- return "BT_CTF_BYTE_ORDER_UNKNOWN";
- case BT_CTF_BYTE_ORDER_NATIVE:
- return "BT_CTF_BYTE_ORDER_NATIVE";
- case BT_CTF_BYTE_ORDER_LITTLE_ENDIAN:
- return "BT_CTF_BYTE_ORDER_LITTLE_ENDIAN";
- case BT_CTF_BYTE_ORDER_BIG_ENDIAN:
- return "BT_CTF_BYTE_ORDER_BIG_ENDIAN";
- case BT_CTF_BYTE_ORDER_NETWORK:
- return "BT_CTF_BYTE_ORDER_NETWORK";
- default:
- return "(unknown)";
- }
-};
-
-static inline
-const char *bt_ctf_string_encoding_string(enum bt_ctf_string_encoding encoding)
-{
- switch (encoding) {
- case BT_CTF_STRING_ENCODING_UNKNOWN:
- return "BT_CTF_STRING_ENCODING_UNKNOWN";
- case BT_CTF_STRING_ENCODING_NONE:
- return "BT_CTF_STRING_ENCODING_NONE";
- case BT_CTF_STRING_ENCODING_UTF8:
- return "BT_CTF_STRING_ENCODING_UTF8";
- case BT_CTF_STRING_ENCODING_ASCII:
- return "BT_CTF_STRING_ENCODING_ASCII";
- default:
- return "(unknown)";
- }
-};
-
-static inline
-const char *bt_ctf_integer_base_string(enum bt_ctf_integer_base base)
-{
- switch (base) {
- case BT_CTF_INTEGER_BASE_UNKNOWN:
- return "BT_CTF_INTEGER_BASE_UNKNOWN";
- case BT_CTF_INTEGER_BASE_BINARY:
- return "BT_CTF_INTEGER_BASE_BINARY";
- case BT_CTF_INTEGER_BASE_OCTAL:
- return "BT_CTF_INTEGER_BASE_OCTAL";
- case BT_CTF_INTEGER_BASE_DECIMAL:
- return "BT_CTF_INTEGER_BASE_DECIMAL";
- case BT_CTF_INTEGER_BASE_HEXADECIMAL:
- return "BT_CTF_INTEGER_BASE_HEXADECIMAL";
- default:
- return "(unknown)";
- }
-}
+BT_HIDDEN
+int bt_field_type_validate_single_clock_class(
+ struct bt_field_type *ft,
+ struct bt_clock_class **expected_clock_class);
-static inline
-const char *bt_ctf_scope_string(enum bt_ctf_scope scope)
-{
- switch (scope) {
- case BT_CTF_SCOPE_UNKNOWN:
- return "BT_CTF_SCOPE_UNKNOWN";
- case BT_CTF_SCOPE_TRACE_PACKET_HEADER:
- return "BT_CTF_SCOPE_TRACE_PACKET_HEADER";
- case BT_CTF_SCOPE_STREAM_PACKET_CONTEXT:
- return "BT_CTF_SCOPE_STREAM_PACKET_CONTEXT";
- case BT_CTF_SCOPE_STREAM_EVENT_HEADER:
- return "BT_CTF_SCOPE_STREAM_EVENT_HEADER";
- case BT_CTF_SCOPE_STREAM_EVENT_CONTEXT:
- return "BT_CTF_SCOPE_STREAM_EVENT_CONTEXT";
- case BT_CTF_SCOPE_EVENT_CONTEXT:
- return "BT_CTF_SCOPE_EVENT_CONTEXT";
- case BT_CTF_SCOPE_EVENT_PAYLOAD:
- return "BT_CTF_SCOPE_EVENT_PAYLOAD";
- case BT_CTF_SCOPE_ENV:
- return "BT_CTF_SCOPE_ENV";
- default:
- return "(unknown)";
- }
-}
+BT_HIDDEN
+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 */